test/functional/expected/standalone_rst_pseudoxml.txt

   1 <document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_pseudoxml.txt" title="reStructuredText Test Document">
   2     <title>
   3         reStructuredText Test Document
   4     <subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">
   5         Examples of Syntax Constructs
   6     <decoration>
   7         <header>
   8             <paragraph>
   9                 Document header
  10         <footer>
  11             <paragraph>
  12                 Document footer
  13     <docinfo>
  14         <author>
  15             David Goodger
  16         <address xml:space="preserve">
  17             123 Example Street
  18             Example, EX  Canada
  19             A1B 2C3
  20         <contact>
  21             <reference refuri="mailto:goodger@python.org">
  22                 goodger@python.org
  23         <authors>
  24             <author>
  25                 Me
  26             <author>
  27                 Myself
  28             <author>
  29                 I
  30         <organization>
  31             humankind
  32         <date>
  33             Now, or yesterday.  Or maybe even
  34             <emphasis>
  35                 before
  36              yesterday.
  37         <status>
  38             This is a "work in progress"
  39         <revision>
  40             is managed by a version control system.
  41         <version>
  42             1
  43         <copyright>
  44             This document has been placed in the public domain. You
  45             may do with it as you wish. You may copy, modify,
  46             redistribute, reattribute, sell, buy, rent, lease,
  47             destroy, or improve it, quote it at length, excerpt,
  48             incorporate, collate, fold, staple, or mutilate it, or do
  49             anything else to it that your or anyone else's heart
  50             desires.
  51         <field>
  52             <field_name>
  53                 field name
  54             <field_body>
  55                 <paragraph>
  56                     This is a "generic bibliographic field".
  57         <field>
  58             <field_name>
  59                 field name "2"
  60             <field_body>
  61                 <paragraph>
  62                     Generic bibliographic fields may contain multiple body elements.
  63                 <paragraph>
  64                     Like this.
  65     <topic classes="dedication">
  66         <title>
  67             Dedication
  68         <paragraph>
  69             For Docutils users & co-developers.
  70     <topic classes="abstract">
  71         <title>
  72             Abstract
  73         <paragraph>
  74             This is a test document, containing at least one example of each
  75             reStructuredText construct.
  76     <comment xml:space="preserve">
  77         This is a comment. Note how any initial comments are moved by
  78         transforms to after the document title, subtitle, and docinfo.
  79     <target refid="doctitle">
  80     <comment xml:space="preserve">
  81         Above is the document title, and below is the subtitle.
  82         They are transformed from section titles after parsing.
  83     <target refid="subtitle">
  84     <comment xml:space="preserve">
  85         bibliographic fields (which also require a transform):
  86     <meta content="reStructuredText, test, parser" name="keywords">
  87     <meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description">
  88     <raw format="latex" xml:space="preserve">
  89         \pagebreak[4] % start ToC on new page
  90     <topic classes="contents" ids="table-of-contents" names="table\ of\ contents">
  91         <title>
  92             Table of Contents
  93         <bullet_list classes="auto-toc">
  94             <list_item>
  95                 <paragraph>
  96                     <reference ids="id34" refid="structural-elements">
  97                         <generated classes="sectnum">
  98                             1
  99                         Structural Elements
 100                 <bullet_list classes="auto-toc">
 101                     <list_item>
 102                         <paragraph>
 103                             <reference ids="id35" refid="section-title">
 104                                 <generated classes="sectnum">
 105                                     1.1
 106                                 Section Title
 107                     <list_item>
 108                         <paragraph>
 109                             <reference ids="id36" refid="empty-section">
 110                                 <generated classes="sectnum">
 111                                     1.2
 112                                 Empty Section
 113                     <list_item>
 114                         <paragraph>
 115                             <reference ids="id37" refid="transitions">
 116                                 <generated classes="sectnum">
 117                                     1.3
 118                                 Transitions
 119             <list_item>
 120                 <paragraph>
 121                     <reference ids="id38" refid="body-elements">
 122                         <generated classes="sectnum">
 123                             2
 124                         Body Elements
 125                 <bullet_list classes="auto-toc">
 126                     <list_item>
 127                         <paragraph>
 128                             <reference ids="id39" refid="paragraphs">
 129                                 <generated classes="sectnum">
 130                                     2.1
 131                                 Paragraphs
 132                         <bullet_list classes="auto-toc">
 133                             <list_item>
 134                                 <paragraph>
 135                                     <reference ids="id40" refid="inline-markup">
 136                                         <generated classes="sectnum">
 137                                             2.1.1
 138                                         Inline Markup
 139                     <list_item>
 140                         <paragraph>
 141                             <reference ids="id41" refid="bullet-lists">
 142                                 <generated classes="sectnum">
 143                                     2.2
 144                                 Bullet Lists
 145                     <list_item>
 146                         <paragraph>
 147                             <reference ids="id42" refid="enumerated-lists">
 148                                 <generated classes="sectnum">
 149                                     2.3
 150                                 Enumerated Lists
 151                     <list_item>
 152                         <paragraph>
 153                             <reference ids="id43" refid="definition-lists">
 154                                 <generated classes="sectnum">
 155                                     2.4
 156                                 Definition Lists
 157                     <list_item>
 158                         <paragraph>
 159                             <reference ids="id44" refid="field-lists">
 160                                 <generated classes="sectnum">
 161                                     2.5
 162                                 Field Lists
 163                     <list_item>
 164                         <paragraph>
 165                             <reference ids="id45" refid="option-lists">
 166                                 <generated classes="sectnum">
 167                                     2.6
 168                                 Option Lists
 169                     <list_item>
 170                         <paragraph>
 171                             <reference ids="id46" refid="literal-blocks">
 172                                 <generated classes="sectnum">
 173                                     2.7
 174                                 Literal Blocks
 175                     <list_item>
 176                         <paragraph>
 177                             <reference ids="id47" refid="line-blocks">
 178                                 <generated classes="sectnum">
 179                                     2.8
 180                                 Line Blocks
 181                     <list_item>
 182                         <paragraph>
 183                             <reference ids="id48" refid="block-quotes">
 184                                 <generated classes="sectnum">
 185                                     2.9
 186                                 Block Quotes
 187                     <list_item>
 188                         <paragraph>
 189                             <reference ids="id49" refid="doctest-blocks">
 190                                 <generated classes="sectnum">
 191                                     2.10
 192                                 Doctest Blocks
 193                     <list_item>
 194                         <paragraph>
 195                             <reference ids="id50" refid="footnotes">
 196                                 <generated classes="sectnum">
 197                                     2.11
 198                                 Footnotes
 199                     <list_item>
 200                         <paragraph>
 201                             <reference ids="id51" refid="citations">
 202                                 <generated classes="sectnum">
 203                                     2.12
 204                                 Citations
 205                     <list_item>
 206                         <paragraph>
 207                             <reference ids="id52" refid="targets">
 208                                 <generated classes="sectnum">
 209                                     2.13
 210                                 Targets
 211                         <bullet_list classes="auto-toc">
 212                             <list_item>
 213                                 <paragraph>
 214                                     <reference ids="id53" refid="duplicate-target-names">
 215                                         <generated classes="sectnum">
 216                                             2.13.1
 217                                         Duplicate Target Names
 218                             <list_item>
 219                                 <paragraph>
 220                                     <reference ids="id54" refid="id21">
 221                                         <generated classes="sectnum">
 222                                             2.13.2
 223                                         Duplicate Target Names
 224                     <list_item>
 225                         <paragraph>
 226                             <reference ids="id55" refid="directives">
 227                                 <generated classes="sectnum">
 228                                     2.14
 229                                 Directives
 230                         <bullet_list classes="auto-toc">
 231                             <list_item>
 232                                 <paragraph>
 233                                     <reference ids="id56" refid="document-parts">
 234                                         <generated classes="sectnum">
 235                                             2.14.1
 236                                         Document Parts
 237                             <list_item>
 238                                 <paragraph>
 239                                     <reference ids="id57" refid="images-and-figures">
 240                                         <generated classes="sectnum">
 241                                             2.14.2
 242                                         Images and Figures
 243                             <list_item>
 244                                 <paragraph>
 245                                     <reference ids="id58" refid="admonitions">
 246                                         <generated classes="sectnum">
 247                                             2.14.3
 248                                         Admonitions
 249                             <list_item>
 250                                 <paragraph>
 251                                     <reference ids="id59" refid="topics-sidebars-and-rubrics">
 252                                         <generated classes="sectnum">
 253                                             2.14.4
 254                                         Topics, Sidebars, and Rubrics
 255                             <list_item>
 256                                 <paragraph>
 257                                     <reference ids="id60" refid="target-footnotes">
 258                                         <generated classes="sectnum">
 259                                             2.14.5
 260                                         Target Footnotes
 261                             <list_item>
 262                                 <paragraph>
 263                                     <reference ids="id61" refid="replacement-text">
 264                                         <generated classes="sectnum">
 265                                             2.14.6
 266                                         Replacement Text
 267                             <list_item>
 268                                 <paragraph>
 269                                     <reference ids="id62" refid="compound-paragraph">
 270                                         <generated classes="sectnum">
 271                                             2.14.7
 272                                         Compound Paragraph
 273                             <list_item>
 274                                 <paragraph>
 275                                     <reference ids="id63" refid="parsed-literal-blocks">
 276                                         <generated classes="sectnum">
 277                                             2.14.8
 278                                         Parsed Literal Blocks
 279                             <list_item>
 280                                 <paragraph>
 281                                     <reference ids="id64" refid="code">
 282                                         <generated classes="sectnum">
 283                                             2.14.9
 284                                         Code
 285                     <list_item>
 286                         <paragraph>
 287                             <reference ids="id65" refid="substitution-definitions">
 288                                 <generated classes="sectnum">
 289                                     2.15
 290                                 Substitution Definitions
 291                     <list_item>
 292                         <paragraph>
 293                             <reference ids="id66" refid="comments">
 294                                 <generated classes="sectnum">
 295                                     2.16
 296                                 Comments
 297                     <list_item>
 298                         <paragraph>
 299                             <reference ids="id67" refid="raw-text">
 300                                 <generated classes="sectnum">
 301                                     2.17
 302                                 Raw text
 303                     <list_item>
 304                         <paragraph>
 305                             <reference ids="id68" refid="container">
 306                                 <generated classes="sectnum">
 307                                     2.18
 308                                 Container
 309                     <list_item>
 310                         <paragraph>
 311                             <reference ids="id69" refid="colspanning-tables">
 312                                 <generated classes="sectnum">
 313                                     2.19
 314                                 Colspanning tables
 315                     <list_item>
 316                         <paragraph>
 317                             <reference ids="id70" refid="rowspanning-tables">
 318                                 <generated classes="sectnum">
 319                                     2.20
 320                                 Rowspanning tables
 321                     <list_item>
 322                         <paragraph>
 323                             <reference ids="id71" refid="complex-tables">
 324                                 <generated classes="sectnum">
 325                                     2.21
 326                                 Complex tables
 327                     <list_item>
 328                         <paragraph>
 329                             <reference ids="id72" refid="list-tables">
 330                                 <generated classes="sectnum">
 331                                     2.22
 332                                 List Tables
 333             <list_item>
 334                 <paragraph>
 335                     <reference ids="id73" refid="error-handling">
 336                         <generated classes="sectnum">
 337                             3
 338                         Error Handling
 339     <section ids="structural-elements" names="structural\ elements">
 340         <title auto="1" refid="id34">
 341             <generated classes="sectnum">
 342                 1
 343             Structural Elements
 344         <section ids="section-title" names="section\ title">
 345             <title auto="1" refid="id35">
 346                 <generated classes="sectnum">
 347                     1.1
 348                 Section Title
 349             <subtitle ids="section-subtitle" names="section\ subtitle">
 350                 Section Subtitle
 351             <paragraph>
 352                 Lone subsections are converted to a section subtitle by a transform
 353                 activated with the
 354                 <literal>
 355                     --section-subtitles
 356                  command line option or the
 357                 <literal>
 358                     sectsubtitle-xform
 359                  configuration value.
 360         <section ids="empty-section" names="empty\ section">
 361             <title auto="1" refid="id36">
 362                 <generated classes="sectnum">
 363                     1.2
 364                 Empty Section
 365         <section ids="transitions" names="transitions">
 366             <title auto="1" refid="id37">
 367                 <generated classes="sectnum">
 368                     1.3
 369                 Transitions
 370             <paragraph>
 371                 Here's a transition:
 372             <transition>
 373             <paragraph>
 374                 It divides the section.  Transitions may also occur between sections:
 375     <transition>
 376     <section ids="body-elements" names="body\ elements">
 377         <title auto="1" refid="id38">
 378             <generated classes="sectnum">
 379                 2
 380             Body Elements
 381         <section ids="paragraphs" names="paragraphs">
 382             <title auto="1" refid="id39">
 383                 <generated classes="sectnum">
 384                     2.1
 385                 Paragraphs
 386             <paragraph>
 387                 A paragraph.
 388             <section ids="inline-markup" names="inline\ markup">
 389                 <title auto="1" refid="id40">
 390                     <generated classes="sectnum">
 391                         2.1.1
 392                     Inline Markup
 393                 <paragraph>
 394                     Paragraphs contain text and may contain inline markup:
 395                     <emphasis>
 396                         emphasis
 397                     ,
 398                     <strong>
 399                         strong emphasis
 400                     ,
 401                     <literal>
 402                         inline literals
 403                     , standalone hyperlinks
 404                     (
 405                     <reference refuri="http://www.python.org">
 406                         http://www.python.org
 407                     ), external hyperlinks (
 408                     <reference name="Python" refuri="http://www.python.org/">
 409                         Python
 410
 411                     <footnote_reference auto="1" ids="id26" refid="id25">
 412                         5
 413                     ), internal
 414                     cross-references (
 415                     <reference name="example" refid="example">
 416                         example
 417                     ), external hyperlinks with embedded URIs
 418                     (
 419                     <reference name="Python web site" refuri="http://www.python.org">
 420                         Python web site
 421                     ),
 422                     <reference anonymous="1" name="anonymous hyperlink references" refuri="http://www.python.org/">
 423                         anonymous hyperlink
 424                         references
 425
 426                     <footnote_reference auto="1" ids="id31" refid="id25">
 427                         5
 428                      (
 429                     <reference anonymous="1" name="a second reference" refuri="http://docutils.sourceforge.net/">
 430                         a second reference
 431
 432                     <footnote_reference auto="1" ids="id33" refid="id32">
 433                         7
 434                     ), footnote references (manually
 435                     numbered
 436                     <footnote_reference ids="id1" refid="id8">
 437                         1
 438                     , anonymous auto-numbered
 439                     <footnote_reference auto="1" ids="id2" refid="id12">
 440                         3
 441                     , labeled auto-numbered
 442                     <footnote_reference auto="1" ids="id3" refid="label">
 443                         2
 444                     , or symbolic
 445                     <footnote_reference auto="*" ids="id4" refid="id13">
 446                         *
 447                     ), citation references (
 448                     <citation_reference ids="id5" refid="cit2002">
 449                         CIT2002
 450                     ),
 451                     substitution references (
 452                     <image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
 453                     ), and
 454                     <target ids="inline-hyperlink-targets" names="inline\ hyperlink\ targets">
 455                         inline hyperlink targets
 456
 457                     (see
 458                     <reference name="Targets" refid="targets">
 459                         Targets
 460                      below for a reference back to here).  Character-level
 461                     inline markup is also possible (although exceedingly ugly!) in
 462                     <emphasis>
 463                         re
 464                     <literal>
 465                         Structured
 466                     <emphasis>
 467                         Text
 468                     .  Problems are indicated by
 469                     <problematic ids="id24" refid="id23">
 470                         |problematic|
 471                      text
 472                     (generated by processing errors; this one is intentional).  Here is a
 473                     reference to the
 474                     <reference name="doctitle" refid="doctitle">
 475                         doctitle
 476                      and the
 477                     <reference name="subtitle" refid="subtitle">
 478                         subtitle
 479                     .
 480                 <target anonymous="1" ids="id6" refuri="http://www.python.org/">
 481                 <target anonymous="1" ids="id7" refuri="http://docutils.sourceforge.net/">
 482                 <paragraph>
 483                     The default role for interpreted text is
 484                     <title_reference>
 485                         Title Reference
 486                     .  Here are
 487                     some explicit interpreted text roles: a PEP reference (
 488                     <reference refuri="http://www.python.org/dev/peps/pep-0287">
 489                         PEP 287
 490                     ); an
 491                     RFC reference (
 492                     <reference refuri="http://www.faqs.org/rfcs/rfc2822.html">
 493                         RFC 2822
 494                     ); an abbreviation (
 495                     <abbreviation>
 496                         abb.
 497                     ), an acronym
 498                     (
 499                     <acronym>
 500                         reST
 501                     ), code (
 502                     <literal classes="code">
 503                         print "hello world"
 504                     ); a
 505                     <subscript>
 506                         subscript
 507                     ;
 508                     a
 509                     <superscript>
 510                         superscript
 511                      and explicit roles for
 512                     <title_reference>
 513                         Docutils
 514                     '
 515                     <emphasis>
 516                         standard
 517
 518                     <strong>
 519                         inline
 520
 521                     <literal>
 522                         markup
 523                     .
 524                 <comment xml:space="preserve">
 525                     DO NOT RE-WRAP THE FOLLOWING PARAGRAPH!
 526                 <paragraph>
 527                     Let's test wrapping and whitespace significance in inline literals:
 528                     <literal>
 529                         This is an example of --inline-literal --text, --including some--
 530                         strangely--hyphenated-words.  Adjust-the-width-of-your-browser-window
 531                         to see how the text is wrapped.  -- ---- --------  Now note    the
 532                         spacing    between the    words of    this sentence    (words
 533                         should    be grouped    in pairs).
 534                 <paragraph>
 535                     If the
 536                     <literal>
 537                         --pep-references
 538                      option was supplied, there should be a
 539                     live link to PEP 258 here.
 540         <section ids="bullet-lists" names="bullet\ lists">
 541             <title auto="1" refid="id41">
 542                 <generated classes="sectnum">
 543                     2.2
 544                 Bullet Lists
 545             <bullet_list bullet="-">
 546                 <list_item>
 547                     <paragraph>
 548                         A bullet list
 549                     <bullet_list bullet="+">
 550                         <list_item>
 551                             <paragraph>
 552                                 Nested bullet list.
 553                         <list_item>
 554                             <paragraph>
 555                                 Nested item 2.
 556                 <list_item>
 557                     <paragraph>
 558                         Item 2.
 559                     <paragraph>
 560                         Paragraph 2 of item 2.
 561                     <bullet_list bullet="*">
 562                         <list_item>
 563                             <paragraph>
 564                                 Nested bullet list.
 565                         <list_item>
 566                             <paragraph>
 567                                 Nested item 2.
 568                             <bullet_list bullet="-">
 569                                 <list_item>
 570                                     <paragraph>
 571                                         Third level.
 572                                 <list_item>
 573                                     <paragraph>
 574                                         Item 2.
 575                         <list_item>
 576                             <paragraph>
 577                                 Nested item 3.
 578                         <list_item>
 579                             <paragraph>
 580                                 This nested list should be compacted by the HTML writer.
 581                             <target ids="target" names="target">
 582                             <comment xml:space="preserve">
 583                                 Even if this item contains a target and a comment.
 584         <section ids="enumerated-lists" names="enumerated\ lists">
 585             <title auto="1" refid="id42">
 586                 <generated classes="sectnum">
 587                     2.3
 588                 Enumerated Lists
 589             <enumerated_list enumtype="arabic" prefix="" suffix=".">
 590                 <list_item>
 591                     <paragraph>
 592                         Arabic numerals.
 593                     <enumerated_list enumtype="loweralpha" prefix="" suffix=")">
 594                         <list_item>
 595                             <paragraph>
 596                                 lower alpha)
 597                             <enumerated_list enumtype="lowerroman" prefix="(" suffix=")">
 598                                 <list_item>
 599                                     <paragraph>
 600                                         (lower roman)
 601                                     <enumerated_list enumtype="upperalpha" prefix="" suffix=".">
 602                                         <list_item>
 603                                             <paragraph>
 604                                                 upper alpha.
 605                                             <enumerated_list enumtype="upperroman" prefix="" suffix=")">
 606                                                 <list_item>
 607                                                     <paragraph>
 608                                                         upper roman)
 609                 <list_item>
 610                     <paragraph>
 611                         Lists that don't start at 1:
 612                     <enumerated_list enumtype="arabic" prefix="" start="3" suffix=".">
 613                         <list_item>
 614                             <paragraph>
 615                                 Three
 616                         <list_item>
 617                             <paragraph>
 618                                 Four
 619                     <system_message level="1" line="8" source="functional/input/data/standard.txt" type="INFO">
 620                         <paragraph>
 621                             Enumerated list start value not ordinal-1: "3" (ordinal 3)
 622                     <enumerated_list enumtype="upperalpha" prefix="" start="3" suffix=".">
 623                         <list_item>
 624                             <paragraph>
 625                                 C
 626                         <list_item>
 627                             <paragraph>
 628                                 D
 629                     <system_message level="1" line="8" source="functional/input/data/standard.txt" type="INFO">
 630                         <paragraph>
 631                             Enumerated list start value not ordinal-1: "C" (ordinal 3)
 632                     <enumerated_list enumtype="lowerroman" prefix="" start="3" suffix=".">
 633                         <list_item>
 634                             <paragraph>
 635                                 iii
 636                         <list_item>
 637                             <paragraph>
 638                                 iv
 639                     <system_message level="1" line="8" source="functional/input/data/standard.txt" type="INFO">
 640                         <paragraph>
 641                             Enumerated list start value not ordinal-1: "iii" (ordinal 3)
 642         <section ids="definition-lists" names="definition\ lists">
 643             <title auto="1" refid="id43">
 644                 <generated classes="sectnum">
 645                     2.4
 646                 Definition Lists
 647             <definition_list>
 648                 <definition_list_item>
 649                     <term>
 650                         Term
 651                     <definition>
 652                         <paragraph>
 653                             Definition
 654                 <definition_list_item>
 655                     <term>
 656                         Term
 657                     <classifier>
 658                         classifier
 659                     <definition>
 660                         <paragraph>
 661                             Definition paragraph 1.
 662                         <paragraph>
 663                             Definition paragraph 2.
 664                 <definition_list_item>
 665                     <term>
 666                         Term
 667                     <definition>
 668                         <paragraph>
 669                             Definition
 670                 <definition_list_item>
 671                     <term>
 672                         Term
 673                     <classifier>
 674                         classifier one
 675                     <classifier>
 676                         classifier two
 677                     <definition>
 678                         <paragraph>
 679                             Definition
 680         <section ids="field-lists" names="field\ lists">
 681             <title auto="1" refid="id44">
 682                 <generated classes="sectnum">
 683                     2.5
 684                 Field Lists
 685             <field_list>
 686                 <field>
 687                     <field_name>
 688                         what
 689                     <field_body>
 690                         <paragraph>
 691                             Field lists map field names to field bodies, like database
 692                             records.  They are often part of an extension syntax.  They are
 693                             an unambiguous variant of RFC 2822 fields.
 694                 <field>
 695                     <field_name>
 696                         how arg1 arg2
 697                     <field_body>
 698                         <paragraph>
 699                             The field marker is a colon, the field name, and a colon.
 700                         <paragraph>
 701                             The field body may contain one or more body elements, indented
 702                             relative to the field marker.
 703                 <field>
 704                     <field_name>
 705                         credits
 706                     <field_body>
 707                         <paragraph classes="credits">
 708                             This paragraph has the
 709                             <title_reference>
 710                                 credits
 711                              class set.  (This is actually not
 712                             about credits but just for ensuring that the class attribute
 713                             doesn't get stripped away.)
 714         <section ids="option-lists" names="option\ lists">
 715             <title auto="1" refid="id45">
 716                 <generated classes="sectnum">
 717                     2.6
 718                 Option Lists
 719             <paragraph>
 720                 For listing command-line options:
 721             <option_list>
 722                 <option_list_item>
 723                     <option_group>
 724                         <option>
 725                             <option_string>
 726                                 -a
 727                     <description>
 728                         <paragraph>
 729                             command-line option "a"
 730                 <option_list_item>
 731                     <option_group>
 732                         <option>
 733                             <option_string>
 734                                 -b
 735                             <option_argument delimiter=" ">
 736                                 file
 737                     <description>
 738                         <paragraph>
 739                             options can have arguments
 740                             and long descriptions
 741                 <option_list_item>
 742                     <option_group>
 743                         <option>
 744                             <option_string>
 745                                 --long
 746                     <description>
 747                         <paragraph>
 748                             options can be long also
 749                 <option_list_item>
 750                     <option_group>
 751                         <option>
 752                             <option_string>
 753                                 --input
 754                             <option_argument delimiter="=">
 755                                 file
 756                     <description>
 757                         <paragraph>
 758                             long options can also have
 759                             arguments
 760                 <option_list_item>
 761                     <option_group>
 762                         <option>
 763                             <option_string>
 764                                 --very-long-option
 765                     <description>
 766                         <paragraph>
 767                             The description can also start on the next line.
 768                         <paragraph>
 769                             The description may contain multiple body elements,
 770                             regardless of where it starts.
 771                 <option_list_item>
 772                     <option_group>
 773                         <option>
 774                             <option_string>
 775                                 -x
 776                         <option>
 777                             <option_string>
 778                                 -y
 779                         <option>
 780                             <option_string>
 781                                 -z
 782                     <description>
 783                         <paragraph>
 784                             Multiple options are an "option group".
 785                 <option_list_item>
 786                     <option_group>
 787                         <option>
 788                             <option_string>
 789                                 -v
 790                         <option>
 791                             <option_string>
 792                                 --verbose
 793                     <description>
 794                         <paragraph>
 795                             Commonly-seen: short & long options.
 796                 <option_list_item>
 797                     <option_group>
 798                         <option>
 799                             <option_string>
 800                                 -1
 801                             <option_argument delimiter=" ">
 802                                 file
 803                         <option>
 804                             <option_string>
 805                                 --one
 806                             <option_argument delimiter="=">
 807                                 file
 808                         <option>
 809                             <option_string>
 810                                 --two
 811                             <option_argument delimiter=" ">
 812                                 file
 813                     <description>
 814                         <paragraph>
 815                             Multiple options with arguments.
 816                 <option_list_item>
 817                     <option_group>
 818                         <option>
 819                             <option_string>
 820                                 /V
 821                     <description>
 822                         <paragraph>
 823                             DOS/VMS-style options too
 824             <paragraph>
 825                 There must be at least two spaces between the option and the
 826                 description.
 827         <section ids="literal-blocks" names="literal\ blocks">
 828             <title auto="1" refid="id46">
 829                 <generated classes="sectnum">
 830                     2.7
 831                 Literal Blocks
 832             <paragraph>
 833                 Literal blocks are indicated with a double-colon ("::") at the end of
 834                 the preceding paragraph (over there
 835                 <literal>
 836                     -->
 837                 ).  They can be indented:
 838             <literal_block xml:space="preserve">
 839                 if literal_block:
 840                     text = 'is left as-is'
 841                     spaces_and_linebreaks = 'are preserved'
 842                     markup_processing = None
 843             <paragraph>
 844                 Or they can be quoted without indentation:
 845             <literal_block xml:space="preserve">
 846                 >> Great idea!
 847                 >
 848                 > Why didn't I think of that?
 849         <section ids="line-blocks" names="line\ blocks">
 850             <title auto="1" refid="id47">
 851                 <generated classes="sectnum">
 852                     2.8
 853                 Line Blocks
 854             <paragraph>
 855                 This section tests line blocks.  Line blocks are body elements which
 856                 consist of lines and other line blocks.  Nested line blocks cause
 857                 indentation.
 858             <line_block>
 859                 <line>
 860                     This is a line block.  It ends with a blank line.
 861                 <line_block>
 862                     <line>
 863                         New lines begin with a vertical bar ("|").
 864                     <line>
 865                         Line breaks and initial indent are significant, and preserved.
 866                     <line_block>
 867                         <line>
 868                             Continuation lines are also possible.  A long line that is intended
 869                             to wrap should begin with a space in place of the vertical bar.
 870                     <line>
 871                         The left edge of a continuation line need not be aligned with
 872                         the left edge of the text above it.
 873             <line_block>
 874                 <line>
 875                     This is a second line block.
 876                 <line>
 877                 <line>
 878                     Blank lines are permitted internally, but they must begin with a "|".
 879             <paragraph>
 880                 Another line block, surrounded by paragraphs:
 881             <line_block>
 882                 <line>
 883                     And it's no good waiting by the window
 884                 <line>
 885                     It's no good waiting for the sun
 886                 <line>
 887                     Please believe me, the things you dream of
 888                 <line>
 889                     They don't fall in the lap of no-one
 890             <paragraph>
 891                 Take it away, Eric the Orchestra Leader!
 892             <block_quote>
 893                 <line_block>
 894                     <line>
 895                         A one, two, a one two three four
 896                     <line>
 897                     <line>
 898                         Half a bee, philosophically,
 899                     <line_block>
 900                         <line>
 901                             must,
 902                             <emphasis>
 903                                 ipso facto
 904                             , half not be.
 905                     <line>
 906                         But half the bee has got to be,
 907                     <line_block>
 908                         <line>
 909                             <emphasis>
 910                                 vis a vis
 911                              its entity.  D'you see?
 912                         <line>
 913                     <line>
 914                         But can a bee be said to be
 915                     <line_block>
 916                         <line>
 917                             or not to be an entire bee,
 918                         <line_block>
 919                             <line>
 920                                 when half the bee is not a bee,
 921                             <line_block>
 922                                 <line>
 923                                     due to some ancient injury?
 924                                 <line>
 925                     <line>
 926                         Singing...
 927             <paragraph>
 928                 A line block, like the following poem by Christian Morgenstern, can
 929                 also be centre-aligned:
 930             <line_block classes="language-de align-center">
 931                 <line>
 932                     <strong>
 933                         Die Trichter
 934                 <line>
 935                 <line>
 936                     Zwei Trichter wandeln durch die Nacht.
 937                 <line>
 938                     Durch ihres Rumpfs verengten Schacht
 939                 <line>
 940                     fließt weißes Mondlicht
 941                 <line>
 942                     still und heiter
 943                 <line>
 944                     auf   ihren
 945                 <line>
 946                     Waldweg
 947                 <line>
 948                     u. s.
 949                 <line>
 950                     w.
 951                 <line>
 952         <section ids="block-quotes" names="block\ quotes">
 953             <title auto="1" refid="id48">
 954                 <generated classes="sectnum">
 955                     2.9
 956                 Block Quotes
 957             <paragraph>
 958                 Block quotes consist of indented body elements:
 959             <block_quote>
 960                 <paragraph>
 961                     My theory by A. Elk.  Brackets Miss, brackets.  This theory goes
 962                     as follows and begins now.  All brontosauruses are thin at one
 963                     end, much much thicker in the middle and then thin again at the
 964                     far end.  That is my theory, it is mine, and belongs to me and I
 965                     own it, and what it is too.
 966                 <attribution>
 967                     Anne Elk (Miss)
 968             <paragraph>
 969                 The language of a quote (like any other object) can be specified by
 970                 a class attribute:
 971             <comment xml:space="preserve">
 972             <block_quote classes="language-fr">
 973                 <paragraph>
 974                     ReStructuredText est un langage de balisage léger utilisé
 975                     notamment dans la documentation du langage Python.
 976         <section ids="doctest-blocks" names="doctest\ blocks">
 977             <title auto="1" refid="id49">
 978                 <generated classes="sectnum">
 979                     2.10
 980                 Doctest Blocks
 981             <doctest_block xml:space="preserve">
 982                 >>> print 'Python-specific usage examples; begun with ">>>"'
 983                 Python-specific usage examples; begun with ">>>"
 984                 >>> print '(cut and pasted from interactive Python sessions)'
 985                 (cut and pasted from interactive Python sessions)
 986         <section ids="footnotes" names="footnotes">
 987             <title auto="1" refid="id50">
 988                 <generated classes="sectnum">
 989                     2.11
 990                 Footnotes
 991             <footnote backrefs="id1 id9 id22" ids="id8" names="1">
 992                 <label>
 993                     1
 994                 <paragraph>
 995                     A footnote contains body elements, consistently indented by at
 996                     least 3 spaces.
 997                 <paragraph>
 998                     This is the footnote's second paragraph.
 999             <footnote auto="1" backrefs="id3 id10" ids="label" names="label">
1000                 <label>
1001                     2
1002                 <paragraph>
1003                     Footnotes may be numbered, either manually (as in
1004                     <footnote_reference ids="id9" refid="id8">
1005                         1
1006                     ) or
1007                     automatically using a "#"-prefixed label.  This footnote has a
1008                     label so it can be referred to from multiple places, both as a
1009                     footnote reference (
1010                     <footnote_reference auto="1" ids="id10" refid="label">
1011                         2
1012                     ) and as a
1013                     <reference anonymous="1" name="hyperlink reference" refid="label">
1014                         hyperlink reference
1015                     .
1016                 <target anonymous="1" ids="id11" refid="label">
1017             <footnote auto="1" backrefs="id2" ids="id12" names="3">
1018                 <label>
1019                     3
1020                 <paragraph>
1021                     This footnote is numbered automatically and anonymously using a
1022                     label of "#" only.
1023                 <paragraph>
1024                     This is the second paragraph.
1025                 <paragraph>
1026                     And this is the third paragraph.
1027             <footnote auto="*" backrefs="id4" ids="id13">
1028                 <label>
1029                     *
1030                 <paragraph>
1031                     Footnotes may also use symbols, specified with a "*" label.
1032                     Here's a reference to the next footnote:
1033                     <footnote_reference auto="*" ids="id14" refid="id15">
1034                         †
1035                     .
1036             <footnote auto="*" backrefs="id14" ids="id15">
1037                 <label>
1038                     †
1039                 <paragraph>
1040                     This footnote shows the next symbol in the sequence.
1041             <footnote ids="id16" names="4">
1042                 <label>
1043                     4
1044                 <paragraph>
1045                     Here's an unreferenced footnote, with a reference to a
1046                     nonexistent footnote:
1047                     <problematic ids="id84 id17" refid="id83">
1048                         [5]_
1049                     .
1050         <section ids="citations" names="citations">
1051             <title auto="1" refid="id51">
1052                 <generated classes="sectnum">
1053                     2.12
1054                 Citations
1055             <citation backrefs="id5 id18" ids="cit2002" names="cit2002">
1056                 <label>
1057                     CIT2002
1058                 <paragraph>
1059                     Citations are text-labeled footnotes. They may be
1060                     rendered separately and differently from footnotes.
1061             <paragraph>
1062                 Here's a reference to the above,
1063                 <citation_reference ids="id18" refid="cit2002">
1064                     CIT2002
1065                 , and a
1066                 <problematic ids="id86 id19" refid="id85">
1067                     [nonexistent]_
1068
1069                 citation.
1070             <target refid="another-target">
1071         <section ids="targets another-target" names="targets another\ target">
1072             <title auto="1" refid="id52">
1073                 <generated classes="sectnum">
1074                     2.13
1075                 Targets
1076             <target refid="example">
1077             <paragraph ids="example" names="example">
1078                 This paragraph is pointed to by the explicit "example" target. A
1079                 reference can be found under
1080                 <reference name="Inline Markup" refid="inline-markup">
1081                     Inline Markup
1082                 , above.
1083                 <reference name="Inline hyperlink targets" refid="inline-hyperlink-targets">
1084                     Inline
1085                     hyperlink targets
1086                  are also possible.
1087             <paragraph>
1088                 Section headers are implicit targets, referred to by name. See
1089                 <reference name="Targets" refid="targets">
1090                     Targets
1091                 , which is a subsection of
1092                 <reference name="Body Elements" refid="body-elements">
1093                     Body Elements
1094                 .
1095             <paragraph>
1096                 Explicit external targets are interpolated into references such as
1097                 "
1098                 <reference name="Python" refuri="http://www.python.org/">
1099                     Python
1100
1101                 <footnote_reference auto="1" ids="id27" refid="id25">
1102                     5
1103                 ".
1104             <target ids="python" names="python" refuri="http://www.python.org/">
1105             <paragraph>
1106                 Targets may be indirect and anonymous.  Thus
1107                 <reference anonymous="1" name="this phrase" refid="targets">
1108                     this phrase
1109                  may also
1110                 refer to the
1111                 <reference name="Targets" refid="targets">
1112                     Targets
1113                  section.
1114             <target anonymous="1" ids="id20" refid="targets">
1115             <paragraph>
1116                 Here's a
1117                 <problematic ids="id88" refid="id87">
1118                     `hyperlink reference without a target`_
1119                 , which generates an
1120                 error.
1121             <section dupnames="duplicate\ target\ names" ids="duplicate-target-names">
1122                 <title auto="1" refid="id53">
1123                     <generated classes="sectnum">
1124                         2.13.1
1125                     Duplicate Target Names
1126                 <paragraph>
1127                     Duplicate names in section headers or other implicit targets will
1128                     generate "info" (level-1) system messages.  Duplicate names in
1129                     explicit targets will generate "warning" (level-2) system messages.
1130             <section dupnames="duplicate\ target\ names" ids="id21">
1131                 <title auto="1" refid="id54">
1132                     <generated classes="sectnum">
1133                         2.13.2
1134                     Duplicate Target Names
1135                 <system_message backrefs="id21" level="1" line="438" source="functional/input/data/standard.txt" type="INFO">
1136                     <paragraph>
1137                         Duplicate implicit target name: "duplicate target names".
1138                 <paragraph>
1139                     Since there are two "Duplicate Target Names" section headers, we
1140                     cannot uniquely refer to either of them by name.  If we try to (like
1141                     this:
1142                     <problematic ids="id90" refid="id89">
1143                         `Duplicate Target Names`_
1144                     ), an error is generated.
1145         <section ids="directives" names="directives">
1146             <title auto="1" refid="id55">
1147                 <generated classes="sectnum">
1148                     2.14
1149                 Directives
1150             <topic classes="contents local" ids="contents" names="contents">
1151                 <bullet_list classes="auto-toc">
1152                     <list_item>
1153                         <paragraph>
1154                             <reference ids="id74" refid="document-parts">
1155                                 <generated classes="sectnum">
1156                                     2.14.1
1157                                 Document Parts
1158                     <list_item>
1159                         <paragraph>
1160                             <reference ids="id75" refid="images-and-figures">
1161                                 <generated classes="sectnum">
1162                                     2.14.2
1163                                 Images and Figures
1164                     <list_item>
1165                         <paragraph>
1166                             <reference ids="id76" refid="admonitions">
1167                                 <generated classes="sectnum">
1168                                     2.14.3
1169                                 Admonitions
1170                     <list_item>
1171                         <paragraph>
1172                             <reference ids="id77" refid="topics-sidebars-and-rubrics">
1173                                 <generated classes="sectnum">
1174                                     2.14.4
1175                                 Topics, Sidebars, and Rubrics
1176                     <list_item>
1177                         <paragraph>
1178                             <reference ids="id78" refid="target-footnotes">
1179                                 <generated classes="sectnum">
1180                                     2.14.5
1181                                 Target Footnotes
1182                     <list_item>
1183                         <paragraph>
1184                             <reference ids="id79" refid="replacement-text">
1185                                 <generated classes="sectnum">
1186                                     2.14.6
1187                                 Replacement Text
1188                     <list_item>
1189                         <paragraph>
1190                             <reference ids="id80" refid="compound-paragraph">
1191                                 <generated classes="sectnum">
1192                                     2.14.7
1193                                 Compound Paragraph
1194                     <list_item>
1195                         <paragraph>
1196                             <reference ids="id81" refid="parsed-literal-blocks">
1197                                 <generated classes="sectnum">
1198                                     2.14.8
1199                                 Parsed Literal Blocks
1200                     <list_item>
1201                         <paragraph>
1202                             <reference ids="id82" refid="code">
1203                                 <generated classes="sectnum">
1204                                     2.14.9
1205                                 Code
1206             <paragraph>
1207                 These are just a sample of the many reStructuredText Directives.  For
1208                 others, please see
1209                 <reference refuri="http://docutils.sourceforge.net/docs/ref/rst/directives.html">
1210                     http://docutils.sourceforge.net/docs/ref/rst/directives.html
1211                 .
1212             <section ids="document-parts" names="document\ parts">
1213                 <title auto="1" refid="id74">
1214                     <generated classes="sectnum">
1215                         2.14.1
1216                     Document Parts
1217                 <paragraph>
1218                     An example of the "contents" directive can be seen above this section
1219                     (a local, untitled table of
1220                     <reference name="contents" refid="contents">
1221                         contents
1222                     ) and at the beginning of the
1223                     document (a document-wide
1224                     <reference name="table of contents" refid="table-of-contents">
1225                         table of contents
1226                     ).
1227             <section ids="images-and-figures" names="images\ and\ figures">
1228                 <title auto="1" refid="id75">
1229                     <generated classes="sectnum">
1230                         2.14.2
1231                     Images and Figures
1232                 <paragraph>
1233                     An image directive (also clickable -- a hyperlink reference):
1234                 <reference name="directives" refid="directives">
1235                     <image classes="class1 class2" uri="../../../docs/user/rst/images/title.png">
1236                 <paragraph>
1237                     Image with multiple IDs:
1238                 <target refid="image-target-1">
1239                 <target refid="image-target-2">
1240                 <target refid="image-target-3">
1241                 <image ids="image-target-3 image-target-2 image-target-1" names="image\ target\ 3 image\ target\ 2 image\ target\ 1" uri="../../../docs/user/rst/images/title.png">
1242                 <paragraph>
1243                     A centered image:
1244                 <image align="center" uri="../../../docs/user/rst/images/biohazard.png">
1245                 <paragraph>
1246                     A left-aligned image:
1247                 <image align="left" uri="../../../docs/user/rst/images/biohazard.png">
1248                 <paragraph>
1249                     This paragraph might flow around the image.
1250                     The specific behavior depends upon the style sheet and
1251                     the browser or rendering software used.
1252                 <paragraph>
1253                     A right-aligned image:
1254                 <image align="right" uri="../../../docs/user/rst/images/biohazard.png">
1255                 <paragraph>
1256                     This paragraph might flow around the image.
1257                     The specific behavior depends upon the style sheet and
1258                     the browser or rendering software used.
1259                 <paragraph>
1260                     For inline images see
1261                     <reference name="Substitution Definitions" refid="substitution-definitions">
1262                         Substitution Definitions
1263                     .
1264                 <paragraph>
1265                     Image size:
1266                 <paragraph>
1267                     An image 2 em wide:
1268                 <image uri="../../../docs/user/rst/images/biohazard.png" width="2em">
1269                 <paragraph>
1270                     An image 2 em wide and 15 pixel high:
1271                 <image height="15px" uri="../../../docs/user/rst/images/biohazard.png" width="2em">
1272                 <paragraph>
1273                     An image occupying 50% of the line width:
1274                 <image uri="../../../docs/user/rst/images/title.png" width="50%">
1275                 <paragraph>
1276                     An image 2 cm high:
1277                 <image height="2cm" uri="../../../docs/user/rst/images/biohazard.png">
1278                 <paragraph>
1279                     A
1280                     <emphasis>
1281                         figure
1282                      is an image with a caption and/or a legend.  With page-based output
1283                     media, figures might float to a different position if this helps the page
1284                     layout.
1285                 <figure classes="figclass1 figclass2">
1286                     <image alt="reStructuredText, the markup syntax" classes="class1 class2" uri="../../../docs/user/rst/images/title.png" width="258">
1287                     <caption>
1288                         Plaintext markup syntax and parser system.
1289                     <legend>
1290                         <table>
1291                             <tgroup cols="2" colwidths="auto">
1292                                 <colspec colwidth="12">
1293                                 <colspec colwidth="47">
1294                                 <tbody>
1295                                     <row>
1296                                         <entry>
1297                                             <paragraph>
1298                                                 re
1299                                         <entry>
1300                                             <paragraph>
1301                                                 Revised, revisited, based on 're' module.
1302                                     <row>
1303                                         <entry>
1304                                             <paragraph>
1305                                                 Structured
1306                                         <entry>
1307                                             <paragraph>
1308                                                 Structure-enhanced text, structuredtext.
1309                                     <row>
1310                                         <entry>
1311                                             <paragraph>
1312                                                 Text
1313                                         <entry>
1314                                             <paragraph>
1315                                                 Well it is, isn't it?
1316                         <paragraph>
1317                             This paragraph is also part of the legend.
1318                 <paragraph>
1319                     A left-aligned figure:
1320                 <figure align="left" classes="figclass1 figclass2" width="70%">
1321                     <image alt="reStructuredText, the markup syntax" classes="class1 class2" uri="../../../docs/user/rst/images/biohazard.png" width="40px">
1322                     <caption>
1323                         This is the caption.
1324                     <legend>
1325                         <paragraph>
1326                             This is the legend.
1327                         <paragraph>
1328                             The legend may consist of several paragraphs.
1329                 <paragraph>
1330                     This paragraph might flow around the figure.
1331                 <paragraph>
1332                     The specific behavior depends upon the style sheet and the browser or
1333                     rendering software used.
1334                 <paragraph>
1335                     A centered figure:
1336                 <figure align="center">
1337                     <image uri="../../../docs/user/rst/images/biohazard.png" width="40px">
1338                     <caption>
1339                         This is the caption.
1340                     <legend>
1341                         <paragraph>
1342                             This is the legend.
1343                         <paragraph>
1344                             The legend may consist of several paragraphs.
1345                 <paragraph>
1346                     This paragraph might flow around the figure.
1347                 <paragraph>
1348                     The specific behavior depends upon the style sheet and the browser or
1349                     rendering software used.
1350                 <paragraph>
1351                     A right-aligned figure:
1352                 <figure align="right">
1353                     <image uri="../../../docs/user/rst/images/biohazard.png" width="40px">
1354                     <caption>
1355                         This is the caption.
1356                     <legend>
1357                         <paragraph>
1358                             This is the legend.
1359                         <paragraph>
1360                             The legend may consist of several paragraphs.
1361                 <paragraph>
1362                     This paragraph might flow around the figure. The specific behavior depends
1363                     upon the style sheet and the browser or rendering software used.
1364             <section ids="admonitions" names="admonitions">
1365                 <title auto="1" refid="id76">
1366                     <generated classes="sectnum">
1367                         2.14.3
1368                     Admonitions
1369                 <attention>
1370                     <paragraph>
1371                         Directives at large.
1372                 <caution>
1373                     <paragraph>
1374                         Don't take any wooden nickels.
1375                 <danger>
1376                     <paragraph>
1377                         Mad scientist at work!
1378                 <error>
1379                     <paragraph>
1380                         Does not compute.
1381                 <hint>
1382                     <paragraph>
1383                         It's bigger than a bread box.
1384                 <important>
1385                     <bullet_list bullet="-">
1386                         <list_item>
1387                             <paragraph>
1388                                 Wash behind your ears.
1389                         <list_item>
1390                             <paragraph>
1391                                 Clean up your room.
1392                         <list_item>
1393                             <paragraph>
1394                                 Call your mother.
1395                         <list_item>
1396                             <paragraph>
1397                                 Back up your data.
1398                 <note>
1399                     <paragraph>
1400                         This is a note.
1401                 <tip>
1402                     <paragraph>
1403                         15% if the service is good.
1404                 <warning>
1405                     <paragraph>
1406                         Strong prose may provoke extreme mental exertion.
1407                         Reader discretion is strongly advised.
1408                 <admonition classes="admonition-and-by-the-way">
1409                     <title>
1410                         And, by the way...
1411                     <paragraph>
1412                         You can make up your own admonition too.
1413                     <target ids="docutils" names="docutils" refuri="http://docutils.sourceforge.net/">
1414             <section ids="topics-sidebars-and-rubrics" names="topics,\ sidebars,\ and\ rubrics">
1415                 <title auto="1" refid="id77">
1416                     <generated classes="sectnum">
1417                         2.14.4
1418                     Topics, Sidebars, and Rubrics
1419                 <paragraph>
1420                     <emphasis>
1421                         Sidebars
1422                      are like miniature, parallel documents.
1423                 <sidebar>
1424                     <title>
1425                         Sidebar Title
1426                     <subtitle>
1427                         Optional Subtitle
1428                     <paragraph>
1429                         This is a sidebar.  It is for text outside the flow of the main
1430                         text.
1431                     <rubric>
1432                         This is a rubric inside a sidebar
1433                     <paragraph>
1434                         Sidebars often appear beside the main text with a border and a different
1435                         background or font color.
1436                 <paragraph>
1437                     A
1438                     <emphasis>
1439                         topic
1440                      is like a block quote with a title, or a self-contained section
1441                     with no subsections.
1442                 <topic>
1443                     <title>
1444                         Topic Title
1445                     <paragraph>
1446                         This is a topic.
1447                 <paragraph>
1448                     A
1449                     <emphasis>
1450                         rubric
1451                      is like an informal heading that doesn't correspond to the
1452                     document's structure. It is typically highlighted in red (hence the name).
1453                 <rubric>
1454                     This is a rubric
1455                 <paragraph>
1456                     Topics and rubrics can be used at places where a
1457                     <reference name="section title" refid="section-title">
1458                         section title
1459                      is not
1460                     allowed (e.g. inside a directive).
1461             <section ids="target-footnotes" names="target\ footnotes">
1462                 <title auto="1" refid="id78">
1463                     <generated classes="sectnum">
1464                         2.14.5
1465                     Target Footnotes
1466                 <footnote auto="1" backrefs="id26 id27 id28 id31" ids="id25" names="TARGET_NOTE:\ id25">
1467                     <label>
1468                         5
1469                     <paragraph>
1470                         <reference refuri="http://www.python.org/">
1471                             http://www.python.org/
1472                 <footnote auto="1" backrefs="id30" ids="id29" names="TARGET_NOTE:\ id29">
1473                     <label>
1474                         6
1475                     <paragraph>
1476                         <reference refuri="http://pygments.org/">
1477                             http://pygments.org/
1478                 <footnote auto="1" backrefs="id33" ids="id32" names="TARGET_NOTE:\ id32">
1479                     <label>
1480                         7
1481                     <paragraph>
1482                         <reference refuri="http://docutils.sourceforge.net/">
1483                             http://docutils.sourceforge.net/
1484             <section ids="replacement-text" names="replacement\ text">
1485                 <title auto="1" refid="id79">
1486                     <generated classes="sectnum">
1487                         2.14.6
1488                     Replacement Text
1489                 <paragraph>
1490                     I recommend you try
1491                     <reference refuri="http://www.python.org/">
1492                         Python,
1493                         <emphasis>
1494                             the
1495                          best language around
1496
1497                     <footnote_reference auto="1" ids="id28" refid="id25">
1498                         5
1499                     .
1500                 <substitution_definition names="Python">
1501                     Python,
1502                     <emphasis>
1503                         the
1504                      best language around
1505             <section ids="compound-paragraph" names="compound\ paragraph">
1506                 <title auto="1" refid="id80">
1507                     <generated classes="sectnum">
1508                         2.14.7
1509                     Compound Paragraph
1510                 <compound classes="some-class">
1511                     <paragraph>
1512                         Compound 1, paragraph 1.
1513                     <paragraph>
1514                         Compound 1, paragraph 2.
1515                     <bullet_list bullet="*">
1516                         <list_item>
1517                             <paragraph>
1518                                 Compound 1, list item one.
1519                         <list_item>
1520                             <paragraph>
1521                                 Compound 1, list item two.
1522                 <paragraph>
1523                     Another compound statement:
1524                 <compound>
1525                     <paragraph>
1526                         Compound 2, a literal block:
1527                     <literal_block xml:space="preserve">
1528                         Compound 2, literal.
1529                     <paragraph>
1530                         Compound 2, this is a test.
1531                 <compound>
1532                     <paragraph>
1533                         Compound 3, only consisting of one paragraph.
1534                 <compound>
1535                     <literal_block xml:space="preserve">
1536                         Compound 4.
1537                         This one starts with a literal block.
1538                     <paragraph>
1539                         Compound 4, a paragraph.
1540                 <paragraph>
1541                     Now something
1542                     <emphasis>
1543                         really
1544                      perverted -- a nested compound block.  This is
1545                     just to test that it works at all; the results don't have to be
1546                     meaningful.
1547                 <compound>
1548                     <paragraph>
1549                         Compound 5, block 1 (a paragraph).
1550                     <compound>
1551                         <paragraph>
1552                             Compound 6, block 2 in compound 5.
1553                         <paragraph>
1554                             Compound 6, another paragraph.
1555                     <paragraph>
1556                         Compound 5, block 3 (a paragraph).
1557                 <compound>
1558                     <paragraph>
1559                         Compound 7, with a table inside:
1560                     <table>
1561                         <tgroup cols="3" colwidths="auto">
1562                             <colspec colwidth="20">
1563                             <colspec colwidth="20">
1564                             <colspec colwidth="20">
1565                             <tbody>
1566                                 <row>
1567                                     <entry>
1568                                         <paragraph>
1569                                             Left cell, first
1570                                             paragraph.
1571                                         <paragraph>
1572                                             Left cell, second
1573                                             paragraph.
1574                                     <entry>
1575                                         <paragraph>
1576                                             Middle cell,
1577                                             consisting of
1578                                             exactly one
1579                                             paragraph.
1580                                     <entry>
1581                                         <paragraph>
1582                                             Right cell.
1583                                         <paragraph>
1584                                             Paragraph 2.
1585                                         <paragraph>
1586                                             Paragraph 3.
1587                     <paragraph>
1588                         Compound 7, a paragraph after the table.
1589                     <paragraph>
1590                         Compound 7, another paragraph.
1591             <section ids="parsed-literal-blocks" names="parsed\ literal\ blocks">
1592                 <title auto="1" refid="id81">
1593                     <generated classes="sectnum">
1594                         2.14.8
1595                     Parsed Literal Blocks
1596                 <literal_block xml:space="preserve">
1597                     This is a parsed literal block.
1598                         This line is indented.  The next line is blank.
1599
1600                     Inline markup is supported, e.g.
1601                     <emphasis>
1602                         emphasis
1603                     ,
1604                     <strong>
1605                         strong
1606                     ,
1607                     <literal>
1608                         literal
1609                         text
1610                     , footnotes
1611                     <footnote_reference ids="id22" refid="id8">
1612                         1
1613                     ,
1614                     <target ids="hyperlink-targets" names="hyperlink\ targets">
1615                         hyperlink targets
1616                     , and
1617                     <reference name="references" refuri="http://www.python.org/">
1618                         references
1619                     <target ids="references" names="references" refuri="http://www.python.org/">
1620                     .
1621             <section ids="code" names="code">
1622                 <title auto="1" refid="id82">
1623                     <generated classes="sectnum">
1624                         2.14.9
1625                     Code
1626                 <paragraph>
1627                     Blocks of source code can be set with the
1628                     <title_reference>
1629                         code
1630                      directive. If the code
1631                     language is specified, the content is parsed and tagged by the
1632                     <reference name="Pygments" refuri="http://pygments.org/">
1633                         Pygments
1634
1635                     <footnote_reference auto="1" ids="id30" refid="id29">
1636                         6
1637
1638                     syntax highlighter and can be formatted with a style sheet. (Code parsing
1639                     is turned off using the
1640                     <literal>
1641                         syntax-highlight
1642                      config setting in the test
1643                     conversions in order to get identical results with/without installed
1644                     Pygments highlighter.)
1645                 <literal_block classes="code python" xml:space="preserve">
1646                     print 'This is Python code.'
1647                 <paragraph>
1648                     The
1649                     <literal>
1650                         :number-lines:
1651                      option (with optional start value) generates line
1652                     numbers:
1653                 <literal_block classes="code python" xml:space="preserve">
1654                     <inline classes="ln">
1655                          8
1656                     # print integers from 0 to 9:
1657                     <inline classes="ln">
1658                          9
1659                     for i in range(10):
1660                     <inline classes="ln">
1661                         10
1662                         print i
1663                 <paragraph>
1664                     For inline code snippets, there is the
1665                     <title_reference>
1666                         code
1667                      role, which can be used
1668                     directly (the code will not be parsed/tagged, as the language is not known)
1669                     or as base for special code roles, e.g. the LaTeX code in the next
1670                     paragraph.
1671                 <paragraph>
1672                     Docutils uses LaTeX syntax for math directives and roles:
1673                     <literal classes="code tex">
1674                         \alpha = f(x)
1675                      prints
1676                     <math>
1677                         \alpha = f(x)
1678                     .
1679                 <paragraph>
1680                     The
1681                     <literal>
1682                         :code:
1683                      option of the
1684                     <title_reference>
1685                         include
1686                      directive sets the included content
1687                     as a code block, here the rst file
1688                     <literal>
1689                         header_footer.txt
1690                      with line numbers:
1691                 <literal_block classes="code rst" source="functional/input/data/header_footer.txt" xml:space="preserve">
1692                     <inline classes="ln">
1693                         1
1694                     .. header:: Document header
1695                     <inline classes="ln">
1696                         2
1697                     .. footer:: Document footer
1698                 <target ids="pygments" names="pygments" refuri="http://pygments.org/">
1699         <section ids="substitution-definitions" names="substitution\ definitions">
1700             <title auto="1" refid="id65">
1701                 <generated classes="sectnum">
1702                     2.15
1703                 Substitution Definitions
1704             <paragraph>
1705                 An inline image (
1706                 <image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
1707                 ) example:
1708             <substitution_definition names="EXAMPLE">
1709                 <image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
1710             <paragraph>
1711                 (Substitution definitions are not visible in the HTML source.)
1712         <section ids="comments" names="comments">
1713             <title auto="1" refid="id66">
1714                 <generated classes="sectnum">
1715                     2.16
1716                 Comments
1717             <paragraph>
1718                 Here's one:
1719             <comment xml:space="preserve">
1720                 Comments begin with two dots and a space. Anything may
1721                 follow, except for the syntax of footnotes, hyperlink
1722                 targets, directives, or substitution definitions.
1723
1724                 Double-dashes -- "--" -- must be escaped somehow in HTML output.
1725
1726                 Comments may contain non-ASCII characters: ä ö ü æ ø å
1727             <paragraph>
1728                 (View the HTML source to see the comment.)
1729         <section ids="raw-text" names="raw\ text">
1730             <title auto="1" refid="id67">
1731                 <generated classes="sectnum">
1732                     2.17
1733                 Raw text
1734             <paragraph>
1735                 This does not necessarily look nice, because there may be missing white space.
1736             <paragraph>
1737                 It's just there to freeze the behavior.
1738             <raw format="html latex" xml:space="preserve">
1739                 A test.
1740             <raw format="html latex" xml:space="preserve">
1741                 Second test.
1742             <raw classes="myclass" format="html latex" xml:space="preserve">
1743                 Another test with myclass set.
1744             <paragraph>
1745                 This is the
1746                 <raw classes="myrawroleclass" format="html latex" xml:space="preserve">
1747                     fourth test
1748                  with myrawroleclass set.
1749             <raw format="html" xml:space="preserve">
1750                 Fifth test in HTML.<br />Line two.
1751             <raw format="latex" xml:space="preserve">
1752                 Fifth test in LaTeX.\\Line two.
1753         <section ids="container" names="container">
1754             <title auto="1" refid="id68">
1755                 <generated classes="sectnum">
1756                     2.18
1757                 Container
1758             <container classes="custom">
1759                 <paragraph>
1760                     paragraph 1
1761                 <paragraph>
1762                     paragraph 2
1763         <section ids="colspanning-tables" names="colspanning\ tables">
1764             <title auto="1" refid="id69">
1765                 <generated classes="sectnum">
1766                     2.19
1767                 Colspanning tables
1768             <paragraph>
1769                 This table has a cell spanning two columns:
1770             <table>
1771                 <tgroup cols="3" colwidths="auto">
1772                     <colspec colwidth="5">
1773                     <colspec colwidth="5">
1774                     <colspec colwidth="6">
1775                     <thead>
1776                         <row>
1777                             <entry morecols="1">
1778                                 <paragraph>
1779                                     Inputs
1780                             <entry>
1781                                 <paragraph>
1782                                     Output
1783                         <row>
1784                             <entry>
1785                                 <paragraph>
1786                                     A
1787                             <entry>
1788                                 <paragraph>
1789                                     B
1790                             <entry>
1791                                 <paragraph>
1792                                     A or B
1793                     <tbody>
1794                         <row>
1795                             <entry>
1796                                 <paragraph>
1797                                     False
1798                             <entry>
1799                                 <paragraph>
1800                                     False
1801                             <entry>
1802                                 <paragraph>
1803                                     False
1804                         <row>
1805                             <entry>
1806                                 <paragraph>
1807                                     True
1808                             <entry>
1809                                 <paragraph>
1810                                     False
1811                             <entry>
1812                                 <paragraph>
1813                                     True
1814                         <row>
1815                             <entry>
1816                                 <paragraph>
1817                                     False
1818                             <entry>
1819                                 <paragraph>
1820                                     True
1821                             <entry>
1822                                 <paragraph>
1823                                     True
1824                         <row>
1825                             <entry>
1826                                 <paragraph>
1827                                     True
1828                             <entry>
1829                                 <paragraph>
1830                                     True
1831                             <entry>
1832                                 <paragraph>
1833                                     True
1834         <section ids="rowspanning-tables" names="rowspanning\ tables">
1835             <title auto="1" refid="id70">
1836                 <generated classes="sectnum">
1837                     2.20
1838                 Rowspanning tables
1839             <paragraph>
1840                 Here's a table with cells spanning several rows:
1841             <table>
1842                 <tgroup cols="3" colwidths="auto">
1843                     <colspec colwidth="24">
1844                     <colspec colwidth="12">
1845                     <colspec colwidth="18">
1846                     <thead>
1847                         <row>
1848                             <entry>
1849                                 <paragraph>
1850                                     Header row, column 1
1851                                     (header rows optional)
1852                             <entry>
1853                                 <paragraph>
1854                                     Header 2
1855                             <entry>
1856                                 <paragraph>
1857                                     Header 3
1858                     <tbody>
1859                         <row>
1860                             <entry>
1861                                 <paragraph>
1862                                     body row 1, column 1
1863                             <entry>
1864                                 <paragraph>
1865                                     column 2
1866                             <entry>
1867                                 <paragraph>
1868                                     column 3
1869                         <row>
1870                             <entry>
1871                                 <paragraph>
1872                                     body row 2
1873                             <entry morerows="1">
1874                                 <paragraph>
1875                                     Cells may
1876                                     span rows.
1877                             <entry morerows="1">
1878                                 <paragraph>
1879                                     Another
1880                                     rowspanning
1881                                     cell.
1882                         <row>
1883                             <entry>
1884                                 <paragraph>
1885                                     body row 3
1886         <section ids="complex-tables" names="complex\ tables">
1887             <title auto="1" refid="id71">
1888                 <generated classes="sectnum">
1889                     2.21
1890                 Complex tables
1891             <paragraph>
1892                 Here's a complex table, which should test all features.
1893             <table>
1894                 <tgroup cols="4" colwidths="auto">
1895                     <colspec colwidth="24">
1896                     <colspec colwidth="12">
1897                     <colspec colwidth="10">
1898                     <colspec colwidth="10">
1899                     <thead>
1900                         <row>
1901                             <entry>
1902                                 <paragraph>
1903                                     Header row, column 1
1904                                     (header rows optional)
1905                             <entry>
1906                                 <paragraph>
1907                                     Header 2
1908                             <entry>
1909                                 <paragraph>
1910                                     Header 3
1911                             <entry>
1912                                 <paragraph>
1913                                     Header 4
1914                     <tbody>
1915                         <row>
1916                             <entry>
1917                                 <paragraph>
1918                                     body row 1, column 1
1919                             <entry>
1920                                 <paragraph>
1921                                     column 2
1922                             <entry>
1923                                 <paragraph>
1924                                     column 3
1925                             <entry>
1926                                 <paragraph>
1927                                     column 4
1928                         <row>
1929                             <entry>
1930                                 <paragraph>
1931                                     body row 2
1932                             <entry morecols="2">
1933                                 <paragraph>
1934                                     Cells may span columns.
1935                         <row>
1936                             <entry>
1937                                 <paragraph>
1938                                     body row 3
1939                             <entry morerows="1">
1940                                 <paragraph>
1941                                     Cells may
1942                                     span rows.
1943                                 <paragraph>
1944                                     Paragraph.
1945                             <entry morecols="1" morerows="1">
1946                                 <bullet_list bullet="-">
1947                                     <list_item>
1948                                         <paragraph>
1949                                             Table cells
1950                                     <list_item>
1951                                         <paragraph>
1952                                             contain
1953                                     <list_item>
1954                                         <paragraph>
1955                                             body elements.
1956                         <row>
1957                             <entry>
1958                                 <paragraph>
1959                                     body row 4
1960                         <row>
1961                             <entry>
1962                                 <paragraph>
1963                                     body row 5
1964                             <entry morecols="1">
1965                                 <paragraph>
1966                                     Cells may also be
1967                                     empty:
1968                                     <literal>
1969                                         -->
1970                             <entry>
1971         <section ids="list-tables" names="list\ tables">
1972             <title auto="1" refid="id72">
1973                 <generated classes="sectnum">
1974                     2.22
1975                 List Tables
1976             <paragraph>
1977                 Here's a list table exercising all features:
1978             <table classes="test">
1979                 <title>
1980                     list table with integral header
1981                 <tgroup cols="3" colwidths="given">
1982                     <colspec colwidth="10" stub="1">
1983                     <colspec colwidth="20">
1984                     <colspec colwidth="30">
1985                     <thead>
1986                         <row>
1987                             <entry>
1988                                 <paragraph>
1989                                     Treat
1990                             <entry>
1991                                 <paragraph>
1992                                     Quantity
1993                             <entry>
1994                                 <paragraph>
1995                                     Description
1996                     <tbody>
1997                         <row>
1998                             <entry>
1999                                 <paragraph>
2000                                     Albatross
2001                             <entry>
2002                                 <paragraph>
2003                                     2.99
2004                             <entry>
2005                                 <paragraph>
2006                                     On a stick!
2007                         <row>
2008                             <entry>
2009                                 <paragraph>
2010                                     Crunchy Frog
2011                             <entry>
2012                                 <paragraph>
2013                                     1.49
2014                             <entry>
2015                                 <paragraph>
2016                                     If we took the bones out, it wouldn't be
2017                                     crunchy, now would it?
2018                         <row>
2019                             <entry>
2020                                 <paragraph>
2021                                     Gannet Ripple
2022                             <entry>
2023                                 <paragraph>
2024                                     1.99
2025                             <entry>
2026                                 <paragraph>
2027                                     On a stick!
2028     <section ids="error-handling" names="error\ handling">
2029         <title auto="1" refid="id73">
2030             <generated classes="sectnum">
2031                 3
2032             Error Handling
2033         <paragraph>
2034             Any errors caught during processing will generate system messages.
2035         <paragraph>
2036             There should be five messages in the following, auto-generated
2037             section, "Docutils System Messages":
2038         <comment xml:space="preserve">
2039             section should be added by Docutils automatically
2040     <section classes="system-messages">
2041         <title>
2042             Docutils System Messages
2043         <system_message backrefs="id24" ids="id23" level="3" line="104" source="functional/input/data/standard.txt" type="ERROR">
2044             <paragraph>
2045                 Undefined substitution referenced: "problematic".
2046         <system_message backrefs="id84" ids="id83" level="3" line="391" source="functional/input/data/standard.txt" type="ERROR">
2047             <paragraph>
2048                 Unknown target name: "5".
2049         <system_message backrefs="id86" ids="id85" level="3" line="400" source="functional/input/data/standard.txt" type="ERROR">
2050             <paragraph>
2051                 Unknown target name: "nonexistent".
2052         <system_message backrefs="id88" ids="id87" level="3" line="427" source="functional/input/data/standard.txt" type="ERROR">
2053             <paragraph>
2054                 Unknown target name: "hyperlink reference without a target".
2055         <system_message backrefs="id90" ids="id89" level="3" line="440" source="functional/input/data/standard.txt" type="ERROR">
2056             <paragraph>
2057                 Duplicate target name, cannot be used as a unique reference: "duplicate target names".
2058         <system_message level="1" line="163" source="functional/input/data/standard.txt" type="INFO">
2059             <paragraph>
2060                 Hyperlink target "target" is not referenced.
2061         <system_message level="1" line="405" source="functional/input/data/standard.txt" type="INFO">
2062             <paragraph>
2063                 Hyperlink target "another-target" is not referenced.
2064         <system_message level="1" line="473" source="functional/input/data/standard.txt" type="INFO">
2065             <paragraph>
2066                 Hyperlink target "image-target-1" is not referenced.
2067         <system_message level="1" line="474" source="functional/input/data/standard.txt" type="INFO">
2068             <paragraph>
2069                 Hyperlink target "image-target-2" is not referenced.
2070         <system_message level="1" line="475" source="functional/input/data/standard.txt" type="INFO">
2071             <paragraph>
2072                 Hyperlink target "image-target-3" is not referenced.
2073         <system_message level="1" line="632" source="functional/input/data/standard.txt" type="INFO">
2074             <paragraph>
2075                 Hyperlink target "docutils" is not referenced.
2076         <system_message level="1" line="753" source="functional/input/data/standard.txt" type="INFO">
2077             <paragraph>
2078                 Hyperlink target "hyperlink targets" is not referenced.