src/help/StringEditorHelp.html

   1 <html xmlns="http://www.w3.org/1999/xhtml">
   2
   3 <body text="#275856">
   4     <basefont size="4"
   5           color="#2F4958"
   6           face="arial">
   7
   8     <h1>The string editor</h1>
   9
  10     <p><em>Opened from the main window
  11     by</em> Edit strings or pressing a button in the toolbar.</p>
  12
  13     <p><em>Strings</em> are the <em>bibtex</em> equivalent to
  14     constants in a programming language. Each string is defined
  15     with a unique <em>name</em> and a <em>content</em>. Elsewhere
  16     in the database, the name can be used to represent the
  17     content.</p>
  18
  19     <p>For instance, if many entries are from a journal with an
  20     abbreviation that may be hard to remember, such as 'J. Theor.
  21     Biol.' (Journal of Theroretical Biology), a string named JTB
  22     could be defined to represent the journal's name. Instead of
  23     repeating the exact journal name in each entry, the characters
  24     '#JTB#' (without quotes) are put into the <em>journal</em>
  25     field of each, ensuring the journal name is written identically
  26     each time.</p>
  27
  28     <p>A string reference can appear anywhere in a field, always by
  29     enclosing the string's name in a pair of '#' characters. This
  30     syntax is specific for JabRef, and differs slightly from the
  31     <em>bibtex</em> notation that is produced when you save your
  32     database. Strings can by default be used for all standard
  33     BibTeX fields, and in <b>Preferences -&gt; General -&gt;
  34     File</b> you can opt to enable strings for non-standard fields
  35     as well. In the latter case you can specify a set of fields
  36     that are excepted from string resolving, and here it is
  37     recommended to include the 'url' field and other fields that
  38     may need to contain the '#' character and that may be processed
  39     by BibTeX/LaTeX.</p>
  40
  41     <p>A string may in the same way be referred in the content of
  42     another string, provided the referred string is defined
  43     <em>before</em> the referring one.</p>
  44
  45     <p>While the order of strings in your BibTeX file is important
  46     in some cases, you don't have to worry about this when using
  47     JabRef. The strings will be displayed in alphabetical order in
  48     the string editor, and stored in the same order, except when a
  49     different ordering is required by BibTeX.</p>
  50 </body>
  51 </html>