MySQL Guide to MySQL Documentation  /  ...  /  Writing an Arby Template

3.3.2 Writing an Arby Template

An Arby template is just a DocBook XML document that includes specially formatted comment tags. These comment tags are replaced with the corresponding fragment from the arbitrary documentation specification. The template document can contain any standard DocBook XML, even additional chapters, sections and statements to include other entire files into the document.

To insert a fragment definition from the arbitrary specification, use an XML comment of this form, where fragment-id is the ID of the corresponding fragment in the specification:

<!--FRAGMENT fragment-id-->

These specifications should be placed in the appropriate place within your document. For example, if your fragment specification creates a chapter, place the specification at the top level in the document. If the specification is a section, include it in a parent chapter.

Also be aware that you could, if you wanted, generated multiple arbitrary documents which are themselves imported and inserted into existing documents.