docutils.transforms.references.Footnotes Class Reference

Inheritance diagram for docutils.transforms.references.Footnotes:

Collaboration diagram for docutils.transforms.references.Footnotes:

Public Member Functions
	apply (self)
	number_footnotes (self, startnum)
	number_footnote_references (self, startnum)
	symbolize_footnotes (self)
	resolve_footnotes_and_citations (self)
	resolve_references (self, note, reflist)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Public Attributes
	symbols
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Static Public Attributes
int	default_priority = 620
	autofootnote_labels = None
list	symbols
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Detailed Description

Assign numbers to autonumbered footnotes, and resolve links to footnotes,
citations, and their references.

Given the following ``document`` as input::

    <document>
        <paragraph>
            A labeled autonumbered footnote reference:
            <footnote_reference auto="1" id="id1" refname="footnote">
        <paragraph>
            An unlabeled autonumbered footnote reference:
            <footnote_reference auto="1" id="id2">
        <footnote auto="1" id="id3">
            <paragraph>
                Unlabeled autonumbered footnote.
        <footnote auto="1" id="footnote" name="footnote">
            <paragraph>
                Labeled autonumbered footnote.

Auto-numbered footnotes have attribute ``auto="1"`` and no label.
Auto-numbered footnote_references have no reference text (they're
empty elements). When resolving the numbering, a ``label`` element
is added to the beginning of the ``footnote``, and reference text
to the ``footnote_reference``.

The transformed result will be::

    <document>
        <paragraph>
            A labeled autonumbered footnote reference:
            <footnote_reference auto="1" id="id1" refid="footnote">
                2
        <paragraph>
            An unlabeled autonumbered footnote reference:
            <footnote_reference auto="1" id="id2" refid="id3">
                1
        <footnote auto="1" id="id3" backrefs="id2">
            <label>
                1
            <paragraph>
                Unlabeled autonumbered footnote.
        <footnote auto="1" id="footnote" name="footnote" backrefs="id1">
            <label>
                2
            <paragraph>
                Labeled autonumbered footnote.

Note that the footnotes are not in the same order as the references.

The labels and reference text are added to the auto-numbered ``footnote``
and ``footnote_reference`` elements.  Footnote elements are backlinked to
their references via "refids" attributes.  References are assigned "id"
and "refid" attributes.

After adding labels and reference text, the "auto" attributes can be
ignored.

Member Function Documentation

apply()

docutils.transforms.references.Footnotes.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

number_footnote_references()

docutils.transforms.references.Footnotes.number_footnote_references	(		self,
			startnum
	)

Assign numbers to autonumbered footnote references.

number_footnotes()

docutils.transforms.references.Footnotes.number_footnotes	(		self,
			startnum
	)

Assign numbers to autonumbered footnotes.

For labeled autonumbered footnotes, copy the number over to
corresponding footnote references.

resolve_footnotes_and_citations()

docutils.transforms.references.Footnotes.resolve_footnotes_and_citations

(

self

)

Link manually-labeled footnotes and citations to/from their
references.

symbolize_footnotes()

docutils.transforms.references.Footnotes.symbolize_footnotes

(

self

)

Add symbols indexes to "[*]"-style footnotes and references.

Member Data Documentation

symbols

list docutils.transforms.references.Footnotes.symbols

static

Initial value:

=  [
          # Entries 1-4 and 6 below are from section 12.51 of
          # The Chicago Manual of Style, 14th edition.
          '*',                          # asterisk/star
          '\u2020',                    # † † dagger
          '\u2021',                    # ‡ ‡ double dagger
          '\u00A7',                    # § § section mark
          '\u00B6',                    # ¶ ¶ paragraph mark (pilcrow)
                                        # (parallels ['||'] in CMoS)
          '#',                          # number sign
          # The entries below were chosen arbitrarily.
          '\u2660',                    # ♠ ♠ spade suit
          '\u2665',                    # ♡ ♥ heart suit
          '\u2666',                    # ♢ ♦ diamond suit
          '\u2663',                    # ♣ ♣ club suit
          ]

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/transforms/references.py