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