Warning, /utilities/krusader/doc/handbook/viewer-editor.docbook is written in an unsupported language. File is not indexed.

0001 <!--
0002     SPDX-FileCopyrightText: 2000-2003 Shie Erlich <erlich@users.sourceforge.net>
0003     SPDX-FileCopyrightText: 2000-2003 Rafi Yanai <yanai@users.sourceforge.net>
0004     SPDX-FileCopyrightText: 2004-2010 Frank Schoolmeesters <codeknight@users.sourceforge.net>
0005     SPDX-FileCopyrightText: 2000-2022 Krusader Krew <https://krusader.org>
0006 -->
0007 <sect1 id="krviewer">
0008   <title>KrViewer: &krusader;'s internal
0009   viewer-editor</title>
0010   <indexterm>
0011     <primary>Viewer</primary>
0012     <seealso>Editor</seealso>
0013   </indexterm>
0014   <para>Pressing &Enter; on a selected file
0015   <emphasis>opens the file with the associated
0016   application</emphasis>. The editor-viewer is tabbed, configure it
0017   on the <link linkend="konfig-general">Konfigurator General page</link></para>
0018   <sect2 id="krview">
0019     <title>Viewer</title>
0020     <para>To view a file as fast as possible according to its type,
0021     just put it under the cursor and press
0022     <keycap>F3</keycap>. &krusader;'s internal viewer is
0023     actually a part of &konqueror;, which can basically
0024     view every file type viewable by &konqueror;
0025     (&eg; display pictures, play music, show the content
0026     of an archive). This is called the 'Generic viewer', for which
0027     you need to configure the &MIME; types.</para>
0028     <para>The viewer works as follows:
0029     <itemizedlist>
0030       <listitem>
0031         <para>It tries to view the file with the
0032         <emphasis>'Generic viewer'.</emphasis></para>
0033       </listitem>
0034       <listitem>
0035         <para>When the file type (&MIME; type) cannot be determined or
0036         when a file (&eg; a binary) does not have an
0037         associated action, it disables the 'generic viewer'. The
0038         file is treated as a text file, which is the
0039         <emphasis>'Text viewer'</emphasis>.</para>
0040       </listitem>
0041       <listitem>
0042         <para>The user can change in the
0043         <link linkend="kredit_krviewer_menu">KrViewer
0044         menu</link> between: 'Generic viewer' (if available), 'Text
0045         viewer' and
0046         <emphasis>'Hex viewer'</emphasis>.</para>
0047       </listitem>
0048     </itemizedlist>You can configure the default viewer mode on the
0049     <link linkend="konfig-general">Konfigurator General page</link> .</para>
0050     <para>
0051     <keycombo action="simul">&Shift;
0052     <keycap>F3</keycap></keycombo> views a &URL; on
0053     demand, &eg;:
0054     <itemizedlist>
0055       <listitem>
0056         <para>
0057         <userinput>
0058           <command>man:/</command>
0059         </userinput>views the manpages.</para>
0060       </listitem>
0061       <listitem>
0062         <para>
0063         <userinput>
0064           <command>man:/</command><replaceable>krusader</replaceable>
0065         </userinput>views manpage of &krusader;.</para>
0066       </listitem>
0067       <listitem>
0068         <para>
0069         <userinput>
0070           <command>info:/</command>
0071         </userinput>views the infopages.</para>
0072       </listitem>
0073       <listitem>
0074         <para>
0075         <userinput>
0076           <command>https://</command><replaceable>krusader.org</replaceable>
0077         </userinput>views a webpage.</para>
0078       </listitem>
0079       <listitem>
0080         <para>
0081         <userinput>
0082           <command>ftp://</command><replaceable>ftp.kde.org/pub/kde/</replaceable>
0083         </userinput>views a &FTP; server.</para>
0084       </listitem>
0085       <listitem>
0086         <para>
0087         <userinput>
0088           <command>sftp://</command><replaceable>sftp.foo/</replaceable>
0089         </userinput>views a secure &FTP; server.</para>
0090       </listitem>
0091       <listitem>
0092         <para>
0093         <userinput>
0094           <command>file:/</command><replaceable>home/frank</replaceable>
0095         </userinput>views Frank's home folder.</para>
0096       </listitem>
0097       <listitem>
0098         <para>
0099         <userinput>
0100           <command>tar:/</command><replaceable>home/frank/archive.tar.gz/</replaceable>
0101         </userinput>opens content browser window for the
0102         <literal role="extension">tar.gz</literal> archive.</para>
0103       </listitem>
0104     </itemizedlist></para>
0105     <para>KrViewer can have the following menus:
0106     <link linkend="katepart-menu-file">File</link>,
0107     <link linkend="katepart-menu-edit">Edit</link>,
0108     <link linkend="katepart-menu-view">View</link>,
0109     <link linkend="katepart-menu-settings">Settings</link> and
0110     <link linkend="kredit_krviewer_menu">Krviewer</link>, depending
0111     on which file type is viewed. They will be discussed in the
0112     <link linkend="kredit">Editor section</link>. The internal
0113     viewer can follow links on &HTML; pages. With
0114     <keycombo action="simul">&Ctrl;&Shift;
0115     <keycap>E</keycap></keycombo> the viewer can start
0116     &krusader;'s internal editor (which is basically the
0117     same application).</para>
0118     <note>
0119       <para>The embedded viewer is not written by us, it is
0120       supplied via &kde-frameworks; and
0121       KIO Slaves. We cannot and do not want to
0122       change it, using these libraries reduces the amount of
0123       written code. So we do not have to reinvent the wheel
0124       ;-)</para>
0125     </note>
0126   </sect2>
0127   <sect2 id="kredit">
0128     <title>Editor</title>
0129     <indexterm>
0130       <primary>Editor</primary>
0131     </indexterm>
0132     <para>&krusader;'s internal editor has almost
0133     everything that you can expect of an editor. Editing is similar
0134     to viewing but with the
0135     <keycap>F4</keycap> key. The default editor is
0136     &krusader;'s internal editor. You can change the
0137     default editor in the <link linkend="konfig-general">Konfigurator General page</link>, if you
0138     prefer to use an external editor.</para>
0139     <tip>
0140       <para>When you use &krusader;'s internal editor
0141       for the first time, it is recommended to look at each section
0142       of the
0143       <link linkend="katepart-menu-settings">Settings</link> menu, and
0144       configure it the way you want it.</para>
0145     </tip>
0146   </sect2>
0147   <sect2 id="kredit_menus">
0148     <title>Menu overview</title>
0149 
0150 <!--mostly brought in from kwrite-->
0151 <para>There are different menus and menu items in simple and advanced mode.
0152 The advanced mode is enabled by checking the option <link linkend="katepart-appearance">
0153 Enable power user mode (&kde; 3 mode)</link>
0154 on the <guilabel>Appearance</guilabel> page in &kappname;s settings.</para>
0155 
0156 <sect3 id="katepart-menu-file">
0157 <title>The File Menu</title>
0158 
0159 <variablelist>
0160 
0161 <varlistentry>
0162 <term id="katepart-menu-save">
0163 <menuchoice>
0164 <shortcut>
0165 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
0166 </shortcut>
0167 <guimenu>File</guimenu>
0168 <guimenuitem>Save</guimenuitem>
0169 </menuchoice>
0170 </term>
0171 <listitem>
0172 <para>
0173 This saves the current document.  If there has already been a save of
0174 the document then this will overwrite the previously saved file without
0175 asking for the user's consent.  If it is the first save of a new
0176 document the save as dialog (described below) will be invoked.
0177 </para>
0178 </listitem>
0179 </varlistentry>
0180 
0181 <varlistentry>
0182 <term id="katepart-menu-save-as">
0183 <menuchoice>
0184 <guimenu>File</guimenu>
0185 <guimenuitem>Save As...</guimenuitem>
0186 </menuchoice>
0187 </term>
0188 <listitem>
0189 <para>
0190 This allows a document to be saved with a new file name.
0191 </para>
0192 </listitem>
0193 </varlistentry>
0194 
0195 <varlistentry>
0196 <term id="katepart-menu-reload">
0197 <menuchoice>
0198 <shortcut>
0199 <keycombo action="simul"><keycap>F5</keycap></keycombo>
0200 </shortcut>
0201 <guimenu>File</guimenu>
0202 <guimenuitem>Reload</guimenuitem>
0203 </menuchoice>
0204 </term>
0205 <listitem>
0206 <para>
0207 Reloads the active file from disk. This command is useful if another program or
0208 process has changed the file while you have it open in &kappname;.
0209 </para>
0210 </listitem>
0211 </varlistentry>
0212 
0213 <varlistentry>
0214 <term id="katepart-menu-print">
0215 <menuchoice>
0216 <shortcut>
0217 <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
0218 </shortcut>
0219 <guimenu>File</guimenu>
0220 <guimenuitem>Print...</guimenuitem>
0221 </menuchoice>
0222 </term>
0223 <listitem>
0224 <para>
0225 Opens a simple print dialog allowing the user to specify what, where,
0226 and how to print.
0227 </para>
0228 </listitem>
0229 </varlistentry>
0230 
0231 <varlistentry> <!-- from plugin Exporter -->
0232 <term id="katepart-menu-export-as-html">
0233 <menuchoice>
0234 <guimenu>File</guimenu>
0235 <guimenuitem>Export as &HTML;</guimenuitem>
0236 </menuchoice>
0237 </term>
0238 <listitem>
0239 <para>
0240 Export your file in &HTML; format so your document can be viewed as a web page.
0241 This item is only displayed when the plugin <guilabel>Exporter</guilabel> is loaded.
0242 </para>
0243 </listitem>
0244 </varlistentry>
0245 
0246 </variablelist>
0247 
0248 </sect3>
0249 
0250 <sect3 id="katepart-menu-edit"> <!-- This is also valid for kates menu edit-->
0251 <title>The Edit Menu</title>
0252 
0253 <variablelist>
0254 <varlistentry>
0255 <term id="katepart-menu-undo"><menuchoice>
0256 <shortcut><keycombo
0257 action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
0258 <guimenu>Edit</guimenu>
0259 <guimenuitem>Undo</guimenuitem></menuchoice></term>
0260 <listitem>
0261 <para>This is used to eliminate or reverse the most recent user action
0262 or operation.
0263 </para>
0264 </listitem>
0265 </varlistentry>
0266 
0267 <varlistentry>
0268 <term><anchor id="katepart-menu-redo"/><menuchoice>
0269 <shortcut><keycombo
0270 action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut>
0271 <guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice></term>
0272 <listitem>
0273 <para>This will reverse the most recent change (if any) made using Undo</para>
0274 </listitem>
0275 </varlistentry>
0276 
0277 <varlistentry>
0278 <term><anchor id="katepart-menu-cut"/><menuchoice>
0279 <shortcut><keycombo
0280 action="simul">&Ctrl;<keycap>X</keycap></keycombo></shortcut>
0281 <guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem></menuchoice></term>
0282 <listitem>
0283 <para>This command deletes the current selection and places it on the
0284 clipboard.
0285 The clipboard is a feature that works invisibly to provide a way to
0286 transfer data between applications.</para>
0287 </listitem>
0288 </varlistentry>
0289 
0290 <varlistentry>
0291 <term><anchor id="katepart-menu-copy"/><menuchoice>
0292 <shortcut><keycombo
0293 action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut>
0294 <guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice></term>
0295 <listitem>
0296 <para>This copies the currently selected text to the clipboard so that it may
0297 be pasted elsewhere. The clipboard is a feature that works invisibly
0298 to provide a way to transfer data between applications.</para>
0299 </listitem>
0300 </varlistentry>
0301 <varlistentry>
0302 <term><anchor id="katepart-menu-paste"/><menuchoice>
0303 <shortcut><keycombo
0304 action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut>
0305 <guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem></menuchoice></term>
0306 <listitem>
0307 <para>This will insert the contents of the clipboard at the cursor position.
0308 The clipboard is a feature that works invisibly to provide a way to
0309 transfer data between applications.</para>
0310 </listitem>
0311 </varlistentry>
0312 <varlistentry><!-- from plugin Exporter -->
0313 <term><anchor id="katepart-menu-copy-as-html"/><menuchoice>
0314 <guimenu>Edit</guimenu><guimenuitem>Copy as
0315 &HTML;</guimenuitem></menuchoice></term>
0316 <listitem>
0317 <para>This copies the currently selected text to the clipboard as &HTML;.
0318 This item is only displayed when the plugin <guilabel>Exporter</guilabel> is loaded.
0319 </para>
0320  </listitem>
0321 </varlistentry>
0322 
0323 <varlistentry>
0324 <term><anchor id="katepart-menu-select-all"/><menuchoice>
0325 <shortcut><keycombo
0326 action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut>
0327 <guimenu>Edit</guimenu><guimenuitem>Select All</guimenuitem></menuchoice></term>
0328 <listitem>
0329 <para>This will select the entire document. This could be very useful for
0330 copying the entire file to another application.</para>
0331 </listitem>
0332 </varlistentry>
0333 
0334 <varlistentry>
0335 <term><anchor id="katepart-menu-deselect"/><menuchoice>
0336 <shortcut>
0337 <keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo>
0338 </shortcut>
0339 <guimenu>Edit</guimenu><guimenuitem>Deselect</guimenuitem></menuchoice></term>
0340 <listitem>
0341 <para>Deselects the selected text in the editor if any.</para>
0342 </listitem>
0343 </varlistentry>
0344 <varlistentry>
0345 <term><anchor id="katepart-menu-block-selection-mode"/><menuchoice>
0346 <shortcut>
0347 <keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
0348 </shortcut>
0349 <guimenu>Edit</guimenu><guimenuitem>Block
0350 Selection Mode</guimenuitem></menuchoice></term>
0351 <listitem>
0352 <para>Toggles Selection Mode. When the Selection Mode is <guilabel>BLOCK</guilabel>,
0353 you can make vertical selections, &eg; select column 5 to 10 in lines 9 to 15.
0354 The status bar shows the current state of the Selection Mode, either <guilabel>BLOCK</guilabel> or
0355 <guilabel>LINE</guilabel>.</para>
0356 </listitem>
0357 </varlistentry>
0358 <varlistentry>
0359 <term><anchor id="katepart-menu-vi-input-mode"/><menuchoice>
0360 <shortcut>
0361 <keycombo action="simul">&Meta;&Ctrl;<keycap>V</keycap></keycombo>
0362 </shortcut>
0363 <guimenu>Edit</guimenu><guimenuitem>VI input
0364 Mode</guimenuitem></menuchoice></term>
0365 <listitem>
0366 <para>Switch to a vi-like, modal editing mode. This mode supports the most used commands
0367 and motions from vim's normal and visual mode and has an optional vi mode statusbar.
0368 This status bar shows commands while they are being entered, output from commands and
0369 the current mode.The behavior of this mode can be configured in the
0370 <link linkend="katepart-pref-edit-vi-input-mode">Vi Input Mode</link> section of the
0371 <guilabel>Editing</guilabel> page in &kappname;'s settings dialog.</para>
0372 </listitem>
0373 </varlistentry>
0374 <varlistentry>
0375 <term><anchor id="katepart-menu-overwrite-mode"/><menuchoice>
0376 <shortcut>
0377 <keycombo action="simul">&Ins;</keycombo>
0378 </shortcut>
0379 <guimenu>Edit</guimenu><guimenuitem>Overwrite
0380 Mode</guimenuitem></menuchoice></term>
0381 <listitem>
0382 <para>Toggles the Insert/Overwrite modes. When the mode is <guilabel>INS</guilabel>, you
0383 insert characters where the cursor is. When the mode is <guilabel>OVR</guilabel>, writing
0384 characters will replace the current characters if your cursor is positioned
0385 before any character. The status bar shows the current state of the Overwrite
0386 Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para>
0387 </listitem>
0388 </varlistentry>
0389 
0390 <varlistentry>
0391 <term><anchor id="katepart-menu-find"/><menuchoice>
0392 <shortcut><keycombo
0393 action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut>
0394 <guimenu>Edit</guimenu><guimenuitem>Find...</guimenuitem></menuchoice></term>
0395 <listitem>
0396 <para>This opens the incremental search bar at the bottom of the editor window.
0397 On the left side of the bar is a button with an icon to close the bar, followed by a small text
0398 box for entering the search pattern.</para>
0399 <para>When you start entering characters of your search pattern, the search starts
0400 immediately. If there is a match in the text this is highlighted and the background color
0401 of the entry field changes to light green. If the search pattern does not match any
0402 string in the text, this is indicated by a light red background color of the entry field
0403 and <guilabel>Not found</guilabel> is displayed at the right side of the bar.</para>
0404 <para>Use the <guilabel>Next</guilabel> or <guilabel>Previous</guilabel> button
0405 to jump to the next or previous match in the document.</para>
0406 <para>You can choose whether the search should be case sensitive.
0407 Selecting <guilabel>Match Case</guilabel> will limit finds to entries that match the
0408 case (upper or lower) of each of the characters in the search  pattern.
0409 </para>
0410 <para>Click on the button with a green arrow icon at the right side of the incremental search bar to
0411 switch to the power search and replace bar.
0412 <!--changed in 4.5 ???
0413 options "Highlight all" + "From cursor" removed only "Match case" left-->
0414 </para>
0415 </listitem>
0416 </varlistentry>
0417 
0418 <varlistentry>
0419 <term><anchor id="katepart-menu-find-again"/><menuchoice>
0420 <shortcut><keycombo action="simul"><keycap>F3</keycap></keycombo></shortcut>
0421 <guimenu>Edit</guimenu><guimenuitem>Find Next</guimenuitem></menuchoice></term>
0422  <listitem>
0423 <para>This repeats the last find operation, if any, without calling the incremental
0424 search bar.
0425 </para>
0426 </listitem>
0427 </varlistentry>
0428 
0429 <varlistentry>
0430 <term id="katepart-menu-find-previous">
0431 <menuchoice>
0432 <shortcut>
0433 <keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
0434 </shortcut>
0435 <guimenu>Edit</guimenu>
0436 <guimenuitem>Find Previous</guimenuitem>
0437 </menuchoice>
0438 </term>
0439 <listitem>
0440 <para>
0441 This repeats the last find operation, if any, without calling the incremental
0442 search bar, and searching backwards instead of forwards through the
0443 document.
0444 </para>
0445 </listitem>
0446 </varlistentry>
0447 
0448 <varlistentry>
0449 <term><anchor id="katepart-menu-replace"/><menuchoice>
0450 <shortcut><keycombo
0451 action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut>
0452 <guimenu>Edit</guimenu><guimenuitem>Replace...</guimenuitem></menuchoice></term>
0453 <listitem>
0454 <para>This command opens the power search and replace bar.
0455 On the upper left side of the bar is a button with an icon to close the bar, followed by a small text
0456 box for entering the search pattern.</para>
0457 <para>You can control the search mode by selecting <guilabel>Plain text</guilabel>,
0458 <guilabel>Whole words</guilabel>, <guilabel>Escape sequences</guilabel> or
0459 <guilabel>Regular expression</guilabel> from the drop down box.
0460 </para>
0461 <para>If <guilabel>Escape sequences</guilabel> or <guilabel>Regular expression</guilabel> are
0462 selected, the <guibutton>Add...</guibutton> menuitem at the bottom of the context menu of the text boxes will be enabled
0463 and allows you to add escape sequences or regular expression items to the
0464 search or replace pattern from predefined lists.</para>
0465 <para>Use the <guilabel>Next</guilabel> or <guilabel>Previous</guilabel> button to jump
0466 to the next or previous match in the document.</para>
0467 <para>Enter the text to replace with in the text box labeled <guilabel>Replace</guilabel>
0468 and click the <guibutton>Replace</guibutton> button to replace only the highlighted text or
0469 the <guibutton>Replace All</guibutton> button to replace the search text in the whole document.
0470 </para>
0471 <para>You can modify the search and replace behavior by selecting different
0472 options at the bottom of the bar.
0473 Selecting <guilabel>Match Case</guilabel> will limit finds to entries that match the
0474 case (upper or lower) of each of the characters in the search  pattern.
0475 <guilabel>Selection Only</guilabel> will search and replace within the current selection only.
0476 The <guilabel>Find All</guilabel> button highlights all matches in the document and shows the
0477 number of found matches in a small popup.
0478 </para>
0479 <para>Click on the button with a green arrow icon at the right side of the power search and replace bar to
0480 switch to the incremental search bar.
0481 <!--changed in 4.5 ???
0482 options "Highlight all" + "From cursor" removed only "Match case" left
0483 -->
0484 </para>
0485 </listitem>
0486 </varlistentry>
0487 
0488 <varlistentry>
0489 <term id="katepart-menu-find-selected">
0490 <menuchoice>
0491 <shortcut><keycombo
0492 action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
0493 <guimenu>Edit</guimenu><guimenuitem>Find Selected</guimenuitem></menuchoice></term>
0494 <listitem>
0495 <para>Finds next occurrence of selected text.</para>
0496 </listitem>
0497 </varlistentry>
0498 
0499 <varlistentry>
0500 <term id="katepart-menu-find-selected-backwards">
0501 <menuchoice>
0502 <shortcut><keycombo
0503 action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></shortcut>
0504 <guimenu>Edit</guimenu><guimenuitem>Find Selected Backwards</guimenuitem></menuchoice></term>
0505 <listitem>
0506 <para>Finds previous occurrence of selected text.</para>
0507 </listitem>
0508 </varlistentry>
0509 
0510 <varlistentry>
0511 <term id="katepart-menu-go-to-line">
0512 <menuchoice>
0513 <shortcut>
0514 <keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo>
0515 </shortcut>
0516 <guimenu>Edit</guimenu>
0517 <guimenuitem>Go to Line...</guimenuitem></menuchoice></term>
0518 <listitem>
0519 <para>
0520 This opens the goto line bar at the bottom of the window which is used to have the cursor
0521 jump to a particular line (specified by number) in the document.  The
0522 line number may be entered directly into the text box or graphically by
0523 clicking on the up or down arrow spin controls at the side of the text
0524 box. The little up arrow will increase the line number and the down
0525 arrow decrease it. Close the bar with a click on the button with an icon on the left side of the bar.
0526 </para>
0527 </listitem>
0528 </varlistentry>
0529 </variablelist>
0530 
0531 </sect3>
0532 <sect3 id="katepart-menu-view">
0533 <!-- This is also valid for kates menu view, but kate does not have the New Window item -->
0534 <title>The View Menu</title>
0535 
0536 <para>The <guimenu>View</guimenu> menu allows you to manage settings
0537 specific to the active editor, and to manage frames.</para>
0538 
0539 <variablelist>
0540 
0541 <varlistentry>
0542 <term>
0543 <anchor id="katepart-menu-view-new-window"/>
0544 <menuchoice>
0545 <guimenu>View</guimenu>
0546 <guimenuitem>New Window</guimenuitem>
0547 </menuchoice>
0548 </term>
0549 <listitem>
0550 <para>Create another window containing the current document. All changes to the
0551 document in one window are reflected in the other window and vice versa.</para>
0552 </listitem>
0553 </varlistentry>
0554 
0555 <varlistentry>
0556 <term>
0557 <anchor id="katepart-menu-view-command-line"/>
0558 <menuchoice>
0559 <shortcut><keycombo
0560 action="simul"><keycap>F7</keycap></keycombo></shortcut>
0561 <guimenu>View</guimenu>
0562 <guimenuitem>Switch to Command Line</guimenuitem>
0563 </menuchoice>
0564 </term>
0565 <listitem>
0566 <para>Displays the Katepart command line at the bottom of the window.
0567 In the command line, type <userinput>help</userinput> to get help and <userinput>help list</userinput>
0568 to get a list of commands.</para>
0569 </listitem>
0570 </varlistentry>
0571 
0572 <varlistentry>
0573 <term><menuchoice>
0574 <guimenu>View</guimenu><guimenuitem>Show the Javascript Console</guimenuitem>
0575 </menuchoice></term>
0576 <listitem><para>This opens a tool view that allows you to run Javascript code
0577 interactively. For more information, see
0578 <ulink url="help:/katepart/advanced-editing-tools-scripting.html">Extending &kate; with Scripts</ulink>
0579 </para></listitem>
0580 </varlistentry>
0581 
0582 <varlistentry>
0583 <term>
0584 <anchor id="katepart-menu-view-schema"/>
0585 <menuchoice>
0586 <guimenu>View</guimenu>
0587 <guisubmenu>Schema</guisubmenu>
0588 </menuchoice>
0589 </term>
0590 <listitem>
0591 <para>Select a font schema.</para>
0592 </listitem>
0593 </varlistentry>
0594 
0595 <varlistentry>
0596 <term>
0597 <anchor id="katepart-menu-view-dynamic-word-wrap"/>
0598 <menuchoice>
0599 <shortcut><keycombo action="simul"><keycap>F10</keycap></keycombo></shortcut>
0600 <guimenu>View</guimenu>
0601 <guimenuitem>Dynamic Word Wrap</guimenuitem>
0602 </menuchoice>
0603 </term>
0604 <listitem>
0605 <para>The text lines will be wrapped at the view
0606 border on the screen.</para>
0607 </listitem>
0608 </varlistentry>
0609 
0610 <varlistentry>
0611 <term>
0612 <anchor id="katepart-menu-view-dynamic-word-wrap-indicators"/>
0613 <menuchoice>
0614 <guimenu>View</guimenu>
0615 <guisubmenu>Dynamic Word Wrap Indicators</guisubmenu>
0616 </menuchoice>
0617 </term>
0618 <listitem>
0619  <para>Choose when and how the dynamic word wrap indicators should be
0620 displayed. This is only available if the <guilabel>Dynamic Word
0621 Wrap</guilabel> option is checked.</para>
0622 </listitem>
0623 </varlistentry>
0624 
0625 <varlistentry>
0626 <term>
0627 <anchor id="katepart-menu-view-show-static-word-wrap"/>
0628 <menuchoice>
0629 <guimenu>View</guimenu>
0630 <guimenuitem>Show Static Word Wrap Marker</guimenuitem>
0631 </menuchoice>
0632 </term>
0633 <listitem>
0634 <para>If this option is checked, a vertical line will be drawn at the
0635 word wrap column as defined in the <menuchoice>
0636 <guimenu>Settings</guimenu>
0637 <guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the
0638 Editing tab. Please note that the word wrap marker is only drawn if you
0639 use a fixed pitch font.</para>
0640 </listitem>
0641 </varlistentry>
0642 
0643 <varlistentry>
0644 <term>
0645 <anchor id="katepart-menu-view-show-icon-border"/>
0646 <menuchoice>
0647 <shortcut><keycombo action="simul"><keycap>F6</keycap></keycombo></shortcut>
0648 <guimenu>View</guimenu>
0649 <guimenuitem>Show Icon Border</guimenuitem>
0650 </menuchoice>
0651 </term>
0652 <listitem>
0653 <para>This is a toggle item. Setting it on checked will make the Icon Border
0654 visible in the left side of the active editor, and vice versa. The Icon Border
0655 indicates the positions of the marked lines in the editor.</para>
0656 </listitem>
0657 </varlistentry>
0658 
0659 <varlistentry>
0660 <term>
0661 <anchor id="katepart-menu-view-show-line-numbers"/>
0662 <menuchoice>
0663 <shortcut><keycombo action="simul"><keycap>F11</keycap></keycombo></shortcut>
0664 <guimenu>View</guimenu>
0665 <guimenuitem>Show Line Numbers</guimenuitem>
0666 </menuchoice>
0667 </term>
0668 <listitem>
0669 <para>This is a toggle Item. Setting it on checked will make a pane displaying
0670 the line numbers of the document visible in the left border of the active
0671 editor, and vice versa.</para>
0672 </listitem>
0673 </varlistentry>
0674 
0675 <varlistentry>
0676 <term>
0677 <anchor id="katepart-menu-view-scrollbar-marks"/>
0678 <menuchoice>
0679 <guimenu>View</guimenu>
0680 <guisubmenu>Show Scrollbar Marks</guisubmenu>
0681 </menuchoice>
0682 </term>
0683 <listitem>
0684 <para>If this option is checked, the view will show marks on the vertical
0685 scrollbar. The marks are equivalent to the marks on the <link
0686 linkend="katepart-menu-view-show-icon-border">Icon Border</link>.</para>
0687 </listitem>
0688 </varlistentry>
0689 
0690 <varlistentry>
0691 <term>
0692 <anchor id="katepart-menu-view-hide-folding-markers"/>
0693 <menuchoice>
0694 <shortcut><keycombo action="simul"><keycap>F9</keycap></keycombo></shortcut>
0695 <guimenu>View</guimenu> <guimenuitem>Show Folding Markers</guimenuitem>
0696 </menuchoice>
0697 </term>
0698 <listitem>
0699 <para>If this option is checked, the marks for code folding will be
0700 shown.</para>
0701 </listitem>
0702 </varlistentry>
0703 
0704 <varlistentry>
0705 <term>
0706 <anchor id="katepart-menu-view-code-folding"/>
0707 <menuchoice>
0708 <guimenu>View</guimenu> <guisubmenu>Code Folding</guisubmenu>
0709 </menuchoice>
0710 </term>
0711 <listitem>
0712 <para>These options pertain to
0713 <ulink url="help:/katepart/advanced-editing-tools-code-folding.html">code
0714 folding</ulink>:</para>
0715 <variablelist>
0716 
0717 <varlistentry id="view-show-folding-markers">
0718 <term><menuchoice>
0719 <shortcut>
0720 <keycombo action="simul"><keycap>F9</keycap></keycombo>
0721 </shortcut>
0722 <guimenuitem>Show Folding Markers</guimenuitem>
0723 </menuchoice></term>
0724 <listitem><para>Toggles the display of the folding marker pane in the left
0725 side of the view.</para></listitem>
0726 </varlistentry>
0727 
0728 <varlistentry id="view-fold-current-node">
0729 <term><menuchoice>
0730 <guimenuitem>Fold Current Node</guimenuitem>
0731 </menuchoice></term>
0732 <listitem><para>Collapse the region that contains the cursor.</para></listitem>
0733 </varlistentry>
0734 
0735 <varlistentry id="view-unfold-current-node">
0736 <term><menuchoice>
0737 <guimenuitem>Unfold Current Node</guimenuitem>
0738 </menuchoice></term>
0739 <listitem><para>Expand the region that contains the cursor.</para></listitem>
0740 </varlistentry>
0741 
0742 <varlistentry id="view-fold-toplevel-nodes">
0743 <term><menuchoice>
0744 <shortcut>
0745 <keycombo action="simul">&Ctrl;&Shift;<keycap>-</keycap></keycombo>
0746 </shortcut>
0747 <guimenuitem>Fold Toplevel Nodes</guimenuitem>
0748 </menuchoice></term>
0749 <listitem><para>Collapse all toplevel regions in the document.
0750 Click on the right pointing triangle to expand all toplevel regions.</para></listitem>
0751 </varlistentry>
0752 </variablelist>
0753 </listitem>
0754 </varlistentry>
0755 
0756 <varlistentry>
0757 <term><menuchoice><guimenuitem>Enlarge Font</guimenuitem></menuchoice>
0758 </term>
0759 <listitem><para>This increases the display font size.</para></listitem>
0760 </varlistentry>
0761 
0762 <varlistentry>
0763 <term><menuchoice><guimenuitem>Shrink Font</guimenuitem></menuchoice>
0764 </term>
0765 <listitem><para>This decreases the display font size.</para></listitem>
0766 </varlistentry>
0767 </variablelist>
0768 
0769 </sect3>
0770 <sect3 id="katepart-menu-go"><!-- This is also valid for kates menu bookmarks-->
0771 <title>The Bookmarks Menu</title>
0772 <variablelist>
0773 
0774 <varlistentry>
0775 <term id="katepart-menu-set-bookmark">
0776 <menuchoice>
0777 <shortcut>
0778 <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
0779 </shortcut>
0780 <guimenu>Bookmarks</guimenu>
0781 <guimenuitem>Set Bookmark</guimenuitem>
0782 </menuchoice>
0783 </term>
0784 <listitem>
0785 <para>
0786 Sets or removes a bookmark in the current line of the active document. (If it is
0787 there, it is removed, otherwise one is set).
0788 </para>
0789 </listitem>
0790 </varlistentry>
0791 
0792 <varlistentry>
0793 <term id="katepart-menu-clear-bookmarks">
0794 <menuchoice>
0795 <guimenu>Bookmarks</guimenu>
0796 <guimenuitem>Clear All Bookmarks</guimenuitem>
0797 </menuchoice>
0798 </term>
0799 <listitem>
0800 <para>
0801 This command will remove all the markers from the document as well as
0802 the list of markers which is appended at the bottom of this menu item.
0803 </para>
0804 </listitem>
0805 </varlistentry>
0806 
0807 <varlistentry id="katepart-menu-bookmarks-previous">
0808 <term><menuchoice><shortcut><keycombo action="simul">&Alt;
0809 &PgUp;</keycombo></shortcut>
0810 <guimenu>Bookmarks</guimenu><guimenuitem>Previous</guimenuitem></menuchoice>
0811 </term>
0812 <listitem><para>This will move the cursor to beginning of the first above line
0813 with a bookmark. The menuitem text will include the line number and the first
0814 piece of text on the line. This item is only available when there is a bookmark
0815 in a line above the cursor.</para></listitem>
0816 </varlistentry>
0817 
0818 <varlistentry id="katepart-menu-bookmarks-next">
0819 <term><menuchoice><shortcut><keycombo action="simul">&Alt;
0820 <keycap>PgDown</keycap></keycombo></shortcut>
0821 <guimenu>Bookmarks</guimenu><guimenuitem>Next</guimenuitem></menuchoice></term>
0822 <listitem><para>This will move the cursor to beginning of the next line with a
0823 bookmark. The menuitem text will include the line number and the first piece of
0824 text on the line. This item is only available when there is a bookmark in a line
0825 below the cursor.</para></listitem>
0826 </varlistentry>
0827 
0828 </variablelist>
0829 
0830 <para>
0831 At the bottom of this menu, a list of bookmarks appears if any bookmarks are
0832 available for this window.
0833 </para>
0834 
0835 </sect3>
0836 
0837 <!-- This is also valid for kates menu tools, kate has additional items:
0838 Pipe to Terminal, Syncronizise Terminal with Current Document, Focus Terminal at top-->
0839 <sect3 id="katepart-menu-tools">
0840 <title>The Tools Menu</title>
0841 
0842 <variablelist>
0843 <varlistentry>
0844 <term><anchor id="katepart-menu-tools-read-only"/><menuchoice>
0845 <guimenu>Tools</guimenu>
0846 <guimenuitem>Read Only Mode</guimenuitem></menuchoice></term>
0847  <listitem>
0848 <para>Set the current document to Read Only mode. This prevents any text
0849 addition and any changes in the document formatting.</para>
0850  </listitem>
0851 </varlistentry>
0852 
0853 <varlistentry><!-- only in power mode-->
0854 <term><anchor id="katepart-menu-tools-filetype"/><menuchoice>
0855 <guimenu>Tools</guimenu>
0856 <guisubmenu>Mode</guisubmenu></menuchoice> </term>
0857  <listitem>
0858 <para>Choose the filetype scheme you prefer for the active document. This
0859 overwrites the global filetype mode set in <menuchoice>
0860 <guimenu>Settings</guimenu>
0861 <guimenuitem>Configure
0862 Editor...</guimenuitem></menuchoice> in the Filetypes tab for your current
0863 document only.</para>
0864  </listitem>
0865 </varlistentry>
0866 
0867 <varlistentry><!-- only in power mode-->
0868 <term><anchor id="katepart-menu-tools-highlighting"/><menuchoice>
0869 <guimenu>Tools</guimenu>
0870 <guisubmenu>Highlighting</guisubmenu></menuchoice> </term>
0871  <listitem>
0872 <para>Choose the Highlighting scheme you prefer for the active document. This
0873 overwrites the global highlighting mode set in <menuchoice>
0874 <guimenu>Settings</guimenu>
0875 <guimenuitem>Configure
0876 Editor...</guimenuitem></menuchoice> for your current document only.</para>
0877  </listitem>
0878 </varlistentry>
0879 
0880 <varlistentry><!-- only in power mode-->
0881 <term><anchor id="katepart-menu-tools-indentation"/><menuchoice>
0882 <guimenu>Tools</guimenu>
0883 <guisubmenu>Indentation</guisubmenu></menuchoice> </term>
0884  <listitem>
0885 <para>Choose the style of indentation you want for your active document.
0886 This overwrites the global indentation mode set in <menuchoice>
0887 <guimenu>Settings</guimenu>
0888 <guimenuitem>Configure
0889 Editor...</guimenuitem></menuchoice> for your current document only.</para>
0890  </listitem>
0891 </varlistentry>
0892 
0893 <varlistentry>
0894 <term><anchor id="katepart-menu-tools-encoding"/><menuchoice>
0895 <guimenu>Tools</guimenu>
0896 <guisubmenu>Encoding</guisubmenu></menuchoice></term>
0897  <listitem>
0898 <para>You can overwrite the default encoding set in <menuchoice>
0899 <guimenu>Settings</guimenu>
0900 <guimenuitem>Configure
0901 Editor...</guimenuitem></menuchoice> in the <guilabel>Open/Save</guilabel> page
0902 to set a different encoding for your current document. The encoding you
0903 set here will be only valid for your current document.</para>
0904  </listitem>
0905 </varlistentry>
0906 
0907 <varlistentry><!-- only in power mode-->
0908 <term><anchor id="katepart-menu-tools-end-of-line"/><menuchoice>
0909 <guimenu>Tools</guimenu>
0910 <guisubmenu>End of Line</guisubmenu></menuchoice> </term>
0911  <listitem>
0912 <para>Choose your preferred end of line mode for your active
0913 document. This overwrites the global end of line mode set in <menuchoice>
0914 <guimenu>Settings</guimenu>
0915 <guimenuitem>Configure
0916 Editor...</guimenuitem></menuchoice> for your current document only.</para>
0917  </listitem>
0918 </varlistentry>
0919 
0920 <varlistentry>
0921 <term><anchor id="katepart-menu-tools-add-byte-mark-order"/><menuchoice>
0922 <guimenu>Tools</guimenu>
0923 <guisubmenu>Add Byte Mark Order (BOM)</guisubmenu></menuchoice></term>
0924  <listitem>
0925 <para>Checking this action you can explicitly add a byte order mark for unicode
0926 encoded documents. The byte order mark (BOM) is a Unicode character used to signal
0927 the endianness (byte order) of a text file or stream, for more information see
0928 <ulink url="https://en.wikipedia.org/wiki/Byte_Order_Mark">Byte Order Mark</ulink>.</para>
0929 </listitem>
0930 </varlistentry>
0931 
0932 <varlistentry>
0933 <term><menuchoice>
0934 <shortcut>
0935 <keycombo action="simul">&Ctrl;&Space;</keycombo>
0936 </shortcut>
0937 <guimenu>Tools</guimenu>
0938 <guimenuitem>Invoke Code Completion</guimenuitem>
0939 </menuchoice> </term>
0940 <listitem>
0941 <para>Manually invoke command completion, usually by using a shortcut bound to this action.</para>
0942 </listitem>
0943 </varlistentry>
0944 
0945 <varlistentry>
0946 <term><menuchoice>
0947 <guimenu>Tools</guimenu>
0948 <guimenuitem>Word Completion</guimenuitem>
0949 </menuchoice> </term>
0950 <listitem>
0951 <para><guimenuitem>Reuse Word Below</guimenuitem> (<keycombo action="simul">&Ctrl;
0952 <keycap>9</keycap></keycombo>) and <guimenuitem>Reuse Word Above</guimenuitem>
0953 (<keycombo action="simul">&Ctrl; <keycap>8</keycap></keycombo>) complete the
0954 currently typed text by searching for similar
0955 words backward or forward from the current cursor position. <guimenuitem>Shell
0956 Completion</guimenuitem> pops up a completion box with matching entries.</para>
0957 </listitem>
0958 </varlistentry>
0959 
0960 <varlistentry>
0961 <term><menuchoice>
0962 <shortcut>
0963 <keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
0964 </shortcut>
0965 <guimenu>Tools</guimenu>
0966 <guimenuitem>Automatic Spell Checking</guimenuitem>
0967 </menuchoice></term>
0968 <listitem>
0969 <para>When <guimenuitem>Automatic Spell Checking</guimenuitem> is enabled, wrong text
0970 is underlined in the document on-the-fly.</para>
0971 </listitem>
0972 </varlistentry>
0973 
0974 <varlistentry>
0975 <term><anchor id="katepart-menu-Spelling..."/><menuchoice>
0976 <guimenu>Tools</guimenu><guimenuitem>Spelling...</guimenuitem></menuchoice>
0977 </term>
0978 
0979 <!--para>These options are described in the documentation for the
0980 <ulink url="help:/sonnet/index.html">Check Spelling Dialog</ulink>.</para
0981 Move / merge the following into kdelibs/doc/sonnet/index.docbook and replace it with the para above
0982 -->
0983 
0984 <listitem><para><action>This initiates the spellchecking program - a program
0985 designed to help the user catch and correct any spelling errors.</action>
0986 Clicking on this entry will start the checker and bring up the speller dialog
0987 box through which the user can control the process.  There are four settings
0988 lined up vertically in the center of the dialog with their corresponding labels
0989 just to the left.  Starting at the top they are:</para>
0990 
0991 <variablelist>
0992 <varlistentry>
0993 <term><guilabel>Unknown word:</guilabel></term>
0994 <listitem><para>Here, the spellchecker indicates the word currently under
0995 consideration.  This happens when the checker encounters a word not in its
0996 dictionary - a file containing a list of correctly spelled words against which
0997 it compares each word in the editor.</para></listitem>
0998 </varlistentry>
0999 <varlistentry>
1000 <term><guilabel>Replace with:</guilabel></term>
1001 <listitem><para> If the checker has any similar words in its dictionary the
1002 first one will be listed here.  The user can accept the suggestion, type in his
1003 or her own correction, or choose a different suggestion from the next
1004 box.</para></listitem>
1005 </varlistentry>
1006 <varlistentry>
1007 <term><guilabel>Language:</guilabel></term>
1008 <listitem><para> If you have installed multiple dictionaries, here you can
1009 select which dictionary/language should be used.</para></listitem>
1010 </varlistentry>
1011 </variablelist>
1012 
1013 <para>On the right side of the dialog box are 6 buttons that allow the user to
1014 control the spellcheck process.  They are:</para>
1015 
1016 <variablelist>
1017 <varlistentry>
1018 <term><guibutton>Add to Dictionary</guibutton></term>
1019 <listitem><para>Pressing this button adds the <guilabel>Unknown word
1020 </guilabel> to the checker's dictionary. This means that in the future
1021 the checker will always consider this word to be correctly
1022 spelled.</para></listitem>
1023 </varlistentry>
1024 <varlistentry>
1025 <term><guilabel>Suggest</guilabel></term>
1026 <listitem><para> The checker may list here a number of possible replacements for
1027 the word under consideration.  Clicking on any one of the suggestions will cause
1028 that word to be entered in the <guilabel>Replace with</guilabel> box,
1029 above.</para></listitem>
1030 </varlistentry>
1031 <varlistentry>
1032 <term><guibutton>Replace</guibutton></term>
1033 <listitem><para> This button has the checker replace the word under
1034 consideration in the document with the word in the
1035 <guilabel>Replace with</guilabel> box.</para></listitem>
1036 </varlistentry>
1037 <varlistentry>
1038 <term><guibutton>Replace All</guibutton></term>
1039 <listitem><para> This button causes the checker to replace not only the current
1040 <guilabel>Unknown word:</guilabel> but to automatically make the same
1041 substitution for any other occurrences of this <guilabel>Unknown word</guilabel>
1042 in the document.</para></listitem>
1043 </varlistentry>
1044 <varlistentry>
1045 <term><guibutton>Ignore</guibutton></term>
1046 <listitem><para>Activating this button will have the checker move on without
1047 making any changes.</para></listitem>
1048 </varlistentry>
1049 <varlistentry>
1050 <term><guibutton>Ignore All</guibutton></term>
1051 <listitem><para> This button tells the checker to do nothing with the current
1052 <guilabel>Unknown word:</guilabel> and to pass over any other instances of
1053 the same word.</para> <note><para>This only applies to the current spellcheck
1054 run.  If the checker is run again later it will stop on this same
1055 word.</para></note></listitem>
1056 </varlistentry>
1057 </variablelist>
1058 
1059 <para>Three more buttons are located horizontally along the bottom of the
1060 spellcheck dialog.  They are:</para>
1061 
1062 <variablelist>
1063 <varlistentry>
1064 <term><guibutton>Help</guibutton></term>
1065 <listitem><para> This invokes the &kde; help system with the help page
1066 for this dialog.</para></listitem>
1067 </varlistentry>
1068 
1069 <varlistentry>
1070 <term><guibutton>Finished</guibutton></term>
1071 <listitem><para> This button ends the spellcheck process, and returns to the
1072 document.</para></listitem>
1073 </varlistentry>
1074 
1075 <varlistentry>
1076 <term><guibutton>Cancel</guibutton></term>
1077 <listitem><para> This button cancels the spellcheck process, all modifications
1078 are reverted, and you will return to your document.</para></listitem>
1079 </varlistentry>
1080 </variablelist>
1081 </listitem>
1082 </varlistentry>
1083 </variablelist>
1084 
1085 <variablelist>
1086 <varlistentry>
1087 <term><anchor id="katepart-menu-tools-spelling-from-cursor"/><menuchoice>
1088 <guimenu>Tools</guimenu>
1089 <guimenuitem>Spelling (from cursor)...</guimenuitem></menuchoice></term>
1090  <listitem>
1091 <para>This initiates the spellchecking program but it starts where your cursor
1092 is instead of at the beginning of the document.</para>
1093  </listitem>
1094 </varlistentry>
1095 
1096 <varlistentry>
1097 <term><anchor id="katepart-menu-tools-spellcheck-selection"/><menuchoice>
1098 <guimenu>Tools</guimenu>
1099 <guimenuitem>Spellcheck Selection...</guimenuitem></menuchoice></term>
1100  <listitem>
1101 <para>Spellchecks the current selection.</para>
1102  </listitem>
1103 </varlistentry>
1104 
1105 <varlistentry>
1106 <term><anchor id="katepart-menu-tools-change-dictionary"/><menuchoice>
1107 <guimenu>Tools</guimenu>
1108 <guimenuitem>Change Dictionary</guimenuitem></menuchoice></term>
1109  <listitem>
1110 <para>Displays a drop down box with all available dictionaries for spellchecking
1111 at the bottom of the editor window. This allows easy switching of the spellcheck
1112 dictionary &eg; for automatic spellcheck of text in different languages.</para>
1113  </listitem>
1114 </varlistentry>
1115 
1116 <varlistentry>
1117 <term><anchor id="katepart-menu-cleanindent"/><menuchoice>
1118 <guimenu>Tools</guimenu><guimenuitem>Clean
1119 Indentation</guimenuitem></menuchoice></term>  <listitem>
1120 <para>This cleans the indentation for the current selection or for the
1121 line the cursor is currently in. Cleaning the indentation ensures that
1122 all your selected text follows the indentation mode you choose.</para>
1123 </listitem>
1124 </varlistentry>
1125 
1126 <varlistentry>
1127 <term><anchor id="katepart-menu-tools-align"/><menuchoice>
1128 <guimenu>Tools</guimenu>
1129 <guimenuitem>Align</guimenuitem>
1130 </menuchoice></term>
1131 <listitem>
1132 <para>Causes a realign of the current line or selected lines using the
1133 indentation mode and indentation settings in the document.</para>
1134 </listitem>
1135 </varlistentry>
1136 
1137 <varlistentry><!-- only in power mode-->
1138 <term><menuchoice>
1139 <shortcut>
1140 <keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo>
1141 </shortcut>
1142 <guimenu>Tools</guimenu>
1143 <guimenuitem>Comment</guimenuitem>
1144 </menuchoice> </term>
1145 <listitem><para>This adds one space to the beginning of the line
1146 where the text cursor is located or to the beginning of any
1147 selected lines.</para>
1148 </listitem>
1149 </varlistentry>
1150 
1151 <varlistentry><!-- only in power mode-->
1152 <term><menuchoice>
1153 <shortcut>
1154 <keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo>
1155 </shortcut>
1156 <guimenu>Tools</guimenu>
1157 <guimenuitem>Uncomment</guimenuitem>
1158 </menuchoice> </term>
1159 <listitem><para>This removes one space (if any exist) from the beginning of the
1160 line where the text cursor is located or from the beginning of any
1161 selected lines.</para></listitem>
1162 </varlistentry>
1163 
1164 <varlistentry>
1165 <term><menuchoice>
1166 <shortcut>
1167 <keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo>
1168 </shortcut>
1169 <guimenu>Tools</guimenu>
1170 <guimenuitem>Uppercase</guimenuitem>
1171 </menuchoice></term>
1172 <listitem><para>Put the selected text or the letter after the cursor in
1173 uppercase.</para></listitem>
1174 </varlistentry>
1175 
1176 <varlistentry>
1177 <term><menuchoice>
1178 <shortcut>
1179 <keycombo action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo>
1180 </shortcut>
1181 <guimenu>Tools</guimenu>
1182 <guimenuitem>Lowercase</guimenuitem>
1183 </menuchoice></term>
1184 <listitem><para>Put the selected text or the letter after the cursor in
1185 lowercase.</para></listitem>
1186 </varlistentry>
1187 
1188 <varlistentry>
1189 <term><menuchoice>
1190 <shortcut>
1191 <keycombo action="simul">&Ctrl;&Alt;<keycap>U</keycap></keycombo>
1192 </shortcut>
1193 <guimenu>Tools</guimenu>
1194 <guimenuitem>Capitalize</guimenuitem>
1195 </menuchoice></term>
1196 <listitem><para>Capitalize the selected text or the current
1197 word.</para></listitem>
1198 </varlistentry>
1199 
1200 <varlistentry>
1201 <term><menuchoice>
1202 <shortcut>
1203 <keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo>
1204 </shortcut>
1205 <guimenu>Tools</guimenu>
1206 <guimenuitem>Join Lines</guimenuitem>
1207 </menuchoice></term>
1208 <listitem><para>Joins the selected lines, or the current line and the line below
1209 with one white space character as a separator. Leading/trailing white space on
1210 joined lines is removed in the affected ends.</para></listitem>
1211 </varlistentry>
1212 
1213 <varlistentry>
1214 <term><menuchoice>
1215 <guimenu>Tools</guimenu>
1216 <guimenuitem>Apply Word Wrap</guimenuitem>
1217 </menuchoice></term>
1218 <listitem><para>Apply static word wrapping on all the document. That means that
1219 a new line of text will automatically start when the current
1220 line exceeds the length specified by the <guilabel>Wrap words at</guilabel> option
1221 in the Editing tab in <menuchoice>
1222 <guimenu>Settings</guimenu><guimenuitem>Configure
1223 Editor...</guimenuitem></menuchoice></para></listitem>
1224 </varlistentry>
1225 
1226 </variablelist>
1227 <para>If the <link linkend="katepart-pref-plugins">plugin</link> Insert File is enabled, you will
1228 find here an additional menu item <guimenuitem>Insert File...</guimenuitem>.
1229 </para>
1230 <!-- Data Tools and Insane HTML (LE) Expansion Ctrl+. when plugins are enabled-->
1231 </sect3>
1232 
1233 <sect3 id="katepart-menu-settings">
1234 <!-- This is also valid for kates menu settings,
1235 only the items Show Toolbar and Show Statusbar are swapped and Configure kate is the last item-->
1236 <title>The Settings Menu</title>
1237 
1238 <variablelist>
1239 
1240 <varlistentry>
1241 <term><anchor id="katepart-menu-preferences"/><menuchoice>
1242 <guimenu>Settings</guimenu>
1243 <guimenuitem>Configure Editor...</guimenuitem> <!-- in kate Configure &kate; ... -->
1244 </menuchoice>
1245 </term>
1246 <listitem>
1247 <para>
1248 This menu item opens a dialog whereby several different <link
1249 linkend="kredit_config">settings</link> may be adjusted.
1250 </para>
1251 </listitem>
1252 </varlistentry>
1253 
1254 </variablelist>
1255 </sect3>
1256 
1257 <!--/end kwrite-->
1258 
1259   <!-- KRVIEWER menu -->
1260 <sect3 id="kredit_krviewer_menu">
1261 <title>The KrViewer Menu</title>
1262     <variablelist>
1263       <varlistentry>
1264         <term>
1265           <menuchoice>
1266             <shortcut>
1267               <keycombo action="simul">
1268               &Ctrl;&Shift;
1269               <keycap>G</keycap></keycombo>
1270             </shortcut>
1271             <guimenu>KrViewer</guimenu>
1272             <guimenuitem>Generic viewer</guimenuitem>
1273           </menuchoice>
1274         </term>
1275         <listitem>
1276           <para>&krusader;'s internal viewer is actually
1277           part of &konqueror;, which can basically view every file
1278           type viewable by &konqueror; (&eg;
1279           display pictures, play music, show the content of an
1280           archive).</para>
1281         </listitem>
1282       </varlistentry>
1283       <varlistentry>
1284         <term>
1285           <menuchoice>
1286             <shortcut>
1287               <keycombo action="simul">&Ctrl;&Shift;
1288               <keycap>T</keycap></keycombo>
1289             </shortcut>
1290             <guimenu>KrViewer</guimenu>
1291             <guimenuitem>Text viewer</guimenuitem>
1292           </menuchoice>
1293         </term>
1294         <listitem>
1295           <para>View the file in text mode.</para>
1296         </listitem>
1297       </varlistentry>
1298       <varlistentry>
1299         <term>
1300           <menuchoice>
1301             <shortcut>
1302               <keycombo action="simul">
1303               &Ctrl;&Shift;
1304               <keycap>H</keycap></keycombo>
1305             </shortcut>
1306             <guimenu>KrViewer</guimenu>
1307             <guimenuitem>Hex viewer</guimenuitem>
1308           </menuchoice>
1309         </term>
1310         <listitem>
1311           <para>View the file in hex mode.</para>
1312         </listitem>
1313       </varlistentry>
1314       <varlistentry>
1315         <term>
1316           <menuchoice>
1317             <shortcut>
1318               <keycombo action="simul">
1319               &Ctrl;&Shift;
1320               <keycap>L</keycap></keycombo>
1321             </shortcut>
1322             <guimenu>KrViewer</guimenu>
1323             <guimenuitem>Lister</guimenuitem>
1324           </menuchoice>
1325         </term>
1326         <listitem>
1327           <para>Fast text/hex viewer for huge filesizes, done by
1328                 <link linkend="konfig-general">Krusader lister</link>.</para>
1329         </listitem>
1330       </varlistentry>
1331       <varlistentry>
1332         <term>
1333           <menuchoice>
1334             <shortcut>
1335               <keycombo action="simul">
1336               &Ctrl;&Shift;
1337               <keycap>E</keycap></keycombo>
1338             </shortcut>
1339             <guimenu>KrViewer</guimenu>
1340             <guimenuitem>Text editor</guimenuitem>
1341           </menuchoice>
1342         </term>
1343         <listitem>
1344           <para>Edit the file in text mode.</para>
1345         </listitem>
1346       </varlistentry>
1347       <varlistentry>
1348         <term>
1349           <menuchoice>
1350             <shortcut>
1351               <keycombo action="simul">
1352               &Ctrl;&Shift;
1353               <keycap>D</keycap></keycombo>
1354             </shortcut>
1355             <guimenu>KrViewer</guimenu>
1356             <guimenuitem>Detach Tab</guimenuitem>
1357           </menuchoice>
1358         </term>
1359         <listitem>
1360           <para>Detach browsing Tab and open in a new
1361           window.</para>
1362         </listitem>
1363       </varlistentry>
1364       <varlistentry>
1365         <term>
1366           <menuchoice>
1367             <shortcut>
1368             <keycombo action="simul">
1369             &Ctrl;
1370             <keycap>Q</keycap></keycombo>
1371             </shortcut>
1372             <guimenu>KrViewer</guimenu>
1373             <guimenuitem>Quit</guimenuitem>
1374           </menuchoice>
1375         </term>
1376         <listitem>
1377           <para>Closes &krusader;'s viewer/editor
1378           window.</para>
1379         </listitem>
1380       </varlistentry>
1381     </variablelist>
1382     </sect3>
1383   </sect2>
1384 
1385 <!--taken from kwrite's configuring-part.docbook-->
1386 <sect2 id="kredit_config">
1387 <title>The Editor Component Configuration</title>
1388 <para>This group contains all pages related to the editor component of
1389 &kappname;. Most of the settings here are defaults, they can be overridden by
1390 <link linkend="katepart-pref-open-save-modes-filetypes">defining a filetype</link>,
1391 by <ulink url="help:/katepart/config-variables.html">Document Variables</ulink> or
1392 by changing them per document during an editing session.</para>
1393 <sect3 id="katepart-appearance"> <!-- updated to 4.7 + synced with kwrite -->
1394 <title>Appearance</title>
1395 
1396 <sect4 id="katepart-appearance-general">
1397 <title>General</title>
1398 
1399 <variablelist>
1400 <varlistentry>
1401 <term><guilabel>Dynamic Word Wrap</guilabel></term>
1402 <listitem>
1403 <para>If this option is checked, the text lines
1404 will be wrapped at the view border on the screen.</para>
1405 <variablelist>
1406 <varlistentry>
1407 <term><guilabel>Dynamic word wrap indicators (if applicable)</guilabel></term>
1408 <listitem><para>Choose when the Dynamic word wrap indicators
1409 should be displayed, either <guilabel>Off</guilabel>, <guilabel>Follow Line
1410 Numbers</guilabel> or <guilabel>Always on</guilabel>.
1411 </para></listitem></varlistentry>
1412 <varlistentry>
1413 <term><guilabel>Align dynamically wrapped lines
1414 to indentation depth:
1415 </guilabel></term>
1416 <listitem><para>Enables the start of dynamically wrapped
1417 lines to be aligned  vertically to the indentation level of the first
1418 line.  This can help to make code and markup more
1419 readable.</para><para>Additionally, this allows you to
1420 set a maximum width of the screen, as a percentage,
1421 after which dynamically wrapped lines will no longer be vertically aligned.
1422 For example, at 50%, lines whose indentation levels are deeper than 50% of the
1423 width of the screen will not have vertical alignment applied to subsequent
1424 wrapped lines.</para></listitem>
1425 </varlistentry>
1426 </variablelist>
1427 </listitem>
1428 </varlistentry>
1429 
1430 <varlistentry>
1431 <term><guilabel>Whitespace Highlighting</guilabel></term>
1432 <listitem>
1433 <variablelist>
1434 <varlistentry>
1435 <term><guilabel>Highlight tabulators</guilabel></term>
1436 <listitem><para>The editor will display a &raquo; symbol to indicate the presence
1437   of a tab in the text.</para></listitem>
1438 </varlistentry>
1439 <varlistentry>
1440 <term><guilabel>Highlight trailing spaces</guilabel></term>
1441 <listitem><para>The editor will display dots to indicate the presence of extra
1442 whitespace at the end of lines.</para></listitem>
1443 </varlistentry>
1444 </variablelist>
1445 </listitem>
1446 </varlistentry>
1447 
1448 <varlistentry>
1449 <term><guilabel>Advanced
1450 </guilabel></term>
1451 <listitem><para>
1452 <variablelist>
1453 <varlistentry>
1454 <term><guilabel>Show indentation lines
1455 </guilabel></term>
1456 <listitem><para>If this is checked, the editor will display
1457 vertical lines to help identifying indent lines.</para></listitem>
1458 </varlistentry>
1459 <varlistentry>
1460 <term><guilabel>Highlight range between selected brackets
1461 </guilabel></term>
1462 <listitem><para>If this is enabled, the range between the selected matching brackets will be highlighted.</para></listitem>
1463 </varlistentry>
1464 </variablelist>
1465 </para></listitem>
1466 </varlistentry>
1467 
1468 </variablelist>
1469 </sect4>
1470 
1471 <sect4 id="katepart-appearance-borders">
1472 <title>Borders</title>
1473 
1474 <variablelist>
1475 <varlistentry>
1476 <term><guilabel>Borders</guilabel></term>
1477 <listitem>
1478 <variablelist>
1479 <varlistentry>
1480 <term><guilabel>Show folding markers (if available)
1481 </guilabel></term>
1482 <listitem><para>If this option is checked, the current view will display marks
1483 for code folding, if code folding is available.</para></listitem>
1484 </varlistentry>
1485 <varlistentry>
1486 <term><guilabel>Show icon border
1487 </guilabel></term>
1488 <listitem><para>If this is checked, you will see an icon border on the left
1489 hand side. The icon border shows bookmark signs for instance.</para></listitem>
1490 </varlistentry>
1491 <varlistentry>
1492 <term><guilabel>Show line numbers
1493 </guilabel></term>
1494 <listitem><para>If this is checked, you will see line numbers on the left
1495 hand side.</para></listitem>
1496 </varlistentry>
1497 <varlistentry>
1498 <term><guilabel>Show scrollbar marks
1499 </guilabel></term>
1500 <listitem><para>If this option is checked the current view
1501 will show marks on the vertical scrollbar. These marks will
1502 for instance show bookmarks.</para></listitem>
1503 </varlistentry>
1504 </variablelist>
1505 </listitem>
1506 </varlistentry>
1507 
1508 <varlistentry>
1509 <term><guilabel>Sort Bookmarks Menu
1510 </guilabel></term>
1511 <listitem>
1512 <variablelist>
1513 <varlistentry>
1514 <term><guilabel>By creation
1515 </guilabel></term>
1516 <listitem><para>Each new bookmark will be added to the bottom,
1517 independently from where it is placed in the document.</para></listitem>
1518 </varlistentry>
1519 <varlistentry>
1520 <term><guilabel>By position
1521 </guilabel></term>
1522 <listitem><para>The bookmarks will be ordered by the line
1523 numbers they are placed at.</para></listitem>
1524 </varlistentry>
1525 </variablelist>
1526 </listitem>
1527 </varlistentry>
1528 </variablelist>
1529 
1530 </sect4>
1531 </sect3>
1532 
1533 <sect3 id="katepart-prefcolors"><!-- checked for 4.7 + synced with kwrite -->
1534 <title>Fonts &amp; Colors</title>
1535 
1536 <para>This section of the dialog lets you configure all fonts and colors in
1537 any color scheme you have, as well creating new schemes or deleting existing
1538 ones. Each scheme has settings for colors, fonts and normal and highlight text
1539 styles.
1540 </para>
1541 
1542 <para>&kappname; will preselect the currently active scheme for you, if you want to
1543 work on a different scheme start by selecting that from the
1544 <guilabel>Schema</guilabel> combobox. With the <guibutton>New</guibutton> and <guibutton>Delete</guibutton>
1545  button you can create a new scheme or delete existing ones.</para>
1546 <para>At the bottom of the page you can select the <guilabel>Default schema for &kappname;</guilabel>.</para>
1547 
1548 <sect4 id="katepart-prefcolors-colors">
1549 <title>Colors</title>
1550 
1551 <variablelist>
1552 <varlistentry id="katepart-variable-prefcolors-colors-text-background">
1553 <term><guilabel>Text Area Background</guilabel></term>
1554 <listitem>
1555 
1556 <variablelist>
1557 
1558 <varlistentry id="katepart-variable-pref-colors-normal-text">
1559 <term><guilabel>Normal text</guilabel></term>
1560 <listitem><para>This is the default background for the editor area, it will be
1561 the dominant color on the editor area.</para></listitem>
1562 </varlistentry>
1563 
1564 <varlistentry id="katepart-variable-pref-colors-selected-text">
1565 <term><guilabel>Selected text</guilabel></term>
1566 <listitem><para>This is the background for selected text. The default is
1567 the global selection color, as set in your &plasma; color preferences.
1568 </para></listitem>
1569 </varlistentry>
1570 
1571 <varlistentry id="katepart-variable-pref-colors-current-line">
1572 <term><guilabel>Current line</guilabel></term>
1573 <listitem><para>Set the color for the current line. Setting this a bit different
1574 from the Normal text background helps to keep focus on the current line.
1575 </para></listitem>
1576 </varlistentry>
1577 
1578 <varlistentry id="katepart-variable-pref-colors-marks">
1579 <term><guilabel>Bookmark</guilabel></term>
1580 <listitem><para>This combobox lets you set overlay colors for various mark types.
1581 The color is mixed into the background color of a marked line, so that a line
1582 with more marks or a marked line that is current has a background that is a mix
1583 of more colors. The mark colors are also used if you enable display of scrollbar
1584 marks.</para></listitem>
1585 </varlistentry>
1586 
1587 </variablelist>
1588 </listitem>
1589 </varlistentry>
1590 
1591 <varlistentry id="katepart-variable-prefcolors-colors-other-elements">
1592 <term><guilabel>Additional Elements</guilabel></term>
1593 <listitem>
1594 <variablelist>
1595 <varlistentry>
1596 <term><guilabel>Left border background</guilabel></term>
1597 <listitem><para>This color is used for the marks, line numbers and folding
1598 marker borders in the left side of the editor view when they are displayed.
1599 </para></listitem>
1600 </varlistentry>
1601 <varlistentry>
1602 <term><guilabel>Line numbers</guilabel></term>
1603 <listitem><para>This color is used to draw the line numbers on the left side of
1604 the view when displayed.</para></listitem>
1605 </varlistentry>
1606 <varlistentry>
1607 <term><guilabel>Bracket highlight</guilabel></term>
1608 <listitem><para>This color is used to draw the background of matching brackets.
1609 </para></listitem>
1610 </varlistentry>
1611 <varlistentry>
1612 <term><guilabel>Word wrap markers</guilabel></term>
1613 <listitem><para>This color is used to draw a pattern to the left of dynamically
1614 wrapped lines when those are aligned vertically, as well as for the static word
1615 wrap marker.</para></listitem>
1616 </varlistentry>
1617 <varlistentry>
1618 <term><guilabel>Tab and space markers</guilabel></term>
1619 <listitem><para>This color is used to draw white space indicators when enabled.
1620 </para></listitem>
1621 </varlistentry>
1622 <varlistentry>
1623 <term><guilabel>Spelling mistake line</guilabel></term>
1624 <listitem><para>sets the color of the line that is used to indicate spelling mistakes.
1625 </para></listitem>
1626 </varlistentry>
1627 </variablelist>
1628 </listitem>
1629 </varlistentry>
1630 
1631 </variablelist>
1632 </sect4>
1633 
1634 <sect4 id="katepart-prefcolors-fonts">
1635 <title>Fonts</title>
1636 <para>
1637 Here you can choose the font for the schema.  You can choose from
1638 any font available on your system, and set a default size. A sample text
1639 displays at the bottom of the dialog, so you can see the effect of your choices.
1640 </para>
1641 </sect4>
1642 
1643 <sect4 id="katepart-prefcolors-normal-text-styles">
1644 <title>Normal Text Styles</title>
1645 <para>The normal text styles are inherited by the highlight text styles,
1646 allowing the editor to present text in a very consistent way, for example comment
1647 text is using the same style in almost all of the text formats that &kappname; can
1648 highlight.</para>
1649 <para>The name in the list of styles is using the style configured for
1650 the item, providing you with an immediate preview when configuring a style.
1651 </para>
1652 <para>Each style lets you select common attributes as well as foreground
1653 and background colors. To unset a background color, rightclick to use the
1654 context menu.</para>
1655 </sect4>
1656 
1657 <sect4 id="katepart-prefcolors-highlighting-text-styles">
1658 <title>Highlighting Text Styles</title>
1659 <para>Here you can edit the text styles used by a specific highlight definition.
1660 The editor preselects the highlight used by your current document. To work on a
1661 different highlight, select one in the <guilabel>Highlight</guilabel> combobox
1662 above the style list.
1663 </para>
1664 <para>The name in the list of styles is using the style configured for
1665 the item, providing you with an immediate preview when configuring a style.
1666 </para>
1667 <para>Each style lets you select common attributes as well as foreground
1668 and background colors. To unset a background color, rightclick to use the
1669 context menu. In addition you can see if a style is equal to the default style
1670 used for the item, and set it to that if not.</para>
1671 <para>You will notice that many highlights contain other highlights represented
1672 by groups in the style list. For example most highlights import the Alert
1673 highlight, and many source code formats imports the Doxygen highlight. Editing
1674 colors in those groups only affects the styles when used in the edited highlight
1675 format.
1676 </para>
1677 </sect4>
1678 
1679 </sect3>
1680 
1681 <sect3 id="katepart-pref-edit">
1682 <title>Editing</title>
1683 
1684 <sect4 id="katepart-pref-edit-general">
1685 <title>General</title>
1686 <variablelist>
1687 
1688 <varlistentry>
1689 <term id="katepart-pref-word-wrap"><guilabel>Static Word Wrap</guilabel></term>
1690 <listitem><para>
1691 Word wrap is a feature that causes the editor to automatically start a new line
1692 of text and move (wrap) the cursor to the beginning of that new line.  &kappname;
1693 will automatically start a new line of text when  the current line reaches the
1694 length specified by the <link linkend="katepart-pref-wrap-words-at">Wrap Words
1695 At:</link> option.</para>
1696 <variablelist>
1697 <varlistentry>
1698 <term><guilabel>Enable static word wrap</guilabel></term>
1699 <listitem>
1700 <para>Turns static word wrap on or off.</para>
1701 </listitem>
1702 </varlistentry>
1703 <varlistentry>
1704 <term><guilabel>Show static word wrap markers
1705 (if applicable)</guilabel></term>
1706 <listitem>
1707 <para>If this option is checked, a vertical line will be drawn at the word wrap
1708 column as defined in the <menuchoice> <guimenu>Settings</guimenu>
1709 <guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the Editing tab.
1710 Please note that the word wrap marker is only drawn if you use a fixed pitch
1711 font.</para>
1712 </listitem>
1713 </varlistentry>
1714 <varlistentry>
1715 <term id="katepart-pref-wrap-words-at"><guilabel>Wrap words at:</guilabel></term>
1716 <listitem>
1717 <para>If the <link linkend="katepart-pref-word-wrap">Enable static word wrap</link> option is selected
1718 this entry  determines the length (in characters) at which the editor will
1719 automatically start a new line.</para>
1720 </listitem>
1721 </varlistentry>
1722 </variablelist>
1723 </listitem>
1724 </varlistentry>
1725 
1726 <varlistentry>
1727 <term ><guilabel>Misc</guilabel></term>
1728 <listitem>
1729 <variablelist>
1730 <varlistentry>
1731 <term><guilabel>Remove trailing spaces while editing</guilabel></term>
1732 <listitem><para>&kappname; will automatically eliminate extra spaces
1733 at the ends of lines of text.</para></listitem> </varlistentry>
1734 
1735 <varlistentry>
1736 <term><guilabel>Auto brackets</guilabel></term> <listitem><para>When
1737 the user types a left bracket ([, (, or {) &kappname; automatically enters the
1738 right bracket (}, ), or ]) to the right of the cursor.</para></listitem>
1739 </varlistentry>
1740 
1741 <varlistentry>
1742 <term><guilabel>Copy/Cut the current line if no selection</guilabel></term> <listitem>
1743 <para>If this option is enabled and the text selection is empty, copy and cut
1744 action are performed for the line of text at the actual cursor position.</para></listitem>
1745 </varlistentry>
1746 
1747 <varlistentry>
1748 <term><guilabel>Allow scrolling past the end of the document</guilabel></term> <listitem>
1749 <para>This option lets you scroll past the end of the document. This can be used to vertically centre the bottom of the document, or put it on top of the current view.</para></listitem>
1750 </varlistentry>
1751 
1752 </variablelist>
1753 </listitem>
1754 </varlistentry>
1755 
1756 </variablelist>
1757 </sect4>
1758 
1759 <sect4 id="katepart-pref-edit-cursor-selection">
1760 <title>Cursor &amp; Selection</title>
1761 
1762 <variablelist>
1763 
1764 <varlistentry>
1765 <term><guilabel>Text Cursor Movement</guilabel></term>
1766 <listitem>
1767 <variablelist>
1768 <varlistentry>
1769 <term><guilabel>Smart home and smart end</guilabel></term>
1770 <listitem>
1771 <para>When selected, pressing the home key will cause the cursor to
1772 skip white space and go to the start of a line's text.</para>
1773 </listitem>
1774 </varlistentry>
1775 <varlistentry>
1776 <term><guilabel>Wrap cursor</guilabel></term>
1777 <listitem>
1778 <para>When on, moving the insertion cursor using the &Left; and &Right; keys will
1779 go on to previous/next line at beginning/end of the line, similar to most
1780 editors.</para><para>When off, the insertion cursor cannot be moved left of the
1781 line start, but it can be moved off the line end, which can be very handy for
1782 programmers. When this option is chosen, moving the cursor with the arrow keys
1783 off the end of a line (to the right) causes it to jump down to the beginning of
1784 the next line. Likewise when the cursor is moved past the beginning of a line
1785 (to the left) it jumps up to the end of the preceding line. When this option is
1786 not selected, moving the cursor right past the end of a line merely causes it to
1787 continue horizontally in the same line and trying to move it left past the
1788 beginning does nothing.</para>
1789 </listitem>
1790 </varlistentry>
1791 <varlistentry>
1792 <term><guilabel>PageUp/PageDown moves cursor</guilabel></term>
1793 <listitem>
1794 <para>This option changes the behavior of the cursor when the user presses
1795 the &PgUp; or &PgDn; key. If unselected
1796 the text cursor will maintain its relative position within the visible text in
1797 &kappname; as new text becomes visible as a result of the operation.  So if the
1798 cursor is in the middle of the visible text when the operation occurs it will
1799 remain there (except when one reaches the beginning or end.)  With this option
1800 selected, the first key press will cause the cursor to move to either the top or
1801 bottom of the visible text as a new page of text is displayed.</para>
1802 </listitem>
1803 </varlistentry>
1804 <varlistentry>
1805 <term><guilabel>Autocenter cursor (lines):</guilabel></term>
1806 <listitem>
1807 <para>Sets the number of lines to maintain visible above and below the cursor
1808 when possible.</para>
1809 </listitem>
1810 </varlistentry>
1811 </variablelist>
1812 </listitem>
1813 </varlistentry>
1814 
1815 <varlistentry>
1816 <term><guilabel>Text Selection Mode</guilabel></term>
1817 <listitem>
1818 <variablelist>
1819 <varlistentry>
1820 <term><guilabel>Normal</guilabel></term>
1821 <listitem>
1822 <para>Selections will be overwritten by typed text and will be lost on
1823 cursor movement.</para>
1824 </listitem>
1825 </varlistentry>
1826 <varlistentry>
1827 <term><guilabel>Persistent</guilabel></term>
1828 <listitem>
1829 <para>Selections will stay even after cursor movement and typing.</para>
1830 </listitem>
1831 </varlistentry>
1832 </variablelist>
1833 </listitem>
1834 </varlistentry>
1835 
1836 </variablelist>
1837 </sect4>
1838 
1839 <sect4 id="katepart-pref-edit-indent">
1840 <title>Indentation</title>
1841 
1842 <variablelist>
1843 
1844 <varlistentry>
1845 <term><guilabel>Default Indentation mode:</guilabel></term>
1846 <listitem>
1847 <para>Select the automatic indentation mode you want to use as default. It is
1848 strongly recommended to use <userinput>None</userinput> or
1849 <userinput>Normal</userinput> here, and use filetype configurations to set other
1850 indentation modes for text formats like C/C++ code or &XML;.</para>
1851 </listitem>
1852 </varlistentry>
1853 
1854 <varlistentry>
1855 <term><guilabel>Indent using</guilabel></term>
1856 <listitem>
1857 <variablelist>
1858 <varlistentry>
1859 <term><guilabel>Tabulators</guilabel></term>
1860 <listitem>
1861 <para>When this is enabled the editor will insert tabulator characters when you
1862 press the &Tab; key or use <ulink url="help:/katepart/kate-part-autoindent.html">automatic
1863 indentation</ulink>.</para>
1864 </listitem>
1865 </varlistentry>
1866 <varlistentry>
1867 <term><guilabel>Spaces</guilabel></term>
1868 <listitem>
1869 <para>When this is enabled the editor will insert a calculated number of spaces
1870 according to the position in the text and the <option>tab-width</option> setting
1871 when you press the &Tab; key or use <ulink url="help:/katepart/kate-part-autoindent.html">automatic
1872 indentation</ulink>.</para>
1873 </listitem>
1874 </varlistentry>
1875 <varlistentry>
1876 <term><guilabel>Tabulators and Spaces</guilabel></term>
1877 <listitem>
1878 <para>When this is enabled, the editor will insert spaces as describe above when
1879 indenting or pressing &Tab; at the beginning of a line, but insert tabulators when
1880 the &Tab; key is pressed in the middle or end of a line.</para>
1881 </listitem>
1882 </varlistentry>
1883 <varlistentry>
1884 <term><guilabel>Tab width:</guilabel></term>
1885 <listitem>
1886 <para>This configures the number of spaces that are displayed in place of a tabulator
1887 character.</para>
1888 </listitem>
1889 </varlistentry>
1890 <varlistentry>
1891 <term><guilabel>Indentation width:</guilabel></term>
1892 <listitem>
1893 <para>The indentation width is the number of spaces which is used to indent a line.
1894 If configured to indent using tabulators, a tabulator character is inserted
1895 if the indentation is divisible by the tab width.</para>
1896 </listitem>
1897 </varlistentry>
1898 </variablelist>
1899 </listitem>
1900 </varlistentry>
1901 
1902 <varlistentry>
1903 <term><guilabel>Indentation Properties</guilabel></term>
1904 <listitem>
1905 <variablelist>
1906 <varlistentry>
1907 <term><guilabel>Keep Extra Spaces</guilabel></term>
1908 <listitem><para>If this option is disabled, changing the indentation
1909 level aligns a line to a multiple of the width specified in
1910 <guilabel>Indentation width</guilabel>.</para></listitem>
1911 </varlistentry>
1912 <varlistentry>
1913 <term><guilabel>Adjust indentation of code pasted from the clipboard</guilabel></term>
1914 <listitem>
1915 <para>If this option is selected, pasted code from the clipboard is indented.
1916 Triggering the <guimenuitem>Undo</guimenuitem> action removes the indentation.</para>
1917 </listitem>
1918 </varlistentry>
1919 </variablelist>
1920 </listitem>
1921 </varlistentry>
1922 
1923 <varlistentry>
1924 <term><guilabel>Indentation Actions</guilabel></term>
1925 <listitem>
1926 <variablelist>
1927 <varlistentry>
1928 <term><guilabel>Backspace key in leading blank space unindents</guilabel></term>
1929 <listitem>
1930 <para>If this option is selected, the &Backspace; key decreases the indentation level
1931 if the cursor is located in the leading blank space of a line.</para>
1932 </listitem>
1933 </varlistentry>
1934 <varlistentry>
1935 <term><guilabel>Tab key action (if no selection exists)</guilabel></term>
1936 <listitem>
1937 <para>
1938 If you want &Tab; to align the current line in the current code block
1939 like in emacs, make &Tab; a shortcut to the action <guimenuitem>Align</guimenuitem>.
1940 </para>
1941 <variablelist>
1942 <varlistentry>
1943 <term><guilabel>Always advance to the next tab position</guilabel></term>
1944 <listitem>
1945 <para>If this option is selected, the &Tab; key always inserts white space
1946 so that the next tab position is reached. If the option <guilabel>Insert spaces instead of tabulators</guilabel>
1947 on the <guilabel>General</guilabel> tab in the <guilabel>Editing</guilabel>
1948 page is enabled, spaces are inserted; otherwise, a single tabulator is inserted.</para>
1949 </listitem>
1950 </varlistentry>
1951 <varlistentry>
1952 <term><guilabel>Always increase indentation level</guilabel></term>
1953 <listitem>
1954 <para>If this option is selected, the &Tab; key always indents the current
1955 line by the number of character positions specified in <guilabel>Indentation width</guilabel>.</para>
1956 </listitem>
1957 </varlistentry>
1958 
1959 <varlistentry>
1960 <term><guilabel>Increase indentation level if in leading blank space</guilabel></term>
1961 <listitem>
1962 <para>If this option is selected, the &Tab; key either indents the current line
1963 or advances to the next tab position. If the insertion point is at or before the
1964 first non-space character in the line, or if there is a selection, the current line
1965 is indented by the number of character positions specified in <guilabel>Indentation width</guilabel>.
1966 If the insertion point is located after the first non-space character in the line
1967 and there is no selection, white space is inserted so that the next tab position is
1968 reached: if the option <guilabel>Insert spaces instead of tabulators</guilabel>
1969 on the <guilabel>General</guilabel> tab in the <guilabel>Editing</guilabel>
1970 page is enabled, spaces are inserted; otherwise, a single tabulator is inserted.</para>
1971 </listitem>
1972 </varlistentry>
1973 </variablelist>
1974 
1975 </listitem>
1976 </varlistentry>
1977 
1978 </variablelist>
1979 </listitem>
1980 </varlistentry>
1981 
1982 </variablelist>
1983 </sect4>
1984 
1985 <sect4 id="katepart-pref-edit-autocompletion">
1986 <title>Auto Completion</title>
1987 <variablelist>
1988 <varlistentry>
1989 <term><guilabel>General</guilabel></term>
1990 <listitem>
1991 <variablelist>
1992 <varlistentry>
1993 <term><guilabel>Enable auto completion</guilabel></term>
1994 <listitem>
1995 <para>If enabled, a word completion box automatically pops up during typing
1996 showing a list of text entries to complete the current text under the
1997 cursor.</para>
1998 </listitem>
1999 </varlistentry>
2000 </variablelist>
2001 </listitem>
2002 </varlistentry>
2003 
2004 <varlistentry>
2005 <term><guilabel>Minimal word length to complete</guilabel></term>
2006 <listitem><para>While typing text, the word completion searches for words in the
2007 document starting with the already typed text. This option configures the minimal
2008 amount of characters that are needed to make the word completion active and pop
2009 up a completion box.</para></listitem>
2010 </varlistentry>
2011 
2012 </variablelist>
2013 
2014 </sect4>
2015 
2016 <sect4 id="katepart-pref-edit-vi-input-mode">
2017 <title>Vi Input Mode</title>
2018 <variablelist>
2019 <varlistentry>
2020 <term><guilabel>General</guilabel></term>
2021 <listitem>
2022 <variablelist>
2023 <varlistentry>
2024 <term><guilabel>Use VI input mode</guilabel></term>
2025 <listitem>
2026 <para>When selected, the vi input mode will be enabled when opening a new view.
2027 You can still toggle the vi input mode on/off for a particular view in the
2028 <guimenu>Edit</guimenu> menu.</para>
2029 </listitem>
2030 </varlistentry>
2031 <varlistentry>
2032 <term><guilabel>Let Vi commands override Kate shortcuts</guilabel></term>
2033 <listitem>
2034 <para>When selected, Vi commands will override &kappname;'s built-in commands. For
2035 example: <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> will redo,
2036 and override the standard action (showing the search and replace dialog).</para>
2037 </listitem>
2038 </varlistentry>
2039 <varlistentry>
2040 <term><guilabel>Hide the Vi mode status bar</guilabel></term>
2041 <listitem>
2042 <para>By default, an extra status bar will be used when the Vi input mode is
2043 enabled. This status bar shows commands while they are being typed and
2044 messages/errors produced by Vi commands.</para>
2045 <para>Checking this option will hide this extra status line.</para>
2046 </listitem>
2047 </varlistentry>
2048 </variablelist>
2049 </listitem>
2050 </varlistentry>
2051 <varlistentry>
2052 <term><guilabel>Key Mapping</guilabel></term>
2053 <listitem><para>
2054 Key mapping is used to change the meaning of typed keys. This allows you to
2055 move commands to other keys or make special keypresses for doing a series of
2056 commands.</para>
2057 <para>Example:</para>
2058 <para><keycap>F2</keycap> -> <keycap>I--</keycap> &Esc;</para>
2059 <para>This will prepend <keycap>I--</keycap> to a line when pressing <keycap>F2</keycap>.
2060 </para>
2061 </listitem>
2062 </varlistentry>
2063 </variablelist>
2064 
2065 </sect4>
2066 
2067 <sect4 id="katepart-pref-edit-spellcheck">
2068 <title>Spellcheck</title>
2069 <para>These configuration options are described in the documentation for the
2070 &systemsettings; module <ulink url="help:/kcontrol/spellchecking">Spell Checker</ulink>.</para>
2071 </sect4>
2072 
2073 </sect3>
2074 
2075 <sect3 id="katepart-pref-open-save">
2076 <title>Open/Save</title>
2077 
2078 <sect4 id="katepart-pref-open-save-general">
2079 <title>General</title>
2080 
2081 <variablelist>
2082 
2083 <varlistentry>
2084 <term><guilabel>File Format</guilabel></term>
2085 <listitem>
2086 <variablelist>
2087 
2088 <varlistentry>
2089 <term><guilabel>Encoding:</guilabel></term>
2090 <listitem>
2091 <para>This defines the standard encoding to use to open/save files, if not changed
2092 in the open/save dialog or by using a command line option.</para>
2093 </listitem>
2094 </varlistentry>
2095 
2096 <varlistentry>
2097 <term><guilabel>Encoding Detection</guilabel></term>
2098 <listitem>
2099 <para>Select an item from the drop down box, either to disable autodetection or
2100 use <guilabel>Universal</guilabel> to enable autodetection for all encodings. But as
2101 this may probably only detect utf-8/utf-16, selecting a region will use custom heuristics
2102 for better results.
2103 If neither the encoding chosen as standard above, nor the encoding specified
2104 in the open/save dialog, nor the encoding specified on command line match
2105 the content of the file, this detection will be run.</para>
2106 </listitem>
2107 </varlistentry>
2108 
2109 <varlistentry>
2110 <term><guilabel>Fallback Encoding</guilabel></term>
2111 <listitem>
2112 <para>This defines the fallback encoding to try for opening files if neither the
2113 encoding chosen as standard above, nor the encoding specified in the open/
2114 save dialog, nor the encoding specified on command line match the content of
2115 the file.  Before this is used, an attempt will be made to determine the
2116 encoding to use by looking for a byte order marker at start of file: if one
2117 is found, the right unicode encoding will be chosen; otherwise encoding
2118 detection will run, if both fail fallback encoding will be tried.</para>
2119 </listitem>
2120 </varlistentry>
2121 
2122 <varlistentry>
2123 <term><guilabel>End of line:</guilabel></term>
2124 <listitem>
2125 <para>Choose your preferred end of line mode for your active
2126 document. You have the choice between &UNIX;, DOS/&Windows; or Macintosh.</para>
2127 </listitem>
2128 </varlistentry>
2129 <varlistentry>
2130 <term><guilabel>Automatic end of line detection</guilabel></term>
2131 <listitem>
2132 <para>Check this if you want the editor to autodetect the end of line
2133 type. The first found end of line type will be used for the whole file.</para>
2134 </listitem>
2135 </varlistentry>
2136 
2137 <varlistentry>
2138 <term><guilabel>Enable byte order marker</guilabel></term>
2139 <listitem>
2140 <para>The byte order mark is a special sequence at the beginning of unicode
2141 encoded documents. It helps editors to open text documents with the correct
2142 unicode encoding. For more information see <ulink
2143 url="https://en.wikipedia.org/wiki/Byte_Order_Mark">Byte Order Mark</ulink>.</para>
2144 </listitem>
2145 </varlistentry>
2146 <!--
2147 Line Length Limit missing
2148  -->
2149 </variablelist>
2150 </listitem>
2151 </varlistentry>
2152 
2153 <varlistentry>
2154 <term><guilabel>Automatic Cleanups on Load/Save</guilabel></term>
2155 <listitem>
2156 <variablelist>
2157 <varlistentry>
2158 <term><guilabel>Remove trailing spaces</guilabel></term>
2159 <listitem>
2160 <para>The editor will automatically eliminate extra spaces at the ends of lines
2161 of text while loading/saving the file.</para>
2162 </listitem>
2163 </varlistentry>
2164 </variablelist>
2165 </listitem>
2166 </varlistentry>
2167 
2168 </variablelist>
2169 </sect4>
2170 
2171 <sect4 id="katepart-pref-open-save-advanced">
2172 <title>Advanced</title>
2173 <variablelist>
2174 <varlistentry>
2175 <term><guilabel>Folder Config File</guilabel></term>
2176 <listitem>
2177 <variablelist>
2178 <varlistentry>
2179 <term><guilabel>Search depth for config file:</guilabel></term>
2180 <listitem>
2181 <para>The editor will search the given number of folder levels upwards
2182 for &kappname; config file and load the settings line from it.
2183 Further information about these hidden folder config files you find in the
2184 <ulink url="help:/katepart/config-variables.html">document variables section</ulink>.
2185 </para>
2186 </listitem>
2187 </varlistentry>
2188 </variablelist>
2189 </listitem>
2190 </varlistentry>
2191 
2192 <varlistentry>
2193 <term><guilabel>Backup on Save</guilabel></term>
2194 <listitem><para>Backing up on save will cause &kappname; to copy the disk file to
2195 &lt;prefix&gt;&lt;filename&gt;&lt;suffix&gt; before saving changes.
2196 The suffix defaults to <emphasis role="bold">~</emphasis> and prefix is empty by
2197 default. </para>
2198 <variablelist>
2199 <varlistentry>
2200 <term><guilabel>Local files</guilabel></term>
2201 <listitem>
2202 <para>Check this if you want backups of local files when
2203 saving.</para>
2204 </listitem>
2205 </varlistentry>
2206 <varlistentry>
2207 <term><guilabel>Remote files</guilabel></term>
2208 <listitem>
2209 <para>Check this if you want backups of remote files when saving.</para>
2210 </listitem>
2211 </varlistentry>
2212 <varlistentry>
2213 <term><guilabel>Prefix</guilabel></term>
2214 <listitem>
2215 <para>Enter the prefix to prepend to the backup file names.</para>
2216 </listitem>
2217 </varlistentry>
2218 <varlistentry>
2219 <term><guilabel>Suffix</guilabel></term>
2220 <listitem>
2221 <para>Enter the suffix to add to the backup file names.</para>
2222 </listitem>
2223 </varlistentry>
2224 <varlistentry>
2225 <term><guilabel>Disable swap file syncing</guilabel></term>
2226 <listitem>
2227 <para>&kappname; is able to recover (most of) what was written after last save in case
2228 of a crash or power failure. A swap file (.swp.&lt;filename&gt;) is created
2229 after the first editing action on a document. If the user doesn’t save the
2230 changes and &kappname; crashes, the swap file remains on the disk. When opening a
2231 file, &kappname; checks if there is a swap file for the document and if it is, it asks
2232 the user whether he wants to recover the lost data or not. The user has the
2233 possibility to view the differences between the original file and the recovered
2234 one, too. The swap file is deleted after every save and on normal exit.</para>
2235 <para>&kappname; syncs the swap files on the disk every 15 seconds, but only if they
2236 have changed since the last sync. The user can disable the swap files syncing if
2237 he wants, by checking the <guilabel>Disable swap file syncing</guilabel> box,
2238 but this can lead to more data loss.</para>
2239 </listitem>
2240 </varlistentry>
2241 
2242 </variablelist>
2243 </listitem>
2244 </varlistentry>
2245 
2246 </variablelist>
2247 </sect4>
2248 
2249 <sect4 id="katepart-pref-open-save-modes-filetypes">
2250 <title>Modes &amp; Filetypes</title>
2251 <para>This page allows you to override the default configuration for documents
2252 of specified &MIME; types. When the editor loads a document, it will try if it
2253 matches the file masks or &MIME; types for one of the defined filetypes, and if so
2254 apply the variables defined. If more filetypes match, the one with the highest
2255 priority will be used.
2256 </para>
2257 <variablelist>
2258 <varlistentry>
2259 <term><guilabel>Filetype:</guilabel></term>
2260 <listitem><para>The filetype with the highest priority is the one displayed in
2261 the first drop down box. If more filetypes were found, they are
2262 also listed.</para>
2263 <variablelist>
2264 <varlistentry>
2265 <term><guilabel>New</guilabel></term>
2266 <listitem><para>This is used to create a new filetype. After
2267 you click on this button, the fields below get empty and you
2268 can fill the properties you want for the new filetype.</para></listitem>
2269 </varlistentry>
2270 <varlistentry>
2271 <term><guilabel>Delete</guilabel></term>
2272 <listitem><para>To remove an existing filetype, select it from the drop down
2273 box and press the Delete button.</para></listitem>
2274 </varlistentry>
2275 </variablelist>
2276 </listitem> </varlistentry>
2277 
2278 <varlistentry>
2279 <term><guilabel>Properties of <replaceable>current filetype</replaceable></guilabel></term>
2280 <listitem><para>The filetype with the highest priority is the one displayed in
2281 the first drop down box. If more filetypes were found, they are also
2282 listed.</para>
2283 <variablelist>
2284 <varlistentry>
2285 <term><guilabel>Name:</guilabel></term>
2286 <listitem><para>The name of the filetype will be the text of the corresponding
2287 menu item. This name is displayed in the
2288 <menuchoice><guimenu>Tools</guimenu><guimenuitem>Filetypes</guimenuitem>
2289 </menuchoice ></para></listitem>
2290 </varlistentry>
2291 <varlistentry>
2292 <term><guilabel>Section:</guilabel></term>
2293 <listitem><para>The section name is used to organize the file types in
2294 menus. This is also used in the
2295 <menuchoice><guimenu>Tools</guimenu><guimenuitem>Filetypes</guimenuitem>
2296 </menuchoice> menu.</para></listitem>
2297 </varlistentry>
2298 <varlistentry>
2299 <term><guilabel>Variables:</guilabel></term>
2300 <listitem><para>This string allows you to configure &kappname;'s settings for the
2301 files selected by this &MIME; type using &kappname; variables. You can set almost any
2302 configuration option, such as highlight, indent-mode,
2303 &etc;</para>
2304 <para>Press <guibutton>Edit</guibutton> to see a list of all available variables
2305 and their descriptions.  Select the checkbox on the left to enable a particular
2306 variable and then set the value of the variable on the right.  Some variables
2307 provide a drop-down box to select possible values from while others require you
2308 to enter a valid value manually.</para>
2309 <para>For complete information on these variables, see
2310 <ulink url="help:/katepart/config-variables.html">Configuring with Document
2311 Variables</ulink>.</para>
2312 </listitem>
2313 </varlistentry>
2314 <varlistentry>
2315 <term><guilabel>Highlighting:</guilabel></term>
2316 <listitem><para>If you create a new file type, this drop down box allows you to
2317 select a filetype for highlighting.</para></listitem>
2318 </varlistentry>
2319 
2320 <varlistentry>
2321 <term><guilabel>Indentation Mode:</guilabel></term>
2322 <listitem><para>The drop down box specifies the indentation mode for new
2323 documents.</para></listitem>
2324 </varlistentry>
2325 
2326 <varlistentry>
2327 <term><guilabel>File extensions:</guilabel></term>
2328 <listitem><para>The wildcards mask allows you to select files by filename. A
2329 typical mask uses an asterisk and the file extension, for example
2330 <filename>*.txt; *.text</filename>. The string is a semicolon-separated list of
2331 masks.</para></listitem>
2332 </varlistentry>
2333 <varlistentry>
2334 <term><guilabel>&MIME; types:</guilabel></term>
2335 <listitem><para>Displays a wizard that helps you easily select
2336 &MIME; types.</para></listitem>
2337 </varlistentry>
2338 <varlistentry>
2339 <term><guilabel>Priority:</guilabel></term>
2340 <listitem><para>Sets a priority for this file type. If more than one file type
2341 selects the same file, the one with the highest priority will be
2342 used.</para></listitem>
2343 </varlistentry>
2344 </variablelist>
2345 </listitem> </varlistentry>
2346 <varlistentry>
2347 <term><guibutton>Download Highlighting Files...</guibutton></term>
2348 <listitem>
2349 <para>
2350 Click this button to download new or updated syntax highlight descriptions
2351 from the &kappname; website.
2352 </para>
2353 </listitem>
2354 </varlistentry>
2355 
2356 </variablelist>
2357 </sect4>
2358 
2359 </sect3>
2360 
2361 <sect3 id="katepart-pref-plugins">
2362 <title>Extensions</title> <!-- updated to 4.7 + synced with kwrite -->
2363 <para>The <guilabel>Plugins</guilabel> tab lists all available plugins and you can check those you
2364 want to use. Click on the <guibutton>Information</guibutton> button to open the
2365 <guilabel>About</guilabel> dialog of this plugin.</para>
2366 <para>Once a configurable plugin is checked, the
2367 <guibutton>Configure</guibutton> button is enabled and you can click it
2368 in order to configure the highlighted plugin.</para>
2369 <variablelist>
2370 <title>Editor Component Plugins</title>
2371 <!-- not released with 4.7
2372 <varlistentry>
2373 <term><guilabel>Artistic Comment</guilabel></term>
2374 <listitem><para>Format long source-code comments like license-headers
2375 or descriptions using different style.</para></listitem>
2376 </varlistentry>
2377 -->
2378 <varlistentry>
2379 <term><guilabel>AutoBrace</guilabel></term>
2380 <listitem><para>The autobrace plugin supersedes the &kappname; internal
2381 <quote>Auto Brackets</quote> feature.
2382 It automatically inserts a closing brace <keycap>}</keycap> at the beginning
2383 of the next line after ending a line with an opening one <keycap>{</keycap>
2384 and pressing the &Enter; key.</para></listitem>
2385 </varlistentry>
2386 <!--http://jakob.petsovits.at/topic/kate-->
2387 <!--Right, it's the automatic insertion of a closing brace (<quote>}</quote>) after you ended a line with an opening one (<quote>{</quote>). Kate's standard insertion of parentheses, brackets and braces is simply too obtrusive for me, so even if I tried it several times I always had to disable it again because I can't stand it. So here's how AutoBrace works.
2388 You, the developer, are writing a line of code, and want to open a new block delimited by braces. Looks like this:
2389 If you press Enter and AutoBrace is enabled, it will insert your favorite new brace where it belongs. Looks like this:
2390 -->
2391 <varlistentry>
2392 <term><guilabel>Data Tools</guilabel></term>
2393 <listitem><para>Enables data tools like thesaurus and spell check (if installed).
2394 Data tools are only available when text is selected, or when the &RMB;
2395 is clicked over a word. If no data tools are offered even when text
2396 is selected, you need to install them.
2397 If this plugin is enabled and data tools are installed, additional items
2398 appear at the end of the context menu.</para></listitem>
2399 </varlistentry>
2400 <varlistentry>
2401 <term><guilabel>Exporter</guilabel></term>
2402 <listitem><para>This command allows you to export the current document with all highlighting
2403 information into a &HTML; document using <menuchoice><guimenu>File</guimenu><guimenuitem>Export
2404 as &HTML;</guimenuitem></menuchoice>. Additionally you can use <menuchoice><guimenu>Edit</guimenu>
2405 <guimenuitem>Copy as &HTML;</guimenuitem></menuchoice> to copy the currently selected text
2406 as &HTML; to the system clipboard.</para></listitem>
2407 </varlistentry>
2408 <!-- not in 4.7
2409 <varlistentry>
2410 <term><guilabel>Highlight Selection</guilabel></term>
2411 <listitem><para>Highlights all words that match the currently selected text.</para></listitem>
2412 </varlistentry>
2413 -->
2414 <varlistentry>
2415 <term><guilabel>IconInserter</guilabel></term>
2416 <listitem><para>The icon inserter plugin is only of use for &kde; developers: It adds an item
2417 <guimenuitem>Insert KIcon-Code</guimenuitem> into the context menu of the editor.
2418 If activated, the &plasma;'s icon chooser opens (showing application icons, action icons &etc;..).
2419 If you click on it, the file name without file extension will be inserted as
2420 text. Useful only for setting icons via &kde-frameworks; through the KIcon() class.
2421 </para></listitem>
2422 </varlistentry>
2423 <varlistentry>
2424 <term><guilabel>Insane (not ZEN) &HTML; coding (light edition)</guilabel></term>
2425 <listitem><para>A plugin, which does zen-coding like selector completion.
2426 For more information see <ulink url="https://en.wikipedia.org/wiki/Zen_Coding">
2427 Zen Coding</ulink>.</para></listitem>
2428 </varlistentry>
2429 <varlistentry>
2430 <term><guilabel>Insert File</guilabel></term>
2431 <listitem><para>This plugin allows you to insert any readable file at the cursor position.
2432 If enabled, the <guimenu>Tools</guimenu> menu has an additional menu item
2433 <guimenuitem>Insert File</guimenuitem>.</para></listitem>
2434 </varlistentry>
2435 </variablelist>
2436 </sect3>
2437 </sect2>
2438 <!--/end kwrite-->
2439 
2440 </sect1>