Imported Upstream version 2.10+ds
[debian/jabref.git] / src / help / StringsHelp.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>Help on Strings</h1>
9     <p><em>Bibtex</em> supports storing constant strings using <code>@String {key = value}</code>.
10     <acronym>JabRef</acronym> supports managing them using <b>BibTeX -> Edit strings</b>, which opens the <a href="StringEditorHelp.html">String Editor</a>. These values can be used
11     in fields. For example, you can have:</p>
12     <pre><code>@String { kopp = "Kopp, Oliver" }
13 @String { kubovy = "Kubovy, Jan" }
14 @String { et = " and " }</code></pre>
15 <p>and then in some entry for example: <code>@Misc{ author = kopp # et # kubovy }</code> or <code>@Misc{ author = kopp # " and " # kubovy }</code>. In the JabRef field editor, the author has to be inserted as  <code>#kopp# #et# #kubovy#</code> or <code>#kopp# and #kubovy#</code>.</p>
16
17 <p>
18 <acronym>JabRef</acronym> enhances the concept of Strings to add a type to those <code>@String</code>s.
19 The issue is how to preserve such type of a string in a bibtex file.
20 <acronym>JabRef</acronym>adds the type though prefixes:</p>
21
22 <ul>
23 <li><code>@String { aKopp = "Kopp, Oliver" }</code> is a <code>@String</code> with the type author.</li>
24 <li><code>@String { iMIT = "{Massachusetts Institute of Technology ({MIT})}" }</code> is a <code>@String</code> with the type of institution.</li>
25 <li><code>@String { anct = "Anecdote" }</code> is a <code>@String</code> of type other.</li>
26 <li><code>@String { lTOSCA = "Topology and Orchestration Specification for Cloud Applications" }</code> is a <code>@String</code> of type other.</li>
27 </ul>
28
29 <p>
30 Then <code>@String</code>s of type author should be used for author and editors
31 fields only. <code>@String</code>s of type institution should be used for
32 institution and organization fields only. <code>@String</code>s of type publisher
33 should be used only for publisher fields. And finally <code>@String</code>s of type
34 other can be used anywhere.
35 </p>
36
37 <p>
38 It can also happen that you will have the same institution for more types:
39 </p>
40 <ul>
41 <li><code>@String { aMIT = "{Massachusetts Institute of Technology ({MIT})}" }</code>
42 if the institution will appear as author or editor</li>
43 <li>
44 <code>@String { iMIT = "{Massachusetts Institute of Technology ({MIT})}" }</code>
45 if the institution will appear as institution or organization</li>
46 <li>
47 <code>@String { pMIT = "{Massachusetts Institute of Technology ({MIT}) press}" }</code> if the institution will appear as publisher.</li>
48 </ul>
49 <p>
50 Even if the last example may appear contradicting the intention was to
51 remove duplicity and unify the names of persons and institutions.
52 </p>
53
54
55 </body>
56 </html>