Índice TOC (Table of Contents)

org.eclipse.help.toc

Para registrar uma contribuição de ajuda on-line para um plug-in individual.

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

Opcionalmente, um índice de procura pode ser pré-construído e registrado utilizando o elemento index para o desempenho da primeira tentativa de procura. Apenas um índice por plug-in pode ser registrado - vários elementos index resultarão em comportamento indefinido.

<!ELEMENT extension (toc* , index?)>

<!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>


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

(desde o 3.1) um elemento opcional que permite a declaração de índice de procura pré-construído criado a partir de documentos contribuídos por esse plug-in.



A seguir encontra-se 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"

/>

<index path=

"index/"

/>

</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.
 

Nenhum código é necessário para utilizar essa ponto de extensão. É necessário apenas fornecer os arquivos manifest adequados, mencionados no arquivo plugin.xml.

A implementação padrão da UI do sistema de ajuda fornecida com a plataforma do Eclipse suporta totalmente o ponto de extensão toc.