[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org 177745e 73/85: doc/org-manual.org (Citations handli
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org 177745e 73/85: doc/org-manual.org (Citations handling): New section |
Date: |
Mon, 27 Sep 2021 15:57:54 -0400 (EDT) |
branch: externals/org
commit 177745e4c98669799bbed0eb83349cafe2a93c94
Author: Bastien <bzg@gnu.org>
Commit: Bastien <bzg@gnu.org>
doc/org-manual.org (Citations handling): New section
* doc/org-manual.org (Citations handling): New section.
---
doc/org-manual.org | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 1d6f6a8..050cca4 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -16509,6 +16509,50 @@ of the commands above, or by customizing the variable
particular if files include other files via =SETUPFILE= or =INCLUDE=
keywords.
+* Citations handling
+:PROPERTIES:
+:DESCRIPTION: create, follow and export citations.
+:END:
+#+cindex: citation
+
+Org 9.5 provides a new library =oc.el= which 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 back-end. The association
+between export back-ends 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 implementors. Most are export-specific and are located in
+the "Tools only available during export" and "Tools generating or
+operating on parsed data" sections.
+
+This section of this manual will be enhanced with more practical
+information. In the meantime, if you need help, please send an email
+to the mailing list at =emacs-orgmode@gnu.org=.
+
* Working with Source Code
:PROPERTIES:
:DESCRIPTION: Export, evaluate, and tangle code blocks.
- [elpa] externals/org 4d1a77a 32/85: org-attach: Fix byte-comp function warning, (continued)
- [elpa] externals/org 4d1a77a 32/85: org-attach: Fix byte-comp function warning, ELPA Syncer, 2021/09/27
- [elpa] externals/org 18f6ef8 33/85: ox.el: add smart quotes for greek, ELPA Syncer, 2021/09/27
- [elpa] externals/org 1c83f6f 47/85: Allow sexps with nested parenthesis in org-agenda-prefix-format, ELPA Syncer, 2021/09/27
- [elpa] externals/org d3d80c5 46/85: Add test checking org-log-done specs, ELPA Syncer, 2021/09/27
- [elpa] externals/org df51e93 53/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org 72c9f1b 43/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org acc49d5 41/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org 1f3722c 65/85: Backport commit c78e16962 from Emacs, ELPA Syncer, 2021/09/27
- [elpa] externals/org c305bb7 69/85: org-agenda: Allow org-agenda-overriding-header to be a function, ELPA Syncer, 2021/09/27
- [elpa] externals/org 2db02f9 70/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org 177745e 73/85: doc/org-manual.org (Citations handling): New section,
ELPA Syncer <=
- [elpa] externals/org 1f2c26a 15/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org 815c0b3 19/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org f5392c4 08/85: Merge branch 'km/from-emacs-master', ELPA Syncer, 2021/09/27
- [elpa] externals/org 4063d4c 06/85: org: Rename for more consistency, ELPA Syncer, 2021/09/27
- [elpa] externals/org 9a4a24a 12/85: mk/targets.mk: Fix ORGVERSION in tag-less repos, ELPA Syncer, 2021/09/27
- [elpa] externals/org 2311677 13/85: mk/server.mk: Use a new path, ELPA Syncer, 2021/09/27
- [elpa] externals/org ce99b55 14/85: Merge commit '986341bd08', ELPA Syncer, 2021/09/27
- [elpa] externals/org 26b0297 20/85: Merge branch 'bugfix', ELPA Syncer, 2021/09/27
- [elpa] externals/org 45a5f17 21/85: org-manual.org: Augment TODO keywords example, ELPA Syncer, 2021/09/27
- [elpa] externals/org 35690cd 36/85: org-src.el (org-src--contents-for-write-back): Do not indent blank lines, ELPA Syncer, 2021/09/27