|
| 1 | + |
| 2 | +[](https://opensource.org/licenses/MIT) |
| 3 | + |
| 4 | + |
| 5 | +# A bare-bones modular annotated bibliography for org-mode |
| 6 | + |
| 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. |
| 9 | + |
| 10 | +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. |
| 12 | +The project number is stored in a database. |
| 13 | +The number is used to label folders and files, categorize projects, and navigate between projects. |
| 14 | +'ab' stands for annotated bibliography. |
| 15 | + |
| 16 | +The annotated bibliography notes are stored in individual files in the communal folder in the home directory. |
| 17 | +This enables the reuse of an annotated bibliography entry in more than one annotated bibliography. |
| 18 | +The communal folder has the name ~/abibNotes. |
| 19 | +Image files that are called by these notes are stored in ~/abibNotes/images. |
| 20 | + |
| 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. |
| 23 | +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. |
| 25 | + |
| 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. |
| 27 | +The note file can also contain images and code listings that have syntax highlighting. |
| 28 | + |
| 29 | +This template is agnostic with regard to which Emacs bibliographic entry manager that you are using. |
| 30 | +However, it does depend on the use of a global.bib file. |
| 31 | + |
| 32 | +This function ml/wrap-citar-citekey-and-create-abibnote-org assumes that you are utilizing the citar Emacs package for managing the bibliography. |
| 33 | +The function is found in MooersLab/mooerslab-functions-el. |
| 34 | +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. |
| 38 | +This file will have been created in the abibNotes folder in your home directory. |
| 39 | +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. |
| 40 | + |
| 41 | + |
| 42 | +## Update history |
| 43 | + |
| 44 | +|Version | Changes | Date | |
| 45 | +|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------|:--------------------| |
| 46 | +| Version 0.1 | Added badges, funding, and update table. Initial commit. | 5/14/2025 | |
| 47 | + |
| 48 | +## Sources of funding |
| 49 | + |
| 50 | +- NIH: R01 CA242845 |
| 51 | +- NIH: R01 AI088011 |
| 52 | +- NIH: P30 CA225520 (PI: R. Mannel) |
| 53 | +- NIH: P20 GM103640 and P30 GM145423 (PI: A. West) |
0 commit comments