[Ericsson AB]

4 Fascicules DTDs

4.1 The fascicules DTD

The fascicules DTD is a special kind of DTD which can be used to specify the different parts of the documentation, and which one of those should be shown as default. Example

<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE fascicules SYSTEM "fascicules.dtd">
<fascicules>
  <fascicule file="part" href="part_frame.html" entry="no">
    User's Guide
  </fascicule>
  <fascicule file="application" href="application_frame.html" entry="yes">
    Reference Manual
  </fascicule>
  <fascicule file="part_notes" href="part_notes_frame.html" entry="no">
    Release Notes
  </fascicule>
</fascicules>
    

Specifies that the documentation for this application consists of three parts: User's Guide, where the "cover page" (with the two frames) is located in part_frame.html, Reference Manual with the cover page application_frame.html and Release Notes with the cover page part_notes_frame.html.

As a result, at the top of the left frame in the generated HTML documentation, there will be corresponding links to User's Guide, Reference Manual and Release Notes.

The <fascicules> attribute entry specifies that it is the Reference Manual which should be shown as default. This means that when generating the HTML files, application_frame.html will be copied to index.html.

Note!

DocBuilder assumes that the XML file written according to the fascicules DTD is called fascicules.xml.

This file is optional. If it does not exist, there are no links to other parts of the documentation (as they are not known) in the left frame, and no index.html is created.


docbuilder 0.9
Copyright © 1991-2007 Ericsson AB