DocBuilder
User's Guide
Version 0.9.8.7

Chapters

• Overview
  • Top of chapter
  • Background
  • DTD Suite
  • Structure of Generated HTML
  • Basic Tags
  • About This Document
  • Usage
• User's Guide DTDs
  • Top of chapter
  • The part DTD
  • <part>
  • <description>
  • <include>
  • The chapter DTD
  • <chapter>
  • <section>
  • <title>
• Reference Manual DTDs
  • Top of chapter
  • The application DTD
  • <application>
  • The appref DTD
  • The comref DTD
  • The cref DTD
  • The erlref DTD
  • The fileref DTD
  • <description>
  • <section>
  • <funcs>
  • <func>
  • <name>
  • <fsummary>
  • <type>
  • <v>
  • <d>
  • <desc>
  • <authors>
  • <aname>
  • <email>
• Fascicules DTDs
  • Top of chapter
  • The fascicules DTD
  • <fascicules>
  • <fascicule>
• Header Tags
  • Top of chapter
  • <header>
  • <copyright>
  • <legalnotice>
  • <title>
  • <shorttitle>
  • <prepared>
  • <responsible>
  • <docno>
  • <approved>
  • <checked>
  • <date>
  • <rev>
  • <file>
• Block Tags
  • Top of chapter
  • <br> - Line Break
  • <code> - Code Example
  • <codeinclude> - Code Inclusion
  • <erleval> - Erlang Evaluation
  • <list> - List
  • <marker> - Marker
  • <p> - Paragraph
  • <note> - Note
  • <pre> - Pre-formatted Text
  • <quote> - Quotation
  • <taglist> - Definition List
  • <warning> - Warning
  • <image> - Image
  • <table> - Table
• Inline Tags
  • Top of chapter
  • <br> - Line Break
  • <c> - Code
  • <em> - Emphasis
  • <marker> - Marker
  • <path> - Path
  • <seealso> - Local Cross Reference
  • <url> - Non-Local Cross Reference
  • <term>, <termdef> - Glossary
  • <cite>, <citedef> - Bibliography
• Character Entities
  • Top of chapter
  • Added Latin 1

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="ref_man" href="ref_man_frame.html" entry="yes">
    Reference Manual
  </fascicule>
  <fascicule file="part_notes" href="part_notes_frame.html" entry="no">
    Release Notes
  </fascicule>
</fascicules>
    

In the example, it is specified 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 ref_man_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 attribute entry="yes" 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.

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.

4.2  <fascicules>

Top level tag for the fascicules DTD.

Contains one or more <fascicule>.

4.3  <fascicule>

Specifies properties for one "part" of the documentation for an application.

Contains plain text, the name of this part.

The file attribute should specify the file name for the corresponding part or application, without the .xml extension.

The href attribute should specify the file name for the corresponding HTML cover page file, without the .html extension.

The optional entry="yes"|"no" attribute specifies if the HTML cover page should be copied to index.html or not. Default is "no".