Skip to content

Commit 71598d3

Browse files
authored
Update README.md
1 parent 4dcf4a4 commit 71598d3

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1-
![Version](https://img.shields.io/static/v1?label=barebones-modulated-annotated-bibliography-orgmode&message=0.0&color=brightcolor)
1+
![Version](https://img.shields.io/static/v1?label=barebones-modulated-annotated-bibliography-orgmode&message=0.1&color=brightcolor)
22
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
33

44

55
# A bare-bones modular annotated bibliography for org-mode
66

7-
This repo is for a template for a bare-bones modular annotated bibliography that uses a small Latex preamble.
8-
The idea is to reduce LaTeX package conflicts between what is in the preamble and what is pre-configured in org-mode.
7+
This repo is for a bare-bones modular annotated bibliography template that uses a small LaTeX preamble.
8+
The idea is to reduce LaTeX package conflicts between the preamble and what is pre-configured in org-mode.
9+
10+
The modularity comes from storing the annotation inside an external file that is important to the main document.
11+
The standard approaches for storing the annotation in the BibTeX file.
12+
Including tables, equations, figures, and code listings in the BibTeX file is more challenging.
13+
914

1015
The annotated bibliography resides in a subfolder in a writing project.
11-
The subfolder has the address ./ab----, where ---- is a four digit project number.
16+
The subfolder has the address ./ab----, where ---- is a four-digit project number.
1217
The project number is stored in a database.
1318
The number is used to label folders and files, categorize projects, and navigate between projects.
1419
'ab' stands for annotated bibliography.
@@ -18,23 +23,23 @@ This enables the reuse of an annotated bibliography entry in more than one annot
1823
The communal folder has the name ~/abibNotes.
1924
Image files that are called by these notes are stored in ~/abibNotes/images.
2025

21-
The note files start out as empty files with the cite key serving as the base of the file name and 'org' serving as a file extension.
22-
This file extension is all that is needed for Emacs to recognize this file as a orgmode file.
26+
The note files start as empty files with the cite key as the base of the file name and 'org' as a file extension.
27+
This file extension is all that Emacs needs to recognize this file as an Org-mode file.
2328
The note file can contain subheadings written in org-mode.
24-
It is simpler to use the `#+LATEX: \paragraph` environment to avoid jumping between org-mode and \LaTeX.
29+
Using the `#+LATEX: \paragraph` environment is simpler to avoid jumping between org-mode and \LaTeX.
2530

26-
The note file can contain org-mode tables that are formatted following the book tabs package, which supports the use of three kinds of rules: toprule, midrule, and bottomrule.
31+
The note file can contain org-mode tables formatted following the booktabs package, which supports the use of three kinds of rules: toprule, midrule, and bottomrule.
2732
The note file can also contain images and code listings that have syntax highlighting.
2833

29-
This template is agnostic with regard to which Emacs bibliographic entry manager that you are using.
34+
This template is agnostic about which Emacs bibliographic entry manager you are using.
3035
However, it does depend on the use of a global.bib file.
3136

3237
This function ml/wrap-citar-citekey-and-create-abibnote-org assumes that you are utilizing the citar Emacs package for managing the bibliography.
3338
The function is found in MooersLab/mooerslab-functions-el.
3439
You first insert a citekey.
35-
Then you place the cursor inside of the citekey.
36-
You execute the above function in the mini buffer and the cite key will be replaced with the bibliographic information injected into a \subsubsection{} heading.
37-
At the same time, a new buffer will open with the new note file so that you can go about editing it.
40+
Then you place the cursor inside the citekey.
41+
You execute the above function in the mini buffer, and the cite key will be replaced with the bibliographic information injected into a \subsubsection{} heading.
42+
At the same time, a new buffer will open with the new note file so that you can edit it.
3843
This file will have been created in the abibNotes folder in your home directory.
3944
The corresponding did tech entry is supposed to be appended to the file ab----.bib so that you can have a local copy of BibTeX entries to ease sharing the annotated bibliography.
4045

@@ -50,4 +55,4 @@ The corresponding did tech entry is supposed to be appended to the file ab----.b
5055
- NIH: R01 CA242845
5156
- NIH: R01 AI088011
5257
- NIH: P30 CA225520 (PI: R. Mannel)
53-
- NIH: P20 GM103640 and P30 GM145423 (PI: A. West)
58+
- NIH: P20 GM103640 and P30 GM145423 (PI: A. West)

0 commit comments

Comments
 (0)