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