Beágyazott dokumentációstruktúra létrehozása

Mivel a bedolgozók funkciót biztosítanak a platform számára, általános, hogy dokumentációt is biztosít, amely leírja az új funkciót.   Hogyan strukturálható a dokumentáció, hogy a felhasználó a dokumentáció teljes összefüggő halmazát lássa számos különálló rész helyett? A tartalomjegyzék definíció egy mechanizmust biztosít a dokumentáció összeépítéséhez fentről lefelé, illetve lentről felfelé módon egyaránt.

Fentről lefelé beágyazás

A fentről lefelé beágyazás az elsődleges tartalomjegyzék megadására hivatkozik, amely az összes többi megadott toc fájlra hivatkozik.  A fentről lefele beágyazás egy megfelelő módszer az ismert tartalom kisebb darabokra tördeléséhez. A fentről lefelé beágyazás esetén egy link attribútumot használ a rendszer a tartalomjegyzék definícióban a csatolt toc fájlokra hivatkozáshoz href biztosítása helyett. 

<toc label="Online súgó példa"
topic="html/book.html">
	<topic label="Alapelvek">
		<link toc="toc_Concepts.xml" />
	</topic>
	<topic label="Feladatok">
		<link toc="toc_Tasks.xml" />
	</topic>
	<topic label="Hivatkozás">
		<link toc="toc_Ref.xml" />
	</topic>
</toc>

Az alap struktúra ugyanaz marad (Alapelvek, Feladatok, Hivatkozás), de az egyedi toc fájlok szabadon alakíthatók.  Ezek pedig más al toc fájlokra hivatkozhatnak.

Lentről felfelé elrendezés

A lentről felfelé elrendezés rugalmasabb abban, hogy ennek segítségével az új bedolgozók eldönthetik, hogy a dokumentumnak hol kell lennie a toc struktúrában.  A lentről felfelé elrendezés a anchor attribútumok segítségével kerül létrehozásra.  A toc fájl megnevezett horgonypontokat hoz létre, amelyben más bedolgozók adhatnak közre dokumentációt.  A példánkban horgonyokat vehetünk fel, így a bedolgozók további anyagot adhatnak közre az alapelvek, feladatok és hivatkozás részekben.

<toc label="Online súgó példa" topic="html/book.html">
	<topic label="Alapelvek">
		<link toc="toc_Concepts.xml" />
		<anchor id="postConcepts" />
	</topic>
	<topic label="Feladatok">
		<link toc="toc_Tasks.xml" />
		<anchor id="postTasks" />
	</topic>
	<topic label="Hivatkozás">
		<link toc="toc_Ref.xml" />		
		<anchor id="postReference" />
	</topic>
</toc>

A többi bedolgozó ezután kiegészítheti a horgonyt a bedolgozóból.   Ez a link_to attribútum segítségével hajtható végre a toc létrehozásakor.

<toc link_to="../com.example.helpexample/toc.xml#postConcepts" label="Late breaking info about concepts">
	<topic>
		...
	</topic>
</toc>