3  User's Guide DTDs

3 User's Guide DTDs

The part DTD is intended for a "normal" document, like the User's Guide or Release Notes. First are some paragraphs introducing the main contents. After that follows chapters, written in separate files with the chapter DTD.

Example:

<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE part SYSTEM "part.dtd">
<part>
  <header>
    <title>The chapter title</title>
    <prepared>The author</prepared>
    <docno/>
    <date/>
    <rev/>
  </header>

  <description>
    <p>Some text..</p>
  </description>

  <include file="file1"></include>
  <include file="file2"></include>
</part>
    

The top level tag of a part DTD.

Contains a <header>, an optional <description>, followed by one or more <include>.

The introduction after the title and before the bulk of included chapters/manual pages.

Contains any combination and any number of block tags except <image> and <table>.

An empty tag. The attribute file specifies a file to include. The .xml file extension should be omitted.

Example:

<include file="notes"></include>
    

The chapter DTD is intended for a chapter in a User's Guide or similar with text divided into sections, which can be nested.

Example:

<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">
<chapter>
  <header>
    <title>Title on first level</title>
    <prepared/>
    <docno/>
    <date/>
    <rev/>
  </header>
  
  <p>Introduction...</p>

  <section>
    <title>Title on second level</title>

    <p>First paragraph.</p>

    <p>Second paragraph etc.</p>

    <section>
      <title>Title on third level</title>

      <p>...</p>
    </section>
  </section>

  ...
</chapter>
    

The top level tag of a chapter DTD.

Contains a <header>, an optional introduction consisting of any combination of block tags, followed by one or more <section>.

Subdivision of a chapter.

Contains an optional <marker>, a <title>, followed by any combination and any number of block tags and <section ghlink="maint/lib/erl_docgen/doc/src/user_guide_dtds.xml#L172">.

Section title, contains plain text.