SF.net SVN: docutils:[9553 ] trunk/docutils/docs/ref/r st
milde--- via Docutils-checkins <[email protected]>
| Newsgroups | gmane.text.docutils.cvs |
|---|---|
| Message-ID | <[email protected]> |
Revision: 9553
http://sourceforge.net/p/docutils/code/9553
Author: milde
Date: 2024-03-08 23:41:41 +0000 (Fri, 08 Mar 2024)
Log Message:
-----------
"reStructuredText Markup Specification" revision.
Add cross links.
Purge trailing spaces.
"semantic wrapping"
More consistent markup:
* "quote" directive and role names,
* wrap doctree elements in <angle brackets>,
* *emphasize* important terms,
Use a field-list for data tables
(doctree elements, see also, start/end strings, ...).
Rework description of document title and
bibliographic fields (`frontmatter` transforms).
Drop "New in Docutils 0.x" for versions <0.11 (older than 10 years).
Add list of implemented inline-compatible directives
to "substitution definition" section.
Move their description and examples to the "directives" document.
Comment out the "styles" example.
Shorten/correct "Standalone Hyperlinks" section. (Docutils
recognizes relative URIs as long as there is a "scheme" part.)
Sort references (hyperlink targets) by target document,
then alphabetically.
Modified Paths:
--------------
trunk/docutils/docs/ref/rst/directives.txt
trunk/docutils/docs/ref/rst/restructuredtext.txt
Modified: trunk/docutils/docs/ref/rst/directives.txt
===================================================================
--- trunk/docutils/docs/ref/rst/directives.txt 2024-03-08 23:41:31 UTC (rev 9552)
+++ trunk/docutils/docs/ref/rst/directives.txt 2024-03-08 23:41:41 UTC (rev 9553)
@@ -216,9 +216,6 @@
.. image:: picture.png
-Inline images can be defined with an "image" directive in a `substitution
-definition`_
-
The URI for the image source file is specified in the directive
argument. As with hyperlink targets, the image URI may begin on the
same line as the explicit markup start and target name, or it may
@@ -238,6 +235,17 @@
:alt: alternate text
:align: right
+
+*Inline images* can be defined with an "image" directive in a `substitution
+definition`_, e.g. ::
+
+ |Red light| means stop, |green light| means go.
+
+ .. |red light| image:: red_light.png
+ :align: top
+ .. |green light| image:: green_light.png
+ :align: bottom
+
.. _image options:
The "image" directive recognizes the common options class_ and name_
@@ -380,7 +388,7 @@
Sets the "width" attribute of the "figure" doctree element.
This option does not scale the included image; use the ``width``
- `image option <image options_>`_ for that. ::
+ `image option <image options_>`__ for that. ::
+---------------------------+
| figure |
@@ -1393,6 +1401,8 @@
Yes, |reST| is a long word, so I can't blame anyone for wanting to
abbreviate it.
+.. _hyperlink workaround:
+
As reStructuredText doesn't support nested inline markup, the only way
to create a reference with styled text is to use substitutions with
the "replace" directive::
@@ -1461,6 +1471,9 @@
.. |---| unicode:: U+02014 .. em dash
:trim:
+Docutils comes with a set of character substitution
+definitions in the `reStructuredText Standard Definition Files`_.
+
.. _unicode options:
The "unicode" directive recognizes the following options:
@@ -1563,8 +1576,8 @@
.. include:: <isonum.txt>
The current set of standard "include" data files consists of sets of
-substitution definitions. See `reStructuredText Standard Definition Files
-<definitions.html>`__ for details.
+substitution definitions. See `reStructuredText Standard Definition
+Files`_ for details.
.. _include options:
@@ -2252,6 +2265,8 @@
.. _"raw" role: roles.html#raw
.. _The Docutils Document Tree: ../doctree.html
+.. _reStructuredText Standard Definition Files: definitions.html
+
.. _identifier keys: ../doctree.html#ids-type
.. _inline elements: ../doctree.html#inline-elements
.. _class names: ../doctree.html#classname
Modified: trunk/docutils/docs/ref/rst/restructuredtext.txt
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.txt 2024-03-08 23:41:31 UTC (rev 9552)
+++ trunk/docutils/docs/ref/rst/restructuredtext.txt 2024-03-08 23:41:41 UTC (rev 9553)
@@ -1,5 +1,3 @@
-.. -*- coding: utf-8 -*-
-
.. include:: ../../header2.txt
=======================================
@@ -224,9 +222,12 @@
Whitespace
==========
+:Config setting: tab_width_
+
Spaces are recommended for indentation_, but tabs may also be used.
Tabs will be converted to spaces. Tab stops are at every 8th column
-(processing systems may make this value configurable).
+(processing systems may make this value configurable, Docutils uses the
+`tab_width`_ configuration setting).
Other whitespace characters (form feeds [chr(12)] and vertical tabs
[chr(11)]) are converted to single spaces before processing.
@@ -380,15 +381,17 @@
r"""This is a raw docstring. Backslashes (\) are not touched."""
.. [#uri-context] In contexts where Docutils expects a URI (the link
- block of `external hyperlink targets`_ or the argument of an image_ or
- figure_ directive), whitespace is ignored by default
+ block of `external hyperlink targets`_ or the argument of an `"image"`_
+ or `"figure"`_ directive), whitespace is ignored by default
-.. [#literal-context] In literal context (`literal blocks`_ and `inline
- literals`_, content of the code_, math_, and raw_ directives, content
- of the `"raw" role`_ and `custom roles`_ based on it),
- reStructuredText markup characters lose their semantics so there is no
- reason to escape them.
+.. [#literal-context]
+ In literal context (`literal blocks`_ and `inline literals`_,
+ content of the `"code"`_, `"math"`_, and `"raw"`_ directives,
+ content of the `"raw" role`_ and `custom roles`_ based on it),
+ reStructuredText markup characters lose their semantics
+ so there is no reason to escape them.
+
.. _reference name:
Reference Names
@@ -401,7 +404,10 @@
`reference name` due to restrictions on identifiers/labels in the
output format.
-Simple reference names are single words consisting of alphanumerics
+.. _simple reference name:
+.. _simple reference names:
+
+*Simple reference names* are single words consisting of alphanumerics
plus isolated (no two adjacent) internal hyphens, underscores,
periods, colons and plus signs; no whitespace or other characters are
allowed. Footnote labels (Footnotes_ & `Footnote References`_), citation
@@ -408,8 +414,10 @@
labels (Citations_ & `Citation References`_), `interpreted text`_ roles,
and some `hyperlink references`_ use the simple reference name syntax.
+.. _phrase references:
+
Reference names using punctuation or whose names are phrases (two or
-more space-separated words) are called "phrase-references".
+more space-separated words) are called *phrase references*.
Phrase-references are expressed by enclosing the phrase in backquotes
and treating the backquoted text as a reference name::
@@ -419,7 +427,7 @@
Simple reference names may also optionally use backquotes.
-.. _`normalized reference names`:
+.. _normalized reference names:
Reference names are whitespace-neutral and case-insensitive. When
resolving reference names internally:
@@ -452,10 +460,16 @@
Document Structure
==================
+.. raw:: html
+
+ <style type="text/css"><!--
+ dl.field-list {--field-indent: 10em;}
+ --></style>
+
Document
--------
-Doctree element: `document <document element_>`_.
+:Doctree element: `\<document>`_
The top-level element of a parsed reStructuredText document is the
@@ -470,29 +484,26 @@
.. _document title:
-Specifically, there is no way to indicate a document title and
-subtitle explicitly in reStructuredText. [#]_ Instead, a lone top-level
-section title (see Sections_ below) can be treated as the document
-title. Similarly, a lone second-level section title immediately after
-the "document title" can become the document subtitle. The rest of
-the sections are then lifted up a level or two. See the `DocTitle
-transform`_ for details.
+Specifically, there is no way to indicate a document title and subtitle
+explicitly in reStructuredText. [#]_ Instead, a lone top-level `section
+title`_ can be treated as the *document title*. Similarly, a lone
+second-level section title immediately after the document title can
+become the *document subtitle*. The rest of the sections are then lifted
+up a level or two. See the `DocTitle transform`_ for details.
-.. [#] The `"title" configuration setting`__ and the `"title"
- directive`__ set the document's `title attribute`_ that does not
- become part of the document body.
+.. [#] The `"title"`_ directive sets the document's `metadata title`_
+ that does not become part of the document body.
- .. _title attribute: ../doctree.html#title-attribute
- __ ../../user/config.html#title
- __ directives.html#metadata-document-title
-
Sections
--------
-Doctree elements: section_, title_.
+:Doctree elements: `\<section>`_, `\<title>`_
-Sections are identified through their titles, which are marked up with
+.. _section title:
+.. _section titles:
+
+Sections are identified through their *titles*, which are marked up with
adornment: "underlines" below the title text, or underlines and
matching "overlines" above the title. An underline/overline is a
single repeated punctuation character that begins in column 1 and
@@ -591,7 +602,7 @@
Transitions
-----------
-Doctree element: transition_.
+:Doctree element: `\<transition>`_
Instead of subheads, extra space or a type ornament between
paragraphs may be used to mark text divisions or to signal
@@ -631,7 +642,7 @@
Paragraphs
----------
-Doctree element: paragraph_.
+:Doctree element: `\<paragraph>`_
Paragraphs consist of blocks of left-aligned text with no markup
indicating any other body element. Blank lines separate paragraphs
@@ -654,7 +665,7 @@
Bullet Lists
------------
-Doctree elements: bullet_list_, list_item_.
+:Doctree elements: `\<bullet_list>`_, `\<list_item>`_
A text block which begins with a "*", "+", "-", "•", "‣", or "⁃",
followed by whitespace, is a bullet list item (a.k.a. "unordered" list
@@ -703,7 +714,7 @@
Enumerated Lists
----------------
-Doctree elements: enumerated_list_, list_item_.
+:Doctree elements: `\<enumerated_list>`_, `\<list_item>`_
Enumerated lists (a.k.a. "ordered" lists) are similar to bullet lists,
but use enumerators instead of bullets. An enumerator consists of an
@@ -719,8 +730,7 @@
In addition, the auto-enumerator, "#", may be used to automatically
enumerate a list. Auto-enumerated lists may begin with explicit
enumeration, which sets the sequence. Fully auto-enumerated lists use
-arabic numerals and begin with 1. (Auto-enumerated lists are new in
-Docutils 0.3.8.)
+arabic numerals and begin with 1.
The following formatting types are recognized:
@@ -764,19 +774,19 @@
A. Einstein was a really smart dude.
-.. Caution::
+.. Caution::
If a single-line paragraph begins with text identical to an enumerator
("A.", "1.", "(b)", "I)", etc.), the first character will have to be
escaped in order to have the line parsed as an ordinary paragraph::
-
+
\A. Einstein was a really smart dude.
-
+
Alternatively, you can escape the delimiter ::
-
+
A\. Einstein was a really smart dude.
-
- or use a literal NO-BREAK SPACE after the initial.
+ or use a literal NO-BREAK SPACE after the initial.
+
Examples of nested enumerated lists::
1. Item 1 initial text.
@@ -798,8 +808,8 @@
Definition Lists
----------------
-Doctree elements: definition_list_, definition_list_item_, term_,
-classifier_, definition_.
+:Doctree elements: `\<definition_list>`_, `\<definition_list_item>`_,
+ `\<term>`_, `\<classifier>`_, `\<definition>`_
Each definition list item contains a term, optional classifiers, and a
definition.
@@ -864,7 +874,8 @@
Field Lists
-----------
-Doctree elements: field_list_, field_, field_name_, field_body_.
+:Doctree elements: `\<field_list>`_, `\<field>`_,
+ `\<field_name>`_, `\<field_body>`_
Field lists are used as part of an extension syntax, such as options
for directives_, or database-like records meant for further
@@ -872,8 +883,8 @@
structures resembling database records (label & data pairs).
Applications of reStructuredText may recognize field names and
transform fields or field bodies in certain contexts. For examples,
-see `Bibliographic Fields`_ below, or the "image_" and "meta_"
-directives in `reStructuredText Directives`_.
+see `Bibliographic Fields`_ or `directive options`_ below or the
+`"meta"`_ directive.
.. _field names:
@@ -924,30 +935,32 @@
| (body elements)+ |
+-----------------------------------+
-.. [#] Up to Docutils 0.14, field markers were not recognized when
+.. [#] Up to Docutils 0.14, field markers were not recognized when
containing a colon.
Bibliographic Fields
````````````````````
-Doctree elements: docinfo_, address_, author_, authors_, contact_,
-copyright_, date_, organization_, revision_, status_, topic_,
-version_.
+:Doctree elements: `\<docinfo>`_, `\<address>`_, `\<author>`_,
+ `\<authors>`_, `\<contact>`_, `\<copyright>`_,
+ `\<date>`_, `\<organization>`_, `\<revision>`_,
+ `\<status>`_, `\<topic>`_, `\<version>`_
-When a field list is the first element in a document
-(after the document title, if there is one) [#]_, it may have its fields
-transformed to document bibliographic data. This bibliographic data
-corresponds to the front matter of a book, such as the title page and
-copyright page.
+When a field list is the document body's first element [#PreBibliographic]_,
+it may have its fields transformed__ to bibliographic data.
+This bibliographic data corresponds to the front matter of a book,
+such as the title page and copyright page.
-.. [#] In addition to the document title and subtitle, also comments_,
- `substitution definitions`_, `hyperlink targets`_, and "header",
- "footer", "meta", and "raw" directives_ may be placed before the
- bibliographic fields.
+.. [#PreBibliographic]
+ A `document title`_, header and footer as well as elements that
+ do not show up in the output before the bibliographic fields don't
+ count. See `PreBibliographic Elements`_ for details.
+__ `DocInfo transform`_
+
Certain registered field names (listed below) are recognized and
transformed to the corresponding doctree elements, most becoming child
-elements of the docinfo_ element. No ordering is required of these
+elements of the `\<docinfo>`_ element. No ordering is required of these
fields, although they may be rearranged to fit the document structure,
as noted. Unless otherwise indicated below, each of the bibliographic
elements' field bodies may contain a single paragraph only. Field
@@ -955,6 +968,8 @@
unrecognized fields will remain as generic fields in the docinfo
element.
+.. _bibliographic field names:
+
The registered bibliographic field names and their corresponding
doctree elements are as follows:
@@ -961,18 +976,18 @@
============= ================
Field name doctree element
============= ================
- Abstract topic_
- Address address_
- Author author_
- Authors authors_
- Contact contact_
- Copyright copyright_
- Date date_
- Dedication topic_
- Organization organization_
- Revision revision_
- Status status_
- Version version_
+ Abstract `\<topic>`_
+ Address `\<address>`_
+ Author `\<author>`_
+ Authors `\<authors>`_
+ Contact `\<contact>`_
+ Copyright `\<copyright>`_
+ Date `\<date>`_
+ Dedication `\<topic>`_
+ Organization `\<organization>`_
+ Revision `\<revision>`_
+ Status `\<status>`_
+ Version `\<version>`_
============= ================
The "Authors" field may contain either: a single paragraph consisting
@@ -995,13 +1010,12 @@
immediately following the docinfo element.
This field-name-to-element mapping can be replaced for other
-languages. See the `DocInfo transform`_ implementation documentation
-for details.
+languages. See `Docutils Internationalization`_ for details.
Unregistered/generic fields may contain one or more paragraphs or
-arbitrary body elements.
-The field name is also used as a `"classes" attribute`_ value after being
-converted into a valid identifier form.
+arbitrary body elements. To support custom styling, the field name is
+also added to the `"classes" attribute`_ value after being converted
+into a valid identifier form.
RCS Keywords
@@ -1033,8 +1047,9 @@
Option Lists
------------
-Doctree elements: option_list_, option_list_item_, option_group_, option_,
-option_string_, option_argument_, description_.
+:Doctree elements: `\<option_list>`_, `\<option_list_item>`_,
+ `\<option_group>`_, `\<option>`_, `\<option_string>`_,
+ `\<option_argument>`_, `\<description>`_
Option lists map a program's command-line options to descriptions
documenting them. For example::
@@ -1048,7 +1063,7 @@
This is the first.
This is the second.
- Blank lines may be omitted between options
+ Blank lines may be omitted between options
(as above) or left in (as here and below).
--very-long-option A VMS-style option. Note the adjustment
@@ -1130,7 +1145,7 @@
Literal Blocks
--------------
-Doctree element: literal_block_.
+:Doctree element: `\<literal_block>`_
A paragraph consisting of two colons ("::") signifies that the
following text block(s) comprise a literal block. The literal block
@@ -1253,7 +1268,7 @@
Line Blocks
-----------
-Doctree elements: line_block_, line_. (New in Docutils 0.3.5.)
+:Doctree elements: `\<line_block>`_, `\<line>`_
Line blocks are useful for address blocks, verse (poetry, song
lyrics), and unadorned lists, where the structure of lines is
@@ -1304,7 +1319,7 @@
Block Quotes
------------
-Doctree elements: block_quote_, attribution_.
+:Doctree elements: `\<block_quote>`_, `\<attribution>`_
A text block that is indented relative to the preceding text, without
preceding markup indicating it to be a literal block or other content,
@@ -1371,7 +1386,7 @@
Doctest Blocks
--------------
-Doctree element: doctest_block_.
+:Doctree element: `\<doctest_block>`_
Doctest blocks are interactive Python sessions cut-and-pasted into
docstrings. They are meant to illustrate usage by example, and
@@ -1401,12 +1416,13 @@
Tables
------
-Doctree elements: table_, tgroup_, colspec_, thead_, tbody_, row_, entry_.
+:Doctree elements: `\<table>`_, `\<tgroup>`_, `\<colspec>`_, `\<thead>`_,
+ `\<tbody>`_, `\<row>`_, `\<entry>`_
ReStructuredText provides two syntax variants for delineating table
cells: `Grid Tables`_ and `Simple Tables`_. Tables are also generated by
-the `CSV Table`_ and `List Table`_ directives. The `table
-directive`_ is used to add a table title or specify options.
+the `"csv-table"`_ and `"list-table"`_ directives. The `"table"`_ directive
+is used to add a table title, caption, or specify options.
As with other body elements, blank lines are required before and after
tables. Tables' left edges should align with the left edge of
@@ -1638,19 +1654,15 @@
unambiguous.
+.. _footnote:
+
Footnotes
`````````
-See also: `Footnote References`_.
+:Doctree elements: `\<footnote>`_, `\<label>`_
+:Config settings: footnote_references_
+:See also: `footnote references`_
-Doctree elements: footnote_, label_.
-
-Configuration settings:
-`footnote_references <footnote_references setting_>`_.
-
-.. _footnote_references setting:
- ../../user/config.html#footnote-references
-
Each footnote consists of an explicit markup start (".. "), a left
square bracket, the footnote label, a right square bracket, and
whitespace, followed by indented body elements. A footnote label can
@@ -1660,7 +1672,7 @@
- a single "#" (denoting `auto-numbered footnotes`_),
-- a "#" followed by a simple reference name (an `autonumber label`_),
+- a "#" followed by a `simple reference name`_ (an `autonumber label`_),
or
- a single "*" (denoting `auto-symbol footnotes`_).
@@ -1796,11 +1808,9 @@
in certain common text encodings such as Latin-1 (ISO 8859-1). The
use of UTF-8 for the output encoding is recommended. An
alternative for HTML and XML output is to use the
- "xmlcharrefreplace" `output encoding error handler`__.
+ "xmlcharrefreplace" `output encoding error handler`_.
-__ ../../user/config.html#output-encoding-error-handler
-
Mixed Manual and Auto-Numbered Footnotes
........................................
@@ -1828,10 +1838,9 @@
Citations
`````````
-See also: `Citation References`_.
+:Doctree element: `\<citation>`_
+:See also: `citation references`_
-Doctree element: citation_
-
Citations are identical to footnotes except that they use only
non-numeric labels such as ``[note]`` or ``[GVR2001]``. Citation
labels are simple `reference names`_ (case-insensitive single words
@@ -1845,20 +1854,23 @@
except the label is textual.
-.. _hyperlinks:
+.. _explicit hyperlink targets:
Hyperlink Targets
`````````````````
-Doctree element: target_.
+:Doctree element: `\<target>`_
+:See also: | `hyperlink references`_
+ | `embedded URIs and aliases`_
+ | `inline internal targets`_
-These are also called _`explicit hyperlink targets`, to differentiate
+These are also called *explicit hyperlink targets*, to differentiate
them from `implicit hyperlink targets`_ defined below.
Hyperlink targets identify a location within or outside of a document,
which may be linked to by `hyperlink references`_.
-Hyperlink targets may be named or anonymous. Named hyperlink targets
+Hyperlink targets may be named or anonymous. *Named hyperlink targets*
consist of an explicit markup start (".. "), an underscore, the
reference name (no trailing underscore), a colon, whitespace, and a
link block::
@@ -1868,7 +1880,7 @@
Reference names are whitespace-neutral and case-insensitive. See
`Reference Names`_ for details and examples.
-Anonymous hyperlink targets consist of an explicit markup start
+*Anonymous hyperlink targets* consist of an explicit markup start
(".. "), two underscores, a colon, whitespace, and a link block; there
is no reference name::
@@ -2038,6 +2050,8 @@
+----------------------+
+.. _anonymous:
+
Anonymous Hyperlinks
....................
@@ -2081,7 +2095,7 @@
Directives
``````````
-Doctree elements: depend on the directive.
+:Doctree elements: depend on the directive
Directives are an extension mechanism for reStructuredText, a way of
adding support for new constructs without adding new primary syntax
@@ -2092,17 +2106,17 @@
are domain-specific, and may require special action to make them
available when processing the document.
-For example, here's how an image_ may be placed::
+For example, the `"image"`_ directive is used to include an image::
.. image:: mylogo.jpeg
-A figure_ (a graphic with a caption) may placed like this::
+A graphic with a caption may included with the `"figure"`_ directive::
.. figure:: larch.png
The larch.
-An admonition_ (note, caution, etc.) contains other body elements::
+An `"admonition"`_ (note, caution, etc.) contains other body elements::
.. note:: This is a paragraph
@@ -2138,7 +2152,7 @@
Individual directives can employ any combination of these parts.
Directive arguments can be filesystem paths, URLs, title text, etc.
-Directive options are indicated using `field lists`_; the field names
+_`Directive options` are indicated using `field lists`_; the field names
and contents are directive-specific. Arguments and options must form
a contiguous block beginning on the first or second line of the
directive; a blank line indicates the beginning of the directive
@@ -2186,14 +2200,15 @@
Substitution Definitions
````````````````````````
-Doctree element: substitution_definition_.
+:Doctree element: `\<substitution_definition>`_
+:See also: `substitution references`_
Substitution definitions are indicated by an explicit markup start
(".. ") followed by a vertical bar, the substitution text, another
vertical bar, whitespace, and the definition block. Substitution text
may not begin or end with whitespace. A substitution definition block
-contains an embedded inline-compatible directive (without the leading
-".. "), such as "image_" or "replace_". For example::
+contains an embedded `inline-compatible directive`_ (such as "image" or
+"replace") without the leading dots. For example::
The |biohazard| symbol must be used on containers used to
dispose of medical waste.
@@ -2228,10 +2243,27 @@
| |
+-----------------------------------------------------+
-Following are some use cases for the substitution mechanism. Please
-note that most of the embedded directives shown are examples only and
-have not been implemented.
+.. _inline-compatible directive:
+
+The following *inline-compatible directives* are implemented in Docutils:
+
+:`"image"`_: can be used for block-level images as well as in a
+ substitution definition for `inline images`_.
+
+:`"replace"`_: allows simple macro substitution.
+ It also provides a workaround__ for the still missing support of
+ nested inline markup.
+
+ __ directives.html#hyperlink-workaround
+
+:`"unicode"`_: converts Unicode character codes to characters.
+
+:`"date"`_: inserts the current local date.
+
+Applications may find other use cases for the substitution mechanism.
+The following are ideas that have not been implemented in Docutils.
+
Objects
Substitution references may be used to associate ambiguous text
with a unique object identifier.
@@ -2272,35 +2304,9 @@
.. |runString| function:: module=xml.xslt class=Processor
-Images
- Images are a common use for substitution references::
+.. @@@ Inline styling is better served with "custom interpreted text".
- West led the |H| 3, covered by dummy's |H| Q, East's |H| K,
- and trumped in hand with the |S| 2.
-
- .. |H| image:: /images/heart.png
- :height: 11
- :width: 11
- .. |S| image:: /images/spade.png
- :height: 11
- :width: 11
-
- * |Red light| means stop.
- * |Green light| means go.
- * |Yellow light| means go really fast.
-
- .. |Red light| image:: red_light.png
- .. |Green light| image:: green_light.png
- .. |Yellow light| image:: yellow_light.png
-
- |-><-| is the official symbol of POEE_.
-
- .. |-><-| image:: discord.png
- .. _POEE: http://www.poee.org/
-
- The "image_" directive has been implemented.
-
-Styles [#]_
+ Styles [#]_
Substitution references may be used to associate inline text with
an externally defined presentation style::
@@ -2350,53 +2356,23 @@
Zope would then transform this to something like "Welcome back,
David!" during a session with an actual user.
-Replacement text
- The substitution mechanism may be used for simple macro
- substitution. This may be appropriate when the replacement text
- is repeated many times throughout one or more documents,
- especially if it may need to change later. A short example is
- unavoidably contrived::
- |RST|_ is a little annoying to type over and over, especially
- when writing about |RST| itself, and spelling out the
- bicapitalized word |RST| every time isn't really necessary for
- |RST| source readability.
-
- .. |RST| replace:: reStructuredText
- .. _RST: https://docutils.sourceforge.io/rst.html
-
- Note the trailing underscore in the first use of a substitution
- reference. This indicates a reference to the corresponding
- hyperlink target.
-
- Substitution is also appropriate when the replacement text cannot
- be represented using other inline constructs, or is obtrusively
- long::
-
- But still, that's nothing compared to a name like
- |j2ee-cas|__.
-
- .. |j2ee-cas| replace::
- the Java `TM`:super: 2 Platform, Enterprise Edition Client
- Access Services
- __ http://developer.java.sun.com/developer/earlyAccess/
- j2eecas/
-
- The "replace_" directive has been implemented.
-
-
Comments
````````
-Doctree element: comment_.
+:Doctree element: `\<comment>`_
+:Config setting: strip_comments_
`Explicit markup blocks`_ that are not recognized as citations_,
directives_, footnotes_, `hyperlink targets`_, or `substitution
-definitions`_ will be processed as a comment element. Arbitrary
-indented text may be used on the lines following the explicit markup
-start. To ensure that none of the other explicit markup constructs is
-recognized, leave the ".." on a line by itself::
+definitions`_ will be processed as a comment element.
+.. tip:: To ensure that none of the other explicit markup constructs
+ is recognized, leave the ".." on a line by itself.
+
+Arbitrary indented text may be used on the lines following the explicit
+markup start::
+
.. This is a comment
..
_so: is this!
@@ -2409,10 +2385,11 @@
.. [this] however, is a citation.
-Apart from removing the maximum common indentation, no further
-processing is done on the content; a comment contains a single "text
-blob". Depending on the output formatter, comments may be removed
-from the processed output.
+Apart from removing the maximum common indentation, no further processing
+is done on the content; a comment contains a single "text blob".
+Depending on the output formatter, comments may be removed from the
+processed output. In Docutils, the strip_comments_ configuration setting
+triggers the removal of comment elements from the document tree.
Syntax diagram::
@@ -2438,11 +2415,14 @@
This is a block quote.
+
Implicit Hyperlink Targets
==========================
-Implicit hyperlink targets are generated by section titles, footnotes,
-and citations, and may also be generated by extension constructs.
+:Doctree element: `\<target>`_
+
+Implicit hyperlink targets are generated by `section titles`_, footnotes_,
+and citations_, and may also be generated by extension constructs.
Implicit hyperlink targets otherwise behave identically to explicit
`hyperlink targets`_.
@@ -2508,6 +2488,8 @@
Inline markup recognition rules
-------------------------------
+:Config setting: character_level_inline_markup_
+
Inline markup start-strings and end-strings are only recognized if
the following conditions are met:
@@ -2531,7 +2513,7 @@
non-ASCII character [#closers]_. (For quotes, matching characters can
be any of the `quotation marks in international usage`_.)
-If the configuration setting `character-level-inline-markup`_ is False
+If the configuration setting character_level_inline_markup_ is False
(default), additional conditions apply to the characters "around" the
inline markup:
@@ -2560,7 +2542,7 @@
.. [#uni-version] The category of some characters changed with the
development of the Unicode standard.
- Docutils 0.13 uses `Unicode version 5.2.0`_.
+ Docutils 0.13 … 0.21 uses `Unicode version 5.2.0`_.
.. _Unicode categories:
https://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values
@@ -2603,15 +2585,12 @@
For languages that don't use whitespace between words (e.g. Japanese or
-Chinese) it is recommended to set `character-level-inline-markup`_ to
-True and eventually escape inline markup characters.
+Chinese) it is recommended to set character_level_inline_markup_ to True
+and escape inline markup characters in case of non-markup use.
The examples breaking rules 6 and 7 above show which constructs may need
special attention.
-.. _character-level-inline-markup:
- ../../user/config.html#character-level-inline-markup
-
Recognition order
-----------------
@@ -2640,6 +2619,8 @@
Character-Level Inline Markup
-----------------------------
+:Config setting: character_level_inline_markup_
+
It is possible to mark up individual characters within a word with
backslash escapes (see `Escaping Mechanism`_ above). Backslash
escapes can be used to allow arbitrary text to immediately follow
@@ -2666,18 +2647,18 @@
unprocessed document's readability. Please use this feature
sparingly and only where absolutely necessary.
-Alternatively, you may relax the `inline markup recognition rules`_ with
-the character-level-inline-markup_ setting, however this may in turn lead
-to false positives.
+In Docutils, you may relax the `inline markup recognition rules`_ with
+the character_level_inline_markup_ setting, however this may in turn
+lead to false positives.
Emphasis
--------
-Doctree element: emphasis_.
+:Doctree element: `\<emphasis>`_
+:Start/End string: "*"
+:Standard role: `"emphasis"`_
-Start-string = end-string = "*".
-
Text enclosed by single asterisk characters is emphasized::
This is *emphasized text*.
@@ -2688,10 +2669,10 @@
Strong Emphasis
---------------
-Doctree element: strong_.
+:Doctree element: `\<strong>`_
+:Start/End string: "**"
+:Standard role: `"strong"`_
-Start-string = end-string = "**".
-
Text enclosed by double-asterisks is emphasized strongly::
This is **strong text**.
@@ -2702,11 +2683,12 @@
Interpreted Text
----------------
-Doctree element: depends on the explicit or implicit role and
-processing.
+:Doctree element: depends on the explicit or implicit role and
+ processing
+:Start/End string: "`"
+:Configuration: `"default-role"`_ directive
+:See also: `reStructuredText Interpreted Text Roles`_
-Start-string = end-string = "`".
-
Interpreted text is text that is meant to be related, indexed, linked,
summarized, or otherwise processed, but the text itself is typically
left alone. Interpreted text is enclosed by single backquote
@@ -2714,9 +2696,9 @@
This is `interpreted text`.
-The "role" of the interpreted text determines how the text is
+The *role* of the interpreted text determines how the text is
interpreted. The role may be inferred implicitly (as above; the
-"default role" is used) or indicated explicitly, using a role marker.
+*default role* is used) or indicated explicitly, using a role marker.
A role marker consists of a colon, the role name, and another colon.
A role name is a single word consisting of alphanumerics plus isolated
internal hyphens, underscores, plus signs, colons, and periods;
@@ -2729,16 +2711,19 @@
`interpreted text`:role:
Interpreted text allows extensions to the available inline descriptive
-markup constructs. To emphasis_, `strong emphasis`_, `inline
-literals`_, and `hyperlink references`_, we can add "title reference",
-"index entry", "acronym", "class", "red", "blinking" or anything else
-we want (as long as it is a simple `reference name`_).
+markup constructs. To `emphasis`_, `strong emphasis`_, `inline
+literals`_, and `hyperlink references`_, we can add "title-reference",
+"index-entry", "acronym", "class", "red", "blinking" or anything else
+we want (as long as it is a `simple reference name`_).
Only pre-determined roles are recognized; unknown roles will
-generate errors. A core set of standard roles is implemented in the
+generate errors.
+
+A core set of *standard roles* is implemented in the
reference parser; see `reStructuredText Interpreted Text Roles`_ for
-individual descriptions. The role_ directive can be used to define
+individual descriptions. The `"role" directive`_ can be used to define
custom interpreted text roles. In addition, applications may support
-specialized roles.
+specialized roles. The *default role* (used for interpreted text without
+role marker) can be set with the `"default-role"`_ directive.
In `field lists`_, care must be taken when using interpreted text with
explicit roles in field names: the role must be a suffix to the
@@ -2753,7 +2738,7 @@
::code:`not a field name`: paragraph with interpreted text
- :code:`not a field name`: paragraph with interpreted text
+ :\ :code:`not a field name`: paragraph with interpreted text
Edge cases::
@@ -2766,10 +2751,11 @@
Inline Literals
---------------
-Doctree element: literal_.
+:Doctree element: `\<literal>`_
+:Start/End string: "``"
+:Standard role: `"literal"`_
+:See also: `"code" role`_
-Start-string = end-string = "``".
-
Text enclosed by double-backquotes is treated as inline literals::
This text is an example of ``inline literals``.
@@ -2787,7 +2773,8 @@
guaranteed. If the preservation of line breaks and/or other
whitespace is important, `literal blocks`_ should be used.
-Inline literals are useful for short code snippets. For example::
+Inline literals or the `"code" role`_ are useful for short code snippets.
+For example::
The regular expression ``[+-]?(\d+(\.\d*)?|\.\d+)`` matches
floating-point numbers (without exponents).
@@ -2796,17 +2783,27 @@
Hyperlink References
--------------------
-Doctree element: reference_.
+.. class:: compact
-- Named hyperlink references:
+:Doctree element: `\<reference>`_
+:Start/End strings:
+ .. table::
+ :class: borderless
+ :widths: grid
- - No start-string, end-string = "_".
- - Start-string = "`", end-string = "\`_". (Phrase references.)
+ ================ ========= ======= ========
+ reference type name start end
+ ================ ========= ======= ========
+ named simple_ none "_"
+ .. phrase_ "`" "\`_"
+ anonymous_ simple none "__"
+ .. phrase "`" "\`__"
+ ================ ========= ======= ========
-- Anonymous hyperlink references:
+:See also: `hyperlink targets`_
- - No start-string, end-string = "__".
- - Start-string = "`", end-string = "\`__". (Phrase references.)
+.. _simple: `simple reference names`_
+.. _phrase: `phrase references`_
Hyperlink references are indicated by a trailing underscore, "_",
except for `standalone hyperlinks`_ which are recognized
@@ -2814,27 +2811,30 @@
arrow. The trailing underscores point away from hyperlink references,
and the leading underscores point toward `hyperlink targets`_.
-Hyperlinks consist of two parts. In the text body, there is a source
-link, a reference name with a trailing underscore (or two underscores
-for `anonymous hyperlinks`_)::
+_`Hyperlinks` consist of two parts:
- See the Python_ home page for info.
+1. In the text body, there is a source link, a reference name with a
+ trailing underscore (or two underscores for `anonymous hyperlinks`_)::
-A target link with a matching reference name must exist somewhere else
-in the document. See `Hyperlink Targets`_ for a full description).
+ See the Python_ home page for info.
-`Anonymous hyperlinks`_ (which see) do not use reference names to
-match references to targets, but otherwise behave similarly to named
-hyperlinks.
+2. A matching target link must exist in the document. It may be embedded
+ (see below) or exist somewhere else in the document (see `Hyperlink
+ Targets`_).
+`Anonymous hyperlinks`_ do not use reference names to match references
+to targets, but otherwise behave similarly to named hyperlinks.
+
Embedded URIs and Aliases
`````````````````````````
-A hyperlink reference may directly embed a target URI or (since
-Docutils 0.11) a hyperlink reference within angle brackets ("<...>")
-as follows::
+:Doctree elements: `\<reference>`_, `\<target>`_
+:Start/End strings: "<" ">" (only recognized inside `hyperlink references`_)
+A hyperlink reference may directly embed a target URI or an "alias"
+hyperlink reference within angle brackets as follows::
+
See the `Python home page <https://www.python.org>`_ for info.
This `link <Python home page_>`_ is an alias to the link above.
@@ -2851,10 +2851,10 @@
The bracketed URI must be preceded by whitespace and be the last text
before the end string.
-With a single trailing underscore, the reference is named and the same
-target URI may be referred to again.
+With a single trailing underscore, the reference is *named* -- the
+`reference name`_ should be unique and may be referred to again.
With two trailing underscores, the reference and target are both
-anonymous, and the target cannot be referred to again. These are
+anonymous_ and the target cannot be referred to again. These are
"one-off" hyperlinks. For example::
`RFC 2396 <https://www.rfc-editor.org/rfc/rfc2396.txt>`__ and `RFC
@@ -2861,7 +2861,7 @@
2732 <https://www.rfc-editor.org/rfc/rfc2732.txt>`__ together
define the syntax of URIs.
-Equivalent to::
+is equivalent to::
`RFC 2396`__ and `RFC 2732`__ together define the syntax of URIs.
@@ -2894,8 +2894,8 @@
URIs where the address or file name is also the desired reference
text::
- See `<a_named_relative_link>`_ or `<an_anonymous_relative_link>`__
- for details.
+ See `<a_named_relative_link>`_ or
+ `<an_anonymous_relative_link>`__ for details.
.. CAUTION::
@@ -2911,10 +2911,10 @@
Inline Internal Targets
------------------------
-Doctree element: target_.
+:Doctree element: `\<target>`_
+:Start/End strings: "_`" "`"
+:See also: `hyperlink targets`_
-Start-string = "_`", end-string = "`".
-
Inline internal targets are the equivalent of explicit `internal
hyperlink targets`_, but may appear within running text. The syntax
begins with an underscore and a backquote, is followed by a hyperlink
@@ -2933,19 +2933,15 @@
Footnote References
-------------------
-See also: Footnotes_
+.. class:: field-indent-12em
-Doctree element: footnote_reference_.
+:Doctree element: `\<footnote_reference>`_
+:Start/End string: "[" "]_"
+:Config settings: footnote_references_,
+ trim_footnote_reference_space_
+:See also: footnotes_
-Configuration settings:
-`footnote_references <footnote_references setting_>`_,
-trim_footnote_reference_space_.
-.. _trim_footnote_reference_space:
- ../../user/config.html#trim-footnote-reference-space
-
-Start-string = "[", end-string = "]_".
-
Each footnote reference consists of a square-bracketed label followed
by a trailing underscore. Footnote labels are one of:
@@ -2967,25 +2963,21 @@
`Inline markup recognition rules`_ may require whitespace in front of the
footnote reference. To remove the whitespace from the output, use an
escaped whitespace character (see `Escaping Mechanism`_) or set the
-trim_footnote_reference_space_ configuration setting. Leading whitespace
-is removed by default, if the `footnote_references setting`_ is
-"superscript".
+trim_footnote_reference_space_ configuration setting.
+Leading whitespace is removed by default, if the footnote_references_
+setting is "superscript".
Citation References
-------------------
-See also: Citations_
+:Doctree element: `\<citation_reference>`_
+:Start/End string: "[" "]_"
+:See also: citations_
-Doctree element: citation_reference_.
+Each citation reference consists of a square-bracketed label followed by
+a trailing underscore. Citation labels are simple `reference names`_.
-Start-string = "[", end-string = "]_".
-
-Each citation reference consists of a square-bracketed label followed
-by a trailing underscore. Citation labels are simple `reference
-names`_ (case-insensitive single words, consisting of alphanumerics
-plus internal hyphens, underscores, and periods; no whitespace).
-
For example::
Here is a citation reference: [CIT2002]_.
@@ -2994,14 +2986,14 @@
Substitution References
-----------------------
-Doctree elements: substitution_reference_, reference_.
+:Doctree elements: `\<substitution_reference>`_, `\<reference>`_
+:Start/End string: "|" (optionally followed by "_" or "__").
-Start-string = "|", end-string = "|" (optionally followed by "_" or
-"__").
+:See also: `substitution definitions`_
Vertical bars are used to bracket the substitution reference text. A
substitution reference may also be a hyperlink reference by appending
-a "_" (named) or "__" (anonymous) suffix; the substitution text is
+a "_" (named) or "__" (anonymous_) suffix; the substitution text is
used for the reference text in the named case.
The processing system replaces substitution references with the
@@ -3011,68 +3003,50 @@
Examples::
- This is a simple |substitution reference|. It will be replaced by
- the processing system.
+ This is a simple |substitution reference|. It will be
+ replaced by the processing system.
- This is a combination |substitution and hyperlink reference|_. In
- addition to being replaced, the replacement text or element will
- refer to the "substitution and hyperlink reference" target.
+ This is a combination |substitution and hyperlink reference|_.
+ In addition to being replaced, the replacement text or element
+ will refer to the "substitution and hyperlink reference" target.
+
.. _standalone hyperlink:
Standalone Hyperlinks
---------------------
-Doctree element: reference_.
+:Doctree element: `\<reference>`_
+:Start/End string: none
-No start-string or end-string.
+A URI [#URI]_ or standalone email address within a text block is treated
+as a general external hyperlink with the URI rsp. address itself as the
+link's text. For example::
-A URI (absolute URI [#URI]_ or standalone email address) within a text
-block is treated as a general external hyperlink with the URI itself
-as the link's text. For example::
+ See https://www.python.org.
- See https://www.python.org for info.
-
would be marked up in HTML as::
- See <a href="https://www.python.org">https://www.python.org</a> for
- info.
+ See <a href="https://www.python.org">https://www.python.org</a>.
-Two forms of URI are recognized:
+Two forms of standalone hyperlinks are recognized:
-1. Absolute URIs. These consist of a scheme, a colon (":"), and a
- scheme-specific part whose interpretation depends on the scheme.
+1. URIs with known schemes
+ (per the `Official IANA Registry of URI Schemes`_
+ and the W3C's `Retired Index of WWW Addressing Schemes`_).
+ Examples::
- The scheme is the name of the protocol, such as "http", "ftp",
- "mailto", or "telnet". The scheme consists of an initial letter,
- followed by letters, numbers, and/or "+", "-", ".". Recognition is
- limited to known schemes, per the `Official IANA Registry of URI
- Schemes`_ and the W3C's `Retired Index of WWW Addressing Schemes`_.
+ tel:+48-816-555-1212
+ urn:isbn:0-486-27557-4
+ news:comp.infosystems.www.servers.unix
+ https://[email protected]:123/forum/questions/?tag=networking&order=newest#top
- The scheme-specific part of the resource identifier may be either
- hierarchical or opaque:
+ With queries, fragments, and %-escape sequences, URIs can become quite
+ complicated. A reStructuredText parser must be able to recognize any
+ URI, as defined in RFC2396_ and RFC2732_.
- - Hierarchical identifiers begin with one or two slashes and may
- use slashes to separate hierarchical components of the path.
- Examples are web pages and FTP sites::
-
- https://www.python.org
-
- ftp://ftp.python.org/pub/python
-
- - Opaque identifiers do not begin with slashes. Examples are
- email addresses and newsgroups::
-
- mailto:[email protected]
-
- news:comp.lang.python
-
- With queries, fragments, and %-escape sequences, URIs can become
- quite complicated. A reStructuredText parser must be able to
- recognize any absolute URI, as defined in RFC2396_ and RFC2732_.
-
2. Standalone email addresses, which are treated as if they were
- absolute URIs with a "mailto:" scheme. Example::
+ URIs with a "mailto:" scheme. Example::
[email protected]
@@ -3090,8 +3064,6 @@
Units
=====
-(New in Docutils 0.3.10.)
-
All measures consist of a positive floating point number in standard
(non-scientific) notation and a unit, possibly separated by one or
more spaces.
@@ -3148,132 +3120,162 @@
Error Handling
----------------
-Doctree elements: system_message_, problematic_.
+:Doctree elements: `\<system_message>`_, `\<problematic>`_
-Markup errors are handled according to the specification in `PEP
-258`_.
+Markup errors are handled according to the specification in
+`PEP 258`_.
+.. References
+ ==========
+.. internal
+ --------
.. _reStructuredText: https://docutils.sourceforge.io/rst.html
.. _Docutils: https://docutils.sourceforge.io/
-.. _Docutils Generic DTD: ../docutils.dtd
-.. _transforms:
- https://docutils.sourceforge.io/docutils/transforms/
-.. _Grouch: http://www.mems-exchange.org/software/grouch/
-.. _RFC822: https://www.rfc-editor.org/rfc/rfc822.txt
-.. _DocTitle transform:
-.. _DocInfo transform:
- https://docutils.sourceforge.io/docutils/transforms/frontmatter.py
-.. _getopt.py:
- https://docs.python.org/3/library/getopt.html
-.. _GNU libc getopt_long():
- https://www.gnu.org/software/libc/manual/html_node/Getopt-Long-Options.html
-.. _doctest module:
- https://docs.python.org/3/library/doctest.html
-.. _Emacs table mode: http://table.sourceforge.net/
-.. _Official IANA Registry of URI Schemes:
- http://www.iana.org/assignments/uri-schemes
-.. _Retired Index of WWW Addressing Schemes:
- https://www.w3.org/Addressing/schemes.html
-.. _World Wide Web Consortium: https://www.w3.org/
-.. _HTML Techniques for Web Content Accessibility Guidelines:
- https://www.w3.org/TR/WCAG10-HTML-TECHS/#link-text
-.. _RFC2396: https://www.rfc-editor.org/rfc/rfc2396.txt
-.. _RFC2732: https://www.rfc-editor.org/rfc/rfc2732.txt
-.. _Zope: http://www.zope.com/
-.. _PEP 258: ../../peps/pep-0258.html
-.. _writers: ../../peps/pep-0258.html#writers
+.. _character_level_inline_markup:
+ ../../user/config.html#character-level-inline-markup
+.. _footnote_references:
+ ../../user/config.html#footnote-references
+.. _output encoding error handler:
+ ../../user/config.html#output-encoding-error-handler
+.. _strip_comments: ../../user/config.html#strip-comments
+.. _tab_width: ../../user/config.html#tab-width
+.. _trim_footnote_reference_space:
+ ../../user/config.html#trim-footnote-reference-space
+
.. _reStructuredText Directives: directives.html
-.. _admonition: directives.html#admonitions
-.. _code: directives.html#code
-.. _math: directives.html#math
-.. _raw: directives.html#raw
-.. _figure: directives.html#figure
-.. _image: directives.html#image
-.. _meta: directives.html#metadata
-.. _replace: directives.html#replace
-.. _role: directives.html#custom-interpreted-text-roles
-.. _table directive: directives.html#table
-.. _list table: directives.html#list-table
-.. _CSV table: directives.html#csv-table
+.. _"admonition": directives.html#admonitions
+.. _"code": directives.html#code
+.. _"csv-table": directives.html#csv-table
+.. _"date": directives.html#date
+.. _"default-role": directives.html#default-role
+.. _"figure": directives.html#figure
+.. _"image": directives.html#image
+.. _"list-table": directives.html#list-table
+.. _"math": directives.html#math
+.. _"meta": directives.html#metadata
+.. _"raw": directives.html#raw
+.. _"replace": directives.html#replace
+.. _"role" directive: directives.html#custom-interpreted-text-roles
+.. _"table": directives.html#table
+.. _"title": directives.html#metadata-document-title
+.. _"unicode": directives.html#unicode
.. _custom roles: directives.html#role
+.. _inline images: directives.html#inline-images
+
.. _reStructuredText Interpreted Text Roles: roles.html
+.. _"code" role: roles.html#code
+.. _"emphasis": roles.html#emphasis
+.. _"literal": roles.html#literal
.. _"raw" role: roles.html#raw
+.. _"strong": roles.html#strong
.. _Document Tree:
.. _The Docutils Document Tree: ../doctree.html
+.. _`<address>`: ../doctree.html#address
+.. _`<attribution>`: ../doctree.html#attribution
+.. _`<author>`: ../doctree.html#author
+.. _`<authors>`: ../doctree.html#authors
+.. _`<block_quote>`: ../doctree.html#block-quote
+.. _`<bullet_list>`: ../doctree.html#bullet-list
+.. _`<citation>`: ../doctree.html#citation
+.. _`<citation_reference>`: ../doctree.html#citation-reference
+.. _`<classifier>`: ../doctree.html#classifier
+.. _`<colspec>`: ../doctree.html#colspec
+.. _`<comment>`: ../doctree.html#comment
+.. _`<contact>`: ../doctree.html#contact
+.. _`<copyright>`: ../doctree.html#copyright
+.. _`<date>`: ../doctree.html#date
+.. _`<definition>`: ../doctree.html#definition
+.. _`<definition_list>`: ../doctree.html#definition-list
+.. _`<definition_list_item>`: ../doctree.html#definition-list-item
+.. _`<description>`: ../doctree.html#description
+.. _`<docinfo>`: ../doctree.html#docinfo
+.. _`<doctest_block>`: ../doctree.html#doctest-block
+.. _`<document>`: ../doctree.html#document
+.. _`<entry>`: ../doctree.html#entry
+.. _`<emphasis>`: ../doctree.html#emphasis
+.. _`<enumerated_list>`: ../doctree.html#enumerated-list
+.. _`<field>`: ../doctree.html#field
+.. _`<field_body>`: ../doctree.html#field-body
+.. _`<field_list>`: ../doctree.html#field-list
+.. _`<field_name>`: ../doctree.html#field-name
+.. _`<footnote>`: ../doctree.html#footnote
+.. _`<footnote_reference>`: ../doctree.html#footnote-reference
+.. _`<label>`: ../doctree.html#label
+.. _`<line>`: ../doctree.html#line
+.. _`<line_block>`: ../doctree.html#line-block
+.. _`<list_item>`: ../doctree.html#list-item
+.. _`<literal>`: ../doctree.html#literal
+.. _`<literal_block>`: ../doctree.html#literal-block
+.. _`<option>`: ../doctree.html#option
+.. _`<option_argument>`: ../doctree.html#option-argument
+.. _`<option_group>`: ../doctree.html#option-group
+.. _`<option_list>`: ../doctree.html#option-list
+.. _`<option_list_item>`: ../doctree.html#option-list-item
+.. _`<option_string>`: ../doctree.html#option-string
+.. _`<organization>`: ../doctree.html#organization
+.. _`<paragraph>`: ../doctree.html#paragraph
+.. _`<problematic>`: ../doctree.html#problematic
+.. _`<reference>`: ../doctree.html#reference
+.. _`<revision>`: ../doctree.html#revision
+.. _`<row>`: ../doctree.html#row
+.. _`<section>`: ../doctree.html#section
+.. _`<status>`: ../doctree.html#status
+.. _`<strong>`: ../doctree.html#strong
+.. _`<substitution_definition>`: ../doctree.html#substitution-definition
+.. _`<substitution_reference>`: ../doctree.html#substitution-reference
+.. _`<system_message>`: ../doctree.html#system-message
+.. _`<table>`: ../doctree.html#table
+.. _`<target>`: ../doctree.html#target
+.. _`<tbody>`: ../doctree.html#tbody
+.. _`<term>`: ../doctree.html#term
+.. _`<tgroup>`: ../doctree.html#tgroup
+.. _`<thead>`: ../doctree.html#thead
+.. _`<title>`: ../doctree.html#title
+.. _`<topic>`: ../doctree.html#topic
+.. _`<transition>`: ../doctree.html#transition
+.. _`<version>`: ../doctree.html#version
.. _"classes" attribute: ../doctree.html#classes
-.. _topic: ../doctree.html#topic
-.. _address: ../doctree.html#address
-.. _author: ../doctree.html#author
-.. _authors: ../doctree.html#authors
-.. _contact: ../doctree.html#contact
-.. _copyright: ../doctree.html#copyright
-.. _date: ../doctree.html#date
-.. _topic: ../doctree.html#topic
-.. _organization: ../doctree.html#organization
-.. _revision: ../doctree.html#revision
-.. _status: ../doctree.html#status
-.. _version: ../doctree.html#version
-.. _docinfo: ../doctree.html#docinfo
-.. _field: ../doctree.html#field
-.. _section: ../doctree.html#section
-.. _bullet_list: ../doctree.html#bullet-list
-.. _list_item: ../doctree.html#list-item
-.. _enumerated_list: ../doctree.html#enumerated-list
-.. _list_item: ../doctree.html#list-item
-.. _definition_list: ../doctree.html#definition-list
-.. _definition_list_item: ../doctree.html#definition-list-item
-.. _term: ../doctree.html#term
-.. _classifier: ../doctree.html#classifier
-.. _definition: ../doctree.html#definition
-.. _field_list: ../doctree.html#field-list
-.. _field_name: ../doctree.html#field-name
-.. _field_body: ../doctree.html#field-body
-.. _option_list: ../doctree.html#option-list
-.. _option_list_item: ../doctree.html#option-list-item
-.. _option_group: ../doctree.html#option-group
-.. _option: ../doctree.html#option
-.. _option_string: ../doctree.html#option-string
-.. _option_argument: ../doctree.html#option-argument
-.. _description: ../doctree.html#description
-.. _line_block: ../doctree.html#line-block
-.. _line: ../doctree.html#line
-.. _table: ../doctree.html#table
-.. _tgroup: ../doctree.html#tgroup
-.. _colspec: ../doctree.html#colspec
-.. _thead: ../doctree.html#thead
-.. _tbody: ../doctree.html#tbody
-.. _title: ../doctree.html#title
-.. _row: ../doctree.html#row
-.. _entry: ../doctree.html#entry
.. _identifier key: ../doctree.html#identifier-keys
-.. _document element: ../doctree.html#document
-.. _footnote: ../doctree.html#footnote
-.. _label: ../doctree.html#label
-.. _citation: ../doctree.html#citation
-.. _target: ../doctree.html#target
-.. _footnote_reference: ../doctree.html#footnote-reference
-.. _citation_reference: ../doctree.html#citation-reference
-.. _transition: ../doctree.html#transition
-.. _paragraph: ../doctree.html#paragraph
-.. _literal_block: ../doctree.html#literal-block
-.. _block_quote: ../doctree.html#block-quote
-.. _attribution: ../doctree.html#attribution
-.. _doctest_block: ../doctree.html#doctest-block
-.. _substitution_definition: ../doctree.html#substitution-definition
-.. _comment: ../doctree.html#comment
-.. _strong: ../doctree.html#strong
-.. _literal: ../doctree.html#literal
-.. _reference: ../doctree.html#reference
-.. _substitution_reference: ../doctree.html#substitution-reference
-.. _reference: ../doctree.html#reference
-.. _reference: ../doctree.html#reference
-.. _system_message: ../doctree.html#system-message
-.. _problematic: ../doctree.html#problematic
+.. _metadata title: ../doctree.html#title-attribute
+.. _Docutils Generic DTD: ../docutils.dtd
+.. _Docutils Internationalization:
+ ../../howto/i18n.html#docutils-language-module
+
+.. _PEP 258: ../../peps/pep-0258.html
+.. _writers: ../../peps/pep-0258.html#writers
+
+.. _transforms: ../../api/transforms.html
+.. _DocTitle transform: ../../api/transforms.html#doctitle
+.. _DocInfo transform: ../../api/transforms.html#docinfo
+.. _PreBibliographic Elements:
+ ../../api/transforms.html#prebibliographic-elements
+
+.. external
+ --------
+.. _doctest module: https://docs.python.org/3/library/doctest.html
+.. _Emacs table mode: http://table.sourceforge.net/
+.. _getopt.py: https://docs.python.org/3/library/getopt.html
+.. _GNU libc getopt_long():
+ https://www.gnu.org/software/libc/manual/html_node/Getopt-Long-Options.html
+.. _Grouch: http://www.mems-exchange.org/software/grouch/
+.. _HTML Techniques for Web Content Accessibility Guidelines:
+ https://www.w3.org/TR/WCAG10-HTML-TECHS/#link-text
+.. _Official IANA Registry of URI Schemes:
+ http://www.iana.org/assignments/uri-schemes
+.. _Retired Index of WWW Addressing Schemes:
+ https://www.w3.org/Addressing/schemes.html
+.. _RFC822: https://www.rfc-editor.org/rfc/rfc822.txt
+.. _RFC2396: https://www.rfc-editor.org/rfc/rfc2396.txt
+.. _RFC2732: https://www.rfc-editor.org/rfc/rfc2732.txt
+.. _World Wide Web Consortium: https://www.w3.org/
+.. _Zope: http://www.zope.com/
+
+
..
Local Variables:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
_______________________________________________
Docutils-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/docutils-checkins