From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Richard Lawrence <richard.lawrence@uni-tuebingen.de>
Cc: org-mode-email <emacs-orgmode@gnu.org>,
Bruce D'Arcus <bdarcus@gmail.com>,
John Kitchin <jkitchin@andrew.cmu.edu>
Subject: Re: wip-cite status question and feedback
Date: Sat, 25 Apr 2020 18:19:57 +0200 [thread overview]
Message-ID: <87lfmjzgeq.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87r1wj7scc.fsf@aquinas> (Richard Lawrence's message of "Sun, 19 Apr 2020 11:11:31 +0200")
Hello,
I cannot answer all open questions as the thread would spread too thin.
So, I'll try to subsume where Org is at the moment, and what need to be
decided.
First things first, I pushed a new branch, "wip-cite-new" in the
repository, with an modified implementation of citation syntax,
hopefully taking into consideration remarks made so far. I didn't squash
"wip-cite" because citeproc-org library suggests to use it, and I didn't
want to break it.
Instead of formally describing the syntax, here are a few boring
examples:
[cite:@key]
[cite:-@key]
[cite:pre @key post]
[cite:pre @key post; pre -@key2 post]
[cite: common prefix; pre @key post; pre @key2 post; common suffix]
There is a limitation for prefixes and suffixes: they cannot contain
semicolons or closing square brackets. I'm not sure it is worth
implementing some character escape mechanism, tho.
Now with styles:
[cite/style: ...]
[cite/style/substyle: ...]
[cite/mycitationprocessor/fullcite: ...]
[cite/foot/text: ...]
[cite/style/substyle/subsubstyle/OMG: ...]
The forward slash separator gives us local citation style and a name
space. There's no limit on the depth of sub-styles. However style
strings are limited to alphanumeric characters only.
I also removed short citations:
Lorem ipsum @doe09 dolor sit amet
They look nice, but I realized this was the same mistake as allowing [1]
to be a footnote reference. False positives are way too common. This
could generate frustration upon export.
I assume [cite:...] is the default citation style, defined at the
citation processor's level. Styled citations override locally the
default style. Again, a processor not handling a given style is expected
to fallback to default style.
As a consequence, there is no special syntax for "author-in-text" style.
But we can suggest one for back-end processors. We might want to stick
to the most complete one, BibLaTeX, IIUC, and /require/ processors to
support, at least:
[cite/text: ...]
[cite/paren: ...]
With this bare minimum, we ensure documents are somehow portable between
processors, and, therefore, export back-ends.
Again, this is only a proposal, feedback is welcome. Hopefully we can
move onto the next step: how should we interface citation processors and
Org?
First, I think we agreed on the BIBLIOGRAPHY keyword, with the following
syntax:
#+BIBLIOGRAPHY: file
#+BIBLIOGRAPHY: "file"
There can be multiple BIBLIOGRAPHY keywords in a document (and
equivalent node properties). Also, I think Org should support a global
variable, e.g., `org-citation-default-bibliography'.
I also think we defined a keyword to insert a bibliography:
#+PRINT_BIBLIOGRAPHY: ... options ... (may be specific to citation processors)
I expect the processors to provide Org with a maximum two different
actions: manage and export. For example, AFAIK, Org Ref manages and
exports, citeproc-org/citeproc-el only exports, and a default processor
might realistically limit export to LaTeX and derived and management to
a default fontification of citations.
- Management ::
As suggested by John Kitchin, we want something like
`org-link-parameters'. However, I don't think it makes much sense to
let different citation processors handle different citations in the
same buffer.
Instead we can provide one global function for each of these features:
- completion
- fontification (possibly special keymaps, help-echo, etc)
- following
- am I missing something?
Citation processors may operate on the bibliography file, but that's
out of the scope of Org.
For example, we could introduce the variable
`org-citation-follow-function', which contains a function called with
two arguments: the key of the citation to follow, and the list of
bibliography files active in the buffer. Each citation processor could
set this function. By default, it would probably be
(defun org-citation-follow-default (&rest _)
(message "Please activate a citation processor to follow citations")
nil)
- Export ::
In this case, we may want to allow multiple processors for various
export back-ends. I thought about declaring active processors in
a document with a keyword, e.g.,
#+CITATION_PROCESSOR: org-ref :default-style foo :back-ends (latex)
#+CITATION_PROCESSOR: citeproc :default-style bar
and with a global variable, e.g., `org-citation-export-default' which
could be, e.g.,
'((default :defaut-style "authoryear" :back-ends (latex)))
but could become, with appropriate libraries
'((org-ref :defaut-style "authoryear" :back-ends (latex))
(citeproc-org :default-style "style-file.csl" :back-ends nil))
where more specialized back-ends are used first. Note that `latex'
would mean `latex' and derived back-ends, e.g., `beamer'.
Well, that's all for now. Again, I am not a citation specialist, so
I need feedback. Let's keep the ball rolling!
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2020-04-25 16:20 UTC|newest]
Thread overview: 139+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-10 9:29 wip-cite status question and feedback denis.maier.lists
2020-04-10 12:22 ` Bruce D'Arcus
2020-04-10 22:56 ` Nicolas Goaziou
2020-04-11 21:42 ` denis.maier.lists
2020-04-11 22:05 ` Bruce D'Arcus
2020-04-12 10:38 ` Nicolas Goaziou
2020-04-12 11:15 ` Bruce D'Arcus
2020-04-12 14:02 ` Nicolas Goaziou
2020-04-12 14:25 ` Bruce D'Arcus
2020-04-12 15:32 ` Nicolas Goaziou
2020-04-12 15:44 ` Bruce D'Arcus
2020-04-12 15:57 ` Nicolas Goaziou
2020-04-12 17:17 ` Bruce D'Arcus
2020-04-12 20:49 ` denis.maier.lists
2020-04-12 22:19 ` Nicolas Goaziou
2020-04-13 8:33 ` Stefan Nobis
2020-04-13 10:02 ` Denis Maier
2020-04-13 10:11 ` denis.maier.lists
2020-04-13 10:05 ` Bruce D'Arcus
2020-04-13 10:14 ` denis.maier.lists
2020-04-13 9:58 ` Bruce D'Arcus
2020-04-13 10:09 ` denis.maier.lists
2020-04-13 10:10 ` Joost Kremers
2020-04-13 10:46 ` Stefan Nobis
2020-04-15 5:54 ` Richard Lawrence
2020-04-15 10:07 ` Joost Kremers
2020-04-18 9:34 ` Richard Lawrence
2020-04-18 10:56 ` Bruce D'Arcus
2020-04-18 12:48 ` Richard Lawrence
2020-04-18 13:17 ` Bruce D'Arcus
2020-04-18 13:22 ` Bruce D'Arcus
2020-04-18 20:23 ` Denis Maier
2020-04-18 20:28 ` denis.maier.lists
2020-04-19 9:11 ` Richard Lawrence
2020-04-25 16:19 ` Nicolas Goaziou [this message]
2020-04-25 17:00 ` Bruce D'Arcus
2020-04-25 20:03 ` Nicolas Goaziou
2020-04-25 21:18 ` Bruce D'Arcus
2020-05-01 17:38 ` Richard Lawrence
2020-05-01 17:54 ` Bruce D'Arcus
2020-05-02 14:06 ` Nicolas Goaziou
[not found] ` <2fbf14cf-ae8c-4f7c-27f7-33771aa99492@mailbox.org>
2020-05-02 16:34 ` Nicolas Goaziou
2020-05-02 17:24 ` Denis Maier
2020-05-02 13:13 ` Nicolas Goaziou
2020-05-02 13:45 ` Bruce D'Arcus
2020-05-02 20:45 ` Richard Lawrence
2020-04-29 9:14 ` Denis Maier
2020-05-02 9:51 ` Nicolas Goaziou
2020-05-02 11:53 ` Bruce D'Arcus
2020-04-18 20:38 ` Joost Kremers
-- strict thread matches above, loose matches on Subject: below --
2020-04-07 15:15 Bruce D'Arcus
2020-04-07 17:51 ` Nicolas Goaziou
2020-04-07 18:27 ` Bruce D'Arcus
2020-04-07 18:31 ` Bruce D'Arcus
2020-04-07 21:13 ` Joost Kremers
2020-04-08 0:01 ` Bruce D'Arcus
2020-04-08 9:16 ` Joost Kremers
2020-04-08 9:32 ` Nicolas Goaziou
2020-04-08 12:19 ` Bruce D'Arcus
2020-04-08 13:39 ` John Kitchin
2020-04-08 16:12 ` Bruce D'Arcus
2020-04-09 7:38 ` Albert Krewinkel
2020-04-09 9:30 ` Bruce D'Arcus
2020-04-09 9:46 ` Bruce D'Arcus
2020-04-09 10:05 ` Bruce D'Arcus
2020-04-09 23:17 ` Nicolas Goaziou
2020-04-10 1:17 ` Bruce D'Arcus
2020-04-10 5:38 ` Albert Krewinkel
2020-04-11 11:41 ` Bruce D'Arcus
2020-04-13 12:05 ` Gustav Wikström
2020-04-13 12:33 ` Bruce D'Arcus
2020-05-24 12:12 ` Bastien
2020-05-24 13:17 ` Bruce D'Arcus
2020-05-29 21:59 ` András Simonyi
2020-05-29 22:24 ` Bruce D'Arcus
2020-05-29 22:58 ` Bruce D'Arcus
2020-06-03 14:40 ` Bastien
2020-06-03 14:53 ` Bruce D'Arcus
2020-12-14 21:24 ` Bruce D'Arcus
2021-03-24 13:22 ` Bruce D'Arcus
2021-03-24 18:27 ` M. ‘quintus’ Gülker
2021-04-11 23:15 ` Bruce D'Arcus
2021-04-12 13:19 ` Nicolas Goaziou
2021-04-12 18:53 ` András Simonyi
2021-04-16 17:05 ` András Simonyi
2021-04-16 17:23 ` Bruce D'Arcus
2021-04-18 13:11 ` Nicolas Goaziou
2021-04-18 13:35 ` Ihor Radchenko
2021-04-18 13:37 ` Bruce D'Arcus
2021-04-21 19:57 ` John Kitchin
2021-04-21 20:09 ` Bruce D'Arcus
2021-04-21 20:57 ` John Kitchin
2021-04-21 20:26 ` John Kitchin
2021-04-21 20:54 ` Bruce D'Arcus
2021-04-22 2:47 ` Timothy
2021-04-22 12:07 ` Bruce D'Arcus
2021-04-22 12:34 ` Timothy
2021-04-21 21:47 ` András Simonyi
2021-04-21 23:51 ` Nicolas Goaziou
2021-04-22 0:01 ` Bruce D'Arcus
2021-04-22 0:15 ` Nicolas Goaziou
2021-04-23 11:49 ` Nicolas Goaziou
2021-04-23 12:55 ` András Simonyi
2021-04-23 13:10 ` Bruce D'Arcus
2021-04-23 13:24 ` Bruce D'Arcus
2021-04-23 14:50 ` András Simonyi
2021-04-23 22:08 ` Bruce D'Arcus
2021-04-24 17:37 ` M. ‘quintus’ Gülker
2021-04-24 17:47 ` Nicolas Goaziou
2021-04-24 18:39 ` Bruce D'Arcus
2021-04-26 14:54 ` Bruce D'Arcus
2021-04-26 20:35 ` Denis Maier
2021-04-27 10:12 ` Bruce D'Arcus
2021-04-27 10:20 ` Timothy
2021-04-27 11:44 ` Denis Maier
2021-04-27 12:32 ` Bruce D'Arcus
2021-04-27 13:58 ` Denis Maier
2021-04-27 14:07 ` Bruce D'Arcus
2021-04-27 14:50 ` Denis Maier
2021-04-30 13:28 ` Nicolas Goaziou
2021-04-30 21:47 ` Denis Maier
2021-05-01 11:09 ` Nicolas Goaziou
2021-05-01 13:26 ` Bruce D'Arcus
2021-05-02 21:58 ` Denis Maier
2021-05-02 22:18 ` Bruce D'Arcus
2021-05-02 23:30 ` Bruce D'Arcus
2021-05-05 13:46 ` Bruce D'Arcus
2021-05-05 18:14 ` M. ‘quintus’ Gülker
2021-05-05 18:27 ` Bruce D'Arcus
2021-05-06 17:05 ` M. ‘quintus’ Gülker
2021-05-06 8:08 ` Denis Maier
2021-04-24 13:14 ` Nicolas Goaziou
2021-04-23 12:03 ` Nicolas Goaziou
2021-04-23 13:34 ` András Simonyi
2021-04-17 19:13 ` M. ‘quintus’ Gülker
2021-04-18 16:17 ` Nicolas Goaziou
2021-04-20 13:32 ` Matt Price
2021-04-21 17:07 ` Nicolas Goaziou
2021-04-21 17:53 ` Bruce D'Arcus
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=87lfmjzgeq.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=bdarcus@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=jkitchin@andrew.cmu.edu \
--cc=richard.lawrence@uni-tuebingen.de \
/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).