From: Ihor Radchenko <yantar92@posteo.net>
To: Rens Oliemans <hallo@rensoliemans.nl>
Cc: "András Simonyi" <andras.simonyi@gmail.com>, emacs-orgmode@gnu.org
Subject: Re: [PATCH] org-manual: Rewrite opening section in Citation handling
Date: Fri, 17 May 2024 11:00:16 +0000 [thread overview]
Message-ID: <87eda0aekf.fsf@localhost> (raw)
In-Reply-To: <87wmnwrzk2.fsf@rensoliemans.nl>
[-- Attachment #1: Type: text/plain, Size: 964 bytes --]
Rens Oliemans <hallo@rensoliemans.nl> writes:
> Thanks for the patch, it looks good and is an improvement over the
> somewhat terse previous version. I do have some thoughts though so will
> chime in. ...
Thanks! I have incorporated all your suggestions into the new version of
the patch (attached).
>> - When style is not specified, default style is used
>> + When style is not specified, default style (=nil=) specified by the
>> + citation processor is used
>
> I am only slightly familiar with Org's citation handling, and this part
> of the manual is a bit confusing to me. I wrote a small patch on top of
> yours with something that is clearer to me, but perhaps this is unique to
> me.
Your changes look reasonable.
> PS: is such a way of including a patch (that builds upon a discussed
> patch) the best way to communicate changes?
Yes, it is. Applying diff is easy - easier than manually editing the
changes according to comments in the email.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: v3-0001-org-manual-Add-better-opening-description-to-Cita.patch --]
[-- Type: text/x-patch, Size: 8606 bytes --]
From 751d73fd0ae00a9a017cd73d5c6c7b2eb7412b5b Mon Sep 17 00:00:00 2001
Message-ID: <751d73fd0ae00a9a017cd73d5c6c7b2eb7412b5b.1715943408.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Mon, 6 May 2024 11:40:18 +0300
Subject: [PATCH v3] org-manual: Add better opening description to "Citation
handling" section
* doc/org-manual.org (Citation handling): Rewrite the opening
paragraphs describing citations using less technical description. The
new version aims to ordinary Org mode users and avoids talking about
Elisp libraries.
(Citations): Unify markup for citation processor names (use verbatim).
Mention that at least one #+PRINT_BIBLIOGRAPHY is mandatory to render
output. Indicate that default citation style is "nil".
---
doc/org-manual.org | 99 ++++++++++++++++++++++++++++++++--------------
1 file changed, 70 insertions(+), 29 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index e3a2c9b70..920114f70 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -17493,30 +17493,68 @@ * Citation handling
#+cindex: citation
#+cindex: citation processor
-The =oc.el= library provides tooling to handle citations in Org via
-"citation processors" that offer some or all of the following
-capabilities:
+While links (see [[*Hyperlinks]]) are often sufficient to refer to
+external or internal information from Org, they have their limitations
+when referring to multiple targets or typesetting printed
+publications.
-- activate :: Fontification, tooltip preview, etc.
-- follow :: At-point actions on citations via ~org-open-at-point~.
-- insert :: Add and edit citations via ~org-cite-insert~.
-- export :: Via different libraries for different target formats.
+Org mode provides a more sophisticated markup to "cite" external
+resources. For example, consider the following Org mode snippet
-To use a "citation processor", the user must load them; for example;
+: #+bibliography: citationdata.bib
+:
+: Org mode is used by various communities [cite:teaching: @orgteaching;
+: and TeX: @orgtex]. [cite/author/caps:@orgtex] uses Org mode to simplify
+: writing scientific publications, while [cite/author/caps:@orgteaching]
+: experiment with Org babel to improve teaching.
+:
+: #+print_bibliography:
-#+begin_src emacs-lisp
-(require 'oc-bibtex)
-#+end_src
+Org mode will gather citation metadata from the =#+bibliography=
+database and use it to typeset the exported document in arbitrary
+formats. For example, the snippet below shows ASCII export output.
+
+: Org mode is used by various communities (teaching: Birkenkrahe, Marcus,
+: 2023, and TeX: Somma, Emmanuele F, 2023). Somma, Emmanuele F uses Org
+: mode to simplify writing scientific publications, while Birkenkrahe,
+: Marcus experiment with Org babel to improve teaching.
+:
+: Birkenkrahe, Marcus (2023). /Teaching Data Science with Literate
+: Programming Tools/, MDPI.
+:
+: Somma, Emmanuele F (2023). /Simplifying LaTeX with ORG-mode in Emacs/,
+: TUGboat volume.
+
+In addition to export, users can use completion to search and insert
+citations from the bibliography (via ~org-cite-insert~). Citations
+also act like ordinary links, jumping to the citation metadata when
+"following" them using ~org-open-at-point~.
+
+You can customize every aspect (/capability/) of citation handling
+using built-in or external /citation processors/.
+
+Org mode ships with several built-in citation processors tailored to
+work with LaTeX export and BibTeX bibliographies (=bibtex=,
+=biblatex=, and =natbib= processors), or with more generic formats
+described using [[https://citationstyles.org/][Citation Style
+Language]] (=csl= processor).
+The default citation processor is =basic= - it works with arbitrary
+export formats and recognizes both BibTeX and CSL bibliographies.
+More citation processors are distributed as Emacs packages.
#+vindex: org-cite-activate-processor
#+vindex: org-cite-follow-processor
#+vindex: org-cite-insert-processor
#+vindex: org-cite-export-processor
-They can then configure them with ~org-cite-activate-processor~,
-~org-cite-follow-processor~, ~org-cite-insert-processor~, and
-~org-cite-export-processors~ respectively.
+Multiple citation processors can be mixed to meet your preferences.
+Configure ~org-cite-activate-processor~, ~org-cite-follow-processor~,
+~org-cite-insert-processor~, and ~org-cite-export-processors~ to
+select which processor to use for every citation capability:
-The included "basic" processor provides all four capabilities.
+- activate :: Fontification, tooltip preview, etc.
+- follow :: At-point actions on citations via ~org-open-at-point~.
+- insert :: Add and edit citations via ~org-cite-insert~.
+- export :: Via different libraries for different target formats.
** Citations
@@ -17570,15 +17608,16 @@ ** Citations
: [cite/style:common prefix ;prefix @key suffix; ... ; common suffix]
- When style is not specified, default style is used
+ When =style= is not specified, one of the two default styles are
+ used
- + either the default style specified in =CITE_EXPORT= keyword (see
- [[*Citation export processors]])
+ + either the default style specified in the =CITE_EXPORT= keyword
+ (see [[*Citation export processors]])
: #+cite_export: basic numeric noauthor/bare
: [cite:@key] is the same as [cite/noauthor/bare:@key]
- + or using default =nil= style
+ + or, if =CITE_EXPORT= is not set, using the default =nil= style
: [cite:@key] is the same as [cite/nil:@key]
@@ -17600,8 +17639,10 @@ ** Citation export processors
where backward compatibility is not a requirement and formatting
needs are minimal;
- - 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]];
+ - 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, three other processors target LaTeX and LaTeX-derived
formats exclusively:
@@ -17630,13 +17671,13 @@ ** Citation export processors
: #+cite_export: basic author-year author
#+texinfo: @noindent
-specifies the "basic" export processor with citations inserted as
+specifies the =basic= export processor with citations inserted as
author's name and references indexed by author's names and year;
: #+cite_export: csl /some/path/to/vancouver-brackets.csl
#+texinfo: @noindent
-specifies the "csl" processor and CSL style, which in this case
+specifies the =csl= processor and CSL style, which in this case
defines numeric citations and numeric references according to the
=Vancouver= specification (as style used in many medical journals),
following a typesetting variation putting citations between brackets;
@@ -17674,8 +17715,8 @@ ** Bibliography printing
: #+print_bibliography:
The bibliography printed by the LaTeX-based export processors
-"bibtex", "natbib" and "biblatex" has a chapter or section heading by
-default, while the "basic" and "csl" processors print the list of
+=bibtex=, =natbib= and =biblatex= has a chapter or section heading by
+default, while the =basic= and =csl= processors print the list of
bibliography entries without a heading.
A document may contain more than one =PRINT_BIBLIOGRAPHY= keywords.
@@ -17688,9 +17729,9 @@ ** Bibliography printing
the different citation export processors. Some export processors do
not support passing options.
-*** Bibliography options in the "biblatex" and "csl" export processors
+*** Bibliography options in the =biblatex= and =csl= export processors
-The "biblatex" and "csl" export processors support bibliography
+The =biblatex= and =csl= export processors support bibliography
options through a property list attached to the =PRINT_BIBLIOGRAPHY=
keyword. For example,
@@ -17702,10 +17743,10 @@ *** Bibliography options in the "biblatex" and "csl" export processors
: #+print_bibliography: :keyword "algebraic logic" :nottype article,book
-The "biblatex" export processor accepts all options supported by
+The =biblatex= export processor accepts all options supported by
BibLaTeX's ~\printbibliography~ command.
-The "csl" processor accepts the following options:
+The =csl= processor accepts the following options:
- =:keyword <keyword(,keyword2...)>= :: Print only entries whose
keyword field contains all given keywords.
--
2.45.1
[-- Attachment #3: Type: text/plain, Size: 224 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2024-05-17 10:59 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-06 8:44 [PATCH] org-manual: Rewrite opening section in Citation handling Ihor Radchenko
2024-05-10 17:06 ` András Simonyi
2024-05-11 9:56 ` Ihor Radchenko
2024-05-14 7:10 ` András Simonyi
2024-05-14 18:58 ` Rens Oliemans
2024-05-17 11:00 ` Ihor Radchenko [this message]
2024-05-18 20:21 ` Rens Oliemans
2024-05-20 13:25 ` Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87eda0aekf.fsf@localhost \
--to=yantar92@posteo.net \
--cc=andras.simonyi@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=hallo@rensoliemans.nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).