Sistema de Ajuda
O plug-in do Sistema de Ajuda, org.eclipse.help, define dois pontos de extensão
("contextos" e "toc") que permitem plug-ins individuais
para contribuir auxílio dependente de contexto e auxílio online para seus
componentes. Um plug-in típico que fornece documentação fará uso desses
pontos de extensão.
Outros pontos de extensão atendem as capacidades de extensão do sistema de ajuda.
Para aplicativos mais avançados, existe também um ponto de extensão ("suporte") para conectar-se a um sistema de ajuda da UI.
Pontos de Extensão
Os pontos de extensão a seguir podem ser utilizados para estender o sistema de ajuda:
Preferências
As definições de preferências a seguir podem ser utilizadas com o sistema de ajuda:
-
log_level: denota qual tipo de informações são obtidas gravadas no
log de ajuda. Utilize um dos três valores a seguir.
- 0: apenas erros de log
- 1: erros e avisos de log
- 2: erros de log, mensagens de avisos e informativas (depuração)
- banner: a exibição de ajuda permite a marca do aplicativo. Se você desejar mostrar o logotipo de uma empresa ou quaisquer outros assuntos
na parte superior da exibição de ajuda, especifique sua página html como /pluginId/path/to/banner.html. Atualmente, o banner
padrão é /org.eclipse.help.webapp/banner.html. Se você definir esse nome para cadeia vazia, nenhum banner será totalmente mostrado.
- banner_height: a altura da área do banner. Atualmente, o padrão é 45.
- help_home: A página a ser mostrada na área de conteúdo ao abrir a ajuda. Especifique sua página html como /pluginId/path/to/home.html.
Atualmente, o início padrão é /org.eclipse.help/doc/help_home.html.
- linksView: definir para verdadeiro ou falso para controlar a visibilidade da exibição de links relacionados.
- baseTOCS: TOC's da lista de ajuda pedida (manuais) conforme eles aparecem no bookshelf. Todos os outros
TOCS irão seguir estes manuais. Os TOC's não presentes nesta lista serão ignorados. Utilize a localização de cada
TOC como /pluginId/path/to/toc.xml.