src/help/BaseFrameHelp.html

   1 <html xmlns="http://www.w3.org/1999/xhtml">
   2
   3 <body text="#275856">
   4     <basefont size="4" color="#2F4958" face="arial" />
   5
   6     <h1>The JabRef main window</h1>
   7
   8     <p><em>Note:</em> most menu actions
   9     referred in the following have keyboard shortcuts, and many are
  10     available from the toolbar. The keyboard shortcuts are found in
  11     the pull-down menus.</p>
  12
  13     <p>This is the main window from where you work with your
  14     databases. Below the menubar and the toolbar is a tabbed pane
  15     containing a panel for each of your currently open databases.
  16     When you select one of these panels, a table appears, listing
  17     all the database's entries, as well as a configurable selection
  18     of their fields.</p>
  19
  20     <ul>
  21         <li>You decide which fields are shown in the table by
  22         checking the fields you want to see in the
  23         <strong>Preferences</strong> dialog.</li>
  24
  25         <li>Double-click a line of the table to edit the entry
  26         content. You can navigate the table with the arrow
  27         keys.</li>
  28
  29         <li>The table is sorted according to a set of fields of
  30         your choosing. The default sort order is set up in
  31         <strong>Preferences -&gt; Entry table</strong>, but to
  32         quickly change the order, click the header of a column to
  33         set it as the primary sort criterion, or reverse the
  34         sorting if it is already set. Another click will deselect
  35         the column as sorting criterion. Hold down <b>CONTROL</b>
  36         and click a column to add, reverse or remove it as a
  37         sub-criterion after the primary column. You can add an
  38         arbitrary number of sub-criteria.</li>
  39
  40         <li>Adjust the width of each column by dragging the borders
  41         between their headers.</li>
  42
  43         <li>In the <strong>Preferences</strong> dialog, toggle
  44         whether the table should be resized to fit the window.
  45         Enable this to ensure visibility of the whole table, and
  46         disable it to make room for displaying more
  47         information.</li>
  48
  49         <li>
  50             Color codes can be toggled in the
  51             <strong>Preferences</strong> dialog, and they help you
  52             visualize the completeness of your database by coloring
  53             cells as follows:
  54
  55             <ul>
  56                 <li>A <font color="red">red</font> cell in the
  57                 leftmost column denotes an incomplete entry.</li>
  58
  59                 <li>A <font color="#909000">yellow</font> cell in
  60                 the leftmost column denotes an entry that doesn't
  61                 define all required fields by itself, but that
  62                 contains a cross-reference.</li>
  63
  64                 <li>A <font color="blue">blue</font> cell denotes a
  65                 required field.</li>
  66
  67                 <li>A <font color="green">green</font> cell denotes
  68                 an optional field.</li>
  69
  70                 <li>An uncolored cell denotes a field which is not
  71                 used by the <em>bibtex</em> program for this type
  72                 of entry. The field can still be edited in
  73                 JabRef.</li>
  74             </ul>
  75         </li>
  76     </ul>
  77
  78     <h2>Adding a new entry</h2>
  79
  80     <p>There are several ways to add a new
  81     entry. The <strong>New entry</strong> menu action shows a
  82     dialog where you can choose the type of the entry from a list.
  83     To bypass this dialog, there are also separate menu actions for
  84     each entry type, and keyboard shortcuts for the most common
  85     types.</p>
  86
  87     <p>When a new entry is added, by default an
  88     <a href="EntryEditorHelp.html">editor dialog</a> for the entry
  89     will be opened. This behaviour can be toggled in the
  90     <strong>Preferences</strong> dialog.</p>
  91
  92     <p><em>Note:</em> We strongly recommend learning the shortcuts
  93     for the entry types you use most often, e.g. CTRL-SHIFT-A for
  94     adding an <em>article</em> entry.</p>
  95
  96     <h2>Editing an entry</h2>
  97
  98     <p>To open an
  99     <a href="EntryEditorHelp.html">editor dialog</a> for an
 100     existing entry, simply double-click anywhere on the appropriate
 101     line will open the <a href="EntryEditorHelp.html">editor
 102     dialog</a> (or select the entry and press ENTER).</p>
 103
 104     <h2>Referencing a <em>bibtex</em> string in a field</h2>
 105
 106     <p>In JabRef you write the contents of all fields the same way as you
 107     would in a text editor, with one exception: to reference a
 108     string, enclose the name of the string in a set of #
 109     characters, e.g.:<br />
 110     &nbsp;&nbsp;'#jan# 1997',<br />
 111     which will be interpreted as the string named 'jan' followed by
 112     ' 1997'.</p>
 113
 114     <p>See also: <a href="StringEditorHelp.html">string editor</a>.
 115     </p>
 116 </body>
 117 </html>