From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: Citation syntax: a revised proposal Date: Mon, 02 Mar 2015 21:26:00 +0100 Message-ID: <87lhjfb0yv.fsf@nicolasgoaziou.fr> References: <87k2zjnc0e.fsf@berkeley.edu> <87bnkvm8la.fsf@berkeley.edu> <87zj8co3se.fsf@berkeley.edu> <87ioezooi2.fsf@berkeley.edu> <87mw4bpaiu.fsf@nicolasgoaziou.fr> <8761aznpiq.fsf@berkeley.edu> <87twyjnh0r.fsf@nicolasgoaziou.fr> <87oaopx24e.fsf@berkeley.edu> <87k2zd4f3w.fsf@nicolasgoaziou.fr> <87egpkv8g9.fsf@berkeley.edu> <877fv6xfaq.fsf@gmail.com> <87twya2ak0.fsf@berkeley.edu> <87zj81aa97.fsf@nicolasgoaziou.fr> <87ioep2r6p.fsf@berkeley.edu> <87y4ngbgm7.fsf@nicolasgoaziou.fr> <87bnkbi61v.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:58658) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YSWtu-0007q0-0G for emacs-orgmode@gnu.org; Mon, 02 Mar 2015 15:25:15 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YSWtq-0004ta-Pp for emacs-orgmode@gnu.org; Mon, 02 Mar 2015 15:25:13 -0500 Received: from relay3-d.mail.gandi.net ([217.70.183.195]:53302) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YSWtq-0004tC-JO for emacs-orgmode@gnu.org; Mon, 02 Mar 2015 15:25:10 -0500 In-Reply-To: <87bnkbi61v.fsf@gmail.com> (Aaron Ecay's message of "Mon, 02 Mar 2015 18:54:20 +0000") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Richard Lawrence Cc: emacs-orgmode@gnu.org, John Kitchin Hello, Aaron Ecay writes: > I decided to go ahead and see what I could make of it. The result has > been pushed to the org mode repo to the branch wip-cite-awe. (I didn=E2= =80=99t > want to push to your branch without asking, but if you prefer I=E2=80=99l= l do > that and delete my own.) This is not *my* branch. However, I suggest to push only consensual features with documentation and tests there, and experiment features in other branches. > The first issue is that the parser includes trailing punctuation in > =E2=80=9Cbare=E2=80=9D @key citations. So the following does not work as= expected (the > :key includes the period): =E2=80=9CThis was demonstrated most recently by > @Smith2015.=E2=80=9D I=E2=80=99m not sure what the right approach is =E2= =80=93 one option > would be to say that keys can contain punctuation, but must end (and > begin) with an alphanumeric character. I'll update the parser once there is a new syntax for keys. At the moment, it is correct wrt syntax. > The second issue is that the :key property of the citation element > includes the @. This is not right IMO: it=E2=80=99s a detail of the synt= ax. > And it means that consumers of the syntax, who might want to look up > the key in a database, will always have to remember to strip the @. > I=E2=80=99ve pushed a provisional fix for this in my branch. Please apply it to wip-cite. A dedicated test would be nice, too. > The code is very rough and ready, has lots of TODO comments in it, is > missing tests, documentation in the manual, etc. Nonetheless, I want to > get feedback on it early, given that many people have already contributed > so much useful information to this discussion. I didn't look closely at the code, but I suggest to use "org-cite.el" instead of "ox-cite.el". Even though this is only related to export at the moment, this library will also contain commands to manipulate citation objects. It also shorten prefix for these functions. Thanks for your work, Regards, --=20 Nicolas Goaziou