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