emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Eric Schulte <schulte.eric@gmail.com>
To: "o.castillo.felisola@gmail.com" <o.castillo.felisola@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: How to use ox-bibtex
Date: Sun, 26 Jan 2014 11:02:42 -0700	[thread overview]
Message-ID: <871tzuy2k3.fsf@gmail.com> (raw)
In-Reply-To: CAAJj91efbkKP1fdmL0mWNOHZuZiwHkmwTm1KXF2FnxnFNa3bvw@mail.gmail.com

[-- Attachment #1: Type: text/plain, Size: 853 bytes --]

"o.castillo.felisola@gmail.com" <o.castillo.felisola@gmail.com> writes:

> Dear community,
>
> I'm using org-mode to draft most of my activities, and day after day I get
> closer to managing my paper writing. Nonetheless, there is a point still
> drives me crazy.
>
> All over the web I find post about using such or what tool to get emacs
> org-mode to work with Bibtex... all of them seems complex to execute. I
> found the exported ox-bibtex.el [1] (included in my installation from git),
> which 'It also introduces "cite" syntax for Org links.', but no examples of
> the usage are included in this document.
>
> *Question*
>
> Can anyone provide a minimal example of the use to this tool, including the
> configuration (if needed), and the necessary external (non-org) files?
>

The attached two files (.org and .bib) provide an example of usage.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: ox-bibtex-example.org --]
[-- Type: text/x-org, Size: 2403 bytes --]

#+Title: An Example Demonstrating ox-bibtex Usage
#+Author: Eric Schulte
#+Options: toc:nil ^:{}

An example document demonstrating generation of bibliographies for
LaTeX, HTML and ASCII export using Org-mode cite:dominik2010org with
the =ox-bibtex= contributed package.  Included code blocks are
executable for reproducibility cite:schulte2012multi.

(taken from the comments at the top of =ox-bibtex.el=)

* Introduction and Requirements
Use =cite= syntax for Org links (e.g., =cite:bibtexid=).  For HTML and
ascii it uses the bibtex2html software from
http://www.lri.fr/~filliatr/bibtex2html/, and for ascii it uses the
pandoc software from http://johnmacfarlane.net/pandoc/.

* Usage
The usage is as follows:

: #+BIBLIOGRAPHY: bibfilebasename stylename optional-options

e.g. given =foo.bib= and using style "plain":

: #+BIBLIOGRAPHY: foo plain option:-d

"stylename" can also be "nil", in which case no style will be used.

Optional options are of the form:

: option:-foobar

pass '-foobar' to bibtex2html

e.g.,

| =option:-d= | sort by date                                 |
| =option:-a= | sort as BibTeX (usually by author) *default* |
| =option:-u= | unsorted i.e. same order as in .bib file     |
| =option:-r= | reverse the sort                             |

See the bibtex2html man page for more.  Multiple options can be
combined like:

: option:-d option:-r

Limiting to only the entries cited in the document:

: limit:t

For LaTeX export this simply inserts the lines

: \bibliographystyle{plain}
: \bibliography{foo}

into the TeX file when exporting.

For HTML export it:
1) converts all =\cite{foo}= and =[[cite:foo=]] to links to the
   bibliography,
2) creates a =foo.html= and =foo_bib.html=,
3) includes the contents of =foo.html= in the exported HTML file.

For ascii export it:
1) converts all =\cite{foo}= and =[[cite:foo=]] to links to the
   bibliography,
2) creates a =foo.txt= and =foo_bib.html=,
3) includes the contents of foo.txt in the exported ascii file.

For LaTeX export it:
1) converts all =[[cite:foo=]] to =\cite{foo}=.

* Emacs Configuration
The =.emacs= configuration is simple.  With path to Org-mode's
=contrib/= repository in your load path, require =ox-bibtex= as in the
following example.

#+begin_src emacs-lisp
(add-to-list 'load-path "~/.emacs.d/src/org-mode/contrib/lisp/")
(require 'ox-bibtex)
#+end_src

#+BIBLIOGRAPHY: ox-bibtex-example plain

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: ox-bibtex-example.bib --]
[-- Type: text/x-bibtex, Size: 543 bytes --]

@book{dominik2010org,
  title={The Org Mode 7 Reference Manual-Organize your life with GNU Emacs},
  author={Dominik, Carsten},
  year={2010},
  publisher={Network Theory Ltd.}
}

@article{schulte2012multi,
  title={A multi-language computing environment for literate programming and reproducible research},
  author={Schulte, Eric and Davison, Dan and Dye, Thomas and Dominik, Carsten},
  journal={Journal of Statistical Software},
  volume={46},
  number={3},
  pages={1--24},
  year={2012},
  publisher={American Statistical Association}
}

[-- Attachment #4: Type: text/plain, Size: 182 bytes --]


Best,

>
> Thank you!
>
> [1]
> http://orgmode.org/w/?p=org-mode.git;a=blob_plain;f=contrib/lisp/ox-bibtex.el;hb=HEAD

-- 
Eric Schulte
https://cs.unm.edu/~eschulte
PGP: 0x614CA05D

  reply	other threads:[~2014-01-26 19:20 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-24 13:41 How to use ox-bibtex o.castillo.felisola
2014-01-26 18:02 ` Eric Schulte [this message]
2014-01-26 19:37   ` o.castillo.felisola
2014-01-27 13:52     ` o.castillo.felisola
2014-01-27 14:36       ` Eric Schulte
2014-01-28  8:32         ` Rainer M Krug
2014-01-28  9:04           ` Christian Moe
2014-01-28 10:08             ` Rainer M Krug
2014-01-28 12:38           ` Rainer M Krug
2014-01-28 15:19             ` o.castillo.felisola
2014-01-29  2:16               ` Eric Schulte
2014-01-29 14:16                 ` o.castillo.felisola
2014-01-29 14:46                   ` Nick Dokos
2014-01-30 10:02                     ` Ahmadou Dicko
2014-01-28 12:33         ` o.castillo.felisola
2014-01-28 12:01       ` Rainer M Krug
2014-01-28 13:23 ` Clojure Code Block Results not Tabularized Soapy Smith
2014-01-29  7:57   ` Christian Moe
2014-01-29 12:36     ` Soapy Smith
2014-01-29 12:58       ` Christian Moe
2014-01-29 13:06         ` Soapy Smith
2014-01-29 15:02           ` Eric Schulte
2014-01-29 15:28             ` Bastien
2014-01-29 23:40               ` Phill Wolf
2014-01-30 11:11   ` Bastien
2014-01-30 13:46     ` Soapy Smith
2014-01-31  1:58     ` Soapy Smith
2014-01-31  9:11       ` Bastien

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=871tzuy2k3.fsf@gmail.com \
    --to=schulte.eric@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=o.castillo.felisola@gmail.com \
    /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).