Elementos para uso em arquivos .rkh (ajuda)- <document>
Precisa estar presente em cada arquivo
.xmlcomo nó raiz (exatamente uma vez). Sem atributos.- <title>
Título da página de ajuda. Isto não é interpretado para páginas de ajuda de um plugin (este título é obtido do próprio plugin), apenas para páginas independentes. Sem atributos. O texto contido na tag <title> se tornará a legenda da página de ajuda. Pode ser definido apenas uma vez, como filho direto do nó <document>.
- <summary>
Um breve resumo da página de ajuda (ou para que serve este plugin). Este será sempre exibido no topo da página de ajuda. Sem atributos. O texto contido na tag <summary> será exibido. Recomendado, mas não obrigatório. Pode ser definido apenas uma vez, como filho direto do nó <document>.
- <usage>
Um resumo um pouco mais detalhado do uso. Este será sempre exibido diretamente após o <summary>. Sem atributos. O texto contido na tag <usage> será exibido. Recomendado para páginas de ajuda de plugins, mas não obrigatório. Pode ser definido apenas uma vez, como filho direto do nó <document>.
- <section>
Uma seção de uso geral. Pode ser usada qualquer número de vezes como um filho direto do nó <document>. Essas seções são exibidas na ordem de sua definição, mas todas após a seção <usage> e antes a seção <settings>. O texto contido na tag <section> será exibido.
- id
Um identificador necessário para acessar esta seção a partir da barra de navegação (ou um link). Precisa ser único dentro do arquivo. Obrigatório, sem valor padrão.
- title
Título (legenda) desta seção. Obrigatório, sem valor padrão.
- short_title
Um título curto adequado para ser exibido na barra de navegação. Opcional, o padrão é o título completo.
- <settings>
Define a seção que contém referências às várias configurações da GUI. Somente significativo e usado apenas para páginas de ajuda relacionadas a plugins. Use como um filho direto do <document>. Pode conter apenas elementos <settings> e <caption> como filhos diretos. Sem atributos.
- <setting>
Explica uma única configuração na GUI. Permitido apenas como filho direto do elemento <settings>. O texto contido no elemento é exibido.
- id
O ID da configuração no plugin
.xml. Obrigatório, sem valor padrão.- title
Um título opcional para a configuração. Se omitido (a omissão é recomendada na maioria dos casos), o título será obtido do plugin
.xml.
- <caption>
Uma legenda para agrupar visualmente várias configurações. Só pode ser usada como um elemento filho direto do elemento <settings>.
- id
O ID do elemento correspondente (normalmente um <frame>, <page> ou <tab>) no plugin
.xml.- title
Um título opcional para a legenda. Se omitido (a omissão é recomendada na maioria dos casos), o título será retirado do plugin
.xml.
- <related>
Define uma seção contendo links para informações adicionais relacionadas. Será sempre exibida após a seção <settings>. Sem atributos. O texto contido na tag <related> será exibido. Normalmente, isso conterá uma lista no estilo HTML. Recomendado para páginas de ajuda de plugins, mas não obrigatório. Pode ser definido apenas uma vez, como filho direto do nó <document>.
- <technical>
Define uma seção contendo informações técnicas irrelevantes para os usuários finais (como a estrutura interna do plugin). Será sempre exibida por último em uma página de ajuda. Sem atributos. O texto contido na tag <related> será exibido. Não é obrigatório e não é recomendado para a maioria das páginas de ajuda de plugins. Pode ser definido apenas uma vez, como filho direto do nó <document>.
- <link>
Um link. Pode ser usado em qualquer uma das seções descritas acima.
- href
O destino URL. Observe que vários URLs específicos para RKWard estão disponíveis. Consulte a seção sobre como escrever páginas de ajuda para obter detalhes.
- <label>
Insere o valor de um rótulo da interface do usuário. Pode ser usado em qualquer uma das seções descritas acima.
- id
O ID do elemento no plugin, do qual copiar o atributo
label.
- <várias tags HTML>
A maioria das tags HTML básicas são permitidas dentro das seções. No entanto, por favor, mantenha a formatação manual ao mínimo.