emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Richard Lawrence <richard.lawrence@berkeley.edu>
To: emacs-orgmode@gnu.org
Subject: Re: exporting zotxt or orgref links to HTML and ODF
Date: Tue, 27 Jan 2015 09:24:00 -0800	[thread overview]
Message-ID: <8761bsp26n.fsf@berkeley.edu> (raw)
In-Reply-To: 878ugo8i60.fsf@gmx.us

Rasmus <rasmus@gmx.us> writes:

> IMO we /need/ to add proper citation support to Org, preferably with a
> real syntax rather than these link-"solutions" and with good backend
> support (bibtex & Zotero for starters, I guess).
> ...
> /Proper/ citation support (not links) is, IMO, the last thing that is
> missing for good academic publishing support.

Although my home-baked solution presently works for me, I am inclined to
agree.

I've just had a glance at: http://pandoc.org/README.html#citations

It looks to me like Pandoc has a quite general solution, and it also
looks like Org could use Pandoc's citation syntax as-is.  I would
suggest borrowing this syntax as a starting point for building citation
support into Org.

#+BEGIN_QUOTE
Citations go inside square brackets and are separated by
semicolons. Each citation must have a key, composed of ‘@’ + the
citation identifier from the database, and may optionally have a prefix,
a locator, and a suffix. The citation key must begin with a letter or _,
and may contain alphanumerics, _, and internal punctuation characters
(:.#$%&-+?<>~/). Here are some examples:

Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].

Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

Blah blah [@smith04; @doe99]. 

A minus sign (-) before the @ will suppress mention of the author in the
citation. This can be useful when the author is already mentioned in the
text:

Smith says blah [-@smith04].

You can also write an in-text citation, as follows:

@smith04 says blah.

@smith04 [p. 33] says blah.
#+END_QUOTE

Org does use single brackets and `@'-signs for other things (footnote
markers, priorities, statistics cookies, inactive timestamps, list
counters, inline export snippets -- I think that's it).  But these
should all be pretty easy to tell apart from citations using regular
expressions, so I wouldn't expect parsing this syntax to present any
difficulties.

Does anyone have citation needs that this syntax doesn't cover?

Using this syntax would also have the advantage that Pandoc can already
parse it, which would reduce friction for Org users who convert their
documents with Pandoc (and Pandoc users who need to deal with Org
inputs).  Since this seems like a significant contingent of Org users,
that's something to consider.

The bigger question is whether, in addition to a citation *syntax*, it
would be a lot of work to add support for the various citation database
formats, as well as the various output styles, and which ones to
support.

Best,
Richard

  parent reply	other threads:[~2015-01-27 17:25 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-26 16:29 exporting zotxt or orgref links to HTML and ODF Matt Price
     [not found] ` <54C67E1A.8080706@law.lsu.edu>
2015-01-26 20:40   ` Matt Price
2015-01-26 21:53     ` Monroe, Will
2015-01-27  8:25 ` Eric S Fraga
2015-01-27  9:23 ` Christian Moe
2015-01-27 13:30   ` Rasmus
2015-01-27 13:51     ` Matt Price
2015-01-27 14:14       ` Rasmus
2015-01-27 18:17         ` John Kitchin
2015-01-27 15:24       ` Christian Moe
2015-01-27 17:24     ` Richard Lawrence [this message]
2015-01-27 17:50       ` Rasmus
2015-01-28  4:09         ` Richard Lawrence
2015-01-27 20:01       ` Christian Moe
2015-01-27 22:08         ` Rasmus
2015-01-27 22:15         ` John Kitchin
2015-01-28  2:10         ` Matt Price
2015-01-28  6:37       ` Erik Hetzner
2015-02-01  4:20         ` Erik Hetzner
2015-01-27 12:01 ` Vikas Rawal
2015-01-27 13:12   ` Matt Price
2015-01-27 14:28     ` Eric S Fraga
2015-01-27 13:31   ` Albert Krewinkel
     [not found] ` <m2vbjsvay0.fsf@christianmoe.com>
     [not found]   ` <CAN_Dec9qBWWWgdX+wQhdgbthMg_ZOgbOMFoXFixSc4=74avMjw@mail.gmail.com>
2015-01-27 14:41     ` Christian Moe
     [not found] <CAMfbzvA83eSWe79Ot=yX+_s_g33gpLnP-z+zQ52QFJm+iJTR+Q@mail.gmail.com>
2015-01-28 21:53 ` Matt Price
2015-01-28 23:01   ` John Kitchin
2015-01-29  1:34     ` Matt Price
2015-01-29  1:48       ` John Kitchin
     [not found]         ` <CAN_Dec80Su+5Nh5mqNxBXsLu_gm93aY77B=2Zrce-TJ1RPKCig@mail.gmail.com>
2015-01-29 13:06           ` John Kitchin
2015-01-29 13:11             ` Vikas Rawal
2015-01-29 13:24               ` John Kitchin
2015-01-29 13:39                 ` Vikas Rawal
2015-01-29 13:09       ` John Kitchin
2015-01-29  2:26     ` Vikas Rawal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8761bsp26n.fsf@berkeley.edu \
    --to=richard.lawrence@berkeley.edu \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).