| blob | 219892d3b6f5380b4f5897436623767c13279540 |
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 classes="field-name">
52 <field_name>
53 field name
54 <field_body>
55 <paragraph>
56 This is a "generic bibliographic field".
57 <field classes="field-name-2">
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
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
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
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
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://tools.ietf.org/html/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
518 <strong>
519 inline
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]_
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
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">
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 <paragraph>
1365 Tables may be given titles and additional arguments with the
1366 <emphasis>
1367 table
1369 directive:
1370 <table align="left">
1371 <title>
1372 left-aligned table
1373 <tgroup cols="2">
1374 <colspec colwidth="5">
1375 <colspec colwidth="5">
1376 <thead>
1377 <row>
1378 <entry>
1379 <paragraph>
1380 A
1381 <entry>
1382 <paragraph>
1383 not A
1384 <tbody>
1385 <row>
1386 <entry>
1387 <paragraph>
1388 False
1389 <entry>
1390 <paragraph>
1391 True
1392 <row>
1393 <entry>
1394 <paragraph>
1395 True
1396 <entry>
1397 <paragraph>
1398 False
1399 <table align="center">
1400 <title>
1401 center-aligned table
1402 <tgroup cols="2">
1403 <colspec colwidth="5">
1404 <colspec colwidth="5">
1405 <thead>
1406 <row>
1407 <entry>
1408 <paragraph>
1409 A
1410 <entry>
1411 <paragraph>
1412 not A
1413 <tbody>
1414 <row>
1415 <entry>
1416 <paragraph>
1417 False
1418 <entry>
1419 <paragraph>
1420 True
1421 <row>
1422 <entry>
1423 <paragraph>
1424 True
1425 <entry>
1426 <paragraph>
1427 False
1428 <table align="right">
1429 <title>
1430 right-aligned table
1431 <tgroup cols="2">
1432 <colspec colwidth="5">
1433 <colspec colwidth="5">
1434 <thead>
1435 <row>
1436 <entry>
1437 <paragraph>
1438 A
1439 <entry>
1440 <paragraph>
1441 not A
1442 <tbody>
1443 <row>
1444 <entry>
1445 <paragraph>
1446 False
1447 <entry>
1448 <paragraph>
1449 True
1450 <row>
1451 <entry>
1452 <paragraph>
1453 True
1454 <entry>
1455 <paragraph>
1456 False
1457 <paragraph>
1458 With the "widths" argument "auto" (or "class" value "colwidths-auto"),
1459 column widths are determined by the backend (if supported by the
1460 writer/backend).
1461 <target refid="target1">
1462 <target refid="target2">
1463 <table classes="colwidths-auto" ids="target2 target1" names="target2 target1">
1464 <tgroup cols="3">
1465 <colspec colwidth="7">
1466 <colspec colwidth="7">
1467 <colspec colwidth="10">
1468 <thead>
1469 <row>
1470 <entry>
1471 <paragraph>
1472 A
1473 <entry>
1474 <paragraph>
1475 B
1476 <entry>
1477 <paragraph>
1478 A or B
1479 <tbody>
1480 <row>
1481 <entry>
1482 <paragraph>
1483 False
1484 <entry>
1485 <paragraph>
1486 False
1487 <entry>
1488 <paragraph>
1489 False
1490 <row>
1491 <entry>
1492 <paragraph>
1493 True
1494 <entry>
1495 <paragraph>
1496 False
1497 <entry>
1498 <paragraph>
1499 True
1500 <row>
1501 <entry>
1502 <paragraph>
1503 False
1504 <entry>
1505 <paragraph>
1506 True
1507 <entry>
1508 <paragraph>
1509 True
1510 <row>
1511 <entry>
1512 <paragraph>
1513 True
1514 <entry>
1515 <paragraph>
1516 True
1517 <entry>
1518 <paragraph>
1519 True
1520 <section ids="admonitions" names="admonitions">
1521 <title auto="1" refid="id76">
1522 <generated classes="sectnum">
1523 2.14.3
1524 Admonitions
1525 <attention>
1526 <paragraph>
1527 Directives at large.
1528 <caution>
1529 <paragraph>
1530 Don't take any wooden nickels.
1531 <danger>
1532 <paragraph>
1533 Mad scientist at work!
1534 <error>
1535 <paragraph>
1536 Does not compute.
1537 <hint>
1538 <paragraph>
1539 It's bigger than a bread box.
1540 <important>
1541 <bullet_list bullet="-">
1542 <list_item>
1543 <paragraph>
1544 Wash behind your ears.
1545 <list_item>
1546 <paragraph>
1547 Clean up your room.
1548 <list_item>
1549 <paragraph>
1550 Call your mother.
1551 <list_item>
1552 <paragraph>
1553 Back up your data.
1554 <note>
1555 <paragraph>
1556 This is a note.
1557 <tip>
1558 <paragraph>
1559 15% if the service is good.
1560 <warning>
1561 <paragraph>
1562 Strong prose may provoke extreme mental exertion.
1563 Reader discretion is strongly advised.
1564 <admonition classes="admonition-and-by-the-way">
1565 <title>
1566 And, by the way...
1567 <paragraph>
1568 You can make up your own admonition too.
1569 <target ids="docutils" names="docutils" refuri="http://docutils.sourceforge.net/">
1570 <section ids="topics-sidebars-and-rubrics" names="topics,\ sidebars,\ and\ rubrics">
1571 <title auto="1" refid="id77">
1572 <generated classes="sectnum">
1573 2.14.4
1574 Topics, Sidebars, and Rubrics
1575 <paragraph>
1576 <emphasis>
1577 Sidebars
1578 are like miniature, parallel documents.
1579 <sidebar>
1580 <title>
1581 Sidebar Title
1582 <subtitle>
1583 Optional Subtitle
1584 <paragraph>
1585 This is a sidebar. It is for text outside the flow of the main
1586 text.
1587 <rubric>
1588 This is a rubric inside a sidebar
1589 <paragraph>
1590 Sidebars often appear beside the main text with a border and a different
1591 background or font color.
1592 <paragraph>
1593 A
1594 <emphasis>
1595 topic
1596 is like a block quote with a title, or a self-contained section
1597 with no subsections.
1598 <topic>
1599 <title>
1600 Topic Title
1601 <paragraph>
1602 This is a topic.
1603 <paragraph>
1604 A
1605 <emphasis>
1606 rubric
1607 is like an informal heading that doesn't correspond to the
1608 document's structure. It is typically highlighted in red (hence the name).
1609 <rubric>
1610 This is a rubric
1611 <paragraph>
1612 Topics and rubrics can be used at places where a
1613 <reference name="section title" refid="section-title">
1614 section title
1615 is not
1616 allowed (e.g. inside a directive).
1617 <section ids="target-footnotes" names="target\ footnotes">
1618 <title auto="1" refid="id78">
1619 <generated classes="sectnum">
1620 2.14.5
1621 Target Footnotes
1622 <footnote auto="1" backrefs="id26 id27 id28 id31" ids="id25" names="TARGET_NOTE:\ id25">
1623 <label>
1624 5
1625 <paragraph>
1626 <reference refuri="http://www.python.org/">
1627 http://www.python.org/
1628 <footnote auto="1" backrefs="id30" ids="id29" names="TARGET_NOTE:\ id29">
1629 <label>
1630 6
1631 <paragraph>
1632 <reference refuri="http://pygments.org/">
1633 http://pygments.org/
1634 <footnote auto="1" backrefs="id33" ids="id32" names="TARGET_NOTE:\ id32">
1635 <label>
1636 7
1637 <paragraph>
1638 <reference refuri="http://docutils.sourceforge.net/">
1639 http://docutils.sourceforge.net/
1640 <section ids="replacement-text" names="replacement\ text">
1641 <title auto="1" refid="id79">
1642 <generated classes="sectnum">
1643 2.14.6
1644 Replacement Text
1645 <paragraph>
1646 I recommend you try
1647 <reference refuri="http://www.python.org/">
1648 Python,
1649 <emphasis>
1650 the
1651 best language around
1653 <footnote_reference auto="1" ids="id28" refid="id25">
1654 5
1655 .
1656 <substitution_definition names="Python">
1657 Python,
1658 <emphasis>
1659 the
1660 best language around
1661 <section ids="compound-paragraph" names="compound\ paragraph">
1662 <title auto="1" refid="id80">
1663 <generated classes="sectnum">
1664 2.14.7
1665 Compound Paragraph
1666 <compound classes="some-class">
1667 <paragraph>
1668 Compound 1, paragraph 1.
1669 <paragraph>
1670 Compound 1, paragraph 2.
1671 <bullet_list bullet="*">
1672 <list_item>
1673 <paragraph>
1674 Compound 1, list item one.
1675 <list_item>
1676 <paragraph>
1677 Compound 1, list item two.
1678 <paragraph>
1679 Another compound statement:
1680 <compound>
1681 <paragraph>
1682 Compound 2, a literal block:
1683 <literal_block xml:space="preserve">
1684 Compound 2, literal.
1685 <paragraph>
1686 Compound 2, this is a test.
1687 <compound>
1688 <paragraph>
1689 Compound 3, only consisting of one paragraph.
1690 <compound>
1691 <literal_block xml:space="preserve">
1692 Compound 4.
1693 This one starts with a literal block.
1694 <paragraph>
1695 Compound 4, a paragraph.
1696 <paragraph>
1697 Now something
1698 <emphasis>
1699 really
1700 perverted -- a nested compound block. This is
1701 just to test that it works at all; the results don't have to be
1702 meaningful.
1703 <compound>
1704 <paragraph>
1705 Compound 5, block 1 (a paragraph).
1706 <compound>
1707 <paragraph>
1708 Compound 6, block 2 in compound 5.
1709 <paragraph>
1710 Compound 6, another paragraph.
1711 <paragraph>
1712 Compound 5, block 3 (a paragraph).
1713 <compound>
1714 <paragraph>
1715 Compound 7, with a table inside:
1716 <table>
1717 <tgroup cols="3">
1718 <colspec colwidth="20">
1719 <colspec colwidth="20">
1720 <colspec colwidth="20">
1721 <tbody>
1722 <row>
1723 <entry>
1724 <paragraph>
1725 Left cell, first
1726 paragraph.
1727 <paragraph>
1728 Left cell, second
1729 paragraph.
1730 <entry>
1731 <paragraph>
1732 Middle cell,
1733 consisting of
1734 exactly one
1735 paragraph.
1736 <entry>
1737 <paragraph>
1738 Right cell.
1739 <paragraph>
1740 Paragraph 2.
1741 <paragraph>
1742 Paragraph 3.
1743 <paragraph>
1744 Compound 7, a paragraph after the table.
1745 <paragraph>
1746 Compound 7, another paragraph.
1747 <section ids="parsed-literal-blocks" names="parsed\ literal\ blocks">
1748 <title auto="1" refid="id81">
1749 <generated classes="sectnum">
1750 2.14.8
1751 Parsed Literal Blocks
1752 <literal_block xml:space="preserve">
1753 This is a parsed literal block.
1754 This line is indented. The next line is blank.
1756 Inline markup is supported, e.g.
1757 <emphasis>
1758 emphasis
1759 ,
1760 <strong>
1761 strong
1762 ,
1763 <literal>
1764 literal
1765 text
1766 ,
1767 <subscript>
1768 sub-
1769 and
1770 <superscript>
1771 super
1772 scripts,
1773 inline formulas:
1774 <math>
1775 A = 2 \pi r^2
1776 ,
1777 footnotes
1778 <footnote_reference ids="id22" refid="id8">
1779 1
1780 ,
1781 <target ids="hyperlink-targets" names="hyperlink\ targets">
1782 hyperlink targets
1783 , and
1784 <reference name="references" refuri="http://www.python.org/">
1785 references
1786 <target ids="references" names="references" refuri="http://www.python.org/">
1787 .
1788 <section ids="code" names="code">
1789 <title auto="1" refid="id82">
1790 <generated classes="sectnum">
1791 2.14.9
1792 Code
1793 <paragraph>
1794 Blocks of source code can be set with the
1795 <title_reference>
1796 code
1797 directive. If the code
1798 language is specified, the content is parsed and tagged by the
1799 <reference name="Pygments" refuri="http://pygments.org/">
1800 Pygments
1802 <footnote_reference auto="1" ids="id30" refid="id29">
1803 6
1805 syntax highlighter and can be formatted with a style sheet. (Code parsing
1806 is turned off using the
1807 <literal>
1808 syntax-highlight
1809 config setting in the test
1810 conversions in order to get identical results with/without installed
1811 Pygments highlighter.)
1812 <literal_block classes="code python" xml:space="preserve">
1813 print 'This is Python code.'
1814 <paragraph>
1815 The
1816 <literal>
1817 :number-lines:
1818 option (with optional start value) generates line
1819 numbers:
1820 <literal_block classes="code python" xml:space="preserve">
1821 <inline classes="ln">
1822 8
1823 # print integers from 0 to 9:
1824 <inline classes="ln">
1825 9
1826 for i in range(10):
1827 <inline classes="ln">
1828 10
1829 print i
1830 <paragraph>
1831 For inline code snippets, there is the
1832 <title_reference>
1833 code
1834 role, which can be used
1835 directly (the code will not be parsed/tagged, as the language is not known)
1836 or as base for special code roles, e.g. the LaTeX code in the next
1837 paragraph.
1838 <paragraph>
1839 Docutils uses LaTeX syntax for math directives and roles:
1840 <literal classes="code tex">
1841 \alpha = f(x)
1842 prints
1843 <math>
1844 \alpha = f(x)
1845 .
1846 <paragraph>
1847 The
1848 <literal>
1849 :code:
1850 option of the
1851 <title_reference>
1852 include
1853 directive sets the included content
1854 as a code block, here the rst file
1855 <literal>
1856 header_footer.txt
1857 with line numbers:
1858 <literal_block classes="code rst" source="functional/input/data/header_footer.txt" xml:space="preserve">
1859 <inline classes="ln">
1860 1
1861 .. header:: Document header
1862 <inline classes="ln">
1863 2
1864 .. footer:: Document footer
1865 <target ids="pygments" names="pygments" refuri="http://pygments.org/">
1866 <section ids="substitution-definitions" names="substitution\ definitions">
1867 <title auto="1" refid="id65">
1868 <generated classes="sectnum">
1869 2.15
1870 Substitution Definitions
1871 <paragraph>
1872 An inline image (
1873 <image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
1874 ) example:
1875 <substitution_definition names="EXAMPLE">
1876 <image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
1877 <paragraph>
1878 (Substitution definitions are not visible in the HTML source.)
1879 <section ids="comments" names="comments">
1880 <title auto="1" refid="id66">
1881 <generated classes="sectnum">
1882 2.16
1883 Comments
1884 <paragraph>
1885 Here's one:
1886 <comment xml:space="preserve">
1887 Comments begin with two dots and a space. Anything may
1888 follow, except for the syntax of footnotes, hyperlink
1889 targets, directives, or substitution definitions.
1891 Double-dashes -- "--" -- must be escaped somehow in HTML output.
1893 Comments may contain non-ASCII characters: ä ö ü æ ø å
1894 <paragraph>
1895 (View the HTML source to see the comment.)
1896 <section ids="raw-text" names="raw\ text">
1897 <title auto="1" refid="id67">
1898 <generated classes="sectnum">
1899 2.17
1900 Raw text
1901 <paragraph>
1902 This does not necessarily look nice, because there may be missing white space.
1903 <paragraph>
1904 It's just there to freeze the behavior.
1905 <raw format="html latex" xml:space="preserve">
1906 A test.
1907 <raw format="html latex" xml:space="preserve">
1908 Second test.
1909 <raw classes="myclass" format="html latex" xml:space="preserve">
1910 Another test with myclass set.
1911 <paragraph>
1912 This is the
1913 <raw classes="myrawroleclass" format="html latex" xml:space="preserve">
1914 fourth test
1915 with myrawroleclass set.
1916 <raw format="html" xml:space="preserve">
1917 Fifth test in HTML.<br />Line two.
1918 <raw format="latex" xml:space="preserve">
1919 Fifth test in LaTeX.\\Line two.
1920 <section ids="container" names="container">
1921 <title auto="1" refid="id68">
1922 <generated classes="sectnum">
1923 2.18
1924 Container
1925 <container classes="custom">
1926 <paragraph>
1927 paragraph 1
1928 <paragraph>
1929 paragraph 2
1930 <section ids="colspanning-tables" names="colspanning\ tables">
1931 <title auto="1" refid="id69">
1932 <generated classes="sectnum">
1933 2.19
1934 Colspanning tables
1935 <paragraph>
1936 This table has a cell spanning two columns:
1937 <table>
1938 <tgroup cols="3">
1939 <colspec colwidth="5">
1940 <colspec colwidth="5">
1941 <colspec colwidth="6">
1942 <thead>
1943 <row>
1944 <entry morecols="1">
1945 <paragraph>
1946 Inputs
1947 <entry>
1948 <paragraph>
1949 Output
1950 <row>
1951 <entry>
1952 <paragraph>
1953 A
1954 <entry>
1955 <paragraph>
1956 B
1957 <entry>
1958 <paragraph>
1959 A or B
1960 <tbody>
1961 <row>
1962 <entry>
1963 <paragraph>
1964 False
1965 <entry>
1966 <paragraph>
1967 False
1968 <entry>
1969 <paragraph>
1970 False
1971 <row>
1972 <entry>
1973 <paragraph>
1974 True
1975 <entry>
1976 <paragraph>
1977 False
1978 <entry>
1979 <paragraph>
1980 True
1981 <row>
1982 <entry>
1983 <paragraph>
1984 False
1985 <entry>
1986 <paragraph>
1987 True
1988 <entry>
1989 <paragraph>
1990 True
1991 <row>
1992 <entry>
1993 <paragraph>
1994 True
1995 <entry>
1996 <paragraph>
1997 True
1998 <entry>
1999 <paragraph>
2000 True
2001 <section ids="rowspanning-tables" names="rowspanning\ tables">
2002 <title auto="1" refid="id70">
2003 <generated classes="sectnum">
2004 2.20
2005 Rowspanning tables
2006 <paragraph>
2007 Here's a table with cells spanning several rows:
2008 <table>
2009 <tgroup cols="3">
2010 <colspec colwidth="24">
2011 <colspec colwidth="12">
2012 <colspec colwidth="18">
2013 <thead>
2014 <row>
2015 <entry>
2016 <paragraph>
2017 Header row, column 1
2018 (header rows optional)
2019 <entry>
2020 <paragraph>
2021 Header 2
2022 <entry>
2023 <paragraph>
2024 Header 3
2025 <tbody>
2026 <row>
2027 <entry>
2028 <paragraph>
2029 body row 1, column 1
2030 <entry>
2031 <paragraph>
2032 column 2
2033 <entry>
2034 <paragraph>
2035 column 3
2036 <row>
2037 <entry>
2038 <paragraph>
2039 body row 2
2040 <entry morerows="1">
2041 <paragraph>
2042 Cells may
2043 span rows.
2044 <entry morerows="1">
2045 <paragraph>
2046 Another
2047 rowspanning
2048 cell.
2049 <row>
2050 <entry>
2051 <paragraph>
2052 body row 3
2053 <section ids="complex-tables" names="complex\ tables">
2054 <title auto="1" refid="id71">
2055 <generated classes="sectnum">
2056 2.21
2057 Complex tables
2058 <paragraph>
2059 Here's a complex table, which should test all features.
2060 <table>
2061 <tgroup cols="4">
2062 <colspec colwidth="24">
2063 <colspec colwidth="12">
2064 <colspec colwidth="10">
2065 <colspec colwidth="10">
2066 <thead>
2067 <row>
2068 <entry>
2069 <paragraph>
2070 Header row, column 1
2071 (header rows optional)
2072 <entry>
2073 <paragraph>
2074 Header 2
2075 <entry>
2076 <paragraph>
2077 Header 3
2078 <entry>
2079 <paragraph>
2080 Header 4
2081 <tbody>
2082 <row>
2083 <entry>
2084 <paragraph>
2085 body row 1, column 1
2086 <entry>
2087 <paragraph>
2088 column 2
2089 <entry>
2090 <paragraph>
2091 column 3
2092 <entry>
2093 <paragraph>
2094 column 4
2095 <row>
2096 <entry>
2097 <paragraph>
2098 body row 2
2099 <entry morecols="2">
2100 <paragraph>
2101 Cells may span columns.
2102 <row>
2103 <entry>
2104 <paragraph>
2105 body row 3
2106 <entry morerows="1">
2107 <paragraph>
2108 Cells may
2109 span rows.
2110 <paragraph>
2111 Paragraph.
2112 <entry morecols="1" morerows="1">
2113 <bullet_list bullet="-">
2114 <list_item>
2115 <paragraph>
2116 Table cells
2117 <list_item>
2118 <paragraph>
2119 contain
2120 <list_item>
2121 <paragraph>
2122 body elements.
2123 <row>
2124 <entry>
2125 <paragraph>
2126 body row 4
2127 <row>
2128 <entry>
2129 <paragraph>
2130 body row 5
2131 <entry morecols="1">
2132 <paragraph>
2133 Cells may also be
2134 empty:
2135 <literal>
2136 -->
2137 <entry>
2138 <section ids="list-tables" names="list\ tables">
2139 <title auto="1" refid="id72">
2140 <generated classes="sectnum">
2141 2.22
2142 List Tables
2143 <paragraph>
2144 Here's a list table exercising all features:
2145 <table classes="colwidths-given test">
2146 <title>
2147 list table with integral header
2148 <tgroup cols="3">
2149 <colspec colwidth="10" stub="1">
2150 <colspec colwidth="20">
2151 <colspec colwidth="30">
2152 <thead>
2153 <row>
2154 <entry>
2155 <paragraph>
2156 Treat
2157 <entry>
2158 <paragraph>
2159 Quantity
2160 <entry>
2161 <paragraph>
2162 Description
2163 <tbody>
2164 <row>
2165 <entry>
2166 <paragraph>
2167 Albatross
2168 <entry>
2169 <paragraph>
2170 2.99
2171 <entry>
2172 <paragraph>
2173 On a stick!
2174 <row>
2175 <entry>
2176 <paragraph>
2177 Crunchy Frog
2178 <entry>
2179 <paragraph>
2180 1.49
2181 <entry>
2182 <paragraph>
2183 If we took the bones out, it wouldn't be
2184 crunchy, now would it?
2185 <row>
2186 <entry>
2187 <paragraph>
2188 Gannet Ripple
2189 <entry>
2190 <paragraph>
2191 1.99
2192 <entry>
2193 <paragraph>
2194 On a stick!
2195 <table align="center">
2196 <title>
2197 center aligned list table
2198 <tgroup cols="2">
2199 <colspec colwidth="50">
2200 <colspec colwidth="50">
2201 <tbody>
2202 <row>
2203 <entry>
2204 <paragraph>
2205 Albatross
2206 <entry>
2207 <paragraph>
2208 2.99
2209 <row>
2210 <entry>
2211 <paragraph>
2212 Crunchy Frog
2213 <entry>
2214 <paragraph>
2215 1.49
2216 <row>
2217 <entry>
2218 <paragraph>
2219 Gannet Ripple
2220 <entry>
2221 <paragraph>
2222 1.99
2223 <section ids="error-handling" names="error\ handling">
2224 <title auto="1" refid="id73">
2225 <generated classes="sectnum">
2226 3
2227 Error Handling
2228 <paragraph>
2229 Any errors caught during processing will generate system messages.
2230 <paragraph>
2231 There should be five messages in the following, auto-generated
2232 section, "Docutils System Messages":
2233 <comment xml:space="preserve">
2234 section should be added by Docutils automatically
2235 <section classes="system-messages">
2236 <title>
2237 Docutils System Messages
2238 <system_message backrefs="id24" ids="id23" level="3" line="104" source="functional/input/data/standard.txt" type="ERROR">
2239 <paragraph>
2240 Undefined substitution referenced: "problematic".
2241 <system_message backrefs="id84" ids="id83" level="3" line="391" source="functional/input/data/standard.txt" type="ERROR">
2242 <paragraph>
2243 Unknown target name: "5".
2244 <system_message backrefs="id86" ids="id85" level="3" line="400" source="functional/input/data/standard.txt" type="ERROR">
2245 <paragraph>
2246 Unknown target name: "nonexistent".
2247 <system_message backrefs="id88" ids="id87" level="3" line="427" source="functional/input/data/standard.txt" type="ERROR">
2248 <paragraph>
2249 Unknown target name: "hyperlink reference without a target".
2250 <system_message backrefs="id90" ids="id89" level="3" line="440" source="functional/input/data/standard.txt" type="ERROR">
2251 <paragraph>
2252 Duplicate target name, cannot be used as a unique reference: "duplicate target names".
2253 <system_message level="1" line="163" source="functional/input/data/standard.txt" type="INFO">
2254 <paragraph>
2255 Hyperlink target "target" is not referenced.
2256 <system_message level="1" line="405" source="functional/input/data/standard.txt" type="INFO">
2257 <paragraph>
2258 Hyperlink target "another-target" is not referenced.
2259 <system_message level="1" line="473" source="functional/input/data/standard.txt" type="INFO">
2260 <paragraph>
2261 Hyperlink target "image-target-1" is not referenced.
2262 <system_message level="1" line="474" source="functional/input/data/standard.txt" type="INFO">
2263 <paragraph>
2264 Hyperlink target "image-target-2" is not referenced.
2265 <system_message level="1" line="475" source="functional/input/data/standard.txt" type="INFO">
2266 <paragraph>
2267 Hyperlink target "image-target-3" is not referenced.
2268 <system_message level="1" line="639" source="functional/input/data/standard.txt" type="INFO">
2269 <paragraph>
2270 Hyperlink target "target1" is not referenced.
2271 <system_message level="1" line="640" source="functional/input/data/standard.txt" type="INFO">
2272 <paragraph>
2273 Hyperlink target "target2" is not referenced.
2274 <system_message level="1" line="685" source="functional/input/data/standard.txt" type="INFO">
2275 <paragraph>
2276 Hyperlink target "docutils" is not referenced.
2277 <system_message level="1" line="806" source="functional/input/data/standard.txt" type="INFO">
2278 <paragraph>
2279 Hyperlink target "hyperlink targets" is not referenced.