User's Guide
Reference Manual
Release Notes
PDF
Top

Erl_Docgen
User's Guide
Version 0.4.1

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

# 5 Header Tags

Each document begins with a header part, which looks the same for all DTDs. Here the title of the document is specified, as well as administrative data like who is responsible for the document, which version is it, when was it last changed and such.

An full header looks like:

    <header>
      <copyright>...</copyright>
      <legalnotice>...</legalnotice>
      <title>...</title>
      <prepared>...</prepared>
      <responsible>...</responsible>
      <docno>...</docno>
      <approved>...</approved>
      <checked>...</checked>
      <date>...</date>
      <rev>...</rev>
      <file>...</file>
    </header>

### 5.1 <header>

Top level tag for the header part.

### 5.2 <copyright>

The copyright element holds information about date(s) and holder(s) of a document copyright. The copyright element is optional. The copyright element has an inner structure containing one or more year elements followed by zero of more holder elements.
See example below:

        <copyright>
          <year>1997</year>
          <year>2007</year>
          <holder>Ericsson AB</holder>
        </copyright>

### 5.3 <legalnotice>

The legalnotice element is used to express copyright, trademark, license, and other legal formalities of a document. The element contains only PCDATA in the same manner as code and pre.

### 5.4 <title>

For part and application documents, this will be the title of the document, visible in the left frame and on the front page.

For chapter documents, this will be the chapter name.

For reference manual documents, this tag is ignored.

### 5.5 <shorttitle>

This optional tag is ignored. It will likely be removed in the future.

### 5.6 <prepared>

This tag is intended for administrative use and is ignored.

### 5.7 <responsible>

This optional tag is intended for administrative use and is ignored.

### 5.8 <docno>

Document number.

For part and application documents, the document number is visible in the left frame and on the front page.

For other types of documents, this tag is ignored.

### 5.9 <approved>

This optional tag is intended for administrative use and is ignored.

### 5.10 <checked>

This optional tag is intended for administrative use and is ignored.

### 5.11 <date>

This tag is intended for administrative use and is ignored.

### 5.12 <rev>

Document version.

For part and application documents, the document version is visible in the left frame and on the front page.

For other types of documents, this tag is ignored.

### 5.13 <file>

This optional tag is intended for administrative use and is ignored.