Preferências do Sistema de Ajuda

O sistema de ajuda do Eclipse pode ser configurado e marcado para adaptar seu produto pela especificação de padrões personalizados para várias preferências de ajuda.

O próprio sistema de ajuda é dividido em vários plug-ins separados. Essas tabelas mostram as preferências disponíveis e quais plug-ins as definem.  Consulte Personalizando um Produto para saber como substituir algumas dessas preferências.
 

Plug-in org.eclipse.help:

Chave de preferência Uso
Default
baseTOCS Ordenação do Toc.  Lista ordenada de TOCs (manuais) de ajuda da forma como deveriam aparecer no bookshelf. Os outros TOCS seguirão esses manuais. Os TOCs não presentes nessa lista serão ignorados. Utilize o local de cada TOC como /pluginId/path/to/toc.xml. /org.eclipse.platform.doc.user/toc.xml,
/org.eclipse.jdt.doc.user/toc.xml,
/org.eclipse.platform.doc.isv/toc.xml,
/org.eclipse.jdt.doc.isv/toc.xml,
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS Desativando os TOCs.  A lista de TOC de ajuda (catálogos) que será ignorada pelo sistema de ajuda. Os TOCs desativados não aparecerão na lista de catálogos, não podem ser vinculados. Os tópicos definidos pelos TOCs desativados não estarão disponíveis para procura. Os TOCs não presentes nessa lista serão ignorados. Utilize o local de cada TOC como /pluginId/path/to/toc.xml.

Plug-in org.eclipse.help.base:

Chave de preferência Uso
Default
banner Local da página do banner a ser exibido no quadro principal
Exemplo: banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height Altura do quadro do banner
Exemplo: banner_height=60

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. /org.eclipse.help.base/doc/help_home.html
linksView Definida como true ou false para controlar a visualização dos links relacionados.
Nota: essa opção não tem efeito no infocenter.
true
bookmarksView Definida como true ou false para controlar a visualização dos marcadores.
Nota: essa opção não tem efeito no infocenter.
true
windowTitlePrefix Definida como true ou false para controlar o título da janela do navegador. Se true, o título terá uma forma "Ajuda - <PRODUCT_NAME>", caso contrário, o título será "<PRODUCT_NAME>", em que <PRODUCT_NAME> é o nome do conjunto de produtos Eclipse no recurso principal. true
loadBookAtOnceLimit O número máximo de tópicos permitido em um manual para a navegação a ser carregada pelo navegador como um documento. A navegação para manuais grandes é carregada dinamicamente com alguns níveis de cada vez. Com a expansão das ramificações, outros tópicos serão transferidos por download, conforme necessário. 1000
dynamicLoadDepthsHint Número sugerido de níveis na navegação do tópico transferidos por download no navegador para manuais grandes. O valor precisa ser maior que 0. O número real de níveis pode ser diferente para a árvore extensiva se o número sugerido de níveis contiver um número grande de tópicos.
3
imagesDirectory Diretório contendo imagens utilizadas na visualização de ajuda. As imagens devem ter o mesmo nome daquelas no plug-in org.eclipse.help.webapp. Utilize o formato /pluginID/directory. images
advanced.toolbarBackground Segundo plano do CSS para barras de ferramentas. O valor é utilizado em navegadores que exibem a UI da ajuda avançada. ButtonFace
advanced.viewBackground Segundo plano do CSS para visualizações de navegação. O valor é utilizado em navegadores que exibem a UI da ajuda avançada. Janela
advanced.toolbarFont Fonte do CSS para barras de ferramentas. O valor é utilizado em navegadores que exibem a UI da ajuda avançada. icon
advanced.viewFont Fonte do CSS para visualizações de navegação. O valor é utilizado em navegadores que exibem a UI da ajuda avançada. icon
basic.toolbarBackground Cor de segundo plano para barras de ferramentas. O valor é utilizado em navegadores que exibem a UI da ajuda básica. #D4D0C8
basic.viewBackground Cor de segundo plano para visualizações de navegação. O valor é utilizado em navegadores que exibem a UI da ajuda básica. #FFFFFF
locales Lista de códigos de idioma que o infocenter reconhecerá e para a qual fornecerá um conteúdo personalizado; se os códigos de idioma (ou idiomas) aceitos pelo navegador do cliente não forem correspondidos com nenhum código de idioma nessa lista, o navegador receberá conteúdo para o código de idioma padrão - o código de idioma do servidor ou o código de idioma especificado pela opção de linha de comandos -nl do eclipse; se a lista não for especificada, o navegador receberá conteúdo para seu código de idioma preferido; nota: o não fornecimento dessa opção poderá resultar em requisitos de muita memória e espaço em disco, pois as navegações e os índices serão criados para cada código de idioma preferido distinto entre os navegadores que acessam o infocenter.
Exemplo: locales=en ja zh_CN zh_TW

productIndex Se o produto fornecer índice de documentação pré-construído por produto, o ID do plug-in que entrega o índice deverá ser especificado para o sistema de ajuda aqui.
always_external_browser
Utilizar incorporado quando possível (no Windows ou Linux) ou sempre externo.  Definir como true forçará a utilização de navegador externo.  A opção não terá efeito se o navegador incorporado não estiver disponível em uma plataforma especificada.
false
default_browser

Navegador externo padrão.  O ID de um dos navegadores externos da Web contribuiu para o ponto de extensão org.eclipse.help.base.browser que será utilizado pelo sistema de ajuda. O método available() do adaptador do navegador deve retornar true no sistema atual.

Essa preferência controla os navegadores externos no modo de ajuda independente. No modo do workbench, a ajuda utiliza navegadores fornecidos pelo suporte de navegador do workbench.

padrão definido dinamicamente com base no navegador disponível em um sistema especificado
custom_browser_path

Caminho executável para o navegador personalizado

Essa preferência controla os navegadores externos no modo de ajuda independente. No modo do workbench, a ajuda utiliza navegadores fornecidos pelo suporte de navegador do workbench.

C:\Arquivos de programas\Internet Explorer\IEXPLORE.EXE" %1 - no Windows,
"konqueror %1" - no Linux
"mozilla %1" - em outras plataformas
showDisabledActivityTopics Tópicos dos filtros do sistema de ajuda dos recursos desativados.  Essa opção controla esse comportamento e existência do botão  Mostrar Todos os Tópicos.
Valores aceitos: never, off, on, always
 never - o tópico dos recursos desativados não são mostrados
 off - o usuário pode optar por mostrar todos os tópicos, tópicos desativados ocultos inicialmente
 on - o usuário pode optar por mostrar todos os tópicos, todos os tópicos mostrados inicialmente
 always - o tópico dos recursos desativados são mostrados (filtragem desativada)
off
activeHelp Permite ativar e desativar a execução da ajuda ativa. A opção não tem efeito na configuração do infocenter, no qual a ajuda ativa é desativada.
Valores aceitos:
 true - ações da ajuda ativa padrão ativadas
 false - estrutura da ajuda ativa desativada
true
window_infopop Permite a ativação dos infopops em estilo antigo quando a chave de ajuda é pressionada nas janelas do workbench. Se falso, em vez disso, a nova visualização de ajuda dinâmica será aberta. false
dialog_infopop
Permite a ativação dos infopops em estilo antigo quando a chave de ajuda é pressionada em diálogos. Se falso, em vez disso, a nova janela de ajuda dinâmica será aberta.
false

Plug-in org.eclipse.help.appserver:

Chave de preferência Uso
Default
port O número da porta na qual o servidor atende pedidos http. Se a porta não for especificada, uma porta arbitrária será selecionada pelo sistema.  
host

O endereço ou o nome do host a ser utilizado para conexão com o servidor. O padrão é nada e o eclipse selecionará um endereço local disponível.

Os produtos que utilizam a ajuda no modo local (workbench ou independente, não infocenter), podem configurar essa preferência como "127.0.0.1", para garantir que o servidor de ajuda não será exposto a outros usuários na rede.


Plug-in org.eclipse.tomcat:

Chave de preferência Uso
Default
acceptCount O comprimento máximo da fila para pedidos de conexão de entrada quando todos os encadeamentos de processamento de pedidos possíveis estiverem sendo utilizados. Todos os pedidos recebidos quando a fila estiver cheia serão recusados. 100
maxProcessors
O número máximo de encadeamentos de processamento de pedidos a ser criado por esse Conector que, portanto, determina o número máximo de pedidos simultâneos que podem ser manipulados.
75
minProcessors
O número de encadeamentos de processamento de pedidos que será criado quando esse Conector for iniciado pela primeira vez. Esse atributo deve ser definido com um valor menor do que o definido para maxProcessors.
5