Warning, /utilities/kate/doc/kate/configuring.docbook is written in an unsupported language. File is not indexed.
0001 <chapter id="configuring-kate"> 0002 <chapterinfo> 0003 <authorgroup> 0004 <author>&Anders.Lund; &Anders.Lund.mail;</author> 0005 <!-- TRANS:ROLES_OF_TRANSLATORS --> 0006 </authorgroup> 0007 </chapterinfo> 0008 <title>Configuring &kate;</title> 0009 0010 <sect1 id="configuring-overview"> 0011 <title>Overview</title> 0012 <para> 0013 <indexterm> 0014 <primary>configure</primary> 0015 <secondary>settings</secondary> 0016 <tertiary>preferences</tertiary></indexterm> 0017 <anchor id="find"/> 0018 <anchor id="find-again"/> 0019 <!-- <anchor id="print"/> --> 0020 <anchor id="replace"/> 0021 <!-- <anchor id="save"/> --> 0022 <anchor id="undo"/> 0023 <anchor id="redo"/> 0024 &kate; offers several means of tweaking the application to behave as desired. 0025 The most important ones are: 0026 </para> 0027 0028 <variablelist> 0029 <varlistentry> 0030 <term id="configure">The Configuration Dialog</term> 0031 <listitem><para>The main configuration tool, allowing you to configure the &kate; application, 0032 the editor component and the usage of plugins.</para></listitem> 0033 </varlistentry> 0034 <varlistentry> 0035 <term id="settings">The <guimenu>Settings</guimenu> Menu</term> 0036 <listitem><para>Allows you to change often used settings, and to 0037 launch the configuration dialogs.</para></listitem> 0038 </varlistentry> 0039 <varlistentry> 0040 <term>The <guimenu>View</guimenu> Menu</term> 0041 <listitem><para>Allows you to split the current frame, as well as to 0042 display the icons and line numbers pane for the currently edited 0043 document.</para></listitem> 0044 </varlistentry> 0045 </variablelist> 0046 0047 <para>The embedded terminal uses the configuration defined in the 0048 &systemsettings;, and may also be configured by clicking the 0049 &RMB; to display a context menu.</para> 0050 0051 </sect1> 0052 0053 <sect1 id="configuring-kate-configdialog"> 0054 <title>The Main Configuration Dialog</title> 0055 0056 <mediaobject> 0057 <imageobject> 0058 <imagedata format="PNG" fileref="configdialog01.png"/> 0059 </imageobject> 0060 </mediaobject> 0061 0062 <para>The &kate; configuration dialog displays a tree of topics on the 0063 left, and a configuration page corresponding to the selected topic on 0064 the right.</para> 0065 0066 <para>The configuration is divided into two groups, namely: 0067 <itemizedlist> 0068 <listitem><para><link linkend="config-dialog">Application configuration</link> 0069 </para></listitem> 0070 <listitem><para><link linkend="config-dialog-editor">Editor component configuration</link></para></listitem> 0071 0072 </itemizedlist> 0073 0074 </para> 0075 0076 </sect1> 0077 0078 <sect1 id="config-dialog"> 0079 <title>The &kate; Application Configuration</title> 0080 <para>This group contains pages to configure the main &kate; application</para> 0081 0082 <sect2 id="config-dialog-general"> 0083 <title>General</title> 0084 <para>This section contains a few global options for &kate;</para> 0085 0086 <variablelist> 0087 0088 <varlistentry> 0089 <term><anchor id="config-general-behavior"/> 0090 <guilabel>Behavior</guilabel></term> 0091 <listitem> 0092 <variablelist> 0093 0094 <varlistentry> 0095 <term><anchor id="config-dialog-general-open-each-document"/> 0096 <guilabel>Open each document in its own window</guilabel></term> 0097 <listitem><para>If enabled, each document will be opened in its own window. 0098 If not enabled, each document will be opened in a new tab in the current 0099 window.</para> 0100 </listitem> 0101 </varlistentry> 0102 0103 <varlistentry> 0104 <term><anchor id="config-dialog-general-switch-to-output"/> 0105 <guilabel>Switch to output view upon message type</guilabel></term> 0106 <listitem><para>This option allows configuring when &kate; should show an 0107 output pane depending on the type of action output.</para> 0108 <para>It is possible to choose between <guimenuitem>Never</guimenuitem>, 0109 <guimenuitem>Error</guimenuitem> (on error), <guimenuitem>Warning</guimenuitem> 0110 (on warning or above), <guimenuitem>Info</guimenuitem> (on info or above), 0111 and <guimenuitem>Log</guimenuitem> (on log or above).</para> 0112 </listitem> 0113 </varlistentry> 0114 0115 <varlistentry> 0116 <term><anchor id="config-dialog-general-separate-dialog"/> 0117 <guilabel>Use a separate dialog for handling externally modified files</guilabel></term> 0118 <listitem><para>When enabled, &kate; will notify you with a modal dialog about all 0119 files modified from outside the application whenever the main window receives input focus. 0120 You will be able to deal with several modified files at once, you 0121 can reload, save or discard changed files in groups.</para> 0122 <para>If not enabled, &kate; will individually ask you what to do for each modified file only 0123 when that file's view receives focus.</para> 0124 </listitem> 0125 </varlistentry> 0126 0127 </variablelist> 0128 </listitem> 0129 </varlistentry><!-- /behavior group --> 0130 0131 <varlistentry> 0132 <term><anchor id="config-general-quick-open"/> 0133 <guilabel>Quick Open</guilabel></term> 0134 <listitem> 0135 0136 <variablelist> 0137 <varlistentry> 0138 <term><anchor id="config-general-quick-open-match-mode"/> 0139 <guilabel>Match Mode</guilabel></term> 0140 <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> 0141 </varlistentry> 0142 0143 <varlistentry> 0144 <term><anchor id="config-general-quick-open-list-mode"/> 0145 <guilabel>List Mode</guilabel></term> 0146 <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> 0147 </varlistentry> 0148 0149 </variablelist> 0150 0151 </listitem> 0152 </varlistentry><!-- /quick open group --> 0153 0154 <varlistentry> 0155 <term><anchor id="config-general-tabs"/> 0156 <guilabel>Tabs</guilabel></term> 0157 <listitem> 0158 0159 <variablelist> 0160 <varlistentry> 0161 <term><anchor id="config-general-limit-number-of-tabs"/> 0162 <guilabel>Limit number of tabs</guilabel></term> 0163 <listitem><para>Set the maximum number of tabs. Choose <guimenuitem>Unlimited</guimenuitem> if you do not want to restrict this number.</para></listitem> 0164 </varlistentry> 0165 0166 <varlistentry> 0167 <term><anchor id="config-general-auto-hide-tabs"/> 0168 <guilabel>Auto hide tabs</guilabel></term> 0169 <listitem><para>When checked tabs will be hidden if only one document is open.</para></listitem> 0170 </varlistentry> 0171 0172 <varlistentry> 0173 <term><anchor id="config-general-show-close-button"/> 0174 <guilabel>Show close button</guilabel></term> 0175 <listitem><para>When checked each tab will display a close button.</para></listitem> 0176 </varlistentry> 0177 0178 <varlistentry> 0179 <term><anchor id="config-general-expand-tabs"/> 0180 <guilabel>Expand tabs</guilabel></term> 0181 <listitem><para>When checked tabs take as much size as possible.</para></listitem> 0182 </varlistentry> 0183 0184 <varlistentry> 0185 <term><anchor id="config-general-double-click"/> 0186 <guilabel>Double click opens a new document</guilabel></term> 0187 <listitem><para>When checked double click opens a new document.</para></listitem> 0188 </varlistentry> 0189 0190 <varlistentry> 0191 <term><anchor id="config-general-middle-click"/> 0192 <guilabel>Middle click closes a document</guilabel></term> 0193 <listitem><para>When checked middle click closes a document.</para></listitem> 0194 </varlistentry> 0195 0196 <varlistentry> 0197 <term><anchor id="config-general-tab-scrolling"/> 0198 <guilabel>Allow tab scrolling</guilabel></term> 0199 <listitem><para>When checked this will allow scrolling in tab bar when number of tabs is large.</para></listitem> 0200 </varlistentry> 0201 0202 <varlistentry> 0203 <term><anchor id="config-general-elide-tab-text"/> 0204 <guilabel>Elide tab text</guilabel></term> 0205 <listitem><para>When checked tab text might be elided if its too long.</para></listitem> 0206 </varlistentry> 0207 </variablelist> 0208 0209 </listitem> 0210 </varlistentry><!-- /tabs group --> 0211 0212 <varlistentry> 0213 <term><anchor id="config-general-mouse"/> 0214 <guilabel>Tabs</guilabel></term> 0215 <listitem> 0216 0217 <variablelist> 0218 <varlistentry> 0219 <term><anchor id="config-general-backward-button-pressed"/> 0220 <guilabel>Backward button pressed</guilabel></term> 0221 <listitem><para>Allows selecting the mouse back button action between the <guimenuitem>Previous tab</guimenuitem> and the <guimenuitem>History back</guimenuitem> items.</para></listitem> 0222 </varlistentry> 0223 0224 <varlistentry> 0225 <term><anchor id="config-general-forward-button-pressed"/> 0226 <guilabel>Forward button pressed</guilabel></term> 0227 <listitem><para>Allows selecting the mouse forward button action between the <guimenuitem>Next tab</guimenuitem> and the <guimenuitem>History forward</guimenuitem> items.</para></listitem> 0228 </varlistentry> 0229 </variablelist> 0230 0231 </listitem> 0232 </varlistentry><!-- /mouse group --> 0233 </variablelist> 0234 </sect2> 0235 0236 <sect2 id="config-dialog-sessions"> 0237 <title>Session</title> 0238 0239 <para>This section contains options related to <link 0240 linkend="fundamentals-using-sessions">using sessions</link>.</para> 0241 0242 <variablelist> 0243 0244 <varlistentry> 0245 <term><anchor id="config-dialog-sessions-startup-behavior"/> 0246 <guilabel>Application Startup Behavior</guilabel></term> 0247 <listitem> 0248 <para>Select how you want &kate; to behave at startup. This setting can be 0249 overridden by specifying what to do on the <link 0250 linkend="command-line-options">command line</link>.</para> 0251 <variablelist> 0252 <varlistentry> 0253 <term><guilabel>Start new session</guilabel></term> 0254 <listitem><para>With this option, &kate; will start a new, unnamed session 0255 when you start the application.</para></listitem> 0256 </varlistentry> 0257 <varlistentry> 0258 <term><guilabel>Load last-used session</guilabel></term> 0259 <listitem><para>&kate; will use the most recently opened session at 0260 startup. This is good if you want to use the same session always or switch 0261 rarely.</para></listitem> 0262 </varlistentry> 0263 <varlistentry> 0264 <term><guilabel>Manually choose a session</guilabel></term> 0265 <listitem><para>&kate; will display a small dialog that lets you choose 0266 your preferred session, or load the default session if none have been saved. 0267 This is the default behavior. Nice if you use a lot of different sessions 0268 frequently.</para></listitem> 0269 </varlistentry> 0270 </variablelist> 0271 </listitem> 0272 </varlistentry><!-- /startup behavior --> 0273 0274 <varlistentry> 0275 <term><anchor id="config-dialog-sessions-shutdown-behavior"/> 0276 <guilabel>Application Startup/Shutdown Behavior</guilabel></term> 0277 <listitem> 0278 <para>Select how you want &kate; to behave at shutdown. It is possible to define what 0279 &kate; should <guilabel>Automatically save and restore</guilabel>.</para> 0280 <variablelist> 0281 <varlistentry> 0282 <term><guilabel>Newly-created unsaved files</guilabel></term> 0283 <listitem><para>With this item checked, &kate; will automatically save 0284 all newly-created unsaved files.</para></listitem> 0285 </varlistentry> 0286 <varlistentry> 0287 <term><guilabel>Files with unsaved changes</guilabel></term> 0288 <listitem><para>This item allows configuring &kate; for automatically saving 0289 all files with unsaved changes on shutdown.</para></listitem> 0290 </varlistentry> 0291 <varlistentry> 0292 <term><anchor id="config-dialog-sessions-close-mod"/> 0293 <guilabel>Close Kate entirely when the last file is closed</guilabel></term> 0294 <listitem><para>If enabled, &kate; will shutdown when the last file being edited is closed, 0295 otherwise a blank page will open so that you can start a new file.</para> 0296 </listitem> 0297 </varlistentry> 0298 </variablelist> 0299 0300 </listitem> 0301 </varlistentry><!-- /shutdown behavior --> 0302 0303 <varlistentry> 0304 <term><anchor id="config-dialog-sessions-elements"/> 0305 <guilabel>Session Elements</guilabel></term> 0306 <listitem> 0307 <variablelist> 0308 <!--FIXME Maximum number of entries in recent file list--> 0309 <varlistentry> 0310 <term><guilabel>Include window configuration</guilabel></term> 0311 <listitem><para>If enabled, &kate; will save the window configuration 0312 with each session.</para></listitem> 0313 </varlistentry> 0314 </variablelist> 0315 </listitem> 0316 </varlistentry><!-- /elements of sessions --> 0317 0318 <varlistentry> 0319 <term><anchor id="config-sessions-keep-meta-information"/> 0320 <guilabel>Keep meta-information past sessions</guilabel></term> 0321 <listitem><para>When enabled, &kate; will store meta data such as bookmarks 0322 and session configuration even when you close your documents. The data 0323 will be used if the document is unchanged when reopened.</para></listitem> 0324 </varlistentry> 0325 0326 <varlistentry> 0327 <term><anchor id="config-sessions-delete-meta-information-after"/> 0328 <guilabel>Delete unused meta-information after</guilabel></term> 0329 <listitem><para>Set the maximum number of days to keep meta information 0330 for previously opened files. This helps keep the database of meta information 0331 reasonably sized.</para></listitem> 0332 </varlistentry> 0333 0334 </variablelist> 0335 <para>Any changes to the session data (opened files and, if enabled, 0336 window configuration) will always be saved.</para> 0337 0338 </sect2> 0339 0340 <sect2 id="config-dialog-plugins"> 0341 <title>Plugins</title> 0342 0343 <para>This page provides a list of installed plugins for the &kate; 0344 application. Each plugin is represented with its name and a short description. 0345 You can check the checkbox with an item to enable the plugin it represents. 0346 </para> 0347 0348 <para>If a plugin provides configuration options, a section to access those 0349 will appear as a child of this page.</para> 0350 0351 <para>For more information about the available plugins, see 0352 <xref linkend="plugins"/>.</para> 0353 0354 </sect2> 0355 0356 <sect2 id="config-dialog-editor"> 0357 <title>The Editor Component Configuration</title> 0358 0359 <para>For information about this section of the configuration dialog, see the 0360 <ulink url="help:/katepart/config-dialog.html">Editor Component 0361 Configuration section of the &katepart; Handbook</ulink>.</para> 0362 0363 </sect2> 0364 0365 <sect2 id="config-variables"> 0366 <title>Configuring With Document Variables</title> 0367 0368 <para>For information about using document variables with &kate;, see the 0369 <ulink url="help:/katepart/config-variables.html">Configuring with Document 0370 Variables section of the &katepart; Handbook</ulink>.</para> 0371 0372 </sect2> 0373 0374 </sect1> 0375 0376 </chapter>