From: "András Simonyi" <andras.simonyi@gmail.com>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] org-manual: Rewrite opening section in Citation handling
Date: Fri, 10 May 2024 19:06:16 +0200 [thread overview]
Message-ID: <CAOWRwxCEZcoyEfUBFCb8Bs1eWQ3qLb4JYB3Nn=wrMi6UZwqp3w@mail.gmail.com> (raw)
In-Reply-To: <87a5l3wcqf.fsf@localhost>
Dear Ihor,
thanks for working on this, I agree that the current version,
especially the introduction, was too technical, so that is a very
good direction to take. Some comments on the proposed changes:
> Org mode will gather citation metadata from =#+bibliography= database
> and use it to typeset the exported document in arbitrary formats.
> For example, below snippet shows ASCII export output.
Hopefully native speakers will chime in, but the phrase "below
snippet" sounds strange to me, I feel that "the snippet below" would
be a better solution. Also, maybe a "the" could be inserted before
"=#+bibliography= database".
> 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 Citation
> Style Language bibliographies (=csl= processor).
Perhaps the second part of the sentence would be a bit more precise
along the following lines:
"or with more generic bibliography and citation formats described
using/in the Citation Style Language (=csl= processor)"
and maybe "Citation Style Language" could link to the CSL site
https://citationstyles.org/.
> The default citation processor is =basic= - it works with arbitrary
> export formats and recognized both BiBTeX and CSL bibliographies.
Here I think there is a typo as "recognized" should be "recognizes".
> At least one =PRINT_BIBLIOGRAPHY= keyword must be present in the
> document to render citations on export.
That is not true in general, as the csl processor and most probably
some others too can render citations without a bibliography; there are
even citation styles (typically, note-based ones) that are designed to
work without a bibliography and specify all bibliographic data in
citations. Because of this I suggest removing or at least rewriting
this sentence.
best wishes,
András
On Mon, 6 May 2024 at 10:44, Ihor Radchenko <yantar92@posteo.net> wrote:
>
> Hi,
>
> The current version of Citation handling section of the manual is rather
> technical. I tried to rewrite it aiming for ordinary users not familiar
> with Org mode internals.
>
> Please, let me know if it reads better.
>
>
> --
> 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-10 17:07 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 [this message]
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
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='CAOWRwxCEZcoyEfUBFCb8Bs1eWQ3qLb4JYB3Nn=wrMi6UZwqp3w@mail.gmail.com' \
--to=andras.simonyi@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/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).