• Stars
    star
    136
  • Rank 267,670 (Top 6 %)
  • Language
    Emacs Lisp
  • License
    GNU General Publi...
  • Created almost 3 years ago
  • Updated about 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An Emacs minor mode for literate & annotated bibliography

Literate & annotated bibliography — Nicolas P. Rougier

./bibliography.png

NOTE This literate and annotated bibliography is an adaptation of the idea Managing my Annotated Bibliography with Emacs’ Org Mode by Gregory J Stein.

Introduction

The core idea behind literate bibliography is to have a single structured file where each entry corresponds to a reference. Information concerning an entry is stored as properties and two subsections allow to enter abstract and notes. To ease the manipulation, org-bib-mode provides a sidebar menu that displays the list of bibliograpic entries and provide tools to ease navigation. Under the hood, the org-bib-mode is the union of two modes:

  • pdf-drop-mode that allow to drag and drop a file in order to add it to the bibliography using its doi that is searched automatically.
  • org-imenu that allow to easily nagivate among entries and allowing various operations such as filtering entries, moving entries, etc.

org-bib mode is meant to be simple and robust (it is simple but not yet robust). If you need somethign more elaborated, have a look at the amazing org-ref mode by John Kitchin.

Installation

org-bib mode depends on pdf-drop-mode and org-imenu that needs to be installed. For example using straight.el:

(straight-use-package
 '(org-imenu :type git :host github :repo "rougier/org-imenu"))

(straight-use-package
 '(pdf-drop-mode :type git :host github :repo "rougier/pdf-drop-mode"))

Configuration

The minimal document structure is a document with a single level headline that is used to store new entries. It is configurable via the org-bib-unsorted-header variable (default is “Unsorted”).

#+LIBRARY-PATH: ~/Documents
#+LIBRARY-FILE: ~/Documents/my-bibliography.bib

* Unsorted

You need to ensure pdf-drop-exiftool-path and pdf-drop-pdftotext-path points to relevant binaries (these are needed to extract information from PDF metadata (exiftool) or PDF content (pdftotext)). Last step is to tell org-bib where to store PDFs. This is done via the #+LIBRARY-PATH keyword that you can set at the top of your org-file. If you don’t, the current directory will be used. PDF will be copied and renamed automatically if you set the corresponding options.

Key bindings

KeyDescriptionKeyDescription
iShow org entryv iSet view mode to org entry
aShow abstractv aSet view mode to abstract
nShow notesv nSet view mode to notes
=Show previewv pSet view mode to preview
bShow bibtexv bSet view mode to bibtex
uShow URLv uSet view mode to URL
pShow PDFv pSet view mode to PDF
v <return>Exit view mode
eExport to bib filefFilter entries
tTag entrymMove entry (refile)
?Mark entry unread!Mark entry read
M-<down>Move entry downM-<up>Move entry up
<tab>Toggle current sectionS-<tab>Toggle all sections
S-<left>Next page (PDF view)S-<right>Prev page (PDF view)

Adding an entry

The simplest way to add a new entry is to drag and drop a PDF file onto the org buffer. The PDF will be parsed to try to identify a DOI and the corresponding bibtex item will be collected from the crossref.org server. The new entry will then be created below the Unsorted header (whose name is configurable) and the file will be renamed and copied to the library folder.

If this procedure fails for some reason, you can also enter a new entry manually or using the org-bib-from-pdf, org-bib-from-doi or org-bib-from-bibtex helper functions. In the latter case, no file will be automatically associated but you can later add a file into the library folder and rename it to “year - title.pdf” (replacing year and title with the actual year and title from the entry).

Edit an entry

An entry is made of a properties block with two sub headlines (Abstract and Notes). You can edit any properties and add or remove them. But be careful to not remove bibliographic properties or else, the conversion to bibtex may fail because of some missing fields that are required.

Export the bibliography

To export the library to a bib file, you can use the org-bib-export command (that is bound to the e key on the sidebar). The export filename will be deduced from the org filename unless a #+LIBRARY-FILE: is defined at the top of the org file.

Filter view

You can filter the sidebar view (f) usin any kind of filtes. Here are some example searches (note the absence of spaces):

  • Articles published in 1984: YEAR=1984
  • Articles published between 2000 & 2010: YEAR>1999+YEAR<2011
  • Journal articles: TYPE={article}
  • Papers by Knuth: AUTHOR={Knuth}
  • Article published in a journal: JOURNAL={The Computer Journal}

See also Advanced searching from the org website.

More Repositories

1

numpy-100

100 numpy exercises (with solutions)
Python
10,706
star
2

scientific-visualization-book

An open access book on scientific visualization using python and matplotlib
Python
10,697
star
3

matplotlib-cheatsheet

Matplotlib 3.1 cheat sheet.
Python
2,898
star
4

matplotlib-tutorial

Matplotlib tutorial for beginner
Python
2,776
star
5

nano-emacs

GNU Emacs / N Λ N O - Emacs made simple
Emacs Lisp
2,564
star
6

from-python-to-numpy

An open-access book on numpy vectorization techniques, Nicolas P. Rougier, 2017
Python
1,904
star
7

freetype-gl

OpenGL text using one vertex buffer, one texture and FreeType
C
1,641
star
8

elegant-emacs

A very minimal but elegant emacs (I think)
Emacs Lisp
1,368
star
9

CPP-Crash-Course

C++ Crash Course
C++
716
star
10

ML-Recipes

A collection of stand-alone Python machine learning recipes
Python
657
star
11

notebook-mode

GNU Emacs notebook mode
Emacs Lisp
617
star
12

python-opengl

An open access book on Python, OpenGL and Scientific Visualization, Nicolas P. Rougier, 2018
HTML
575
star
13

svg-tag-mode

A minor mode for Emacs that replace keywords with nice SVG labels
Emacs Lisp
496
star
14

mu4e-dashboard

A dashboard for mu4e (mu for emacs)
Emacs Lisp
465
star
15

numpy-tutorial

Numpy beginner tutorial
Python
459
star
16

emacs-gtd

Get Things Done with Emacs
CSS
441
star
17

nano-theme

GNU Emacs / N Λ N O Theme
Emacs Lisp
374
star
18

svg-lib

Emacs SVG libraries for creatings tags, icons and bars
Emacs Lisp
340
star
19

book-mode

A clean interface for org files (Emacs)
Emacs Lisp
290
star
20

ten-rules

Ten simple rules for better figures
Python
274
star
21

freetype-py

Python binding for the freetype library
Python
270
star
22

matplotlib-3d

Experimental 3D axis for matplotlib
Python
269
star
23

dotemacs

Litterate configuration for GNU Emacs
216
star
24

nano-modeline

GNU Emacs / N Λ N O Modeline
Emacs Lisp
175
star
25

tiny-renderer

A tiny sotfware 3D renderer in 100 lines of Python
Python
171
star
26

mu4e-thread-folding

Functions for folding threads in mu4e headers view
Emacs Lisp
136
star
27

agenda

Org agenda in the console
Python
134
star
28

neural-networks

Artificial Neural Networks / Python
Python
134
star
29

nano-sidebar

Emacs package to have configurable sidebars on a per frame basis.
Emacs Lisp
128
star
30

notes-list

Emacs notes list
Emacs Lisp
102
star
31

scipy-crash-course

Material for a 24 hours course on Scientific Python
102
star
32

python-visualization-landscape

Adaptation of Jake VanderPlas graphic about python visualization landscape
HTML
97
star
33

org-margin

Outdent headlines in emacs org-mode
Emacs Lisp
96
star
34

calendar-heatmap

Calendar heatmap with matplotlib and random data
Python
95
star
35

emacs-svg-icon

An emacs library to create SVG icons on the fly
Emacs Lisp
94
star
36

sideframe

Emacs side frames
Emacs Lisp
88
star
37

nano-dialog

Emac native dialog box
Emacs Lisp
87
star
38

nano-agenda

A minimal org agenda for Emacs
Emacs Lisp
84
star
39

gl-agg

OpenGL Antigrain Geometry experiments
Python
83
star
40

nano-elfeed

Emacs configuration file for elfeed (news reader)
Emacs Lisp
68
star
41

emacs-splash

An alternative splash screen for GNU Emacs
Emacs Lisp
63
star
42

recursive-voronoi

Recursive voronoi diagram
Python
60
star
43

2021-Dataviz

Material for dataviz course at university of Bordeaux
Jupyter Notebook
51
star
44

CNCC-2020

Computational Neuroscience Crash Course (University of Bordeaux, 2020)
Jupyter Notebook
48
star
45

gallery

Gallery of matplotlib samples
Python
47
star
46

50-git-questions

50 Frequently Asked question about Git & GitHub
47
star
47

mastodon-alt

Emacs alternative mastodon layout
Emacs Lisp
46
star
48

baby-gnu-tux

3D files for printing baby GNU and Tux
46
star
49

windmap

Streamlines animation (matplotlib)
Python
46
star
50

URFIST-git-course

This is the material for the URFIST course on Git & GitHub. Bordeaux, March 27 & 28, 2018.
44
star
51

rougier

Exended profile
43
star
52

nano-vertico

Emacs / nano + vertico
Emacs Lisp
43
star
53

minibuffer-header

Minibuffer header for GNU/Emacs
Emacs Lisp
43
star
54

open-heroes

Some people that facilitate science, one way or the other
41
star
55

alien-life

Remake of necessary disorrder beautiful animation
Python
41
star
56

reviewer-manifesto

A pledge for reviewers
40
star
57

pyglfw

Python bindings for GLFW 3.0
Python
40
star
58

pdf-drop-mode

Get DOI from PDF files dropped onto a Emacs buffer
Emacs Lisp
35
star
59

persid

Persistent identifier library for GNU Emacs
Emacs Lisp
35
star
60

scientific-posters

A collection of scientific posters (with sources) made with Pages or ComicLife
Rich Text Format
34
star
61

nano-toolbar

Emacs toolbar in the header line
Emacs Lisp
33
star
62

org-imenu

org-mode side menu with filtering capability
Emacs Lisp
31
star
63

org-outer-indent

An outer indentation org mode
Emacs Lisp
30
star
64

Neurosciences

Computational Neurosciences repository
Python
30
star
65

nano-calendar

An alternative calendar for Emacs
Emacs Lisp
28
star
66

relative-date

Emacs package for formatting relative dates (dates difference)
Emacs Lisp
28
star
67

CNCC-2019

Computational Neuroscience Crash Course (CNCC 2019)
Jupyter Notebook
27
star
68

unknown-pleasures

Matplotlib animation from the Unknown Pleasures album cover (Joy Division)
Python
26
star
69

2023-dataviz-nancy

Material for dataviz course (Nancy, 2023)
Jupyter Notebook
25
star
70

conference-posters

A collection of conferences posters (with sources) made with Pages
25
star
71

aerial-emacs

A cleaner and less cluttered style for emacs
Emacs Lisp
25
star
72

2024-Dataviz

Material for the dataviz courses, Bordeaux
Jupyter Notebook
25
star
73

VSOM

Randomize Self Organizing map
Python
24
star
74

emacs-octicons

Octicons glyph name for emacs
Emacs Lisp
22
star
75

dynamic-som

Dynamic Self-Organized maps
Python
22
star
76

numpy-glm

GL Mathematics for Numpy
Python
21
star
77

Scipy-Bordeaux-2018

Notes for the Scientific Python course at the university of Bordeaux
21
star
78

Scipy-Bordeaux-2016

Course taught at the University of Bordeaux in the academic year 2015/16 for PhD students.
21
star
79

bootstrap-rst

Restructured Text Bootstrap
Python
19
star
80

nano-bell

Visual bell for GNU Emacs
Emacs Lisp
19
star
81

pendulum

Animated double pendulum using matplotlib
Python
18
star
82

spatial-computation

Spatial computation
Python
18
star
83

nano-splash

N Λ N O Splash
Emacs Lisp
16
star
84

Scipy-Bordeaux-2017

Course taught at the University of Bordeaux in the academic year 2017 for PhD students.
16
star
85

less-is-more

A remake of the animation by Dark Horse Analytics (http://www.darkhorseanalytics.com)
Python
16
star
86

nano-minibuffer

Minibuffer for NΛNO Emacs
Emacs Lisp
15
star
87

org-agenda-conflict

Mark conflicting items in the org-agenda
Emacs Lisp
15
star
88

emacs-defaults

Defaults setting for vanilla emacs
Emacs Lisp
15
star
89

blog

My GitHub blog
14
star
90

ASPP-2017

Material for the Advanced Scientific Python Programming course, Nikiti, Greece, 2017
Python
14
star
91

nano-command

Emacs / Quick command in the mode-line or header-line
Emacs Lisp
13
star
92

figure-anatomy

Anatomy of a matplotlib figure
Python
13
star
93

Scipy-Bordeaux-2019

Lecture notes (Université de Bordeaux)
Python
13
star
94

gl-bezier

Experiments on quadratic and cubic Bézier curves
Python
12
star
95

mu4e-folding

Thread folding support for mu4e
Emacs Lisp
12
star
96

galaxy

Spiral galaxy simulator using the density wave theory
Python
12
star
97

EmacsConf-2022

Poster for the Emacs conference 2022
12
star
98

mu4e-thread

mu4e thread folding
Emacs Lisp
11
star
99

dana

Distributed (Asynchronous) Numerical Adaptive computing framework
Python
11
star
100

nano-read

Alternartive read functions for GNU Emacs
Emacs Lisp
11
star