Arquivos de Índice (toc)

Agora que temos nossos exemplos de arquivos de conteúdo, é possível criar um arquivo de índice (toc). Um arquivo toc define os pontos de entrada principais nos arquivos de conteúdo HTML mapeando um rótulo de tópico a uma referência em um dos arquivos HTML. 

Os aplicativos que estão sendo migrados para a plataforma podem reutilizar a documentação existente utilizando o arquivo toc para definir pontos de entrada nessa documentação.

Um plug-in pode ter um ou mais arquivos toc. Nosso exemplo de documentação é organizado em três categorias principais: conceitos, tarefas e referências. Como criamos arquivos toc que representam essa estrutura?

Poderíamos fazer um arquivo toc grande, ou poderíamos criar um arquivo toc separado para cada categoria principal do conteúdo. Essa decisão pode ser tomada de acordo com o modo de trabalho em conjunto de suas equipes de documentação. Se um autor diferente possuir cada categoria, será melhor manter arquivos toc separados para cada categoria.  Isso não é regido pela arquitetura da plataforma.

Neste exemplo, criaremos um arquivo toc para cada categoria de conteúdo principal. Para um número tão pequeno de arquivos, pode não ser necessário ter arquivos toc separados para cada categoria.  Construiremos este exemplo como se tivéssemos muitos arquivos a mais ou autores separados que possuíssem cada categoria de conteúdo.

Nossos arquivos se parecem com este:

toc_Concepts.xml

   <toc label="Conceitos">
      <topic label="Concept1" href="html/concepts/concept1.html">
         <topic label="Concept1_1" href="html/concepts/concept1_1.html"/>
         <topic label="Concept1_2" href="html/concepts/concept1_2.html"/>
      </topic>
   </toc>

toc_Tasks.xml

   <toc label="Tarefas">
      <topic id="plainTasks" label="Coisas Simples">
         <topic label="Task1" href="html/tasks/task1.html"/>
         <topic label="Task2" href="html/tasks/task2.html"/>
      </topic>
      <topic id="funTasks" label="Coisas Engraçadas" >
         <topic label="Task3_1" href="html/tasks/task3_1.html"/>
         <topic label="Task3_2" href="html/tasks/task3_2.html"/>
      </topic>
   </toc>

toc_Ref.xml

   <toc label="Referência">
      <topic label="Ref1" href="html/ref/ref1.html"/>
      <topic label="Ref2" href="html/ref/ref2.html"/>
   </toc>

Um tópico pode ser um link simples a um conteúdo.  Por exemplo, "Task1" fornece um label e um link href para o conteúdo.  Um tópico também pode ser um agrupamento hierárquico de subtópicos sem conteúdo próprio.  Por exemplo, "Coisas Engraçadas" possui apenas um label e subtópicos, mas nenhum href .  Os tópicos também podem fazer ambos.  "Concept1" possui um href e subtópicos.

 

Copyright IBM Corporation e outros 2000, 2003.