From: W. Trevor King <wking@drexel.edu>
Date: Sat, 16 Oct 2010 15:58:25 +0000 (-0400)
Subject: Moved BibTeX comments from src/sawsim.bib to README.bibtex.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=24772a6e51127459751af5dd2162bd3d81e1e4ee;p=sawsim.git

Moved BibTeX comments from src/sawsim.bib to README.bibtex.
---

diff --git a/README.bibtex b/README.bibtex
new file mode 100644
index 0000000..41121c3
--- /dev/null
+++ b/README.bibtex
@@ -0,0 +1,80 @@
+BibTeX_ is a bibliographic database format and processing tool often
+used with LaTeX.
+
+.. _BibTeX: http://www.bibtex.org/
+
+sawsim.bib
+==========
+
+I maintain the bibliography format with pybtex_.  The actual command
+used to re-format the files is
+
+    $ python -c 'from pybtex.database.input.bibtex import Parser; from pybtex.database.output.clean_bibtex import Writer; p = Parser(); d = p.parse_file("src/sawsim.bib"); w = Writer(); w.write_file(d, "src/sawsim.bib", p.get_raw_macros())' 2> pybtex.log
+
+Be sure to look over `pybtex.log` and `git diff src/sawsim.bib` for
+anything suspicious before committing the new file.  You may have to
+do some find-and-replacing to handle changed keys and consolidate or
+rename automatically generated macros.
+
+.. _pybtex: http://pybtex.sourceforge.net/
+
+%   which I can kindof achieve with
+%    $ bibtool -f '%-1n(author)%2d(year)' wtk.bib -o wtk1.bib
+%   Except any paper with more than one author has a '.ea' appended to the name
+%   and bibtool removes all comments :(.
+
+
+Basic usage
+===========
+
+At some point in your LaTeX document
+
+    \bibliographystyle{prsty} % Phys. Rev. style
+
+other syles include `abbrv`, `alpha`, `plain`, `unsrt`, ...
+In your LaTeX document where you want the bibliography:
+
+    \bibliography{wtk} % wtk.bib is the name of the database
+
+compile (using `latex` for example) with
+
+    $ latex example
+    $ bibtex example
+    $ latex example
+    $ latex example
+
+Natbib
+======
+
+The Natbib package adds support for other citation styles & link
+formats.
+
+Makebst
+=======
+
+Customize bibliography with Makebst (`latex makebst`), makes `.bst`
+(bib-style) format files according to your specifications.
+
+References
+==========
+
+There are a number of good resources to get you going:
+
+* very basic tutorial:
+  http://cmtw.harvard.edu/Documentation/TeX/Bibtex/Example.html
+* process overview:
+  http://www.andy-roberts.net/misc/latex/latextutorial3.html
+* entry types reference
+  http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node6.html
+* fields reference
+  http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node7.html
+* entry and fields reference, but with little discussion
+  http://en.wikipedia.org/wiki/BibTeX
+* examples of assorted styles
+  http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html
+* assorted tools
+  http://liinwww.ira.uka.de/bibliography/Bib.Format.html
+* Nelson Beebe's list of bibliographies
+  http://www.math.utah.edu/~beebe/bibliographies.html
+* Nelson Beebe's GNU bibliography
+  http://www.math.utah.edu/pub/tex/bib/gnu.html