summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2014-03-16 18:55:45 -0400
committerKyle Meyer <kyle@kyleam.com>2014-03-16 18:55:45 -0400
commitbbe5367b3c7aae2b329d59416e41c25ba6525e04 (patch)
tree984b77634e871d9e6dcf73e278774eb58bc6b28d /README.md
parent761a9a1b038033c077851ad75e91d61de7872b6f (diff)
downloadbog-bbe5367b3c7aae2b329d59416e41c25ba6525e04.tar.gz
DOC: Reformat README
Diffstat (limited to 'README.md')
-rw-r--r--README.md119
1 files changed, 55 insertions, 64 deletions
diff --git a/README.md b/README.md
index 5b3b51b..e6ad489 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,7 @@
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1. Workflow</a></li>
-<li><a href="#sec-2">2. Main features</a>
-<ul>
-<li><a href="#sec-2-1">2.1. Opening a PDF file for a citekey</a></li>
-<li><a href="#sec-2-2">2.2. Opening a BibTeX file for a citekey</a></li>
-<li><a href="#sec-2-3">2.3. Searching online for a citekey</a></li>
-<li><a href="#sec-2-4">2.4. Renaming new PDFs</a></li>
-<li><a href="#sec-2-5">2.5. Renaming new BibTeX files</a></li>
-<li><a href="#sec-2-6">2.6. Generating a combined BibTeX file</a></li>
-</ul>
-</li>
+<li><a href="#sec-2">2. Main features</a></li>
<li><a href="#sec-3">3. Variables</a></li>
<li><a href="#sec-4">4. Recommended keybindings</a></li>
</ul>
@@ -64,66 +55,66 @@ Many Bog functions take the citekey from the notes context. If the point
is on a citekey (like "another1999study" above), then that citekey will
be used. Otherwise, the citekey will be taken from the first parent
heading that is a study.
+- `bog-find-citekey-pdf`
+
+ Open a PDF file for a citekey.
-## Opening a PDF file for a citekey
-
-The function `bog-find-citekey-pdf` will open a PDF associated with a
-citekey.
-
-## Opening a BibTeX file for a citekey
-
-The function `bog-find-citekey-bib` will open the BibTeX entry
-associated with a citekey.
-
-BibTeX entries can be stored in one of two ways:
-
-1. As a single file with many entries
-2. As single-entry files named <citekey>.bib within a common directory
-
-## Searching online for a citekey
-
-The function `bog-search-citekey-on-web` will perform a Google Scholar
-search with the citekey information. The default citekey format (first
-author's last name, year, and first non-trivial word) usually contains
-enough information to make this search successful.
-
-## Renaming new PDFs
-
-New PDF files can be put in a "stage" directory and then renamed to a
-citekey.
+- `bog-find-citekey-bib`
+
+ Open a BibTeX file for a citekey.
+
+ BibTeX entries can be stored in one of two ways:
+
+ 1. As a single file with many entries
+ 2. As single-entry files named <citekey>.bib within a common directory
-## Renaming new BibTeX files
+- `bog-search-citekey-on-web`
+
+ Search Google Scholar for a citekey. The default citekey format (first
+ author's last name, year, and first non-trivial word) usually contains
+ enough information to make this search successful.
-If a separate BibTeX file is used for each citekey,
-`bog-clean-and-rename-staged-bibs` can be used to rename all new BibTeX
-files. `bibtex-clean-entry` is used to clean the entry and autogenerate
-the key.
+- `bog-rename-staged-pdf-to-citekey`
+
+ Rename a new PDF.
-## Generating a combined BibTeX file
+- `bog-clean-and-rename-staged-bibs`
+
+ Renaming new BibTeX files. If a separate BibTeX file is used for each
+ citekey, this function can be used to rename all new BibTeX files.
+ `bibtex-clean-entry` is used to clean the entry and autogenerate the
+ key.
-If single-entry BibTeX files are used, there should be a way to collect
-the references that are needed. `bog-create-combined-bib` can be used to
-create a BibTeX file that has entries for all the citekeys in the
-current buffer.
+- `bog-create-combined-bib`
+
+ Generate a combined BibTeX file for all citekeys in buffer. This is
+ useful if single-entry BibTeX files are used.
# Variables
Several variables determine where Bog looks for things.
-- bog-notes-directory
-- bog-pdf-directory
-- bog-bib-directory or bog-bib-file
-- bog-stage-directory
+- `bog-notes-directory`
+- `bog-pdf-directory`
+- `bog-bib-directory` or `bog-bib-file`
+- `bog-stage-directory`
The variables below are important for specifying how Bog behaves.
-- **bog-citekey-format:** A regular expression that defines the format
- used for citekeys
-- **bog-citekey-func:** A function to extract a citekey from the current
- subtree. Use this to indicate whether the citekey should be taken
- from the heading or property.
-- **bog-find-citekey-bib-func:** A function to find a citekey in a BibTeX
- file. This determines whether a directory of single-entry BibTeX
- files or a single BibTeX file is used.
+- `bog-citekey-format`
+
+ A regular expression that defines the format used for citekeys
+
+- `bog-citekey-function`
+
+ A function to extract a citekey from the current subtree. Use this to
+ indicate whether the citekey should be taken from the heading or
+ property.
+
+- `bog-find-citekey-bib-function`
+
+ A function to find a citekey in a BibTeX file. This determines whether
+ a directory of single-entry BibTeX files or a single BibTeX file is
+ used.
# Recommended keybindings
@@ -148,37 +139,37 @@ in Org mode is a good option.
<tbody>
<tr>
<td class="left">C-c b p</td>
-<td class="left">bog-find-citekey-pdf</td>
+<td class="left">`bog-find-citekey-pdf`</td>
</tr>
<tr>
<td class="left">C-c b r</td>
-<td class="left">bog-rename-staged-pdf-to-citekey</td>
+<td class="left">`bog-rename-staged-pdf-to-citekey`</td>
</tr>
<tr>
<td class="left">C-c b b</td>
-<td class="left">bog-find-citekey-bib</td>
+<td class="left">`bog-find-citekey-bib`</td>
</tr>
<tr>
<td class="left">C-c b h</td>
-<td class="left">bog-goto-citekey-heading-in-buffer</td>
+<td class="left">`bog-goto-citekey-heading-in-buffer`</td>
</tr>
<tr>
<td class="left">C-c b H</td>
-<td class="left">bog-goto-citekey-heading-in-notes</td>
+<td class="left">`bog-goto-citekey-heading-in-notes`</td>
</tr>
<tr>
<td class="left">C-c b w</td>
-<td class="left">bog-search-citekey-on-web</td>
+<td class="left">`bog-search-citekey-on-web`</td>
</tr>
</tbody>
</table>