Conectando-se à Ajuda

Os recursos de ajuda da plataforma Eclipse fornecem os blocos de construção não processados para estruturar e contribuir com documentação para a plataforma. Não determina estrutura ou granularidade de documentação. Você pode escolher as ferramentas e a estrutura para sua documentação que melhor se adaptar às suas necessidades.  O plug-in de ajuda permite descrever a estrutura de sua documentação para a plataforma utilizando um arquivo de índice (toc).

A ajuda on-line de seu plug-in recebe contribuição utilizando o ponto de extensão org.eclipse.help.toc. É possível contribuir com a ajuda on-line como parte do seu plug-in de código ou fornecê-la separadamente em seu próprio plug-in de documentação.

Separando a documentação em um plug-in separado é benéfico nas situações em que as equipes de código e documentação são grupos diferentes ou onde desejar reduzir o agrupamento entre a documentação e o código.

Os recursos avançados do sistema de ajuda incluem auxílio contextual com links de referência (conhecidos como infopops) e a capacidade de chamar código da plataforma a partir da documentação.  Um navegador de ajuda permite exibir, imprimir e pesquisar sua documentação.  

A melhor forma de demonstrar a contribuição de ajuda é criar um plug-in de documentação.

Copyright IBM Corporation e outros 2000, 2003.