Move Bell model unfolding rate test into pysawsim/test/bell_rate.py.
[sawsim.git] / README.bibtex
1 BibTeX_ is a bibliographic database format and processing tool often
2 used with LaTeX.
3
4 .. _BibTeX: http://www.bibtex.org/
5
6 sawsim.bib
7 ==========
8
9 I maintain the bibliography format with pybtex_.  The actual command
10 used to re-format the files is
11
12     $ 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
13
14 Be sure to look over `pybtex.log` and `git diff src/sawsim.bib` for
15 anything suspicious before committing the new file.  You may have to
16 do some find-and-replacing to handle changed keys and consolidate or
17 rename automatically generated macros.
18
19 .. _pybtex: http://pybtex.sourceforge.net/
20
21 %   which I can kindof achieve with
22 %    $ bibtool -f '%-1n(author)%2d(year)' wtk.bib -o wtk1.bib
23 %   Except any paper with more than one author has a '.ea' appended to the name
24 %   and bibtool removes all comments :(.
25
26
27 Basic usage
28 ===========
29
30 At some point in your LaTeX document
31
32     \bibliographystyle{prsty} % Phys. Rev. style
33
34 other syles include `abbrv`, `alpha`, `plain`, `unsrt`, ...
35 In your LaTeX document where you want the bibliography:
36
37     \bibliography{wtk} % wtk.bib is the name of the database
38
39 compile (using `latex` for example) with
40
41     $ latex example
42     $ bibtex example
43     $ latex example
44     $ latex example
45
46 There are many possible author name formats, but the least ambiguous
47 is `von Last, Jr., First Middle`.  If the `von` is capitalized
48 (e.g. "Emanuela Di Cola"), use `\uppercase`:
49
50     @String{EDCola = "{\uppercase{d}}i Cola, Emanuela"}
51
52 See *Tame the BeaST* for details.
53
54 Natbib
55 ======
56
57 The Natbib package adds support for other citation styles & link
58 formats.
59
60 Makebst
61 =======
62
63 Customize bibliography with Makebst (`latex makebst`), makes `.bst`
64 (bib-style) format files according to your specifications.
65
66 References
67 ==========
68
69 There are a number of good resources to get you going:
70
71 * very basic tutorial:
72   http://cmtw.harvard.edu/Documentation/TeX/Bibtex/Example.html
73 * Really awesome explaination of how BibTeX works:
74   http://www.ctan.org/tex-archive/info/bibtex/tamethebeast/
75 * process overview:
76   http://www.andy-roberts.net/misc/latex/latextutorial3.html
77 * entry types reference
78   http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node6.html
79 * fields reference
80   http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node7.html
81 * entry and fields reference, but with little discussion
82   http://en.wikipedia.org/wiki/BibTeX
83 * examples of assorted styles
84   http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html
85 * assorted tools
86   http://liinwww.ira.uka.de/bibliography/Bib.Format.html
87 * Nelson Beebe's list of bibliographies
88   http://www.math.utah.edu/~beebe/bibliographies.html
89 * Nelson Beebe's GNU bibliography
90   http://www.math.utah.edu/pub/tex/bib/gnu.html