Load /tmp/tmp.JUKpM13035/jabref-2.0.1+2.1b2 into
[debian/jabref.git] / src / help / EntryEditorHelp.html
1 <HTML>
2
3 <BODY text="#275856">
4 <basefont size="4" color="#2F4958" face="arial">
5
6 <H1>The entry editor</H1>
7
8 <em>Opened from main window by double-clicking anywhere on the line of the entry,
9 or selecting the entry and pressing ENTER. The panel is closed by pressing ESC.</em>
10 <P>
11 In this panel you can specify all relevant information on a single entry.
12 The entry editor checks the type of your entry, and lists all the fields that
13 are required, and the ones that are optional, for referring the entry
14 with <em>bibtex</em>. In addition, there are several fields termed <em>General
15 fields</em>, that are common to all entry types.
16
17 <P>You can fully customize which fields should be regarded as required and optional for each
18 type of entry, and which fields appear in the General fields tab. See
19 <a href="CustomEntriesHelp.html">Customizing entry types</a> for more information about this.
20
21 <P>For information about how the fields should be filled out, see <a href="BibtexHelp.html">Bibtex help</a>.
22
23 <H2>The entry editor's panels</H2>
24
25 The entry editor contains six panels: <em>Required fields</em>,
26 <em>Optional fields</em>, <em>General</em>, <em>Abstract</em>, <em>Review</em> and <em>BibTeX
27 source</em>, where <em>General</em>, <em>Abstract</em> and <em>Review</em> can be customized
28 (see <a href="GeneralFields.html">Customizing general fields</a> for details).
29 Inside the three first panels, TAB and SHIFT-TAB are used
30 to switch focus between the text fields.
31
32 <P>Switch panels by clicking on the tabs, or navigate to the panel to
33 the left or right using the following key combinations: CTRL-TAB or CTRL-PLUS
34 switch to the tab to the right, and CTRL-SHIFT-TAB or CTRL-MINUS switch to the
35 tab to the left. You can also switch to the next or previous entry by pressing
36 CTRL-SHIFT-DOWN or CTRL-SHIFT-UP, respectively, or by clicking the
37 appropriate toolbar button.
38
39 <P>The <em>bibtex source</em> panel shows how the entry will appear
40 when the database is saved in <em>bibtex</em> format.  If you wish,
41 you can edit the <em>bibtex</em> source directly in this panel. When
42 you move to a different panel, press CTRL-S or close the entry editor,
43 JabRef will try to parse the contents of the source panel. If there
44 are problems, you will be notified, and given the option to edit your
45 entry further, or to revert to the former contents.
46
47 If <strong>Show source by default</strong> is checked in the
48 <strong>General options</strong> tab of the
49 <strong>Preferences</strong> dialog, the source panel will be the one
50 shown each time you open the entry editor. If you prefer editing the
51 source rather than using the other four panels, you should check this
52 option.
53
54 <P><strong>Tip:</strong> If your database contains fields unknown to
55 JabRef, these will be visible in the source panel.
56
57 <P><strong>Tip:</strong> the <I>pdf</I> and <I>url</I> fields support Drag and Drop operations.
58 You can drop there an url from your browser. either a link to a pdf file
59 (that JabRef can download for you) or you can keep the link.
60
61 <H2>Field consistency checking</H2>
62 When the contents of a field is changed, JabRef checks if the new
63 contents are acceptable. For field types that are used by
64 <em>bibtex</em>, the contents are checked with respect to the use of
65 the '#' character. The hash symbol is <em>only</em> to be used in
66 pairs, wrapping the name of a <em>bibtex</em> string that is
67 referenced. Note that JabRef does not check if the referenced string
68 actually exists (this is not trivial, since the <em>bibtex</em> style
69 you use can define an arbitrary set of strings unknown to JabRef).
70 <P>
71 If the contents are not accepted, the field will turn red,
72 indicating an error. In this case the change will not be stored.
73
74 <!--<H2>Word/name autocompletion</H2>
75 The entry editor offers autocompletion of words. In the Preferences dialog
76 you can enable or disable autocompletion, and choose for which fields
77 autocompletion is active.
78 <P>With autocompletion, JabRef records all words that appear in
79 each of the chosen fields throughout your database. Whenever you write
80 the beginning of one of these words, it will be suggested visually. To
81 ignore the suggestion, simply write on. To accept the suggestion,
82 either press <em>ENTER</em> or use your arrow keys or other keys to
83 remove the selection box around the suggested characters.
84 <P><em>Note:</em> the words considered for suggestion are only the ones
85 appearing in the same field in entries of the same database as the one you
86 are editing. There are many ways to realise this kind of feature, and if you feel
87 it should have been implemented differently, we'd like to hear your suggestions!
88
89 <H2>Copy <em>bibtex</em> key</H2>
90 Pressing CTRL-K or the 'key' button causes the <em>bibtex</em> key for your entry
91 to be copied to the clipboard.
92 -->
93 <H2>Autogenerate <em>bibtex</em> key</H2>
94 Press CTRL-G or the 'gen key' button (the magic wand) to autogenerate a <em>bibtex</em> key for your entry
95 based on the contents of its required fields.
96 <p>
97 For more information on how JabRef generates <em>bibtex</em> keys, see <a href="LabelPatterns.html">Customizing the BibTex key generator</a>.
98
99 </BODY>
100 </HTML>