Minor documentation fixes.

jgm · Sep 1, 2013 · c3ebb04 · c3ebb04
1 parent 21f8765
commit c3ebb04
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,9 @@ To process citations with pandoc, call pandoc-citeproc as a filter:
 
     pandoc --filter pandoc-citeproc input.md -s -o output.html
 
+The bibliography will be put into a pandoc `Div` container with
+class `references`.
+
 pandoc-citeproc will look for the following metadata fields in
 the input:
 
@@ -56,6 +59,11 @@ object.  The format is essentially CSL JSON format.  Here is an example:
       volume: 6
       container-title: Journal of Generic Studies
 
+The contents of fields will be interpreted as markdown when
+appropriate:  so, for example, emphasis and strong emphasis can
+be used in title fileds. Simple tex math will also be
+parsed and rendered appropriately.
+
 `csl`: Path to a CSL style file.  If the file is not found relative
 to the working directory, pandoc-citeproc will look in the
 `$HOME/.csl` directory (or `C:\Users\USERNAME\AppData\Roaming\csl`

diff --git a/TODO b/TODO
@@ -1,8 +1,6 @@
 TODO:
 
 - man pages
-- document fact that bibliography is put in a div
-- document rich text and math formatting
 - error reporting has been improved, but warnings still don't appear with
   numerical styles