Examples of Syntax Constructs
David Goodger
123 Example Street Example, EX Canada A1B 2C3
Me
Myself
I
This is a "generic bibliographic field".
Generic bibliographic fields may contain multiple body elements.
Like this.
Dedication
For Docutils users & co-developers.
Abstract
This is a test document, containing at least one example of each reStructuredText construct.
Section Subtitle
Lone subsections are converted to a section subtitle by a transform activated with the --section-subtitles command line option or the sectsubtitle-xform configuration value.
1.2 Empty Section 1.3 TransitionsHere's a transition:
It divides the section. Transitions may also occur between sections:
2 Body Elements 2.1 ParagraphsA paragraph.
2.1.1 Inline MarkupParagraphs contain text and may contain inline markup: emphasis, strong emphasis, inline literals, standalone hyperlinks (http://www.python.org), external hyperlinks (Python [7]), internal cross-references (example), external hyperlinks with embedded URIs (Python web site), anonymous hyperlink references [7] (a second reference [14]), footnote references (manually numbered [1], anonymous auto-numbered [3], labeled auto-numbered [2], or symbolic [*]), citation references (see [CIT2002]), substitution references ( & a trimmed heart (U+2665):â¥), and inline hyperlink targets (see Targets below for a reference back to here). Character-level inline markup is also possible (although exceedingly ugly!) in reStructuredText. Problems are indicated by |problematic| text (generated by processing errors; this one is intentional). Here is a reference to the doctitle and the subtitle.
The default role for interpreted text is Title Reference. Here are some explicit interpreted text roles: a PEP reference (PEP 287); an RFC reference (RFC 2822); an abbreviation (abb.), an acronym (reST), code (print "hello world"); a subscript; a superscript and explicit roles for Docutils' standard inline markup.
Let's test wrapping and whitespace significance in inline literals: This is an example of --inline-literal --text, --including some-- strangely--hyphenated-words. Adjust-the-width-of-your-browser-window to see how the text is wrapped. -- ---- -------- Now note the spacing between the words of this sentence (words should be grouped in pairs).
If the --pep-references option was supplied, there should be a live link to PEP 258 here.
2.2 Bullet ListsA bullet list
Nested bullet list.
Nested item 2.
Item 2.
Paragraph 2 of item 2.
Nested bullet list.
Nested item 2.
Third level.
Item 2.
Nested item 3.
This nested list should be compacted by the HTML writer.
Arabic numerals.
lower alpha)
(lower roman)
upper alpha.
upper roman)
Lists that don't start at 1:
Three
Four
C
D
iii
iv
Definition
Definition paragraph 1.
Definition paragraph 2.
Definition
Definition
Field lists map field names to field bodies, like database records. They are often part of an extension syntax. They are an unambiguous variant of RFC 2822 fields.
The field marker is a colon, the field name, and a colon.
The field body may contain one or more body elements, indented relative to the field marker.
This paragraph has the credits class set. (This is actually not about credits but just for ensuring that the class attribute doesn't get stripped away.)
For listing command-line options:
command-line option "a"
options can have arguments and long descriptions
options can be long, too
long options can also have arguments
DOS/VMS-style option
The description can also start on the next line.
The description may contain multiple body elements, regardless of where it starts.
Multiple options are an "option group".
Commonly-seen: short & long options.
Multiple options with arguments.
Option argumens must start with a letter or be wrapped in angle brackets.
Angle brackets are also required if an option expects more than one argument.
There must be at least two spaces between the option and the description.
2.7 Literal BlocksLiteral blocks are indicated with a double-colon ("::") at the end of the preceding paragraph (over there -->). They can be indented:
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
Or they can be quoted without indentation:
>> Great idea! > > Why didn't I think of that?2.8 Line Blocks
This section tests line blocks. Line blocks are body elements which consist of lines and other line blocks. Nested line blocks cause indentation.
This is a line block. It ends with a blank line.
New lines begin with a vertical bar ("|").
Line breaks and initial indent are significant, and preserved.
Continuation lines are also possible. A long line that is intended to wrap should begin with a space in place of the vertical bar.
The left edge of a continuation line need not be aligned with the left edge of the text above it.
This is a second line block.
Blank lines are permitted internally, but they must begin with a "|".
Another line block, surrounded by paragraphs:
And it's no good waiting by the window
It's no good waiting for the sun
Please believe me, the things you dream of
They don't fall in the lap of no-one
Take it away, Eric the Orchestra Leader!
A one, two, a one two three four
Half a bee, philosophically,
must, ipso facto, half not be.
But half the bee has got to be,
vis a vis its entity. D'you see?
But can a bee be said to be
or not to be an entire bee,
when half the bee is not a bee,
due to some ancient injury?
Singing...
A line block, like the following poem by Christian Morgenstern, can also be centre-aligned:
Die Trichter
Zwei Trichter wandeln durch die Nacht.
Durch ihres Rumpfs verengten Schacht
flieÃt weiÃes Mondlicht
still und heiter
auf  ihren
Waldweg
u. s.
w.
2.9 Block QuotesBlock quotes consist of indented body elements:
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
âAnne Elk (Miss)
The language of a quote (like any other object) can be specified by a class attribute:
2.10 Doctest BlocksReStructuredText est un langage de balisage léger utilisé notamment dans la documentation du langage Python.
>>> print 'Python-specific usage examples; begun with ">>>"' Python-specific usage examples; begun with ">>>" >>> print '(cut and pasted from interactive Python sessions)' (cut and pasted from interactive Python sessions)2.12 Citations [CIT2002] (1,2)
Citations are text-labeled footnotes. They may be rendered separately and differently from footnotes.
Here's a reference to the above, [CIT2002], and a [nonexistent]_ citation.
2.13 TargetsThis paragraph is pointed to by the explicit "example" target. A reference can be found under Inline Markup, above. Inline hyperlink targets are also possible.
Section headers are implicit targets, referred to by name. See Targets, which is a subsection of Body Elements.
Explicit external targets are interpolated into references such as "Python [7]".
Targets may be indirect and anonymous. Thus this phrase may also refer to the Targets section.
Here's a `hyperlink reference without a target`_, which generates an error.
2.13.1 Duplicate Target NamesDuplicate names in section headers or other implicit targets will generate "info" (level-1) system messages. Duplicate names in explicit targets will generate "warning" (level-2) system messages.
2.13.2 Duplicate Target NamesSince there are two "Duplicate Target Names" section headers, we cannot uniquely refer to either of them by name. If we try to (like this: `Duplicate Target Names`_), an error is generated.
2.14 DirectivesThese are just a sample of the many reStructuredText Directives. For others, please see reStructuredText Directives [15].
2.14.1 Document PartsAn example of the "contents" directive can be seen above this section (a local, untitled table of contents) and at the beginning of the document (a document-wide table of contents).
2.14.2 Images and FiguresAn image directive (also clickable -- a hyperlink reference):
Image with multiple IDs:
A centered image:
A left-aligned image:
This paragraph might flow around the image. The specific behavior depends upon the style sheet and the browser or rendering software used.
A right-aligned image:
This paragraph might flow around the image. The specific behavior depends upon the style sheet and the browser or rendering software used.
For inline images see Substitution Definitions.
Image size:
An image 2 em wide:
An image 2 cm wide and 15 pixel high:
Relative units allow adaption of the image to the screen or paper size. An image occupying 50% of the line width:
A figure is an image with a caption and/or a legend. With page-based output media, figures might float to a different position if this helps the page layout.
Plaintext markup syntax and parser system.
re
Revised, revisited, based on 're' module.
Structured
Structure-enhanced text, structuredtext.
Text
Well it is, isn't it?
This paragraph is also part of the legend.
A left-aligned figure, 70% wide:
This is the caption.
This is the legend.
The legend may consist of several paragraphs.
This paragraph might flow around the figure.
The specific behavior depends upon the style sheet and the browser or rendering software used.
A centred figure, 40% wide:
This is the caption.
This is the legend.
The legend may consist of several paragraphs.
This paragraph might flow around the figure.
The specific behavior depends upon the style sheet and the browser or rendering software used.
A right-aligned figure:
This is the caption.
This is the legend.
The legend may consist of several paragraphs.
This paragraph might flow around the figure. The specific behavior depends upon the style sheet and the browser or rendering software used.
2.14.3 TablesTables may be given titles and additional arguments with the table directive:
left-aligned tableA
not A
False
True
True
False
center-aligned tableA
not A
False
True
True
False
right-aligned tableA
not A
False
True
True
False
With the "widths" argument "auto" (or "class" value "colwidths-auto"), column widths are determined by the backend (if supported by the writer/backend).
A
B
A or B
False
False
False
True
False
True
False
True
True
True
True
True
2.14.4 AdmonitionsAttention!
Directives at large.
Caution!
Don't take any wooden nickels.
!DANGER!
Mad scientist at work!
Error
Does not compute.
Hint
It's bigger than a bread box.
Important
Wash behind your ears.
Clean up your room.
Call your mother.
Back up your data.
Note
This is a note.
Tip
15% if the service is good.
Warning
Strong prose may provoke extreme mental exertion. Reader discretion is strongly advised.
And, by the way...
You can make up your own admonition too.
2.14.5 Topics, Sidebars, and RubricsSidebars are like miniature, parallel documents.
A topic is like a block quote with a title, or a self-contained section with no subsections.
Topic Title
This is a topic.
A rubric is like an informal heading that doesn't correspond to the document's structure. It is typically highlighted in red (hence the name).
This is a rubric
Topics and rubrics can be used at places where a section title is not allowed (e.g. inside a directive).
2.14.7 Replacement TextI recommend you try Python, the best language around [7].
2.14.8 Compound ParagraphThe compound directive is used to create a "compound paragraph", which is a single logical paragraph containing multiple physical body elements. For example:
The 'rm' command is very dangerous. If you are logged in as root and enter
cd / rm -rf *
you will erase the entire contents of your file system.
Test the handling and display of compound paragraphs:
Compound 2, paragraph 1,
compound 2, paragraph 2,
list item 1,
list item 2,
compound 2, paragraph 3.
Compound 3, only consisting of one paragraph.
Compound 4. This one starts with a literal block.
Compound 4, paragraph following the literal block.
Now something really perverted -- a nested compound block. This is just to test that it works at all; the results don't have to be meaningful.
Compound 5, block 1 (a paragraph).
Compound 6 is block 2 in compound 5.
Compound 6, another paragraph.
Compound 5, block 3 (a paragraph).
Compound 7, tests the inclusion of various block-level elements in one logical paragraph. First a table,
Left cell, first paragraph.
Left cell, second paragraph.
Middle cell, consisting of exactly one paragraph.
Right cell.
Paragraph 2.
Paragraph 3.
followed by a paragraph. This physical paragraph is actually a continuation of the paragraph before the table. It is followed by
a quote and
an enumerated list,
a paragraph,
option list,
a paragraph,
list,
a paragraph,
list,
a paragraph, an image:
a paragraph,
a paragraph followed by a comment,
a paragraph, a
Note
with content
and the final paragraph of the compound 7.
2.14.9 Parsed Literal BlocksThis is a parsed literal block.
This line is indented. The next line is blank.
Inline markup is supported, e.g. emphasis, strong, literal
text, sub- and superscripts,
inline formulas:
A
=
2
Ï
r
2
,
footnotes [1], hyperlink targets, and references.2.14.10 Code
Blocks of source code can be set with the code directive. If the code language is specified, the content is parsed and tagged by the Pygments [8] syntax highlighter and can be formatted with a style sheet. (Code parsing is turned off using the syntax-highlight config setting in the test conversions in order to get identical results with/without installed Pygments highlighter.)
print 'This is Python code.'The :number-lines: option (with optional start value) generates line numbers:
8# print integers from 0 to 9:9for i in range(10):10print i
For inline code snippets, there is the code role, which can be used directly (the code will not be parsed/tagged, as the language is not known) or as base for special code roles, e.g. the LaTeX code in the next paragraph.
Docutils uses LaTeX syntax for math directives and roles: \alpha = f(x) prints α = f ( x ) .
The :code: option of the include directive sets the included content as a code block, here the rst file header_footer.rst with line numbers:
12.14.11 Meta.. header:: Document header2.. footer:: Document footer
The âmetaâ directive [16] is used to specify metadata to be stored in, e.g., HTML META tags or ODT file properties.
2.15 Substitution DefinitionsAn inline image () example:
A Unicode example:
(Substitution definitions are only visible in the rST source.)
2.17 Raw textThis does not necessarily look nice, because there may be missing white space.
It's just there to freeze the behavior.
A test.Second test.Another test with myclass set.
This is the fourth test with myrawroleclass set.
Fifth test in HTML.This table has a cell spanning two columns:
Inputs
Output
A
B
A or B
False
False
False
True
False
True
False
True
True
True
True
True
2.20 Rowspanning tablesHere's a table with cells spanning several rows:
Header row, column 1 (header rows optional)
Header 2
Header 3
body row 1, column 1
column 2
column 3
body row 2
Cells may span rows.
Another rowspanning cell.
body row 3
2.21 Complex tablesHere's a complex table, which should test all features.
Header row, column 1 (header rows optional)
Header 2
Header 3
Header 4
body row 1, column 1
column 2
column 3
column 4
body row 2
Cells may span columns.
body row 3
Cells may span rows.
Paragraph.
Table cells
contain
body elements.
body row 4
body row 5
Cells may also be empty: -->
2.22 List TablesHere's a list table exercising all features:
list table with integral headerTreat
Quantity
Description
Albatross
2.99
On a stick!
Crunchy Frog
1.49
If we took the bones out, it wouldn't be crunchy, now would it?
Gannet Ripple
1.99
On a stick!
center aligned list tableAlbatross
2.99
Crunchy Frog
1.49
Gannet Ripple
1.99
2.23 Custom RolesA role based on an existing role.
one two three
A new role.
one two three
A role with class attribute.
interpreted text
A language-switching role:
Let's count in German eins zwei drei.
A role with multiple class attributes, styled with raw directives:
The following works in most browsers but does not validate (<style> is only allowed in the document head):
.. raw:: html
<style type="text/css"><!--
.green {color: green;}
.sc {font-variant: small-caps;}
--></style>
British colourful text in small-caps.
Use only meta keywords recognized by HTML 5. Add HTML5-compatible meta tags for docinfo items "authors", "date", and "copyright".
Add a viewport meta tag [17] to tell mobile browsers to use the device-width as viewport.
Set table column widths with <style="width: ...">, not "width" argument.
Horizontal alignment of table heads with CSS.
Do not drop paragraph elements, use CSS rules to prevent unwanted vertical space.
Put subtitles in <p> elements.
Use the new semantic tags <main>, <section>, <header>, <footer>, <aside>, <figure>, and <figcaption>. See minimal.css and responsive.css for styling rule examples.
Change the initial_header_level setting default to "2", as browsers use the same style for <h1> and <h2> when nested in a <section> [18].
Use HTML5 tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>, <i>, <b>, <u>, <mark>, and <bdi> if a matching class value is found in inline and literal elements. Use <ins> and <del> if a matching class value is found in inline, literal, or container elements. (See text-level semantics and indicating edits.)
Use <img> tags for SVG images and <video> for video formats.
Embed images or defer fetching images with the image-loading [9] configuration setting or the "loading" option of the "image" directive.
Especially with "lazy" loading, it is strongly recommended to specify both width and height of the image to prevent content layout shifts or use the "scale" option to let the writer insert the size determined from the image file.
A field list is converted to a HTML definition list and given the field-list class argument value to allow CSS styling. With html_plain.css, the layout is similar to html4css1:
sticks into the field body.
The field body is pushed to the next line (you can suppress this behaviour with the run-in class argument).
of the field name width is possible with CSS instead of the field-name-limit configuration setting, for example:
dl.field-list > dd { margin-left: 6em; }
must not lead to misalignment of the following content.
The plain.css style sheet comes with some pre-defined style variants that can be chosen via a class argument.
3.2.1 Description ListsDefinition lists with the "description" class argument:
Definition lists that are styled like in most dictionaries, encyclopedias etc. (as well as the LaTeX description environment).
The term to be described. Put in boldface or italic.
starts on the same line and has a hanging indent.
must align.
as content containing more than one
paragraph
nested lists
item 2
definition lists
Items of definition lists with class argument "details" are converted to details [10] disclosure elements with the term becoming the "summary".
A summarywith details only visible after user interaction.
Another summarywith open details because the source list has the additional class value "open".
3.2.3 Field List VariantsFor field lists, the "compact/open", "narrow" and "run-in" styles are defined in the style sheets plain.css and responsive.css.
No additional space between list items.
The --compact-field-lists command line option (and the corresponding configuration setting) set the compact class argument on all "simple" field lists, if not overridden with open.
For lists with short field body.
Additional space between list items also in "simple" lists. (Overrides the --compact-field-lists command line option and the corresponding configuration setting)
For "simple" lists that should keep the space between list items.
Less indented field body.
For lists with short field names.
sticks into the field body and the field body starts on a new line (if not combined with run-in).
Field body indented by custom amount.
class value starting with field-indent- followed by a valid length, e.g. field-indent-3em.
will convert this class value to a style attribute setting.
Field body starts on the same line also after long field names.
sticks into the field body which continues on the same line.
and field body should align. Long text in the field body is wrapped and aligns with other fields.
The following styles can be applied to individual tables via a class argument or as document wide setting with the table-style [11] configuration setting (or command line argument).
Numbered tables can be achieved with the "numbered" class option:
truth valuesA
B
A or B
False
False
False
True
False
True
False
True
True
True
True
True
Currently, referencing to the table by number is not supported. This is a common request and already on the TODO list.
A table with "booktabs" class value, is rendered similar to the style from the booktabs [12] LaTeX package.
"Booktabs" style table, numbered, centre-aligned, with auto-sized columns:
I/O values3.2.5 Numbered FiguresInput
Output
A
B
A or B
False
False
False
True
False
True
False
True
True
True
True
True
Numbered figures can be achieved with the "numbered" :figclass: option:
reStructuredText, the markup syntax re Structured TextEmbedded SVG image in a numbered figure.
3.3 Text-Level SemanticsThis section describes the HTML 5 tags for representation of text-level semantics [19] and their reStructuredText equivalents.
Hyperlinks
Visit my drinks page.
Stress emphasis
I must say I adore lemonade. I's sooo sweet.
Importance
Warning: This tea is very hot.
Side comments
These grapes are made into wine. Alcohol is addictive.
Inaccurate text
Price: £4.50 £2.00!
Titles of works
The case Hugo v. Danielle is relevant here. I recommend reading Harry Potter.
Quotations
The judge said
You can drink water from the fish tankbut advised against it.
Defining instance
The term organic food refers to food produced without synthetic chemicals.
Abbreviations [5]
Organic food in Ireland is certified by the IOFGA [â¡]
In rST there are separate roles for abbreviations rsp. acronymes. In HTML, the <acronym> tag is obsolete and authors are advised to use <abbr> instead. The HTML5 writer uses <abbr> for Docutil's <abbreviation> element.
Ruby annotations
Require inline nesting, currently not supported in rST.
Machine-readable equivalent [6]
Machine-readable equivalent of date- or time-related data [6]
Computer code
The
fruitdbprogram can be used for tracking fruit production.
Variables
If there are n fruit in the bowl, at least n÷2 will be ripe.
Computer output
The computer said Unknown error -3.
User input
Hit F1 to continue.
Subscripts
Water is H2O.
Superscripts
The Hydrogen in heavy water is usually 2H.
Alternative voice
Lemonade consists primarily of Citrus limon.
Keywords
Take a lemon and squeeze it with a juicer.
Annotations
The mixture of apple juice and eldeflower juice is very pleasant.
Highlight
Elderflower cordial, with one part cordial to ten parts water, stands apart from the rest.
Text directionality isolation [5]
The recommended restaurant is My Juice Café (At The Beach).
The dir global attribute defaults to "auto" (not "inherit") on this element.
Text directionality formatting [6]
Authors must specify the dir attribute on this element.
Other
In French we call it sirop de sureau.
Line break
For complete paragraphs, use a line-block:
Simply Orange Juice Company
Apopka, FL 32703
U.S.A.
rST does not natively support an exceptional hard line break in a floating paragraph. You may use a HTML-only substitution.
I want to break this line after the colon:
but allow other linebreaks in this paragraph according to the width of the containing block.
Line breaking opportunity
Not supported by rST. You may use a ZWSP character (u200B), literal or via a substitution.
www.simplyâââorangeâjuice.com
The HTML tags for representation of edits to the document [20] and their reStructuredText equivalents are:
Additions [5]
This text has "always" been here. This text has been inserted.
This paragraph has been inserted.
Removed content [5]
This text has been deleted, here is the rest of the paragraph.
This paragraph has been deleted.
Scalable vector graphics (SVG) images are the only standards-compatible way to include vector graphics in HTML documents. However, they are not supported by all backends/output formats (LaTeX, e.g., supports the PDF or Postscript formats for vector graphics instead). Rendering behaviour varies, depending on the SVG image itself, the method used to put the image in the document, and the viewing agent.
Figure with image occupying 40% of the figure width.
The viewBox attribute in the image file enables scaling also in <object> and <svg> nodes.
All up-to-date HTML browsers support SVG, however not all do this fully and in the same manner. Some older browsers, especially IE < 9, have deficiencies or require plug-ins (i.e. don't support the <img> tag). Older versions of webkit based browsers (chromium, safari, midori, konqueror) support the <img> tag but don't display contained bitmap images.
The "html4css1" writer includes SVG images as <object> elements, the "html5" writer uses <svg> for embedded images and <img> else. The element type influences several aspects of image behaviour:
Due to security/privacy considerations, browsers may block <object> data from 3rd party sources.
If an image is included as <object> or <svg>, it depends on the viewBox declaration of the root <svg> element whether it is scaled or clipped/padded. Images in <img> elements are always scaled.
Image with viewBox, 1.2Â em high, left aligned and inline.
Image with viewBox, 5Â mm x 15Â mm.
Image without viewBox, 5Â mm x 15Â mm.
Image with embedded bitmap and viewBox, 2Â em wide.
Image with embedded bitmap without viewBox.
SVG images with viewBox keep the aspect ratio unless the preserveAspectRatio attribute is "none". The following two images are 25% wide and 1Â em high:
Image with viewBox.
Image without viewBox.
Hyperlinks and script actions attached to SVG elements are ignored in images included as <img>. Hyperlinks in images included as <object> are opened in the "object frame". Hyperlinks specified in the rST source (with the :target: directive option) work in <img> and <svg> elements but are ignored in images included as <object> (unless the object is blocked).
Image with a link attached to the upper rectangle; interactive clock and button aligned to the right.
ButtonEmbedded interactive SVG images.
Any errors caught during processing will generate system messages.
There should be five messages in the following, auto-generated section, "Docutils System Messages":
Docutils System MessagesSystem Message: ERROR/3 (functional/input/data/standard.rst, line 99); backlink
Undefined substitution referenced: "problematic".
System Message: ERROR/3 (functional/input/data/standard.rst, line 390); backlink
Unknown target name: "5".
System Message: ERROR/3 (functional/input/data/standard.rst, line 399); backlink
Unknown target name: "nonexistent".
System Message: ERROR/3 (functional/input/data/standard.rst, line 426); backlink
Unknown target name: "hyperlink reference without a target".
System Message: ERROR/3 (functional/input/data/standard.rst, line 439); backlink
Duplicate target name, cannot be used as a unique reference: "duplicate target names".
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4
