Editor de Ajuda de Contexto

Ajuda contextual é um mecanismo que possibilita vincular uma parte da interface com o usuário a um tópico de ajuda específico. Quando o usuário ativa a parte associada da interface com o usuário, a página de ajuda é exibida na área de ajuda dinâmica. A interface com o usuário e as páginas de ajuda estão associadas entre si de duas maneiras: um arquivo XML estático ou um provedor de contexto dinâmico. Para associar as páginas estaticamente, deve ser criado um arquivo xml de ajuda de contexto. O editor de ajuda de contexto ajuda na criação destas páginas.

A página Definição do editor fornece uma visualização gráfica do arquivo xml, separada em duas colunas. A da esquerda tem o título Ajuda de Contexto e exibe os elementos xml em um formato em árvore juntamente com ações para incluí-los, movê-los e removê-los. A outra coluna fornece informações mais detalhadas sobre o elemento selecionado na coluna da esquerda e possibilita a edição dos detalhes.

A página Origem do editor fornece a visualização textual do arquivo xml. O xml pode ser editado diretamente e as alterações, se válidas, serão refletidas na página gráfica Definição.

Incluindo Novos Contextos de Ajuda

Editor de contexto de ajuda com campos preenchidos

Para incluir um novo contexto, clique no botão Incluir Contexto. Isso incluirá uma nova entrada de contexto no xml e será exibido na árvore na página Definição. O novo contexto será selecionado, abrindo uma seção de detalhes na coluna direita do editor. Nesta seção de detalhes você pode fornecer informações mais detalhadas sobre o contexto, incluindo:

Incluindo Tópicos e Comandos de Ajuda

Incluir um contexto no arquivo fornecerá ajuda dinâmica com uma descrição básica a ser exibida ao usuário. Geralmente, você desejará fornecer links adicionais para os tópicos relacionados no sistema de ajuda. Para isso, você deve incluir tópicos e comandos no arquivo xml.

Editor de contexto de ajuda com campos de detalhes preenchidos

Ao clicar no botão Incluir Tópico, você incluirá uma nova entrada de tópico no xml sob um dos contextos de ajuda. Um tópico aparecerá para o usuário como um link. Depois que um novo tópico for criado, você poderá selecioná-lo para abrir a seção Detalhes de Tópico na coluna direita da página Definição. Na seção de detalhes, você pode alterar o rótulo que será exibido ao usuário e o local do arquivo que será vinculado. Na maioria dos casos, o arquivo vinculado será uma página html no sistema de ajuda. Você pode utilizar o botão Procurar... para procurar por um arquivo a ser vinculado.

Além dos tópicos, talvez você também queira incluir um comando. Um comando possui a mesma aparência para o usuário como um tópico. No entanto, quando o link é ativado, um comando de código é executado em vez de um arquivo sendo aberto. Os comandos podem ser utilizados para abrir as páginas de preferências e executar outras ações.

Comando incluir do editor de contexto de ajuda

Clicando no botão Incluir Comando para incluir um novo comando. Você pode editar os detalhes de comandos da mesma maneira que edita os tópicos.

Comandos Remover, Para Cima, Para Baixo

Existem três botões adicionais sobre a página Definição, que permitem manipular com a ordem de itens na lista de contexto ou com a exclusão dos itens.

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

Esses botões são:

Registrando o Arquivo de Ajuda de Contexto

Para que o Eclipse reconheça o arquivo xml de ajuda de contexto como sendo uma origem para o sistema de ajuda dinâmica, ele deve ser registrado através do ponto de extensão org.eclipse.help.contexts. O editor fornece uma maneira de registrar o arquivo de ajuda de contexto automaticamente. No canto superior direito do editor, existe um link denominado "Registrar com Arquivo de Ajuda de Contexto". Clicar neste link incluirá a entrada correta no arquivo plugin.xml.