Agora que dispomos dos ficheiros de conteúdos exemplo podemos criar um ficheiro de índice (toc). Um ficheiro de índice define os pontos de entrada principais para os ficheiros de conteúdos HTML mediante correlação de uma etiqueta de tópico com uma referência num dos ficheiros HTML.
As aplicações que estiverem a ser migradas para a plataforma podem reutilizar documentação existente mediante utilização do ficheiro de índice para definir pontos de entrada para essa documentação.
Um plug-in pode ter um ou mais ficheiros de índice. A nossa documentação exemplo está organizada em três categorias principais: conceitos, tarefas e referência. Como se fazem ficheiros de índice que representem esta estrutura?
Podemos fazer um ficheiro de índice grande ou podemos criar um ficheiro de índice para cada categoria principal de conteúdos. Esta decisão deve ser tomada segundo a forma como as equipas de documentação trabalham em conjunto. Se houver um autor diferente para cada categoria, será preferível manter ficheiros de índice separados para cada categoria. Tal não é ditado pela arquitectura da plataforma.
Neste exemplo, iremos criar um ficheiro de índice para cada categoria principal. Para número tão pequeno de ficheiros, poderá não ser necessário ter ficheiros de índice separados para cada categoria. Iremos construir este exemplo como se tivéssemos mais ficheiros ou autores separados possuidores de cada categoria de conteúdos.
Os ficheiros assemelham-se ao seguinte:
<toc label="Conceitos"> <topic label="Conceito1" href="html/conceitos/conceito1.html"> <topic label="Conceito1_1" href="html/conceitos/conceito1_1.html"/> <topic label="Conceito1_2" href="html/conceitos/conceito1_2.html"/> </topic> </toc>
<toc label="Tarefas"> <topic id="tarefasSimples" label="Coisas Simples"> <topic label="Tarefa1" href="html/tarefas/tarefa1.html"/> <topic label="Tarefa2" href="html/tarefas/tarefa2.html"/> </topic> <topic id="tarefasDivertidas" label="Coisas Divertidas" > <topic label="Tarefa3_1" href="html/tarefas/tarefa3_1.html"/> <topic label="Tarefa3_2" href="html/tarefas/tarefa3_2.html"/> </topic> </toc>
<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 consistir numa simples ligação a conteúdos. Por exemplo, "Tarefa1" faculta uma etiqueta e um tag href que ligam ao conteúdo. Um tópico também pode ser um agrupamento hierárquico de subtópicos sem conteúdo próprio. Por exemplo, "Coisas Divertidas" só tem uma etiqueta e subtópicos, mas não tem href . Os tópicos também podem fazer as duas coisas. "Conceito1" tem href e subtópicos.
Conteúdo dinâmico
O conteúdo dinâmico está disponível para o índice sob a forma de filtros e âncoras. Por exemplo, poderá desejar que um tópico seja apenas apresentado no índice quando estiver a ser executado um sistema operativo específico.
As Inclusões não são suportadas, uma vez que não são necessárias. Em vez disso, utilize ligações.