Ajuda

As funções de ajuda da plataforma Eclipse disponibilizam os pontos de partida em bruto para estruturar e contribuir com documentação para a plataforma. Não ditam a estrutura nem a granularidade da documentação. Poderá escolher as ferramentas e a estrutura da documentação que se adaptem às suas necessidades.  O plug-in de ajuda permite descrever a estrutura da documentação para a plataforma mediante um ficheiro de índice (toc).

A ajuda online do plug-in é contributo do ponto de extensão org.eclipse.help.toc. Poderá contribuir com a ajuda online como parte do plug-in de código ou fornecê-la separadamente no seu próprio plug-in de documentação.

É benéfico separar a documentação num plug-in separado em situações em que as equipas de código e documentação sejam grupos diferentes ou onde pretenda reduzir a acoplagem entre documentação e código.

As funções avançadas do sistema de ajuda incluem ajuda sensível a contextos com ligações de referência e a capacidade de invocar código de plataforma a partir da documentação. Um browser de ajuda permite ver, imprimir e pesquisar a documentação. Desde a versão 3.1, a nova vista Ajuda adiciona capacidades de ajuda dinâmica e pesquisa de informações federadas.

A melhor forma de demonstrar o contributo da ajuda consiste em criar um plug-in de documentação.