[PATCH] org-manual.org: org-cite additions

[PATCH] org-manual.org: org-cite additions

[Bruce D'Arcus]

[-- Attachment #1: Type: text/plain, Size: 305 bytes --]

This is a minor patch to address the most obvious missing pieces that
have confused people.

Please feel free to modify; I don't really have any experience with
this, and don't have a lot of time.

For example, I'm not clear on conventions for instructing people
whether and how to load a package.

Bruce

[-- Attachment #2: 0001-org-manual-minor-org-cite-additions.patch --]
[-- Type: text/x-patch, Size: 2923 bytes --]

From bdd33dd4efc1cd237dd90dc1a5c5741604cfd807 Mon Sep 17 00:00:00 2001
From: Bruce D'Arcus <bdarcus@gmail.com>
Date: Wed, 13 Oct 2021 18:04:20 -0400
Subject: [PATCH] org-manual: minor org-cite additions

* doc/org-manual.org (Handling citations): Add note and example to load
a processor package, and on the PRINT_BIBLIOGRAPHY keyword.
---
 doc/org-manual.org | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 2cb538975..7415d9ece 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -16532,7 +16532,11 @@ capabilities:
 - insert :: Add and edit citations via ~org-cite-insert~.
 - export :: Via different libraries for different target formats.
 
-The user can configure these with ~org-cite-activate-processor~,
+To use a "citation processor", the user must load them; for example;
+
+: (require 'oc-bibtex)
+
+They can then configure them with ~org-cite-activate-processor~,
 ~org-cite-follow-processor~, ~org-cite-insert-processor~, and
 ~org-cite-export-processors~ respectively.
 
@@ -16597,15 +16601,18 @@ Org currently includes the following export processors:
   - csl :: this export processor uses format files written in [[https://en.wikipedia.org/wiki/Citation_Style_Language][Citation
     Style Language]] via [[https://github.com/andras-simonyi/citeproc-el][citeproc-el]];
 
-- In contrast, two other processors target LaTeX and LaTeX-derived
+- In contrast, three other processors target LaTeX and LaTeX-derived
   formats exclusively:
 
-  - natbib :: this export processor uses BibTeX, the historical
+  - bibtex :: this export processor uses BibTeX, the historical
     bibliographic processor used with LaTeX, thus allowing the use of
-    data and style files compatible with this processor (including
-    a large number of publishers' styles).  It uses citation commands
-    implemented in the LaTeX package =natbib=, allowing more stylistic
-    variants that LaTeX's =\cite= command.
+    data and style files compatible with this processor (including a
+    large number of publishers' styles). It only supports LaTeX's
+    =\cite= and =\nocite= commands.
+
+  - natbib :: as with the bibtex processor, but using the LaTeX
+    package =natbib=, allowing more stylistic variants that LaTeX's
+    =\cite= command.
 
   - biblatex :: this backend allows the use of data and formats
     prepared for BibLaTeX, an alternate bibliographic processor used
@@ -16638,6 +16645,11 @@ conformant to the Harvard style and the specification of the
 Wolkers-Kluwer publisher; since it relies on the ~bibtex~ processor of
 your LaTeX installation, it won't export to anything but PDF.
 
+The =PRINT_BIBLIOGRAPHY= keyword specifies where the bibliography
+should print.
+
+: #+print_bibliography:
+
 * Working with Source Code
 :PROPERTIES:
 :DESCRIPTION: Export, evaluate, and tangle code blocks.
-- 
2.33.0

Re: [PATCH] org-manual.org: org-cite additions

[Timothy]

Hi Bruce,

Thanks for this patch. I've had a read through and it all looks good to
me. I've just applied this with minor tweaks as 30dbfc6.

> This is a minor patch to address the most obvious missing pieces that
> have confused people.

--
Timothy