| Server IP : 127.0.0.2 / Your IP : 13.59.113.183 Web Server : Apache/2.4.18 (Ubuntu) System : User : www-data ( ) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : disk_free_space,disk_total_space,diskfreespace,dl,exec,fpaththru,getmyuid,getmypid,highlight_file,ignore_user_abord,leak,listen,link,opcache_get_configuration,opcache_get_status,passthru,pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,php_uname,phpinfo,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwnam,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,pclose,popen,proc_open,proc_close,proc_get_status,proc_nice,proc_terminate,shell_exec,source,show_source,system,virtual MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/docutils-doc/docs/ref/ |
Upload File : |
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>The Docutils Document Tree</title>
<meta name="author" content="David Goodger" />
<meta name="date" content="2012-01-03" />
<meta name="copyright" content="This document has been placed in the public domain." />
<link rel="stylesheet" href="../../css/html4css1.css" type="text/css" />
</head>
<body>
<div class="document" id="the-docutils-document-tree">
<h1 class="title">The Docutils Document Tree</h1>
<h2 class="subtitle" id="a-guide-to-the-docutils-dtd">A Guide to the Docutils DTD</h2>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>David Goodger</td></tr>
<tr><th class="docinfo-name">Contact:</th>
<td><a class="first last reference external" href="mailto:docutils-develop@lists.sourceforge.net">docutils-develop@lists.sourceforge.net</a></td></tr>
<tr><th class="docinfo-name">Revision:</th>
<td>7302</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2012-01-03</td></tr>
<tr><th class="docinfo-name">Copyright:</th>
<td>This document has been placed in the public domain.</td></tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#element-hierarchy" id="id185">Element Hierarchy</a></li>
<li><a class="reference internal" href="#element-reference" id="id186">Element Reference</a></li>
<li><a class="reference internal" href="#attribute-reference" id="id187">Attribute Reference</a></li>
<li><a class="reference internal" href="#parameter-entity-reference" id="id188">Parameter Entity Reference</a></li>
</ul>
</div>
<p>This document describes the XML data structure of <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> documents:
the relationships and semantics of elements and attributes. The
Docutils document structure is formally defined by the <a class="reference external" href="docutils.dtd">Docutils
Generic DTD</a> XML document type definition, <a class="reference external" href="docutils.dtd">docutils.dtd</a>, which is
the definitive source for details of element structural relationships.</p>
<p>This document does not discuss implementation details. Those can be
found in internal documentation (docstrings) for the
<tt class="docutils literal">docutils.nodes</tt> module, where the document tree data structure is
implemented in a class library.</p>
<p>The reader is assumed to have some familiarity with XML or SGML, and
an understanding of the data structure meaning of "tree". For a list
of introductory articles, see <a class="reference external" href="http://xml.coverpages.org/xmlIntro.html">Introducing the Extensible Markup
Language (XML)</a>.</p>
<p>The <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> markup is used for illustrative examples
throughout this document. For a gentle introduction, see <a class="reference external" href="../user/rst/quickstart.html">A
ReStructuredText Primer</a>. For complete technical details, see the
<a class="reference external" href="rst/restructuredtext.html">reStructuredText Markup Specification</a>.</p>
<div class="section" id="element-hierarchy">
<h1><a class="toc-backref" href="#id185">Element Hierarchy</a></h1>
<div class="contents local topic" id="id2">
<ul class="simple">
<li><a class="reference internal" href="#structural-elements" id="id189">Structural Elements</a><ul>
<li><a class="reference internal" href="#structural-subelements" id="id190">Structural Subelements</a><ul>
<li><a class="reference internal" href="#bibliographic-elements" id="id191">Bibliographic Elements</a></li>
<li><a class="reference internal" href="#decorative-elements" id="id192">Decorative Elements</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#body-elements" id="id193">Body Elements</a><ul>
<li><a class="reference internal" href="#simple-body-elements" id="id194">Simple Body Elements</a></li>
<li><a class="reference internal" href="#compound-body-elements" id="id195">Compound Body Elements</a><ul>
<li><a class="reference internal" href="#body-subelements" id="id196">Body Subelements</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#inline-elements" id="id197">Inline Elements</a></li>
</ul>
</div>
<p>Below is a simplified diagram of the hierarchy of elements in the
Docutils document tree structure. An element may contain any other
elements immediately below it in the diagram. Notes are written in
square brackets. Element types in parentheses indicate recursive or
one-to-many relationships; sections may contain (sub)sections, tables
contain further body elements, etc.</p>
<pre class="literal-block">
+--------------------------------------------------------------------+
| document [may begin with a title, subtitle, decoration, docinfo] |
| +--------------------------------------+
| | sections [each begins with a title] |
+-----------------------------+-------------------------+------------+
| [body elements:] | (sections) |
| | - literal | - lists | | - hyperlink +------------+
| | blocks | - tables | | targets |
| para- | - doctest | - block | foot- | - sub. defs |
| graphs | blocks | quotes | notes | - comments |
+---------+-----------+----------+-------+--------------+
| [text]+ | [text] | (body elements) | [text] |
| (inline +-----------+------------------+--------------+
| markup) |
+---------+
</pre>
<p>The Docutils document model uses a simple, recursive model for section
structure. A <a class="reference internal" href="#document">document</a> node may contain body elements and <a class="reference internal" href="#section">section</a>
elements. Sections in turn may contain body elements and sections.
The level (depth) of a section element is determined from its physical
nesting level; unlike other document models (<tt class="docutils literal"><h1></tt> in <a class="reference external" href="http://www.w3.org/MarkUp/">HTML</a>,
<tt class="docutils literal"><sect1></tt> in <a class="reference external" href="http://docbook.org/tdg/en/html/docbook.html">DocBook</a>, <tt class="docutils literal"><div1></tt> in <a class="reference external" href="http://www.w3.org/XML/1998/06/xmlspec-report.htm">XMLSpec</a>) the level is not
incorporated into the element name.</p>
<p>The Docutils document model uses strict element content models. Every
element has a unique structure and semantics, but elements may be
classified into general categories (below). Only elements which are
meant to directly contain text data have a mixed content model, where
text data and inline elements may be intermixed. This is unlike the
much looser <a class="reference external" href="http://www.w3.org/MarkUp/">HTML</a> document model, where paragraphs and text data may
occur at the same level.</p>
<div class="section" id="structural-elements">
<h2><a class="toc-backref" href="#id189">Structural Elements</a></h2>
<p>Structural elements may only contain child elements; they do not
directly contain text data. Structural elements may contain body
elements or further structural elements. Structural elements can only
be child elements of other structural elements.</p>
<p>Category members: <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>, <a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#sidebar">sidebar</a></p>
<div class="section" id="structural-subelements">
<h3><a class="toc-backref" href="#id190">Structural Subelements</a></h3>
<p>Structural subelements are child elements of structural elements.
Simple structuctural subelements (<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>) contain text
data; the others are compound and do not directly contain text data.</p>
<p>Category members: <a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>, <a class="reference internal" href="#decoration">decoration</a>, <a class="reference internal" href="#docinfo">docinfo</a>,
<a class="reference internal" href="#transition">transition</a></p>
<div class="section" id="bibliographic-elements">
<h4><a class="toc-backref" href="#id191">Bibliographic Elements</a></h4>
<p>The <a class="reference internal" href="#docinfo">docinfo</a> element is an optional child of <a class="reference internal" href="#document">document</a>. It groups
bibliographic elements together. All bibliographic elements except
<a class="reference internal" href="#authors">authors</a> and <a class="reference internal" href="#field">field</a> contain text data. <a class="reference internal" href="#authors">authors</a> contains further
bibliographic elements (most notably <a class="reference internal" href="#author">author</a>). <a class="reference internal" href="#field">field</a> contains
<a class="reference internal" href="#field-name">field_name</a> and <a class="reference internal" href="#field-body">field_body</a> body subelements.</p>
<p>Category members: <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#authors">authors</a>, <a class="reference internal" href="#contact">contact</a>, <a class="reference internal" href="#copyright">copyright</a>,
<a class="reference internal" href="#date">date</a>, <a class="reference internal" href="#field">field</a>, <a class="reference internal" href="#organization">organization</a>, <a class="reference internal" href="#revision">revision</a>, <a class="reference internal" href="#status">status</a>, <a class="reference internal" href="#version">version</a></p>
</div>
<div class="section" id="decorative-elements">
<h4><a class="toc-backref" href="#id192">Decorative Elements</a></h4>
<p>The <a class="reference internal" href="#decoration">decoration</a> element is also an optional child of <a class="reference internal" href="#document">document</a>. It
groups together elements used to generate page headers and footers.</p>
<p>Category members: <a class="reference internal" href="#footer">footer</a>, <a class="reference internal" href="#header">header</a></p>
</div>
</div>
</div>
<div class="section" id="body-elements">
<h2><a class="toc-backref" href="#id193">Body Elements</a></h2>
<p>Body elements are contained within structural elements and compound
body elements. There are two subcategories of body elements: simple
and compound.</p>
<p>Category members: <a class="reference internal" href="#admonition">admonition</a>, <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#block-quote">block_quote</a>, <a class="reference internal" href="#bullet-list">bullet_list</a>,
<a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#comment">comment</a>, <a class="reference internal" href="#compound">compound</a>, <a class="reference internal" href="#container">container</a>, <a class="reference internal" href="#danger">danger</a>,
<a class="reference internal" href="#definition-list">definition_list</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#enumerated-list">enumerated_list</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#field-list">field_list</a>, <a class="reference internal" href="#figure">figure</a>, <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#image">image</a>, <a class="reference internal" href="#important">important</a>,
<a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#option-list">option_list</a>, <a class="reference internal" href="#paragraph">paragraph</a>,
<a class="reference internal" href="#pending">pending</a>, <a class="reference internal" href="#raw">raw</a>, <a class="reference internal" href="#rubric">rubric</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>, <a class="reference internal" href="#system-message">system_message</a>,
<a class="reference internal" href="#table">table</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a></p>
<div class="section" id="simple-body-elements">
<h3><a class="toc-backref" href="#id194">Simple Body Elements</a></h3>
<p>Simple body elements are empty or directly contain text data. Those
that contain text data may also contain inline elements. Such
elements therefore have a "mixed content model".</p>
<p>Category members: <a class="reference internal" href="#comment">comment</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#image">image</a>, <a class="reference internal" href="#literal-block">literal_block</a>,
<a class="reference internal" href="#math-block">math_block</a>, <a class="reference internal" href="#paragraph">paragraph</a>, <a class="reference internal" href="#pending">pending</a>, <a class="reference internal" href="#raw">raw</a>, <a class="reference internal" href="#rubric">rubric</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>,
<a class="reference internal" href="#target">target</a></p>
</div>
<div class="section" id="compound-body-elements">
<h3><a class="toc-backref" href="#id195">Compound Body Elements</a></h3>
<p>Compound body elements contain local substructure (body subelements)
and further body elements. They do not directly contain text data.</p>
<p>Category members: <a class="reference internal" href="#admonition">admonition</a>, <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#block-quote">block_quote</a>, <a class="reference internal" href="#bullet-list">bullet_list</a>,
<a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#compound">compound</a>, <a class="reference internal" href="#container">container</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#definition-list">definition_list</a>,
<a class="reference internal" href="#enumerated-list">enumerated_list</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#field-list">field_list</a>, <a class="reference internal" href="#figure">figure</a>, <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#hint">hint</a>,
<a class="reference internal" href="#important">important</a>, line_block, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#option-list">option_list</a>, <a class="reference internal" href="#system-message">system_message</a>, <a class="reference internal" href="#table">table</a>,
<a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a></p>
<div class="section" id="body-subelements">
<h4><a class="toc-backref" href="#id196">Body Subelements</a></h4>
<p>Compound body elements contain specific subelements (e.g. <a class="reference internal" href="#bullet-list">bullet_list</a>
contains <a class="reference internal" href="#list-item">list_item</a>). Subelements may themselves be compound elements
(containing further child elements, like <a class="reference internal" href="#field">field</a>) or simple data
elements (containing text data, like <a class="reference internal" href="#field-name">field_name</a>). These subelements
always occur within specific parent elements, never at the body
element level (beside paragraphs, etc.).</p>
<p>Category members (simple): <a class="reference internal" href="#attribution">attribution</a>, <a class="reference internal" href="#caption">caption</a>, <a class="reference internal" href="#classifier">classifier</a>,
<a class="reference internal" href="#colspec">colspec</a>, <a class="reference internal" href="#field-name">field_name</a>, <a class="reference internal" href="#label">label</a>, <a class="reference internal" href="#line">line</a>, <a class="reference internal" href="#option-argument">option_argument</a>,
<a class="reference internal" href="#option-string">option_string</a>, <a class="reference internal" href="#term">term</a></p>
<p>Category members (compound): <a class="reference internal" href="#definition">definition</a>, <a class="reference internal" href="#definition-list-item">definition_list_item</a>,
<a class="reference internal" href="#description">description</a>, <a class="reference internal" href="#entry">entry</a>, <a class="reference internal" href="#field">field</a>, <a class="reference internal" href="#field-body">field_body</a>, <a class="reference internal" href="#legend">legend</a>, <a class="reference internal" href="#list-item">list_item</a>,
<a class="reference internal" href="#option">option</a>, <a class="reference internal" href="#option-group">option_group</a>, <a class="reference internal" href="#option-list-item">option_list_item</a>, <a class="reference internal" href="#row">row</a>, <a class="reference internal" href="#tbody">tbody</a>, <a class="reference internal" href="#tgroup">tgroup</a>,
<a class="reference internal" href="#thead">thead</a></p>
</div>
</div>
</div>
<div class="section" id="inline-elements">
<h2><a class="toc-backref" href="#id197">Inline Elements</a></h2>
<p>Inline elements directly contain text data, and may also contain
further inline elements. Inline elements are contained within simple
body elements. Most inline elements have a "mixed content model".</p>
<p>Category members: <a class="reference internal" href="#abbreviation">abbreviation</a>, <a class="reference internal" href="#acronym">acronym</a>, <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#emphasis">emphasis</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#generated">generated</a>, <a class="reference internal" href="#image">image</a>, <a class="reference internal" href="#inline">inline</a>, <a class="reference internal" href="#literal">literal</a>,
<a class="reference internal" href="#math">math</a>, <a class="reference internal" href="#problematic">problematic</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#strong">strong</a>, <a class="reference internal" href="#subscript">subscript</a>,
<a class="reference internal" href="#substitution-reference">substitution_reference</a>, <a class="reference internal" href="#superscript">superscript</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#title-reference">title_reference</a>, <a class="reference internal" href="#raw">raw</a></p>
</div>
</div>
<div class="section" id="element-reference">
<h1><a class="toc-backref" href="#id186">Element Reference</a></h1>
<div class="contents local topic" id="id3">
<ul class="simple">
<li><a class="reference internal" href="#abbreviation" id="id198"><tt class="docutils literal">abbreviation</tt></a></li>
<li><a class="reference internal" href="#acronym" id="id199"><tt class="docutils literal">acronym</tt></a></li>
<li><a class="reference internal" href="#address" id="id200"><tt class="docutils literal">address</tt></a></li>
<li><a class="reference internal" href="#admonition" id="id201"><tt class="docutils literal">admonition</tt></a></li>
<li><a class="reference internal" href="#attention" id="id202"><tt class="docutils literal">attention</tt></a></li>
<li><a class="reference internal" href="#attribution" id="id203"><tt class="docutils literal">attribution</tt></a></li>
<li><a class="reference internal" href="#author" id="id204"><tt class="docutils literal">author</tt></a></li>
<li><a class="reference internal" href="#authors" id="id205"><tt class="docutils literal">authors</tt></a></li>
<li><a class="reference internal" href="#block-quote" id="id206"><tt class="docutils literal">block_quote</tt></a></li>
<li><a class="reference internal" href="#bullet-list" id="id207"><tt class="docutils literal">bullet_list</tt></a></li>
<li><a class="reference internal" href="#caption" id="id208"><tt class="docutils literal">caption</tt></a></li>
<li><a class="reference internal" href="#caution" id="id209"><tt class="docutils literal">caution</tt></a></li>
<li><a class="reference internal" href="#citation" id="id210"><tt class="docutils literal">citation</tt></a></li>
<li><a class="reference internal" href="#citation-reference" id="id211"><tt class="docutils literal">citation_reference</tt></a></li>
<li><a class="reference internal" href="#classifier" id="id212"><tt class="docutils literal">classifier</tt></a></li>
<li><a class="reference internal" href="#colspec" id="id213"><tt class="docutils literal">colspec</tt></a></li>
<li><a class="reference internal" href="#comment" id="id214"><tt class="docutils literal">comment</tt></a></li>
<li><a class="reference internal" href="#compound" id="id215"><tt class="docutils literal">compound</tt></a></li>
<li><a class="reference internal" href="#contact" id="id216"><tt class="docutils literal">contact</tt></a></li>
<li><a class="reference internal" href="#container" id="id217"><tt class="docutils literal">container</tt></a></li>
<li><a class="reference internal" href="#copyright" id="id218"><tt class="docutils literal">copyright</tt></a></li>
<li><a class="reference internal" href="#danger" id="id219"><tt class="docutils literal">danger</tt></a></li>
<li><a class="reference internal" href="#date" id="id220"><tt class="docutils literal">date</tt></a></li>
<li><a class="reference internal" href="#decoration" id="id221"><tt class="docutils literal">decoration</tt></a></li>
<li><a class="reference internal" href="#definition" id="id222"><tt class="docutils literal">definition</tt></a></li>
<li><a class="reference internal" href="#definition-list" id="id223"><tt class="docutils literal">definition_list</tt></a></li>
<li><a class="reference internal" href="#definition-list-item" id="id224"><tt class="docutils literal">definition_list_item</tt></a></li>
<li><a class="reference internal" href="#description" id="id225"><tt class="docutils literal">description</tt></a></li>
<li><a class="reference internal" href="#docinfo" id="id226"><tt class="docutils literal">docinfo</tt></a></li>
<li><a class="reference internal" href="#doctest-block" id="id227"><tt class="docutils literal">doctest_block</tt></a></li>
<li><a class="reference internal" href="#document" id="id228"><tt class="docutils literal">document</tt></a></li>
<li><a class="reference internal" href="#emphasis" id="id229"><tt class="docutils literal">emphasis</tt></a></li>
<li><a class="reference internal" href="#entry" id="id230"><tt class="docutils literal">entry</tt></a></li>
<li><a class="reference internal" href="#enumerated-list" id="id231"><tt class="docutils literal">enumerated_list</tt></a></li>
<li><a class="reference internal" href="#error" id="id232"><tt class="docutils literal">error</tt></a></li>
<li><a class="reference internal" href="#field" id="id233"><tt class="docutils literal">field</tt></a></li>
<li><a class="reference internal" href="#field-body" id="id234"><tt class="docutils literal">field_body</tt></a></li>
<li><a class="reference internal" href="#field-list" id="id235"><tt class="docutils literal">field_list</tt></a></li>
<li><a class="reference internal" href="#field-name" id="id236"><tt class="docutils literal">field_name</tt></a></li>
<li><a class="reference internal" href="#figure" id="id237"><tt class="docutils literal">figure</tt></a></li>
<li><a class="reference internal" href="#footer" id="id238"><tt class="docutils literal">footer</tt></a></li>
<li><a class="reference internal" href="#footnote" id="id239"><tt class="docutils literal">footnote</tt></a></li>
<li><a class="reference internal" href="#footnote-reference" id="id240"><tt class="docutils literal">footnote_reference</tt></a></li>
<li><a class="reference internal" href="#generated" id="id241"><tt class="docutils literal">generated</tt></a></li>
<li><a class="reference internal" href="#header" id="id242"><tt class="docutils literal">header</tt></a></li>
<li><a class="reference internal" href="#hint" id="id243"><tt class="docutils literal">hint</tt></a></li>
<li><a class="reference internal" href="#image" id="id244"><tt class="docutils literal">image</tt></a></li>
<li><a class="reference internal" href="#important" id="id245"><tt class="docutils literal">important</tt></a></li>
<li><a class="reference internal" href="#inline" id="id246"><tt class="docutils literal">inline</tt></a></li>
<li><a class="reference internal" href="#label" id="id247"><tt class="docutils literal">label</tt></a></li>
<li><a class="reference internal" href="#legend" id="id248"><tt class="docutils literal">legend</tt></a></li>
<li><a class="reference internal" href="#line" id="id249"><tt class="docutils literal">line</tt></a></li>
<li><a class="reference internal" href="#line-block" id="id250"><tt class="docutils literal">line_block</tt></a></li>
<li><a class="reference internal" href="#list-item" id="id251"><tt class="docutils literal">list_item</tt></a></li>
<li><a class="reference internal" href="#literal" id="id252"><tt class="docutils literal">literal</tt></a></li>
<li><a class="reference internal" href="#literal-block" id="id253"><tt class="docutils literal">literal_block</tt></a></li>
<li><a class="reference internal" href="#math" id="id254"><tt class="docutils literal">math</tt></a></li>
<li><a class="reference internal" href="#math-block" id="id255"><tt class="docutils literal">math_block</tt></a></li>
<li><a class="reference internal" href="#note" id="id256"><tt class="docutils literal">note</tt></a></li>
<li><a class="reference internal" href="#option" id="id257"><tt class="docutils literal">option</tt></a></li>
<li><a class="reference internal" href="#option-argument" id="id258"><tt class="docutils literal">option_argument</tt></a></li>
<li><a class="reference internal" href="#option-group" id="id259"><tt class="docutils literal">option_group</tt></a></li>
<li><a class="reference internal" href="#option-list" id="id260"><tt class="docutils literal">option_list</tt></a></li>
<li><a class="reference internal" href="#option-list-item" id="id261"><tt class="docutils literal">option_list_item</tt></a></li>
<li><a class="reference internal" href="#option-string" id="id262"><tt class="docutils literal">option_string</tt></a></li>
<li><a class="reference internal" href="#organization" id="id263"><tt class="docutils literal">organization</tt></a></li>
<li><a class="reference internal" href="#paragraph" id="id264"><tt class="docutils literal">paragraph</tt></a></li>
<li><a class="reference internal" href="#pending" id="id265"><tt class="docutils literal">pending</tt></a></li>
<li><a class="reference internal" href="#problematic" id="id266"><tt class="docutils literal">problematic</tt></a></li>
<li><a class="reference internal" href="#raw" id="id267"><tt class="docutils literal">raw</tt></a></li>
<li><a class="reference internal" href="#reference" id="id268"><tt class="docutils literal">reference</tt></a></li>
<li><a class="reference internal" href="#revision" id="id269"><tt class="docutils literal">revision</tt></a></li>
<li><a class="reference internal" href="#row" id="id270"><tt class="docutils literal">row</tt></a></li>
<li><a class="reference internal" href="#rubric" id="id271"><tt class="docutils literal">rubric</tt></a></li>
<li><a class="reference internal" href="#section" id="id272"><tt class="docutils literal">section</tt></a></li>
<li><a class="reference internal" href="#sidebar" id="id273"><tt class="docutils literal">sidebar</tt></a></li>
<li><a class="reference internal" href="#status" id="id274"><tt class="docutils literal">status</tt></a></li>
<li><a class="reference internal" href="#strong" id="id275"><tt class="docutils literal">strong</tt></a></li>
<li><a class="reference internal" href="#subscript" id="id276"><tt class="docutils literal">subscript</tt></a></li>
<li><a class="reference internal" href="#substitution-definition" id="id277"><tt class="docutils literal">substitution_definition</tt></a></li>
<li><a class="reference internal" href="#substitution-reference" id="id278"><tt class="docutils literal">substitution_reference</tt></a></li>
<li><a class="reference internal" href="#subtitle" id="id279"><tt class="docutils literal">subtitle</tt></a></li>
<li><a class="reference internal" href="#superscript" id="id280"><tt class="docutils literal">superscript</tt></a></li>
<li><a class="reference internal" href="#system-message" id="id281"><tt class="docutils literal">system_message</tt></a></li>
<li><a class="reference internal" href="#table" id="id282"><tt class="docutils literal">table</tt></a></li>
<li><a class="reference internal" href="#target" id="id283"><tt class="docutils literal">target</tt></a></li>
<li><a class="reference internal" href="#tbody" id="id284"><tt class="docutils literal">tbody</tt></a></li>
<li><a class="reference internal" href="#term" id="id285"><tt class="docutils literal">term</tt></a></li>
<li><a class="reference internal" href="#tgroup" id="id286"><tt class="docutils literal">tgroup</tt></a></li>
<li><a class="reference internal" href="#thead" id="id287"><tt class="docutils literal">thead</tt></a></li>
<li><a class="reference internal" href="#tip" id="id288"><tt class="docutils literal">tip</tt></a></li>
<li><a class="reference internal" href="#id159" id="id289"><tt class="docutils literal">title</tt></a></li>
<li><a class="reference internal" href="#title-reference" id="id290"><tt class="docutils literal">title_reference</tt></a></li>
<li><a class="reference internal" href="#topic" id="id291"><tt class="docutils literal">topic</tt></a></li>
<li><a class="reference internal" href="#transition" id="id292"><tt class="docutils literal">transition</tt></a></li>
<li><a class="reference internal" href="#version" id="id293"><tt class="docutils literal">version</tt></a></li>
<li><a class="reference internal" href="#warning" id="id294"><tt class="docutils literal">warning</tt></a></li>
</ul>
</div>
<p>Each element in the DTD (document type definition) is described in its
own section below. Each section contains an introduction plus the
following subsections:</p>
<ul>
<li><p class="first">Details (of element relationships and semantics):</p>
<ul class="simple">
<li>Category: One or more references to the element categories in
<a class="reference internal" href="#element-hierarchy">Element Hierarchy</a> above. Some elements belong to more than one
category.</li>
<li>Parents: A list of elements which may contain the element.</li>
<li>Children: A list of elements which may occur within the element.</li>
<li>Analogues: Describes analogous elements in well-known document
models such as <a class="reference external" href="http://www.w3.org/MarkUp/">HTML</a> or <a class="reference external" href="http://docbook.org/tdg/en/html/docbook.html">DocBook</a>. Lists similarities and
differences.</li>
<li>Processing: Lists formatting or rendering recommendations for the
element.</li>
</ul>
</li>
<li><p class="first">Content Model:</p>
<p>The formal XML content model from the <a class="reference external" href="docutils.dtd">Docutils DTD</a>, followed by:</p>
<ul class="simple">
<li>Attributes: Describes (or refers to descriptions of) the possible
values and semantics of each attribute.</li>
<li>Parameter Entities: Lists the parameter entities which directly or
indirectly include the element.</li>
</ul>
</li>
<li><p class="first">Examples: <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> examples are shown along with
fragments of the document trees resulting from parsing.
<span class="target" id="pseudo-xml">Pseudo-XML</span> is used for the results of parsing and processing.
Pseudo-XML is a representation of XML where nesting is indicated by
indentation and end-tags are not shown. Some of the precision of
real XML is given up in exchange for easier readability. For
example, the following are equivalent:</p>
<ul>
<li><p class="first">Real XML:</p>
<pre class="literal-block">
<document>
<section ids="a-title" names="a title">
<title>A Title</title>
<paragraph>A paragraph.</paragraph>
</section>
</document>
</pre>
</li>
<li><p class="first">Pseudo-XML:</p>
<pre class="literal-block">
<document>
<section ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
</li>
</ul>
</li>
</ul>
<hr class="docutils" />
<p>Many of the element reference sections below are marked "<span class="target" id="to-be-completed">to be
completed</span>". Please help complete this document by contributing to
its writing.</p>
<div class="section" id="abbreviation">
<h2><a class="toc-backref" href="#id198"><tt class="docutils literal">abbreviation</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="acronym">
<h2><a class="toc-backref" href="#id199"><tt class="docutils literal">acronym</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="address">
<h2><a class="toc-backref" href="#id200"><tt class="docutils literal">address</tt></a></h2>
<p>The <tt class="docutils literal">address</tt> element holds the surface mailing address information
for the author (individual or group) of the document, or a third-party
contact address. Its structure is identical to that of the
<a class="reference internal" href="#literal-block">literal_block</a> element: whitespace is significant, especially
newlines.</p>
<div class="section" id="details">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><p class="first"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body"><p class="first">The following elements may contain <tt class="docutils literal">address</tt>: <a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#authors">authors</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><p class="first"><tt class="docutils literal">address</tt> elements contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><p class="first"><tt class="docutils literal">address</tt> is analogous to the DocBook "address" element.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><p class="first">As with the <a class="reference internal" href="#literal-block">literal_block</a> element, newlines and other whitespace
is significant and must be preserved. However, a monospaced
typeface need not be used.</p>
<p class="last">See also <a class="reference internal" href="#docinfo">docinfo</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="content-model">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">address</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">address</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="examples">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Address: 123 Example Ave.
Example, EX
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<address>
123 Example Ave.
Example, EX
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="admonition">
<h2><a class="toc-backref" href="#id201"><tt class="docutils literal">admonition</tt></a></h2>
<p>This element is a generic, titled admonition. Also see the specific
admonition elements Docutils offers (in alphabetical order): <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>.</p>
<div class="section" id="id4">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">admonition</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">admonition</tt> elements begin with a <a class="reference internal" href="#title">title</a> and may contain one or
more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">admonition</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id5">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>, (<a class="reference internal" href="#id183">%body.elements;</a>)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">admonition</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">admonition</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">admonition</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id6">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. admonition:: And, by the way...
You can make up your own admonition too.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<admonition class="admonition-and-by-the-way">
<title>
And, by the way...
<paragraph>
You can make up your own admonition too.
</pre>
</div>
</div>
<div class="section" id="attention">
<h2><a class="toc-backref" href="#id202"><tt class="docutils literal">attention</tt></a></h2>
<p>The <tt class="docutils literal">attention</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id7">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">attention</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">attention</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">attention</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Attention!" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id8">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">attention</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">attention</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">attention</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id9">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Attention:: All your base are belong to us.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<attention>
<paragraph>
All your base are belong to us.
</pre>
</div>
</div>
<div class="section" id="attribution">
<h2><a class="toc-backref" href="#id203"><tt class="docutils literal">attribution</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="author">
<h2><a class="toc-backref" href="#id204"><tt class="docutils literal">author</tt></a></h2>
<p>The <tt class="docutils literal">author</tt> element holds the name of the author of the document.</p>
<div class="section" id="id10">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">author</tt>: <a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#authors">authors</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">author</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">author</tt> is analogous to the DocBook "author" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id11">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">author</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">author</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id12">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Author: J. Random Hacker
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<author>
J. Random Hacker
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id205"><tt class="docutils literal">authors</tt></a></h2>
<p>The <tt class="docutils literal">authors</tt> element is a container for author information for
documents with multiple authors.</p>
<div class="section" id="id13">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">authors</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">authors</tt> elements may contain the following elements: <a class="reference internal" href="#author">author</a>,
<a class="reference internal" href="#organization">organization</a>, <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#contact">contact</a></td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">authors</tt> is analogous to the DocBook "authors" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id14">
<h3>Content Model</h3>
<pre class="literal-block">
((<a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#organization">organization</a>?, <a class="reference internal" href="#address">address</a>?, <a class="reference internal" href="#contact">contact</a>?)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">authors</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">authors</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id15">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Authors: J. Random Hacker; Jane Doe
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<authors>
<author>
J. Random Hacker
<author>
Jane Doe
</pre>
<p>In reStructuredText, multiple author's names are separated with
semicolons (";") or commas (","); semicolons take precedence. There
is currently no way to represent the author's organization, address,
or contact in a reStructuredText "Authors" field.</p>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="block-quote">
<h2><a class="toc-backref" href="#id206"><tt class="docutils literal">block_quote</tt></a></h2>
<p>The <tt class="docutils literal">block_quote</tt> element is used for quotations set off from the
main text (standalone).</p>
<div class="section" id="id16">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">block_quote</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">block_quote</tt> elements contain <a class="reference internal" href="#body-elements">body elements</a> followed by an
optional <a class="reference internal" href="#attribution">attribution</a> element.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">block_quote</tt> is analogous to the "blockquote" element in both
HTML and DocBook.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><tt class="docutils literal">block_quote</tt> elements serve to set their contents off from the
main text, typically with indentation and/or other decoration.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id17">
<h3>Content Model</h3>
<pre class="literal-block">
((<a class="reference internal" href="#id183">%body.elements;</a>)+, <a class="reference internal" href="#attribution">attribution</a>?)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">block_quote</tt> element contains only the <a class="reference internal" href="#common-attributes">common
attributes</a>: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">block_quote</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">block_quote</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id18">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
As a great paleontologist once said,
This theory, that is mine, is mine.
-- Anne Elk (Miss)
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
As a great paleontologist once said,
<block_quote>
<paragraph>
This theory, that is mine, is mine.
<attribution>
Anne Elk (Miss)
</pre>
</div>
</div>
<div class="section" id="bullet-list">
<h2><a class="toc-backref" href="#id207"><tt class="docutils literal">bullet_list</tt></a></h2>
<p>The <tt class="docutils literal">bullet_list</tt> element contains <a class="reference internal" href="#list-item">list_item</a> elements which are
uniformly marked with bullets. Bullets are typically simple dingbats
(symbols) such as circles and squares.</p>
<div class="section" id="id19">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">bullet_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">bullet_list</tt> elements contain one or more <a class="reference internal" href="#list-item">list_item</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">bullet_list</tt> is analogous to the HTML "ul" element and to the
DocBook "itemizedlist" element. HTML's "ul" is short for
"unordered list", which we consider to be a misnomer. "Unordered"
implies that the list items may be randomly rearranged without
affecting the meaning of the list. Bullet lists <em>are</em> often
ordered; the ordering is simply left implicit.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Each list item should begin a new vertical block, prefaced by a
bullet/dingbat.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id20">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#list-item">list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">bullet_list</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#bullet">bullet</a>.</p>
<p><tt class="docutils literal">bullet</tt> is used to record the style of bullet from the input
data. In documents processed from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>, it contains
one of "-", "+", or "*". It may be ignored in processing.</p>
</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body"><p class="first last">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">bullet_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">bullet_list</tt>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id21">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
- Item 1, paragraph 1.
Item 1, paragraph 2.
- Item 2.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<bullet_list bullet="-">
<list_item>
<paragraph>
Item 1, paragraph 1.
<paragraph>
Item 1, paragraph 2.
<list_item>
<paragraph>
Item 2.
</pre>
<p>See <a class="reference internal" href="#list-item">list_item</a> for another example.</p>
</div>
</div>
<div class="section" id="caption">
<h2><a class="toc-backref" href="#id208"><tt class="docutils literal">caption</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="caution">
<h2><a class="toc-backref" href="#id209"><tt class="docutils literal">caution</tt></a></h2>
<p>The <tt class="docutils literal">caution</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id22">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">caution</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">caution</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">caution</tt> is analogous to the DocBook "caution" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Caution" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id23">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">caution</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">caution</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">caution</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id24">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Caution:: Don't take any wooden nickels.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<caution>
<paragraph>
Don't take any wooden nickels.
</pre>
</div>
</div>
<div class="section" id="citation">
<h2><a class="toc-backref" href="#id210"><tt class="docutils literal">citation</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="citation-reference">
<h2><a class="toc-backref" href="#id211"><tt class="docutils literal">citation_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="classifier">
<h2><a class="toc-backref" href="#id212"><tt class="docutils literal">classifier</tt></a></h2>
<p>The <tt class="docutils literal">classifier</tt> element contains the classification or type of the
<a class="reference internal" href="#term">term</a> being defined in a <a class="reference internal" href="#definition-list">definition_list</a>. For example, it can be
used to indicate the type of a variable.</p>
<div class="section" id="id25">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#definition-list-item">definition_list_item</a> element contains <tt class="docutils literal">classifier</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">classifier</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">classifier</tt> has no direct analogues in common DTDs. It can be
emulated with primitives or type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id26">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">classifier</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id27">
<h3>Examples</h3>
<p>Here is a hypothetical data dictionary. <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
name : string
Customer name.
i : int
Temporary index variable.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<definition_list>
<definition_list_item>
<term>
name
<classifier>
string
<definition>
<paragraph>
Customer name.
<definition_list_item>
<term>
i
<classifier>
int
<definition>
<paragraph>
Temporary index variable.
</pre>
</div>
</div>
<div class="section" id="colspec">
<h2><a class="toc-backref" href="#id213"><tt class="docutils literal">colspec</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="comment">
<h2><a class="toc-backref" href="#id214"><tt class="docutils literal">comment</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="compound">
<h2><a class="toc-backref" href="#id215"><tt class="docutils literal">compound</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="contact">
<h2><a class="toc-backref" href="#id216"><tt class="docutils literal">contact</tt></a></h2>
<p>The <tt class="docutils literal">contact</tt> element holds contact information for the author
(individual or group) of the document, or a third-party contact. It
is typically used for an email or web address.</p>
<div class="section" id="id28">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">contact</tt>: <a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#authors">authors</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">contact</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">contact</tt> is analogous to the DocBook "email" element. The HTML
"address" element serves a similar purpose.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id29">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">contact</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">contact</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id30">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Contact: jrh@example.com
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<contact>
<reference refuri="mailto:jrh@example.com">
jrh@example.com
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="container">
<h2><a class="toc-backref" href="#id217"><tt class="docutils literal">container</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="copyright">
<h2><a class="toc-backref" href="#id218"><tt class="docutils literal">copyright</tt></a></h2>
<p>The <tt class="docutils literal">copyright</tt> element contains the document's copyright statement.</p>
<div class="section" id="id31">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">copyright</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">copyright</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">copyright</tt> is analogous to the DocBook "copyright" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id32">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">copyright</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">copyright</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id33">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Copyright: This document has been placed in the public domain.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<copyright>
This document has been placed in the public domain.
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="danger">
<h2><a class="toc-backref" href="#id219"><tt class="docutils literal">danger</tt></a></h2>
<p>The <tt class="docutils literal">danger</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id34">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">danger</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">danger</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">danger</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "!DANGER!" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id35">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">danger</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">danger</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">danger</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id36">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. DANGER:: Mad scientist at work!
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<danger>
<paragraph>
Mad scientist at work!
</pre>
</div>
</div>
<div class="section" id="date">
<h2><a class="toc-backref" href="#id220"><tt class="docutils literal">date</tt></a></h2>
<p>The <tt class="docutils literal">date</tt> element contains the date of publication, release, or
last modification of the document.</p>
<div class="section" id="id37">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">date</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">date</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">date</tt> is analogous to the DocBook "date" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Often used with the RCS/CVS keyword "Date". See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id38">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">date</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">date</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id39">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Date: 2002-08-20
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<date>
2002-08-20
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="decoration">
<h2><a class="toc-backref" href="#id221"><tt class="docutils literal">decoration</tt></a></h2>
<p>The <tt class="docutils literal">decoration</tt> element is a container for <a class="reference internal" href="#header">header</a> and <a class="reference internal" href="#footer">footer</a>
elements and potential future extensions. These elements are used for
notes, time/datestamp, processing information, etc.</p>
<div class="section" id="id40">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#document">document</a> element contains <tt class="docutils literal">decoration</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">decoration</tt> elements may contain <a class="reference internal" href="#decorative-elements">decorative elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body">There are no direct analogies to <tt class="docutils literal">decoration</tt> in HTML or in
DocBook. Equivalents are typically constructed from primitives
and/or generated by the processing system.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See the individual <a class="reference internal" href="#decorative-elements">decorative elements</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id41">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#header">header</a>?, <a class="reference internal" href="#footer">footer</a>?)
</pre>
<p>Although the content model doesn't specifically require contents, no
empty <tt class="docutils literal">decoration</tt> elements are ever created.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">decoration</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id42">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms,
assuming that the datestamp command-line option or configuration
setting has been supplied:</p>
<pre class="literal-block">
<document>
<decoration>
<footer>
<paragraph>
Generated on: 2002-08-20.
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="definition">
<h2><a class="toc-backref" href="#id222"><tt class="docutils literal">definition</tt></a></h2>
<p>The <tt class="docutils literal">definition</tt> element is a container for the body elements used
to define a <a class="reference internal" href="#term">term</a> in a <a class="reference internal" href="#definition-list">definition_list</a>.</p>
<div class="section" id="id43">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (compound)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only <a class="reference internal" href="#definition-list-item">definition_list_item</a> elements contain <tt class="docutils literal">definition</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">definition</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">definition</tt> is analogous to the HTML "dd" element and to the
DocBook "listitem" element (inside a "variablelistentry" element).</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id44">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">definition</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id45">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#definition-list">definition_list</a>, <a class="reference internal" href="#definition-list-item">definition_list_item</a>, and
<a class="reference internal" href="#classifier">classifier</a> elements.</p>
</div>
</div>
<div class="section" id="definition-list">
<h2><a class="toc-backref" href="#id223"><tt class="docutils literal">definition_list</tt></a></h2>
<p>The <tt class="docutils literal">definition_list</tt> element contains a list of terms and their
definitions. It can be used for glossaries or dictionaries, to
describe or classify things, for dialogues, or to itemize subtopics
(such as in this reference).</p>
<div class="section" id="id46">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">definition_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">definition_list</tt> elements contain one or more
<a class="reference internal" href="#definition-list-item">definition_list_item</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">definition_list</tt> is analogous to the HTML "dl" element and to
the DocBook "variablelist" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id47">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#definition-list-item">definition_list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">definition_list</tt> element contains only the <a class="reference internal" href="#common-attributes">common
attributes</a>: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">definition_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">definition_list</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id48">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Term
Definition.
Term : classifier
The ' : ' indicates a classifier in
definition list item terms only.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<definition_list>
<definition_list_item>
<term>
Term
<definition>
<paragraph>
Definition.
<definition_list_item>
<term>
Term
<classifier>
classifier
<definition>
<paragraph>
The ' : ' indicates a classifier in
definition list item terms only.
</pre>
<p>See <a class="reference internal" href="#definition-list-item">definition_list_item</a> and <a class="reference internal" href="#classifier">classifier</a> for further examples.</p>
</div>
</div>
<div class="section" id="definition-list-item">
<h2><a class="toc-backref" href="#id224"><tt class="docutils literal">definition_list_item</tt></a></h2>
<p>The <tt class="docutils literal">definition_list_item</tt> element contains a single
<a class="reference internal" href="#term">term</a>/<a class="reference internal" href="#definition">definition</a> pair (with optional <a class="reference internal" href="#classifier">classifier</a>).</p>
<div class="section" id="id49">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (compound)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#definition-list">definition_list</a> element contains
<tt class="docutils literal">definition_list_item</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">definition_list_item</tt> elements each contain a single <a class="reference internal" href="#term">term</a>,
an optional <a class="reference internal" href="#classifier">classifier</a>, and a <a class="reference internal" href="#definition">definition</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">definition_list_item</tt> is analogous to the DocBook
"variablelistentry" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The optional <a class="reference internal" href="#classifier">classifier</a> can be rendered differently from the
<a class="reference internal" href="#term">term</a>. They should be separated visually, typically by spaces
plus a colon or dash.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id50">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#term">term</a>, <a class="reference internal" href="#classifier">classifier</a>?, <a class="reference internal" href="#definition">definition</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">definition_list_item</tt> element contains only the <a class="reference internal" href="#common-attributes">common
attributes</a>: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id51">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Tyrannosaurus Rex : carnivore
Big and scary; the "Tyrant King".
Brontosaurus : herbivore
All brontosauruses are thin at one end,
much much thicker in the middle
and then thin again at the far end.
-- Anne Elk (Miss)
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<definition_list>
<definition_list_item>
<term>
Tyrannosaurus Rex
<classifier>
carnivore
<definition>
<paragraph>
Big and scary; the "Tyrant King".
<definition_list_item>
<term>
Brontosaurus
<classifier>
herbivore
<definition>
<paragraph>
All brontosauruses are thin at one end,
much much thicker in the middle
and then thin again at the far end.
<paragraph>
-- Anne Elk (Miss)
</pre>
<p>See <a class="reference internal" href="#definition-list">definition_list</a> and <a class="reference internal" href="#classifier">classifier</a> for further examples.</p>
</div>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#id225"><tt class="docutils literal">description</tt></a></h2>
<p>The <tt class="docutils literal">description</tt> element contains body elements, describing the
purpose or effect of a command-line option or group of options.</p>
<div class="section" id="id52">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option-list-item">option_list_item</a> element contains <tt class="docutils literal">description</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">description</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">description</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#option-list">option_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id53">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">description</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id54">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="docinfo">
<h2><a class="toc-backref" href="#id226"><tt class="docutils literal">docinfo</tt></a></h2>
<p>The <tt class="docutils literal">docinfo</tt> element is a container for document bibliographic
data, or meta-data (data about the document). It corresponds to the
front matter of a book, such as the title page and copyright page.</p>
<div class="section" id="id55">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><p class="first"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body"><p class="first">Only the <a class="reference internal" href="#document">document</a> element contains <tt class="docutils literal">docinfo</tt>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><p class="first"><tt class="docutils literal">docinfo</tt> elements contain <a class="reference internal" href="#bibliographic-elements">bibliographic elements</a>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><p class="first"><tt class="docutils literal">docinfo</tt> is analogous to DocBook "info" elements ("bookinfo"
etc.). There are no directly analogous HTML elements; the "meta"
element carries some of the same information, albeit invisibly.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><p class="first">The <tt class="docutils literal">docinfo</tt> element may be rendered as a two-column table or
in other styles. It may even be invisible or omitted from the
processed output. Meta-data may be extracted from <tt class="docutils literal">docinfo</tt>
children; for example, HTML <tt class="docutils literal"><meta></tt> tags may be constructed.</p>
<p class="last">When <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> transforms a <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> <a class="reference internal" href="#field-list">field_list</a> into a
<tt class="docutils literal">docinfo</tt> element (see the examples below), RCS/CVS keywords are
normally stripped from simple (one paragraph) field bodies. For
complete details, please see <a class="reference external" href="rst/restructuredtext.html#rcs-keywords">RCS Keywords</a> in the
<a class="reference external" href="rst/restructuredtext.html">reStructuredText Markup Specification</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id56">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id182">%bibliographic.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">docinfo</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id57">
<h3>Examples</h3>
<p>Docinfo is represented in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> by a <a class="reference internal" href="#field-list">field_list</a> in a
bibliographic context: the first non-comment element of a <a class="reference internal" href="#document">document</a>,
after any document <a class="reference internal" href="#title">title</a>/<a class="reference internal" href="#subtitle">subtitle</a>. The field list is transformed
into a <tt class="docutils literal">docinfo</tt> element and its children by a transform. Source:</p>
<pre class="literal-block">
Docinfo Example
===============
:Author: J. Random Hacker
:Contact: jrh@example.com
:Date: 2002-08-18
:Status: Work In Progress
:Version: 1
:Filename: $RCSfile$
:Copyright: This document has been placed in the public domain.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="docinfo-example" names="docinfo example">
<title>
Docinfo Example
<docinfo>
<author>
J. Random Hacker
<contact>
<reference refuri="mailto:jrh@example.com">
jrh@example.com
<date>
2002-08-18
<status>
Work In Progress
<version>
1
<field>
<field_name>
Filename
<field_body>
<paragraph>
doctree.txt
<copyright>
This document has been placed in the public domain.
</pre>
<p>Note that "Filename" is a non-standard <tt class="docutils literal">docinfo</tt> field, so becomes a
generic <tt class="docutils literal">field</tt> element. Also note that the "RCSfile" keyword
syntax has been stripped from the "Filename" data.</p>
<p>See <a class="reference internal" href="#field-list">field_list</a> for an example in a non-bibliographic context. Also
see the individual examples for the various <a class="reference internal" href="#bibliographic-elements">bibliographic elements</a>.</p>
</div>
</div>
<div class="section" id="doctest-block">
<h2><a class="toc-backref" href="#id227"><tt class="docutils literal">doctest_block</tt></a></h2>
<p>The <tt class="docutils literal">doctest_block</tt> element is a Python-specific variant of
<a class="reference internal" href="#literal-block">literal_block</a>. It is a block of text where line breaks and
whitespace are significant and must be preserved. <tt class="docutils literal">doctest_block</tt>
elements are used for interactive Python interpreter sessions, which
are distinguished by their input prompt: <tt class="docutils literal">>>></tt>. They are meant to
illustrate usage by example, and provide an elegant and powerful
testing environment via the <a class="reference external" href="http://www.python.org/doc/current/lib/module-doctest.html">doctest module</a> in the Python standard
library.</p>
<div class="section" id="id58">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">doctest_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">doctest_block</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">doctest_block</tt> is analogous to the HTML "pre" element and to
the DocBook "programlisting" and "screen" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">As with <a class="reference internal" href="#literal-block">literal_block</a>, <tt class="docutils literal">doctest_block</tt> elements are typically
rendered in a monospaced typeface. It is crucial that all
whitespace and line breaks are preserved in the rendered form.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id59">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">doctest_block</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">doctest_block</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">doctest_block</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id60">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
This is an ordinary paragraph.
>>> print 'this is a Doctest block'
this is a Doctest block
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
This is an ordinary paragraph.
<doctest_block xml:space="preserve">
>>> print 'this is a Doctest block'
this is a Doctest block
</pre>
</div>
</div>
<div class="section" id="document">
<h2><a class="toc-backref" href="#id228"><tt class="docutils literal">document</tt></a></h2>
<p>The <tt class="docutils literal">document</tt> element is the root (topmost) element of the Docutils
document tree. <tt class="docutils literal">document</tt> is the direct or indirect ancestor of
every other element in the tree. It encloses the entire document
tree. It is the starting point for a document.</p>
<div class="section" id="id61">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The <tt class="docutils literal">document</tt> element has no parents.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">document</tt> elements may contain <a class="reference internal" href="#structural-subelements">structural subelements</a>,
<a class="reference internal" href="#structural-elements">structural elements</a>, and <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">document</tt> is analogous to the HTML "html" element and to
several DocBook elements such as "book".</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id62">
<h3>Content Model</h3>
<pre class="literal-block">
( (<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>?)?,
<a class="reference internal" href="#decoration">decoration</a>?,
(<a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#transition">transition</a>?)?,
<a class="reference internal" href="#structure-model">%structure.model;</a> )
</pre>
<p>Depending on the source of the data and the stage of processing, the
"document" may not initially contain a "title". A document title is
not directly representable in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>. Instead, a lone
top-level section may have its title promoted to become the document
<a class="reference internal" href="#title">title</a>, and similarly for a lone second-level (sub)section's title to
become the document <a class="reference internal" href="#subtitle">subtitle</a>.</p>
<p>The contents of "<a class="reference internal" href="#decoration">decoration</a>" may be specified in a document,
constructed programmatically, or both. The "<a class="reference internal" href="#docinfo">docinfo</a>" may be
transformed from an initial <a class="reference internal" href="#field-list">field_list</a>.</p>
<p>See the <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity for details of the body
of a <tt class="docutils literal">document</tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">document</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus an optional <a class="reference internal" href="#title-attribute">title</a>
attribute which stores the document title metadata.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id64">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A Title
=======
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result from simple parsing:</p>
<pre class="literal-block">
<document>
<section ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
<p>After applying transforms, the section title is promoted to become the
document title:</p>
<pre class="literal-block">
<document ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="emphasis">
<h2><a class="toc-backref" href="#id229"><tt class="docutils literal">emphasis</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="entry">
<h2><a class="toc-backref" href="#id230"><tt class="docutils literal">entry</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="enumerated-list">
<h2><a class="toc-backref" href="#id231"><tt class="docutils literal">enumerated_list</tt></a></h2>
<p>The <tt class="docutils literal">enumerated_list</tt> element contains <a class="reference internal" href="#list-item">list_item</a> elements which are
uniformly marked with enumerator labels.</p>
<div class="section" id="id65">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">enumerated_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">enumerated_list</tt> elements contain one or more <a class="reference internal" href="#list-item">list_item</a>
elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">enumerated_list</tt> is analogous to the HTML "ol" element and to
the DocBook "orderedlist" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Each list item should begin a new vertical block, prefaced by a
enumeration marker (such as "1.").</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id66">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#list-item">list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">enumerated_list</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#enumtype">enumtype</a>,
<a class="reference internal" href="#prefix">prefix</a>, <a class="reference internal" href="#suffix">suffix</a>, and <a class="reference internal" href="#start">start</a>.</p>
<p><tt class="docutils literal">enumtype</tt> is used to record the intended enumeration sequence,
one of "arabic" (1, 2, 3, ...), "loweralpha" (a, b, c, ..., z),
"upperalpha" (A, B, C, ..., Z), "lowerroman" (i, ii, iii, iv, ...,
mmmmcmxcix [4999]), or "upperroman" (I, II, III, IV, ...,
MMMMCMXCIX [4999]).</p>
<p><tt class="docutils literal">prefix</tt> stores the formatting characters used before the
enumerator. In documents originating from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> data,
it will contain either "" (empty string) or "(" (left
parenthesis). It may or may not affect processing.</p>
<p><tt class="docutils literal">suffix</tt> stores the formatting characters used after the
enumerator. In documents originating from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> data,
it will contain either "." (period) or ")" (right parenthesis).
Depending on the capabilities of the output format, this attribute
may or may not affect processing.</p>
<p><tt class="docutils literal">start</tt> contains the ordinal value of the first item in the
list, in decimal. For lists beginning at value 1 ("1", "a", "A",
"i", or "I"), this attribute may be omitted.</p>
</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body"><p class="first last">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">enumerated_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">enumerated_list</tt>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id67">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
1. Item 1.
(A) Item A.
(B) Item B.
(C) Item C.
2. Item 2.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>
Item 1.
<enumerated_list enumtype="upperalpha" prefix="(" suffix=")">
<list_item>
<paragraph>
Item A.
<list_item>
<paragraph>
Item B.
<list_item>
<paragraph>
Item C.
<list_item>
<paragraph>
Item 2.
</pre>
<p>See <a class="reference internal" href="#list-item">list_item</a> for another example.</p>
</div>
</div>
<div class="section" id="error">
<h2><a class="toc-backref" href="#id232"><tt class="docutils literal">error</tt></a></h2>
<p>The <tt class="docutils literal">error</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id68">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">error</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">error</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">error</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Error" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id69">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">error</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">error</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">error</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id70">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Error:: Does not compute.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<error>
<paragraph>
Does not compute.
</pre>
</div>
</div>
<div class="section" id="field">
<h2><a class="toc-backref" href="#id233"><tt class="docutils literal">field</tt></a></h2>
<p>The <tt class="docutils literal">field</tt> element contains a pair of <a class="reference internal" href="#field-name">field_name</a> and <a class="reference internal" href="#field-body">field_body</a>
elements.</p>
<div class="section" id="id71">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">field</tt>: <a class="reference internal" href="#docinfo">docinfo</a>,
<a class="reference internal" href="#field-list">field_list</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body">Each <tt class="docutils literal">field</tt> element contains one <a class="reference internal" href="#field-name">field_name</a> and one
<a class="reference internal" href="#field-body">field_body</a> element.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#field-list">field_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id72">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#field-name">field_name</a>, <a class="reference internal" href="#field-body">field_body</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">field</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id73">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#field-list">field_list</a> and <a class="reference internal" href="#docinfo">docinfo</a> elements.</p>
</div>
</div>
<div class="section" id="field-body">
<h2><a class="toc-backref" href="#id234"><tt class="docutils literal">field_body</tt></a></h2>
<p>The <tt class="docutils literal">field_body</tt> element contains body elements. It is analogous to
a database field's data.</p>
<div class="section" id="id74">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#field">field</a> element contains <tt class="docutils literal">field_body</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">field_body</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field_body</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#field-list">field_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id75">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)*
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field_body</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id76">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#field-list">field_list</a> and <a class="reference internal" href="#docinfo">docinfo</a> elements.</p>
</div>
</div>
<div class="section" id="field-list">
<h2><a class="toc-backref" href="#id235"><tt class="docutils literal">field_list</tt></a></h2>
<p>The <tt class="docutils literal">field_list</tt> element contains two-column table-like structures
resembling database records (label & data pairs). Field lists are
often meant for further processing. In <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>, field lists
are used to represent bibliographic fields (contents of the <a class="reference internal" href="#docinfo">docinfo</a>
element) and directive options.</p>
<div class="section" id="id77">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">field_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">field_list</tt> elements contain one or more <a class="reference internal" href="#field">field</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field_list</tt> has no direct analogues in common DTDs. It can be
emulated with primitives such as tables.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A <tt class="docutils literal">field_list</tt> is typically rendered as a two-column list, where
the first column contains "labels" (usually with a colon suffix).
However, field lists are often used for extension syntax or
special processing. Such structures do not survive as field lists
to be rendered.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id78">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#field">field</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field_list</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">field_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">field_list</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id79">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
:Author: Me
:Version: 1
:Date: 2001-08-11
:Parameter i: integer
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<field_list>
<field>
<field_name>
Author
<field_body>
<paragraph>
Me
<field>
<field_name>
Version
<field_body>
<paragraph>
1
<field>
<field_name>
Date
<field_body>
<paragraph>
2001-08-11
<field>
<field_name>
Parameter i
<field_body>
<paragraph>
integer
</pre>
</div>
</div>
<div class="section" id="field-name">
<h2><a class="toc-backref" href="#id236"><tt class="docutils literal">field_name</tt></a></h2>
<p>The <tt class="docutils literal">field_name</tt> element contains text; it is analogous to a
database field's name.</p>
<div class="section" id="id80">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#field">field</a> element contains <tt class="docutils literal">field_name</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">field_name</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field_name</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#field-list">field_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id81">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field_name</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id82">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#field-list">field_list</a> and <a class="reference internal" href="#docinfo">docinfo</a> elements.</p>
</div>
</div>
<div class="section" id="figure">
<h2><a class="toc-backref" href="#id237"><tt class="docutils literal">figure</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="footer">
<h2><a class="toc-backref" href="#id238"><tt class="docutils literal">footer</tt></a></h2>
<p>The <tt class="docutils literal">footer</tt> element is a container element whose contents are meant
to appear at the bottom of a web page, or repeated at the bottom of
every printed page. The <tt class="docutils literal">footer</tt> element may contain processing
information (datestamp, a link to <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a>, etc.) as well as custom
content.</p>
<div class="section" id="id83">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#decorative-elements">Decorative Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#decoration">decoration</a> element contains <tt class="docutils literal">footer</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">footer</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body">There are no direct analogies to <tt class="docutils literal">footer</tt> in HTML or DocBook.
Equivalents are typically constructed from primitives and/or
generated by the processing system.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id84">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">footer</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id85">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms,
assuming that the datestamp command-line option or configuration
setting has been supplied:</p>
<pre class="literal-block">
<document>
<decoration>
<footer>
<paragraph>
Generated on: 2002-08-20.
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="footnote">
<h2><a class="toc-backref" href="#id239"><tt class="docutils literal">footnote</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="footnote-reference">
<h2><a class="toc-backref" href="#id240"><tt class="docutils literal">footnote_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="generated">
<h2><a class="toc-backref" href="#id241"><tt class="docutils literal">generated</tt></a></h2>
<p>Docutils wraps <tt class="docutils literal">generated</tt> elements around text that is inserted
(generated) by Docutils; i.e., text that was not in the document, like
section numbers inserted by the "sectnum" directive.</p>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="header">
<h2><a class="toc-backref" href="#id242"><tt class="docutils literal">header</tt></a></h2>
<p>The <tt class="docutils literal">header</tt> element is a container element whose contents are meant
to appear at the top of a web page, or at the top of every printed
page.</p>
<div class="section" id="id86">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#decorative-elements">Decorative Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#decoration">decoration</a> element contains <tt class="docutils literal">header</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">header</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body">There are no direct analogies to <tt class="docutils literal">header</tt> in HTML or DocBook.
Equivalents are typically constructed from primitives and/or
generated by the processing system.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id87">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">header</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id88">
<h3>Examples</h3>
<p>reStructuredText source fragment:</p>
<pre class="literal-block">
.. header:: This space for rent.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<document>
<decoration>
<header>
<paragraph>
This space for rent.
</pre>
</div>
</div>
<div class="section" id="hint">
<h2><a class="toc-backref" href="#id243"><tt class="docutils literal">hint</tt></a></h2>
<p>The <tt class="docutils literal">hint</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id89">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">hint</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">hint</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">hint</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Hint" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id90">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">hint</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">hint</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">hint</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id91">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Hint:: It's bigger than a bread box.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<hint>
<paragraph>
It's bigger than a bread box.
</pre>
</div>
</div>
<div class="section" id="image">
<h2><a class="toc-backref" href="#id244"><tt class="docutils literal">image</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="important">
<h2><a class="toc-backref" href="#id245"><tt class="docutils literal">important</tt></a></h2>
<p>The <tt class="docutils literal">important</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id92">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">important</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">important</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">important</tt> is analogous to the DocBook "important" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Important" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id93">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">important</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">important</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">important</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id94">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Important::
* Wash behind your ears.
* Clean up your room.
* Back up your data.
* Call your mother.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<important>
<bullet_list>
<list_item>
<paragraph>
Wash behind your ears.
<list_item>
<paragraph>
Clean up your room.
<list_item>
<paragraph>
Back up your data.
<list_item>
<paragraph>
Call your mother.
</pre>
</div>
</div>
<div class="section" id="inline">
<h2><a class="toc-backref" href="#id246"><tt class="docutils literal">inline</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="label">
<h2><a class="toc-backref" href="#id247"><tt class="docutils literal">label</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="legend">
<h2><a class="toc-backref" href="#id248"><tt class="docutils literal">legend</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="line">
<h2><a class="toc-backref" href="#id249"><tt class="docutils literal">line</tt></a></h2>
<p>The <tt class="docutils literal">line</tt> element contains a single line of text, part of a
<a class="reference internal" href="#line-block">line_block</a>.</p>
<div class="section" id="id95">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#line-block">line_block</a> element contains <tt class="docutils literal">line</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">line</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">line</tt> has no direct analogues in common DTDs. It can be
emulated with primitives or type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#line-block">line_block</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id96">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">line</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id97">
<h3>Examples</h3>
<p>See <a class="reference internal" href="#line-block">line_block</a>.</p>
</div>
</div>
<div class="section" id="line-block">
<h2><a class="toc-backref" href="#id250"><tt class="docutils literal">line_block</tt></a></h2>
<p>The <tt class="docutils literal">line_block</tt> element contains a sequence of lines and nested
line blocks. Line breaks (implied between elements) and leading
whitespace (indicated by nesting) is significant and must be
preserved. <tt class="docutils literal">line_block</tt> elements are commonly used for verse and
addresses. See <a class="reference internal" href="#literal-block">literal_block</a> for an alternative useful for program
listings and interactive computer sessions.</p>
<div class="section" id="id98">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">line_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">line_block</tt> elements may contain <a class="reference internal" href="#line">line</a> elements and nested
<tt class="docutils literal">line_block</tt> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">line_block</tt> is analogous to the DocBook "literallayout" element
and to the HTML "pre" element (with modifications to typeface
styles).</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Unlike <tt class="docutils literal">literal_block</tt>, <tt class="docutils literal">line_block</tt> elements are typically
rendered in an ordinary text typeface. It is crucial that leading
whitespace and line breaks are preserved in the rendered form.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id99">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#line">line</a> | <a class="reference internal" href="#line-block">line_block</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">line_block</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">line_block</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">line_block</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id100">
<h3>Examples</h3>
<p>reStructuredText uses a directive to indicate a <tt class="docutils literal">line_block</tt>.
Example source:</p>
<pre class="literal-block">
Take it away, Eric the Orchestra Leader!
| A one, two, a one two three four
|
| Half a bee, philosophically,
| must, *ipso facto*, half not be.
| But half the bee has got to be,
| *vis a vis* its entity. D'you see?
|
| But can a bee be said to be
| or not to be an entire bee,
| when half the bee is not a bee,
| due to some ancient injury?
|
| Singing...
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
Take it away, Eric the Orchestra Leader!
<line_block>
<line>
A one, two, a one two three four
<line>
<line>
Half a bee, philosophically,
<line_block>
<line>
must,
<emphasis>
ipso facto
, half not be.
<line>
But half the bee has got to be,
<line_block>
<line>
<emphasis>
vis a vis
its entity. D'you see?
<line>
<line>
But can a bee be said to be
<line_block>
<line>
or not to be an entire bee,
<line_block>
<line>
when half the bee is not a bee,
<line_block>
<line>
due to some ancient injury?
<line>
<line>
Singing...
</pre>
</div>
</div>
<div class="section" id="list-item">
<h2><a class="toc-backref" href="#id251"><tt class="docutils literal">list_item</tt></a></h2>
<p>The <tt class="docutils literal">list_item</tt> element is a container for the elements of a list
item.</p>
<div class="section" id="id101">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (compound)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The <a class="reference internal" href="#bullet-list">bullet_list</a> and <a class="reference internal" href="#enumerated-list">enumerated_list</a> elements contain
<tt class="docutils literal">list_item</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">list_item</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">list_item</tt> is analogous to the HTML "li" element and to the
DocBook "listitem" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#bullet-list">bullet_list</a> or <a class="reference internal" href="#enumerated-list">enumerated_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id102">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)*
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">list_item</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id103">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
1. Outer list, item 1.
* Inner list, item 1.
* Inner list, item 2.
2. Outer list, item 2.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>
Outer list, item 1.
<bullet_list bullet="*">
<list_item>
<paragraph>
Inner list, item 1.
<list_item>
<paragraph>
Inner list, item 2.
<list_item>
<paragraph>
Outer list, item 2.
</pre>
<p>See <a class="reference internal" href="#bullet-list">bullet_list</a> or <a class="reference internal" href="#enumerated-list">enumerated_list</a> for further examples.</p>
</div>
</div>
<div class="section" id="literal">
<h2><a class="toc-backref" href="#id252"><tt class="docutils literal">literal</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="literal-block">
<h2><a class="toc-backref" href="#id253"><tt class="docutils literal">literal_block</tt></a></h2>
<p>The <tt class="docutils literal">literal_block</tt> element contains a block of text where line
breaks and whitespace are significant and must be preserved.
<tt class="docutils literal">literal_block</tt> elements are commonly used for program listings and
interactive computer sessions. See <a class="reference internal" href="#line-block">line_block</a> for an alternative
useful for verse and addresses.</p>
<div class="section" id="id104">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">literal_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">literal_block</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">literal_block</tt> is analogous to the HTML "pre" element and to
the DocBook "programlisting" and "screen" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><tt class="docutils literal">literal_block</tt> elements are typically rendered in a monospaced
typeface. It is crucial that all whitespace and line breaks are
preserved in the rendered form.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id105">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">literal_block</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">literal_block</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">literal_block</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id106">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
Here is a literal block::
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
Here is a literal block:
<literal_block xml:space="preserve">
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
</pre>
</div>
</div>
<div class="section" id="math">
<h2><a class="toc-backref" href="#id254"><tt class="docutils literal">math</tt></a></h2>
<p>The <tt class="docutils literal">math</tt> element contains text in <span class="incremental">LaTeX math format</span> that is typeset
as mathematical notation (inline formula).</p>
<p>If the output format does not support math typesetting, the content is
inserted verbatim.</p>
<div class="section" id="id107">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#inline-elements">Inline Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id184">%inline.elements;</a> parameter entities in
their content models may contain <tt class="docutils literal">math</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">math</tt> elements may contain text data.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">math</tt> is analogous to a MathML "math" element or
the LaTeX (<tt class="docutils literal">$ math $</tt>) mode.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered as mathematical notation.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id108">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">math</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>).</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="math-block">
<h2><a class="toc-backref" href="#id255"><tt class="docutils literal">math_block</tt></a></h2>
<p>The <tt class="docutils literal">math_block</tt> element contains a block of text in <span class="incremental">LaTeX math
format</span> that is typeset as mathematical notation (display formula).
The <tt class="docutils literal">math_block</tt> element is generated during the initial parse from a
"math" directive.</p>
<p>If the output format does not support math typesetting, the content is
inserted verbatim.</p>
<div class="section" id="id109">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">math_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">math_block</tt> elements may contain text data.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">math_block</tt> is analogous to a LaTeX "equation*" environment or
a MathML "math" element displayed as block-level element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered in a block as mathematical notation, typically centered or with
indentation</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id110">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">math</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>).</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="note">
<h2><a class="toc-backref" href="#id256"><tt class="docutils literal">note</tt></a></h2>
<p>The <tt class="docutils literal">note</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id111">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">note</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">note</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">note</tt> is analogous to the DocBook "note" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Note" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id112">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">note</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">note</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">note</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id113">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Note:: Admonitions can be handy to break up a
long boring technical document.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<note>
<paragraph>
Admonitions can be handy to break up a
long boring technical document.
</pre>
</div>
</div>
<div class="section" id="option">
<h2><a class="toc-backref" href="#id257"><tt class="docutils literal">option</tt></a></h2>
<p>The <tt class="docutils literal">option</tt> element groups an option string together with zero or
more option argument placeholders. Note that <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>
currently supports only one argument per option.</p>
<div class="section" id="id114">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option-group">option_group</a> element contains <tt class="docutils literal">option</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body">Each <tt class="docutils literal">option</tt> element contains one <a class="reference internal" href="#option-string">option_string</a> and zero or
more <a class="reference internal" href="#option-argument">option_argument</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#option-list">option_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id115">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-string">option_string</a>, <a class="reference internal" href="#option-argument">option_argument</a> *)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id116">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-argument">
<h2><a class="toc-backref" href="#id258"><tt class="docutils literal">option_argument</tt></a></h2>
<p>The <tt class="docutils literal">option_argument</tt> element contains placeholder text for option
arguments.</p>
<div class="section" id="id117">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option">option</a> element contains <tt class="docutils literal">option_argument</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">option_argument</tt> elements contain text data only.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_argument</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The value of the "delimiter" attribute is prefixed to the
<tt class="docutils literal">option_argument</tt>, separating it from its <a class="reference internal" href="#option-string">option_string</a> or a
preceding <tt class="docutils literal">option_argument</tt>. The <tt class="docutils literal">option_argument</tt> text is
typically rendered in a monospaced typeface, possibly italicized
or otherwise altered to indicate its placeholder nature.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id118">
<h3>Content Model</h3>
<pre class="literal-block">
(#PCDATA)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">option_argument</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#delimiter">delimiter</a>.</p>
<p class="last"><tt class="docutils literal">delimiter</tt> contains the text preceding the <tt class="docutils literal">option_argument</tt>:
either the text separating it from the <a class="reference internal" href="#option-string">option_string</a> (typically
either "=" or " ") or the text between option arguments (typically
either "," or " ").</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id119">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-group">
<h2><a class="toc-backref" href="#id259"><tt class="docutils literal">option_group</tt></a></h2>
<p>The <tt class="docutils literal">option_group</tt> element groups together one or more <a class="reference internal" href="#option">option</a>
elements, all synonyms.</p>
<div class="section" id="id120">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><p class="first"><a class="reference internal" href="#body-subelements">Body Subelements</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body"><p class="first">Only the <a class="reference internal" href="#option-list-item">option_list_item</a> element contains <tt class="docutils literal">option_group</tt>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><p class="first"><tt class="docutils literal">option_group</tt> elements contain one or more <a class="reference internal" href="#option">option</a> elements.</p>
<p><tt class="docutils literal">option_group</tt> is an empty element and has no children.</p>
<p>Each <tt class="docutils literal">option_group</tt> element contains one _ and
one _ element.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><p class="first"><tt class="docutils literal">option_group</tt> has no direct analogues in common DTDs.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><p class="first last">Typically <a class="reference internal" href="#option">option</a> elements within an <tt class="docutils literal">option_group</tt> are joined
together in a comma-separated list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id121">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-group">option_group</a>, <a class="reference internal" href="#description">description</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_group</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id122">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-list">
<h2><a class="toc-backref" href="#id260"><tt class="docutils literal">option_list</tt></a></h2>
<p>Each <tt class="docutils literal">option_list</tt> element contains a two-column list of
command-line options and descriptions, documenting a program's
options.</p>
<div class="section" id="id123">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">option_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">option_list</tt> elements contain one or more <a class="reference internal" href="#option-list-item">option_list_item</a>
elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_list</tt> has no direct analogues in common DTDs. It can be
emulated with primitives such as tables.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">An <tt class="docutils literal">option_list</tt> is typically rendered as a two-column list,
where the first column contains option strings and arguments, and
the second column contains descriptions.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id124">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-list-item">option_list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_list</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">option_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">option_list</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id125">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
-a command-line option "a"
-1 file, --one=file, --two file
Multiple options with arguments.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<option_list>
<option_list_item>
<option_group>
<option>
<option_string>
-a
<description>
<paragraph>
command-line option "a"
<option_list_item>
<option_group>
<option>
<option_string>
-1
<option_argument delimiter=" ">
file
<option>
<option_string>
--one
<option_argument delimiter="=">
file
<option>
<option_string>
--two
<option_argument delimiter=" ">
file
<description>
<paragraph>
Multiple options with arguments.
</pre>
</div>
</div>
<div class="section" id="option-list-item">
<h2><a class="toc-backref" href="#id261"><tt class="docutils literal">option_list_item</tt></a></h2>
<p>The <tt class="docutils literal">option_list_item</tt> element is a container for a pair of
<a class="reference internal" href="#option-group">option_group</a> and <a class="reference internal" href="#description">description</a> elements.</p>
<div class="section" id="id126">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option-list">option_list</a> element contains <tt class="docutils literal">option_list_item</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body">Each <tt class="docutils literal">option_list_item</tt> element contains one <a class="reference internal" href="#option-group">option_group</a> and
one <a class="reference internal" href="#description">description</a> element.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_list_item</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#option-list">option_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id127">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-group">option_group</a>, <a class="reference internal" href="#description">description</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_list_item</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id128">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-string">
<h2><a class="toc-backref" href="#id262"><tt class="docutils literal">option_string</tt></a></h2>
<p>The <tt class="docutils literal">option_string</tt> element contains the text of a command-line
option.</p>
<div class="section" id="id129">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option">option</a> element contains <tt class="docutils literal">option_string</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">option_string</tt> elements contain text data only.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_string</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The <tt class="docutils literal">option_string</tt> text is typically rendered in a monospaced
typeface.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id130">
<h3>Content Model</h3>
<pre class="literal-block">
(#PCDATA)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_string</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id131">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="organization">
<h2><a class="toc-backref" href="#id263"><tt class="docutils literal">organization</tt></a></h2>
<p>The <tt class="docutils literal">organization</tt> element contains the name of document author's
organization, or the organization responsible for the document.</p>
<div class="section" id="id132">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">organization</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">organization</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">organization</tt> is analogous to the DocBook "orgname",
"corpname", or "publishername" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id133">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">organization</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">organization</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id134">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Organization: Humankind
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<organization>
Humankind
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="paragraph">
<h2><a class="toc-backref" href="#id264"><tt class="docutils literal">paragraph</tt></a></h2>
<p>The <tt class="docutils literal">paragraph</tt> element contains the text and inline elements of a
single paragraph, a fundamental building block of documents.</p>
<div class="section" id="id135">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">paragraph</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">paragraph</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">paragraph</tt> is analogous to the HTML "p" element and to the
DocBook "para" elements.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id136">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">paragraph</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">paragraph</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">paragraph</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id137">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A paragraph.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="pending">
<h2><a class="toc-backref" href="#id265"><tt class="docutils literal">pending</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="problematic">
<h2><a class="toc-backref" href="#id266"><tt class="docutils literal">problematic</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="raw">
<h2><a class="toc-backref" href="#id267"><tt class="docutils literal">raw</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="reference">
<h2><a class="toc-backref" href="#id268"><tt class="docutils literal">reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="revision">
<h2><a class="toc-backref" href="#id269"><tt class="docutils literal">revision</tt></a></h2>
<p>The <tt class="docutils literal">revision</tt> element contains the revision number of the document.
It can be used alone or in conjunction with <a class="reference internal" href="#version">version</a>.</p>
<div class="section" id="id138">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">revision</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">revision</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">revision</tt> is analogous to but simpler than the DocBook
"revision" element. It closely matches the DocBook "revnumber"
element, but in a simpler context.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Often used with the RCS/CVS keyword "Revision". See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id139">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">revision</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">revision</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id140">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Version: 1
:Revision: b
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<version>
1
<revision>
b
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="row">
<h2><a class="toc-backref" href="#id270"><tt class="docutils literal">row</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="rubric">
<h2><a class="toc-backref" href="#id271"><tt class="docutils literal">rubric</tt></a></h2>
<blockquote>
<p>rubric n. 1. a title, heading, or the like, in a manuscript,
book, statute, etc., written or printed in red or otherwise
distinguished from the rest of the text. ...</p>
<p class="attribution">—Random House Webster's College Dictionary, 1991</p>
</blockquote>
<p>A rubric is like an informal heading that doesn't correspond to the
document's structure.</p>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="section">
<h2><a class="toc-backref" href="#id272"><tt class="docutils literal">section</tt></a></h2>
<p>The <tt class="docutils literal">section</tt> element is the main unit of hierarchy for Docutils
documents. Docutils <tt class="docutils literal">section</tt> elements are a recursive structure; a
<tt class="docutils literal">section</tt> may contain other <tt class="docutils literal">section</tt> elements, without limit.
Paragraphs and other body elements may occur before a <tt class="docutils literal">section</tt>, but
not after it.</p>
<div class="section" id="id141">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">section</tt>: <a class="reference internal" href="#document">document</a>,
<a class="reference internal" href="#section">section</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">section</tt> elements begin with a <a class="reference internal" href="#title">title</a>, and may contain <a class="reference internal" href="#body-elements">body
elements</a> as well as <a class="reference internal" href="#transition">transition</a>, <a class="reference internal" href="#topic">topic</a>, and <a class="reference internal" href="#sidebar">sidebar</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">section</tt> is analogous to DocBook recursive "section" elements,
and to HTML "div" elements combined with "h1" etc. title elements.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id142">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>,
<a class="reference internal" href="#structure-model">%structure.model;</a>)
</pre>
<p>See the <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity for details of the body
of a <tt class="docutils literal">section</tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">section</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#section-elements">%section.elements;</a> parameter entity directly includes
<tt class="docutils literal">section</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">section</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id143">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Title 1
=======
Paragraph 1.
Title 2
-------
Paragraph 2.
Title 3
=======
Paragraph 3.
Title 4
-------
Paragraph 4.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing:</p>
<pre class="literal-block">
<document>
<section ids="title-1" names="title 1">
<title>
Title 1
<paragraph>
Paragraph 1.
<section ids="title-2" names="title 2">
<title>
Title 2
<paragraph>
Paragraph 2.
<section ids="title-3" names="title 3">
<title>
Title 3
<paragraph>
Paragraph 3.
<section ids="title-4" names="title 4">
<title>
Title 4
<paragraph>
Paragraph 4.
</pre>
</div>
</div>
<div class="section" id="sidebar">
<h2><a class="toc-backref" href="#id273"><tt class="docutils literal">sidebar</tt></a></h2>
<p>Sidebars are like miniature, parallel documents that occur inside
other documents, providing related or reference material. A
<tt class="docutils literal">sidebar</tt> is typically offset by a border and "floats" to the side
of the page; the document's main text may flow around it. Sidebars
can also be likened to super-footnotes; their content is outside of
the flow of the document's main text.</p>
<p>The <tt class="docutils literal">sidebar</tt> element is a nonrecursive <a class="reference internal" href="#section">section</a>-like construct
which may occur at the top level of a <a class="reference internal" href="#section">section</a> wherever a body element
(list, table, etc.) is allowed. In other words, <tt class="docutils literal">sidebar</tt> elements
cannot nest inside body elements, so you can't have a <tt class="docutils literal">sidebar</tt>
inside a <tt class="docutils literal">table</tt> or a <tt class="docutils literal">list</tt>, or inside another <tt class="docutils literal">sidebar</tt> (or
<a class="reference internal" href="#topic">topic</a>).</p>
<div class="section" id="id144">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">sidebar</tt>: <a class="reference internal" href="#document">document</a>,
<a class="reference internal" href="#section">section</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">sidebar</tt> elements begin with a <a class="reference internal" href="#title">title</a> and an optional <a class="reference internal" href="#subtitle">subtitle</a>
and contain <a class="reference internal" href="#body-elements">body elements</a> and <a class="reference internal" href="#topic">topic</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">sidebar</tt> is analogous to the DocBook "sidebar" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A <tt class="docutils literal">sidebar</tt> element should be set off from the rest of the
document somehow, typically with a border. Sidebars typically
"float" to the side of the page and the document's main text flows
around them.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id145">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>?,
(<a class="reference internal" href="#id183">%body.elements;</a> | <a class="reference internal" href="#topic">topic</a>)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">sidebar</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity directly includes
<tt class="docutils literal">sidebar</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id146">
<h3>Examples</h3>
<p>The <a class="reference external" href="rst/directives.html#sidebar">"sidebar" directive</a> is used to create a <tt class="docutils literal">sidebar</tt> element.
<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
.. sidebar:: Title
:subtitle: If Desired
Body.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<sidebar>
<title>
Title
<subtitle>
If Desired
<paragraph>
Body.
</pre>
</div>
</div>
<div class="section" id="status">
<h2><a class="toc-backref" href="#id274"><tt class="docutils literal">status</tt></a></h2>
<p>The <tt class="docutils literal">status</tt> element contains a status statement for the document,
such as "Draft", "Final", "Work In Progress", etc.</p>
<div class="section" id="id147">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">status</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">status</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">status</tt> is analogous to the DocBook "status" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id148">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">status</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">status</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id149">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Status: Work In Progress
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<status>
Work In Progress
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="strong">
<h2><a class="toc-backref" href="#id275"><tt class="docutils literal">strong</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="subscript">
<h2><a class="toc-backref" href="#id276"><tt class="docutils literal">subscript</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="substitution-definition">
<h2><a class="toc-backref" href="#id277"><tt class="docutils literal">substitution_definition</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="substitution-reference">
<h2><a class="toc-backref" href="#id278"><tt class="docutils literal">substitution_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="subtitle">
<h2><a class="toc-backref" href="#id279"><tt class="docutils literal">subtitle</tt></a></h2>
<p>The <tt class="docutils literal">subtitle</tt> element stores the subtitle of a <a class="reference internal" href="#document">document</a>.</p>
<div class="section" id="id150">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The <a class="reference internal" href="#document">document</a> and <a class="reference internal" href="#sidebar">sidebar</a> elements may contain <tt class="docutils literal">subtitle</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">subtitle</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">subtitle</tt> is analogous to HTML header elements ("h2" etc.) and
to the DocBook "subtitle" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A document's subtitle is usually rendered smaller than its <a class="reference internal" href="#title">title</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id151">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">subtitle</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id152">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
=======
Title
=======
----------
Subtitle
----------
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="title" names="title">
<title>
Title
<subtitle ids="subtitle" names="subtitle">
Subtitle
<paragraph>
A paragraph.
</pre>
<p>Note how two section levels have collapsed, promoting their titles to
become the document's title and subtitle. Since there is only one
structural element (document), the subsection's <tt class="docutils literal">ids</tt> and <tt class="docutils literal">names</tt>
attributes are stored in the <tt class="docutils literal">subtitle</tt> element.</p>
</div>
</div>
<div class="section" id="superscript">
<h2><a class="toc-backref" href="#id280"><tt class="docutils literal">superscript</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="system-message">
<h2><a class="toc-backref" href="#id281"><tt class="docutils literal">system_message</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="table">
<h2><a class="toc-backref" href="#id282"><tt class="docutils literal">table</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="target">
<h2><a class="toc-backref" href="#id283"><tt class="docutils literal">target</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="tbody">
<h2><a class="toc-backref" href="#id284"><tt class="docutils literal">tbody</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="term">
<h2><a class="toc-backref" href="#id285"><tt class="docutils literal">term</tt></a></h2>
<p>The <tt class="docutils literal">term</tt> element contains a word or phrase being defined in a
<a class="reference internal" href="#definition-list">definition_list</a>.</p>
<div class="section" id="id153">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#definition-list-item">definition_list_item</a> element contains <tt class="docutils literal">term</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">term</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">term</tt> is analogous to the HTML "dt" element and to the DocBook
"term" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id154">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">term</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id155">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#definition-list">definition_list</a>, <a class="reference internal" href="#definition-list-item">definition_list_item</a>, and
<a class="reference internal" href="#classifier">classifier</a> elements.</p>
</div>
</div>
<div class="section" id="tgroup">
<h2><a class="toc-backref" href="#id286"><tt class="docutils literal">tgroup</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="thead">
<h2><a class="toc-backref" href="#id287"><tt class="docutils literal">thead</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="tip">
<h2><a class="toc-backref" href="#id288"><tt class="docutils literal">tip</tt></a></h2>
<p>The <tt class="docutils literal">tip</tt> element is an admonition, a distinctive and self-contained
notice. Also see the other admonition elements Docutils offers (in
alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>,
<a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id156">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">tip</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">tip</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">tip</tt> is analogous to the DocBook "tip" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Tip" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id157">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">tip</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes <tt class="docutils literal">tip</tt>.
The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly includes
<tt class="docutils literal">tip</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id158">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Tip:: 15% if the service is good.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<tip>
<paragraph>
15% if the service is good.
</pre>
</div>
</div>
<div class="section" id="id159">
<span id="title"></span><h2><a class="toc-backref" href="#id289"><tt class="docutils literal">title</tt></a></h2>
<p>The <tt class="docutils literal">title</tt> element stores the title of a <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>,
<a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#sidebar">sidebar</a>, or generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id160">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">title</tt>: <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>,
<a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#sidebar">sidebar</a>, <a class="reference internal" href="#admonition">admonition</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">title</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">title</tt> is analogous to HTML "title" and header ("h1" etc.)
elements, and to the DocBook "title" element.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id161">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">title</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#refid">refid</a> and <a class="reference internal" href="#auto">auto</a>.</p>
<p><tt class="docutils literal">refid</tt> is used as a backlink to a table of contents entry.</p>
<p class="last"><tt class="docutils literal">auto</tt> is used to indicate (with value "1") that the <tt class="docutils literal">title</tt>
has been numbered automatically.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id162">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A Title
=======
A paragraph.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<section ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="title-reference">
<h2><a class="toc-backref" href="#id290"><tt class="docutils literal">title_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="topic">
<h2><a class="toc-backref" href="#id291"><tt class="docutils literal">topic</tt></a></h2>
<p>The <tt class="docutils literal">topic</tt> element is a nonrecursive <a class="reference internal" href="#section">section</a>-like construct which
may occur at the top level of a <a class="reference internal" href="#section">section</a> wherever a body element
(list, table, etc.) is allowed. In other words, <tt class="docutils literal">topic</tt> elements
cannot nest inside body elements, so you can't have a <tt class="docutils literal">topic</tt> inside
a <tt class="docutils literal">table</tt> or a <tt class="docutils literal">list</tt>, or inside another <tt class="docutils literal">topic</tt>.</p>
<div class="section" id="id163">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">topic</tt>: <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>,
<a class="reference internal" href="#sidebar">sidebar</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">topic</tt> elements begin with a <a class="reference internal" href="#title">title</a> and may contain <a class="reference internal" href="#body-elements">body
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">topic</tt> is analogous to the DocBook "simplesect" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A <tt class="docutils literal">topic</tt> element should be set off from the rest of the
document somehow, such as with indentation or a border.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id164">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>?,
(<a class="reference internal" href="#id183">%body.elements;</a>)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">topic</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity directly includes
<tt class="docutils literal">topic</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id165">
<h3>Examples</h3>
<p>The <a class="reference external" href="rst/directives.html#topic">"topic" directive</a> is used to create a <tt class="docutils literal">topic</tt> element.
<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
.. topic:: Title
Body.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<topic>
<title>
Title
<paragraph>
Body.
</pre>
</div>
</div>
<div class="section" id="transition">
<h2><a class="toc-backref" href="#id292"><tt class="docutils literal">transition</tt></a></h2>
<p>The <tt class="docutils literal">transition</tt> element is commonly seen in novels and short
fiction, as a gap spanning one or more lines, with or without a type
ornament such as a row of asterisks. Transitions separate body
elements and sections, dividing a section into untitled divisions. A
transition may not begin or end a section <a class="footnote-reference" href="#id167" id="id166">[1]</a> or document, nor may
two transitions be immediately adjacent.</p>
<p>See <a class="reference external" href="../dev/rst/alternatives.html#doctree-representation-of-transitions">Doctree Representation of Transitions</a> in <a class="reference external" href="../dev/rst/alternatives.html">A Record of
reStructuredText Syntax Alternatives</a>.</p>
<table class="docutils footnote" frame="void" id="id167" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id166">[1]</a></td><td>In reStructuredText markup, a transition may appear to fall at
the end of a section immediately before another section. A
transform recognizes this case and moves the transition so it
separates the sections.</td></tr>
</tbody>
</table>
<div class="section" id="id170">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">transition</tt>: <a class="reference internal" href="#document">document</a>,
<a class="reference internal" href="#section">section</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">transition</tt> is an empty element and has no children.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">transition</tt> is analogous to the HTML "hr" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The <tt class="docutils literal">transition</tt> element is typically rendered as vertical
whitespace (more than that separating paragraphs), with or without
a horizontal line or row of asterisks. In novels, transitions are
often represented as a row of three well-spaced asterisks with
vertical space above and below.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id171">
<h3>Content Model</h3>
<pre class="literal-block">
EMPTY
</pre>
<p>The <tt class="docutils literal">transition</tt> element has no content; it is a "point element".</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">transition</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity directly includes
<tt class="docutils literal">transition</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id172">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Paragraph 1.
--------
Paragraph 2.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing:</p>
<pre class="literal-block">
<document>
<paragraph>
Paragraph 1.
<transition>
<paragraph>
Paragraph 2.
</pre>
</div>
</div>
<div class="section" id="version">
<h2><a class="toc-backref" href="#id293"><tt class="docutils literal">version</tt></a></h2>
<p>The <tt class="docutils literal">version</tt> element contains the version number of the document.
It can be used alone or in conjunction with <a class="reference internal" href="#revision">revision</a>.</p>
<div class="section" id="id173">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">version</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">version</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">version</tt> may be considered analogous to the DocBook "revision",
"revnumber", or "biblioid" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Sometimes used with the RCS/CVS keyword "Revision". See <a class="reference internal" href="#docinfo">docinfo</a>
and <a class="reference internal" href="#revision">revision</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id174">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">version</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id182">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">version</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id175">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Version: 1.1
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<version>
1.1
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="warning">
<h2><a class="toc-backref" href="#id294"><tt class="docutils literal">warning</tt></a></h2>
<p>The <tt class="docutils literal">warning</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>.</p>
<div class="section" id="id176">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id183">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">warning</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">warning</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">warning</tt> is analogous to the DocBook "warning" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Warning" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id177">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id183">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">warning</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id183">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">warning</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">warning</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id178">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. WARNING:: Reader discretion is strongly advised.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<warning>
<paragraph>
Reader discretion is strongly advised.
</pre>
</div>
</div>
</div>
<div class="section" id="attribute-reference">
<h1><a class="toc-backref" href="#id187">Attribute Reference</a></h1>
<div class="contents local topic" id="id179">
<ul class="simple">
<li><a class="reference internal" href="#anonymous" id="id295"><tt class="docutils literal">anonymous</tt></a></li>
<li><a class="reference internal" href="#auto" id="id296"><tt class="docutils literal">auto</tt></a></li>
<li><a class="reference internal" href="#backrefs" id="id297"><tt class="docutils literal">backrefs</tt></a></li>
<li><a class="reference internal" href="#bullet" id="id298"><tt class="docutils literal">bullet</tt></a></li>
<li><a class="reference internal" href="#classes" id="id299"><tt class="docutils literal">classes</tt></a></li>
<li><a class="reference internal" href="#delimiter" id="id300"><tt class="docutils literal">delimiter</tt></a></li>
<li><a class="reference internal" href="#dupnames" id="id301"><tt class="docutils literal">dupnames</tt></a></li>
<li><a class="reference internal" href="#enumtype" id="id302"><tt class="docutils literal">enumtype</tt></a></li>
<li><a class="reference internal" href="#ids" id="id303"><tt class="docutils literal">ids</tt></a></li>
<li><a class="reference internal" href="#names" id="id304"><tt class="docutils literal">names</tt></a></li>
<li><a class="reference internal" href="#prefix" id="id305"><tt class="docutils literal">prefix</tt></a></li>
<li><a class="reference internal" href="#refid" id="id306"><tt class="docutils literal">refid</tt></a></li>
<li><a class="reference internal" href="#refname" id="id307"><tt class="docutils literal">refname</tt></a></li>
<li><a class="reference internal" href="#refuri" id="id308"><tt class="docutils literal">refuri</tt></a></li>
<li><a class="reference internal" href="#source" id="id309"><tt class="docutils literal">source</tt></a></li>
<li><a class="reference internal" href="#start" id="id310"><tt class="docutils literal">start</tt></a></li>
<li><a class="reference internal" href="#suffix" id="id311"><tt class="docutils literal">suffix</tt></a></li>
<li><a class="reference internal" href="#xml-space" id="id312"><tt class="docutils literal">xml:space</tt></a></li>
<li><a class="reference internal" href="#id180" id="id313"><tt class="docutils literal">title</tt></a></li>
</ul>
</div>
<p><span class="target" id="common-attributes">Common Attributes</span>: Through the <a class="reference internal" href="#basic-atts">%basic.atts;</a> parameter entity,
all elements contain the following attributes: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>,
<a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</p>
<p id="attribute-type">Attribute types:</p>
<dl class="docutils">
<dt><tt class="docutils literal">CDATA</tt></dt>
<dd>Character data. <tt class="docutils literal">CDATA</tt> attributes may contain arbitrary text.</dd>
<dt><tt class="docutils literal">ID</tt></dt>
<dd>Like a <tt class="docutils literal">NMTOKEN</tt>, but it must begin with a letter (a "name
production"). Identical <tt class="docutils literal">ID</tt> values must not appear more than
once in a document; i.e., ID values must uniquely identify their
elements.</dd>
<dt><tt class="docutils literal">IDREF</tt></dt>
<dd>A reference to an <tt class="docutils literal">ID</tt> value (a name production) of another
element.</dd>
<dt><tt class="docutils literal">IDREFS</tt></dt>
<dd>One or more space-separated <tt class="docutils literal">ID</tt> references (name productions).</dd>
<dt><tt class="docutils literal">NMTOKEN</tt></dt>
<dd>A "name token". One or more of letters, digits, ".", "-", and
"_".</dd>
<dt><tt class="docutils literal">NMTOKENS</tt></dt>
<dd>One or more space-separated <tt class="docutils literal">NMTOKEN</tt> names.</dd>
<dt><tt class="docutils literal">%yesorno;</tt></dt>
<dd>No if zero ("0"), yes if any other value. This is a parameter
entity which resolves to a <tt class="docutils literal">NMTOKEN</tt> attribute type.</dd>
<dt><tt class="docutils literal">%number;</tt></dt>
<dd>This emphasizes that the attribute value must be a number. This
is a parameter entity which resolves to a <tt class="docutils literal">NMTOKEN</tt> attribute
type.</dd>
<dt>enumeration</dt>
<dd>The attribute value may be one of a specified list of values.</dd>
</dl>
<div class="section" id="anonymous">
<h2><a class="toc-backref" href="#id295"><tt class="docutils literal">anonymous</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">%yesorno;</tt>. Default value: none (implies no).</p>
<p>The <tt class="docutils literal">anonymous</tt> attribute is used for unnamed hyperlinks in the
<a class="reference internal" href="#target">target</a> and <a class="reference internal" href="#reference">reference</a> elements (via the <a class="reference internal" href="#anonymous-att">%anonymous.att;</a> parameter
entity).</p>
</div>
<div class="section" id="auto">
<h2><a class="toc-backref" href="#id296"><tt class="docutils literal">auto</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">auto</tt> attribute is used to indicate automatically-numbered
<a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a> and <a class="reference internal" href="#title">title</a> elements (via the
<a class="reference internal" href="#auto-att">%auto.att;</a> parameter entity).</p>
</div>
<div class="section" id="backrefs">
<h2><a class="toc-backref" href="#id297"><tt class="docutils literal">backrefs</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">IDREFS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">backrefs</tt> attribute contains a space-separated list of <a class="reference internal" href="#ids">ids</a>
references, used for backlinks from <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#citation">citation</a>, and
<a class="reference internal" href="#system-message">system_message</a> elements (via the <a class="reference internal" href="#backrefs-att">%backrefs.att;</a> parameter entity).</p>
</div>
<div class="section" id="bullet">
<h2><a class="toc-backref" href="#id298"><tt class="docutils literal">bullet</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">bullet</tt> attribute is used in the <a class="reference internal" href="#bullet-list">bullet_list</a> element.</p>
</div>
<div class="section" id="classes">
<h2><a class="toc-backref" href="#id299"><tt class="docutils literal">classes</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">NMTOKENS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">classes</tt> attribute is a list containing zero or more names used
to classify an element. The names are converted to conform to the
regular expression <tt class="docutils literal"><span class="pre">[a-z](-?[a-z0-9]+)*</span></tt> (see the <a class="reference external" href="rst/directives.html#class">"class"
directive</a> description for details and <a class="reference external" href="rst/directives.html#rationale">rationale</a>).</p>
<p>The purpose of the attribute is to indicate
an "is-a" variant relationship, to allow an extensible way of defining
sub-classes of existing elements. It can be used to carry context
forward between a Docutils Reader and Writer, when a custom structure
is reduced to a standardized document tree. One common use is in
conjunction with stylesheets, to add selection criteria. It should
not be used to carry formatting instructions or arbitrary content.</p>
<p>The <tt class="docutils literal">classes</tt> attribute's contents should be ignorable. Writers that
are not familiar with the variant expressed should be able to ignore
the attribute.</p>
<p><tt class="docutils literal">classes</tt> is one of the <a class="reference internal" href="#common-attributes">common attributes</a>, shared by all Docutils
elements.</p>
</div>
<div class="section" id="delimiter">
<h2><a class="toc-backref" href="#id300"><tt class="docutils literal">delimiter</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">delimiter</tt> attribute is used in the <a class="reference internal" href="#option-argument">option_argument</a> element.</p>
</div>
<div class="section" id="dupnames">
<h2><a class="toc-backref" href="#id301"><tt class="docutils literal">dupnames</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">dupnames</tt> attribute is a list containing the names of an
element when there has been a naming conflict. The contents of the
<tt class="docutils literal">dupnames</tt> attribute would have been transferred from the <a class="reference internal" href="#names">names</a>
attribute. An element may have at most one of the <tt class="docutils literal">names</tt> or
<tt class="docutils literal">dupnames</tt> attributes, but not both. <tt class="docutils literal">dupnames</tt> is one of the
<a class="reference internal" href="#common-attributes">common attributes</a>, shared by all Docutils elements.</p>
</div>
<div class="section" id="enumtype">
<h2><a class="toc-backref" href="#id302"><tt class="docutils literal">enumtype</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: enumeration, one of "arabic", "loweralpha",
"upperalpha", "lowerroman", or "upperroman". Default value: none.</p>
<p>The <tt class="docutils literal">enumtype</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="ids">
<h2><a class="toc-backref" href="#id303"><tt class="docutils literal">ids</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">NMTOKENS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">ids</tt> attribute is a list containing one or more unique
identifier keys. <tt class="docutils literal">ids</tt> is one of the <a class="reference internal" href="#common-attributes">common attributes</a>, shared
by all Docutils elements.</p>
</div>
<div class="section" id="names">
<h2><a class="toc-backref" href="#id304"><tt class="docutils literal">names</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">names</tt> attribute is a list containing the names of an element,
typically originating from the element's title or content. Each name
in <tt class="docutils literal">names</tt> must be unique; if there are name conflicts (two or more
elements want to the same name), the contents will be transferred to
the <a class="reference internal" href="#dupnames">dupnames</a> attribute on the duplicate elements. An element may
have at most one of the <tt class="docutils literal">names</tt> or <tt class="docutils literal">dupnames</tt> attributes, but not
both. <tt class="docutils literal">names</tt> is one of the <a class="reference internal" href="#common-attributes">common attributes</a>, shared by all
Docutils elements.</p>
</div>
<div class="section" id="prefix">
<h2><a class="toc-backref" href="#id305"><tt class="docutils literal">prefix</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">prefix</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="refid">
<h2><a class="toc-backref" href="#id306"><tt class="docutils literal">refid</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">IDREF</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">refid</tt> attribute contains references to <a class="reference internal" href="#ids">ids</a> attributes in
other elements. It is used by the <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#reference">reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#citation-reference">citation_reference</a>, <a class="reference internal" href="#title">title</a> and <a class="reference internal" href="#problematic">problematic</a>
elements (via the <a class="reference internal" href="#refid-att">%refid.att;</a> and <a class="reference internal" href="#reference-atts">%reference.atts;</a> parameter
entities).</p>
</div>
<div class="section" id="refname">
<h2><a class="toc-backref" href="#id307"><tt class="docutils literal">refname</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">NMTOKENS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">refname</tt> attribute contains an internal reference to the
<a class="reference internal" href="#names">names</a> attribute of another element. On a <a class="reference internal" href="#target">target</a> element,
<tt class="docutils literal">refname</tt> indicates an indirect target which may resolve to either
an internal or external reference. <tt class="docutils literal">refname</tt> is used by the
<a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#citation-reference">citation_reference</a>, and
<a class="reference internal" href="#substitution-reference">substitution_reference</a> elements (via the <a class="reference internal" href="#refname-att">%refname.att;</a> and
<a class="reference internal" href="#reference-atts">%reference.atts;</a> parameter entities).</p>
</div>
<div class="section" id="refuri">
<h2><a class="toc-backref" href="#id308"><tt class="docutils literal">refuri</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">refuri</tt> attribute contains an external reference to a URI/URL.
It is used by the <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, and
<a class="reference internal" href="#citation-reference">citation_reference</a> elements (via the <a class="reference internal" href="#reference-atts">%reference.atts;</a> parameter
entity).</p>
</div>
<div class="section" id="source">
<h2><a class="toc-backref" href="#id309"><tt class="docutils literal">source</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">source</tt> attribute is used to store the path or URL to the
source text that was used to produce the document tree. It is one of
the <a class="reference internal" href="#common-attributes">common attributes</a>, shared by all Docutils elements.</p>
</div>
<div class="section" id="start">
<h2><a class="toc-backref" href="#id310"><tt class="docutils literal">start</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">%number;</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">start</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="suffix">
<h2><a class="toc-backref" href="#id311"><tt class="docutils literal">suffix</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">suffix</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="xml-space">
<h2><a class="toc-backref" href="#id312"><tt class="docutils literal">xml:space</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: one of "default" or "preserve". Default value:
"preserve" (fixed).</p>
<p>The <tt class="docutils literal">xml:space</tt> attribute is a standard XML attribute for
whitespace-preserving elements. It is used by the <a class="reference internal" href="#literal-block">literal_block</a>,
<a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#comment">comment</a>, and <a class="reference internal" href="#raw">raw</a> elements (via the
<a class="reference internal" href="#fixedspace-att">%fixedspace.att;</a> parameter entity). It is a fixed attribute, meant
to communicate to an XML parser that the element contains significant
whitespace. The attribute value should not be set in a document
instance.</p>
</div>
<div class="section" id="id180">
<span id="title-attribute"></span><h2><a class="toc-backref" href="#id313"><tt class="docutils literal">title</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">title</tt> attribute stores the title metadata of a document. This
title is typically not part of the rendered document. It may for
example be used in HTML's <tt class="docutils literal">title</tt> element.</p>
</div>
</div>
<div class="section" id="parameter-entity-reference">
<h1><a class="toc-backref" href="#id188">Parameter Entity Reference</a></h1>
<div class="contents local topic" id="id181">
<ul class="simple">
<li><a class="reference internal" href="#anonymous-att" id="id314"><tt class="docutils literal">%anonymous.att;</tt></a></li>
<li><a class="reference internal" href="#auto-att" id="id315"><tt class="docutils literal">%auto.att;</tt></a></li>
<li><a class="reference internal" href="#backrefs-att" id="id316"><tt class="docutils literal">%backrefs.att;</tt></a></li>
<li><a class="reference internal" href="#basic-atts" id="id317"><tt class="docutils literal">%basic.atts;</tt></a></li>
<li><a class="reference internal" href="#id182" id="id318"><tt class="docutils literal">%bibliographic.elements;</tt></a></li>
<li><a class="reference internal" href="#id183" id="id319"><tt class="docutils literal">%body.elements;</tt></a></li>
<li><a class="reference internal" href="#fixedspace-att" id="id320"><tt class="docutils literal">%fixedspace.att;</tt></a></li>
<li><a class="reference internal" href="#id184" id="id321"><tt class="docutils literal">%inline.elements;</tt></a></li>
<li><a class="reference internal" href="#reference-atts" id="id322"><tt class="docutils literal">%reference.atts;</tt></a></li>
<li><a class="reference internal" href="#refid-att" id="id323"><tt class="docutils literal">%refid.att;</tt></a></li>
<li><a class="reference internal" href="#refname-att" id="id324"><tt class="docutils literal">%refname.att;</tt></a></li>
<li><a class="reference internal" href="#refuri-att" id="id325"><tt class="docutils literal">%refuri.att;</tt></a></li>
<li><a class="reference internal" href="#section-elements" id="id326"><tt class="docutils literal">%section.elements;</tt></a></li>
<li><a class="reference internal" href="#structure-model" id="id327"><tt class="docutils literal">%structure.model;</tt></a></li>
<li><a class="reference internal" href="#text-model" id="id328"><tt class="docutils literal">%text.model;</tt></a></li>
</ul>
</div>
<p>Parameter entities are used to simplify the DTD (to share definitions
and reduce duplication) and to allow the DTD to be customized by
wrapper DTDs (external client DTDs that use or import the Docutils
DTD). Parameter entities may be overridden by wrapper DTDs, replacing
the definitions below with custom definitions. Parameter entities
whose names begin with "additional" are meant to allow easy extension
by wrapper DTDs.</p>
<div class="section" id="anonymous-att">
<h2><a class="toc-backref" href="#id314"><tt class="docutils literal">%anonymous.att;</tt></a></h2>
<p>The <tt class="docutils literal">%anonymous.att;</tt> parameter entity contains the <a class="reference internal" href="#anonymous">anonymous</a>
attribute, used for unnamed hyperlinks.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#anonymous">anonymous</a> %yesorno; #IMPLIED
</pre>
<p>The <a class="reference internal" href="#reference">reference</a> and <a class="reference internal" href="#target">target</a> elements directly employ the
<tt class="docutils literal">%anonymous.att;</tt> parameter entity in their attribute lists.</p>
</div>
<div class="section" id="auto-att">
<h2><a class="toc-backref" href="#id315"><tt class="docutils literal">%auto.att;</tt></a></h2>
<p>The <tt class="docutils literal">%auto.att;</tt> parameter entity contains the <a class="reference internal" href="#auto">auto</a> attribute, used
to indicate an automatically-numbered footnote or title.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#auto">auto</a> CDATA #IMPLIED
</pre>
<p>The <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, and <a class="reference internal" href="#title">title</a> elements directly
employ the <tt class="docutils literal">%auto.att;</tt> parameter entity in their attribute lists.</p>
</div>
<div class="section" id="backrefs-att">
<h2><a class="toc-backref" href="#id316"><tt class="docutils literal">%backrefs.att;</tt></a></h2>
<p>The <tt class="docutils literal">%backrefs.att;</tt> parameter entity contains the <a class="reference internal" href="#backrefs">backrefs</a>
attribute, a space-separated list of id references, for backlinks.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#backrefs">backrefs</a> IDREFS #IMPLIED
</pre>
<p>The <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#footnote">footnote</a>, and <a class="reference internal" href="#system-message">system_message</a> elements directly employ
the <tt class="docutils literal">%backrefs.att;</tt> parameter entity in their attribute lists.</p>
</div>
<div class="section" id="basic-atts">
<h2><a class="toc-backref" href="#id317"><tt class="docutils literal">%basic.atts;</tt></a></h2>
<p>The <tt class="docutils literal">%basic.atts;</tt> parameter entity lists attributes common to all
Docutils elements. See <a class="reference internal" href="#common-attributes">Common Attributes</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#ids">ids</a> NMTOKENS #IMPLIED
<a class="reference internal" href="#names">names</a> CDATA #IMPLIED
<a class="reference internal" href="#dupnames">dupnames</a> CDATA #IMPLIED
<a class="reference internal" href="#source">source</a> CDATA #IMPLIED
<a class="reference internal" href="#classes">classes</a> NMTOKENS #IMPLIED
%additional.basic.atts;
</pre>
<p>The <tt class="docutils literal">%additional.basic.atts;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%basic.atts;</tt>.</p>
</div>
<div class="section" id="id182">
<h2><a class="toc-backref" href="#id318"><tt class="docutils literal">%bibliographic.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%bibliographic.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#bibliographic-elements">bibliographic elements</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#author">author</a> | <a class="reference internal" href="#authors">authors</a> | <a class="reference internal" href="#organization">organization</a> | <a class="reference internal" href="#contact">contact</a> | <a class="reference internal" href="#address">address</a>
| <a class="reference internal" href="#version">version</a> | <a class="reference internal" href="#revision">revision</a> | <a class="reference internal" href="#status">status</a> | <a class="reference internal" href="#date">date</a> | <a class="reference internal" href="#copyright">copyright</a>
| <a class="reference internal" href="#field">field</a>
%additional.bibliographic.elements;
</pre>
<p>The <tt class="docutils literal">%additional.bibliographic.elements;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%bibliographic.elements;</tt>.</p>
<p>Only the <a class="reference internal" href="#docinfo">docinfo</a> element directly employs the
<tt class="docutils literal">%bibliographic.elements;</tt> parameter entity in its content model.</p>
</div>
<div class="section" id="id183">
<h2><a class="toc-backref" href="#id319"><tt class="docutils literal">%body.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%body.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#body-elements">body elements</a>. <tt class="docutils literal">%body.elements;</tt> is itself contained within the
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#admonition">admonition</a> | <a class="reference internal" href="#attention">attention</a> | <a class="reference internal" href="#block-quote">block_quote</a> | <a class="reference internal" href="#bullet-list">bullet_list</a> | <a class="reference internal" href="#caution">caution</a>
| <a class="reference internal" href="#citation">citation</a> | <a class="reference internal" href="#compound">compound</a> | <a class="reference internal" href="#comment">comment</a> | <a class="reference internal" href="#container">container</a> | <a class="reference internal" href="#danger">danger</a> |
<a class="reference internal" href="#definition-list">definition_list</a> | <a class="reference internal" href="#doctest-block">doctest_block</a> | <a class="reference internal" href="#enumerated-list">enumerated_list</a> | <a class="reference internal" href="#error">error</a> |
<a class="reference internal" href="#field-list">field_list</a> | <a class="reference internal" href="#figure">figure</a> | <a class="reference internal" href="#footnote">footnote</a> | <a class="reference internal" href="#hint">hint</a> | <a class="reference internal" href="#image">image</a> | <a class="reference internal" href="#important">important</a>
| <a class="reference internal" href="#line-block">line_block</a> | <a class="reference internal" href="#literal-block">literal_block</a> | <a class="reference internal" href="#note">note</a> | <a class="reference internal" href="#option-list">option_list</a> |
<a class="reference internal" href="#paragraph">paragraph</a> | <a class="reference internal" href="#pending">pending</a> | <a class="reference internal" href="#raw">raw</a> <a class="reference internal" href="#reference">reference</a> | <a class="reference internal" href="#rubric">rubric</a> |
<a class="reference internal" href="#substitution-definition">substitution_definition</a> | <a class="reference internal" href="#system-message">system_message</a> | <a class="reference internal" href="#table">table</a> | <a class="reference internal" href="#target">target</a> |
<a class="reference internal" href="#tip">tip</a> | <a class="reference internal" href="#warning">warning</a> %additional.body.elements;
</pre>
<p>The <tt class="docutils literal">%additional.body.elements;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%body.elements;</tt>.</p>
<p>The <tt class="docutils literal">%body.elements;</tt> parameter entity is directly employed in the
content models of the following elements: <a class="reference internal" href="#admonition">admonition</a>, <a class="reference internal" href="#attention">attention</a>,
<a class="reference internal" href="#block-quote">block_quote</a>, <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#compound">compound</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#definition">definition</a>,
<a class="reference internal" href="#description">description</a>, <a class="reference internal" href="#entry">entry</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#field-body">field_body</a>, <a class="reference internal" href="#footer">footer</a>, <a class="reference internal" href="#footnote">footnote</a>,
<a class="reference internal" href="#header">header</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#legend">legend</a>, <a class="reference internal" href="#list-item">list_item</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#sidebar">sidebar</a>,
<a class="reference internal" href="#system-message">system_message</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#warning">warning</a></p>
<p>Via <a class="reference internal" href="#structure-model">%structure.model;</a>, the <tt class="docutils literal">%body.elements;</tt> parameter entity is
indirectly employed in the content models of the <a class="reference internal" href="#document">document</a> and
<a class="reference internal" href="#section">section</a> elements.</p>
</div>
<div class="section" id="fixedspace-att">
<h2><a class="toc-backref" href="#id320"><tt class="docutils literal">%fixedspace.att;</tt></a></h2>
<p>The <tt class="docutils literal">%fixedspace.att;</tt> parameter entity contains the <a class="reference internal" href="#xml-space">xml:space</a>
attribute, a standard XML attribute for whitespace-preserving
elements.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#xml-space">xml:space</a> (default | preserve) #FIXED 'preserve'
</pre>
<p>The <tt class="docutils literal">%fixedspace.att;</tt> parameter entity is directly employed in the
attribute lists of the following elements: <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#comment">comment</a>,
<a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#raw">raw</a></p>
</div>
<div class="section" id="id184">
<h2><a class="toc-backref" href="#id321"><tt class="docutils literal">%inline.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%inline.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#inline-elements">inline elements</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#abbreviation">abbreviation</a> | <a class="reference internal" href="#acronym">acronym</a> | <a class="reference internal" href="#citation-reference">citation_reference</a> | <a class="reference internal" href="#emphasis">emphasis</a> |
<a class="reference internal" href="#footnote-reference">footnote_reference</a> | <a class="reference internal" href="#generated">generated</a> | <a class="reference internal" href="#image">image</a> | <a class="reference internal" href="#inline">inline</a> | <a class="reference internal" href="#literal">literal</a> |
<a class="reference internal" href="#problematic">problematic</a> | <a class="reference internal" href="#raw">raw</a> | <a class="reference internal" href="#reference">reference</a> | <a class="reference internal" href="#strong">strong</a> | <a class="reference internal" href="#substitution-reference">substitution_reference</a> |
<a class="reference internal" href="#subscript">subscript</a> | <a class="reference internal" href="#superscript">superscript</a> | <a class="reference internal" href="#target">target</a> | <a class="reference internal" href="#title-reference">title_reference</a>
%additional.inline.elements;
</pre>
<p>The <tt class="docutils literal">%additional.inline.elements;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%inline.elements;</tt>.</p>
<p>Via <a class="reference internal" href="#text-model">%text.model;</a>, the <tt class="docutils literal">%inline.elements;</tt> parameter entity is
indirectly employed in the content models of the following elements:
<a class="reference internal" href="#abbreviation">abbreviation</a>, <a class="reference internal" href="#acronym">acronym</a>, <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#attribution">attribution</a>, <a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#caption">caption</a>,
<a class="reference internal" href="#classifier">classifier</a>, <a class="reference internal" href="#contact">contact</a>, <a class="reference internal" href="#copyright">copyright</a>, <a class="reference internal" href="#date">date</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#emphasis">emphasis</a>,
<a class="reference internal" href="#generated">generated</a>, <a class="reference internal" href="#inline">inline</a>, <a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#math">math</a>, <a class="reference internal" href="#math-block">math_block</a>,
<a class="reference internal" href="#organization">organization</a>,
<a class="reference internal" href="#paragraph">paragraph</a>, <a class="reference internal" href="#problematic">problematic</a>, <a class="reference internal" href="#raw">raw</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#revision">revision</a>, <a class="reference internal" href="#rubric">rubric</a>,
<a class="reference internal" href="#status">status</a>, <a class="reference internal" href="#strong">strong</a>, <a class="reference internal" href="#subscript">subscript</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>,
<a class="reference internal" href="#substitution-reference">substitution_reference</a>, <a class="reference internal" href="#subtitle">subtitle</a>, <a class="reference internal" href="#superscript">superscript</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#term">term</a>,
<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#title-reference">title_reference</a>, <a class="reference internal" href="#version">version</a></p>
</div>
<div class="section" id="reference-atts">
<h2><a class="toc-backref" href="#id322"><tt class="docutils literal">%reference.atts;</tt></a></h2>
<p>The <tt class="docutils literal">%reference.atts;</tt> parameter entity groups together the <a class="reference internal" href="#refuri">refuri</a>,
<a class="reference internal" href="#refid">refid</a>, and <a class="reference internal" href="#refname">refname</a> attributes.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refuri-att">%refuri.att;</a>
<a class="reference internal" href="#refid-att">%refid.att;</a>
<a class="reference internal" href="#refname-att">%refname.att;</a>
%additional.reference.atts;
</pre>
<p>The <tt class="docutils literal">%additional.reference.atts;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%additional.reference.atts;</tt>.</p>
<p>The <a class="reference internal" href="#citation-reference">citation_reference</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a>
elements directly employ the <tt class="docutils literal">%reference.att;</tt> parameter entity in
their attribute lists.</p>
</div>
<div class="section" id="refid-att">
<h2><a class="toc-backref" href="#id323"><tt class="docutils literal">%refid.att;</tt></a></h2>
<p>The <tt class="docutils literal">%refid.att;</tt> parameter entity contains the <a class="reference internal" href="#refid">refid</a> attribute, an
internal reference to the <a class="reference internal" href="#ids">ids</a> attribute of another element.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refid">refid</a> CDATA #IMPLIED
</pre>
<p>The <a class="reference internal" href="#title">title</a> and <a class="reference internal" href="#problematic">problematic</a> elements directly employ the
<tt class="docutils literal">%refid.att;</tt> parameter entity in their attribute lists.</p>
<p>Via <a class="reference internal" href="#reference-atts">%reference.atts;</a>, the <tt class="docutils literal">%refid.att;</tt> parameter entity is
indirectly employed in the attribute lists of the <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a> elements.</p>
</div>
<div class="section" id="refname-att">
<h2><a class="toc-backref" href="#id324"><tt class="docutils literal">%refname.att;</tt></a></h2>
<p>The <tt class="docutils literal">%refname.att;</tt> parameter entity contains the <a class="reference internal" href="#refname">refname</a>
attribute, an internal reference to the <a class="reference internal" href="#names">names</a> attribute of another
element. On a <a class="reference internal" href="#target">target</a> element, <tt class="docutils literal">refname</tt> indicates an indirect
target which may resolve to either an internal or external
reference.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refname">refname</a> NMTOKENS #IMPLIED
</pre>
<p>The <a class="reference internal" href="#substitution-reference">substitution_reference</a> element directly employs the
<tt class="docutils literal">%refname.att;</tt> parameter entity in its attribute list.</p>
<p>Via <a class="reference internal" href="#reference-atts">%reference.atts;</a>, the <tt class="docutils literal">%refname.att;</tt> parameter entity is
indirectly employed in the attribute lists of the <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a> elements.</p>
</div>
<div class="section" id="refuri-att">
<h2><a class="toc-backref" href="#id325"><tt class="docutils literal">%refuri.att;</tt></a></h2>
<p>The <tt class="docutils literal">%refuri.att;</tt> parameter entity contains the <a class="reference internal" href="#refuri">refuri</a> attribute,
an external reference to a URI/URL.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refuri">refuri</a> CDATA #IMPLIED
</pre>
<p>Via <a class="reference internal" href="#reference-atts">%reference.atts;</a>, the <tt class="docutils literal">%refuri.att;</tt> parameter entity is
indirectly employed in the attribute lists of the <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a> elements.</p>
</div>
<div class="section" id="section-elements">
<h2><a class="toc-backref" href="#id326"><tt class="docutils literal">%section.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%section.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#section">section</a>-equivalent elements. <tt class="docutils literal">%section.elements;</tt> is itself
contained within the <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#section">section</a>
%additional.section.elements;
</pre>
<p>The <tt class="docutils literal">%additional.section.elements;</tt> parameter entity can be used
by wrapper DTDs to extend <tt class="docutils literal">%section.elements;</tt>.</p>
<p>Via <a class="reference internal" href="#structure-model">%structure.model;</a>, the <tt class="docutils literal">%section.elements;</tt> parameter entity
is indirectly employed in the content models of the <a class="reference internal" href="#document">document</a> and
<a class="reference internal" href="#section">section</a> elements.</p>
</div>
<div class="section" id="structure-model">
<h2><a class="toc-backref" href="#id327"><tt class="docutils literal">%structure.model;</tt></a></h2>
<p>The <tt class="docutils literal">%structure.model;</tt> parameter entity encapsulates the
hierarchical structure of a document and of its constituent parts.
See the discussion of the <a class="reference internal" href="#element-hierarchy">element hierarchy</a> above.</p>
<p>Entity definition:</p>
<pre class="literal-block">
( ( (<a class="reference internal" href="#id183">%body.elements;</a> | <a class="reference internal" href="#topic">topic</a> | <a class="reference internal" href="#sidebar">sidebar</a>)+, <a class="reference internal" href="#transition">transition</a>? )*,
( (<a class="reference internal" href="#section-elements">%section.elements;</a>), (<a class="reference internal" href="#transition">transition</a>?, (<a class="reference internal" href="#section-elements">%section.elements;</a>) )* )? )
</pre>
<p>Each <a class="reference internal" href="#document">document</a> or <a class="reference internal" href="#section">section</a> contains zero or more body elements,
topics, and/or sidebars, optionally interspersed with single
transitions, followed by zero or more sections (whose contents are
recursively the same as this model) optionally interspersed with
transitions.</p>
<p>The following restrictions are imposed by this model:</p>
<ul class="simple">
<li>Transitions must be separated by other elements (body elements,
sections, etc.). In other words, a transition may not be
immediately adjacent to another transition.</li>
<li>A transition may not occur at the beginning of a document or
section.</li>
</ul>
<p>An additional restriction, which cannot be expressed in the language
of DTDs, is imposed by software:</p>
<ul class="simple">
<li>A transition may not occur at the end of a document or section.</li>
</ul>
<p>The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity is directly employed in the
content models of the <a class="reference internal" href="#document">document</a> and <a class="reference internal" href="#section">section</a> elements.</p>
</div>
<div class="section" id="text-model">
<h2><a class="toc-backref" href="#id328"><tt class="docutils literal">%text.model;</tt></a></h2>
<p>The <tt class="docutils literal">%text.model;</tt> parameter entity is used by many elements to
represent text data mixed with <a class="reference internal" href="#inline-elements">inline elements</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
(#PCDATA | <a class="reference internal" href="#id184">%inline.elements;</a>)*
</pre>
<p>The <tt class="docutils literal">%text.model;</tt> parameter entity is directly employed in the
content models of the following elements: <a class="reference internal" href="#abbreviation">abbreviation</a>, <a class="reference internal" href="#acronym">acronym</a>,
<a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#caption">caption</a>, <a class="reference internal" href="#classifier">classifier</a>, <a class="reference internal" href="#contact">contact</a>, <a class="reference internal" href="#copyright">copyright</a>, <a class="reference internal" href="#date">date</a>,
<a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#emphasis">emphasis</a>, <a class="reference internal" href="#field-name">field_name</a>, <a class="reference internal" href="#generated">generated</a>, <a class="reference internal" href="#line-block">line_block</a>,
<a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#organization">organization</a>, <a class="reference internal" href="#paragraph">paragraph</a>, <a class="reference internal" href="#problematic">problematic</a>, <a class="reference internal" href="#raw">raw</a>,
<a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#revision">revision</a>, <a class="reference internal" href="#status">status</a>, <a class="reference internal" href="#strong">strong</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>,
<a class="reference internal" href="#substitution-reference">substitution_reference</a>, <a class="reference internal" href="#subtitle">subtitle</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#term">term</a>, <a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#version">version</a></p>
<!-- Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
End: -->
</div>
</div>
</div>
</body>
</html>