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