Imported Upstream version 2.10+ds
[debian/jabref.git] / src / help / BibtexHelp.html
1 <html xmlns="http://www.w3.org/1999/xhtml">
2 <head>
3 <link rel="stylesheet" type="text/css" href="jabref_help.css"/>
4 </head>
5
6 <body>
7
8     <h1>About <em>bibtex</em></h1>
9
10     <p>JabRef helps you work with your
11     <em>bibtex</em> databases, but there are still rules to keep in
12     mind when editing your entries, to ensure that your database is
13     treated properly by the <em>bibtex</em> program.</p>
14
15     <h2><em>Bibtex</em> fields</h2>
16
17     <p>There is a lot of different
18     fields in <em>bibtex</em>, and some additional fields that you
19     can set in JabRef.</p>
20
21     <p>Generally, you can use LaTeX commands inside of fields
22     containing text. <em>Bibtex</em> will automatically format your
23     reference lists, and those fields that are included in the
24     lists will be (de)capitalized according to your bibliography
25     style. To ensure that certain characters remain capitalized,
26     enclose them in braces, like in the word {B}elgium.</p>
27
28     <p>Notes about some of the field types:</p>
29
30     <ul>
31         <li><strong style="font-style: italic;">Bibtexkey</strong>
32         A unique string used to refer to the entry in LaTeX
33         documents. Note that when referencing an entry from LaTeX,
34         the key must match case-sensitively with the reference
35         string.</li>
36
37         <li><strong>address<br /></strong> Usually the address of
38         the <tt>publisher</tt> or other type of institution. For
39         major publishing houses, van&nbsp;Leunen recommends
40         omitting the information entirely. For small publishers, on
41         the other hand, you can help the reader by giving the
42         complete address.</li>
43
44         <li><strong>annote<br /></strong> An annotation. It is not
45         used by the standard bibliography styles, but may be used
46         by others that produce an annotated bibliography.</li>
47
48         <li><strong>author<br /></strong> This field should contain
49         the complete author list for your entry. The names are
50         separated by the word <em>and</em>, even if there are more
51         than two authors. Each name can be written in two
52         equivalent forms:<br />
53          Donald E. Knuth <em>or</em> Knuth, Donald E.<br />
54          Eddie van Halen <em>or</em> van Halen, Eddie<br />
55          The second form should be used for authors with more than
56         two names, to differentiate between middle names and last
57         names.</li>
58
59         <li><strong>booktitle<br /></strong> Title of a book, part
60         of which is being cited. For book entries, use the
61         <tt>title</tt> field instead.</li>
62
63         <li><strong>chapter<br /></strong> A chapter (or section or
64         whatever) number.</li>
65
66         <li><strong>crossref<br /></strong> The database key of the
67         entry being cross referenced.</li>
68
69         <li><strong>edition<br /></strong> The edition of a
70         book--for example, ``Second''. This should be an ordinal,
71         and should have the first letter capitalized, as shown
72         here; the standard styles convert to lower case when
73         necessary.</li>
74
75         <li><strong>editor<br /></strong> This field is analogue to
76         the <em>author</em> field. If there is also an
77         <tt>author</tt> field, then the <tt>editor</tt> field gives
78         the editor of the book or collection in which the reference
79         appears.</li>
80
81         <li><strong>howpublished<br /></strong> How something
82         strange has been published. The first word should be
83         capitalized.</li>
84
85         <li><strong>institution<br /></strong> The sponsoring
86         institution of a technical report.</li>
87
88         <li><strong>journal<br /></strong> A journal name. The name
89         of a journal can be abbreviated using a "string". To define
90         such string, use the <a href="StringEditorHelp.html">string
91         editor</a>.</li>
92
93         <li><strong>key<br /></strong> Used for alphabetizing,
94         cross referencing, and creating a label when the ``author''
95         information is missing. This field should not be confused
96         with the key that appears in the <code>\cite</code> command
97         and at the beginning of the database entry.</li>
98
99         <li><strong>month<br /></strong> The month in which the
100         work was published or, for an unpublished work, in which it
101         was written. You should use the standard three-letter
102         abbreviation (jan, feb, mar, apr, may, jun, jul, aug, sep,
103         oct, nov, dec).</li>
104
105         <li><strong>note<br /></strong> Any additional information
106         that can help the reader. The first word should be
107         capitalized.</li>
108
109         <li><strong>number</strong><br />
110         The number of a journal, magazine, technical report, or of
111         a work in a series. An issue of a journal or magazine is
112         usually identified by its volume and number; the
113         organization that issues a technical report usually gives
114         it a number; and sometimes books are given numbers in a
115         named series.</li>
116
117         <li><strong>organization<br /></strong> The organization
118         that sponsors a conference or that publishes a manual.</li>
119
120         <li><strong>pages<br /></strong> One or more page numbers
121         or range of numbers, such as <tt>42-111</tt> or
122         <tt>7,41,73-97</tt> or <tt>43+</tt> (the `<tt>+</tt>' in
123         this last example indicates pages following that don't form
124         a simple range). To make it easier to maintain
125         <em>Scribe</em>-compatible databases, the standard styles
126         convert a single dash (as in <tt>7-33</tt>) to the double
127         dash used in TeX to denote number ranges (as in
128         <tt>7-33</tt>).</li>
129
130         <li><strong>publisher<br /></strong> The publisher's
131         name.</li>
132
133         <li><strong>school<br /></strong> The name of the school
134         where a thesis was written.</li>
135
136         <li><strong>series<br /></strong> The name of a series or
137         set of books. When citing an entire book, the
138         <tt>title</tt> field gives its title and an optional
139         <tt>series</tt> field gives the name of a series or
140         multi-volume set in which the book is published.</li>
141
142         <li><strong>title<br /></strong> The work's title. The
143         capitalization may depend on the bibliography style and on
144         the language used. For words that have to be capitalized
145         (such as a proper noun), enclose the word (or its first
146         letter) in braces.</li>
147
148         <li><strong>type<br /></strong> The type of a technical
149         report--for example, ``Research Note''.</li>
150
151         <li><strong>volume<br /></strong> The volume of a journal
152         or multivolume book.</li>
153
154         <li><strong>year<br /></strong> The year of publication or,
155         for an unpublished work, the year it was written. Generally
156         it should consist of four numerals, such as <tt>1984</tt>,
157         although the standard styles can handle any <tt>year</tt>
158         whose last four nonpunctuation characters are numerals,
159         such as `(about 1984)'. This field is required for most
160         entry types.</li>
161     </ul><br />
162
163
164     <h2>Other fields</h2>
165
166     <p>BibTeX is extremely popular, and many
167     people have used it to store information. Here is a list of
168     some of the more common fields:</p>
169
170     <ul>
171         <li>
172         <strong><span style="font-weight: normal; font-style: italic;">
173         affiliation*</span><br /></strong> The authors
174         affiliation.<br />
175         <br /></li>
176
177         <li><strong>abstract<br /></strong> An abstract of the
178         work.<br />
179         <br /></li>
180
181         <li><strong>doi<br /></strong> The Digital Object
182         Identifier, a permanent identifier given to
183         documents.<br />
184         <br /></li>
185
186         <li><strong>eid<br /></strong> The Electronic identifier is
187         for electronic journals that also appear in print. This
188         number replaces the page number, and is used to find the
189         article within the printed volume. Sometimes also called
190         <em>citation number</em>.<br />
191         <br /></li>
192
193         <li>
194         <strong><span style="font-weight: normal; font-style: italic;">
195         contents*</span><br /></strong> A Table of Contents<br />
196         <br /></li>
197
198         <li>
199         <strong><span style="font-weight: normal; font-style: italic;">
200         copyright*</span><br /></strong> Copyright
201         information.<br />
202         <br /></li>
203
204         <li>
205         <strong><span style="font-weight: normal; font-style: italic;">
206         ISBN*</span><br /></strong> The International Standard Book
207         Number.<br />
208         <br /></li>
209
210         <li>
211         <strong><span style="font-weight: normal; font-style: italic;">
212         ISSN*</span><br /></strong> The International Standard
213         Serial Number. Used to identify a journal.<br />
214         <br /></li>
215
216         <li><strong>keywords<br /></strong> Key words used for
217         searching or possibly for annotation.<br />
218         <br /></li>
219
220         <li>
221         <strong><span style="font-weight: normal; font-style: italic;">
222         language*</span><br /></strong> The language the document
223         is in.<br />
224         <br /></li>
225
226         <li>
227         <strong><span style="font-weight: normal; font-style: italic;">
228         location*</span><br /></strong> A location associated with
229         the entry, such as the city in which a conference took
230         place.<br />
231         <br /></li>
232
233         <li>
234         <strong><span style="font-weight: normal; font-style: italic;">
235         LCCN*</span><br /></strong> The Library of Congress Control
236         Number. I've also seen this as <tt>lib-congress</tt>.<br />
237         <br /></li>
238
239         <li>
240         <strong><span style="font-weight: normal; font-style: italic;">
241         mrnumber*</span><br /></strong> The <i>Mathematical
242         Reviews</i> number.<br />
243         <br /></li>
244
245         <li>
246         <strong><span style="font-weight: normal; font-style: italic;">
247         price*</span><br /></strong> The price of the
248         document.<br />
249         <br /></li>
250
251         <li>
252         <strong><span style="font-weight: normal; font-style: italic;">
253         size*</span><br /></strong> The physical dimensions of a
254         work.<br />
255         <br /></li>
256
257         <li><strong>URL<br /></strong> The WWW Uniform Resource
258         Locator that points to the item being referenced. This
259         often is used for technical reports to point to the ftp
260         site where the postscript source of the report is
261         located.</li>
262     </ul>
263
264     <h3>JuraBib</h3>
265
266     <ul>
267         <li><strong>urldate<br /></strong> The date of the last
268         page visit.</li>
269     </ul><br />
270      *) not direct supported by JabRef<br />
271      <br />
272
273     <h2>Hints on fields</h2>
274     <p>
275     An institution name should be inside <code>{} </code> brackets. If the institution name also includes its abbreviation, this abbreviation should be also in <code>{}</code> brackets. For instance, <code>{The Attributed Graph Grammar System ({AGG})}</code>.</p>
276
277     <h2>Further information resources</h2>
278     <ul>
279     <li>
280     Hints on BibTeX: <a href="http://sandilands.info/sgordon/node/488">Recommended BibTeX Format</a>
281     </li>
282     </ul>
283
284 </body>
285 </html>