added name parser documentation to help content
[taxeditor.git] / / html / nameparser / reference_part.html
1 <h3>Reference Part</h3>
3 <p>The reference part follows the syntax: <code>{separator}{authorship{,}}{titleEditionVolume}{:}{detail}{.}{year}</code></p>
5 <p>Zoological new combinations should not have a reference part, since in zoology, it is not common
6 to mention the new combination reference.</p>
8 <h4>Separator</h4>
10 <p>The separator between the reference part and the preceding authorship may be a comma , or
11 an <pre> in </pre> (surrounded by whitespaces). The comma indicates a book whereas the <code>in</code> stands either
12 for a journal article or a book section. If the <code>in</code> is not followed by a comma, the parser
13 interprets the reference as an article; otherwise, as a book section. Reference type parsing
14 should be improved in future.</p>
16 <h4>Reference Authorship</h4>
18 <p>An author is only available for book sections. Articles and book sections are differentiated
19 from each other by comparing the first four words that follow the separator. If these words
20 include a comma and the words before the comma are likely to represent an author, the reference
21 is recognized as a book section. Otherwise, it will be treated as an article. In both cases,
22 a warning is thrown that differentiation is not possible.</p>
24 <h4>TitleEditionVolume</h4>
26 <p>The TitleEditionVolume part includes the title itself as well as optional edition part
27 and volume parts. The title itself allows most character combinations but care must be taken
28 if a <code>:</code> is included as this is the separator for the subsequent detail part. Special characters
29 like <code>&amp;</code> and <code>-</code> are only allowed if preceded and followed immediately by ordinary characters.
30 Ordinary brackets are allowed. Edition and volume are separated by whitespace if only one
31 of them exists. If both exist the later is separated by a comma. Both are optional, so all
32 four of the following formats are valid:</p>
34 <pre>
35 Sp. Pl.
36 Sp. Pl. ed. 3
37 Sp. Pl. ed. 3, 4
38 Sp. Pl. 4
39 </pre>
41 <p>As can be seen, the edition is recognized by a preceding <code>ed.</code>, whereas the volume is just
42 a number (or a number followed by another number in brackets - e.g. <code>4(5)</code> ).</p>
44 <p>The detail part is separated by a column <code>:</code> from the preceding titleEditonVolume part and
45 is separated from the year by <code>.</code> (botanical names only). A number of typical detail information
46 is recognized as either pure page numbers (<code>345</code>) or ranges (<code>345-348</code>). Page numbers may be
47 preceded by <code>p.</code>(e.g. <code>p. 345</code>) or <code>pp.</code>(e.g. <code>pp. 345-348</code>). Abbreviations indicating special parts of a
48 reference such as <code>fig.</code> or <code>tab.</code> are recognized as well. Roman numbers are not detected
49 at the moment.</p>