Índice TOC (Table of Contents)

Identificador: org.eclipse.help.toc

Descrição: Para registrar uma contribuição de ajuda online para um plug-in individual.

Cada plug-in que contribui com os arquivos de ajuda deve geralmente fazer o seguinte:

Marcação da Configuração:

   <!ELEMENT extension (toc*)>

   <!ATTLIST extension
     point CDATA #REQUIRED
     id    CDATA #IMPLIED
     name  CDATA #IMPLIED
   >

   <!ELEMENT toc EMPTY>

   <!ATTLIST toc
     file     CDATA #REQUIRED
      primary   (true | false) "false"
     extradir CDATA #IMPLIED
   >

Exemplos: A seguir, um exemplo de utilização do ponto de extensão toc.

(no arquivo plugin.xml)

 <extension point="org.eclipse.help.toc">
  <toc file="maindocs.html" primary="true"/>
  <toc file="task.xml"/>
  <toc file="sample.xml" extradir="samples"/>
 </extension>

(no arquivo maindocs.xml)

<toc label="Help System Example">
 <topic label="Introduction" href="intro.html"/>
 <topic label="Tasks">
  <topic label="Creating a Project" href="tasks/task1.html">
   <topic label="Creating a Web Project" href="tasks/task11.html"/>
   <topic label="Creating a Java Project" href="tasks/task12.html"/>
  </tópico>
  <link toc="task.xml" />
  <topic label="Testing a Project" href="tasks/taskn.html"/>
 </tópico>
 <topic label="Samples">
  <topic label="Creating Java Project" href="samples/sample1.html">
   <topic label="Launch a Wizard" href="samples/sample11.html"/>
   <topic label="Set Options" href="samples/sample12.html"/>
   <topic label="Finish Creating Project" href="samples/sample13.html"/>
  </tópico>
  <anchor id="samples" />
 </tópico>
</toc>


(no arquivo tasks.xml)

<toc label="Building a Project">
 <topic label="Building a Project" href="build/building.html">
  <topic label="Building a Web Project" href="build/web.html"/>
  <topic label="Building a Java Project" href="build/java.html"/>
 </tópico>
</toc>


(no arquivo samples.xml)

<toc link_to="maindocs.xml#samples" label="Using The Compile Tool">
 <topic label="The Compile Tool Sample" href="compilesample/example.html">
  <topic label="Step 1" href="compilesample/step1.html"/>
  <topic label="Step 2" href="compilesample/step2.html"/>
  <topic label="Step 3" href="compilesample/step3.html"/>
  <topic label="Step 4" href="compilesample/step4.html"/>
 </tópico>
</toc>

Supondo a existência de mais documentos com o caminho que começa com "samples", eles não serão exibidos na árvore de navegação, mas poderão ser acessados utilizando a pesquisa.  Isso ocorre por causa da presença do atributo "extradir" no arquivo <toc file="sample.xml" extradir="samples" /> inside plugin.xml do elemento. Por exemplo, pesquisar "Criando Projeto Java" poderia retornar um documento "Outras Maneiras de Criação do Projeto Java", cujo caminho é samples/sample2.html.

Internacionalização Os arquivos XML de índice podem ser traduzidos e a cópia resultante (com rótulos traduzidos) deve ser colocada no diretório nl/<idioma>/<país> ou nl/<idioma>.  <idioma> e <país> significam códigos de idioma e país de duas letras, conforme utilizado em códigos de localidade.  Por exemplo, as traduções do chinês tradicional deverão ser colocadas no diretório nl/zh/TW.  O diretório nl/<idioma>/<país> possui prioridade mais alta que o diretório nl/<idioma>.  Apenas se nenhum arquivo for encontrado no diretório nl/<idioma>/<país>, o arquivo que reside no diretório nl/<idioma> será utilizado.  O diretório raiz de um plugin será pesquisado por último.

A documentação contida no doc.zip pode ser localizada criando um arquivo doc.zip com a versão traduzida de documentos e colocando doc.zip no diretório
nl/<idioma>/<país> ou nl/<idioma>. O sistema de ajuda procurará os arquivos nesses diretórios antes de padronizar o diretório de plug-in.
 

Informações de API: Não é necessário nenhum código para utilizar esse ponto de extensão. É necessário apenas fornecer os arquivos manifest adequados, mencionados no arquivo plugin.xml.

Informações Fornecidas:A implementação padrão da interface do sistema de ajuda fornecida com a plataforma Eclipse suporta totalmente o ponto de extensão toc.

Copyright (c) 2000, 2003 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais que o acompanham são disponibilizados sob os termos da Common Public License v1.0 que acompanha esta distribuição e estão disponíveis no endereço http://www.eclipse.org/legal/cpl-v10.html