[svn-upgrade] Integrating new upstream version, jabref (2.3~beta1)
[debian/jabref.git] / src / help / LabelPatterns.html
1 <HTML>
2
3 <BODY text="#275856">
4
5 <basefont size="4" color="#2F4958" face="arial">
6
7 <H1>Customizing the BibTeX key generator</H1>
8
9 In the 'Key pattern' tab in Preferences, one can set the fields used in auto
10 generation of BibTex labels. The pattern can be set for each of the standard entry
11 types.
12 <H2>Key patterns</H2>
13 The pattern can contain any text you wish, in addition to field
14 markers that indicate that a specific field of the entry should be
15 inserted at that position of the key. A field marker generally
16 consists of the field name enclosed in square braces,
17 e.g. <b>[volume]</b>. If the field is undefined in an entry at the
18 time of key generation, no text will be inserted by the field marker.
19 <P>
20 Several special field markers are offered, which extract only a specific part of a field. These are listed below. Feel free to suggest new special field markers.
21
22 <P>
23 Special field markers:
24 <ul>
25 <li><b>[<code>auth</code>]</b>: The last name of the first author<BR>
26 <li><b>[<code>authors</code>]</b>: The last name of all authors<BR>
27 <li><b>[<code>authorsN</code>]</b>: The last name of up to N authors. If there are more authors, "EtAl" is appended.<BR>
28 <li><b>[<code>authIniN</code>]</b>: The beginning of each author's last name, using
29 no more than N characters.<BR>
30 <li><b>[<code>authorIni</code>]</b>: The first 5 characters of the first author's last name,
31           and the last name initials of the remaining authors.<BR>
32 <li><b>[<code>authN</code>]</b>: The first N characters of the first author's last name<BR>
33 <li><b>[<code>authN_M</code>]</b>: The first N characters of the Mth author's last name<BR>
34 <li><b>[<code>auth.auth.ea</code>]</b>: The last name of the first two authors, and ".ea" if there are more than two.<BR>
35 <li><b>[<code>auth.etal</code>]</b>: The last name of the first author, and the last name of the second author if there are two
36     authors or ".etal" if there are more than two.<BR>    
37 <li><b>[<code>authshort</code>]</b>: The last name if one author is given; the first character of up to three authors' last names if more than one author is given. A plus character is added, if there are more than three authors.<BR>
38 </ul>
39 <b>Note:</b> If there is no author (as in the case of an edited book), then all of the above <b><code>[auth...]</code></b> markers will use the editor(s) (if any) as a fallback. Thus, the editor(s) of a book with no author will be treated as the author(s) for label-generation purposes. If you do not want this behaviour, i.e. you require a marker which expands to nothing if there is no author, use  <b><code>pureauth</code></b> instead of <b><code>auth</code></b> in the above codes. For example, <b><code>[pureauth]</code></b>, or <b><code>[pureauthors3]</code></b>.
40 <ul>
41 <li><b>[<code>edtr</code>]</b>: The last name of the first editor<BR>
42 <li><b>[<code>edtrIniN</code>]</b>: The beginning of each editor's last name, using
43 no more than N characters<BR>
44 <li><b>[<code>editors</code>]</b>: The last name of all editors<BR>
45 <li><b>[<code>editorIni</code>]</b>: The first 5 characters of the first editor's last name,
46         and the last name initials of the remaining editors.<BR>
47 <li><b>[<code>edtrN</code>]</b>: The first N characters of the first editor's last name<BR>
48 <li><b>[<code>edtrN_M</code>]</b>: The first N characters of the Mth editor's last name<BR>
49 <li><b>[<code>edtr.edtr.ea</code>]</b>: The last name of the first two editors, and ".ea" if there are more than two.<BR>
50 <li><b>[<code>edtrshort</code>]</b>: The last name if one editor is given; the first character of up to three editors' last names if more than one editor is given. A plus character is added, if there are more than three editors.<BR>
51 <li><b>[<code>firstpage</code>]</b>: The number of the first page of the publication<BR>
52 <li><b>[<code>lastpage</code>]</b>: The number of the last page of the publication<BR>
53 <li><b>[<code>shorttitle</code>]</b>: The first 3 words of the title<BR>
54 <li><b>[<code>shortyear</code>]</b>: The last 2 digits of the publication year<BR>
55 <li><b>[<code>veryshorttitle</code>]</b>: The first word of the title,
56 discounting 'the', 'a', 'an'.<BR>
57  </ul>
58
59 <P>
60 A field name (or one of the above pseudo-field names) may optionally
61 be followed by one or more modifiers. Modifiers are applied in the order they are
62 specified.
63 <ul>
64     <li><b>:abbr</b>: Abbreviates the text produced by the field name or spcial field
65         marker. Only the first character and subsequent characters following white space
66         will be included. For example, <b>[journal:abbr]</b> would from the journal name
67         "Journal of Fish Biology" produce "JoFB".<br>
68     <li><b>:lower</b>: Forces the text inserted by the field marker to
69         be in lowercase.  For example, <b>[auth:lower]</b> expands the last
70         name of the first author in lowercase.<br>
71 </ul>
72
73
74 <P>
75 If you haven't defined a key pattern for a certain entry type, the <b>Default
76 key pattern</b> will be used. You can change the default pattern - its setting
77 is above the list of entry types in the <b>Key pattern</b> section of the <b>Preferences</b>
78 dialog.
79
80 <P>
81 The default key pattern is [auth][year], and this could produce
82 keys like e.g. <code>Yared1998</code> If the key is not unique in the
83 current database, it is made unique by adding one of the letters a-z
84 until a unique key is found. Thus, the labels might look like:
85 <blockquote> <code>Yared1998</code><BR> <code>Yared1998a</code><BR>
86 <code>Yared1998b</code> </blockquote>
87
88 <h2>Regular expression replace</h2>
89
90     After the key pattern has been applied to produce a key, you can choose to have the
91     key generator search for occurences of a specific regular expression, and replace
92     it with a string. The regular expression and replacement string are entered in the
93     text fields below the list of key patterns.
94
95     If the replacement string is empty, matches of the regular expression will simply
96     be removed from the generated key.
97
98 </font>
99 </BODY>
100 </HTML>