[Ericsson AB]

2 User's Guide DTDs

2.1 The part DTD

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.

A typical part:

<?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 <header> part is described in Header Tags.

The optional <description> part is described below.

One or more chapter files can be included using <include>, see below.

2.2 <description>

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

This tag is optional. Can contain any combination and any number of block tags except <image> and <table>.

2.3 <include>

A part or application document can include one or more files. Which file to include is specified using the file attribute. The .xml file extension should be omitted.

Example:

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

2.4 The chapter DTD

The chapter DTD is intended for segments of plain text. The text is divided into sections, which can be nested.

An 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>
    

Between the header and the included files, there can be an introduction consisting of any combination of block tags.

2.5 <chapter>

The top level tag.

2.6 <section>

Possibly nested subdivisions of the document. Contains an optional <marker>, a title <title> containing plain text, followed by any combination and any number of <section> and block tags.


docbuilder 0.9
Copyright © 1991-2007 Ericsson AB