當外掛程式提供功能給平台時,通常會新增說明新功能的文件。如何設計這份文件的結構,才讓使用者看到有凝聚性而且完整的文件,而不是許多個別的構成要素。目錄定義提供由上而下以及由下而上方式 來建置文件的機制。
由上而下的巢狀結構是指定義主要目錄,其中參照所以其他併入的 toc 的技術。由上而下的巢狀結構是將已知內容分割為小部分的便利方法。在由上而下巢狀結構中,目錄定義中的 link 屬性可參照鏈結的 toc 而不使用 href。
<toc label="Online Help Sample" topic="html/book.html"> <topic label="概念"> <link toc="toc_Concepts.xml" /> </topic> <topic label="作業"> <link toc="toc_Tasks.xml" /> </topic> <topic label="參照"> <link toc="toc_Ref.xml" /> </topic> </toc>
基本結構維持相同(概念、作業、參照),但是個別 toc 則自由發展。它們依序鏈結至其他的子 toc。
由下而上組合更有彈性;它讓新的外掛程式決定文件在 toc 結構中的位置。使用 anchor 屬性可完成由下而上組合。toc 定義其他外掛程式可提供文件的具名定錨點。在範例中,我們可新增錨點,所以外掛程式可在概念、作業和參照區段中提供其他資料。
<toc label="Online Help Sample" topic="html/book.html"> <topic label="概念"> <link toc="toc_Concepts.xml" /> <anchor id="postConcepts" /> </topic> <topic label="作業"> <link toc="toc_Tasks.xml" /> <anchor id="postTasks" /> </topic> <topic label="參照"> <link toc="toc_Ref.xml" /> <anchor id="postReference" /> </topic> </toc>
其他外掛程式可以從他們的外掛程式提供至錨點。定義 toc 時可使用 link_to 屬性來完成。
<toc link_to="../com.example.helpexample/toc.xml#postConcepts" label="關於概念的最新資訊"> <topic> ... </topic> </toc>