Re: [wip-cite-new] Initial implementation of `csl' citation processor

[Denis Maier <denismaier@mailbox.org>]

Hi,

Am 26.05.2021 um 22:33 schrieb Nicolas Goaziou:

thanks for this!

I've just tried to test this, but I can't get it to work.

I've done
git pull
make

And I'm getting:
In toplevel form:
oc-csl.el:93:1:Error: Cannot open load file: No such file or directory, 
citeproc

Do you have an idea what's going wrong here?

Best,
Denis

> Hello,
> 
> I just pushed a Citeproc-based citation processor. As such, Citeproc
> library must be available in the load path. For a better experience,
> your also need to download styles, and possibly locales definitions, as
> pointed in the commentary section pasted below.
> 
> I called it `csl' instead of `citeproc'. It is a bit ambiguous, but it
> is shorter, and "org-cite-csl" prefix sounds less redudant than
> "org-cite-citeproc...". Also, I don't expect a different CSL-based
> citation processor any time soon, so it should be fine. But I know this
> is a weak argument, so if you think "citeproc" is still more
> appropriate, I can revisit this.
> 
> As pointed out in the commentary section, this is, for a large part,
> a port of András Simonyi's Citeproc Org library. Thanks!
> 
> There are some differences between the two libraries, however. For
> example, Org Cite CSL does not support Org Ref links. It also provides
> less customization options. OTOH, it supports ".bib", ".bibtex" and
> ".json" bibliography files. It also handles author suppression and
> global affixes in citations.
> 
> This patch adds two files in a new "etc/csl/" directory. They are both
> licensed under CC BY-SA 3.0 terms. So I assume this is fine to
> distribute them with Org.
> 
> Here is the full commentary. Feedback welcome!
> 
> --8<---------------cut here---------------start------------->8---
> This library registers the `csl' citation processor, which provides
> the "export" capability for citations.  You may activate it globally with
> 
>     (setq org-cite-export-processor '(csl))
> 
> or at the document level, with
> 
>     #+cite_export: csl
> 
> The processor relies on the external Citeproc Emacs library, which must be
> available prior to loading this library.
> 
> By default, citations are rendered in Chicago author-date CSL style.  You can
> use another style file by specifying it in `org-cite-export-processor'
> 
>     (setq org-cite-export-processor '(csl "/path/to/style-file.csl")
> 
> or from within the document by adding the file name to "cite_export" keyword
> 
>     #+cite_export: csl /path/to/style-file.csl
>     #+cite_export: csl "/path/to/style-file.csl"
> 
> Styles can be downloaded, for instance, from the Zotero Style Repository
> (<https://www.zotero.org/styles>).  Dependent styles (which are not "unique"
> in the Zotero Style Repository terminology) are not supported.
> 
> The processor uses the "en-US" CSL locale file shipped with Org for rendering
> localized dates and terms in the references, independently of the language
> settings of the Org document.  Additional CSL locales can be made available
> by setting `org-cite-csl-locales-dir' to a directory containing the locale
> files in question (see <https://github.com/citation-style-language/locales>
> for such files).  The directory must contain at least the "en-US" CSL locale.
> 
> Bibliography is defined with the "bibliography" keyword.  It supports files
> with ".bib", ".bibtex", and ".json" extensions.  References are exported using
> the "print_bibliography" keyword.
> 
> The library supports the following citation styles:
> 
> - noauthor (na), including bare (b) variant,
> - default style, including bare (b) variant.
> 
> CSL styles recognize "locator" in citation references' suffix.  For example,
> in the citation
> 
>      [cite:see @Tarski-1965 chapter 1, for an example]
> 
> "chapter 1" is the locator.  The whole citation is rendered as
> 
>      (see Tarski 1965, chap. 1 for an example)
> 
> in the default CSL style.
> 
> The locator starts with a locator term, among "bk.", "bks.", "book", "chap.",
> "chaps.", "chapter", "col.", "cols.", "column", "figure", "fig.", "figs.",
> "folio", "fol.", "fols.", "number", "no.", "nos.", "line", "l.", "ll.",
> "note", "n.", "nn.", "opus", "op.", "opp.", "page", "p.", "pp.", "paragraph",
> "para.", "paras.", "¶", "¶¶", "§", "§§", "part", "pt.", "pts.", "section",
> "sec.", "secs.", "sub verbo", "s.v.", "s.vv.", "verse", "v.", "vv.",
> "volume", "vol.", and "vols.".  It ends with the last comma or digit in the
> suffix, whichever comes last, or runs till the end of the suffix.
> 
> The part of the suffix before the locator is appended to reference's prefix.
> If no locator term is used, but a number is present, then "page" is assumed.
> 
> This library was heavily inspired by and borrows from András Simonyi's
> Citeproc Org (<https://github.com/andras-simonyi/citeproc-org>) library.
> Many thanks to him!
> --8<---------------cut here---------------end--------------->8---
> 
> Regards,
>