spacemacs/layers/+lang/bibtex
JP-Ellis 97aff9d8db Add BibTeX layer.
Integrates with org mode and LaTeX in order to manage citations.

Signed-off-by: JP-Ellis <josh@jpellis.me>
2016-04-17 00:37:47 -04:00
..
img Add BibTeX layer. 2016-04-17 00:37:47 -04:00
packages-config.el Add BibTeX layer. 2016-04-17 00:37:47 -04:00
packages.el Add BibTeX layer. 2016-04-17 00:37:47 -04:00
README.org Add BibTeX layer. 2016-04-17 00:37:47 -04:00

BibTeX layer

/TakeV/spacemacs/media/commit/97aff9d8dba3dbdfcef8a647c6a6cfd0c2717d94/layers/+lang/bibtex/img/logo.png

Description

BibTeX and BibLaTeX files are a common way to manage bibliographies. The format was original designed to work with LaTeX files and subsequently has been adopted by other markup formats such as MarkDown and Org mode.

This layer adds support to manipulate BibTeX and BibLaTeX files and offer utilities to automatically add new entries by DOI, arXiv identifier, ISBN, and more.

Once enabled, this layer also introduces additional shortcuts in other modes to easily insert citations.

Install

To use this contribution add it to your ~/.spacemacs

  (setq-default dotspacemacs-configuration-layers '(bibtex))

Configuration

This layer also supports having a global BibTeX file. For a basic configuration, add this to your ~/.spacemacs inside dotspacemacs/user-config:

  (setq org-ref-default-bibliography '("~/Papers/references.bib")
        org-ref-pdf-directory "~/Papers/"
        org-ref-bibliography-notes "~/Papers/notes.org")

Certain modes, such as latex-mode with AucTeX, will automatically lookup references in a document if any of the recognized bibliography commands are used. Other modes may have a similar feature, or one could always set file-local variables (through SPC f v f).

You can also customize which program is used to display the PDFs. For example, to use Zathura:

  (setq org-ref-open-pdf-function (lambda (fpath) (start-process "zathura" "*helm-bibtex-zathura*" "/usr/bin/zathura" fpath)))

More configuration options are available and are detailed in the org-ref and helm-bibtex package documentations.

Key bindings

In a Bib(La)TeX files, the following key bindings are added:

Key Binding Description
<SPC> m j Next entry
<SPC> m k Previous entry
<SPC> m p Open PDF
<SPC> m n Open notes
<SPC> m b Open browser
<SPC> m i Insert new entry
<SPC> m s Sort entry
<SPC> m h Various actions on entry
<SPC> m l a Lookup and add arXiv paper (don't get PDF)
<SPC> m l A Lookup and add arXiv paper (download PDF)
<SPC> m l d Lookup and add paper by DOI
<SPC> m l i Lookup and add book by ISBN
<SPC> m l p Lookup and add paper by PMID

In addition, org-mode, latex-mode and markdown-mode all have the following key binding added:

Key Binding Description
SPC m i c Insert citation