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