From: Eric Schulte <schulte.eric@gmail.com>
To: Joseph Vidal-Rosset <joseph.vidal.rosset@gmail.com>
Cc: emacs-orgmode list <emacs-orgmode@gnu.org>, Rasmus <rasmus@gmx.us>
Subject: Re: Let's discuss citation and Org syntax
Date: Thu, 02 Jan 2014 11:33:00 -0700 [thread overview]
Message-ID: <87k3eiz0zw.fsf@gmail.com> (raw)
In-Reply-To: CAD-VTcH08AOY8ZtUpO-ge6HuSHs8C1YAWg3-OuiGBNbaz3JdgA@mail.gmail.com
Take a look at ox-bibtex.el in contrib [1], which adds support for
bibtex citations. The commentary at the top of that file explains the
usage, but in brief, ox-bibtex adds cite: links which will export to
HTML, ASCII and LaTeX (using bibtex2html [2] for HTML export, and pandoc
[3] for ASCII export).
For example, I've used ox-bibtex to write this Org file [4], which
exports to this HTML [5], as well as LaTeX.
Best,
Joseph Vidal-Rosset <joseph.vidal.rosset@gmail.com> writes:
> Hi Rasmus, hi the list,
>
> Reading this thread I've understood that the question of html export of
> biblatex citations is still an open problem for org-mode developers, right
> ?
>
> Thanks to the online manual and the help of the list, I have succeeded to
> write a template of koma-article class which is correctly exported both in
> latex and in html. But I meet the problem of exporting into html footnotes
> and references.
>
> At the moment, what is the best i.e. the more convenient solution?
>
> My best wishes for this new year,
>
> Jo.
>
>
> 2013/5/21 Rasmus <rasmus@gmx.us>
>
>> Hi,
>>
>> Now that 8.0 has shipped let's talk bibliography support. This
>> follows directly upon the discussion around March[1].
>>
>> The essence of the thread was that some people agreed that it would be
>> nice to have support for citation commands build into Org (I'll
>> summarize in the next post). But let me first restate my own take on
>> the issue. IMO a nice format would be:
>>
>> (*) [KEYWORD PROPERTIES]
>>
>> I think we should allow for a more general approach than one just for
>> citation and this is a good thing (IMO).
>>
>> The in-buffer display of (*) could be governed by
>> org-buffer-format-KEYWORD (similar to
>> gnus-user-format-function-LETTER) or just identity if no function is
>> defined. Export could be handled by org-BACKEND-KEYWORD or
>> org-export-KEYWORD. With officially recognized KEYWORDs something
>> like citation could be a 'first-class citizen'. PROPERTIES could be a
>> string like:
>>
>> optional-keyless-entry :prop1 one :prop2 two ...
>>
>> Perhaps, treatment of keyword, could even be handled by an
>> in-buffer Org Babel function in the spirit of e.g. reproducible
>> research (see below).
>>
>> This would be different from Org links in that (*) is more like a
>> functions that allows for (i) pretty and informative display in
>> buffer/export and (ii) easy user extension.
>>
>> I think there are many compelling use-cases for such a framework.
>>
>> 1. Citation: Take the keyword citetext which should be an 'official'
>> KEYWORD. So for instance we could have
>>
>> [citetext BIBTEX-KEY :prenote note, w/comma :postnote blah].
>>
>> In buffers, via org-in-buffer-format-citetext, it would be
>> displayed as
>>
>> BIBTEX-KEY (note, w/comma, YEAR, blah)
>>
>> or something similar (depending to what extend bibtex.el would be
>> leveraged; e.g. BIBTEX-KEY might show the author/editor key and
>> YEAR would also depend on parsing a bibtex file) (obviouesly,
>> there's some reference to a bibtex file somewhere). In LaTeX it
>> would be exported as
>>
>> \citetext[note,w/comma][blah]{BIBTEX-KEY}
>>
>> In html it might utilize some tool that understand bibtex (there's
>> a link to such a tool in the next post). In ASCII it could almost
>> use what would be displayed in the buffer.
>>
>> 2. MY-FUN: MY-FUN is some function that does something with some
>> properties, perhaps just a string (simple cases: [sc text] is used
>> for small caps, or mayhaps [my-treat-dna-string DNA-STRING]). I
>> might use it in a single file that I want to send to people or I
>> might just use it in my notes. Currently it's implemented via
>> org-emphasis-alist or as a link. Changing emphases is a hacks, and
>> they are hard to export with the now more robust Org syntax and
>> further permit little control over how they are displayed
>> in-buffer. Links are more flexible but lacks display control and
>> becomes somewhat painful with many arguments[2]. Also, MY-FUN
>> doesn't take a 'description'. With (*) I could simply write
>>
>> [MY-FUN PROPERTIES].
>>
>> Perhaps, I could even define org-BACKEND-MY-FUN in a babel block
>> if it's only relevant to the current file.
>>
>> There's been some work and some discussion on this already, most
>> notably Aaron already supplied some patches towards this end[3],
>> but using a slightly different syntax more like the link syntax;
>> e.g. textcite above would look like
>>
>> [[textcite:bibtex-key&&pre%3Dfoo&&post%3Dbar][whatever]]
>>
>> where whatever is ignored. The state of the discussion is to some
>> extend summarized in the next post.
>>
>> It would love to hear whether other people find something like this to
>> be a good idea? Would anyone find a use such a framework? Would (*)
>> conflict with anyone's current usage of Org? Is (*) too ambitious and
>> in terms of getting citation support? Is this is taking a musket to
>> kill a butterfly? What are the the flaws in the above.
>>
>> I'm not a good (lisp) programmer, but I think I have a month off this
>> summer where I could work on something like the above.
>>
>> Thanks for reading,
>> Rasmus
>>
>> Footnotes:
>> [1] http://mid.gmane.org/20130303070635.GA12112%40panahar
>> [2] my citation links often look like postnote;prenote without
>> showing the BIBTEX-KEY or citation format.
>> [2] here http://mid.gmane.org/87lia0s7wi.fsf%40bzg.ath.cx
>> and here http://mid.gmane.org/87wqthk7vj.fsf%40gmail.com.
>>
>>
>> --
>> When in doubt, do it!
>>
>>
>>
Footnotes:
[1] http://orgmode.org/w/?p=org-mode.git;a=blob_plain;f=contrib/lisp/ox-bibtex.el;hb=HEAD
[2] http://www.lri.fr/~filliatr/bibtex2html/
[3] http://johnmacfarlane.net/pandoc/
[4] https://github.com/eschulte/netgear-repair/blob/master/pub/netgear-repair.org
[5] http://eschulte.github.io/netgear-repair/pub/netgear-repair.html
--
Eric Schulte
https://cs.unm.edu/~eschulte
PGP: 0x614CA05D
next prev parent reply other threads:[~2014-01-02 18:36 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-05-21 12:21 Let's discuss citation and Org syntax Rasmus
2013-05-21 12:25 ` Rasmus
2013-05-22 9:02 ` Christian Moe
2013-05-22 16:23 ` Matt Price
2013-05-23 8:05 ` Christian Moe
2013-05-26 14:23 ` Darlan Cavalcante Moreira
2013-05-26 19:12 ` Christian Moe
2013-06-27 6:17 ` Christian Wittern
2013-05-21 17:55 ` Viktor Rosenfeld
2013-05-21 18:18 ` Rasmus
2013-05-21 21:34 ` Marcin Borkowski
2013-05-22 21:53 ` Matt Lundin
2013-05-22 5:36 ` Erik Hetzner
2013-05-22 3:51 ` Christian Wittern
2014-01-02 8:08 ` Joseph Vidal-Rosset
2014-01-02 15:51 ` Rüdiger Sonderfeld
2014-01-02 18:33 ` Eric Schulte [this message]
2014-01-02 19:12 ` Joseph Vidal-Rosset
2014-01-03 18:32 ` Joseph Vidal-Rosset
2014-01-03 19:13 ` John Hendy
2014-01-03 20:27 ` Joseph Vidal-Rosset
2014-01-03 21:56 ` John Hendy
2014-01-04 10:17 ` Joseph Vidal-Rosset
2014-01-04 14:52 ` John Hendy
2014-01-03 21:15 ` Joseph Vidal-Rosset
[not found] ` <87fvoy4r1l.fsf@ucl.ac.uk>
2014-01-08 12:53 ` Joseph Vidal-Rosset
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=87k3eiz0zw.fsf@gmail.com \
--to=schulte.eric@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=joseph.vidal.rosset@gmail.com \
--cc=rasmus@gmx.us \
/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).