From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id SHGUEWW27WAuAgEAgWs5BA (envelope-from ) for ; Tue, 13 Jul 2021 17:51:01 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id aNtUDWW27WDLAwAAB5/wlQ (envelope-from ) for ; Tue, 13 Jul 2021 15:51:01 +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 062A93252 for ; Tue, 13 Jul 2021 17:51:00 +0200 (CEST) Received: from localhost ([::1]:42862 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m3KgU-0001XX-Fd for larch@yhetil.org; Tue, 13 Jul 2021 11:50:58 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59382) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m3Kg3-0001Rx-Tc for emacs-orgmode@gnu.org; Tue, 13 Jul 2021 11:50:32 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:46052) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m3Kg0-0003cJ-T0 for emacs-orgmode@gnu.org; Tue, 13 Jul 2021 11:50:31 -0400 Received: by mail-wr1-x436.google.com with SMTP id t5so17273024wrw.12 for ; Tue, 13 Jul 2021 08:50:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=andrew-cmu-edu.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=Ane03WWjRariLgGM/G2dRb8AIL/3BMkIFbeMacaH+mo=; b=c8WB4eQMPG0U38DFnSn3GiPAxypTpXACUd7PyqLbq16cuG+rhBn8jz5ydk5aeuX9kH xBVPVAHkyN6nZIY3UZyv2axUUaPwNfSCoPMfEYUJoEfiAowccAJtorpHq62W2L2uK46e ECjK3mDlFxy6Hd400o+L5CLZDkO8NO3VsoYxxkIuJEQwxKXR9B6N9ea9JREuxii2DIh7 KyQVixRsJmBcniHgyr467iQCJRAHcdWDmFwvOIQqpMqX893i3dsYmamPb03CvvQKf6d9 SsDstZ/wNX7pD012IX5ge1E3qA1JpiMduswALeBcfdHXdeY7t9+BgE+ZkbqwEz5unfiS dDJw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=Ane03WWjRariLgGM/G2dRb8AIL/3BMkIFbeMacaH+mo=; b=dmKUeAKDt9Jt/aOLFphuiOU7snnpk3+LtWrNZqMpjCOf78q5i5ZUohij8GwGqXY0Gp ELN5tsiQqQzUlDSV8RbdLpz2cPRwyj58a4GIm/SPFHUGi8Qn4wtr1ovLUFEyEFm60Lbf XEzMxfAOyjkWSOc4MBEGkDNSXXMlJ5zEAPq/8KvWHZiN9VhiPzclx9wo0peXoXJ2R1PH h4NgQJXAgoYdHSYPXOB25TIPy7ABY3aSilBMRWq0Lj7mrept9Fsmx2owkaRVoyIdARgC vs1g6dlabu0LulnDtitE8vZ/HFapaUMFymFYsxuoo9TNtDjmz2DTEMBITrX5xYrWpbo5 iY5w== X-Gm-Message-State: AOAM5302wl/4Tu2Z0QpatmlhKjTVmnprPz/M3OD6cxmA5Vw7/oQEGO6K DRwa7yfdHLaxVu2VRr9749OKF+hu4H3WScirTpHWe+H/7vSCsg== X-Google-Smtp-Source: ABdhPJzL0ZQ+zPj3CFg0+SlSES6gSQK/ATi5iYuWGU9PM0vTEyQAopxrhp9KDlZ6dmFbNQL9T7eJ/AbYto+YfAylmx0= X-Received: by 2002:a5d:4a4c:: with SMTP id v12mr6497268wrs.256.1626191426910; Tue, 13 Jul 2021 08:50:26 -0700 (PDT) MIME-Version: 1.0 References: <87lf6hr74u.fsf@nicolasgoaziou.fr> In-Reply-To: <87lf6hr74u.fsf@nicolasgoaziou.fr> From: John Kitchin Date: Tue, 13 Jul 2021 11:50:16 -0400 Message-ID: Subject: Re: [wip-cite-new] Merging tomorrow? To: Nicolas Goaziou Content-Type: multipart/alternative; boundary="000000000000567c4b05c7033266" Received-SPF: pass client-ip=2a00:1450:4864:20::436; envelope-from=johnrkitchin@gmail.com; helo=mail-wr1-x436.google.com X-Spam_score_int: -13 X-Spam_score: -1.4 X-Spam_bar: - X-Spam_report: (-1.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.248, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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: , Cc: Org Mode List 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=1626191460; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=Ane03WWjRariLgGM/G2dRb8AIL/3BMkIFbeMacaH+mo=; b=Q0mVYZwnDr32ZlUNcDvfAgDC1J2xudQAiqpU7WDAqn1jea0/0/WoRF2ksoC0DMwsfsmlug YPKiD9lmer5ah7wYRU6IRIzZ0wzAd7weP/LT2JFT96My3JI4DXDL9fSMSX0/LlaeHizlOt K4JAi2jDaurBL4do5DEYFKmB9mxgiTyu3WGIhJzmMg5hLkBY+6Vb9utUsk7Z2hHlMCED1S 7dN3FwZTuvweQvFGHcc2hU9sYMiC/EbbbAbRWV7xci09I0anVs2Py22XPBhGcW6HLay+d2 24igQvQr6n41A/WkonsU/+HUN5xSAgc/6PMTXTmd6I8TvjXJ/VxXcr1jTJ3GjA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1626191460; a=rsa-sha256; cv=none; b=abrhG3wZ6KTuoS7EqPMHU/BRyeb5JCrRYwegaTxWU1HN/WJwociW7iYA++2UAfDBV2xT1u 4ZVyIPrhfGns/xGMxFMlztRVHbbEON+9IJtp1lXfk/JhZTVKChfklJg8ItCD/dIJzm7Slw lXwLfr9rv0oEVvYfpEOOMe+vXFBWheuZDc4Ni/c1bK/9ceXev6S4qbYSCjn5fMyra7SO2k cxwBtT3CMT5dsZb9Wmn7/3zxsefjaQz2U04V279vACqfi/QMsFT4lnTg6FBXYKYRXi+K8i uQ8HYj3m1hFzNYw9I6dBWC6EDeD9Cc5240zCFowJR08X3z604JQTHwSVxJGMjw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=andrew-cmu-edu.20150623.gappssmtp.com header.s=20150623 header.b=c8WB4eQM; 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: -0.00 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=andrew-cmu-edu.20150623.gappssmtp.com header.s=20150623 header.b=c8WB4eQM; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=andrew.cmu.edu (policy=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: 062A93252 X-Spam-Score: -0.00 X-Migadu-Scanner: scn0.migadu.com X-TUID: cKJitn7hAphy --000000000000567c4b05c7033266 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Is there a timeline for when this will be available in orgmode.org/elpa or other package repository? I tried it today, but it doesn't seem to be there yet, at least not in this version: Org mode version 9.4.6 (9.4.6-10-gee652a-elpaplus @ /Users/jkitchin/Dropbox/emacs/scimax/elpa/org-plus-contrib-20210712/) John ----------------------------------- Professor John Kitchin (he/him/his) Doherty Hall A207F Department of Chemical Engineering Carnegie Mellon University Pittsburgh, PA 15213 412-268-7803 @johnkitchin http://kitchingroup.cheme.cmu.edu On Wed, Jul 7, 2021 at 8:18 PM Nicolas Goaziou wrote: > 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. > > 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 in= formation. > > 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 > > --000000000000567c4b05c7033266 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Is there a timeline for when this will be available in=C2= =A0orgmode.org/elpa or other packag= e repository? I tried it today, but it doesn't seem to be there yet, at= least not in this version:

Org mode version 9.4.6 (9.4.= 6-10-gee652a-elpaplus @ /Users/jkitchin/Dropbox/emacs/scimax/elpa/org-plus-= contrib-20210712/)

John

-----------------------------------
Prof= essor John Kitchin (he/him/his)
Doherty Hall A207F
Department of Chem= ical Engineering
Carnegie Mellon University
Pittsburgh, PA 15213
4= 12-268-7803


On Wed, Jul 7, 2021 at 8:1= 8 PM Nicolas Goaziou <mail@nic= olasgoaziou.fr> wrote:
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 s= uch 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:

=C2=A0 [cite/style:common prefix ;prefix @key suffix; ... ; common suffix]<= br>
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:

=C2=A0 [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 wi= th
<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.=C2=A0 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&qu= ot;) 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.<= br> Common variants include "bare", "caps" or "full&qu= ot;.=C2=A0 They also accept
short-hands, like "b", "c" and "f".=C2=A0 Ple= ase refer to the export
processors' libraries ("oc-basic.el", "oc-csl.el", = =E2=80=A6) 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-proce= ssors').

References are displayed with the "print_bibliography" keyword. I= t 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

--000000000000567c4b05c7033266--