IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add global citations. #1.

Browse Source
This commit is contained in:
Georg Brandl
2008-10-25 15:54:34 +00:00
parent bcd1a78d83
commit 29a3a86cef
10 changed files with 121 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/rest.rst
View File

@@ -240,17 +240,34 @@ the former, while the HTML builder would prefer the latter.
Footnotes
---------
For footnotes, use ``[#]_`` to mark the footnote location, and add the footnote
body at the bottom of the document after a "Footnotes" rubric heading, like so::
For footnotes, use ``[#name]_`` to mark the footnote location, and add the
footnote body at the bottom of the document after a "Footnotes" rubric heading,
like so::
Lorem ipsum [#]_ dolor sit amet ... [#]_
Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_
.. rubric:: Footnotes
.. [#] Text of the first footnote.
.. [#] Text of the second footnote.
.. [#f1] Text of the first footnote.
.. [#f2] Text of the second footnote.
You can also explicitly number the footnotes for better context.
You can also explicitly number the footnotes (``[1]_``) or use auto-numbered
footnotes without names (``[#]_``).
Citations
---------
Standard reST citations are supported, with the additional feature that they are
"global", i.e. all citations can be referenced from all files. Use them like
so::
Lorem ipsum [Ref]_ dolor sit amet.
.. [Ref] Book or article reference, URL or whatever.
Citation usage is similar to footnote usage, but with a label that is not
numeric or begins with ``#``.
Comments