24.6. Documentation (*.docbook.def.xml)

A file named <moduleName>.<documentName>.docbook.def.xml defines a chapter or section of documentation. This extension point requires a suffix of ".docbook.def.xml" in order to be recognized by the build system.

Example 24.5, “hackyCore_Build.buildsystem.docbook.def.xml” illustrates an example documentation definition file for a new chapter in the Developer Guide.

Example 24.5. hackyCore_Build.buildsystem.docbook.def.xml

<hackydocbook>
  <chapter guide="Developer"
           fileName="hackyCore_Build.buildsystem.docbook.xml"
           rank="1.1"/>
</hackydocbook>

The definition file specifies the Volume the chapter should go in, the file containing the chapter contents, and a number whose numerical value indicates the ordering of the chapters within this volume.

Example 24.6, “hackyCore_Build.extensionpoint.docbook.def.xml” illustrates an example documentation definition file for a new section in the Reference Guide.

Example 24.6. hackyCore_Build.extensionpoint.docbook.def.xml

<hackydocbook>
  <reference-guide-section chapter="Extension Point Definition Files"
                           sortString=""
                           fileName="hackyCore_Build.overview.extensionpoint.docbook.xml" />
</hackydocbook>

This definition file indicates the Chapter of the Reference Guide that this section will appear in, a string to be used to sort the sections within the chapter, and the name of the file containing the chapter.