docutils/test/functional/expected/standalone_rst_html5.html

   1 <!DOCTYPE html>
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4 <meta charset="utf-8"/>
   5 <meta name="viewport" content="width=device-width, initial-scale=1" />
   6 <meta name="generator" content="Docutils 0.17b2.dev: http://docutils.sourceforge.net/" />
   7 <title>reStructuredText Test Document</title>
   8 <meta name="author" content="David Goodger" />
   9 <meta name="author" content="Me" />
  10 <meta name="author" content="Myself" />
  11 <meta name="author" content="I" />
  12 <meta name="dcterms.date" content="Now, or yesterday.  Or maybe even before yesterday." />
  13 <meta name="dcterms.rights" content="This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else's heart desires." />
  14 <meta content="reStructuredText, test, parser" name="keywords" />
  15 <meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description" xml:lang="en" />
  16 <link rel="schema.dcterms" href="http://purl.org/dc/terms/"/>
  17 <link rel="stylesheet" href="../input/data/minimal.css" type="text/css" />
  18 <link rel="stylesheet" href="../input/data/plain.css" type="text/css" />
  19 <link rel="stylesheet" href="../input/data/math.css" type="text/css" />
  20 </head>
  21 <body class="with-toc">
  22 <header>
  23 <p>Document header</p>
  24 </header>
  25 <main id="restructuredtext-test-document">
  26 <span id="doctitle"></span>
  27 <h1 class="title">reStructuredText Test Document</h1>
  28 <p class="subtitle" id="examples-of-syntax-constructs"><span id="subtitle"></span>Examples of Syntax Constructs</p>
  29 <dl class="docinfo">
  30 <dt class="author">Author</dt>
  31 <dd class="author"><p>David Goodger</p></dd>
  32 <dt class="address">Address</dt>
  33 <dd class="address"><pre class="address">123 Example Street
  34 Example, EX  Canada
  35 A1B 2C3
  36 </pre>
  37 </dd>
  38 <dt class="contact">Contact</dt>
  39 <dd class="contact"><a class="reference external" href="mailto:goodger&#64;python.org">goodger&#64;python.org</a></dd>
  40 <dt class="authors">Authors</dt>
  41 <dd class="authors"><p>Me</p>
  42 <p>Myself</p>
  43 <p>I</p>
  44 </dd>
  45 <dt class="organization">Organization</dt>
  46 <dd class="organization">humankind</dd>
  47 <dt class="date">Date</dt>
  48 <dd class="date">Now, or yesterday.  Or maybe even <em>before</em> yesterday.</dd>
  49 <dt class="status">Status</dt>
  50 <dd class="status">This is a &quot;work in progress&quot;</dd>
  51 <dt class="revision">Revision</dt>
  52 <dd class="revision">is managed by a version control system.</dd>
  53 <dt class="version">Version</dt>
  54 <dd class="version">1</dd>
  55 <dt class="copyright">Copyright</dt>
  56 <dd class="copyright">This document has been placed in the public domain. You
  57 may do with it as you wish. You may copy, modify,
  58 redistribute, reattribute, sell, buy, rent, lease,
  59 destroy, or improve it, quote it at length, excerpt,
  60 incorporate, collate, fold, staple, or mutilate it, or do
  61 anything else to it that your or anyone else's heart
  62 desires.</dd>
  63 <dt class="field-name">field name</dt>
  64 <dd class="field-name"><p>This is a &quot;generic bibliographic field&quot;.</p>
  65 </dd>
  66 <dt class="field-name-2">field name &quot;2&quot;</dt>
  67 <dd class="field-name-2"><p>Generic bibliographic fields may contain multiple body elements.</p>
  68 <p>Like this.</p>
  69 </dd>
  70 </dl>
  71 <div class="dedication topic">
  72 <p class="topic-title">Dedication</p>
  73 <p>For Docutils users &amp; co-developers.</p>
  74 </div>
  75 <div class="abstract topic">
  76 <p class="topic-title">Abstract</p>
  77 <p>This is a test document, containing at least one example of each
  78 reStructuredText construct.</p>
  79 </div>
  80 <!-- This is a comment. Note how any initial comments are moved by
  81 transforms to after the document title, subtitle, and docinfo. -->
  82 <!-- Above is the document title, and below is the subtitle.
  83 They are transformed from section titles after parsing. -->
  84 <!-- bibliographic fields (which also require a transform): -->
  85 <div class="contents topic" id="table-of-contents">
  86 <p class="topic-title">Table of Contents</p>
  87 <ul class="auto-toc simple">
  88 <li><p><a class="reference internal" href="#structural-elements" id="toc-entry-1"><span class="sectnum">1</span> Structural Elements</a></p>
  89 <ul class="auto-toc">
  90 <li><p><a class="reference internal" href="#section-title" id="toc-entry-2"><span class="sectnum">1.1</span> Section Title</a></p></li>
  91 <li><p><a class="reference internal" href="#empty-section" id="toc-entry-3"><span class="sectnum">1.2</span> Empty Section</a></p></li>
  92 <li><p><a class="reference internal" href="#transitions" id="toc-entry-4"><span class="sectnum">1.3</span> Transitions</a></p></li>
  93 </ul>
  94 </li>
  95 <li><p><a class="reference internal" href="#body-elements" id="toc-entry-5"><span class="sectnum">2</span> Body Elements</a></p>
  96 <ul class="auto-toc">
  97 <li><p><a class="reference internal" href="#paragraphs" id="toc-entry-6"><span class="sectnum">2.1</span> Paragraphs</a></p>
  98 <ul class="auto-toc">
  99 <li><p><a class="reference internal" href="#inline-markup" id="toc-entry-7"><span class="sectnum">2.1.1</span> Inline Markup</a></p></li>
 100 </ul>
 101 </li>
 102 <li><p><a class="reference internal" href="#bullet-lists" id="toc-entry-8"><span class="sectnum">2.2</span> Bullet Lists</a></p></li>
 103 <li><p><a class="reference internal" href="#enumerated-lists" id="toc-entry-9"><span class="sectnum">2.3</span> Enumerated Lists</a></p></li>
 104 <li><p><a class="reference internal" href="#definition-lists" id="toc-entry-10"><span class="sectnum">2.4</span> Definition Lists</a></p></li>
 105 <li><p><a class="reference internal" href="#field-lists" id="toc-entry-11"><span class="sectnum">2.5</span> Field Lists</a></p></li>
 106 <li><p><a class="reference internal" href="#option-lists" id="toc-entry-12"><span class="sectnum">2.6</span> Option Lists</a></p></li>
 107 <li><p><a class="reference internal" href="#literal-blocks" id="toc-entry-13"><span class="sectnum">2.7</span> Literal Blocks</a></p></li>
 108 <li><p><a class="reference internal" href="#line-blocks" id="toc-entry-14"><span class="sectnum">2.8</span> Line Blocks</a></p></li>
 109 <li><p><a class="reference internal" href="#block-quotes" id="toc-entry-15"><span class="sectnum">2.9</span> Block Quotes</a></p></li>
 110 <li><p><a class="reference internal" href="#doctest-blocks" id="toc-entry-16"><span class="sectnum">2.10</span> Doctest Blocks</a></p></li>
 111 <li><p><a class="reference internal" href="#footnotes" id="toc-entry-17"><span class="sectnum">2.11</span> Footnotes</a></p></li>
 112 <li><p><a class="reference internal" href="#citations" id="toc-entry-18"><span class="sectnum">2.12</span> Citations</a></p></li>
 113 <li><p><a class="reference internal" href="#targets" id="toc-entry-19"><span class="sectnum">2.13</span> Targets</a></p>
 114 <ul class="auto-toc">
 115 <li><p><a class="reference internal" href="#duplicate-target-names" id="toc-entry-20"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></p></li>
 116 <li><p><a class="reference internal" href="#duplicate-target-names-1" id="toc-entry-21"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></p></li>
 117 </ul>
 118 </li>
 119 <li><p><a class="reference internal" href="#directives" id="toc-entry-22"><span class="sectnum">2.14</span> Directives</a></p>
 120 <ul class="auto-toc">
 121 <li><p><a class="reference internal" href="#document-parts" id="toc-entry-23"><span class="sectnum">2.14.1</span> Document Parts</a></p></li>
 122 <li><p><a class="reference internal" href="#images-and-figures" id="toc-entry-24"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li>
 123 <li><p><a class="reference internal" href="#tables" id="toc-entry-25"><span class="sectnum">2.14.3</span> Tables</a></p></li>
 124 <li><p><a class="reference internal" href="#admonitions" id="toc-entry-26"><span class="sectnum">2.14.4</span> Admonitions</a></p></li>
 125 <li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="toc-entry-27"><span class="sectnum">2.14.5</span> Topics, Sidebars, and Rubrics</a></p></li>
 126 <li><p><a class="reference internal" href="#target-footnotes" id="toc-entry-28"><span class="sectnum">2.14.6</span> Target Footnotes</a></p></li>
 127 <li><p><a class="reference internal" href="#replacement-text" id="toc-entry-29"><span class="sectnum">2.14.7</span> Replacement Text</a></p></li>
 128 <li><p><a class="reference internal" href="#compound-paragraph" id="toc-entry-30"><span class="sectnum">2.14.8</span> Compound Paragraph</a></p></li>
 129 <li><p><a class="reference internal" href="#parsed-literal-blocks" id="toc-entry-31"><span class="sectnum">2.14.9</span> Parsed Literal Blocks</a></p></li>
 130 <li><p><a class="reference internal" href="#code" id="toc-entry-32"><span class="sectnum">2.14.10</span> Code</a></p></li>
 131 <li><p><a class="reference internal" href="#meta" id="toc-entry-33"><span class="sectnum">2.14.11</span> Meta</a></p></li>
 132 </ul>
 133 </li>
 134 <li><p><a class="reference internal" href="#substitution-definitions" id="toc-entry-34"><span class="sectnum">2.15</span> Substitution Definitions</a></p></li>
 135 <li><p><a class="reference internal" href="#comments" id="toc-entry-35"><span class="sectnum">2.16</span> Comments</a></p></li>
 136 <li><p><a class="reference internal" href="#raw-text" id="toc-entry-36"><span class="sectnum">2.17</span> Raw text</a></p></li>
 137 <li><p><a class="reference internal" href="#container" id="toc-entry-37"><span class="sectnum">2.18</span> Container</a></p></li>
 138 <li><p><a class="reference internal" href="#colspanning-tables" id="toc-entry-38"><span class="sectnum">2.19</span> Colspanning tables</a></p></li>
 139 <li><p><a class="reference internal" href="#rowspanning-tables" id="toc-entry-39"><span class="sectnum">2.20</span> Rowspanning tables</a></p></li>
 140 <li><p><a class="reference internal" href="#complex-tables" id="toc-entry-40"><span class="sectnum">2.21</span> Complex tables</a></p></li>
 141 <li><p><a class="reference internal" href="#list-tables" id="toc-entry-41"><span class="sectnum">2.22</span> List Tables</a></p></li>
 142 <li><p><a class="reference internal" href="#custom-roles" id="toc-entry-42"><span class="sectnum">2.23</span> Custom Roles</a></p></li>
 143 </ul>
 144 </li>
 145 <li><p><a class="reference internal" href="#changes-to-the-html4css1-writer" id="toc-entry-43"><span class="sectnum">3</span> Changes to the <cite>html4css1</cite> Writer</a></p>
 146 <ul class="auto-toc">
 147 <li><p><a class="reference internal" href="#field-list-rendering" id="toc-entry-44"><span class="sectnum">3.1</span> Field List Rendering</a></p></li>
 148 <li><p><a class="reference internal" href="#styling-with-class-arguments" id="toc-entry-45"><span class="sectnum">3.2</span> Styling with Class Arguments</a></p>
 149 <ul class="auto-toc">
 150 <li><p><a class="reference internal" href="#description-lists" id="toc-entry-46"><span class="sectnum">3.2.1</span> Description Lists</a></p></li>
 151 <li><p><a class="reference internal" href="#field-list-variants" id="toc-entry-47"><span class="sectnum">3.2.2</span> Field List Variants</a></p></li>
 152 <li><p><a class="reference internal" href="#table-variants" id="toc-entry-48"><span class="sectnum">3.2.3</span> Table Variants</a></p></li>
 153 <li><p><a class="reference internal" href="#numbered-figures" id="toc-entry-49"><span class="sectnum">3.2.4</span> Numbered Figures</a></p></li>
 154 </ul>
 155 </li>
 156 <li><p><a class="reference internal" href="#text-level-semantics" id="toc-entry-50"><span class="sectnum">3.3</span> Text-Level Semantics</a></p></li>
 157 <li><p><a class="reference internal" href="#indicating-edits" id="toc-entry-51"><span class="sectnum">3.4</span> Indicating Edits</a></p></li>
 158 </ul>
 159 </li>
 160 <li><p><a class="reference internal" href="#error-handling" id="toc-entry-52"><span class="sectnum">4</span> Error Handling</a></p></li>
 161 </ul>
 162 </div>
 163 <section id="structural-elements">
 164 <h2><a class="toc-backref" href="#toc-entry-1"><span class="sectnum">1</span> Structural Elements</a></h2>
 165 <section id="section-title">
 166 <h3 class="with-subtitle"><a class="toc-backref" href="#toc-entry-2"><span class="sectnum">1.1</span> Section Title</a></h3>
 167 <p class="section-subtitle" id="section-subtitle">Section Subtitle</p>
 168 <p>Lone subsections are converted to a section subtitle by a transform
 169 activated with the <span class="docutils literal"><span class="pre">--section-subtitles</span></span> command line option or the
 170 <span class="docutils literal"><span class="pre">sectsubtitle-xform</span></span> configuration value.</p>
 171 </section>
 172 <section id="empty-section">
 173 <h3><a class="toc-backref" href="#toc-entry-3"><span class="sectnum">1.2</span> Empty Section</a></h3>
 174 </section>
 175 <section id="transitions">
 176 <h3><a class="toc-backref" href="#toc-entry-4"><span class="sectnum">1.3</span> Transitions</a></h3>
 177 <p>Here's a transition:</p>
 178 <hr class="docutils" />
 179 <p>It divides the section.  Transitions may also occur between sections:</p>
 180 </section>
 181 </section>
 182 <hr class="docutils" />
 183 <section id="body-elements">
 184 <h2><a class="toc-backref" href="#toc-entry-5"><span class="sectnum">2</span> Body Elements</a></h2>
 185 <section id="paragraphs">
 186 <h3><a class="toc-backref" href="#toc-entry-6"><span class="sectnum">2.1</span> Paragraphs</a></h3>
 187 <p>A paragraph.</p>
 188 <section id="inline-markup">
 189 <h4><a class="toc-backref" href="#toc-entry-7"><span class="sectnum">2.1.1</span> Inline Markup</a></h4>
 190 <p>Paragraphs contain text and may contain inline markup: <em>emphasis</em>,
 191 <strong>strong emphasis</strong>, <span class="docutils literal">inline literals</span>, standalone hyperlinks
 192 (<a class="reference external" href="http://www.python.org">http://www.python.org</a>), external hyperlinks (<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-18">7</a>), internal
 193 cross-references (<a class="reference internal" href="#example">example</a>), external hyperlinks with embedded URIs
 194 (<a class="reference external" href="http://www.python.org">Python web site</a>), <a class="reference external" href="http://www.python.org/">anonymous hyperlink
 195 references</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-25">7</a> (<a class="reference external" href="https://docutils.sourceforge.io/">a second reference</a> <a class="footnote-reference brackets" href="#footnote-12" id="footnote-reference-26">12</a>), footnote references (manually
 196 numbered <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-1">1</a>, anonymous auto-numbered <a class="footnote-reference brackets" href="#footnote-2" id="footnote-reference-2">3</a>, labeled auto-numbered
 197 <a class="footnote-reference brackets" href="#label" id="footnote-reference-3">2</a>, or symbolic <a class="footnote-reference brackets" href="#footnote-3" id="footnote-reference-4">*</a>), citation references (see <a class="citation-reference" href="#cit2002" id="citation-reference-1">[CIT2002]</a>),
 198 substitution references (<img alt="EXAMPLE" src="../../../docs/user/rst/images/biohazard.png" /> &amp;
 199 a <em>trimmed heart</em> <span class="docutils literal">(U+2665):</span>♥), and <span class="target" id="inline-hyperlink-targets">inline hyperlink targets</span>
 200 (see <a class="reference internal" href="#targets">Targets</a> below for a reference back to here).  Character-level
 201 inline markup is also possible (although exceedingly ugly!) in <em>re</em><span class="docutils literal">Structured</span><em>Text</em>.  Problems are indicated by <a href="#system-message-1"><span class="problematic" id="problematic-1">|problematic|</span></a> text
 202 (generated by processing errors; this one is intentional).  Here is a
 203 reference to the <a class="reference internal" href="#doctitle">doctitle</a> and the <a class="reference internal" href="#subtitle">subtitle</a>.</p>
 204 <p>The default role for interpreted text is <cite>Title Reference</cite>.  Here are
 205 some explicit interpreted text roles: a PEP reference (<a class="reference external" href="http://www.python.org/dev/peps/pep-0287">PEP 287</a>); an
 206 RFC reference (<a class="reference external" href="http://tools.ietf.org/html/rfc2822.html">RFC 2822</a>); an abbreviation (<abbr>abb.</abbr>), an acronym
 207 (<abbr>reST</abbr>), code (<code>print &quot;hello world&quot;</code>); a <sub>subscript</sub>;
 208 a <sup>superscript</sup> and explicit roles for <cite>Docutils</cite>'
 209 <em>standard</em> <strong>inline</strong> <span class="docutils literal">markup</span>.</p>
 210 <!-- DO NOT RE-WRAP THE FOLLOWING PARAGRAPH! -->
 211 <p>Let's test wrapping and whitespace significance in inline literals:
 212 <span class="docutils literal">This is an example of <span class="pre">--inline-literal</span> <span class="pre">--text,</span> <span class="pre">--including</span> <span class="pre">some--</span> <span class="pre">strangely--hyphenated-words.</span>  <span class="pre">Adjust-the-width-of-your-browser-window</span> to see how the text is wrapped.  <span class="pre">--</span> <span class="pre">----</span> <span class="pre">--------</span>  Now note    the spacing    between the    words of    this sentence    (words should    be grouped    in pairs).</span></p>
 213 <p>If the <span class="docutils literal"><span class="pre">--pep-references</span></span> option was supplied, there should be a
 214 live link to PEP 258 here.</p>
 215 </section>
 216 </section>
 217 <section id="bullet-lists">
 218 <h3><a class="toc-backref" href="#toc-entry-8"><span class="sectnum">2.2</span> Bullet Lists</a></h3>
 219 <ul>
 220 <li><p>A bullet list</p>
 221 <ul class="simple">
 222 <li><p>Nested bullet list.</p></li>
 223 <li><p>Nested item 2.</p></li>
 224 </ul>
 225 </li>
 226 <li><p>Item 2.</p>
 227 <p>Paragraph 2 of item 2.</p>
 228 <ul class="simple">
 229 <li><p>Nested bullet list.</p></li>
 230 <li><p>Nested item 2.</p>
 231 <ul>
 232 <li><p>Third level.</p></li>
 233 <li><p>Item 2.</p></li>
 234 </ul>
 235 </li>
 236 <li><p>Nested item 3.</p></li>
 237 <li><p>This nested list should be compacted by the HTML writer.</p>
 238 <span class="target" id="target"></span><!-- Even if this item contains a target and a comment. -->
 239 </li>
 240 </ul>
 241 </li>
 242 </ul>
 243 </section>
 244 <section id="enumerated-lists">
 245 <h3><a class="toc-backref" href="#toc-entry-9"><span class="sectnum">2.3</span> Enumerated Lists</a></h3>
 246 <ol class="arabic">
 247 <li><p>Arabic numerals.</p>
 248 <ol class="loweralpha simple">
 249 <li><p>lower alpha)</p>
 250 <ol class="lowerroman simple">
 251 <li><p>(lower roman)</p>
 252 <ol class="upperalpha simple">
 253 <li><p>upper alpha.</p>
 254 <ol class="upperroman simple">
 255 <li><p>upper roman)</p></li>
 256 </ol>
 257 </li>
 258 </ol>
 259 </li>
 260 </ol>
 261 </li>
 262 </ol>
 263 </li>
 264 <li><p>Lists that don't start at 1:</p>
 265 <ol class="arabic simple" start="3">
 266 <li><p>Three</p></li>
 267 <li><p>Four</p></li>
 268 </ol>
 269 <ol class="upperalpha simple" start="3">
 270 <li><p>C</p></li>
 271 <li><p>D</p></li>
 272 </ol>
 273 <ol class="lowerroman simple" start="3">
 274 <li><p>iii</p></li>
 275 <li><p>iv</p></li>
 276 </ol>
 277 </li>
 278 </ol>
 279 </section>
 280 <section id="definition-lists">
 281 <h3><a class="toc-backref" href="#toc-entry-10"><span class="sectnum">2.4</span> Definition Lists</a></h3>
 282 <dl>
 283 <dt>Term</dt>
 284 <dd><p>Definition</p>
 285 </dd>
 286 <dt>Term<span class="classifier">classifier</span></dt>
 287 <dd><p>Definition paragraph 1.</p>
 288 <p>Definition paragraph 2.</p>
 289 </dd>
 290 <dt>Term</dt>
 291 <dd><p>Definition</p>
 292 </dd>
 293 <dt>Term<span class="classifier">classifier one</span><span class="classifier">classifier two</span></dt>
 294 <dd><p>Definition</p>
 295 </dd>
 296 </dl>
 297 </section>
 298 <section id="field-lists">
 299 <h3><a class="toc-backref" href="#toc-entry-11"><span class="sectnum">2.5</span> Field Lists</a></h3>
 300 <dl class="field-list">
 301 <dt>what</dt>
 302 <dd><p>Field lists map field names to field bodies, like database
 303 records.  They are often part of an extension syntax.  They are
 304 an unambiguous variant of RFC 2822 fields.</p>
 305 </dd>
 306 <dt>how arg1 arg2</dt>
 307 <dd><p>The field marker is a colon, the field name, and a colon.</p>
 308 <p>The field body may contain one or more body elements, indented
 309 relative to the field marker.</p>
 310 </dd>
 311 <dt>credits</dt>
 312 <dd><p class="credits">This paragraph has the <cite>credits</cite> class set.  (This is actually not
 313 about credits but just for ensuring that the class attribute
 314 doesn't get stripped away.)</p>
 315 </dd>
 316 </dl>
 317 </section>
 318 <section id="option-lists">
 319 <h3><a class="toc-backref" href="#toc-entry-12"><span class="sectnum">2.6</span> Option Lists</a></h3>
 320 <p>For listing command-line options:</p>
 321 <dl class="option-list">
 322 <dt><kbd><span class="option">-a</span></kbd></dt>
 323 <dd><p>command-line option &quot;a&quot;</p>
 324 </dd>
 325 <dt><kbd><span class="option">-b <var>file</var></span></kbd></dt>
 326 <dd><p>options can have arguments
 327 and long descriptions</p>
 328 </dd>
 329 <dt><kbd><span class="option">--long</span></kbd></dt>
 330 <dd><p>options can be long also</p>
 331 </dd>
 332 <dt><kbd><span class="option">--input=<var>file</var></span></kbd></dt>
 333 <dd><p>long options can also have
 334 arguments</p>
 335 </dd>
 336 <dt><kbd><span class="option">--very-long-option</span></kbd></dt>
 337 <dd><p>The description can also start on the next line.</p>
 338 <p>The description may contain multiple body elements,
 339 regardless of where it starts.</p>
 340 </dd>
 341 <dt><kbd><span class="option">-x</span>, <span class="option">-y</span>, <span class="option">-z</span></kbd></dt>
 342 <dd><p>Multiple options are an &quot;option group&quot;.</p>
 343 </dd>
 344 <dt><kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></dt>
 345 <dd><p>Commonly-seen: short &amp; long options.</p>
 346 </dd>
 347 <dt><kbd><span class="option">-1 <var>file</var></span>, <span class="option">--one=<var>file</var></span>, <span class="option">--two <var>file</var></span></kbd></dt>
 348 <dd><p>Multiple options with arguments.</p>
 349 </dd>
 350 <dt><kbd><span class="option">/V</span></kbd></dt>
 351 <dd><p>DOS/VMS-style options too</p>
 352 </dd>
 353 </dl>
 354 <p>There must be at least two spaces between the option and the
 355 description.</p>
 356 </section>
 357 <section id="literal-blocks">
 358 <h3><a class="toc-backref" href="#toc-entry-13"><span class="sectnum">2.7</span> Literal Blocks</a></h3>
 359 <p>Literal blocks are indicated with a double-colon (&quot;::&quot;) at the end of
 360 the preceding paragraph (over there <span class="docutils literal"><span class="pre">--&gt;</span></span>).  They can be indented:</p>
 361 <pre class="literal-block">if literal_block:
 362     text = 'is left as-is'
 363     spaces_and_linebreaks = 'are preserved'
 364     markup_processing = None</pre>
 365 <p>Or they can be quoted without indentation:</p>
 366 <pre class="literal-block">&gt;&gt; Great idea!
 367 &gt;
 368 &gt; Why didn't I think of that?</pre>
 369 </section>
 370 <section id="line-blocks">
 371 <h3><a class="toc-backref" href="#toc-entry-14"><span class="sectnum">2.8</span> Line Blocks</a></h3>
 372 <p>This section tests line blocks.  Line blocks are body elements which
 373 consist of lines and other line blocks.  Nested line blocks cause
 374 indentation.</p>
 375 <div class="line-block">
 376 <div class="line">This is a line block.  It ends with a blank line.</div>
 377 <div class="line-block">
 378 <div class="line">New lines begin with a vertical bar (&quot;|&quot;).</div>
 379 <div class="line">Line breaks and initial indent are significant, and preserved.</div>
 380 <div class="line-block">
 381 <div class="line">Continuation lines are also possible.  A long line that is intended
 382 to wrap should begin with a space in place of the vertical bar.</div>
 383 </div>
 384 <div class="line">The left edge of a continuation line need not be aligned with
 385 the left edge of the text above it.</div>
 386 </div>
 387 </div>
 388 <div class="line-block">
 389 <div class="line">This is a second line block.</div>
 390 <div class="line"><br /></div>
 391 <div class="line">Blank lines are permitted internally, but they must begin with a &quot;|&quot;.</div>
 392 </div>
 393 <p>Another line block, surrounded by paragraphs:</p>
 394 <div class="line-block">
 395 <div class="line">And it's no good waiting by the window</div>
 396 <div class="line">It's no good waiting for the sun</div>
 397 <div class="line">Please believe me, the things you dream of</div>
 398 <div class="line">They don't fall in the lap of no-one</div>
 399 </div>
 400 <p>Take it away, Eric the Orchestra Leader!</p>
 401 <blockquote>
 402 <div class="line-block">
 403 <div class="line">A one, two, a one two three four</div>
 404 <div class="line"><br /></div>
 405 <div class="line">Half a bee, philosophically,</div>
 406 <div class="line-block">
 407 <div class="line">must, <em>ipso facto</em>, half not be.</div>
 408 </div>
 409 <div class="line">But half the bee has got to be,</div>
 410 <div class="line-block">
 411 <div class="line"><em>vis a vis</em> its entity.  D'you see?</div>
 412 <div class="line"><br /></div>
 413 </div>
 414 <div class="line">But can a bee be said to be</div>
 415 <div class="line-block">
 416 <div class="line">or not to be an entire bee,</div>
 417 <div class="line-block">
 418 <div class="line">when half the bee is not a bee,</div>
 419 <div class="line-block">
 420 <div class="line">due to some ancient injury?</div>
 421 <div class="line"><br /></div>
 422 </div>
 423 </div>
 424 </div>
 425 <div class="line">Singing...</div>
 426 </div>
 427 </blockquote>
 428 <p>A line block, like the following poem by Christian Morgenstern, can
 429 also be centre-aligned:</p>
 430 <div class="align-center line-block" lang="de">
 431 <div class="line"><strong>Die Trichter</strong></div>
 432 <div class="line"><br /></div>
 433 <div class="line">Zwei Trichter wandeln durch die Nacht.</div>
 434 <div class="line">Durch ihres Rumpfs verengten Schacht</div>
 435 <div class="line">fließt weißes Mondlicht</div>
 436 <div class="line">still und heiter</div>
 437 <div class="line">auf   ihren</div>
 438 <div class="line">Waldweg</div>
 439 <div class="line">u. s.</div>
 440 <div class="line">w.</div>
 441 <div class="line"><br /></div>
 442 </div>
 443 </section>
 444 <section id="block-quotes">
 445 <h3><a class="toc-backref" href="#toc-entry-15"><span class="sectnum">2.9</span> Block Quotes</a></h3>
 446 <p>Block quotes consist of indented body elements:</p>
 447 <blockquote>
 448 <p>My theory by A. Elk.  Brackets Miss, brackets.  This theory goes
 449 as follows and begins now.  All brontosauruses are thin at one
 450 end, much much thicker in the middle and then thin again at the
 451 far end.  That is my theory, it is mine, and belongs to me and I
 452 own it, and what it is too.</p>
 453 <p class="attribution">—Anne Elk (Miss)</p>
 454 </blockquote>
 455 <p>The language of a quote (like any other object) can be specified by
 456 a class attribute:</p>
 457 <!--  -->
 458 <blockquote lang="fr">
 459 <p>ReStructuredText est un langage de balisage léger utilisé
 460 notamment dans la documentation du langage Python.</p>
 461 </blockquote>
 462 </section>
 463 <section id="doctest-blocks">
 464 <h3><a class="toc-backref" href="#toc-entry-16"><span class="sectnum">2.10</span> Doctest Blocks</a></h3>
 465 <pre class="code python doctest">&gt;&gt;&gt; print 'Python-specific usage examples; begun with &quot;&gt;&gt;&gt;&quot;'
 466 Python-specific usage examples; begun with &quot;&gt;&gt;&gt;&quot;
 467 &gt;&gt;&gt; print '(cut and pasted from interactive Python sessions)'
 468 (cut and pasted from interactive Python sessions)
 469 </pre>
 470 </section>
 471 <section id="footnotes">
 472 <h3><a class="toc-backref" href="#toc-entry-17"><span class="sectnum">2.11</span> Footnotes</a></h3>
 473 <dl class="footnote brackets">
 474 <dt class="label" id="footnote-1"><span class="brackets">1</span><span class="fn-backref">(<a href="#footnote-reference-1">1</a>,<a href="#footnote-reference-5">2</a>,<a href="#footnote-reference-9">3</a>)</span></dt>
 475 <dd><p>A footnote contains body elements, consistently indented by at
 476 least 3 spaces.</p>
 477 <p>This is the footnote's second paragraph.</p>
 478 </dd>
 479 <dt class="label" id="label"><span class="brackets">2</span><span class="fn-backref">(<a href="#footnote-reference-3">1</a>,<a href="#footnote-reference-6">2</a>)</span></dt>
 480 <dd><p>Footnotes may be numbered, either manually (as in <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-5">1</a>) or
 481 automatically using a &quot;#&quot;-prefixed label.  This footnote has a
 482 label so it can be referred to from multiple places, both as a
 483 footnote reference (<a class="footnote-reference brackets" href="#label" id="footnote-reference-6">2</a>) and as a <a class="reference internal" href="#label">hyperlink reference</a>.</p>
 484 </dd>
 485 <dt class="label" id="footnote-2"><span class="brackets"><a class="fn-backref" href="#footnote-reference-2">3</a></span></dt>
 486 <dd><p>This footnote is numbered automatically and anonymously using a
 487 label of &quot;#&quot; only.</p>
 488 <p>This is the second paragraph.</p>
 489 <p>And this is the third paragraph.</p>
 490 </dd>
 491 <dt class="label" id="footnote-3"><span class="brackets"><a class="fn-backref" href="#footnote-reference-4">*</a></span></dt>
 492 <dd><p>Footnotes may also use symbols, specified with a &quot;*&quot; label.
 493 Here's a reference to the next footnote: <a class="footnote-reference brackets" href="#footnote-4" id="footnote-reference-7">†</a>.</p>
 494 </dd>
 495 <dt class="label" id="footnote-4"><span class="brackets"><a class="fn-backref" href="#footnote-reference-7">†</a></span></dt>
 496 <dd><p>This footnote shows the next symbol in the sequence.</p>
 497 </dd>
 498 <dt class="label" id="footnote-5"><span class="brackets">4</span></dt>
 499 <dd><p>Here's an unreferenced footnote, with a reference to a
 500 nonexistent footnote: <a href="#system-message-2"><span class="problematic" id="footnote-reference-8">[5]_</span></a>.</p>
 501 </dd>
 502 </dl>
 503 </section>
 504 <section id="citations">
 505 <h3><a class="toc-backref" href="#toc-entry-18"><span class="sectnum">2.12</span> Citations</a></h3>
 506 <dl class="citation">
 507 <dt class="label" id="cit2002"><span class="brackets">CIT2002</span><span class="fn-backref">(<a href="#citation-reference-1">1</a>,<a href="#citation-reference-2">2</a>)</span></dt>
 508 <dd><p>Citations are text-labeled footnotes. They may be
 509 rendered separately and differently from footnotes.</p>
 510 </dd>
 511 </dl>
 512 <p>Here's a reference to the above, <a class="citation-reference" href="#cit2002" id="citation-reference-2">[CIT2002]</a>, and a <a href="#system-message-3"><span class="problematic" id="citation-reference-3">[nonexistent]_</span></a>
 513 citation.</p>
 514 </section>
 515 <section id="targets">
 516 <span id="another-target"></span><h3><a class="toc-backref" href="#toc-entry-19"><span class="sectnum">2.13</span> Targets</a></h3>
 517 <p id="example">This paragraph is pointed to by the explicit &quot;example&quot; target. A
 518 reference can be found under <a class="reference internal" href="#inline-markup">Inline Markup</a>, above. <a class="reference internal" href="#inline-hyperlink-targets">Inline
 519 hyperlink targets</a> are also possible.</p>
 520 <p>Section headers are implicit targets, referred to by name. See
 521 <a class="reference internal" href="#targets">Targets</a>, which is a subsection of <a class="reference internal" href="#body-elements">Body Elements</a>.</p>
 522 <p>Explicit external targets are interpolated into references such as
 523 &quot;<a class="reference external" href="http://www.python.org/">Python</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-19">7</a>&quot;.</p>
 524 <p>Targets may be indirect and anonymous.  Thus <a class="reference internal" href="#targets">this phrase</a> may also
 525 refer to the <a class="reference internal" href="#targets">Targets</a> section.</p>
 526 <p>Here's a <a href="#system-message-4"><span class="problematic" id="problematic-2">`hyperlink reference without a target`_</span></a>, which generates an
 527 error.</p>
 528 <section id="duplicate-target-names">
 529 <h4><a class="toc-backref" href="#toc-entry-20"><span class="sectnum">2.13.1</span> Duplicate Target Names</a></h4>
 530 <p>Duplicate names in section headers or other implicit targets will
 531 generate &quot;info&quot; (level-1) system messages.  Duplicate names in
 532 explicit targets will generate &quot;warning&quot; (level-2) system messages.</p>
 533 </section>
 534 <section id="duplicate-target-names-1">
 535 <h4><a class="toc-backref" href="#toc-entry-21"><span class="sectnum">2.13.2</span> Duplicate Target Names</a></h4>
 536 <p>Since there are two &quot;Duplicate Target Names&quot; section headers, we
 537 cannot uniquely refer to either of them by name.  If we try to (like
 538 this: <a href="#system-message-5"><span class="problematic" id="problematic-3">`Duplicate Target Names`_</span></a>), an error is generated.</p>
 539 </section>
 540 </section>
 541 <section id="directives">
 542 <h3><a class="toc-backref" href="#toc-entry-22"><span class="sectnum">2.14</span> Directives</a></h3>
 543 <div class="contents local topic" id="contents">
 544 <ul class="auto-toc simple">
 545 <li><p><a class="reference internal" href="#document-parts" id="toc-entry-53"><span class="sectnum">2.14.1</span> Document Parts</a></p></li>
 546 <li><p><a class="reference internal" href="#images-and-figures" id="toc-entry-54"><span class="sectnum">2.14.2</span> Images and Figures</a></p></li>
 547 <li><p><a class="reference internal" href="#tables" id="toc-entry-55"><span class="sectnum">2.14.3</span> Tables</a></p></li>
 548 <li><p><a class="reference internal" href="#admonitions" id="toc-entry-56"><span class="sectnum">2.14.4</span> Admonitions</a></p></li>
 549 <li><p><a class="reference internal" href="#topics-sidebars-and-rubrics" id="toc-entry-57"><span class="sectnum">2.14.5</span> Topics, Sidebars, and Rubrics</a></p></li>
 550 <li><p><a class="reference internal" href="#target-footnotes" id="toc-entry-58"><span class="sectnum">2.14.6</span> Target Footnotes</a></p></li>
 551 <li><p><a class="reference internal" href="#replacement-text" id="toc-entry-59"><span class="sectnum">2.14.7</span> Replacement Text</a></p></li>
 552 <li><p><a class="reference internal" href="#compound-paragraph" id="toc-entry-60"><span class="sectnum">2.14.8</span> Compound Paragraph</a></p></li>
 553 <li><p><a class="reference internal" href="#parsed-literal-blocks" id="toc-entry-61"><span class="sectnum">2.14.9</span> Parsed Literal Blocks</a></p></li>
 554 <li><p><a class="reference internal" href="#code" id="toc-entry-62"><span class="sectnum">2.14.10</span> Code</a></p></li>
 555 <li><p><a class="reference internal" href="#meta" id="toc-entry-63"><span class="sectnum">2.14.11</span> Meta</a></p></li>
 556 </ul>
 557 </div>
 558 <p>These are just a sample of the many reStructuredText Directives.  For
 559 others, please see <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html">reStructuredText Directives</a> <a class="footnote-reference brackets" href="#footnote-13" id="footnote-reference-27">13</a>.</p>
 560 <section id="document-parts">
 561 <h4><a class="toc-backref" href="#toc-entry-53"><span class="sectnum">2.14.1</span> Document Parts</a></h4>
 562 <p>An example of the &quot;contents&quot; directive can be seen above this section
 563 (a local, untitled table of <a class="reference internal" href="#contents">contents</a>) and at the beginning of the
 564 document (a document-wide <a class="reference internal" href="#table-of-contents">table of contents</a>).</p>
 565 </section>
 566 <section id="images-and-figures">
 567 <h4><a class="toc-backref" href="#toc-entry-54"><span class="sectnum">2.14.2</span> Images and Figures</a></h4>
 568 <p>An image directive (also clickable -- a hyperlink reference):</p>
 569 <a class="reference internal image-reference" href="#directives"><img alt="../../../docs/user/rst/images/title.png" class="class1 class2" src="../../../docs/user/rst/images/title.png" style="width: 70%;" /></a>
 570 <p>Image with multiple IDs:</p>
 571 <span id="image-target-2"></span><span id="image-target-1"></span><img alt="../../../docs/user/rst/images/biohazard.png" id="image-target-3" src="../../../docs/user/rst/images/biohazard.png" />
 572 <p>A centered image:</p>
 573 <img alt="../../../docs/user/rst/images/biohazard.png" class="align-center" src="../../../docs/user/rst/images/biohazard.png" />
 574 <p>A left-aligned image:</p>
 575 <img alt="../../../docs/user/rst/images/biohazard.png" class="align-left" src="../../../docs/user/rst/images/biohazard.png" />
 576 <p>This paragraph might flow around the image.
 577 The specific behavior depends upon the style sheet and
 578 the browser or rendering software used.</p>
 579 <p>A right-aligned image:</p>
 580 <img alt="../../../docs/user/rst/images/biohazard.png" class="align-right" src="../../../docs/user/rst/images/biohazard.png" />
 581 <p>This paragraph might flow around the image.
 582 The specific behavior depends upon the style sheet and
 583 the browser or rendering software used.</p>
 584 <p>For inline images see <a class="reference internal" href="#substitution-definitions">Substitution Definitions</a>.</p>
 585 <p>Image size:</p>
 586 <p>An image 2 em wide:</p>
 587 <img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" style="width: 2em;" />
 588 <p>An image 2 cm wide and 15 pixel high:</p>
 589 <img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" style="width: 2cm; height: 15px;" />
 590 <p>Relative units allow adaption of the image to the screen or paper size.
 591 An image occupying 50% of the line width:</p>
 592 <img alt="../../../docs/user/rst/images/title.png" src="../../../docs/user/rst/images/title.png" style="width: 50%;" />
 593 <p>A <em>figure</em> is an image with a caption and/or a legend.  With page-based output
 594 media, figures might float to a different position if this helps the page
 595 layout.</p>
 596 <figure class="figclass1 figclass2">
 597 <img alt="reStructuredText, the markup syntax" class="class1 class2" src="../../../docs/user/rst/images/title.png" style="width: 258px;" />
 598 <figcaption>
 599 <p>Plaintext markup syntax and parser system.</p>
 600 <div class="legend">
 601 <table>
 602 <colgroup>
 603 <col style="width: 20%" />
 604 <col style="width: 80%" />
 605 </colgroup>
 606 <tbody>
 607 <tr><td><p>re</p></td>
 608 <td><p>Revised, revisited, based on 're' module.</p></td>
 609 </tr>
 610 <tr><td><p>Structured</p></td>
 611 <td><p>Structure-enhanced text, structuredtext.</p></td>
 612 </tr>
 613 <tr><td><p>Text</p></td>
 614 <td><p>Well it is, isn't it?</p></td>
 615 </tr>
 616 </tbody>
 617 </table>
 618 <p>This paragraph is also part of the legend.</p>
 619 </div>
 620 </figcaption>
 621 </figure>
 622 <p>A left-aligned figure, 70% wide:</p>
 623 <figure class="figclass1 figclass2 align-left" style="width: 70%">
 624 <img alt="reStructuredText, the markup syntax" class="class1 class2" src="../../../docs/user/rst/images/biohazard.png" style="width: 40px;" />
 625 <figcaption>
 626 <p>This is the caption.</p>
 627 <div class="legend">
 628 <p>This is the legend.</p>
 629 <p>The legend may consist of several paragraphs.</p>
 630 </div>
 631 </figcaption>
 632 </figure>
 633 <p>This paragraph might flow around the figure.</p>
 634 <p>The specific behavior depends upon the style sheet and the browser or
 635 rendering software used.</p>
 636 <p>A centered figure:</p>
 637 <figure class="align-center">
 638 <img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" style="width: 40px;" />
 639 <figcaption>
 640 <p>This is the caption.</p>
 641 <div class="legend">
 642 <p>This is the legend.</p>
 643 <p>The legend may consist of several paragraphs.</p>
 644 </div>
 645 </figcaption>
 646 </figure>
 647 <p>This paragraph might flow around the figure.</p>
 648 <p>The specific behavior depends upon the style sheet and the browser or
 649 rendering software used.</p>
 650 <p>A right-aligned figure:</p>
 651 <figure class="align-right">
 652 <img alt="../../../docs/user/rst/images/biohazard.png" src="../../../docs/user/rst/images/biohazard.png" style="width: 40px;" />
 653 <figcaption>
 654 <p>This is the caption.</p>
 655 <div class="legend">
 656 <p>This is the legend.</p>
 657 <p>The legend may consist of several paragraphs.</p>
 658 </div>
 659 </figcaption>
 660 </figure>
 661 <p>This paragraph might flow around the figure. The specific behavior depends
 662 upon the style sheet and the browser or rendering software used.</p>
 663 </section>
 664 <section id="tables">
 665 <h4><a class="toc-backref" href="#toc-entry-55"><span class="sectnum">2.14.3</span> Tables</a></h4>
 666 <p>Tables may be given titles and additional arguments with the <em>table</em>
 667 directive:</p>
 668 <table class="align-left">
 669 <caption>left-aligned table</caption>
 670 <colgroup>
 671 <col style="width: 50%" />
 672 <col style="width: 50%" />
 673 </colgroup>
 674 <thead>
 675 <tr><th class="head"><p>A</p></th>
 676 <th class="head"><p>not A</p></th>
 677 </tr>
 678 </thead>
 679 <tbody>
 680 <tr><td><p>False</p></td>
 681 <td><p>True</p></td>
 682 </tr>
 683 <tr><td><p>True</p></td>
 684 <td><p>False</p></td>
 685 </tr>
 686 </tbody>
 687 </table>
 688 <table class="align-center">
 689 <caption>center-aligned table</caption>
 690 <colgroup>
 691 <col style="width: 50%" />
 692 <col style="width: 50%" />
 693 </colgroup>
 694 <thead>
 695 <tr><th class="head"><p>A</p></th>
 696 <th class="head"><p>not A</p></th>
 697 </tr>
 698 </thead>
 699 <tbody>
 700 <tr><td><p>False</p></td>
 701 <td><p>True</p></td>
 702 </tr>
 703 <tr><td><p>True</p></td>
 704 <td><p>False</p></td>
 705 </tr>
 706 </tbody>
 707 </table>
 708 <table class="align-right">
 709 <caption>right-aligned table</caption>
 710 <colgroup>
 711 <col style="width: 50%" />
 712 <col style="width: 50%" />
 713 </colgroup>
 714 <thead>
 715 <tr><th class="head"><p>A</p></th>
 716 <th class="head"><p>not A</p></th>
 717 </tr>
 718 </thead>
 719 <tbody>
 720 <tr><td><p>False</p></td>
 721 <td><p>True</p></td>
 722 </tr>
 723 <tr><td><p>True</p></td>
 724 <td><p>False</p></td>
 725 </tr>
 726 </tbody>
 727 </table>
 728 <p>With the &quot;widths&quot; argument &quot;auto&quot; (or &quot;class&quot; value &quot;colwidths-auto&quot;),
 729 column widths are determined by the backend (if supported by the
 730 writer/backend).</p>
 731 <span id="target1"></span><table class="colwidths-auto" id="target2">
 732 <thead>
 733 <tr><th class="head"><p>A</p></th>
 734 <th class="head"><p>B</p></th>
 735 <th class="head"><p>A or B</p></th>
 736 </tr>
 737 </thead>
 738 <tbody>
 739 <tr><td><p>False</p></td>
 740 <td><p>False</p></td>
 741 <td><p>False</p></td>
 742 </tr>
 743 <tr><td><p>True</p></td>
 744 <td><p>False</p></td>
 745 <td><p>True</p></td>
 746 </tr>
 747 <tr><td><p>False</p></td>
 748 <td><p>True</p></td>
 749 <td><p>True</p></td>
 750 </tr>
 751 <tr><td><p>True</p></td>
 752 <td><p>True</p></td>
 753 <td><p>True</p></td>
 754 </tr>
 755 </tbody>
 756 </table>
 757 </section>
 758 <section id="admonitions">
 759 <h4><a class="toc-backref" href="#toc-entry-56"><span class="sectnum">2.14.4</span> Admonitions</a></h4>
 760 <div class="admonition attention">
 761 <p class="admonition-title">Attention!</p>
 762 <p>Directives at large.</p>
 763 </div>
 764 <div class="admonition caution">
 765 <p class="admonition-title">Caution!</p>
 766 <p>Don't take any wooden nickels.</p>
 767 </div>
 768 <div class="admonition danger">
 769 <p class="admonition-title">!DANGER!</p>
 770 <p>Mad scientist at work!</p>
 771 </div>
 772 <div class="admonition error">
 773 <p class="admonition-title">Error</p>
 774 <p>Does not compute.</p>
 775 </div>
 776 <div class="admonition hint">
 777 <p class="admonition-title">Hint</p>
 778 <p>It's bigger than a bread box.</p>
 779 </div>
 780 <div class="admonition important">
 781 <p class="admonition-title">Important</p>
 782 <ul class="simple">
 783 <li><p>Wash behind your ears.</p></li>
 784 <li><p>Clean up your room.</p></li>
 785 <li><p>Call your mother.</p></li>
 786 <li><p>Back up your data.</p></li>
 787 </ul>
 788 </div>
 789 <div class="admonition note">
 790 <p class="admonition-title">Note</p>
 791 <p>This is a note.</p>
 792 </div>
 793 <div class="admonition tip">
 794 <p class="admonition-title">Tip</p>
 795 <p>15% if the service is good.</p>
 796 </div>
 797 <div class="admonition warning">
 798 <p class="admonition-title">Warning</p>
 799 <p>Strong prose may provoke extreme mental exertion.
 800 Reader discretion is strongly advised.</p>
 801 </div>
 802 <div class="admonition admonition-and-by-the-way">
 803 <p class="admonition-title">And, by the way...</p>
 804 <p>You can make up your own admonition too.</p>
 805 </div>
 806 </section>
 807 <section id="topics-sidebars-and-rubrics">
 808 <h4><a class="toc-backref" href="#toc-entry-57"><span class="sectnum">2.14.5</span> Topics, Sidebars, and Rubrics</a></h4>
 809 <p><em>Sidebars</em> are like miniature, parallel documents.</p>
 810 <aside class="sidebar">
 811 <p class="sidebar-title">Optional Sidebar Title</p>
 812 <p class="sidebar-subtitle">Optional Subtitle</p>
 813 <p>This is a sidebar.  It is for text outside the flow of the main
 814 text.</p>
 815 <p class="rubric">This is a rubric inside a sidebar</p>
 816 <p>Sidebars often appear beside the main text with a border and a different
 817 background or font color.</p>
 818 </aside>
 819 <p>A <em>topic</em> is like a block quote with a title, or a self-contained section
 820 with no subsections.</p>
 821 <div class="topic">
 822 <p class="topic-title">Topic Title</p>
 823 <p>This is a topic.</p>
 824 </div>
 825 <p>A <em>rubric</em> is like an informal heading that doesn't correspond to the
 826 document's structure. It is typically highlighted in red (hence the name).</p>
 827 <p class="rubric">This is a rubric</p>
 828 <p>Topics and rubrics can be used at places where a <a class="reference internal" href="#section-title">section title</a> is not
 829 allowed (e.g. inside a directive).</p>
 830 </section>
 831 <section id="target-footnotes">
 832 <h4><a class="toc-backref" href="#toc-entry-58"><span class="sectnum">2.14.6</span> Target Footnotes</a></h4>
 833 <dl class="footnote brackets">
 834 <dt class="label" id="footnote-7"><span class="brackets">7</span><span class="fn-backref">(<a href="#footnote-reference-18">1</a>,<a href="#footnote-reference-19">2</a>,<a href="#footnote-reference-20">3</a>,<a href="#footnote-reference-25">4</a>)</span></dt>
 835 <dd><p><a class="reference external" href="http://www.python.org/">http://www.python.org/</a></p>
 836 </dd>
 837 <dt class="label" id="footnote-8"><span class="brackets"><a class="fn-backref" href="#footnote-reference-21">8</a></span></dt>
 838 <dd><p><a class="reference external" href="http://pygments.org/">http://pygments.org/</a></p>
 839 </dd>
 840 <dt class="label" id="footnote-9"><span class="brackets"><a class="fn-backref" href="#footnote-reference-22">9</a></span></dt>
 841 <dd><p><a class="reference external" href="http://docutils.sourceforge.net/docs/user/config.html#table-style">http://docutils.sourceforge.net/docs/user/config.html#table-style</a></p>
 842 </dd>
 843 <dt class="label" id="footnote-10"><span class="brackets"><a class="fn-backref" href="#footnote-reference-23">10</a></span></dt>
 844 <dd><p><a class="reference external" href="http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf">http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf</a></p>
 845 </dd>
 846 <dt class="label" id="footnote-11"><span class="brackets"><a class="fn-backref" href="#footnote-reference-24">11</a></span></dt>
 847 <dd><p><a class="reference external" href="http://docutils.sourceforge.net/docs/dev/todo.html#interpreted-text">http://docutils.sourceforge.net/docs/dev/todo.html#interpreted-text</a></p>
 848 </dd>
 849 <dt class="label" id="footnote-12"><span class="brackets"><a class="fn-backref" href="#footnote-reference-26">12</a></span></dt>
 850 <dd><p><a class="reference external" href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a></p>
 851 </dd>
 852 <dt class="label" id="footnote-13"><span class="brackets"><a class="fn-backref" href="#footnote-reference-27">13</a></span></dt>
 853 <dd><p><a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html">https://docutils.sourceforge.io/docs/ref/rst/directives.html</a></p>
 854 </dd>
 855 <dt class="label" id="footnote-14"><span class="brackets"><a class="fn-backref" href="#footnote-reference-28">14</a></span></dt>
 856 <dd><p><a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata</a></p>
 857 </dd>
 858 <dt class="label" id="footnote-15"><span class="brackets"><a class="fn-backref" href="#footnote-reference-29">15</a></span></dt>
 859 <dd><p><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag">https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag</a></p>
 860 </dd>
 861 <dt class="label" id="footnote-16"><span class="brackets"><a class="fn-backref" href="#footnote-reference-30">16</a></span></dt>
 862 <dd><p><a class="reference external" href="https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article">https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article</a></p>
 863 </dd>
 864 <dt class="label" id="footnote-17"><span class="brackets"><a class="fn-backref" href="#footnote-reference-31">17</a></span></dt>
 865 <dd><p><a class="reference external" href="https://html.spec.whatwg.org/#text-level-semantics">https://html.spec.whatwg.org/#text-level-semantics</a></p>
 866 </dd>
 867 <dt class="label" id="footnote-18"><span class="brackets"><a class="fn-backref" href="#footnote-reference-32">18</a></span></dt>
 868 <dd><p><a class="reference external" href="https://html.spec.whatwg.org/multipage/edits.html">https://html.spec.whatwg.org/multipage/edits.html</a></p>
 869 </dd>
 870 </dl>
 871 </section>
 872 <section id="replacement-text">
 873 <h4><a class="toc-backref" href="#toc-entry-59"><span class="sectnum">2.14.7</span> Replacement Text</a></h4>
 874 <p>I recommend you try <a class="reference external" href="http://www.python.org/">Python, <em>the</em> best language around</a> <a class="footnote-reference brackets" href="#footnote-7" id="footnote-reference-20">7</a>.</p>
 875 </section>
 876 <section id="compound-paragraph">
 877 <h4><a class="toc-backref" href="#toc-entry-60"><span class="sectnum">2.14.8</span> Compound Paragraph</a></h4>
 878 <p>The <em>compound</em> directive is used to create a &quot;compound paragraph&quot;, which
 879 is a single logical paragraph containing multiple physical body
 880 elements. For example:</p>
 881 <div class="compound">
 882 <p class="compound-first">The 'rm' command is very dangerous.  If you are logged
 883 in as root and enter</p>
 884 <pre class="compound-middle literal-block">cd /
 885 rm -rf *</pre>
 886 <p class="compound-last">you will erase the entire contents of your file system.</p>
 887 </div>
 888 <p>Test the handling and display of compound paragraphs:</p>
 889 <div class="some-class compound">
 890 <p class="compound-first">Compound 2, paragraph 1,</p>
 891 <p class="compound-middle">compound 2, paragraph 2,</p>
 892 <ul class="compound-middle simple">
 893 <li><p>list item 1,</p></li>
 894 <li><p>list item 2,</p></li>
 895 </ul>
 896 <p class="compound-last">compound 2, paragraph 3.</p>
 897 </div>
 898 <div class="compound">
 899 <p>Compound 3, only consisting of one paragraph.</p>
 900 </div>
 901 <div class="compound">
 902 <pre class="compound-first literal-block">Compound 4.
 903 This one starts with a literal block.</pre>
 904 <p class="compound-last">Compound 4, paragraph following the literal block.</p>
 905 </div>
 906 <p>Now something <em>really</em> perverted -- a nested compound block.  This is
 907 just to test that it works at all; the results don't have to be
 908 meaningful.</p>
 909 <div class="compound">
 910 <p class="compound-first">Compound 5, block 1 (a paragraph).</p>
 911 <div class="compound-middle compound">
 912 <p class="compound-first">Compound 6 is block 2 in compound 5.</p>
 913 <p class="compound-last">Compound 6, another paragraph.</p>
 914 </div>
 915 <p class="compound-last">Compound 5, block 3 (a paragraph).</p>
 916 </div>
 917 <div class="compound">
 918 <p class="compound-first">Compound 7, tests the inclusion of various block-level
 919 elements in one logical paragraph. First a table,</p>
 920 <table class="compound-middle">
 921 <colgroup>
 922 <col style="width: 33%" />
 923 <col style="width: 33%" />
 924 <col style="width: 33%" />
 925 </colgroup>
 926 <tbody>
 927 <tr><td><p>Left cell, first
 928 paragraph.</p>
 929 <p>Left cell, second
 930 paragraph.</p>
 931 </td>
 932 <td><p>Middle cell,
 933 consisting of
 934 exactly one
 935 paragraph.</p></td>
 936 <td><p>Right cell.</p>
 937 <p>Paragraph 2.</p>
 938 <p>Paragraph 3.</p>
 939 </td>
 940 </tr>
 941 </tbody>
 942 </table>
 943 <p class="compound-middle">followed by a paragraph. This physical paragraph is
 944 actually a continuation of the paragraph before the table. It is followed
 945 by</p>
 946 <blockquote class="compound-middle">
 947 <p>a quote and</p>
 948 </blockquote>
 949 <ol class="compound-middle arabic simple">
 950 <li><p>an enumerated list,</p></li>
 951 </ol>
 952 <p class="compound-middle">a paragraph,</p>
 953 <dl class="compound-middle option-list">
 954 <dt><kbd><span class="option">--an</span></kbd></dt>
 955 <dd><p>option list,</p>
 956 </dd>
 957 </dl>
 958 <p class="compound-middle">a paragraph,</p>
 959 <dl class="compound-middle field-list simple">
 960 <dt>a field</dt>
 961 <dd><p>list,</p>
 962 </dd>
 963 </dl>
 964 <p class="compound-middle">a paragraph,</p>
 965 <dl class="compound-middle simple">
 966 <dt>a definition</dt>
 967 <dd><p>list,</p>
 968 </dd>
 969 </dl>
 970 <p class="compound-middle">a paragraph, an image:</p>
 971 <img alt="../../../docs/user/rst/images/biohazard.png" class="compound-middle" src="../../../docs/user/rst/images/biohazard.png" />
 972 <p class="compound-middle">a paragraph,</p>
 973 <div class="compound-middle line-block">
 974 <div class="line">a line</div>
 975 <div class="line">block,</div>
 976 </div>
 977 <p class="compound-middle">a paragraph followed by a comment,</p>
 978 <!-- this is a comment -->
 979 <p class="compound-middle">a paragraph, a</p>
 980 <div class="admonition note compound-middle">
 981 <p class="admonition-title">Note</p>
 982 <p>with content</p>
 983 </div>
 984 <p class="compound-last">and the final paragraph of the compound 7.</p>
 985 </div>
 986 </section>
 987 <section id="parsed-literal-blocks">
 988 <h4><a class="toc-backref" href="#toc-entry-61"><span class="sectnum">2.14.9</span> Parsed Literal Blocks</a></h4>
 989 <pre class="literal-block">This is a parsed literal block.
 990     This line is indented.  The next line is blank.
 991
 992 Inline markup is supported, e.g. <em>emphasis</em>, <strong>strong</strong>, <span class="docutils literal">literal
 993 text</span>, <sub>sub-</sub> and <sup>super</sup>scripts,
 994 inline formulas: <span class="formula"><i>A</i> = 2<i>π</i><i>r</i><sup>2</sup></span>,
 995 footnotes <a class="footnote-reference brackets" href="#footnote-1" id="footnote-reference-9">1</a>, <span class="target" id="hyperlink-targets">hyperlink targets</span>, and <a class="reference external" href="http://www.python.org/">references</a>.</pre>
 996 </section>
 997 <section id="code">
 998 <h4><a class="toc-backref" href="#toc-entry-62"><span class="sectnum">2.14.10</span> Code</a></h4>
 999 <p>Blocks of source code can be set with the <cite>code</cite> directive. If the code
1000 language is specified, the content is parsed and tagged by the <a class="reference external" href="http://pygments.org/">Pygments</a> <a class="footnote-reference brackets" href="#footnote-8" id="footnote-reference-21">8</a>
1001 syntax highlighter and can be formatted with a style sheet. (Code parsing
1002 is turned off using the <span class="docutils literal"><span class="pre">syntax-highlight</span></span> config setting in the test
1003 conversions in order to get identical results with/without installed
1004 Pygments highlighter.)</p>
1005 <pre class="code python literal-block"><code>print 'This is Python code.'</code></pre>
1006 <p>The <span class="docutils literal"><span class="pre">:number-lines:</span></span> option (with optional start value) generates line
1007 numbers:</p>
1008 <pre class="code python literal-block"><code data-lineno=" 8 "><span class="ln"> 8 </span># print integers from 0 to 9:
1009 </code><code data-lineno=" 9 "><span class="ln"> 9 </span>for i in range(10):
1010 </code><code data-lineno="10 "><span class="ln">10 </span>    print i</code></pre>
1011 <p>For inline code snippets, there is the <cite>code</cite> role, which can be used
1012 directly (the code will not be parsed/tagged, as the language is not known)
1013 or as base for special code roles, e.g. the LaTeX code in the next
1014 paragraph.</p>
1015 <p>Docutils uses LaTeX syntax for math directives and roles:
1016 <code class="tex">\alpha = f(x)</code> prints <span class="formula"><i>α</i> = <i>f</i>(<i>x</i>)</span>.</p>
1017 <p>The <span class="docutils literal">:code:</span> option of the <cite>include</cite> directive sets the included content
1018 as a code block, here the rst file <span class="docutils literal">header_footer.txt</span> with line numbers:</p>
1019 <pre class="code rst literal-block"><code data-lineno="1 "><span class="ln">1 </span>.. header:: Document header
1020 </code><code data-lineno="2 "><span class="ln">2 </span>.. footer:: Document footer</code></pre>
1021 </section>
1022 <section id="meta">
1023 <h4><a class="toc-backref" href="#toc-entry-63"><span class="sectnum">2.14.11</span> Meta</a></h4>
1024 <p>The <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">“meta” directive</a> <a class="footnote-reference brackets" href="#footnote-14" id="footnote-reference-28">14</a> is used to specify metadata to be stored in,
1025 e.g., HTML META tags or ODT file properties.</p>
1026 </section>
1027 </section>
1028 <section id="substitution-definitions">
1029 <h3><a class="toc-backref" href="#toc-entry-34"><span class="sectnum">2.15</span> Substitution Definitions</a></h3>
1030 <p>An inline image (<img alt="EXAMPLE" src="../../../docs/user/rst/images/biohazard.png" />) example:</p>
1031 <p>A Unicode example:</p>
1032 <p>(Substitution definitions are not visible in the HTML source.)</p>
1033 </section>
1034 <section id="comments">
1035 <h3><a class="toc-backref" href="#toc-entry-35"><span class="sectnum">2.16</span> Comments</a></h3>
1036 <p>Here's one:</p>
1037 <!-- Comments begin with two dots and a space. Anything may
1038 follow, except for the syntax of footnotes, hyperlink
1039 targets, directives, or substitution definitions.
1040
1041 Double-dashes - - "- -" - - must be escaped somehow in HTML output.
1042
1043 Comments may contain non-ASCII characters: ä ö ü æ ø å -->
1044 <p>(View the HTML source to see the comment.)</p>
1045 </section>
1046 <section id="raw-text">
1047 <h3><a class="toc-backref" href="#toc-entry-36"><span class="sectnum">2.17</span> Raw text</a></h3>
1048 <p>This does not necessarily look nice, because there may be missing white space.</p>
1049 <p>It's just there to freeze the behavior.</p>
1050 A test.Second test.<div class="myclass">Another test with myclass set.</div><p>This is the <span class="myrawroleclass">fourth test</span> with myrawroleclass set.</p>
1051 Fifth test in HTML.<br />Line two.</section>
1052 <section id="container">
1053 <h3><a class="toc-backref" href="#toc-entry-37"><span class="sectnum">2.18</span> Container</a></h3>
1054 <div class="custom docutils container">
1055 <p>paragraph 1</p>
1056 <p>paragraph 2</p>
1057 </div>
1058 </section>
1059 <section id="colspanning-tables">
1060 <h3><a class="toc-backref" href="#toc-entry-38"><span class="sectnum">2.19</span> Colspanning tables</a></h3>
1061 <p>This table has a cell spanning two columns:</p>
1062 <table>
1063 <colgroup>
1064 <col style="width: 31%" />
1065 <col style="width: 31%" />
1066 <col style="width: 38%" />
1067 </colgroup>
1068 <thead>
1069 <tr><th class="head" colspan="2"><p>Inputs</p></th>
1070 <th class="head"><p>Output</p></th>
1071 </tr>
1072 <tr><th class="head"><p>A</p></th>
1073 <th class="head"><p>B</p></th>
1074 <th class="head"><p>A or B</p></th>
1075 </tr>
1076 </thead>
1077 <tbody>
1078 <tr><td><p>False</p></td>
1079 <td><p>False</p></td>
1080 <td><p>False</p></td>
1081 </tr>
1082 <tr><td><p>True</p></td>
1083 <td><p>False</p></td>
1084 <td><p>True</p></td>
1085 </tr>
1086 <tr><td><p>False</p></td>
1087 <td><p>True</p></td>
1088 <td><p>True</p></td>
1089 </tr>
1090 <tr><td><p>True</p></td>
1091 <td><p>True</p></td>
1092 <td><p>True</p></td>
1093 </tr>
1094 </tbody>
1095 </table>
1096 </section>
1097 <section id="rowspanning-tables">
1098 <h3><a class="toc-backref" href="#toc-entry-39"><span class="sectnum">2.20</span> Rowspanning tables</a></h3>
1099 <p>Here's a table with cells spanning several rows:</p>
1100 <table>
1101 <colgroup>
1102 <col style="width: 44%" />
1103 <col style="width: 22%" />
1104 <col style="width: 33%" />
1105 </colgroup>
1106 <thead>
1107 <tr><th class="head"><p>Header row, column 1
1108 (header rows optional)</p></th>
1109 <th class="head"><p>Header 2</p></th>
1110 <th class="head"><p>Header 3</p></th>
1111 </tr>
1112 </thead>
1113 <tbody>
1114 <tr><td><p>body row 1, column 1</p></td>
1115 <td><p>column 2</p></td>
1116 <td><p>column 3</p></td>
1117 </tr>
1118 <tr><td><p>body row 2</p></td>
1119 <td rowspan="2"><p>Cells may
1120 span rows.</p></td>
1121 <td rowspan="2"><p>Another
1122 rowspanning
1123 cell.</p></td>
1124 </tr>
1125 <tr><td><p>body row 3</p></td>
1126 </tr>
1127 </tbody>
1128 </table>
1129 </section>
1130 <section id="complex-tables">
1131 <h3><a class="toc-backref" href="#toc-entry-40"><span class="sectnum">2.21</span> Complex tables</a></h3>
1132 <p>Here's a complex table, which should test all features.</p>
1133 <table>
1134 <colgroup>
1135 <col style="width: 43%" />
1136 <col style="width: 21%" />
1137 <col style="width: 18%" />
1138 <col style="width: 18%" />
1139 </colgroup>
1140 <thead>
1141 <tr><th class="head"><p>Header row, column 1
1142 (header rows optional)</p></th>
1143 <th class="head"><p>Header 2</p></th>
1144 <th class="head"><p>Header 3</p></th>
1145 <th class="head"><p>Header 4</p></th>
1146 </tr>
1147 </thead>
1148 <tbody>
1149 <tr><td><p>body row 1, column 1</p></td>
1150 <td><p>column 2</p></td>
1151 <td><p>column 3</p></td>
1152 <td><p>column 4</p></td>
1153 </tr>
1154 <tr><td><p>body row 2</p></td>
1155 <td colspan="3"><p>Cells may span columns.</p></td>
1156 </tr>
1157 <tr><td><p>body row 3</p></td>
1158 <td rowspan="2"><p>Cells may
1159 span rows.</p>
1160 <p>Paragraph.</p>
1161 </td>
1162 <td colspan="2" rowspan="2"><ul class="simple">
1163 <li><p>Table cells</p></li>
1164 <li><p>contain</p></li>
1165 <li><p>body elements.</p></li>
1166 </ul>
1167 </td>
1168 </tr>
1169 <tr><td><p>body row 4</p></td>
1170 </tr>
1171 <tr><td><p>body row 5</p></td>
1172 <td colspan="2"><p>Cells may also be
1173 empty: <span class="docutils literal"><span class="pre">--&gt;</span></span></p></td>
1174 <td></td>
1175 </tr>
1176 </tbody>
1177 </table>
1178 </section>
1179 <section id="list-tables">
1180 <h3><a class="toc-backref" href="#toc-entry-41"><span class="sectnum">2.22</span> List Tables</a></h3>
1181 <p>Here's a list table exercising all features:</p>
1182 <table class="colwidths-given test" style="width: 95%">
1183 <caption>list table with integral header</caption>
1184 <colgroup>
1185 <col style="width: 26%" />
1186 <col style="width: 21%" />
1187 <col style="width: 53%" />
1188 </colgroup>
1189 <thead>
1190 <tr><th class="head stub"><p>Treat</p></th>
1191 <th class="head"><p>Quantity</p></th>
1192 <th class="head"><p>Description</p></th>
1193 </tr>
1194 </thead>
1195 <tbody>
1196 <tr><th class="stub"><p>Albatross</p></th>
1197 <td><p>2.99</p></td>
1198 <td><p>On a stick!</p></td>
1199 </tr>
1200 <tr><th class="stub"><p>Crunchy Frog</p></th>
1201 <td><p>1.49</p></td>
1202 <td><p>If we took the bones out, it wouldn't be
1203 crunchy, now would it?</p></td>
1204 </tr>
1205 <tr><th class="stub"><p>Gannet Ripple</p></th>
1206 <td><p>1.99</p></td>
1207 <td><p>On a stick!</p></td>
1208 </tr>
1209 </tbody>
1210 </table>
1211 <table class="colwidths-auto align-center">
1212 <caption>center aligned list table</caption>
1213 <tbody>
1214 <tr><td><p>Albatross</p></td>
1215 <td><p>2.99</p></td>
1216 </tr>
1217 <tr><td><p>Crunchy Frog</p></td>
1218 <td><p>1.49</p></td>
1219 </tr>
1220 <tr><td><p>Gannet Ripple</p></td>
1221 <td><p>1.99</p></td>
1222 </tr>
1223 </tbody>
1224 </table>
1225 </section>
1226 <section id="custom-roles">
1227 <h3><a class="toc-backref" href="#toc-entry-42"><span class="sectnum">2.23</span> Custom Roles</a></h3>
1228 <ul>
1229 <li><p>A role based on an existing role.</p>
1230 <p><span class="custom docutils literal">one</span> <span class="custom docutils literal">two</span> <span class="custom docutils literal">three</span></p>
1231 </li>
1232 <li><p>A new role.</p>
1233 <p><span class="customnew">one two three</span></p>
1234 </li>
1235 <li><p>A role with class attribute.</p>
1236 <p><span class="special">interpreted text</span></p>
1237 </li>
1238 <li><p>A language-switching role:</p>
1239 <p>Let's count in German <span lang="de">eins zwei drei</span>.</p>
1240 </li>
1241 <li><p>A role with multiple class attributes, styled with raw directives:</p>
1242 <p>The following works in most browsers but does not validate
1243 (<span class="docutils literal">&lt;style&gt;</span> is only allowed in the document head):</p>
1244 <pre class="literal-block">.. raw:: html
1245
1246   &lt;style type=&quot;text/css&quot;&gt;&lt;!--
1247    .green {color: green;}
1248    .sc {font-variant: small-caps;}
1249    --&gt;&lt;/style&gt;</pre>
1250 <p><span class="green sc" lang="en-gb">British colourful text in small-caps</span>.</p>
1251 </li>
1252 </ul>
1253 <!-- HTML Specific -->
1254 </section>
1255 </section>
1256 <section id="changes-to-the-html4css1-writer">
1257 <h2><a class="toc-backref" href="#toc-entry-43"><span class="sectnum">3</span> Changes to the <cite>html4css1</cite> Writer</a></h2>
1258 <ul>
1259 <li><p>Use only <a class="reference internal" href="#meta">meta</a> keywords recognized by HTML 5.
1260 Add HTML5-compatible meta tags for docinfo items
1261 &quot;authors&quot;, &quot;date&quot;, and &quot;copyright&quot;.</p>
1262 <p>Add a <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag">viewport meta tag</a> <a class="footnote-reference brackets" href="#footnote-15" id="footnote-reference-29">15</a> to tell mobile browsers
1263 to use the device-width as viewport.</p>
1264 </li>
1265 <li><p>Set table column widths with &lt;style=&quot;width: ...&quot;&gt;, not &quot;width&quot; argument.</p></li>
1266 <li><p>Horizontal alignment of table heads with CSS.</p></li>
1267 <li><p>Do not drop paragraph objects, use CSS rules to prevent unwanted vertical
1268 space.</p></li>
1269 <li><p>Put subtitles in &lt;p&gt; elements.</p></li>
1270 <li><p>Use the new semantic tags &lt;main&gt;, &lt;section&gt;, &lt;header&gt;,
1271 &lt;footer&gt;, &lt;aside&gt;, &lt;figure&gt;, and &lt;figcaption&gt;.
1272 See <span class="docutils literal">minimal.css</span> and <span class="docutils literal">responsive.css</span> for styling rule examples.</p>
1273 <p>Change the <cite>initial_header_level</cite> setting default to &quot;2&quot;, as browsers
1274 use the <a class="reference external" href="https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article">same style for &lt;h1&gt; and &lt;h2&gt; when nested in a &lt;section&gt;</a> <a class="footnote-reference brackets" href="#footnote-16" id="footnote-reference-30">16</a>.</p>
1275 </li>
1276 <li><p>Use HTML5 tags &lt;small&gt;, &lt;s&gt;, &lt;q&gt;, &lt;dfn&gt;, &lt;var&gt;, &lt;samp&gt;, &lt;kbd&gt;,
1277 &lt;i&gt;, &lt;b&gt;, &lt;u&gt;, &lt;mark&gt;, and &lt;bdi&gt; if a matching class value
1278 is found in <cite>inline</cite> and <cite>literal</cite> elements.
1279 Use &lt;ins&gt; and &lt;del&gt; if a matching class value
1280 is found in <cite>inline</cite>, <cite>literal</cite>, or <cite>container</cite> elements.
1281 (See <a class="reference internal" href="#text-level-semantics">text-level semantics</a> and <a class="reference internal" href="#indicating-edits">indicating edits</a>.)</p></li>
1282 </ul>
1283 <section id="field-list-rendering">
1284 <h3><a class="toc-backref" href="#toc-entry-44"><span class="sectnum">3.1</span> Field List Rendering</a></h3>
1285 <p>A <cite>field list</cite> is converted to a HTML <cite>definition list</cite> and given the
1286 <span class="docutils literal"><span class="pre">field-list</span></span> class argument value to allow CSS styling.
1287 With <span class="docutils literal">html_plain.css</span>, the layout is similar to <cite>html4css1</cite>:</p>
1288 <dl class="open field-list">
1289 <dt>A long field name</dt>
1290 <dd><p>sticks into the field body.</p>
1291 <p>The field body is pushed to the next line (you can suppress this
1292 behaviour with the <a class="reference internal" href="#run-in">run-in</a> class argument).</p>
1293 </dd>
1294 <dt>Customization</dt>
1295 <dd><p>of the field name width is possible with CSS instead
1296 of the <cite>field-name-limit</cite> configuration setting, for
1297 example:</p>
1298 <pre class="literal-block">dl.field-list &gt; dd { margin-left: 6em; }</pre>
1299 </dd>
1300 <dt>Empty</dt>
1301 <dd><p></p></dd>
1302 <dt>fields</dt>
1303 <dd><p>must not lead to misalignment of the following content.</p>
1304 </dd>
1305 </dl>
1306 </section>
1307 <section id="styling-with-class-arguments">
1308 <h3><a class="toc-backref" href="#toc-entry-45"><span class="sectnum">3.2</span> Styling with Class Arguments</a></h3>
1309 <p>The <span class="docutils literal">plain.css</span> style sheet comes with some pre-defined style variants
1310 that can be choosen via a class argument.</p>
1311 <section id="description-lists">
1312 <h4><a class="toc-backref" href="#toc-entry-46"><span class="sectnum">3.2.1</span> Description Lists</a></h4>
1313 <p>Definition lists with the &quot;description&quot; class argument:</p>
1314 <dl class="description">
1315 <dt>description lists</dt>
1316 <dd><p>Definition lists that are styled like in most dictionaries,
1317 encyclopedias etc. (as well as the LaTeX <cite>description</cite> environment).</p>
1318 </dd>
1319 <dt>label</dt>
1320 <dd><p>The term to be described. Put in boldface or italic.</p>
1321 </dd>
1322 <dt>Content</dt>
1323 <dd><p>starts on the same line and has a hanging indent.</p>
1324 </dd>
1325 <dt>A label without content</dt>
1326 <dd><!--  -->
1327 </dd>
1328 <dt>and the next label</dt>
1329 <dd><p>must align.</p>
1330 </dd>
1331 <dt>as well</dt>
1332 <dd><p>as content containing more than one</p>
1333 <p>paragraph</p>
1334 </dd>
1335 <dt>or</dt>
1336 <dd><ul class="simple">
1337 <li><p>nested lists</p></li>
1338 <li><p>item 2</p></li>
1339 </ul>
1340 </dd>
1341 <dt>or</dt>
1342 <dd><dl class="simple">
1343 <dt>nested</dt>
1344 <dd><p>definition lists</p>
1345 </dd>
1346 </dl>
1347 </dd>
1348 </dl>
1349 </section>
1350 <section id="field-list-variants">
1351 <h4><a class="toc-backref" href="#toc-entry-47"><span class="sectnum">3.2.2</span> Field List Variants</a></h4>
1352 <p>For field lists, the &quot;compact/open&quot;, &quot;narrow&quot; and &quot;run-in&quot; styles are defined
1353 in the style sheet <span class="docutils literal">plain.css</span>.</p>
1354 <dl class="simple">
1355 <dt><em>compact</em></dt>
1356 <dd><dl class="compact field-list simple">
1357 <dt>Feature</dt>
1358 <dd><p>No additional space between list items.</p>
1359 </dd>
1360 <dt>Option</dt>
1361 <dd><p>The <span class="docutils literal"><span class="pre">--compact-field-lists</span></span> command line option (and the
1362 corresponding configuration setting) set the <cite>compact</cite>
1363 class argument on all &quot;simple&quot; field lists, if not
1364 overridden with <cite>open</cite>.</p>
1365 </dd>
1366 <dt>Use</dt>
1367 <dd><p>For lists with short field body.</p>
1368 </dd>
1369 </dl>
1370 </dd>
1371 <dt><em>open</em></dt>
1372 <dd><dl class="open field-list">
1373 <dt>Feature</dt>
1374 <dd><p>Additional space between list items also in &quot;simple&quot; lists.
1375 (Overrides the <span class="docutils literal"><span class="pre">--compact-field-lists</span></span> command line
1376 option and the corresponding configuration setting)</p>
1377 </dd>
1378 <dt>Use</dt>
1379 <dd><p>For &quot;simple&quot; lists that should keep the space between list items.</p>
1380 </dd>
1381 </dl>
1382 </dd>
1383 <dt><em>narrow</em></dt>
1384 <dd><dl class="narrow field-list simple">
1385 <dt>Feature</dt>
1386 <dd><p>Less indented field body.</p>
1387 </dd>
1388 <dt>Use</dt>
1389 <dd><p>For lists with short field names.</p>
1390 </dd>
1391 <dt>A long field name</dt>
1392 <dd><p>sticks into the field body and the field body starts on a
1393 new line (if not combined with <a class="reference internal" href="#run-in">run-in</a>).</p>
1394 </dd>
1395 </dl>
1396 </dd>
1397 </dl>
1398 <dl class="simple" id="run-in">
1399 <dt><em>run-in</em></dt>
1400 <dd><dl class="run-in field-list simple">
1401 <dt>Feature</dt>
1402 <dd><p>Field body starts on the same line also after long field
1403 names.</p>
1404 </dd>
1405 <dt>A long field name</dt>
1406 <dd><p>sticks into the field body which continues on
1407 the same line.</p>
1408 </dd>
1409 <dt>The next field name</dt>
1410 <dd><p>and field body should align. Long text in the field
1411 body is wrapped and aligns with other fields.</p>
1412 </dd>
1413 </dl>
1414 </dd>
1415 </dl>
1416 </section>
1417 <section id="table-variants">
1418 <h4><a class="toc-backref" href="#toc-entry-48"><span class="sectnum">3.2.3</span> Table Variants</a></h4>
1419 <p>The following styles can be applied to individual tables via a class
1420 argument or as document wide setting with the <a class="reference external" href="http://docutils.sourceforge.net/docs/user/config.html#table-style">table-style</a> <a class="footnote-reference brackets" href="#footnote-9" id="footnote-reference-22">9</a> configuration
1421 setting (or command line argument).</p>
1422 <ul>
1423 <li><p>Numbered tables can be achieved with the &quot;numbered&quot; class option:</p>
1424 <table class="numbered">
1425 <caption>truth values</caption>
1426 <colgroup>
1427 <col style="width: 29%" />
1428 <col style="width: 29%" />
1429 <col style="width: 42%" />
1430 </colgroup>
1431 <thead>
1432 <tr><th class="head"><p>A</p></th>
1433 <th class="head"><p>B</p></th>
1434 <th class="head"><p>A or B</p></th>
1435 </tr>
1436 </thead>
1437 <tbody>
1438 <tr><td><p>False</p></td>
1439 <td><p>False</p></td>
1440 <td><p>False</p></td>
1441 </tr>
1442 <tr><td><p>True</p></td>
1443 <td><p>False</p></td>
1444 <td><p>True</p></td>
1445 </tr>
1446 <tr><td><p>False</p></td>
1447 <td><p>True</p></td>
1448 <td><p>True</p></td>
1449 </tr>
1450 <tr><td><p>True</p></td>
1451 <td><p>True</p></td>
1452 <td><p>True</p></td>
1453 </tr>
1454 </tbody>
1455 </table>
1456 <p>Currently, referencing to the table by number is not supported. This is a
1457 common request and already on the <cite>TODO list</cite>.</p>
1458 </li>
1459 <li><p>A table with &quot;booktabs&quot; class value, is rendered similar to the style
1460 from the <a class="reference external" href="http://tug.ctan.org/tex-archive/macros/latex/contrib/booktabs/booktabs.pdf">booktabs</a> <a class="footnote-reference brackets" href="#footnote-10" id="footnote-reference-23">10</a> LaTeX package.</p>
1461 </li>
1462 </ul>
1463 <p>&quot;Booktabs&quot; style table, numbered, centre-aligned, with auto-sized columns:</p>
1464 <blockquote>
1465 <table class="booktabs numbered colwidths-auto align-center">
1466 <caption>I/O values</caption>
1467 <thead>
1468 <tr><th class="head" colspan="2"><p>Input</p></th>
1469 <th class="head"><p>Output</p></th>
1470 </tr>
1471 <tr><th class="head"><p>A</p></th>
1472 <th class="head"><p>B</p></th>
1473 <th class="head"><p>A or B</p></th>
1474 </tr>
1475 </thead>
1476 <tbody>
1477 <tr><td><p>False</p></td>
1478 <td><p>False</p></td>
1479 <td><p>False</p></td>
1480 </tr>
1481 <tr><td><p>True</p></td>
1482 <td><p>False</p></td>
1483 <td><p>True</p></td>
1484 </tr>
1485 <tr><td><p>False</p></td>
1486 <td><p>True</p></td>
1487 <td><p>True</p></td>
1488 </tr>
1489 <tr><td><p>True</p></td>
1490 <td><p>True</p></td>
1491 <td><p>True</p></td>
1492 </tr>
1493 </tbody>
1494 </table>
1495 </blockquote>
1496 </section>
1497 <section id="numbered-figures">
1498 <h4><a class="toc-backref" href="#toc-entry-49"><span class="sectnum">3.2.4</span> Numbered Figures</a></h4>
1499 <p>Numbered figures can be achieved with the &quot;numbered&quot; <span class="docutils literal">:figclass:</span> option:</p>
1500 <figure class="numbered">
1501 <img alt="reStructuredText, the markup syntax" src="../../../docs/user/rst/images/title.svg" style="width: 100%;" />
1502 <figcaption>
1503 <p>SVG image in a numbered figure.</p>
1504 </figcaption>
1505 </figure>
1506 </section>
1507 </section>
1508 <section id="text-level-semantics">
1509 <h3><a class="toc-backref" href="#toc-entry-50"><span class="sectnum">3.3</span> Text-Level Semantics</a></h3>
1510 <p>This section describes the <a class="reference external" href="https://html.spec.whatwg.org/#text-level-semantics">HTML 5 tags for representation of text-level
1511 semantics</a> <a class="footnote-reference brackets" href="#footnote-17" id="footnote-reference-31">17</a> and their reStructuredText equivalents.</p>
1512 <dl class="description">
1513 <dt>a</dt>
1514 <dd><p>Hyperlinks</p>
1515 <blockquote>
1516 <p>Visit my <a class="reference external" href="example.org:drinks.html">drinks</a> page.</p>
1517 </blockquote>
1518 </dd>
1519 <dt>em</dt>
1520 <dd><p>Stress emphasis</p>
1521 <blockquote>
1522 <p>I must say I <em>adore</em> lemonade. I's <em>sooo</em> sweet.</p>
1523 </blockquote>
1524 </dd>
1525 <dt>strong</dt>
1526 <dd><p>Importance</p>
1527 <blockquote>
1528 <p><strong>Warning</strong>: This tea is <strong>very hot</strong>.</p>
1529 </blockquote>
1530 </dd>
1531 <dt>small</dt>
1532 <dd><p>Side comments</p>
1533 <blockquote>
1534 <p>These grapes are made into wine.
1535 <small>Alcohol is addictive.</small></p>
1536 </blockquote>
1537 </dd>
1538 <dt>s</dt>
1539 <dd><p>Inaccurate text</p>
1540 <blockquote>
1541 <p>Price: <s>£4.50</s> £2.00!</p>
1542 </blockquote>
1543 </dd>
1544 <dt>cite</dt>
1545 <dd><p>Titles of works</p>
1546 <blockquote>
1547 <p>The case <cite>Hugo v. Danielle</cite> is relevant here.
1548 I recommend reading <cite>Harry Potter</cite>.</p>
1549 </blockquote>
1550 </dd>
1551 <dt>q</dt>
1552 <dd><p>Quotations</p>
1553 <blockquote>
1554 <p>The judge said <q>You can drink water from the fish tank</q>
1555 but advised against it.</p>
1556 </blockquote>
1557 </dd>
1558 <dt>dfn</dt>
1559 <dd><p>Defining instance</p>
1560 <blockquote>
1561 <p>The term <dfn>organic food</dfn> refers to food produced without synthetic
1562 chemicals.</p>
1563 </blockquote>
1564 </dd>
1565 <dt>abbr</dt>
1566 <dd><p>Abbreviations <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-10">5</a></p>
1567 <blockquote>
1568 <p>Organic food in Ireland is certified by the <abbr>IOFGA</abbr> <a class="footnote-reference brackets" href="#footnote-6" id="footnote-reference-11">‡</a></p>
1569 </blockquote>
1570 <p>In rST there are separate roles for <cite>abbreviations</cite> <abbr>rsp.</abbr>
1571 <cite>acronymes</cite>. In HTML, the &lt;acronym&gt; tag is obsolete and authors are
1572 advised to use &lt;abbr&gt; instead. The HTML5 writer uses &lt;abbr&gt; for Docutil's
1573 &lt;abbreviation&gt; element.</p>
1574 <dl class="footnote brackets">
1575 <dt class="label" id="footnote-6"><span class="brackets"><a class="fn-backref" href="#footnote-reference-11">‡</a></span></dt>
1576 <dd><p>Irish Organic Farmers and Growers Association</p>
1577 </dd>
1578 </dl>
1579 </dd>
1580 <dt>ruby, rt, rp</dt>
1581 <dd><p>Ruby annotations</p>
1582 <p>Require inline nesting, currently not supported in rST.</p>
1583 <!-- <ruby> OJ <rp>(</rp><rt>Orange Juice</rt><rp>)</rp></ruby> -->
1584 </dd>
1585 <dt>data</dt>
1586 <dd><p>Machine-readable equivalent <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-12">6</a></p>
1587 <!-- Available starting today! <data value="UPC:022014640201">North Coast
1588 Organic Apple Cider</data> -->
1589 </dd>
1590 <dt>time</dt>
1591 <dd><p>Machine-readable equivalent of date- or time-related data <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-13">6</a></p>
1592 <!-- Available starting on <time datetime="2011-11-18">November 18th</time>! -->
1593 </dd>
1594 <dt>code</dt>
1595 <dd><p>Computer code</p>
1596 <blockquote>
1597 <p>The <code>fruitdb</code> program can be used for tracking fruit production.</p>
1598 </blockquote>
1599 </dd>
1600 <dt>var</dt>
1601 <dd><p>Variables</p>
1602 <blockquote>
1603 <p>If there are <var>n</var> fruit in the bowl, at least <var>n</var>÷2 will be
1604 ripe.</p>
1605 </blockquote>
1606 </dd>
1607 <dt>samp</dt>
1608 <dd><p>Computer output</p>
1609 <blockquote>
1610 <p>The computer said <samp class="docutils literal">Unknown error <span class="pre">-3</span></samp>.</p>
1611 </blockquote>
1612 </dd>
1613 <dt>kbd</dt>
1614 <dd><p>User input</p>
1615 <blockquote>
1616 <p>Hit <kbd>F1</kbd> to continue.</p>
1617 </blockquote>
1618 </dd>
1619 <dt>sub</dt>
1620 <dd><p>Subscripts</p>
1621 <blockquote>
1622 <p>Water is H<sub>2</sub>O.</p>
1623 </blockquote>
1624 </dd>
1625 <dt>sup</dt>
1626 <dd><p>Superscripts</p>
1627 <blockquote>
1628 <p>The Hydrogen in heavy water is usually <sup>2</sup>H.</p>
1629 </blockquote>
1630 </dd>
1631 <dt>i</dt>
1632 <dd><p>Alternative voice</p>
1633 <blockquote>
1634 <p>Lemonade consists primarily of <i lang="la">Citrus limon</i>.</p>
1635 </blockquote>
1636 </dd>
1637 <dt>b</dt>
1638 <dd><p>Keywords</p>
1639 <blockquote>
1640 <p>Take a <b>lemon</b> and squeeze it with a <b>juicer</b>.</p>
1641 </blockquote>
1642 </dd>
1643 <dt>u</dt>
1644 <dd><p>Annotations</p>
1645 <blockquote>
1646 <p>The mixture of apple juice and <u class="spelling">eldeflower</u> juice is very
1647 pleasant.</p>
1648 </blockquote>
1649 </dd>
1650 <dt>mark</dt>
1651 <dd><p>Highlight</p>
1652 <blockquote>
1653 <p>Elderflower cordial, with one <mark>part</mark> cordial to ten
1654 <mark>part</mark>s water, stands a<mark>part</mark> from the rest.</p>
1655 </blockquote>
1656 </dd>
1657 <dt>bdi</dt>
1658 <dd><p>Text directionality isolation <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-14">5</a></p>
1659 <blockquote>
1660 <p>The recommended restaurant is <bdi>My Juice Café (At The Beach)</bdi>.</p>
1661 </blockquote>
1662 <p>The <cite>dir</cite> global attribute defaults to &quot;auto&quot; (not &quot;inherit&quot;) on this
1663 element.</p>
1664 </dd>
1665 <dt>bdo</dt>
1666 <dd><p>Text directionality formatting <a class="footnote-reference brackets" href="#attribute-required" id="footnote-reference-15">6</a></p>
1667 <!-- The proposal is to write English, but in reverse order. "Juice" would
1668 become "<bdo dir=rtl>Juice</bdo>"> -->
1669 <p>Authors <em>must</em> specify the dir attribute on this element.</p>
1670 </dd>
1671 <dt>span</dt>
1672 <dd><p>Other</p>
1673 <blockquote>
1674 <p>In French we call it <span lang="fr">sirop de sureau</span>.</p>
1675 </blockquote>
1676 </dd>
1677 <dt>br</dt>
1678 <dd><p>Line break</p>
1679 <p>For complete paragraphs, use a line-block:</p>
1680 <blockquote>
1681 <div class="line-block">
1682 <div class="line">Simply Orange Juice Company</div>
1683 <div class="line">Apopka, FL 32703</div>
1684 <div class="line">U.S.A.</div>
1685 </div>
1686 </blockquote>
1687 <p>rST does not natively support an exceptional hard line break in a floating
1688 paragraph. You may use a HTML-only substitution.</p>
1689 <blockquote>
1690 <p>I want to break this line after the colon: <br /> but allow other
1691 linebreaks in this paragraph according to the width of the containing
1692 block.</p>
1693 </blockquote>
1694 </dd>
1695 <dt>wbr</dt>
1696 <dd><p>Line breaking opportunity</p>
1697 <p>Not supported by rST. You may use a ZWSP character (u200B), literal or via
1698 a substitution.</p>
1699 <blockquote>
1700 <p>www.simplyorangejuice.com</p>
1701 </blockquote>
1702 </dd>
1703 </dl>
1704 <dl class="footnote brackets">
1705 <dt class="label" id="attribute-optional"><span class="brackets">5</span><span class="fn-backref">(<a href="#footnote-reference-10">1</a>,<a href="#footnote-reference-14">2</a>,<a href="#footnote-reference-16">3</a>,<a href="#footnote-reference-17">4</a>)</span></dt>
1706 <dd><p>Would gain from support for attributes/arguments
1707 to inline roles. See <a class="reference external" href="http://docutils.sourceforge.net/docs/dev/todo.html#interpreted-text">TODO</a> <a class="footnote-reference brackets" href="#footnote-11" id="footnote-reference-24">11</a></p>
1708 </dd>
1709 <dt class="label" id="attribute-required"><span class="brackets">6</span><span class="fn-backref">(<a href="#footnote-reference-12">1</a>,<a href="#footnote-reference-13">2</a>,<a href="#footnote-reference-15">3</a>)</span></dt>
1710 <dd><p>Requires support for attributes to inline
1711 roles to make sense.</p>
1712 </dd>
1713 </dl>
1714 </section>
1715 <section id="indicating-edits">
1716 <h3><a class="toc-backref" href="#toc-entry-51"><span class="sectnum">3.4</span> Indicating Edits</a></h3>
1717 <p>The <a class="reference external" href="https://html.spec.whatwg.org/multipage/edits.html">HTML tags for representation of edits to the document</a> <a class="footnote-reference brackets" href="#footnote-18" id="footnote-reference-32">18</a> and their
1718 reStructuredText equivalents are:</p>
1719 <dl class="description">
1720 <dt>ins</dt>
1721 <dd><p>Additions <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-16">5</a></p>
1722 <blockquote>
1723 <p>This text has &quot;always&quot; been here. <ins>This text has been inserted.</ins></p>
1724 <ins class="docutils container">
1725 <p>This paragraph has been inserted.</p>
1726 </ins>
1727 </blockquote>
1728 </dd>
1729 <dt>del</dt>
1730 <dd><p>Removed content <a class="footnote-reference brackets" href="#attribute-optional" id="footnote-reference-17">5</a></p>
1731 <blockquote>
1732 <p><del>This text has been deleted</del>, here is the rest of the paragraph.</p>
1733 <del class="docutils container">
1734 <p>This paragraph has been deleted.</p>
1735 </del>
1736 </blockquote>
1737 </dd>
1738 </dl>
1739 </section>
1740 </section>
1741 <section id="error-handling">
1742 <h2><a class="toc-backref" href="#toc-entry-52"><span class="sectnum">4</span> Error Handling</a></h2>
1743 <p>Any errors caught during processing will generate system messages.</p>
1744 <p>There should be five messages in the following, auto-generated
1745 section, &quot;Docutils System Messages&quot;:</p>
1746 <!-- section should be added by Docutils automatically -->
1747 </section>
1748 <section class="system-messages">
1749 <h2>Docutils System Messages</h2>
1750 <div class="system-message" id="system-message-1">
1751 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 99); <em><a href="#problematic-1">backlink</a></em></p>
1752 <p>Undefined substitution referenced: &quot;problematic&quot;.</p>
1753 </div>
1754 <div class="system-message" id="system-message-2">
1755 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 387); <em><a href="#footnote-reference-8">backlink</a></em></p>
1756 <p>Unknown target name: &quot;5&quot;.</p>
1757 </div>
1758 <div class="system-message" id="system-message-3">
1759 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 396); <em><a href="#citation-reference-3">backlink</a></em></p>
1760 <p>Unknown target name: &quot;nonexistent&quot;.</p>
1761 </div>
1762 <div class="system-message" id="system-message-4">
1763 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 423); <em><a href="#problematic-2">backlink</a></em></p>
1764 <p>Unknown target name: &quot;hyperlink reference without a target&quot;.</p>
1765 </div>
1766 <div class="system-message" id="system-message-5">
1767 <p class="system-message-title">System Message: ERROR/3 (<span class="docutils literal">functional/input/data/standard.txt</span>, line 436); <em><a href="#problematic-3">backlink</a></em></p>
1768 <p>Duplicate target name, cannot be used as a unique reference: &quot;duplicate target names&quot;.</p>
1769 </div>
1770 </section>
1771 </main>
1772 <footer>
1773 <p>Document footer</p>
1774 <p><a class="reference external image-reference" href="http://www.w3.org/TR/html5/"><img alt="Conforms to HTML 5" src="http://www.w3.org/html/logo/badge/html5-badge-h-css3-semantics.png" style="width: 88px; height: 31px;" /></a> <a class="reference external image-reference" href="http://validator.w3.org/check?uri=referer"><img alt="Check validity!" src="https://www.w3.org/Icons/ValidatorSuite/vs-blue-190.png" style="width: 88px; height: 31px;" /></a> <a class="reference external image-reference" href="http://jigsaw.w3.org/css-validator/check/referer"><img alt="Valid CSS 2.1!" src="http://jigsaw.w3.org/css-validator/images/vcss" style="width: 88px; height: 31px;" /></a></p>
1775
1776 </footer>
1777 </body>
1778 </html>