Org API

Do the right thing for footnotes.

When at a footnote reference, jump to the definition.

When at a definition, jump to the references if they exist, offer to create them otherwise.

When neither at definition or reference, create a new footnote, interactively.

With prefix arg special, offer additional commands in a menu.

Return list with all defined foot labels used in the buffer.

If with-defs is non-nil, also associate the definition to each label. The function will then return an alist whose key is label and value definition.

Is point within a footnote definition?

This matches only pure definitions like ¹ or ² at the beginning of a line. It does not match references like [fn:name:definition], where the footnote text is included and defined locally.

The return value will be nil if not at a footnote definition, and a list with label, start, end and definition of the footnote otherwise.

Is the cursor at a footnote reference?

If so, return a list containing its label, beginning and ending positions, and the definition, when inlined.

Renumber and/or sort footnotes according to user settings.

Start the definition of a footnote with label label.

Delete the footnote at point. This will remove the definition (even multiple definitions if they exist) and all references of a footnote label.

If label is non-nil, delete that footnote instead.

Delete every definition of the footnote label. Return the number of footnotes removed.

Delete every reference to footnote label. Return the number of footnotes removed.

Return label, boundaries and definition of the footnote label.

Return complete reference of the next footnote.

If label is provided, get the next reference of that footnote. If backward is non-nil, find previous reference instead. limit is the buffer position bounding the search.

Return value is a list like those provided by org-footnote-at-reference-p. If no footnote is found, return nil.

Move point to the definition of the footnote label. Return a non-nil value when a definition has been found.

Find insertion point for footnote, just before next outline heading.

Find the first closest (to point) reference of footnote with label label.

Is point in a context where footnotes are allowed?

Insert a new footnote. This command prompts for a label. If this is a label referencing an existing label, only insert the label. If the footnote label is empty or new, let the user edit the definition of the footnote.

Move point to next footnote reference or definition.

limit is the buffer position bounding the search.

Return value is a list like those provided by org-footnote-at-reference-p or org-footnote-at-definition-p. If no footnote is found, return nil.

Collect the footnotes in various formats and normalize them.

This finds the different sorts of footnotes allowed in Org, and normalizes them to the usual [N] format that is understood by the Org-mode exporters.

When sort-only is set, only sort the footnote definitions into the referenced sequence.

If Org is amidst an export process, export-props will hold the export properties of the buffer.

When export-props is non-nil, the default action is to insert normalized footnotes towards the end of the pre-processing buffer. Some exporters (docbook, odt…) expect footnote definitions to be available before any references to them. Such exporters can let bind org-footnote-insert-pos-for-preprocessor to symbol point-min to achieve the desired behaviour.

Additional note on org-footnote-insert-pos-for-preprocessor:

1. This variable has not effect when FOR-PREPROCESSOR is nil.
2. This variable (potentially) obviates the need for extra scan of pre-processor buffer as witnessed in `org-export-docbook-get-footnotes'.

Return label as an appropriate string.

Renumber the simple footnotes like fn:17 into a sequence in the document.

Return a new unique footnote label.

The function returns the first "fn:N" or "N" label that is currently not used.

Optional argument current is the list of labels active in the buffer.