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 2IFkCvav5mDqAgAAgWs5BA (envelope-from ) for ; Thu, 08 Jul 2021 09:57:42 +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 gC4yBvav5mAIIAAA1q6Kng (envelope-from ) for ; Thu, 08 Jul 2021 07:57:42 +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 52B0823CD0 for ; Thu, 8 Jul 2021 09:57:41 +0200 (CEST) Received: from localhost ([::1]:50074 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m1Oui-00061B-Cw for larch@yhetil.org; Thu, 08 Jul 2021 03:57:40 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:37298) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m1OuG-0005yD-Vp for emacs-orgmode@gnu.org; Thu, 08 Jul 2021 03:57:13 -0400 Received: from mail.neuhalfen.name ([144.76.61.246]:50746) by eggs.gnu.org with esmtps (TLS1.2:DHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m1OuE-0001cI-QO for emacs-orgmode@gnu.org; Thu, 08 Jul 2021 03:57:12 -0400 Content-Type: text/plain; charset=utf-8 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=neuhalfen.name; s=2019; t=1625731019; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Jr6QrWlUb5T8SiJLbTuPlta/TW4Qvno50RzYNiJNbZ8=; b=bnFAFushi9yCyIChvEA/zRViGhqtGgwBQlaJbGxloEI3j4B/2L0CLuTeCv+XQ+OyhLZ7yT wqf87WoS/pDU9qsPgTHnfUgLzqiMtjS/skJUNjM73Nk3DW/GIsiHmsgytVZfhUn4Dpcb5/ VY+HU7xRnDD/yOWUU91TEaBsfYEGhhA/e6pIeDSzDVuzKfE5nshcDTWpH9fBQhnfxvvu98 VP08pNEKKvIaK05EiS9U1f0s8wOjsplhGtEyPkhYkLuXYqwqPg5uy1tklPixlyXcza/KSf vetdX/ptgjx9YCb0zjRlfEnBiAupC9Zl7mIpXH9BZboZNmgFND0jzvCXJTVqpA== Content-Transfer-Encoding: quoted-printable From: Jens Neuhalfen Mime-Version: 1.0 (1.0) Subject: Re: [wip-cite-new] Merging tomorrow? Date: Thu, 8 Jul 2021 09:56:57 +0200 Message-Id: References: <87lf6hr74u.fsf@nicolasgoaziou.fr> In-Reply-To: <87lf6hr74u.fsf@nicolasgoaziou.fr> To: Nicolas Goaziou Received-SPF: pass client-ip=144.76.61.246; envelope-from=jens@neuhalfen.name; helo=mail.neuhalfen.name X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, MIME_QP_LONG_LINE=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: , 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=1625731061; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=Jr6QrWlUb5T8SiJLbTuPlta/TW4Qvno50RzYNiJNbZ8=; b=EjRfFT2Sth5RopeR3ZBUzyQ8LjlqnVUwN+ROfJZyXs88Kv+K3orWO6yELQBohrw47r2kQ3 hfJ5QTp0biZ5voSYxr952e+ObQ4ulSY4VkVokI4YQDPIgrzfG7vcKPY2vhF148EOFF8vrx egEtG4CaW5YAak0TKU/ZtTn5zXdnudc5ddD1RTo9VKa8PsJO5EH1cSgAgr7K2qEaIwLo64 Q4f4DCRjvobzKVB4Qt7/hrcG1ytGMccBe85tT1o6MIQHQTfnu9BIUgntKREKHAeu3vSF1F G2P9Sk4a6UKpgtn8kdxkmPiHiJHmTsapkz0IaBbYWay5tt8KTWOz5hgBoe0Nug== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1625731061; a=rsa-sha256; cv=none; b=nXVhnPjjIdIS1UQERFKoKYh5rMLTM5euDbvZ3SQ39Nsp48Cmj12mN1Fx3vNC42wmcKy+SQ ws1HqzrmiCHDGt0DvQLVsp3s1gq43tGtyi4ovTGhpRmsL7GKZl0nZ2RfAmkLeWfyRcpDQV Qtws5QAIDaiNqSZ7/7E9hK2F1hcaqiE3Q4SN9exf+qTcHwVe4wsXWNdNEvT/mrwXLVx+lR iIu33dyOVDHk/3yTsk+ZKHX4ze14b1JxkEDF+d/Z0UTAhtalxup6O/vPTTVxa5ZMj/sjS+ 66kI/7PiBDU/NaaLX1Qpnl0+FTKYAlGbEUnX66Y/JacHETgPAGqCzL2ehrBo7Q== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=neuhalfen.name header.s=2019 header.b=bnFAFush; 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.61 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=neuhalfen.name header.s=2019 header.b=bnFAFush; dmarc=pass (policy=none) header.from=neuhalfen.name; 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: 52B0823CD0 X-Spam-Score: -1.61 X-Migadu-Scanner: scn0.migadu.com X-TUID: cWOUo6Ks6hf0 Hi Nicolas, first: thank you for all the work, especially for thinking of documentation f= or end users. My biggest struggle with the current org (and emacs) documenta= tion is the lack of end-to-end examples. This makes it incredibly difficult t= o get things working. It often is like =E2=80=9Ethis is a big puzzle, some p= ieces are in other boxes and we don=E2=80=99t provide a picture of how the f= inal puzzle will look like=E2=80=9C. The documentation often makes sense onc= e I get it running, though . But this is to late. This being the motivation, I would greatly appreciate the following: =E2=80=94=E2=80=94=E2=80=94 snip =E2=80=94=E2=80=94=E2=80=94- Consider the following minimal viable example where an org file with one bib= tex file is rendered to pdf and html. This is the BibTex file #+begin_example bibtex =E2=80=A6. #+end_example This is the org file #+begin_example org =E2=80=A6. #+end_example and this is the rendered html/Latex=20 - picture 1 - screenshot 2 This has been achieved with the following minimal configuration: #+begin_example elisp=20 =E2=80=A6. #+end_example As you can see in line 42 the =E2=80=A6 etc, etc If you would like to use two bibtex files you would need to change =E2=80=A6= #+begin_example elisp=20 =E2=80=A6. ; change line 14 in the sample for one file like this: (=E2=80=A6) =E2=80=A6 #+end_example =E2=80=94=E2=80=94- snap =E2=80=94=E2=80=94- That kind of documentation would have made many, many hours of frustrating =E2= =80=9Esearch in google/github for a solution someone else has found=E2=80=9C= and replace it with =E2=80=9Ewow that was actually quite beginner friendly!= =E2=80=9C. Pictures also make it much easier to visualize what is actually a= chieved. Cheers Jens > On 8. Jul 2021, at 02:18, Nicolas Goaziou wrote: >=20 > =EF=BB=BFHello, >=20 > I think the "wip-cite-new" branch is in good shape now. As > a consequence, I'd like to merge it tomorrow. >=20 > 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. >=20 > --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. >=20 > Then, citations can be inserted with the following syntax: >=20 > [cite/style:common prefix ;prefix @key suffix; ... ; common suffix] >=20 > Spaces are meaningful except those after the initial colon and before > the closing bracket. >=20 > 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: >=20 > [cite:@key] >=20 > The "style" part is detailed below, in the part related to export. >=20 > 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. >=20 > You can select one citation processor for each capability, independently > on the others, through the following variables: >=20 > - org-cite-activate-processor > - org-cite-export-processors > - org-cite-follow-processor > - org-cite-insert-processor >=20 > 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". >=20 > 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 >=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 inf= ormation. >=20 > It is possible to define a default style for a whole document (with > "cite_export"), or for all documents (with `org-cite-export-processors'). >=20 > 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--- >=20 > Please let me know if there are any objections to the merge. >=20 > Regards, > --=20 > Nicolas Goaziou >=20