Erlang -- User's Guide DTDs

User's Guide
Reference Manual
Release Notes
PDF
Top

Erl_Docgen
User's Guide
Version 0.3.2

Expand All
Contract All

Chapters

- How to Build OTP like documentation
  - Top of chapter
  - Utilities to prepare XML files
  - Use xsltproc to generate different output formats
- Overview OTP DTDs
  - Top of chapter
  - DTD Suite
  - Basic Tags
- 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>
- 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
  - <seealso> - Local Cross Reference
  - <url> - Non-Local Cross Reference
  - <term>, <termdef> - Glossary
  - <cite>, <citedef> - Bibliography
- Character Entities
  - Top of chapter
  - Added Latin 1

# 3 User's Guide DTDs

### 3.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.

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>

### 3.2 <part>

The top level tag of a part DTD.

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

### 3.3 <description>

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

### 3.4 <include>

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

Example:

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

### 3.5 The chapter DTD

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>

### 3.6 <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>.

### 3.7 <section>

Subdivision of a chapter.

Contains an optional <marker>, a <title>, followed by any combination and any number of block tags and <section>.

### 3.8 <title>

Section title, contains plain text.