<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- Header Tags</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/docbuilder-0.9.8.7.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>DocBuilder</strong><br><strong>User's Guide</strong><br><small>Version 0.9.8.7</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu">
<li id="no" title="Overview" expanded="false">Overview<ul>
<li><a href="overview.html">
Top of chapter
</a></li>
<li title="Background"><a href="overview.html#id2255927">Background</a></li>
<li title="DTD Suite"><a href="overview.html#id2261226">DTD Suite</a></li>
<li title="Structure of Generated HTML"><a href="overview.html#id2252211">Structure of Generated HTML</a></li>
<li title="Basic Tags"><a href="overview.html#id2259883">Basic Tags</a></li>
<li title="About This Document"><a href="overview.html#id2259327">About This Document</a></li>
<li title="Usage"><a href="overview.html#id2259855">Usage</a></li>
</ul>
</li>
<li id="no" title="User's Guide DTDs" expanded="false">User's Guide DTDs<ul>
<li><a href="user_guide_dtds.html">
Top of chapter
</a></li>
<li title="The part DTD"><a href="user_guide_dtds.html#id2255918">The part DTD</a></li>
<li title="<part>"><a href="user_guide_dtds.html#id2252604"><part></a></li>
<li title="<description>"><a href="user_guide_dtds.html#id2257848"><description></a></li>
<li title="<include>"><a href="user_guide_dtds.html#id2259250"><include></a></li>
<li title="The chapter DTD"><a href="user_guide_dtds.html#id2260255">The chapter DTD</a></li>
<li title="<chapter>"><a href="user_guide_dtds.html#id2259926"><chapter></a></li>
<li title="<section>"><a href="user_guide_dtds.html#id2259200"><section></a></li>
<li title="<title>"><a href="user_guide_dtds.html#id2252192"><title></a></li>
</ul>
</li>
<li id="no" title="Reference Manual DTDs" expanded="false">Reference Manual DTDs<ul>
<li><a href="refman_dtds.html">
Top of chapter
</a></li>
<li title="The application DTD"><a href="refman_dtds.html#id2259344">The application DTD</a></li>
<li title="<application>"><a href="refman_dtds.html#id2258600"><application></a></li>
<li title="The appref DTD"><a href="refman_dtds.html#id2261527">The appref DTD</a></li>
<li title="The comref DTD"><a href="refman_dtds.html#id2261698">The comref DTD</a></li>
<li title="The cref DTD"><a href="refman_dtds.html#id2261823">The cref DTD</a></li>
<li title="The erlref DTD"><a href="refman_dtds.html#id2253008">The erlref DTD</a></li>
<li title="The fileref DTD"><a href="refman_dtds.html#id2255212">The fileref DTD</a></li>
<li title="<description>"><a href="refman_dtds.html#id2252314"><description></a></li>
<li title="<section>"><a href="refman_dtds.html#id2261020"><section></a></li>
<li title="<funcs>"><a href="refman_dtds.html#id2261064"><funcs></a></li>
<li title="<func>"><a href="refman_dtds.html#id2261090"><func></a></li>
<li title="<name>"><a href="refman_dtds.html#id2261135"><name></a></li>
<li title="<fsummary>"><a href="refman_dtds.html#id2265198"><fsummary></a></li>
<li title="<type>"><a href="refman_dtds.html#id2265227"><type></a></li>
<li title="<v>"><a href="refman_dtds.html#id2265260"><v></a></li>
<li title="<d>"><a href="refman_dtds.html#id2265277"><d></a></li>
<li title="<desc>"><a href="refman_dtds.html#id2265306"><desc></a></li>
<li title="<authors>"><a href="refman_dtds.html#id2265337"><authors></a></li>
<li title="<aname>"><a href="refman_dtds.html#id2265373"><aname></a></li>
<li title="<email>"><a href="refman_dtds.html#id2265389"><email></a></li>
</ul>
</li>
<li id="no" title="Fascicules DTDs" expanded="false">Fascicules DTDs<ul>
<li><a href="fasc_dtds.html">
Top of chapter
</a></li>
<li title="The fascicules DTD"><a href="fasc_dtds.html#id2265458">The fascicules DTD</a></li>
<li title="<fascicules>"><a href="fasc_dtds.html#id2265565"><fascicules></a></li>
<li title="<fascicule>"><a href="fasc_dtds.html#id2265595"><fascicule></a></li>
</ul>
</li>
<li id="loadscrollpos" title="Header Tags" expanded="true">Header Tags<ul>
<li><a href="header_tags.html">
Top of chapter
</a></li>
<li title="<header>"><a href="header_tags.html#id2263347"><header></a></li>
<li title="<copyright>"><a href="header_tags.html#id2263363"><copyright></a></li>
<li title="<legalnotice>"><a href="header_tags.html#id2263412"><legalnotice></a></li>
<li title="<title>"><a href="header_tags.html#id2263441"><title></a></li>
<li title="<shorttitle>"><a href="header_tags.html#id2263474"><shorttitle></a></li>
<li title="<prepared>"><a href="header_tags.html#id2263492"><prepared></a></li>
<li title="<responsible>"><a href="header_tags.html#id2263509"><responsible></a></li>
<li title="<docno>"><a href="header_tags.html#id2263526"><docno></a></li>
<li title="<approved>"><a href="header_tags.html#id2263559"><approved></a></li>
<li title="<checked>"><a href="header_tags.html#id2263576"><checked></a></li>
<li title="<date>"><a href="header_tags.html#id2263594"><date></a></li>
<li title="<rev>"><a href="header_tags.html#id2263611"><rev></a></li>
<li title="<file>"><a href="header_tags.html#id2263644"><file></a></li>
</ul>
</li>
<li id="no" title="Block Tags" expanded="false">Block Tags<ul>
<li><a href="block_tags.html">
Top of chapter
</a></li>
<li title="<br> - Line Break"><a href="block_tags.html#id2263775"><br> - Line Break</a></li>
<li title="<code> - Code Example"><a href="block_tags.html#id2263814"><code> - Code Example</a></li>
<li title="<codeinclude> - Code Inclusion"><a href="block_tags.html#id2263872"><codeinclude> - Code Inclusion</a></li>
<li title="<erleval> - Erlang Evaluation"><a href="block_tags.html#id2263953"><erleval> - Erlang Evaluation</a></li>
<li title="<list> - List"><a href="block_tags.html#id2263989"><list> - List</a></li>
<li title="<marker> - Marker"><a href="block_tags.html#id2264076"><marker> - Marker</a></li>
<li title="<p> - Paragraph"><a href="block_tags.html#id2264104"><p> - Paragraph</a></li>
<li title="<note> - Note"><a href="block_tags.html#id2264149"><note> - Note</a></li>
<li title="<pre> - Pre-formatted Text"><a href="block_tags.html#id2264198"><pre> - Pre-formatted Text</a></li>
<li title="<quote> - Quotation"><a href="block_tags.html#id2264278"><quote> - Quotation</a></li>
<li title="<taglist> - Definition List"><a href="block_tags.html#id2264331"><taglist> - Definition List</a></li>
<li title="<warning> - Warning"><a href="block_tags.html#id2264437"><warning> - Warning</a></li>
<li title="<image> - Image"><a href="block_tags.html#id2264492"><image> - Image</a></li>
<li title="<table> - Table"><a href="block_tags.html#id2264557"><table> - Table</a></li>
</ul>
</li>
<li id="no" title="Inline Tags" expanded="false">Inline Tags<ul>
<li><a href="inline_tags.html">
Top of chapter
</a></li>
<li title="<br> - Line Break"><a href="inline_tags.html#id2264769"><br> - Line Break</a></li>
<li title="<c> - Code"><a href="inline_tags.html#id2264797"><c> - Code</a></li>
<li title="<em> - Emphasis"><a href="inline_tags.html#id2264848"><em> - Emphasis</a></li>
<li title="<marker> - Marker"><a href="inline_tags.html#id2264891"><marker> - Marker</a></li>
<li title="<path> - Path"><a href="inline_tags.html#id2264939"><path> - Path</a></li>
<li title="<seealso> - Local Cross Reference"><a href="inline_tags.html#id2265025"><seealso> - Local Cross Reference</a></li>
<li title="<url> - Non-Local Cross Reference"><a href="inline_tags.html#id2265132"><url> - Non-Local Cross Reference</a></li>
<li title="<term>, <termdef> - Glossary"><a href="inline_tags.html#id2266646"><term>, <termdef> - Glossary</a></li>
<li title="<cite>, <citedef> - Bibliography"><a href="inline_tags.html#id2266761"><cite>, <citedef> - Bibliography</a></li>
</ul>
</li>
<li id="no" title="Character Entities" expanded="false">Character Entities<ul>
<li><a href="character_entities.html">
Top of chapter
</a></li>
<li title="Added Latin 1"><a href="character_entities.html#id2266872">Added Latin 1</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>5 Header Tags</h1>
<p>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.</p>
<p>An full header looks like:</p>
<div class="example"><pre>
<header>
<copyright>...</copyright>
<legalnotice>...</legalnotice>
<title>...</title>
<prepared>...</prepared>
<responsible>...</responsible>
<docno>...</docno>
<approved>...</approved>
<checked>...</checked>
<date>...</date>
<rev>...</rev>
<file>...</file>
</header>
</pre></div>
<h3><a name="id2263347">5.1
<header></a></h3>
<a name="headerTAG"></a>
<p>Top level tag for the header part.</p>
<h3><a name="id2263363">5.2
<copyright></a></h3>
<a name="copyrightTAG"></a>
<p>The <span class="code">copyright</span> element holds information about date(s) and holder(s) of
a document copyright. The <span class="code">copyright</span> element is optional.
The <span class="code">copyright</span> element has an inner structure containing one or
more
<span class="code">year</span> elements followed by zero of more <span class="code">holder</span> elements.<br>
See example below:
</p>
<div class="example"><pre>
<copyright>
<year>1997</year>
<year>2007</year>
<holder>Ericsson AB</holder>
</copyright>
</pre></div>
<h3><a name="id2263412">5.3
<legalnotice></a></h3>
<a name="legalnoticeTAG"></a>
<p>The <span class="code">legalnotice</span> 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 <span class="code">code</span> and <span class="code">pre</span>.
</p>
<h3><a name="id2263441">5.4
<title></a></h3>
<a name="titleTAG"></a>
<p>For <span class="code">part</span> and <span class="code">application</span> documents, this will be
the title of the document, visible in the left frame and on
the front page.</p>
<p>For <span class="code">chapter</span> documents, this will be the chapter name.</p>
<p>For reference manual documents, this tag is ignored.</p>
<h3><a name="id2263474">5.5
<shorttitle></a></h3>
<p>This optional tag is ignored by DocBuilder. It will likely be
removed in the future.</p>
<h3><a name="id2263492">5.6
<prepared></a></h3>
<a name="preparedTAG"></a>
<p>This tag is intended for administrative use and is ignored by
DocBuilder.</p>
<h3><a name="id2263509">5.7
<responsible></a></h3>
<a name="responsibleTAG"></a>
<p>This optional tag is intended for administrative use and is
ignored by DocBuilder.</p>
<h3><a name="id2263526">5.8
<docno></a></h3>
<a name="docnoTAG"></a>
<p>Document number.</p>
<p>For <span class="code">part</span> and <span class="code">application</span> documents, the document
number is visible in the left frame and on the front page.</p>
<p>For other types of documents, this tag is ignored.</p>
<h3><a name="id2263559">5.9
<approved></a></h3>
<a name="approvedTAG"></a>
<p>This optional tag is intended for administrative use and is
ignored by DocBuilder.</p>
<h3><a name="id2263576">5.10
<checked></a></h3>
<a name="checkedTAG"></a>
<p>This optional tag is intended for administrative use and is
ignored by DocBuilder.</p>
<h3><a name="id2263594">5.11
<date></a></h3>
<a name="dateTAG"></a>
<p>This tag is intended for administrative use and is ignored by
DocBuilder.</p>
<h3><a name="id2263611">5.12
<rev></a></h3>
<a name="revTAG"></a>
<p>Document version.</p>
<p>For <span class="code">part</span> and <span class="code">application</span> documents, the document
version is visible in the left frame and on the front page.</p>
<p>For other types of documents, this tag is ignored.</p>
<h3><a name="id2263644">5.13
<file></a></h3>
<a name="fileTAG"></a>
<p>This optional tag is intended for administrative use and is
ignored by DocBuilder.</p>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2010 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
f806c0f24240b25bde21a53f71766070
>
files
>
541
