Editor da ajuda de contexto

A ajuda contextual é um mecanismo que permite a ligação de uma parte de uma interface de utilizador a um tópico de ajuda específico. Quando o utilizador activa a parte da interface de utilizador associada, a página de ajuda é apresentada na área de ajuda dinâmica. A interface de utilizador e as páginas de ajuda estão associadas entre si de duas formas: um ficheiro XML estático ou um fornecedor de contexto dinâmico. Para associar páginas estaticamente, deve ser criado um ficheiro XML de ajuda contextual. O editor de ajuda contextual ajuda na criação destas páginas.

A página Definição do editor faculta uma vista gráfica do ficheiro xml, separado em duas colunas. A da esquerda intitula-se Ajuda Contextual e apresenta os elementos xml sob formato de árvore bem como as acções para os adicionar, mover e remover. A outra coluna faculta informações mais detalhadas sobre o elemento seleccionada na coluna da esquerda e permite a edição dos detalhes.

A página Origem do editor faculta uma vista textual do ficheiro xml. O ficheiro pode ser editado directamente e as alterações, se forem válidas, reflectem-se na página Definição gráfica.

Adicionar novos contextos de ajuda

Editor contextual da ajuda com campos preenchidos

Para adicionar novo contexto, clique no botão Adicionar Contexto. Irá adicionar nova entrada de contexto ao ficheiro XML e esta será apresentada na árvore da página Definição. Será seleccionado o novo contexto, abrindo uma secção de detalhes na coluna da direita do editor. Nesta secção de detalhes, pode facultar mais informações detalhadas sobre o contexto, incluindo:

Adicionar tópicos de ajuda e comandos

Adicionar um contexto ao ficheiro faculta à ajuda dinâmica uma descrição básica a apresentar ao utilizador. Regra geral, será útil facultar hiperligações adicionais a tópicos relacionados no sistema de ajuda. Nesse sentido, deve adicionar tópicos e comandos ao ficheiro XML.

Editor contextual de ajuda com campos detalhados preenchidos

Ao clicar no botão Adicionar Tópico, irá adicionar nova entrada de tópico ao código XML a seguir a um dos contextos de ajuda. O tópico aparece ao utilizador como hiperligação. Uma vez o novo tópico criado, poderá seleccioná-lo para abrir a secção Detalhes do Tópico na coluna da direita da página Definição. Na secção de detalhes, pode alterar a etiqueta que será apresentada ao utilizador e a localização do ficheiro que será ligado. Regra geral, o ficheiro ligado será uma página HTML no sistema de ajuda. Utilize o botão Procurar... para procurar uma ficheiro com que ligar.

Além dos tópicos, poderá ser útil adicionar um comando. Um comando tem o mesmo aspecto para o utilizador que um tópico. Todavia, quando se activa a hiperligação, é executado um comando de código em vez de se abrir um ficheiro. Os comandos podem ser usados para abrir páginas de preferências e executar outras acções.

Comando Adicionar editor contextual de ajuda

Clique no botão Adicionar Comando para adicionar novo comando. Pode editar os detalhes dos comandos da mesma maneira que editar tópicos.

Comandos Remover, Para Cima, Para Baixo

Existem três botões adicionais na página Definição, que permitem a manipulação da ordem dos artigos na lista de contexto ou a eliminação dos artigos.

Contexto de ajuda com botões de manipulação

Estes botões são:

Registar o ficheiro de ajuda contextual

Para que o Eclipse reconheça o ficheiro XML de ajuda contextual como código para o sistema de ajuda dinâmica, o mesmo deve ser registado através do ponto de extensão org.eclipse.help.contexts. O editor faculta maneira de registar o ficheiro de ajuda contextual automaticamente. No canto superior direito do editor, há uma hiperligação chamada "Registar este ficheiro de ajuda contextual". Clique nesta hiperligação para adicionar a entrada correcta ao ficheiro plugin.xml.