Footnote references, like [5]_.
Note that footnotes may get
rearranged, e.g., to the bottom of
the "page".
.. [5] A numerical footnote. Note
there's no colon after the ``]``.
|
Footnote references, like .
Note that footnotes may get
rearranged, e.g., to the bottom of
the "page".
|
Autonumbered footnotes are
possible, like using [#]_ and [#]_.
.. [#] This is the first one.
.. [#] This is the second one.
They may be assigned 'autonumber
labels' - for instance,
[#fourth]_ and [#third]_.
.. [#third] a.k.a. third_
.. [#fourth] a.k.a. fourth_
|
Autonumbered footnotes are
possible, like using and .
They may be assigned 'autonumber
labels' - for instance,
and .
|
Auto-symbol footnotes are also
possible, like this: [*]_ and [*]_.
.. [*] This is the first one.
.. [*] This is the second one.
|
Auto-symbol footnotes are also
possible, like this: and .
|
Citation references, like [CIT2002]_.
Note that citations may get
rearranged, e.g., to the bottom of
the "page".
.. [CIT2002] A citation
(as often used in journals).
Citation labels contain alphanumerics,
underlines, hyphens and fullstops.
Case is not significant.
Given a citation like [this]_, one
can also refer to it like this_.
.. [this] here.
|
Citation references, like [CIT2002].
Note that citations may get
rearranged, e.g., to the bottom of
the "page".
[CIT2002] | (1, 2) A citation
(as often used in journals). |
Citation labels contain alphanumerics,
underlines, hyphens and fullstops.
Case is not significant.
Given a citation like [this], one
can also refer to it like this.
|
External hyperlinks, like Python_.
.. _Python: http://www.python.org/
|
External hyperlinks, like Python. |
External hyperlinks, like `Python
<http://www.python.org/>`_.
|
External hyperlinks, like Python. |
Internal crossreferences, like example_.
.. _example:
This is an example crossreference target.
|
Internal crossreferences, like example.
This is an example crossreference target.
|
Python_ is `my favourite
programming language`__.
.. _Python: http://www.python.org/
__ Python_
|
Python is my favourite
programming language. |
Titles are targets, too
=======================
Implict references, like `Titles are targets, too`_.
|
Titles are targets, too
Implict references, like
Titles are targets, too.
|
Directives are a general-purpose extension mechanism, a way of adding support for new constructs without adding
new syntax. For a description of all standard directives, see reStructuredText Directives (http://is.gd/2Ecqh). |
For instance:
.. image:: magnetic-balls.jpg
:width: 55pt
:alt: silver balls in an arc
|
For instance:
|
Substitutions are like inline directives, allowing graphics and arbitrary constructs within text. |
The |biohazard| symbol must be used on containers used to
dispose of medical waste.
.. |biohazard| image:: biohazard.png
:align: middle
:width: 12
|
The symbol must be used on containers used to
dispose of medical waste. |
Any text which begins with an explicit markup start but doesn't use the syntax of any of the constructs above, is a comment. |
.. This text will not be shown
(but, for instance, in HTML might be
rendered as an HTML comment)
|
|
An "empty comment" does not
consume following blocks.
(An empty comment is ".." with
blank lines before and after.)
..
So this block is not "lost",
despite its indentation.
|
An "empty comment" does not
consume following blocks.
(An empty comment is ".." with
blank lines before and after.)
So this block is not "lost",
despite its indentation.
|