From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id gGagAFBE5mB61wAAgWs5BA (envelope-from ) for ; Thu, 08 Jul 2021 02:18:24 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id kETuN09E5mCVAwAA1q6Kng (envelope-from ) for ; Thu, 08 Jul 2021 00:18:23 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 6183A1F86E for ; Thu, 8 Jul 2021 02:18:23 +0200 (CEST) Received: from localhost ([::1]:37790 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m1HkD-0005KT-7l for larch@yhetil.org; Wed, 07 Jul 2021 20:18:21 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:33404) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m1Hjd-0005K5-2m for emacs-orgmode@gnu.org; Wed, 07 Jul 2021 20:17:45 -0400 Received: from relay2-d.mail.gandi.net ([217.70.183.194]:42203) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m1Hja-0002ic-Gg for emacs-orgmode@gnu.org; Wed, 07 Jul 2021 20:17:44 -0400 Received: (Authenticated sender: admin@nicolasgoaziou.fr) by relay2-d.mail.gandi.net (Postfix) with ESMTPSA id A51B040004 for ; Thu, 8 Jul 2021 00:17:38 +0000 (UTC) From: Nicolas Goaziou To: Org Mode List Subject: [wip-cite-new] Merging tomorrow? Date: Thu, 08 Jul 2021 02:17:37 +0200 Message-ID: <87lf6hr74u.fsf@nicolasgoaziou.fr> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=217.70.183.194; envelope-from=mail@nicolasgoaziou.fr; helo=relay2-d.mail.gandi.net X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1625703503; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=6KQLw+yTaj8sE1OPuqz0QssLCY8oZJdugUdvjF93ZVg=; b=S8/bONIonwbE3SRgQxcgloMvJuhTs8wK4nFzO0u50AZqET6ZxDflCRjwWBz094i4tNgCUt ZKF4UNymwGisGSSRcyBDi4WImh6j0motB81O7RKul0glPIQ3IC3f5EljHKb9qnzc6WctOi Azer+TDcUZ9aesKPkhsNxrmbKvyFWAzKOECzKvlzLPrPvg8bPZ7lXYbStV58TfToGAGuSu AVMGpqSF35q4Qmaf44v1w4CdN2QHXtVwzCqjuZ7QE4maeOJh0DBQu6etLn4qXIOQ+03cjf uV3shJWDxzs2/fLIvZt+OLNsFzVHtX7hRttXNvpr0pARhf+y9C79Gz3/3sYd5Q== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1625703503; a=rsa-sha256; cv=none; b=ewEeNNxv756Gj1FOIkXPEmpxdbMvFEK1L5j8q+Vuy+ATgoIl8fcgYid9JukxP7n77kJHir MI8TL0sk8BJcqkgncOLP11n808dTAanvUZ19qDa7u04x04IZGZfmHxK9tbcANmWInr3EnT bFgw8ZaRa6xjc96dks4CpI24/qkeScQ4eqKEURC9cDU7RlT80a1Lkin6MVm0/QGUuY2EAf Qdxgc02oE5KZRiabwWJOKoU8zDGwqkGtFQNJ+BWT1ebdoyNHO3WdLoFeaweym/ngXQVqqg mQUgJi5FRgUG01T7rxFdQpX/oHp+2yNP35yBoOaA8f7YlypyTVtJdwOgPDZYFg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -1.41 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: 6183A1F86E X-Spam-Score: -1.41 X-Migadu-Scanner: scn0.migadu.com X-TUID: CJuZHEjTTmsE 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. 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 (and delete them with ), follow them with , 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.=20 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", =E2=80=A6) for more info= rmation. 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, --=20 Nicolas Goaziou