Nota: o sistema de ajuda ainda está em desenvolvimento e esperam-se algumas alterações antes de alcançar estabilidade. Nesse estágio é possível solicitar feedback de pessoas que adotaram o sistema anteriormente, entendendo-se que os detalhes dos mecanismos de contribuição poderão ser alterados nos pontos de ruptura. |
Descrição: definindo o auxílio dependente de contexto para um plug-in individual.
Marcação da Configuração:
<!ELEMENT contexts EMPTY>
<!ATTLIST contexts name CDATA #REQUIRED>
<!ELEMENT contexts (context)* ) >
<!ELEMENT context (description?,topic*) >
<!ATTLIST context id ID #REQUIRED >
<!ELEMENT description (#PCDATA)>
<!ELEMENT topic (topic)* >
<!ATTLIST topic id ID #IMPLIED >
<!ATTLIST topic label CDATA #REQUIRED >
<!ATTLIST topic href CDATA #IMPLIED
>
Os arquivos manifest de contextos fornecem todas as informações necessárias quando um auxílio dependente de contexto é solicitado pelo usuário.
O ID é transmitido pela plataforma para identificar o contexto atualmente ativo.
A definição do contexto com um ID correspondente é então recuperada.
Esse elemento de contexto contém uma breve descrição a ser exibida para o usuário, bem como tópicos relacionados que o usuário poderá achar útil para o entendimento do contexto atual.
Exemplos:
A seguir um exemplo do uso do ponto de extensão contextos.
(no arquivo plugin.xml)
<extension point="org.eclipse.help.contexts">
<contexts name="xyzContexts.xml"/>
</extension>
(no arquivo xyzContexts.xml)
<contexts>
<contexto id="generalContextId">
<descrição> Esta é uma </descrição> da amostra da cadeia de ajuda F1.
<topic href="contexts/RelatedContext1.html"
label="Help Related Topic 1"/>
<topic href="contexts/RelatedContext2.html"
label="Help Related Topic 2"/>
</context>
</contexts>
Informações de API: nenhum código é solicitado para utilização desse ponto de extensão. Tudo que é necessário é fornecer o(s) arquivo(s) manifest apropriados mencionados no arquivo plugin.xml.
Implementação Fornecida: a implementação padrão opcional do sistema de ajuda da UI fornecido com a plataforma Eclipse suporta completamente o ponto de extensão contexts.