c15ceb1d9284dccf653ff965d5079c2a7954274c
[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>Fields can be edited directly in the table, by simply clicking on a cell and
22 typing the contents
23 (this edition mode is possible only if "Allow editing in table cells"
24 is selected in <strong>Options --> Preferences --> General</strong>).
25 Double-click a cell to enter a more powerful edit mode.
26 You can navigate the table with the arrow keys.</li>
27 <li>The table is sorted according to a set of fields of your choosing.
28 The default sort order is set up in <strong>Preferences -> Entry table</strong>,
29 but to quickly change the order,
30     click the header of a column to set it as the primary sort criterion, or
31     reverse the sorting if it is already set. Another click will deselect the column
32     as sorting criterion. Hold down <b>CONTROL</b> and click a column to add, reverse
33     or remove it as a sub-criterion after the primary column. You can add an arbitrary
34     number of sub-criteria.
35 <li>Adjust the width of each column by dragging the borders between
36 their headers.</li>
37 <li>In the <strong>Preferences</strong> dialog, toggle whether the table should be
38 resized to fit the window. Enable this to ensure visibility of the whole table,
39 and disable it to make room for displaying more information.</li>
40 <li>Color codes can be toggled in the <strong>Preferences</strong> dialog, and
41 they help you visualize the completeness of your database by coloring cells as
42 follows:
43   <ul>
44   <li>A <font color="red">red</font> cell in the leftmost column denotes an
45   incomplete entry.</li>
46   <li>A <font color="#909000">yellow</font> cell in the leftmost column denotes an entry
47   that doesn't define all required fields by itself, but that contains a
48   cross-reference.</li>
49   <li>A <font color="blue">blue</font> cell denotes a required field.</li>
50   <li>A <font color="green">green</font> cell denotes an optional field.</li>
51   <li>An uncolored cell denotes a field which is not used by the <em>bibtex</em>
52   program for this type of entry. The field can still be edited in JabRef.</li>
53   </ul>
54 </li>
55
56 </ul>
57
58 <H2>Adding a new entry</H2>
59 There are several ways to add a new entry. The <strong>New entry</strong> menu
60 action shows a dialog where you can choose the type of the entry from a list. To
61 bypass this dialog, there are also separate menu actions for each entry type, and
62 keyboard shortcuts for the most common types.
63 <P>When a new entry is added, by default an
64 <a href="EntryEditorHelp.html">editor dialog</a> for the entry will be
65 opened. This behaviour can be toggled in the <strong>Preferences</strong> dialog.
66 <P><em>Note:</em> We strongly recommend learning the shortcuts for
67 the entry types you use most often, e.g. CTRL-SHIFT-A for adding an
68 <em>article</em> entry.
69
70 <H2>Editing an entry</H2> To open an <a
71 href="EntryEditorHelp.html">editor dialog</a> for an existing entry,
72 simply double-click in the leftmost column of the appropriate line, or
73 select the entry and press ENTER.
74 If "Allow editing in table cells" is not selected in the dialog window
75 <strong>Options --> Preferences --> General</strong>, a double-click anywhere
76 on the appropriate line will open the <a href="EntryEditorHelp.html">editor dialog</a>.
77
78
79 <H2>Referencing a <em>bibtex</em> string in a field</H2>
80 In JabRef you write the contents of all fields the same way as you
81 would in a text editor, with one exception: to reference a string,
82 enclose the name of the string in a set of # characters, e.g.:<BR>
83 &nbsp;&nbsp;'#jan# 1997',<BR>
84 which will be interpreted as the string named 'jan' followed by ' 1997'.
85 <P>See also: <a href="StringEditorHelp.html">string editor</a>.
86
87 </font>
88
89 </BODY>
90 </HTML>