[svn-upgrade] new version jabref (2.7~beta1+ds)
[debian/jabref.git] / src / help / EntryEditorHelp.html
1 <html xmlns="http://www.w3.org/1999/xhtml">
2 <head>
3 <link rel="stylesheet" type="text/css" href="jabref_help.css"/>
4 </head>
5
6 <body>
7 <h1>The entry editor</h1>
8
9     <p><em>Opened from main window by
10     double-clicking anywhere on the line of the entry, or selecting
11     the entry and pressing ENTER. The panel is closed by pressing
12     ESC.</em></p>
13
14     <p>In this panel you can specify all relevant information on a
15     single entry. The entry editor checks the type of your entry,
16     and lists all the fields that are required, and the ones that
17     are optional, for referring the entry with <em>bibtex</em>. In
18     addition, there are several fields termed <em>General
19     fields</em>, that are common to all entry types.</p>
20
21     <p>You can fully customize which fields should be regarded as
22     required and optional for each type of entry, and which fields
23     appear in the General fields tabs. See
24     <a href="CustomEntriesHelp.html">Customizing entry types</a>
25     for more information about this.</p>
26
27     <p>For information about how the fields should be filled out,
28     see <a href="BibtexHelp.html">Bibtex help</a>.</p>
29
30     <h2>The entry editor's panels</h2>
31
32     <p>The entry editor contains six
33     panels: <em>Required fields</em>, <em>Optional fields</em>,
34     <em>General</em>, <em>Abstract</em>, <em>Review</em> and
35     <em>BibTeX source</em>, where <em>General</em>,
36     <em>Abstract</em> and <em>Review</em> can be customized (see
37     <a href="GeneralFields.html">Customizing general fields</a> for
38     details). Inside the three first panels, TAB and SHIFT-TAB are
39     used to switch focus between the text fields.</p>
40
41     <p>Switch panels by clicking on the tabs, or navigate to the
42     panel to the left or right using the following key
43     combinations: CTRL-TAB or CTRL-PLUS switch to the tab to the
44     right, and CTRL-SHIFT-TAB or CTRL-MINUS switch to the tab to
45     the left. You can also switch to the next or previous entry by
46     pressing CTRL-SHIFT-DOWN or CTRL-SHIFT-UP, respectively, or by
47     clicking the appropriate toolbar button.</p>
48
49     <p>The <em>bibtex source</em> panel shows how the entry will
50     appear when the database is saved in <em>bibtex</em> format. If
51     you wish, you can edit the <em>bibtex</em> source directly in
52     this panel. When you move to a different panel, press CTRL-S or
53     close the entry editor, JabRef will try to parse the contents
54     of the source panel. If there are problems, you will be
55     notified, and given the option to edit your entry further, or
56     to revert to the former contents. If <strong>Show source by
57     default</strong> is checked in the <strong>General
58     options</strong> tab of the <strong>Preferences</strong>
59     dialog, the source panel will be the one shown each time you
60     open the entry editor. If you prefer editing the source rather
61     than using the other four panels, you should check this
62     option.</p>
63
64     <p><strong>Tip:</strong> If your database contains fields
65     unknown to JabRef, these will be visible in the source
66     panel.</p>
67
68     <h2>Field consistency checking</h2>
69
70     <p>When the contents of a field
71     is changed, JabRef checks if the new contents are acceptable.
72     For field types that are used by <em>bibtex</em>, the contents
73     are checked with respect to the use of the '#' character. The
74     hash symbol is <em>only</em> to be used in pairs (except in escaped
75     form, '\#'), wrapping the
76     name of a <em>bibtex</em> string that is referenced. Note that
77     JabRef does not check if the referenced string actually exists
78     (this is not trivial, since the <em>bibtex</em> style you use
79     can define an arbitrary set of strings unknown to JabRef).</p>
80
81     <p>If the contents are not accepted, the field will turn red,
82     indicating an error. In this case the change will not be
83     stored.</p>
84
85     <!--<h2>Word/name autocompletion</h2>
86
87     <p>The entry editor offers autocompletion of words. In the Preferences dialog
88     you can enable or disable autocompletion, and choose for which fields
89     autocompletion is active.</p>
90
91     <p>With autocompletion, JabRef records all words that appear in
92     each of the chosen fields throughout your database. Whenever you write
93     the beginning of one of these words, it will be suggested visually. To
94     ignore the suggestion, simply write on. To accept the suggestion,
95     either press <em>ENTER</em> or use your arrow keys or other keys to
96     remove the selection box around the suggested characters.</p>
97
98     <p><em>Note:</em> the words considered for suggestion are only the ones
99     appearing in the same field in entries of the same database as the one you
100     are editing. There are many ways to realise this kind of feature, and if you feel
101     it should have been implemented differently, we'd like to hear your suggestions!</p>
102
103     <h2>Copy <em>bibtex</em> key</h2>
104
105     <p>Pressing CTRL-K or the 'key' button causes the <em>bibtex</em> key for your entry
106     to be copied to the clipboard.</p>
107     -->
108
109     <h2>Autogenerate <em>bibtex</em> key</h2>
110
111     <p>Press CTRL-G or the
112     'gen key' button (the magic wand) to autogenerate a
113     <em>bibtex</em> key for your entry based on the contents of its
114     required fields.</p>
115
116     <p>For more information on how JabRef generates <em>bibtex</em>
117     keys, see <a href="LabelPatterns.html">Customizing the BibTex
118     key generator</a>.</p>
119
120     <h2>Word/name autocompletion</h2>
121
122     <p>JabRef offers autocompletion of words and names. Autocompletion can be
123     set up in <b>Options -> Preferences -> Entry editor</b>, and is by default
124     activated for several of the common fields.</p>
125
126     <p>When editing a field for which autocompletion is activated, JabRef will
127     try to suggest word completions as you write, based on which words are used
128     for that specific field elsewhere in your database. The suggestion appears
129     as a highlighted block of text completing the word. If there are several
130     possible completions, you can use the PAGE UP and PAGE DOWN keys to cycle
131     through the possible suggestions. To accept a suggestion, press ENTER once.
132     To ignore the suggestion, just keep typing.</p>
133
134 </body>
135 </html>