Archivos de tabla de contenido (toc)

Ahora que tenemos nuestros archivos de contenido de ejemplo, podemos crear un archivo de tabla de contenido (toc). Un archivo toc define los puntos de entrada clave situados en los archivos de contenido HTML, y para ello correlaciona la etiqueta de un tema con una referencia de uno de los archivos HTML. 

Las aplicaciones que se estén migrando a la plataforma pueden reutilizar la documentación existente empleando el archivo toc para definir puntos de entrada en la documentación.

Un conector puede tener uno o más archivos toc. Nuestra documentación de ejemplo está organizada en tres categorías principales: conceptos, tareas y consulta. ¿Cómo haremos que los archivos toc representen esta estructura?

Podríamos crear un solo archivo toc de gran tamaño o bien crear un archivo toc aparte para cada categoría de contenido principal. Esta decisión debe tomarse en función de cómo colaboren los equipos de documentación. Si cada categoría es propiedad de un autor distinto, sería preferible mantener aparte los archivos toc de cada categoría.  Esto no viene impuesto por la arquitectura de la plataforma.

En este ejemplo, crearemos un archivo toc por cada categoría principal de contenido. Cuando hay un número pequeño de archivos, puede que no sea necesario tener un archivo toc aparte para cada categoría.  Construiremos este ejemplo como si tuviéramos muchos más archivos o como si cada categoría de contenido fuese propiedad de autores distintos.

Los archivos tienen este aspecto:

toc_Concepts.xml

   <toc label="Conceptos">
      <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="Tareas">
      <topic id="plainTasks" label="Materias básicas">
         <topic label="Task1" href="html/tasks/task1.html"/>
         <topic label="Task2" href="html/tasks/task2.html"/>
      </topic>
      <topic id="funTasks" label="Materias divertidas" >
         <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="Consulta">
      <topic label="Ref1" href="html/ref/ref1.html"/>
      <topic label="Ref2" href="html/ref/ref2.html"/>
   </toc>

Un tema puede ser un simple enlace con el contenido.  Por ejemplo, "Task1" proporciona los enlaces label y href con el contenido.  Un tema también puede ser una agrupación jerárquica de subtemas sin contenido por sí misma.  Por ejemplo, "Materias divertidas" sólo tiene label y subtemas, pero no href.  También pueden ser ambas cosas.  "Concept1" tiene href y subtemas.

 

Copyright IBM Corporation y otros 2000, 2003.