Warning, /utilities/kate/doc/katepart/menus.docbook is written in an unsupported language. File is not indexed.

0001 <chapter id="the-menu-entries">
0002 <title>The Menu Entries</title>
0003 
0004 <sect1 id="file-menu">
0005 <title>The File Menu</title>
0006 
0007 <variablelist>
0008 
0009 <varlistentry id="file-new">
0010 <term><menuchoice>
0011 <shortcut>
0012 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
0013 </shortcut>
0014 <guimenu>File</guimenu>
0015 <guimenuitem>New</guimenuitem>
0016 </menuchoice></term>
0017 <listitem>
0018 <para>
0019 This starts a new document in a new and independent editor window.
0020 </para>
0021 </listitem>
0022 </varlistentry>
0023 
0024 <varlistentry id="file-new-window">
0025 <term><menuchoice>
0026 <guimenu>File</guimenu>
0027 <guimenuitem>New Window</guimenuitem>
0028 </menuchoice></term>
0029 <listitem>
0030 <para>Create another window containing the current document. All changes to the
0031 document in one window are reflected in the other window and vice versa.</para>
0032 </listitem>
0033 </varlistentry>
0034 
0035 <varlistentry id="file-open">
0036 <term><menuchoice>
0037 <shortcut>
0038 <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
0039 </shortcut>
0040 <guimenu>File</guimenu>
0041 <guimenuitem>Open...</guimenuitem>
0042 </menuchoice></term>
0043 <listitem>
0044 <para>Displays a standard &kde; <guilabel>Open File</guilabel>
0045 dialog. Use the file view to select the file you want to open, and
0046 click on <guibutton>Open</guibutton> to open it.</para>
0047 </listitem>
0048 </varlistentry>
0049 
0050 <varlistentry id="file-open-recent">
0051 <term><menuchoice>
0052 <guimenu>File</guimenu>
0053 <guisubmenu>Open Recent</guisubmenu>
0054 </menuchoice></term>
0055 <listitem>
0056 <para>
0057 This is a shortcut to open recently saved documents. Clicking on this
0058 item opens a list to the side of the menu with several of the most
0059 recently saved files. Clicking on a specific file will open it in
0060 &kappname; - if the file still resides at the same
0061 location.
0062 </para>
0063 </listitem>
0064 </varlistentry>
0065 
0066 <varlistentry id="file-save">
0067 <term><menuchoice>
0068 <shortcut>
0069 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
0070 </shortcut>
0071 <guimenu>File</guimenu>
0072 <guimenuitem>Save</guimenuitem>
0073 </menuchoice></term>
0074 <listitem>
0075 <para>
0076 This saves the current document.  If there has already been a save of
0077 the document then this will overwrite the previously saved file without
0078 asking for the user's consent.  If it is the first save of a new
0079 document the save as dialog (described below) will be invoked.
0080 </para>
0081 </listitem>
0082 </varlistentry>
0083 
0084 <varlistentry id="file-save-as">
0085 <term><menuchoice>
0086 <shortcut>
0087 <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>
0088 </shortcut>
0089 <guimenu>File</guimenu>
0090 <guimenuitem>Save As...</guimenuitem>
0091 </menuchoice></term>
0092 <listitem>
0093 <para>
0094 This allows a document to be saved with a new file name. This is done by
0095 means of the file dialog box described above in the <link
0096 linkend="file-open">Open</link> section of this help file.
0097 </para>
0098 </listitem>
0099 </varlistentry>
0100 
0101 <varlistentry id="file-save-as-encoding">
0102 <term><menuchoice>
0103 <guimenu>File</guimenu>
0104 <guimenuitem>Save As with Encoding</guimenuitem>
0105 </menuchoice>
0106 </term><listitem>
0107 <para>
0108 Save a document with a new file name in a different encoding.</para>
0109 </listitem>
0110 </varlistentry>
0111 
0112 <varlistentry id="file-save-copy-as">
0113 <term><menuchoice>
0114 <guimenu>File</guimenu>
0115 <guimenuitem>Save Copy As</guimenuitem>
0116 </menuchoice></term>
0117 <listitem>
0118 <para>
0119 Save a copy of the document with a new file name and continue editing the original document.</para>
0120 </listitem>
0121 </varlistentry>
0122 
0123 <varlistentry id="file-reload">
0124 <term><menuchoice>
0125 <shortcut>
0126 <keycombo action="simul"><keycap>F5</keycap></keycombo>
0127 </shortcut>
0128 <guimenu>File</guimenu>
0129 <guimenuitem>Reload</guimenuitem>
0130 </menuchoice>
0131 </term><listitem>
0132 <para>
0133 Reloads the active file from disk. This command is useful if another program or
0134 process has changed the file while you have it open in &kappname;.
0135 </para>
0136 </listitem>
0137 </varlistentry>
0138 
0139 <varlistentry id="file-print">
0140 <term><menuchoice>
0141 <shortcut>
0142 <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
0143 </shortcut>
0144 <guimenu>File</guimenu>
0145 <guimenuitem>Print...</guimenuitem>
0146 </menuchoice></term>
0147 <listitem>
0148 <para>
0149 Opens a simple print dialog allowing the user to specify what, where,
0150 and how to print.
0151 </para>
0152 </listitem>
0153 </varlistentry>
0154 
0155 <!--FIXME Print Preview -->
0156 
0157 <varlistentry id="file-export-as-html">
0158 <term><menuchoice>
0159 <guimenu>File</guimenu>
0160 <guimenuitem>Export as HTML</guimenuitem>
0161 </menuchoice></term>
0162 <listitem>
0163 <para>Save the currently open document as an &HTML; file, which will be
0164 formatted using the current syntax highlighting and color scheme settings.</para>
0165 </listitem>
0166 </varlistentry>
0167 
0168 <varlistentry id="file-close">
0169 <term><menuchoice>
0170 <shortcut>
0171 <keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
0172 </shortcut>
0173 <guimenu>File</guimenu>
0174 <guimenuitem>Close</guimenuitem>
0175 </menuchoice></term>
0176 <listitem>
0177 <para>
0178 Close the active file with this command. If you have made unsaved changes, you
0179 will be prompted to save the file before &kappname; closes it.
0180 </para>
0181 </listitem>
0182 </varlistentry>
0183 
0184 <varlistentry id="file-quit">
0185 <term><menuchoice>
0186 <shortcut>
0187 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0188 </shortcut>
0189 <guimenu>File</guimenu>
0190 <guimenuitem>Quit</guimenuitem>
0191 </menuchoice></term>
0192 <listitem>
0193 <para>
0194 This will close the editor window, if you have more than one instance of
0195 &kappname; running, through the <guimenuitem>New</guimenuitem> or
0196 <guimenuitem>New Window</guimenuitem> menu items, those instances will
0197 not be closed.
0198 </para>
0199 </listitem>
0200 </varlistentry>
0201 
0202 </variablelist>
0203 
0204 </sect1>
0205 
0206 <sect1 id="edit-menu">
0207 <title>The Edit Menu</title>
0208 
0209 <variablelist>
0210 
0211 <varlistentry id="edit-undo">
0212 <term><menuchoice>
0213 <shortcut><keycombo
0214 action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
0215 </shortcut>
0216 <guimenu>Edit</guimenu>
0217 <guimenuitem>Undo</guimenuitem>
0218 </menuchoice></term>
0219 <listitem>
0220 <para>Undo the last editing command (typing, copying, cutting &etc;)</para>
0221 <note><para>This may undo several editing commands of the same type, like typing
0222 in characters.</para></note>
0223 </listitem>
0224 </varlistentry>
0225 
0226 <varlistentry id="edit-redo">
0227 <term><menuchoice>
0228 <shortcut>
0229 <keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo>
0230 </shortcut>
0231 <guimenu>Edit</guimenu>
0232 <guimenuitem>Redo</guimenuitem>
0233 </menuchoice></term>
0234 <listitem>
0235 <para>This will reverse the most recent change (if any) made using Undo.</para>
0236 </listitem>
0237 </varlistentry>
0238 
0239 <varlistentry id="edit-cut">
0240 <term><menuchoice>
0241 <shortcut>
0242 <keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
0243 </shortcut>
0244 <guimenu>Edit</guimenu>
0245 <guimenuitem>Cut</guimenuitem>
0246 </menuchoice></term>
0247 <listitem>
0248 <para>This command deletes the current selection and places it on the
0249 clipboard. The clipboard works invisibly and provides a way to
0250 transfer data between applications.</para>
0251 </listitem>
0252 </varlistentry>
0253 
0254 <varlistentry id="edit-copy">
0255 <term><menuchoice>
0256 <shortcut>
0257 <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
0258 </shortcut>
0259 <guimenu>Edit</guimenu>
0260 <guimenuitem>Copy</guimenuitem>
0261 </menuchoice></term>
0262 <listitem>
0263 <para>This copies the currently selected text to the clipboard so that it may
0264 be pasted elsewhere. The clipboard works invisibly and provides a way to
0265 transfer data between applications.</para>
0266 </listitem>
0267 </varlistentry>
0268 
0269 <varlistentry id="edit-copy-as-html">
0270 <term><menuchoice>
0271 <guimenu>Edit</guimenu>
0272 <guimenuitem>Copy as HTML</guimenuitem>
0273 </menuchoice></term>
0274 <listitem>
0275 <para>Copy the selection as &HTML;, formatted using the current syntax
0276 highlighting and color scheme settings.</para>
0277 </listitem>
0278 </varlistentry>
0279 
0280 <varlistentry id="edit-paste">
0281 <term><menuchoice>
0282 <shortcut>
0283 <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
0284 </shortcut>
0285 <guimenu>Edit</guimenu>
0286 <guimenuitem>Paste</guimenuitem>
0287 </menuchoice></term>
0288 <listitem>
0289 <para>This will insert the first item in the clipboard at the cursor position.
0290 The clipboard works invisibly and provides a way to
0291 transfer data between applications.</para>
0292 <note><para>If Overwrite Selection is enabled, the pasted text will overwrite the selection, if any.</para></note>
0293 </listitem>
0294 </varlistentry>
0295 
0296 <varlistentry id="edit-paste-selection">
0297 <term><menuchoice>
0298 <shortcut>
0299 <keycombo action="simul">&Ctrl;&Shift;&Ins;</keycombo>
0300 </shortcut>
0301 <guimenu>Edit</guimenu>
0302 <guimenuitem>Paste Selection</guimenuitem>
0303 </menuchoice></term>
0304 <listitem>
0305 <para>This will paste the <ulink url="https://en.wikipedia.org/wiki/Clipboard_(computing)#X_Window_System">mouse selection</ulink> contents that were chosen previously. Mark some text with the mouse pointer to paste it in the currently open file using this menu item.</para>
0306 </listitem>
0307 </varlistentry>
0308 
0309 <varlistentry id="edit-swap-with-clipboard-contents">
0310 <term><menuchoice>
0311 <guimenu>Edit</guimenu>
0312 <guimenuitem>Swap with clipboard contents</guimenuitem>
0313 </menuchoice></term>
0314 <listitem>
0315 <para>This will swap the selected text with the <ulink url="https://en.wikipedia.org/wiki/Clipboard_(computing)#X_Window_System">clipboard</ulink> contents.</para>
0316 </listitem>
0317 </varlistentry>
0318 
0319 <varlistentry id="edit-clipboard-history">
0320 <term><menuchoice>
0321 <guimenu>Edit</guimenu>
0322 <guimenuitem>Clipboard History Paste</guimenuitem>
0323 </menuchoice></term>
0324 <listitem>
0325 <para>This will open a dialog to select and paste an entry from the clipboard history.</para>
0326 </listitem>
0327 </varlistentry>
0328 
0329 <varlistentry id="edit-input-modes">
0330 <term><menuchoice>
0331 <guimenu>Edit</guimenu>
0332 <guimenuitem>Input Modes</guimenuitem>
0333 </menuchoice></term>
0334 <listitem>
0335 <para>Switch between a normal and a vi-like, modal editing mode. The vi input mode supports the most used commands
0336 and motions from vim's normal and visual mode and has an optional vi mode statusbar.
0337 This status bar shows commands while they are being entered, output from commands and
0338 the current mode. The behavior of this mode can be configured in the
0339 <link linkend="pref-edit-vi-input-mode">Vi Input Mode</link> tab of the
0340 <guilabel>Editing</guilabel> page in &kappname;'s settings dialog.</para>
0341 </listitem>
0342 </varlistentry>
0343 
0344 <varlistentry id="edit-overwrite-mode">
0345 <term><menuchoice>
0346 <shortcut>
0347 <keycombo action="simul">&Ins;</keycombo>
0348 </shortcut>
0349 <guimenu>Edit</guimenu>
0350 <guimenuitem>Overwrite Mode</guimenuitem>
0351 </menuchoice></term>
0352 <listitem>
0353 <para>Toggles the Insert/Overwrite modes. When the mode is <guilabel>INS</guilabel>, you
0354 insert characters where the cursor is. When the mode is <guilabel>OVR</guilabel>, writing
0355 characters will replace the current characters if your cursor is positioned
0356 before any character. The status bar shows the current state of the Overwrite
0357 Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para>
0358 </listitem>
0359 </varlistentry>
0360 
0361 <varlistentry id="edit-read-only">
0362 <term><menuchoice>
0363 <guimenu>Edit</guimenu>
0364 <guimenuitem>Read Only Mode</guimenuitem>
0365 </menuchoice></term>
0366 <listitem>
0367 <para>Set the current document to Read Only mode. This prevents any text
0368 addition and any changes in the document formatting.</para>
0369 </listitem>
0370 </varlistentry>
0371 
0372 <varlistentry id="edit-find">
0373 <term><menuchoice>
0374 <shortcut>
0375 <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
0376 </shortcut>
0377 <guimenu>Edit</guimenu>
0378 <guimenuitem>Find...</guimenuitem>
0379 </menuchoice></term>
0380 <listitem>
0381 <para>This opens the incremental search bar at the bottom of the editor window.
0382 On the left side of the bar is a button with an icon to close the bar, followed by a small text
0383 box for entering the search pattern.</para>
0384 <para>When you start entering characters of your search pattern, the search starts
0385 immediately. If there is a match in the text this is highlighted and the background color
0386 of the entry field changes to light green. If the search pattern does not match any
0387 string in the text, this is indicated by a light red background color of the entry field.</para>
0388 <para>Use the
0389 <inlinemediaobject><imageobject><imagedata fileref="arrow-up-double-22.png" format="PNG"/></imageobject></inlinemediaobject> or
0390 <inlinemediaobject><imageobject><imagedata fileref="arrow-down-double-22.png" format="PNG"/></imageobject></inlinemediaobject> button
0391 to jump to the next or previous match in the document.</para>
0392 <para>Matches in the document are highlighted even when you close the search bar. To clear
0393 this highlighting, press the &Esc; key.</para>
0394 <para>You can choose whether the search should be case sensitive.
0395 Selecting <inlinemediaobject><imageobject><imagedata fileref="format-text-superscript-22.png" format="PNG"/></imageobject></inlinemediaobject>
0396 will limit finds to entries that match the
0397 case (upper or lower) of each of the characters in the search  pattern.
0398 </para>
0399 <para>Click on the <inlinemediaobject><imageobject><imagedata fileref="configure-shortcuts-22.png" format="PNG"/></imageobject></inlinemediaobject>
0400 button at the right side of the incremental search bar to
0401 switch to the power search and replace bar.
0402 </para>
0403 </listitem>
0404 </varlistentry>
0405 
0406 <varlistentry id="edit-find-next">
0407 <term><menuchoice>
0408 <shortcut>
0409 <keycombo action="simul"><keycap>F3</keycap></keycombo>
0410 </shortcut>
0411 <guimenu>Edit</guimenu>
0412 <guisubmenu>Find Variants</guisubmenu>
0413 <guimenuitem>Find Next</guimenuitem>
0414 </menuchoice></term>
0415  <listitem>
0416 <para>This repeats the last find operation, if any, without calling the incremental
0417 search bar, and searching forwards through the document starting from the cursor position.
0418 </para>
0419 </listitem>
0420 </varlistentry>
0421 
0422 <varlistentry id="edit-find-previous">
0423 <term><menuchoice>
0424 <shortcut>
0425 <keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
0426 </shortcut>
0427 <guimenu>Edit</guimenu>
0428 <guisubmenu>Find Variants</guisubmenu>
0429 <guimenuitem>Find Previous</guimenuitem>
0430 </menuchoice></term>
0431 <listitem>
0432 <para>
0433 This repeats the last find operation, if any, without calling the incremental
0434 search bar, and searching backwards instead of forwards through the
0435 document.
0436 </para>
0437 </listitem>
0438 </varlistentry>
0439 
0440 <varlistentry id="edit-find-selected">
0441 <term><menuchoice>
0442 <shortcut>
0443 <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
0444 </shortcut>
0445 <guimenu>Edit</guimenu>
0446 <guisubmenu>Find Variants</guisubmenu>
0447 <guimenuitem>Find Selected</guimenuitem>
0448 </menuchoice></term>
0449 <listitem>
0450 <para>Finds next occurrence of selected text.</para>
0451 </listitem>
0452 </varlistentry>
0453 
0454 <varlistentry id="edit-find-selected-backwards">
0455 <term><menuchoice>
0456 <shortcut>
0457 <keycombo action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo>
0458 </shortcut>
0459 <guimenu>Edit</guimenu>
0460 <guisubmenu>Find Variants</guisubmenu>
0461 <guimenuitem>Find Selected Backwards</guimenuitem>
0462 </menuchoice></term>
0463 <listitem>
0464 <para>Finds previous occurrence of selected text.</para>
0465 </listitem>
0466 </varlistentry>
0467 
0468 <varlistentry id="edit-replace">
0469 <term><menuchoice>
0470 <shortcut>
0471 <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
0472 </shortcut>
0473 <guimenu>Edit</guimenu>
0474 <guimenuitem>Replace...</guimenuitem>
0475 </menuchoice></term>
0476 <listitem>
0477 <para>This command opens the power search and replace bar.
0478 On the upper left side of the bar is a button with an icon to close the bar, followed by a small text
0479 box for entering the search pattern.</para>
0480 <para>You can control the search mode by selecting <guilabel>Plain text</guilabel>,
0481 <guilabel>Whole words</guilabel>, <guilabel>Escape sequences</guilabel> or
0482 <guilabel>Regular expression</guilabel> from the drop down box.
0483 </para>
0484 <para>If <guilabel>Escape sequences</guilabel> or <guilabel>Regular expression</guilabel> are
0485 selected, the <guibutton>Add...</guibutton> menuitem at the bottom of the context menu of the text boxes will be enabled
0486 and allows you to add escape sequences or regular expression items to the
0487 search or replace pattern from predefined lists.</para>
0488 <para>Use the
0489 <inlinemediaobject><imageobject><imagedata fileref="arrow-up-double-22.png" format="PNG"/></imageobject></inlinemediaobject> or
0490 <inlinemediaobject><imageobject><imagedata fileref="arrow-down-double-22.png" format="PNG"/></imageobject></inlinemediaobject> button
0491 to jump to the next or previous match in the document.</para>
0492 <para>Enter the text to replace with in the text box labeled <guilabel>Replace</guilabel>
0493 and click the <guibutton>Replace</guibutton> button to replace only the highlighted text or
0494 the <guibutton>Replace All</guibutton> button to replace the search text in the whole document.
0495 </para>
0496 <para>You can modify the search and replace behavior by selecting different
0497 options at the bottom of the bar.
0498 Selecting <inlinemediaobject><imageobject><imagedata fileref="format-text-superscript-22.png" format="PNG"/></imageobject></inlinemediaobject>
0499 will limit finds to entries that match the
0500 case (upper or lower) of each of the characters in the search  pattern.
0501 <inlinemediaobject><imageobject><imagedata fileref="edit-select-all-22.png" format="PNG"/></imageobject></inlinemediaobject>
0502 will search and replace within the current selection only.
0503 The <guilabel>Find All</guilabel> button highlights all matches in the document and shows the
0504 number of found matches in a small popup.
0505 </para>
0506 <para>Click on the <inlinemediaobject><imageobject><imagedata fileref="configure-shortcuts-22.png" format="PNG"/></imageobject></inlinemediaobject>
0507 button at the right side of the power search and replace bar to
0508 switch to the incremental search bar.
0509 </para>
0510 </listitem>
0511 </varlistentry>
0512 
0513 </variablelist>
0514 
0515 </sect1>
0516 
0517 <sect1 id="selection-menu">
0518 
0519 <title>The Selection Menu</title>
0520 
0521 <variablelist>
0522 <varlistentry id="selection-select-all">
0523 <term><menuchoice>
0524 <shortcut>
0525 <keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
0526 </shortcut>
0527 <guimenu>Selection</guimenu>
0528 <guimenuitem>Select All</guimenuitem>
0529 </menuchoice></term>
0530 <listitem>
0531 <para>This will select the entire document. This could be very useful for
0532 copying the entire file to another application.</para>
0533 </listitem>
0534 </varlistentry>
0535 
0536 <varlistentry id="selection-deselect">
0537 <term><menuchoice>
0538 <shortcut>
0539 <keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo>
0540 </shortcut>
0541 <guimenu>Selection</guimenu>
0542 <guimenuitem>Deselect</guimenuitem>
0543 </menuchoice></term>
0544 <listitem>
0545 <para>Deselects the selected text in the editor if any.</para>
0546 </listitem>
0547 </varlistentry>
0548 
0549 <varlistentry id="selection-toggle-block-selection">
0550 <term><menuchoice>
0551 <shortcut>
0552 <keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
0553 </shortcut>
0554 <guimenu>Selection</guimenu>
0555 <guimenuitem>Block Selection Mode</guimenuitem>
0556 </menuchoice></term>
0557 <listitem>
0558 <para>Toggles Selection Mode. When the Selection Mode is <guilabel>BLOCK</guilabel>,
0559 the status bar contains the string <guilabel>[BLOCK]</guilabel> and
0560 you can make vertical selections, &eg; select column 5 to 10 in lines 9 to 15.</para>
0561 </listitem>
0562 </varlistentry>
0563 
0564 <!-- Indent/Unindent no longer in the menu ???, but shortcuts work-->
0565 <!--
0566 <varlistentry id="tools-indent">
0567 <term><menuchoice>
0568 <shortcut>
0569 <keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
0570 </shortcut>
0571 <guimenu>Tools</guimenu>
0572 <guimenuitem>Indent</guimenuitem>
0573 </menuchoice></term>
0574 <listitem>
0575 <para>This increases the paragraph's indentation by one step. The size of the
0576 step depends on the <link linkend="pref-edit-indent"> indentation
0577 settings</link>.</para>
0578 </listitem>
0579 </varlistentry>
0580 
0581 <varlistentry id="tools-unindent">
0582 <term><menuchoice>
0583 <shortcut>
0584 <keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo>
0585 </shortcut>
0586 <guimenu>Tools</guimenu>
0587 <guimenuitem>Unindent</guimenuitem>
0588 </menuchoice></term>
0589 <listitem>
0590 <para>This reduces the paragraph's indentation by one step. The size of the step
0591 depends on the <link linkend="pref-edit-indent"> indentation settings</link>.</para>
0592 </listitem>
0593 </varlistentry>
0594 -->
0595 <varlistentry id="selection-comment">
0596 <term><menuchoice>
0597 <shortcut>
0598 <keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo>
0599 </shortcut>
0600 <guimenu>Selection</guimenu>
0601 <guimenuitem>Comment</guimenuitem>
0602 </menuchoice></term>
0603 <listitem><para>This adds one space to the beginning of the line
0604 where the text cursor is located or to the beginning of any
0605 selected lines.</para>
0606 </listitem>
0607 </varlistentry>
0608 
0609 <varlistentry id="selection-uncomment">
0610 <term><menuchoice>
0611 <shortcut>
0612 <keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo>
0613 </shortcut>
0614 <guimenu>Selection</guimenu>
0615 <guimenuitem>Uncomment</guimenuitem>
0616 </menuchoice></term>
0617 <listitem><para>This removes one space (if any exist) from the beginning of the
0618 line where the text cursor is located or from the beginning of any
0619 selected lines.</para></listitem>
0620 </varlistentry>
0621 
0622 <varlistentry id="selection-join-lines">
0623 <term><menuchoice>
0624 <shortcut>
0625 <keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo>
0626 </shortcut>
0627 <guimenu>Selection</guimenu>
0628 <guimenuitem>Join Lines</guimenuitem>
0629 </menuchoice></term>
0630 <listitem><para>Joins the selected lines, or the current line and the line below
0631 with one white space character as a separator. Leading/trailing white space on
0632 joined lines is removed in the affected ends.</para></listitem>
0633 </varlistentry>
0634 
0635 <varlistentry id="selection-capitalization">
0636 <term><menuchoice>
0637 <shortcut>
0638 <keycombo action="simul">&Ctrl;&Alt;<keycap>U</keycap></keycombo>
0639 </shortcut>
0640 <guimenu>Selection</guimenu>
0641 <guimenuitem>Capitalization</guimenuitem>
0642 </menuchoice></term>
0643 <listitem><para>Capitalize the selected text or the current
0644 word.</para></listitem>
0645 </varlistentry>
0646 
0647 <varlistentry id="selection-uppercase">
0648 <term><menuchoice>
0649 <shortcut>
0650 <keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo>
0651 </shortcut>
0652 <guimenu>Selection</guimenu>
0653 <guimenuitem>Uppercase</guimenuitem>
0654 </menuchoice></term>
0655 <listitem><para>Put the selected text or the letter after the cursor in
0656 uppercase.</para></listitem>
0657 </varlistentry>
0658 
0659 <varlistentry id="selection-lowercase">
0660 <term><menuchoice>
0661 <shortcut>
0662 <keycombo action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo>
0663 </shortcut>
0664 <guimenu>Selection</guimenu>
0665 <guimenuitem>Lowercase</guimenuitem>
0666 </menuchoice></term>
0667 <listitem><para>Put the selected text or the letter after the cursor in
0668 lowercase.</para></listitem>
0669 </varlistentry>
0670 
0671 <varlistentry id="selection-cleanindent">
0672 <term><menuchoice>
0673 <guimenu>Selection</guimenu>
0674 <guimenuitem>Clean Indentation</guimenuitem>
0675 </menuchoice></term>
0676 <listitem>
0677 <para>This cleans the indentation for the current selection or for the
0678 line the cursor is currently in. Cleaning the indentation ensures that
0679 all your selected text follows the indentation mode you choose.</para>
0680 </listitem>
0681 </varlistentry>
0682 
0683 <varlistentry id="selection-formatindent">
0684 <term><menuchoice>
0685 <guimenu>Selection</guimenu>
0686 <guimenuitem>Format Indent</guimenuitem>
0687 </menuchoice></term>
0688 <listitem>
0689 <para>Causes a realign of the current line or selected lines using the
0690 indentation mode and indentation settings in the document.</para>
0691 </listitem>
0692 </varlistentry>
0693 
0694 <varlistentry id="selection-alignon">
0695 <term><menuchoice>
0696 <guimenu>Selection</guimenu>
0697 <guimenuitem>Align On...</guimenuitem>
0698 </menuchoice></term>
0699 <listitem>
0700 <para>This command aligns lines in the selected block or whole document on the column given by a regular expression that you will be prompted for.</para>
0701 <para>If you give an empty pattern it will align on the first non-blank character by default.</para>
0702 <para>If the pattern has a capture it will indent on the captured match.</para>
0703 <para><emphasis>Examples:</emphasis></para>
0704 <para>With '<userinput>-</userinput>' it will insert spaces before the first '-' of each lines to align them all on the same column.</para>
0705 <para>With '<userinput>alignon :\\s+(.)</userinput>' it will insert spaces before the first non-blank character that occurs after a colon to align them all on the same column.</para>
0706 </listitem>
0707 </varlistentry>
0708 
0709 <varlistentry id="selection-word-wrap-document">
0710 <term><menuchoice>
0711 <guimenu>Selection</guimenu>
0712 <guimenuitem>Apply Word Wrap</guimenuitem>
0713 </menuchoice></term>
0714 <listitem><para>Apply static word wrapping on all the document. That means that
0715 a new line of text will automatically start when the current
0716 line exceeds the length specified by the <guilabel>Wrap words at</guilabel> option
0717 in the Editing tab in <menuchoice>
0718 <guimenu>Settings</guimenu><guimenuitem>Configure
0719 Editor...</guimenuitem></menuchoice> menu.</para></listitem>
0720 </varlistentry>
0721 
0722 <varlistentry id="selection-add-caret-above-cursor">
0723 <term><menuchoice>
0724 <shortcut>
0725 <keycombo action="simul">&Ctrl;&Alt;&Up;</keycombo>
0726 </shortcut>
0727 <guimenu>Selection</guimenu>
0728 <guimenuitem>Add Caret above Cursor</guimenuitem>
0729 </menuchoice></term>
0730 <listitem><para>Adds another caret above the current cursor. The caret is placed in the line directly above and in the same column as the current cursor.
0731 </para></listitem>
0732 </varlistentry>
0733 
0734 <varlistentry id="selection-add-caret-below-cursor">
0735 <term><menuchoice>
0736 <shortcut>
0737 <keycombo action="simul">&Ctrl;&Alt;&Down;</keycombo>
0738 </shortcut>
0739 <guimenu>Selection</guimenu>
0740 <guimenuitem>Add Caret below Cursor</guimenuitem>
0741 </menuchoice></term>
0742 <listitem><para>Adds another caret below the current cursor. The caret is placed in the line directly above and in the same column as the current cursor.
0743 </para></listitem>
0744 </varlistentry>
0745 
0746 <varlistentry id="selection-add-cursors-to-line-ends">
0747 <term><menuchoice>
0748 <shortcut>
0749 <keycombo action="simul">&Alt;&Shift;<keycap>I</keycap></keycombo>
0750 </shortcut>
0751 <guimenu>Selection</guimenu>
0752 <guimenuitem>Add Cursors to Line Ends</guimenuitem>
0753 </menuchoice></term>
0754 <listitem><para>Adds a cursor to every currently selected line.
0755 </para></listitem>
0756 </varlistentry>
0757 
0758 <varlistentry id="selection-find-and-select-next-occurrence">
0759 <term><menuchoice>
0760 <shortcut>
0761 <keycombo action="simul">&Alt;<keycap>J</keycap></keycombo>
0762 </shortcut>
0763 <guimenu>Selection</guimenu>
0764 <guimenuitem>Find and Select Next Occurrence</guimenuitem>
0765 </menuchoice></term>
0766 <listitem><para>Finds the next occurrence of the word currently under the cursor, selects it and adds a cursor.
0767 </para></listitem>
0768 </varlistentry>
0769 
0770 <varlistentry id="selection-find-and-select-all-occurrences">
0771 <term><menuchoice>
0772 <shortcut>
0773 <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>J</keycap></keycombo>
0774 </shortcut>
0775 <guimenu>Selection</guimenu>
0776 <guimenuitem>Find and Select All Occurrences</guimenuitem>
0777 </menuchoice></term>
0778 <listitem><para>Finds all occurrences of the word currently under the cursor, selects them and adds a cursor for each of them.
0779 </para></listitem>
0780 </varlistentry>
0781 
0782 </variablelist>
0783 
0784 </sect1>
0785 
0786 <sect1 id="view-menu">
0787 
0788 <title>The View Menu</title>
0789 
0790 <variablelist>
0791 
0792 <varlistentry id="view-enlarge-font">
0793 <term><menuchoice>
0794 <shortcut>
0795 <keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo>
0796 </shortcut>
0797 <guimenu>View</guimenu>
0798 <guimenuitem>Enlarge Font</guimenuitem>
0799 </menuchoice></term>
0800 <listitem><para>This increases the display font size.</para></listitem>
0801 </varlistentry>
0802 
0803 <varlistentry id="view-shrink-font">
0804 <term><menuchoice>
0805 <shortcut>
0806 <keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo>
0807 </shortcut>
0808 <guimenu>View</guimenu>
0809 <guimenuitem>Shrink Font</guimenuitem>
0810 </menuchoice></term>
0811 <listitem><para>This decreases the display font size.</para></listitem>
0812 </varlistentry>
0813 
0814 <varlistentry id="view-dynamic-word-wrap">
0815 <term><menuchoice>
0816 <shortcut>
0817 <keycombo action="simul"><keycap>F10</keycap></keycombo>
0818 </shortcut>
0819 <guimenu>View</guimenu>
0820 <guisubmenu>Word Wrap</guisubmenu>
0821 <guimenuitem>Dynamic Word Wrap</guimenuitem>
0822 </menuchoice></term>
0823 <listitem><para>Toggles dynamic word wrap in the current view. Dynamic word
0824 wrap makes all the text in a view visible without the need for horizontal
0825 scrolling by rendering one actual line on more visual lines as needed.</para>
0826 </listitem>
0827 </varlistentry>
0828 
0829 <varlistentry id="view-dynamic-word-wrap-indicators">
0830 <term><menuchoice>
0831 <guimenu>View</guimenu>
0832 <guisubmenu>Word Wrap</guisubmenu>
0833 <guisubmenu>Dynamic Word Wrap Indicators</guisubmenu>
0834 </menuchoice></term>
0835 <listitem>
0836 <para>Choose when and how the dynamic word wrap indicators should be
0837 displayed. This is only available if the <guilabel>Dynamic Word
0838 Wrap</guilabel> option is checked.</para>
0839 </listitem>
0840 </varlistentry>
0841 
0842 <varlistentry id="view-show-statik-word-wrap-markers">
0843 <term><menuchoice>
0844 <guimenu>View</guimenu>
0845 <guisubmenu>Word Wrap</guisubmenu>
0846 <guimenuitem>Show Static Word Wrap Marker</guimenuitem>
0847 </menuchoice></term>
0848 <listitem>
0849 <para>If this option is checked, a vertical line will be drawn at the
0850 word wrap column as defined in the <menuchoice>
0851 <guimenu>Settings</guimenu>
0852 <guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the
0853 Editing tab. Please note that the word wrap marker is only drawn if you
0854 use a fixed pitch font.</para>
0855 </listitem>
0856 </varlistentry>
0857 
0858 <varlistentry id="view-show-icon-border">
0859 <term><menuchoice>
0860 <shortcut>
0861 <keycombo action="simul"><keycap>F6</keycap></keycombo>
0862 </shortcut>
0863 <guimenu>View</guimenu>
0864 <guisubmenu>Borders</guisubmenu>
0865 <guimenuitem>Show Icon Border</guimenuitem>
0866 </menuchoice></term>
0867 <listitem>
0868 <para>This is a toggle item. Setting it on checked will make the Icon Border
0869 visible in the left side of the active editor, and vice versa. The Icon Border
0870 indicates the positions of the marked lines in the editor.</para>
0871 </listitem>
0872 </varlistentry>
0873 
0874 <varlistentry id="view-show-line-numbers">
0875 <term><menuchoice>
0876 <shortcut>
0877 <keycombo action="simul"><keycap>F11</keycap></keycombo>
0878 </shortcut>
0879 <guimenu>View</guimenu>
0880 <guisubmenu>Borders</guisubmenu>
0881 <guimenuitem>Show Line Numbers</guimenuitem>
0882 </menuchoice></term>
0883 <listitem>
0884 <para>This is a toggle Item. Setting it on checked will make a pane displaying
0885 the line numbers of the document visible in the left border of the active
0886 editor, and vice versa.</para>
0887 </listitem>
0888 </varlistentry>
0889 
0890 <varlistentry id="view-scrollbar-marks">
0891 <term><menuchoice>
0892 <guimenu>View</guimenu>
0893 <guisubmenu>Borders</guisubmenu>
0894 <guimenuitem>Show Scrollbar Marks</guimenuitem>
0895 </menuchoice></term>
0896 <listitem>
0897 <para>If this option is checked, the view will show marks on the vertical
0898 scrollbar. The marks are equivalent to the marks on the <link
0899 linkend="view-show-icon-border">Icon Border</link>.</para>
0900 </listitem>
0901 </varlistentry>
0902 
0903 <varlistentry id="view-border-show-scrollbar-minimap">
0904 <term><menuchoice>
0905 <guimenu>View</guimenu>
0906 <guisubmenu>Borders</guisubmenu>
0907 <guimenuitem>Show Scrollbar Mini-Map</guimenuitem>
0908 </menuchoice></term>
0909 <listitem><para>This will replace the scrollbar with a visualization of the
0910 current document. For more information on the scrollbar minimap, see
0911 <xref linkend="kate-part-scrollbar-minimap"/>.</para></listitem>
0912 </varlistentry>
0913 
0914 <varlistentry id="view-code-folding">
0915 <term><menuchoice>
0916 <guimenu>View</guimenu>
0917 <guimenuitem>Code Folding</guimenuitem>
0918 </menuchoice></term>
0919 <listitem><para>These options pertain to
0920 <ulink url="help:/katepart/advanced-editing-tools-code-folding.html">code
0921 folding</ulink>:</para>
0922 <variablelist>
0923 
0924 <varlistentry id="view-show-folding-markers">
0925 <term><menuchoice>
0926 <guimenu>View</guimenu>
0927 <guisubmenu>Borders</guisubmenu>
0928 <guisubmenu>Code Folding</guisubmenu>
0929 <guimenuitem>Show Folding Markers</guimenuitem>
0930 </menuchoice></term>
0931 <listitem><para>Toggles the display of the folding marker pane in the left
0932 side of the view.</para></listitem>
0933 </varlistentry>
0934 
0935 <varlistentry id="view-fold-current-node">
0936 <term><menuchoice>
0937 <guimenu>View</guimenu>
0938 <guisubmenu>Code Folding</guisubmenu>
0939 <guimenuitem>Fold Current Node</guimenuitem>
0940 </menuchoice></term>
0941 <listitem><para>Collapse the region that contains the cursor.</para></listitem>
0942 </varlistentry>
0943 
0944 <varlistentry id="view-unfold-current-node">
0945 <term><menuchoice>
0946 <guimenu>View</guimenu>
0947 <guisubmenu>Code Folding</guisubmenu>
0948 <guimenuitem>Unfold Current Node</guimenuitem>
0949 </menuchoice></term>
0950 <listitem><para>Expand the region that contains the cursor.</para></listitem>
0951 </varlistentry>
0952 
0953 <varlistentry id="view-fold-toplevel-nodes">
0954 <term><menuchoice>
0955 <shortcut>
0956 <keycombo action="simul">&Ctrl;&Shift;<keycap>-</keycap></keycombo>
0957 </shortcut>
0958 <guimenu>View</guimenu>
0959 <guisubmenu>Code Folding</guisubmenu>
0960 <guimenuitem>Fold Toplevel Nodes</guimenuitem>
0961 </menuchoice></term>
0962 <listitem><para>Collapse all toplevel regions in the document.
0963 Click on the right pointing triangle to expand all toplevel regions.</para></listitem>
0964 </varlistentry>
0965 
0966 <varlistentry id="view-unfold-toplevel-nodes">
0967 <term><menuchoice>
0968 <shortcut>
0969 <keycombo action="simul">&Ctrl;&Shift;<keycap>+</keycap></keycombo>
0970 </shortcut>
0971 <guimenu>View</guimenu>
0972 <guisubmenu>Code Folding</guisubmenu>
0973 <guimenuitem>Unfold Toplevel Nodes</guimenuitem>
0974 </menuchoice></term>
0975 <listitem><para>Expand all toplevel regions in the document.</para></listitem>
0976 </varlistentry>
0977 </variablelist>
0978 
0979 </listitem>
0980 </varlistentry>
0981 
0982 <varlistentry id="view-show-non-printable-spaces">
0983 <term><menuchoice>
0984 <guimenuitem>Show Non-Printable Spaces</guimenuitem>
0985 </menuchoice></term>
0986 <listitem><para>Show/hide bounding box around non-printable spaces.</para></listitem>
0987 </varlistentry>
0988 
0989 </variablelist>
0990 
0991 </sect1>
0992 
0993 <sect1 id="go-menu">
0994 
0995 <title>The Go Menu</title>
0996 
0997 <variablelist>
0998 <varlistentry id="go-go-to-line">
0999 <term><menuchoice>
1000 <shortcut>
1001 <keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo>
1002 </shortcut>
1003 <guimenu>Go</guimenu>
1004 <guimenuitem>Go to Line...</guimenuitem>
1005 </menuchoice></term>
1006 <listitem>
1007 <para>
1008 This opens the goto line bar at the bottom of the window which is used to have the cursor
1009 jump to a particular line (specified by number) in the document.  The
1010 line number may be entered directly into the text box or graphically by
1011 clicking on the up or down arrow spin controls at the side of the text
1012 box. The little up arrow will increase the line number and the down
1013 arrow decrease it. Close the bar with a click on the button with an icon on the left side of the bar.
1014 </para>
1015 </listitem>
1016 </varlistentry>
1017 
1018 <varlistentry id="go-go-to-previous-editing-line">
1019 <term><menuchoice>
1020 <shortcut>
1021 <keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo>
1022 </shortcut>
1023 <guimenu>Go</guimenu>
1024 <guimenuitem>Go to Previous Editing Line</guimenuitem>
1025 </menuchoice></term>
1026 <listitem>
1027 <para>This action jumps the previous editing line in the <link linkend="multicursor-modifier-configure">multicursor configuration</link>.
1028 </para>
1029 </listitem>
1030 </varlistentry>
1031 
1032 <varlistentry id="go-go-to-next-editing-line">
1033 <term><menuchoice>
1034 <shortcut>
1035 <keycombo action="simul">&Ctrl;&Shift;<keycap>E</keycap></keycombo>
1036 </shortcut>
1037 <guimenu>Go</guimenu>
1038 <guimenuitem>Go to Next Editing Line</guimenuitem>
1039 </menuchoice></term>
1040 <listitem>
1041 <para>This action jumps the next editing line in the <link linkend="multicursor-modifier-configure">multicursor configuration</link>.
1042 </para>
1043 </listitem>
1044 </varlistentry>
1045 
1046 <varlistentry id="go-go-to-previous-modified-line">
1047 <term><menuchoice>
1048 <guimenu>Go</guimenu>
1049 <guimenuitem>Go to Previous Modified Line</guimenuitem>
1050 </menuchoice></term>
1051 <listitem>
1052 <para>Lines that were changed since opening the file are called modified lines. This action jumps the previous modified line.
1053 </para>
1054 </listitem>
1055 </varlistentry>
1056 
1057 <varlistentry id="go-go-to-next-modified-line">
1058 <term><menuchoice>
1059 <guimenu>Go</guimenu>
1060 <guimenuitem>Go to Next Modified Line</guimenuitem>
1061 </menuchoice></term>
1062 <listitem>
1063 <para>Lines that were changed since opening the file are called modified lines. This action jumps the next modified line.
1064 </para>
1065 </listitem>
1066 </varlistentry>
1067 
1068 <varlistentry id="go-go-to-matching-bracket">
1069 <term><menuchoice>
1070 <shortcut>
1071 <keycombo action="simul">&Ctrl;<keycap>6</keycap></keycombo>
1072 </shortcut>
1073 <guimenu>Go</guimenu>
1074 <guimenuitem>Go to Matching Bracket</guimenuitem>
1075 </menuchoice></term>
1076 <listitem>
1077 <para>Move the cursor to the associated opening or closing bracket.</para>
1078 </listitem>
1079 </varlistentry>
1080 
1081 <varlistentry id="go-select-to-matching-bracket">
1082 <term><menuchoice>
1083 <shortcut>
1084 <keycombo action="simul">&Ctrl;&Shift;<keycap>6</keycap></keycombo>
1085 </shortcut>
1086 <guimenu>Go</guimenu>
1087 <guimenuitem>Select to Matching Bracket</guimenuitem>
1088 </menuchoice></term>
1089 <listitem>
1090 <para>Selects the text between associated opening and closing brackets.</para>
1091 </listitem>
1092 </varlistentry>
1093 
1094 <varlistentry id="go-bookmarks-menu">
1095 <term><menuchoice>
1096 <shortcut>
1097 <keycombo action="simul">&Ctrl;&Shift;<keycap>6</keycap></keycombo>
1098 </shortcut>
1099 <guimenu>Go</guimenu>
1100 <guisubmenu>Bookmarks</guisubmenu>
1101 </menuchoice></term>
1102 <listitem>
1103 <para>Below the entries described here, one entry for each bookmark in
1104 the active document will be available. The text will be the first few
1105 words of the marked line. Choose an item to move the cursor to the
1106 start of that line. The editor will scroll as necessary to make that
1107 line visible.</para>
1108 </listitem>
1109 </varlistentry>
1110 
1111 <varlistentry id="go-bookmarks-set-bookmark">
1112 <term><menuchoice>
1113 <shortcut>
1114 <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
1115 </shortcut>
1116 <guimenu>Go</guimenu>
1117 <guisubmenu>Bookmarks</guisubmenu>
1118 <guimenuitem>Set Bookmark</guimenuitem>
1119 </menuchoice></term>
1120 <listitem>
1121 <para>Sets or removes a bookmark in the current line of the active document.
1122 (If it's there, it is removed, otherwise one is set.)</para>
1123 </listitem>
1124 </varlistentry>
1125 
1126 <varlistentry id="go-bookmarks-clear-bookmarks">
1127 <term><menuchoice>
1128 <guimenu>Go</guimenu>
1129 <guisubmenu>Bookmarks</guisubmenu>
1130 <guimenuitem>Clear All Bookmarks</guimenuitem>
1131 </menuchoice></term>
1132 <listitem>
1133 <para>
1134 This command will remove all the markers from the document as well as
1135 the list of markers which is appended at the bottom of this menu item.
1136 </para>
1137 </listitem>
1138 </varlistentry>
1139 
1140 <varlistentry id="go-bookmarks-bookmarks-previous">
1141 <term><menuchoice>
1142 <shortcut>
1143 <keycombo action="simul">&Alt;&PgUp;</keycombo>
1144 </shortcut>
1145 <guimenu>Go</guimenu>
1146 <guisubmenu>Bookmarks</guisubmenu>
1147 <guimenuitem>Previous</guimenuitem>
1148 </menuchoice></term>
1149 <listitem><para>This will move the cursor to beginning of the first above line
1150 with a bookmark. The menuitem text will include the line number and the first
1151 piece of text on the line. This item is only available when there is a bookmark
1152 in a line above the cursor.</para></listitem>
1153 </varlistentry>
1154 
1155 <varlistentry id="go-bookmarks-bookmarks-next">
1156 <term><menuchoice>
1157 <shortcut>
1158 <keycombo action="simul">&Alt;&PgDn;</keycombo>
1159 </shortcut>
1160 <guimenu>Go</guimenu>
1161 <guisubmenu>Bookmarks</guisubmenu>
1162 <guimenuitem>Next</guimenuitem>
1163 </menuchoice></term>
1164 <listitem><para>This will move the cursor to beginning of the next line with a
1165 bookmark. The menuitem text will include the line number and the first piece of
1166 text on the line. This item is only available when there is a bookmark in a line
1167 below the cursor.</para></listitem>
1168 </varlistentry>
1169 
1170 </variablelist>
1171 
1172 </sect1>
1173 
1174 <sect1 id="tools-menu">
1175 
1176 <title>The Tools Menu</title>
1177 
1178 <variablelist>
1179 
1180 <varlistentry id="tools-filetype">
1181 <term><menuchoice>
1182 <guimenu>Tools</guimenu>
1183 <guisubmenu>Mode</guisubmenu>
1184 </menuchoice></term>
1185 <listitem>
1186 <para>Choose the filetype scheme you prefer for the active document. This
1187 overwrites the global filetype mode set in <menuchoice>
1188 <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem></menuchoice>
1189 in the Filetypes tab for your current document only.</para>
1190 </listitem>
1191 </varlistentry>
1192 
1193 <varlistentry id="tools-highlighting">
1194 <term><menuchoice>
1195 <guimenu>Tools</guimenu>
1196 <guisubmenu>Highlighting</guisubmenu>
1197 </menuchoice></term>
1198 <listitem>
1199 <para>Choose the Highlighting scheme you prefer for the active document. This
1200 overwrites the global highlighting mode set in <menuchoice>
1201 <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
1202 </menuchoice> for your current document only.</para>
1203 </listitem>
1204 </varlistentry>
1205 
1206 <varlistentry id="tools-indentation">
1207 <term><menuchoice>
1208 <guimenu>Tools</guimenu>
1209 <guisubmenu>Indentation</guisubmenu>
1210 </menuchoice></term>
1211 <listitem>
1212 <para>Choose the style of indentation you want for your active document.
1213 This overwrites the global indentation mode set in <menuchoice>
1214 <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
1215 </menuchoice> for your current document only.</para>
1216 </listitem>
1217 </varlistentry>
1218 
1219 <varlistentry id="tools-encoding">
1220 <term><menuchoice>
1221 <guimenu>Tools</guimenu>
1222 <guisubmenu>Encoding</guisubmenu>
1223 </menuchoice></term>
1224 <listitem>
1225 <para>You can overwrite the default encoding set in <menuchoice>
1226 <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
1227 </menuchoice> in the <guilabel>Open/Save</guilabel> page
1228 to set a different encoding for your current document. The encoding you
1229 set here will be only valid for your current document.</para>
1230 </listitem>
1231 </varlistentry>
1232 
1233 <varlistentry id="tools-add-byte-mark-order">
1234 <term><menuchoice>
1235 <guimenu>Tools</guimenu>
1236 <guisubmenu>Add Byte Mark Order (BOM)</guisubmenu>
1237 </menuchoice></term>
1238 <listitem>
1239 <para>Checking this action you can explicitly add a byte order mark for unicode
1240 encoded documents. The byte order mark (BOM) is a Unicode character used to signal
1241 the endianness (byte order) of a text file or stream, for more information see
1242 <ulink url="https://en.wikipedia.org/wiki/Byte_order_mark">Byte Order Mark</ulink>.</para>
1243 </listitem>
1244 </varlistentry>
1245 
1246 <varlistentry id="tools-end-of-line">
1247 <term><menuchoice>
1248 <guimenu>Tools</guimenu>
1249 <guisubmenu>End of Line</guisubmenu>
1250 </menuchoice></term>
1251 <listitem>
1252 <para>Choose your preferred end of line mode for your active
1253 document. This overwrites the global end of line mode set in <menuchoice>
1254 <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem>
1255 </menuchoice> for your current document only.</para>
1256 </listitem>
1257 </varlistentry>
1258 
1259 <varlistentry id="tools-scripts">
1260 <term><menuchoice>
1261 <guimenu>Tools</guimenu>
1262 <guisubmenu>Scripts</guisubmenu>
1263 </menuchoice></term>
1264 <listitem>
1265 <para>This submenu contains a list of all scripted actions. The list can easily be
1266 modified by <link linkend="dev-scripting-command-line">writing your
1267 own scripts</link>. This way, &katepart; can be extended with user-defined tools.
1268 </para>
1269 
1270 <variablelist>
1271 
1272 <varlistentry id="tools-scripts-navigation">
1273 <term><menuchoice>
1274 <guimenu>Tools</guimenu>
1275 <guisubmenu>Scripts</guisubmenu>
1276 <guisubmenu>Navigation</guisubmenu>
1277 </menuchoice></term>
1278 <listitem><variablelist>
1279 
1280 <varlistentry id="tools-scripts-navigation-previous-indent">
1281 <term><menuchoice>
1282 <shortcut>
1283 <keycombo action="simul">&Alt;&Shift;&Up;</keycombo>
1284 </shortcut>
1285 <guimenu>Tools</guimenu>
1286 <guisubmenu>Scripts</guisubmenu>
1287 <guisubmenu>Navigation</guisubmenu>
1288 <guimenuitem>Move cursor to previous matching indent</guimenuitem>
1289 </menuchoice></term>
1290 <listitem><para>
1291 Moves the cursor to the first line above the current line that is indented at
1292 the same level as the current line.
1293 </para></listitem>
1294 </varlistentry>
1295 
1296 <varlistentry id="tools-scripts-navigation-next-indent">
1297 <term><menuchoice>
1298 <shortcut>
1299 <keycombo action="simul">&Alt;&Shift;&Down;</keycombo>
1300 </shortcut>
1301 <guimenu>Tools</guimenu>
1302 <guisubmenu>Scripts</guisubmenu>
1303 <guisubmenu>Navigation</guisubmenu>
1304 <guimenuitem>Move cursor to next matching indent</guimenuitem>
1305 </menuchoice></term>
1306 <listitem><para>
1307 Moves the cursor to the first line below the current line that is indented at
1308 the same level as the current line.
1309 </para></listitem>
1310 </varlistentry>
1311 
1312 </variablelist>
1313 </listitem></varlistentry>
1314 
1315 <!--FIXME: Quick Coding -> Expand Abbreviation (CTRL+ALT+#)
1316 https://git.reviewboard.kde.org/r/127601/
1317 Dominik Haumann
1318 A bit experimental right now, therefore I suggest to keep the FIXME for now and not add further docs.
1319 -->
1320 
1321 <varlistentry id="tools-scripts-editing">
1322 <term><menuchoice>
1323 <guimenu>Tools</guimenu>
1324 <guisubmenu>Scripts</guisubmenu>
1325 <guisubmenu>Editing</guisubmenu>
1326 </menuchoice></term>
1327 <listitem><variablelist>
1328 
1329 <varlistentry id="tools-scripts-editing-sort">
1330 <term><menuchoice>
1331 <guimenu>Tools</guimenu>
1332 <guisubmenu>Scripts</guisubmenu>
1333 <guisubmenu>Editing</guisubmenu>
1334 <guimenuitem>Sort Selected Text</guimenuitem>
1335 </menuchoice></term>
1336 <listitem><para>
1337 Sorts the selected text or whole document in ascending order.
1338 </para></listitem>
1339 </varlistentry>
1340 
1341 <varlistentry id="tools-scripts-editing-move-down">
1342 <term><menuchoice>
1343 <shortcut>
1344 <keycombo action="simul">&Ctrl;&Shift;&Down;</keycombo>
1345 </shortcut>
1346 <guimenu>Tools</guimenu>
1347 <guisubmenu>Scripts</guisubmenu>
1348 <guisubmenu>Editing</guisubmenu>
1349 <guimenuitem>Move Lines Down</guimenuitem>
1350 </menuchoice></term>
1351 <listitem><para>
1352 Move selected lines down.
1353 </para></listitem>
1354 </varlistentry>
1355 
1356 <varlistentry id="tools-scripts-editing-move-up">
1357 <term><menuchoice>
1358 <shortcut>
1359 <keycombo action="simul">&Ctrl;&Shift;&Up;</keycombo>
1360 </shortcut>
1361 <guimenu>Tools</guimenu>
1362 <guisubmenu>Scripts</guisubmenu>
1363 <guisubmenu>Editing</guisubmenu>
1364 <guimenuitem>Move Lines Up</guimenuitem>
1365 </menuchoice></term>
1366 <listitem><para>
1367 Move selected lines up.
1368 </para></listitem>
1369 </varlistentry>
1370 
1371 <varlistentry id="tools-scripts-editing-dupe-down">
1372 <term><menuchoice>
1373 <shortcut>
1374 <keycombo action="simul">&Ctrl;&Alt;&Down;</keycombo>
1375 </shortcut>
1376 <guimenu>Tools</guimenu>
1377 <guisubmenu>Scripts</guisubmenu>
1378 <guisubmenu>Editing</guisubmenu>
1379 <guimenuitem>Duplicate Selected Lines Down</guimenuitem>
1380 </menuchoice></term>
1381 <listitem><para>
1382 Duplicates the selected lines down.
1383 </para></listitem>
1384 </varlistentry>
1385 
1386 <varlistentry id="tools-scripts-editing-dupe-up">
1387 <term><menuchoice>
1388 <shortcut>
1389 <keycombo action="simul">&Ctrl;&Alt;&Up;</keycombo>
1390 </shortcut>
1391 <guimenu>Tools</guimenu>
1392 <guisubmenu>Scripts</guisubmenu>
1393 <guisubmenu>Editing</guisubmenu>
1394 <guimenuitem>Duplicate Selected Lines Up</guimenuitem>
1395 </menuchoice></term>
1396 <listitem><para>
1397 Duplicates the selected lines up.
1398 </para></listitem>
1399 </varlistentry>
1400 
1401 <varlistentry id="tools-scripts-editing-uri-encode">
1402 <term><menuchoice>
1403 <guimenu>Tools</guimenu>
1404 <guisubmenu>Scripts</guisubmenu>
1405 <guisubmenu>Editing</guisubmenu>
1406 <guimenuitem>URI-encode selected text</guimenuitem>
1407 </menuchoice></term>
1408 <listitem><para>
1409 Encodes the selected text so that it can be used as part of a query string in a
1410 &URL;, replacing the selection with the encoded text.
1411 </para></listitem>
1412 </varlistentry>
1413 
1414 <varlistentry id="tools-scripts-editing-uri-decode">
1415 <term><menuchoice>
1416 <guimenu>Tools</guimenu>
1417 <guisubmenu>Scripts</guisubmenu>
1418 <guisubmenu>Editing</guisubmenu>
1419 <guimenuitem>URI-decode selected text</guimenuitem>
1420 </menuchoice></term>
1421 <listitem><para>
1422 If part of the query string of a &URL; is selected, this will decode it and
1423 replace the selection with the original raw text.
1424 </para></listitem>
1425 </varlistentry>
1426 
1427 </variablelist></listitem>
1428 </varlistentry>
1429 
1430 <varlistentry id="tools-scripts-emmet">
1431 <term><menuchoice>
1432 <guimenu>Tools</guimenu>
1433 <guisubmenu>Scripts</guisubmenu>
1434 <guisubmenu>Emmet</guisubmenu>
1435 </menuchoice></term>
1436 <listitem><variablelist>
1437 
1438 <varlistentry id="tools-scripts-emmet-expand-abbreviation">
1439 <term><menuchoice>
1440 <guimenu>Tools</guimenu>
1441 <guisubmenu>Scripts</guisubmenu>
1442 <guisubmenu>Emmet</guisubmenu>
1443 <guimenuitem>Expand abbreviation</guimenuitem>
1444 </menuchoice></term>
1445 <listitem><para>
1446 Converts the selected text to a pair of opening and closing &HTML; or &XML; tags.
1447 For example, if <userinput>div</userinput> is selected, this item will replace
1448 that with  <computeroutput>&lt;div&gt;&lt;/div&gt;</computeroutput>.
1449 </para></listitem>
1450 </varlistentry>
1451 
1452 <varlistentry id="tools-scripts-emmet-wrap-with-tag">
1453 <term><menuchoice>
1454 <guimenu>Tools</guimenu>
1455 <guisubmenu>Scripts</guisubmenu>
1456 <guisubmenu>Emmet</guisubmenu>
1457 <guimenuitem>Wrap with tag</guimenuitem>
1458 </menuchoice></term>
1459 <listitem><para>
1460 Wraps the selected text with the tag provided on the
1461 <link linkend="dev-scripting-command-line">command line</link>.
1462 </para></listitem>
1463 </varlistentry>
1464 
1465 <varlistentry id="tools-scripts-emmet-move-cursor-to-matching-tag">
1466 <term><menuchoice>
1467 <guimenu>Tools</guimenu>
1468 <guisubmenu>Scripts</guisubmenu>
1469 <guisubmenu>Emmet</guisubmenu>
1470 <guimenuitem>Move cursor to matching tag</guimenuitem>
1471 </menuchoice></term>
1472 <listitem><para>
1473 If the cursor is inside an opening &HTML;/&XML; tag, this item will move it to the
1474 closing tag.  If the cursor is inside the closing tag, it will instead move it
1475 to the opening tag.
1476 </para></listitem>
1477 </varlistentry>
1478 
1479 <varlistentry id="tools-scripts-emmet-select-tag-inwards">
1480 <term><menuchoice>
1481 <guimenu>Tools</guimenu>
1482 <guisubmenu>Scripts</guisubmenu>
1483 <guisubmenu>Emmet</guisubmenu>
1484 <guimenuitem>Select &HTML;/&XML; tag contents inwards</guimenuitem>
1485 </menuchoice></term>
1486 <listitem><para>
1487 When the cursor is inside a pair of &HTML;/&XML; tags, this option will change the
1488 selection to include the contents of those &HTML;/&XML; tags, without selecting the
1489 tags themselves.
1490 </para></listitem>
1491 </varlistentry>
1492 
1493 <varlistentry id="tools-scripts-emmet-select-tag-outwards">
1494 <term><menuchoice>
1495 <guimenu>Tools</guimenu>
1496 <guisubmenu>Scripts</guisubmenu>
1497 <guisubmenu>Emmet</guisubmenu>
1498 <guimenuitem>Select &HTML;/&XML; tag contents outwards</guimenuitem>
1499 </menuchoice></term>
1500 <listitem><para>
1501 When the cursor is inside a pair of &HTML;/&XML; tags, this item will change the
1502 selection to include the contents of those &HTML;/&XML; tags, including the tags
1503 themselves.
1504 </para></listitem>
1505 </varlistentry>
1506 
1507 <varlistentry id="tools-scripts-emmet-toggle-comment">
1508 <term><menuchoice>
1509 <guimenu>Tools</guimenu>
1510 <guisubmenu>Scripts</guisubmenu>
1511 <guisubmenu>Emmet</guisubmenu>
1512 <guimenuitem>Toggle Comment</guimenuitem>
1513 </menuchoice></term>
1514 <listitem><para>
1515 If the selected portion is not a comment, this item will enclose that portion
1516 in &HTML;/&XML; comments (&eg;
1517 <computeroutput>&lt;!-- selected text --&gt;</computeroutput>). If the selected
1518 portion is a comment, the comment tags will be removed instead.
1519 </para></listitem>
1520 </varlistentry>
1521 
1522 <!--FIXME: (Go to|Select next) (previous|next) edit point -->
1523 
1524 <varlistentry id="tools-scripts-emmet-toggle-delete-tag">
1525 <term><menuchoice>
1526 <guimenu>Tools</guimenu><guisubmenu>Scripts</guisubmenu><guisubmenu>Emmet</guisubmenu>
1527 <guimenuitem>Delete tag under cursor</guimenuitem>
1528 </menuchoice></term>
1529 <listitem><para>
1530 If the cursor is presently inside a &HTML;/&XML; tag, this item will delete the
1531 entire tag.
1532 </para></listitem>
1533 </varlistentry>
1534 
1535 <varlistentry id="tools-scripts-emmet-decrement-number-by-1">
1536 <term><menuchoice>
1537 <guimenu>Tools</guimenu>
1538 <guisubmenu>Scripts</guisubmenu>
1539 <guisubmenu>Emmet</guisubmenu>
1540 <guimenuitem>Decrement number by 1</guimenuitem>
1541 </menuchoice></term>
1542 <listitem><para>
1543 This item will subtract one from the currently selected text, if it is a number.
1544 For example, if <userinput>5</userinput> is selected, it will become
1545 <computeroutput>4</computeroutput>.
1546 </para></listitem>
1547 </varlistentry>
1548 
1549 <varlistentry id="tools-scripts-emmet-decrement-number-by-10">
1550 <term><menuchoice>
1551 <guimenu>Tools</guimenu>
1552 <guisubmenu>Scripts</guisubmenu>
1553 <guisubmenu>Emmet</guisubmenu>
1554 <guimenuitem>Decrement number by 10</guimenuitem>
1555 </menuchoice></term>
1556 <listitem><para>
1557 This item will subtract 10 from the currently selected text, if it is a number.
1558 For example, if <userinput>15</userinput> is selected, it will become
1559 <computeroutput>5</computeroutput>.
1560 </para></listitem>
1561 </varlistentry>
1562 
1563 <varlistentry id="tools-scripts-emmet-decrement-number-by-0_1">
1564 <term><menuchoice>
1565 <guimenu>Tools</guimenu>
1566 <guisubmenu>Scripts</guisubmenu>
1567 <guisubmenu>Emmet</guisubmenu>
1568 <guimenuitem>Decrement number by 0.1</guimenuitem>
1569 </menuchoice></term>
1570 <listitem><para>
1571 This item will subtract 0.1 from the currently selected text, if it is a number.
1572 For example, if <userinput>4.5</userinput> is selected, it will become
1573 <computeroutput>4.4</computeroutput>.
1574 </para></listitem>
1575 </varlistentry>
1576 
1577 <varlistentry id="tools-scripts-emmet-increment-number-by-1">
1578 <term><menuchoice>
1579 <guimenu>Tools</guimenu>
1580 <guisubmenu>Scripts</guisubmenu>
1581 <guisubmenu>Emmet</guisubmenu>
1582 <guimenuitem>Increment number by 1</guimenuitem>
1583 </menuchoice></term>
1584 <listitem><para>
1585 This item will add one to the currently selected text, if it is a number.
1586 For example, if <userinput>5</userinput> is selected, it will become
1587 <computeroutput>6</computeroutput>.
1588 </para></listitem>
1589 </varlistentry>
1590 
1591 <varlistentry id="tools-scripts-emmet-increment-number-by-10">
1592 <term><menuchoice>
1593 <guimenu>Tools</guimenu>
1594 <guisubmenu>Scripts</guisubmenu>
1595 <guisubmenu>Emmet</guisubmenu>
1596 <guimenuitem>Increment number by 10</guimenuitem>
1597 </menuchoice></term>
1598 <listitem><para>
1599 This item will add 10 to the currently selected text, if it is a number.
1600 For example, if <userinput>5</userinput> is selected, it will become
1601 <computeroutput>15</computeroutput>.
1602 </para></listitem>
1603 </varlistentry>
1604 
1605 <varlistentry id="tools-scripts-emmet-increment-number-by-0_1">
1606 <term><menuchoice>
1607 <guimenu>Tools</guimenu>
1608 <guisubmenu>Scripts</guisubmenu>
1609 <guisubmenu>Emmet</guisubmenu>
1610 <guimenuitem>Increment number by 0.1</guimenuitem>
1611 </menuchoice></term>
1612 <listitem><para>
1613 This item will add 0.1 to the currently selected text, if it is a number.
1614 For example, if <userinput>4.5</userinput> is selected, it will become
1615 <computeroutput>4.6</computeroutput>.
1616 </para></listitem>
1617 </varlistentry>
1618 
1619 </variablelist></listitem>
1620 </varlistentry>
1621 
1622 </variablelist>
1623 
1624 </listitem>
1625 </varlistentry>
1626 
1627 <varlistentry id="tools-command-line">
1628 <term><menuchoice>
1629 <shortcut>
1630 <keycap>F7</keycap>
1631 </shortcut>
1632 <guimenu>Tools</guimenu>
1633 <guimenuitem>Switch to Command Line</guimenuitem>
1634 </menuchoice></term>
1635 <listitem>
1636 <para>Displays the &katepart; command line at the bottom of the window.
1637 In the command line, type <userinput>help</userinput> to get help and <userinput>help list</userinput>
1638 to get a list of commands.  For more information on the command line, see
1639 <link linkend="advanced-editing-tools-commandline">The Editor
1640 Component Command Line</link>.</para>
1641 </listitem>
1642 </varlistentry>
1643 
1644 <varlistentry id="tools-invoke-code-completition">
1645 <term><menuchoice>
1646 <shortcut>
1647 <keycombo action="simul">&Ctrl;&Space;</keycombo>
1648 </shortcut>
1649 <guimenu>Tools</guimenu>
1650 <guimenuitem>Invoke Code Completion</guimenuitem>
1651 </menuchoice></term>
1652 <listitem>
1653 <para>Manually invoke command completion, usually by using a shortcut bound to this action.</para>
1654 </listitem>
1655 </varlistentry>
1656 
1657 <varlistentry id="tools-word-completition">
1658 <term><menuchoice>
1659 <guimenu>Tools</guimenu>
1660 <guimenuitem>Word Completion</guimenuitem>
1661 </menuchoice></term>
1662 <listitem>
1663 <para><guimenuitem>Reuse Word Below</guimenuitem> (<keycombo action="simul">&Ctrl;
1664 <keycap>9</keycap></keycombo>) and <guimenuitem>Reuse Word Above</guimenuitem>
1665 (<keycombo action="simul">&Ctrl; <keycap>8</keycap></keycombo>) complete the
1666 currently typed text by searching for similar
1667 words backward or forward from the current cursor position. <guimenuitem>Shell
1668 Completion</guimenuitem> pops up a completion box with matching entries.</para>
1669 </listitem>
1670 </varlistentry>
1671 
1672 <varlistentry id="spelling-automatic-spell-checking">
1673 <term><menuchoice>
1674 <shortcut>
1675 <keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
1676 </shortcut>
1677 <guimenu>Tools</guimenu>
1678 <guisubmenu>Spelling</guisubmenu>
1679 <guimenuitem>Automatic Spell Checking</guimenuitem>
1680 </menuchoice></term>
1681 <listitem>
1682 <para>When <guimenuitem>Automatic Spell Checking</guimenuitem> is enabled, wrongly spelled text
1683 is underlined in the document on-the-fly.</para>
1684 </listitem>
1685 </varlistentry>
1686 
1687 <varlistentry id="spelling-spelling">
1688 <term><menuchoice>
1689 <guimenu>Tools</guimenu>
1690 <guisubmenu>Spelling</guisubmenu>
1691 <guimenuitem>Spelling...</guimenuitem>
1692 </menuchoice></term>
1693 
1694 <!--para>These options are described in the documentation for the
1695 <ulink url="help:/sonnet/index.html">Check Spelling Dialog</ulink>.</para
1696 Move / merge the following into kdelibs/doc/sonnet/index.docbook and replace it with the para above
1697 -->
1698 
1699 <listitem><para><action>This initiates the spellchecking program - a program
1700 designed to help the user catch and correct any spelling errors.</action>
1701 Clicking on this entry will start the checker and bring up the speller dialog
1702 box through which the user can control the process.  There are four settings
1703 lined up vertically in the center of the dialog with their corresponding labels
1704 just to the left.  Starting at the top they are:</para>
1705 
1706 <variablelist>
1707 
1708 <varlistentry>
1709 <term><guilabel>Unknown word:</guilabel></term>
1710 <listitem><para>Here, the spellchecker indicates the word currently under
1711 consideration.  This happens when the checker encounters a word not in its
1712 dictionary - a file containing a list of correctly spelled words against which
1713 it compares each word in the editor.</para></listitem>
1714 </varlistentry>
1715 
1716 <varlistentry>
1717 <term><guilabel>Replace with:</guilabel></term>
1718 <listitem><para> If the checker has any similar words in its dictionary the
1719 first one will be listed here.  The user can accept the suggestion, type in his
1720 or her own correction, or choose a different suggestion from the next
1721 box.</para></listitem>
1722 </varlistentry>
1723 <varlistentry>
1724 <term><guilabel>Language:</guilabel></term>
1725 <listitem><para> If you have installed multiple dictionaries, here you can
1726 select which dictionary/language should be used.</para></listitem>
1727 </varlistentry>
1728 </variablelist>
1729 
1730 <para>On the right side of the dialog box are 6 buttons that allow the user to
1731 control the spellcheck process.  They are:</para>
1732 
1733 <variablelist>
1734 
1735 <varlistentry>
1736 <term><guibutton>Add to Dictionary</guibutton></term>
1737 <listitem><para>Pressing this button adds the <guilabel>Unknown word
1738 </guilabel> to the checker's dictionary. This means that in the future
1739 the checker will always consider this word to be correctly
1740 spelled.</para></listitem>
1741 </varlistentry>
1742 
1743 <varlistentry>
1744 <term><guilabel>Suggest</guilabel></term>
1745 <listitem><para> The checker may list here a number of possible replacements for
1746 the word under consideration.  Clicking on any one of the suggestions will cause
1747 that word to be entered in the <guilabel>Replace with</guilabel> box,
1748 above.</para></listitem>
1749 </varlistentry>
1750 
1751 <varlistentry>
1752 <term><guibutton>Replace</guibutton></term>
1753 <listitem><para> This button has the checker replace the word under
1754 consideration in the document with the word in the
1755 <guilabel>Replace with</guilabel> box.</para></listitem>
1756 </varlistentry>
1757 
1758 <varlistentry>
1759 <term><guibutton>Replace All</guibutton></term>
1760 <listitem><para> This button causes the checker to replace not only the current
1761 <guilabel>Unknown word:</guilabel> but to automatically make the same
1762 substitution for any other occurrences of this <guilabel>Unknown word</guilabel>
1763 in the document.</para></listitem>
1764 </varlistentry>
1765 
1766 <varlistentry>
1767 <term><guibutton>Ignore</guibutton></term>
1768 <listitem><para>Activating this button will have the checker move on without
1769 making any changes.</para></listitem>
1770 </varlistentry>
1771 
1772 <varlistentry>
1773 <term><guibutton>Ignore All</guibutton></term>
1774 <listitem><para> This button tells the checker to do nothing with the current
1775 <guilabel>Unknown word:</guilabel> and to pass over any other instances of
1776 the same word.</para> <note><para>This only applies to the current spellcheck
1777 run.  If the checker is run again later it will stop on this same
1778 word.</para></note></listitem>
1779 </varlistentry>
1780 
1781 </variablelist>
1782 
1783 <para>Three more buttons are located horizontally along the bottom of the
1784 spellcheck dialog.  They are:</para>
1785 
1786 <variablelist>
1787 
1788 <varlistentry>
1789 <term><guibutton>Help</guibutton></term>
1790 <listitem><para> This invokes the &kde; help system with the help page
1791 for this dialog.</para></listitem>
1792 </varlistentry>
1793 
1794 <varlistentry>
1795 <term><guibutton>Finished</guibutton></term>
1796 <listitem><para> This button ends the spellcheck process, and returns to the
1797 document.</para></listitem>
1798 </varlistentry>
1799 
1800 <varlistentry>
1801 <term><guibutton>Cancel</guibutton></term>
1802 <listitem><para> This button cancels the spellcheck process, all modifications
1803 are reverted, and you will return to your document.</para></listitem>
1804 </varlistentry>
1805 
1806 </variablelist>
1807 
1808 </listitem>
1809 
1810 </varlistentry>
1811 
1812 <varlistentry id="tools-spelling-from-cursor">
1813 <term><menuchoice>
1814 <guimenu>Tools</guimenu>
1815 <guisubmenu>Spelling</guisubmenu>
1816 <guimenuitem>Spelling (from cursor)...</guimenuitem>
1817 </menuchoice></term>
1818 <listitem>
1819 <para>This initiates the spellchecking program but it starts where your cursor
1820 is instead of at the beginning of the document.</para>
1821 </listitem>
1822 </varlistentry>
1823 
1824 <varlistentry id="tools-spellcheck-selection">
1825 <term><menuchoice>
1826 <guimenu>Tools</guimenu>
1827 <guisubmenu>Spelling</guisubmenu>
1828 <guimenuitem>Spellcheck Selection...</guimenuitem>
1829 </menuchoice></term>
1830 <listitem>
1831 <para>Spellchecks the current selection.</para>
1832 </listitem>
1833 </varlistentry>
1834 
1835 <varlistentry id="tools-change-dictionary">
1836 <term><menuchoice>
1837 <guimenu>Tools</guimenu>
1838 <guisubmenu>Spelling</guisubmenu>
1839 <guimenuitem>Change Dictionary</guimenuitem>
1840 </menuchoice></term>
1841 <listitem>
1842 <para>Displays a drop down box with all available dictionaries for spellchecking
1843 at the bottom of the editor window. This allows easy switching of the spellcheck
1844 dictionary &eg; for automatic spellcheck of text in different languages.</para>
1845 </listitem>
1846 </varlistentry>
1847 
1848 </variablelist>
1849 </sect1>
1850 
1851 <sect1 id="settings-help-menu">
1852 <title>The Settings and Help Menu</title>
1853 
1854 <variablelist>
1855 <varlistentry id="settings-color-theme">
1856 <term><menuchoice>
1857 <guimenu>Settings</guimenu>
1858 <guisubmenu>Editor Color Theme</guisubmenu>
1859 </menuchoice></term>
1860 <listitem><para>This menu lists the available color schemes. You can change the
1861 schema for the current view here, to change the default schema you need to
1862 use the <ulink url="help:/katepart/config-dialog-editor.html#prefcolors">Fonts
1863 &amp; Colors</ulink> page of the config dialog.</para>
1864 </listitem>
1865 </varlistentry>
1866 </variablelist>
1867 
1868 <para>
1869 &katepart; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
1870 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
1871 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
1872 of the &kde; Fundamentals.
1873 </para>
1874 
1875 </sect1>
1876 </chapter>