File: oc.el.html

This library provides tooling to handle citations in Org, e.g, activate, follow, insert, and export them, respectively called
"activate", "follow", "insert" and "export" capabilities.
Libraries responsible for providing some, or all, of these capabilities are called "citation processors".

Such processors are defined using org-cite-register-processor. Using this function, it is possible, in addition to giving it a name, to attach functions associated to capabilities. As such, a processor handling citation export must set the :export-citation property to an appropriate function. Likewise, "activate" capability requires an appropriate :activate property, "insert" requires :insert property and, unsurprisingly, "follow" capability implies :follow property.

As a user, the first thing to do is setting a bibliography, either globally with org-cite-global-bibliography, or locally using one or more "bibliography" keywords. Then one can select any registered processor for each capability by providing a processor name to the variables org-cite-activate-processor and org-cite-follow-processor.

The "export" capability is slightly more involved as one need to select the processor providing it, but may also provide a default style for citations and bibliography. Also, the choice of an export processor may depend of the current export backend. The association between export backends and triplets of parameters can be set in org-cite-export-processors variable, or in a document, through the "cite_export" keyword.

Eventually, this library provides some tools, mainly targeted at processor implementers. Most are export-specific and are located in the "Tools only available during export" and "Tools generating or operating on parsed data" sections.

The few others can be used directly from an Org buffer, or operate on processors. See "Generic tools" section.

Defined variables (10)

Defined functions (72)

Defined faces (0)