emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [wip-cite-new] Merging tomorrow?
@ 2021-07-08  0:17 Nicolas Goaziou
  2021-07-08  0:29 ` William Denton
                   ` (7 more replies)
  0 siblings, 8 replies; 35+ messages in thread
From: Nicolas Goaziou @ 2021-07-08  0:17 UTC (permalink / raw)
  To: Org Mode List

Hello,

I think the "wip-cite-new" branch is in good shape now. As
a consequence, I'd like to merge it tomorrow.

It is documented, but the documentation is scattered across the various
"oc" libraries, and some threads in the mailing list. I'll do a summary
here, from a user point of view.

--8<---------------cut here---------------start------------->8---
Basically, in order to use it, you need to first set-up a bibliography,
using one or more "bibliography" keywords. <C-c '> on such a keyword
visits the related file. Out of the box, Org supports JSON-CSL and
BibTeX (or biblatex) bibliographies.

Then, citations can be inserted with the following syntax:

  [cite/style:common prefix ;prefix @key suffix; ... ; common suffix]

Spaces are meaningful except those after the initial colon and before
the closing bracket.

Every part of the syntax is optional, except the brackets, "cite" and
the colon. Also the citation must contain at least a key. So its minimal
form is:

  [cite:@key]

The "style" part is detailed below, in the part related to export.

Org can insert or edit citations with <C-c C-x @> (and delete them with
<C-u C-c C-x @>), follow them with <C-c C-o>, fontify them, and export
them. These four actions (insert, follow, activate, and export) are
called capabilities.  Libraries responsible for these capabilities are
called citation processors.

You can select one citation processor for each capability, independently
on the others, through the following variables:

- org-cite-activate-processor
- org-cite-export-processors
- org-cite-follow-processor
- org-cite-insert-processor

Out of the box, Org provides the "basic" (in "oc-basic.el") processor
for all of these tasks. It also boasts processors dedicated for export:
"csl", "natbib" and "biblatex".

During export, output for citations is controlled by their style, which
is an Org label that the export processor may recognize and associate to
a specific display, or fall-back to a default style (called "nil"). For
example, most processors support "noauthor" and "text" styles. 

Some styles can accept a variant, with the syntax "style/variant".
Again, it's up to the processor to associate it to a specific display.
Common variants include "bare", "caps" or "full".  They also accept
short-hands, like "b", "c" and "f".  Please refer to the export
processors' libraries ("oc-basic.el", "oc-csl.el", …) for more information.

It is possible to define a default style for a whole document (with
"cite_export"), or for all documents (with `org-cite-export-processors').

References are displayed with the "print_bibliography" keyword. It is
possible to add parameters to its value, as some export processors could
make use of them.
--8<---------------cut here---------------end--------------->8---

Please let me know if there are any objections to the merge.

Regards,
-- 
Nicolas Goaziou


^ permalink raw reply	[flat|nested] 35+ messages in thread

end of thread, other threads:[~2021-08-20 15:57 UTC | newest]

Thread overview: 35+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-07-08  0:17 [wip-cite-new] Merging tomorrow? Nicolas Goaziou
2021-07-08  0:29 ` William Denton
2021-07-08  2:12 ` Thomas S. Dye
2021-07-08  3:18   ` Matt Price
2021-07-08  8:12     ` Greg Minshall
2021-07-08 10:09     ` Timothy
2021-07-08  3:47 ` Timothy
2021-07-08  6:31   ` Bruce D'Arcus
2021-07-08  6:47     ` Joost Kremers
2021-07-08 10:17     ` Timothy
2021-07-08 10:26       ` Nicolas Goaziou
2021-07-08 11:15         ` Bruce D'Arcus
2021-07-08 11:33           ` John Kitchin
2021-07-08 13:31         ` Timothy
2021-07-08 14:27           ` Bruce D'Arcus
2021-07-08 21:31             ` William Denton
2021-07-09  7:58               ` Timothy
2021-07-09  8:06                 ` Eric S Fraga
2021-07-08 14:36           ` Nicolas Goaziou
2021-07-08 11:39   ` Eric S Fraga
2021-07-08  7:56 ` Jens Neuhalfen
2021-07-08 11:42 ` Eric S Fraga
2021-07-08 11:50   ` Nicolas Goaziou
2021-07-08 12:49     ` Eric S Fraga
2021-07-09 13:36 ` William Denton
2021-07-09 16:07   ` Eric S Fraga
2021-07-13 15:50 ` John Kitchin
2021-08-20 13:37 ` Eric S Fraga
2021-08-20 13:46   ` Eric S Fraga
2021-08-20 13:47     ` Bruce D'Arcus
2021-08-20 13:55       ` Eric S Fraga
     [not found]       ` <87eeaonp4x.fsf@ucl.ac.uk>
2021-08-20 15:06         ` Bruce D'Arcus
2021-08-20 15:20           ` John Kitchin
2021-08-20 15:31             ` Bruce D'Arcus
2021-08-20 15:56       ` Eric S Fraga

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).