configuring.docbook 11 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<chapter id="configuring-kate">
<chapterinfo>
<authorgroup>
<author>&Anders.Lund; &Anders.Lund.mail;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Configuring &kate;</title>

<sect1 id="configuring-overview">
<title>Overview</title>
<para>
<indexterm>
<primary>configure</primary>
<secondary>settings</secondary>
<tertiary>preferences</tertiary></indexterm>
<anchor id="find"/>
<anchor id="find-again"/>
<!-- <anchor id="print"/> -->
<anchor id="replace"/>
<!-- <anchor id="save"/> -->
<anchor id="undo"/>
<anchor id="redo"/>
&kate; offers several means of tweaking the application to behave as desired.
The most important ones are:
</para>

<variablelist>
<varlistentry>
<term id="configure">The Configuration Dialog</term>
<listitem><para>The main configuration tool, allowing you to configure the &kate; application,
the editor component and the usage of plugins.</para></listitem>
</varlistentry>
<varlistentry>
<term id="settings">The <guimenu>Settings</guimenu> Menu</term>
<listitem><para>Allows you to change often used settings, and to
launch the configuration dialogs.</para></listitem>
</varlistentry>
<varlistentry>
<term>The <guimenu>View</guimenu> Menu</term>
<listitem><para>Allows you to split the current frame, as well as to
display the icons and line numbers pane for the currently edited
document.</para></listitem>
</varlistentry>
</variablelist>

47
48
<para>The embedded terminal uses the configuration defined in the
&systemsettings;, and may also be configured by clicking the
49
&RMB; to display a context menu.</para>
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

</sect1>

<sect1 id="configuring-kate-configdialog">
<title>The Main Configuration Dialog</title>

<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="configdialog01.png"/>
</imageobject>
</mediaobject>

<para>The &kate; configuration dialog displays a tree of topics on the
left, and a configuration page corresponding to the selected topic on
the right.</para>

66
<para>The configuration is divided into two groups, namely:
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<itemizedlist>
<listitem><para><link linkend="config-dialog">Application configuration</link>
</para></listitem>
<listitem><para><link linkend="config-dialog-editor">Editor component configuration</link></para></listitem>

</itemizedlist>

</para>

</sect1>

<sect1 id="config-dialog">
<title>The &kate; Application Configuration</title>
<para>This group contains pages to configure the main &kate; application</para>

<sect2 id="config-dialog-general">
T.C. Hollingsworth's avatar
T.C. Hollingsworth committed
83
<title>General</title>
84
85
86
87
88
89
90
91
92
93
<para>This section contains a few global options for &kate;</para>

<variablelist>

<varlistentry>
<term><anchor id="config-general-behavior"/>
<guilabel>Behavior</guilabel></term>
<listitem>
<variablelist>

94
95
96
97
98
99
100
101
102
103
104
105
<varlistentry>
<term><anchor id="config-dialog-general-switch-to-output"/>
<guilabel>Switch to output view upon message type</guilabel></term>
<listitem><para>This option allows configuring when &kate; should show an
output pane depending on the type of action output.</para>
<para>It is possible to choose between <guimenuitem>Never</guimenuitem>,
<guimenuitem>Error</guimenuitem> (on error), <guimenuitem>Warning</guimenuitem>
(on warning or above), <guimenuitem>Info</guimenuitem> (on info or above),
and <guimenuitem>Log</guimenuitem> (on log or above).</para>
</listitem>
</varlistentry>

106
<varlistentry>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
107
108
109
110
<term><anchor id="config-dialog-general-separate-dialog"/>
<guilabel>Use a separate dialog for handling externally modified files</guilabel></term>
<listitem><para>When enabled, &kate; will notify you with a modal dialog about all
files modified from outside the application whenever the main window receives input focus.
111
112
You will be able to deal with several modified files at once, you
can reload, save or discard changed files in groups.</para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
113
114
<para>If not enabled, &kate; will individually ask you what to do for each modified file only
when that file's view receives focus.</para>
115
116
117
118
119
120
121
</listitem>
</varlistentry>

</variablelist>
</listitem>
</varlistentry><!-- /behavior group -->

Yuri Chornoivan's avatar
Yuri Chornoivan committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<varlistentry>
<term><anchor id="config-general-quick-open"/>
<guilabel>Quick Open</guilabel></term>
 <listitem>

<variablelist>
<varlistentry>
<term><anchor id="config-general-quick-open-match-mode"/>
<guilabel>Match Mode</guilabel></term>
<listitem><para>Set the list mode for the <link linkend="view-quick-open">Quick Open</link> tool. The files can be matched by their name or by their path.</para></listitem>
</varlistentry>

<varlistentry>
<term><anchor id="config-general-quick-open-list-mode"/>
<guilabel>List Mode</guilabel></term>
<listitem><para>Set the list mode for the <link linkend="view-quick-open">Quick Open</link> tool. It is possible to choose from <guilabel>Current Project Files</guilabel> and <guilabel>All Projects Files</guilabel>.</para></listitem>
</varlistentry>

</variablelist>

</listitem>
</varlistentry><!-- /quick open group -->

<varlistentry>
<term><anchor id="config-general-tabs"/>
<guilabel>Tabs</guilabel></term>
 <listitem>

<variablelist>
<varlistentry>
<term><anchor id="config-general-limit-number-of-tabs"/>
<guilabel>Limit number of tabs</guilabel></term>
<listitem><para>Set the maximum number of tabs. Choose <guimenuitem>Unlimited</guimenuitem> if you do not want to restrict this number.</para></listitem>
</varlistentry>
156
157
158
159
160
161
162
163
164
165
166
167

<varlistentry>
<term><anchor id="config-general-show-close-button"/>
<guilabel>Show close button</guilabel></term>
<listitem><para>When checked each tab will display a close button.</para></listitem>
</varlistentry>

<varlistentry>
<term><anchor id="config-general-expand-tabs"/>
<guilabel>Expand tabs</guilabel></term>
<listitem><para>When checked tabs take as much size as possible.</para></listitem>
</varlistentry>
168
169
170
171
172
173
174
175
176
177
178
179

<varlistentry>
<term><anchor id="config-general-double-click"/>
<guilabel>Double click opens a new document</guilabel></term>
<listitem><para>When checked double click opens a new document.</para></listitem>
</varlistentry>

<varlistentry>
<term><anchor id="config-general-middle-click"/>
<guilabel>Middle click closes a document</guilabel></term>
<listitem><para>When checked middle click closes a document.</para></listitem>
</varlistentry>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
180
181
182
183
</variablelist>

</listitem>
</varlistentry><!-- /tabs group -->
184
185
186
187
</variablelist>
</sect2>

<sect2 id="config-dialog-sessions">
Yuri Chornoivan's avatar
Yuri Chornoivan committed
188
<title>Session</title>
189
190
191
192
193
194
195
196

<para>This section contains options related to <link
linkend="fundamentals-using-sessions">using sessions</link>.</para>

<variablelist>

<varlistentry>
<term><anchor id="config-dialog-sessions-startup-behavior"/>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
197
<guilabel>Application Startup Behavior</guilabel></term>
198
199
200
201
202
203
204
205
<listitem>
<para>Select how you want &kate; to behave at startup. This setting can be
overridden by specifying what to do on the <link
linkend="command-line-options">command line</link>.</para>
<variablelist>
<varlistentry>
<term><guilabel>Start new session</guilabel></term>
<listitem><para>With this option, &kate; will start a new, unnamed session
206
when you start the application.</para></listitem>
207
208
209
210
211
212
213
214
215
216
</varlistentry>
<varlistentry>
<term><guilabel>Load last-used session</guilabel></term>
<listitem><para>&kate; will use the most recently opened session at
startup. This is good if you want to use the same session always or switch
rarely.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Manually choose a session</guilabel></term>
<listitem><para>&kate; will display a small dialog that lets you choose
T.C. Hollingsworth's avatar
T.C. Hollingsworth committed
217
218
219
your preferred session, or load the default session if none have been saved.
This is the default behavior. Nice if you use a lot of different sessions
frequently.</para></listitem>
220
221
222
223
224
</varlistentry>
</variablelist>
</listitem>
</varlistentry><!-- /startup behavior -->

Yuri Chornoivan's avatar
Yuri Chornoivan committed
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<varlistentry>
<term><anchor id="config-dialog-sessions-shutdown-behavior"/>
<guilabel>Application Shutdown Behavior</guilabel></term>
<listitem>
<para>Select how you want &kate; to behave at shutdown. It is possible to define what
&kate; should <guilabel>Automatically save and restore</guilabel>.</para>
<variablelist>
<varlistentry>
<term><guilabel>Newly-created unsaved files</guilabel></term>
<listitem><para>With this item checked, &kate; will automatically save
all newly-created unsaved files.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Files with unsaved changes</guilabel></term>
<listitem><para>This item allows configuring &kate; for automatically saving
all files with unsaved changes on shutdown.</para></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="config-dialog-sessions-close-mod"/>
<guilabel>Close Kate entirely when the last file is closed</guilabel></term>
<listitem><para>If enabled, &kate; will shutdown when the last file being edited is closed,
otherwise a blank page will open so that you can start a new file.</para>
</listitem>
</varlistentry>
</variablelist>

</listitem>
</varlistentry><!-- /shutdown behavior -->

<varlistentry>
<term><anchor id="config-dialog-sessions-elements"/>
<guilabel>Session Elements</guilabel></term>
<listitem>
<variablelist>
<!--FIXME Maximum number of entries in recent file list-->
<varlistentry>
<term><guilabel>Include window configuration</guilabel></term>
<listitem><para>If enabled, &kate; will save the window configuration
with each session.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry><!-- /elements of sessions -->

<varlistentry>
<term><anchor id="config-sessions-keep-meta-information"/>
<guilabel>Keep meta-information past sessions</guilabel></term>
<listitem><para>When enabled, &kate; will store meta data such as bookmarks
and session configuration even when you close your documents. The data
will be used if the document is unchanged when reopened.</para></listitem>
</varlistentry>

<varlistentry>
<term><anchor id="config-sessions-delete-meta-information-after"/>
<guilabel>Delete unused meta-information after</guilabel></term>
<listitem><para>Set the maximum number of days to keep meta information
281
for previously opened files. This helps keep the database of meta information
Yuri Chornoivan's avatar
Yuri Chornoivan committed
282
283
284
reasonably sized.</para></listitem>
</varlistentry>

285
</variablelist>
286
<para>Any changes to the session data (opened files and, if enabled,
287
288
289
290
window configuration) will always be saved.</para>

</sect2>

291
292
293
294
<sect2 id="config-dialog-plugins">
<title>Plugins</title>

<para>This page provides a list of installed plugins for the &kate;
295
296
application. Each plugin is represented with its name and a short description.
You can check the checkbox with an item to enable the plugin it represents.
297
298
</para>

299
<para>If a plugin provides configuration options, a section to access those
300
301
will appear as a child of this page.</para>

302
<para>For more information about the available plugins, see
303
304
305
306
<xref linkend="plugins"/>.</para>

</sect2>

307
<sect2 id="config-dialog-editor">
308
309
310
<title>The Editor Component Configuration</title>

<para>For information about this section of the configuration dialog, see the
311
<ulink url="help:/katepart/config-dialog.html">Editor Component
312
313
Configuration section of the &katepart; Handbook</ulink>.</para>

314
</sect2>
315

316
<sect2 id="config-variables">
317
318
319
<title>Configuring With Document Variables</title>

<para>For information about using document variables with &kate;, see the
320
<ulink url="help:/katepart/config-variables.html">Configuring with Document
321
322
Variables section of the &katepart; Handbook</ulink>.</para>

323
324
</sect2>

325
</sect1>
326

327
</chapter>