O sistema de ajuda do Eclipse pode ser configurado e personalizado para se adequar às necessidades do produto, especificando as predefinições personalizadas para diversas preferências da ajuda.
O próprio sistema de ajuda divide-se em vários plug-ins separados.
Estas tabelas mostram as preferências disponíveis e qual o plug-in que as define.
Consulte Personalizar um
produto para saber como substituir algumas dessas preferências.
Chave de preferência | Utilização |
Predefinição |
baseTOCS |
Ordem dos arquivos TOC. Lista ordenada dos arquivos TOC da ajuda (manuais) ou categorias TOC, como apareceriam na estante. Todos os outros arquivos TOC e categorias seguirão estes. Os arquivos TOC ou categorias que não estejam presentes nesta lista, serão ignorados. Para arquivos TOC, utilizar a localização de cada TOC como /pluginId/path/to/toc.xml. Para categorias, utilizar o ID da categoria. | /org.eclipse.platform.doc.user/toc.xml, |
ignoredTOCS |
Desactivar arquivos TOC. Lista dos arquivos TOC de ajuda (manuais) ou categorias TOC que serão ignorados pelo sistema de ajuda. Os arquivos TOC/categorias não aparecerão na lista de manuais, não podendo ser ligados. Os tópicos definidos pelos arquivos TCO desactivados não estão disponíveis a partir da pesquisa. Os arquivos TOC ou categorias que não estejam presentes nesta lista, serão ignorados. Para arquivos TOC, utilizar a localização de cada TOC como /pluginId/path/to/toc.xml. Para categorias, utilizar o ID da categoria. |
Chave de preferência | Utilização |
Predefinição |
banner |
Localização da página de mensagem de cabeçalho na estrutura superior Exemplo: banner=/org.eclipse.help.webapp/advanced/banner.html |
|
banner_height |
A altura da mensagem de cabeçalho Exemplo: banner_height=60 |
|
help_home |
A página para mostrar a área de conteúdos ao abrir a ajuda.
Especifique a página html como /pluginId/path/to/home.html . |
/org.eclipse.help.base/doc/help_home.html |
linksView |
Definir como true ou false para controlar a
visibilidade da vista de ligações relacionadas. Nota: esta opção não tem qualquer efeito no infocenter. |
true |
bookmarksView |
Definir como true ou false para controlar a
visibilidade da vista dos marcadores. Nota: esta opção não tem qualquer efeito no infocenter. |
true |
windowTitlePrefix |
Definir como true ou false para controlar o título da janela do browser. Se o valor for true , o título terá um formato "Ajuda - <PRODUCT_NAME> ", caso contrário, o título será "<PRODUCT_NAME> ", onde <PRODUCT_NAME> é o nome do produto do Eclipse definido na função primária. |
true |
loadBookAtOnceLimit |
O número máximo de tópicos que um manual pode ter, para a navegação ser transferida pelo browser como um documento. A navegação para manuais maiores é transferida dinamicamente, poucos níveis de cada vez. São transferidos mais tópicos conforme o necessário, quando os ramos são expandidos. | 1000 |
dynamicLoadDepthsHint |
O número sugerido de níveis na navegação de tópicos transferidos para o browser para manuais de grande dimensão.
O valor tem de ser maior do que 0 . O número real de níveis pode
ser diferente para a árvore ampla, se o número de níveis sugerido contiver um
número elevado de tópicos. |
3 |
imagesDirectory |
O directório que contém as imagens utilizadas na visualização da ajuda. As imagens devem ter o mesmo nome que o plug-in org.eclipse.help.webapp.
Utilizar o formato /pluginID/directory . |
images |
advanced.toolbarBackground |
Segundo plano de CSS para barras de ferramentas. O valor é utilizador nos browsers que apresentam a UI de ajuda avançada. | ButtonFace |
advanced.viewBackground |
Segundo plano de CSS para visualizações de navegação. O valor é utilizador nos browsers que apresentam a UI de ajuda avançada. | Window |
advanced.toolbarFont |
Tipo de letra CSS para barras de ferramentas. O valor é utilizador nos browsers que apresentam a UI de ajuda avançada. | icon |
advanced.viewFont |
Tipo de letra CSS para visualizações de navegação. O valor é utilizador nos browsers que apresentam a UI de ajuda avançada. | icon |
basic.toolbarBackground |
Cor de segundo plano para barras de ferramentas. O valor é utilizador nos browsers que apresentam a UI de ajuda básica. | #D4D0C8 |
basic.viewBackground |
Cor de segundo plano para visualizações de navegação. O valor é utilizador nos browsers que apresentam a UI de ajuda básica. | #FFFFFF |
locales |
A lista dos locales que o infocenter irá reconhecer e para
os quais irá fornecer um conteúdo personalizado; se os locales (ou linguagens)
aceites pelo browser de cliente não corresponderem a nenhum dos locales nesta
lista, o browser receberá o conteúdo para locale predefinido - o locale do
servidor ou o locale especificado pela opção -nl da linha de
comandos do Eclipse; se a lista não for especificada, o browser receberá os
conteúdos para o locale preferido; nota: não fornecer esta opção poderá
resultar em requisitos de memória e espaço em disco de grandes dimensões, já
que os ecrãs de navegação e os índices serão criados para cada locale preferido
distinto entre os browsers que acedem ao infocenter. Exemplo: locales=en ja zh_CN zh_TW |
|
productIndex |
Se for fornecido um índice de documentação pré-construído com o produto, deve especificar-se aqui o ID do plug-in que fornece o índice ao sistema de ajuda. | |
always_external_browser |
Utilizar incorporado sempre que seja possível (no Windows ou Linux) ou sempre externo. Definir como true irá forçar o uso do browser externo. A opção não tem qualquer efeito se o browser incorporado não estiver disponível numa plataforma fornecida. |
false |
default_browser |
O browser externo predefinido. O ID de um dos browsers da Web externo para o ponto de extensão org.eclipse.help.base.browser que o sistema irá utilizar.
O método Esta preferência controla os browser externos no modo de ajuda autónomo. No modo de ambiente de trabalho, a ajuda utilizar os browsers fornecidos pelo suporte do browser da área de trabalho. |
definido dinamicamente como predefinição com base no browser disponível num determinado sistema |
custom_browser_path |
Caminho executável do browser personalizado Esta preferência controla os browser externos no modo de ajuda autónomo. No modo de ambiente de trabalho, a ajuda utilizar os browsers fornecidos pelo suporte do browser da área de trabalho. |
C:\Program Files\Internet Explorer\IEXPLORE.EXE" %1 - no Windows, "konqueror %1" - no Linux "mozilla %1" - noutras plataformas |
showDisabledActivityTopics |
O sistema de ajuda filtra os tópicos de capacidades desactivadas. Esta opção controla este comportamento e a existência do botão Mostrar Todos os Tópicos. Valores aceites: never , off , on ,
always never - não se mostram os tópicos de capacidades desactivadasoff - o utilizador pode escolher mostrar todos os tópicos, tópicos desactivados inicialmente ocultoson - o utilizador pode escolher mostrar todos os tópicos, todos os tópicos inicialmente mostradosalways - são apresentados os tópicos das capacidades desactivadas que são mostradas (filtração desactivada) |
off |
activeHelp |
Permite a activação e desactivação a execução da ajuda activa.
A opção não tem qualquer efeito na configuração do infocenter, onde a ajuda activa está desactivada. Valores aceites: true - acções de ajuda activa activadas predefinidasfalse - infra-estrutura de ajuda activa desactivada |
true |
window_infopop |
Permite a activação de janelas emergente de informação à antiga quando a tecla de ajuda é premida nas janelas da área de trabalho. Se o valor for false, abre-se, em vez disso, uma nova visualização da ajuda dinâmica. | false |
dialog_infopop |
Permite a activação de janelas emergente de informação à antiga quando a tecla de ajuda é premida nas caixas de diálogo. Se o valor for false, abre-se, em vez disso, uma nova janela de ajuda dinâmica. |
false |
Chave de preferência | Utilização |
Predefinição |
port |
O número de porta no qual o servidor aguarda por pedidos http. Se a porta não for fornecida, o sistema escolhe uma porta arbitrária. | |
host |
O endereço ou nome do sistema central a utilizar para estabelecer ligação ao servidor. O valor predefinido é nothing (nenhum) e o Eclipse irá escolher um endereço local disponível. Os produtos que utilizam a ajuda no modo local (ambiente de trabalhou ou autónomo, não o infocenter), pode definir esta preferência para " |
Chave de preferência | Utilização |
Predefinição |
acceptCount |
O comprimento máximo de fila para os pedidos de ligação de entrada quando todos os módulos de processamento de pedidos possíveis estiverem a ser utilizados. Quaisquer pedidos recebido quando a fila estiver cheia serão recusados. | 100 |
maxProcessors |
O número máximo de módulos de processamento de pedidos que este plug-in irá criar, o que, por conseguinte, determina o número máximo de pedidos simultâneos que podem ser processados. |
75 |
minProcessors |
O número de módulo de processamento de pedidos que serão criados quando este plug-in for iniciado pela primeira vez. Este atributo deverá ser definido para um valor menor do que o que foi definido para maxProcessors. |
5 |