<chapter id="the-menu-entries"> <title>The Menu Entries</title> <!-- This is also valid for kates menu file, kate has additional Save All Ctrl+L, Reload All, Close Other, Close All--> <sect1 id="file"> <title>The File Menu</title> <variablelist> <varlistentry> <term id="new"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>New</guimenuitem></menuchoice></term> <listitem> <para> This starts a new document in a new and independent editor window. </para> </listitem> </varlistentry> <varlistentry> <term id="open"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Open...</guimenuitem> </menuchoice> </term> <listitem> <para>Displays a standard &kde; <guilabel>Open File</guilabel> dialog. Use the file view to select the file you want to open, and click on <guibutton>Open</guibutton> to open it.</para> </listitem> </varlistentry> <varlistentry> <term id="open-recent"> <menuchoice> <guimenu>File</guimenu> <guisubmenu>Open Recent</guisubmenu> </menuchoice> </term> <listitem> <para> This is a shortcut to open recently saved documents. Clicking on this item opens a list to the side of the menu with several of the most recently saved files. Clicking on a specific file will open it in &kappname; - if the file still resides at the same location. </para> </listitem> </varlistentry> <varlistentry> <term id="save"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Save</guimenuitem> </menuchoice> </term> <listitem> <para> This saves the current document. If there has already been a save of the document then this will overwrite the previously saved file without asking for the user's consent. If it is the first save of a new document the save as dialog (described below) will be invoked. </para> </listitem> </varlistentry> <varlistentry> <term id="save-as"> <menuchoice> <guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem> </menuchoice> </term> <listitem> <para> This allows a document to be saved with a new file name. This is done by means of the file dialog box described above in the <link linkend="open">Open</link> section of this help file. </para> </listitem> </varlistentry> <varlistentry> <term id="reload"> <menuchoice> <shortcut> <keycombo action="simul"><keycap>F5</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Reload</guimenuitem> </menuchoice> </term> <listitem> <para> Reloads the active file from disk. This command is useful if another program or process has changed the file while you have it open in &kappname;. </para> </listitem> </varlistentry> <varlistentry> <term id="print"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Print...</guimenuitem> </menuchoice> </term> <listitem> <para> Opens a simple print dialog allowing the user to specify what, where, and how to print. </para> </listitem> </varlistentry> <varlistentry> <!-- from plugin Exporter --> <term id="export-as-html"> <menuchoice> <guimenu>File</guimenu> <guimenuitem>Export as HTML</guimenuitem> </menuchoice> </term> <listitem> <para> Export your file in &HTML; format so your document can be viewed as a web page. This item is only displayed when the plugin <guilabel>Exporter</guilabel> is loaded. </para> </listitem> </varlistentry> <varlistentry> <term id="close"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Close</guimenuitem> </menuchoice> </term> <listitem> <para> Close the active file with this command. If you have made unsaved changes, you will be prompted to save the file before &kappname; closes it. </para> </listitem> </varlistentry> <varlistentry> <term id="quit"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Quit</guimenuitem> </menuchoice> </term> <listitem> <para> This will close the editor window, if you have more than one instance of &kappname; running, through the <guimenuitem>New</guimenuitem> or <guimenuitem>New Window</guimenuitem> menu items, those instances will not be closed. </para> </listitem> </varlistentry> </variablelist> </sect1> <sect1 id="edit"> <!-- This is also valid for kates menu edit--> <title>The Edit Menu</title> <variablelist> <varlistentry> <term id="undo"><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem></menuchoice></term> <listitem> <para>This is used to eliminate or reverse the most recent user action or operation. </para> </listitem> </varlistentry> <varlistentry> <term><anchor id="redo"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice></term> <listitem> <para>This will reverse the most recent change (if any) made using Undo</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="cut"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem></menuchoice></term> <listitem> <para>This command deletes the current selection and places it on the clipboard. The clipboard is a feature of &kde; that works invisibly to provide a way to transfer data between applications.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="copy"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice></term> <listitem> <para>This copies the currently selected text to the clipboard so that it may be pasted elsewhere. The clipboard is a feature of &kde; that works invisibly to provide a way to transfer data between applications.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="paste"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem></menuchoice></term> <listitem> <para>This will insert the contents of the clipboard at the cursor position. The clipboard is feature of &kde; that works invisibly to provide a way to transfer data between applications.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="edit-clipboard-history"/> <menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Clipboard History</guisubmenu> </menuchoice> </term> <listitem> <para>This submenu will display the beginning of portions of text recently copied to the clipboard. Select an item from this menu to paste it in the currently open file.</para> </listitem> </varlistentry> <varlistentry><!-- from plugin Exporter --> <term><anchor id="copy-as-html"/><menuchoice> <guimenu>Edit</guimenu><guimenuitem>Copy as HTML</guimenuitem></menuchoice></term> <listitem> <para>This copies the currently selected text to the clipboard as &HTML;. This item is only displayed when the plugin <guilabel>Exporter</guilabel> is loaded. </para> </listitem> </varlistentry> <varlistentry> <term><anchor id="select-all"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Select All</guimenuitem></menuchoice></term> <listitem> <para>This will select the entire document. This could be very useful for copying the entire file to another application.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="deselect"/><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu><guimenuitem>Deselect</guimenuitem></menuchoice></term> <listitem> <para>Deselects the selected text in the editor if any.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="block-selection-mode"/><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu><guimenuitem>Block Selection Mode</guimenuitem></menuchoice></term> <listitem> <para>Toggles Selection Mode. When the Selection Mode is <guilabel>BLOCK</guilabel>, you can make vertical selections, ⪚ select column 5 to 10 in lines 9 to 15. The status bar shows the current state of the Selection Mode, either <guilabel>BLOCK</guilabel> or <guilabel>LINE</guilabel>.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="vi-input-mode"/><menuchoice> <shortcut> <keycombo action="simul"><keysym>Meta</keysym>&Ctrl;<keycap>V</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu><guimenuitem>VI input Mode</guimenuitem></menuchoice></term> <listitem> <para>Switch to a vi-like, modal editing mode. This mode supports the most used commands and motions from vim's normal and visual mode and has an optional vi mode statusbar. This status bar shows commands while they are being entered, output from commands and the current mode.The behavior of this mode can be configured in the <link linkend="pref-edit-vi-input-mode">Vi Input Mode</link> section of the <guilabel>Editing</guilabel> page in &kappname;'s settings dialog.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="overwrite-mode"/><menuchoice> <shortcut> <keycombo action="simul"><keycap>Ins</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu><guimenuitem>Overwrite Mode</guimenuitem></menuchoice></term> <listitem> <para>Toggles the Insert/Overwrite modes. When the mode is <guilabel>INS</guilabel>, you insert characters where the cursor is. When the mode is <guilabel>OVR</guilabel>, writing characters will replace the current characters if your cursor is positioned before any character. The status bar shows the current state of the Overwrite Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="find"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Find...</guimenuitem></menuchoice></term> <listitem> <para>This opens the incremental search bar at the bottom of the editor window. On the left side of the bar is a button with an icon to close the bar, followed by a small text box for entering the search pattern.</para> <para>When you start entering characters of your search pattern, the search starts immediately. If there is a match in the text this is highlighted and the background color of the entry field changes to light green. If the search pattern does not match any string in the text, this is indicated by a light red background color of the entry field and <guilabel>Not found</guilabel> is displayed at the right side of the bar.</para> <para>Use the <guilabel>Next</guilabel> or <guilabel>Previous</guilabel> button to jump to the next or previous match in the document.</para> <para>You can choose whether the search should be case sensitive. Selecting <guilabel>Match Case</guilabel> will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. </para> <para>Click on the button with a green arrow icon at the right side of the incremental search bar to switch to the power search and replace bar. </para> </listitem> </varlistentry> <varlistentry> <term><anchor id="find-again"/><menuchoice> <shortcut><keycombo action="simul"><keycap>F3</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu><guimenuitem>Find Next</guimenuitem></menuchoice></term> <listitem> <para>This repeats the last find operation, if any, without calling the incremental search bar. </para> </listitem> </varlistentry> <varlistentry> <term id="find-previous"> <menuchoice> <shortcut> <keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu> <guimenuitem>Find Previous</guimenuitem> </menuchoice> </term> <listitem> <para> This repeats the last find operation, if any, without calling the incremental search bar, and searching backwards instead of forwards through the document. </para> </listitem> </varlistentry> <varlistentry> <term id="find-selected"> <menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu><guimenuitem>Find Selected</guimenuitem></menuchoice></term> <listitem> <para>Finds next occurrence of selected text.</para> </listitem> </varlistentry> <varlistentry> <term id="find-selected-backwards"> <menuchoice> <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu><guimenuitem>Find Selected Backwards</guimenuitem></menuchoice></term> <listitem> <para>Finds previous occurrence of selected text.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="replace"/><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut> <guimenu>Edit</guimenu><guimenuitem>Replace...</guimenuitem></menuchoice></term> <listitem> <para>This command opens the power search and replace bar. On the upper left side of the bar is a button with an icon to close the bar, followed by a small text box for entering the search pattern.</para> <para>You can control the search mode by selecting <guilabel>Plain text</guilabel>, <guilabel>Whole words</guilabel>, <guilabel>Escape sequences</guilabel> or <guilabel>Regular expression</guilabel> from the drop down box. </para> <para>If <guilabel>Escape sequences</guilabel> or <guilabel>Regular expression</guilabel> are selected, the <guibutton>Add...</guibutton> menuitem at the bottom of the context menu of the text boxes will be enabled and allows you to add escape sequences or regular expression items to the search or replace pattern from predefined lists.</para> <para>Use the <guilabel>Next</guilabel> or <guilabel>Previous</guilabel> button to jump to the next or previous match in the document.</para> <para>Enter the text to replace with in the text box labeled <guilabel>Replace</guilabel> and click the <guibutton>Replace</guibutton> button to replace only the highlighted text or the <guibutton>Replace All</guibutton> button to replace the search text in the whole document. </para> <para>You can modify the search and replace behavior by selecting different options at the bottom of the bar. Selecting <guilabel>Match Case</guilabel> will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. <guilabel>Selection Only</guilabel> will search and replace within the current selection only. The <guilabel>Find All</guilabel> button highlights all matches in the document and shows the number of found matches in a small popup. </para> <para>Click on the button with a green arrow icon at the right side of the power search and replace bar to switch to the incremental search bar. </para> </listitem> </varlistentry> <varlistentry> <term id="go-to-line"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Go to Line...</guimenuitem></menuchoice></term> <listitem> <para> This opens the goto line bar at the bottom of the window which is used to have the cursor jump to a particular line (specified by number) in the document. The line number may be entered directly into the text box or graphically by clicking on the up or down arrow spin controls at the side of the text box. The little up arrow will increase the line number and the down arrow decrease it. Close the bar with a click on the button with an icon on the left side of the bar. </para> </listitem> </varlistentry> </variablelist> </sect1> <sect1 id="view-menu"> <!-- This is also valid for kates menu view --> <title>The View Menu</title> <para>The <guimenu>View</guimenu> menu allows you to manage settings specific to the active editor, and to manage frames.</para> <variablelist> <varlistentry> <term> <anchor id="view-new-window"/> <menuchoice> <guimenu>View</guimenu> <guimenuitem>New Window</guimenuitem> </menuchoice> </term> <listitem> <para>Create another window containing the current document. All changes to the document in one window are reflected in the other window and vice versa.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-command-line"/> <menuchoice> <shortcut><keycombo action="simul"><keycap>F7</keycap></keycombo></shortcut> <guimenu>View</guimenu> <guimenuitem>Switch to Command Line</guimenuitem> </menuchoice> </term> <listitem> <para>Displays the Katepart command line at the bottom of the window. In the command line, type <userinput>help</userinput> to get help and <userinput>help list</userinput> to get a list of commands. For more information on the command line, see <ulink url="help:/kate/advanced-editing-tools-commandline.html">The Editor Component Command Line</ulink>.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>View</guimenu><guimenuitem>Show the Javascript Console</guimenuitem> </menuchoice></term> <listitem><para>This opens a tool view that allows you to run Javascript code interactively. For more information, see <ulink url="help:/kate/dev-scripting.html">Extending &kate; with Scripts</ulink> </para></listitem> </varlistentry> <varlistentry> <term> <anchor id="view-schema"/> <menuchoice> <guimenu>View</guimenu> <guisubmenu>Schema</guisubmenu> </menuchoice> </term> <listitem> <para>Select a font schema.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-dynamic-word-wrap"/> <menuchoice> <shortcut><keycombo action="simul"><keycap>F10</keycap></keycombo></shortcut> <guimenu>View</guimenu> <guimenuitem>Dynamic Word Wrap</guimenuitem> </menuchoice> </term> <listitem> <para>The text lines will be wrapped at the view border on the screen.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-dynamic-word-wrap-indicators"/> <menuchoice> <guimenu>View</guimenu> <guisubmenu>Dynamic Word Wrap Indicators</guisubmenu> </menuchoice> </term> <listitem> <para>Choose when and how the dynamic word wrap indicators should be displayed. This is only available if the <guilabel>Dynamic Word Wrap</guilabel> option is checked.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-show-static-word-wrap"/> <menuchoice> <guimenu>View</guimenu> <guimenuitem>Show Static Word Wrap Marker</guimenuitem> </menuchoice> </term> <listitem> <para>If this option is checked, a vertical line will be drawn at the word wrap column as defined in the <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the Editing tab. Please note that the word wrap marker is only drawn if you use a fixed pitch font.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-show-icon-border"/> <menuchoice> <shortcut><keycombo action="simul"><keycap>F6</keycap></keycombo></shortcut> <guimenu>View</guimenu> <guimenuitem>Show Icon Border</guimenuitem> </menuchoice> </term> <listitem> <para>This is a toggle item. Setting it on checked will make the Icon Border visible in the left side of the active editor, and vice versa. The Icon Border indicates the positions of the marked lines in the editor.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-show-line-numbers"/> <menuchoice> <shortcut><keycombo action="simul"><keycap>F11</keycap></keycombo></shortcut> <guimenu>View</guimenu> <guimenuitem>Show Line Numbers</guimenuitem> </menuchoice> </term> <listitem> <para>This is a toggle Item. Setting it on checked will make a pane displaying the line numbers of the document visible in the left border of the active editor, and vice versa.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-scrollbar-marks"/> <menuchoice> <guimenu>View</guimenu> <guisubmenu>Show Scrollbar Marks</guisubmenu> </menuchoice> </term> <listitem> <para>If this option is checked, the view will show marks on the vertical scrollbar. The marks are equivalent to the marks on the <link linkend="view-show-icon-border">Icon Border</link>.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice><guimenu>View</guimenu><guimenuitem>Show Scrollbar Minimap</guimenuitem></menuchoice></term> <listitem><para>This will replace the scrollbar with a visualization of the current document. For more information on the scrollbar minimap, see <xref linkend="kate-part-scrollbar-minimap"/></para></listitem> </varlistentry> <varlistentry> <term> <anchor id="view-hide-folding-markers"/> <menuchoice> <shortcut><keycombo action="simul"><keycap>F9</keycap></keycombo></shortcut> <guimenu>View</guimenu> <guimenuitem>Show Folding Markers</guimenuitem> </menuchoice> </term> <listitem> <para>If this option is checked, the marks for code folding will be shown.</para> </listitem> </varlistentry> <varlistentry> <term> <anchor id="view-code-folding"/> <menuchoice> <guimenu>View</guimenu> <guisubmenu>Code Folding</guisubmenu> </menuchoice> </term> <listitem> <variablelist> <varlistentry> <term><menuchoice> <guimenuitem>Fold Current Node</guimenuitem></menuchoice> </term> <listitem><para>Collapse the region that contains the cursor.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenuitem>Unfold Current Node</guimenuitem></menuchoice> </term> <listitem><para>Expand the region that contains the cursor.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice><shortcut><keycombo action="simul">&Ctrl; &Shift;<keycap>-</keycap></keycombo></shortcut> <guimenuitem>Fold Toplevel Nodes</guimenuitem></menuchoice> </term> <listitem><para>Collapse all toplevel regions in the document. Click onto the right pointing triangle to expand all toplevel regions.</para></listitem> </varlistentry> <!--FIXME not implemented in 4.11 varlistentry> <term><menuchoice><shortcut><keycombo action="simul">&Ctrl; &Shift;<keycap>+</keycap></keycombo></shortcut> <guimenuitem>Unfold Toplevel Nodes</guimenuitem></menuchoice> </term> <listitem><para>Expand all toplevel regions in the document.</para></listitem> </varlistentry--> </variablelist> </listitem> </varlistentry> <varlistentry> <term><menuchoice><guimenu>View</guimenu> <guimenuitem>Enlarge Font</guimenuitem></menuchoice> </term> <listitem><para>This increases the display font size.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice><guimenu>View</guimenu> <guimenuitem>Shrink Font</guimenuitem></menuchoice> </term> <listitem><para>This decreases the display font size.</para></listitem> </varlistentry> </variablelist> </sect1> <sect1 id="go"><!-- This is also valid for kates menu bookmarks--> <title>The Bookmarks Menu</title> <variablelist> <varlistentry> <term id="set-bookmark"> <menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> </shortcut> <guimenu>Bookmarks</guimenu> <guimenuitem>Set Bookmark</guimenuitem> </menuchoice> </term> <listitem> <para> Sets or removes a bookmark in the current line of the active document. (If it's there, it is removed, otherwise one is set). </para> </listitem> </varlistentry> <varlistentry> <term id="clear-bookmarks"> <menuchoice> <guimenu>Bookmarks</guimenu> <guimenuitem>Clear All Bookmarks</guimenuitem> </menuchoice> </term> <listitem> <para> This command will remove all the markers from the document as well as the list of markers which is appended at the bottom of this menu item. </para> </listitem> </varlistentry> <varlistentry id="bookmarks-previous"> <term><menuchoice><shortcut><keycombo action="simul">&Alt; <keycap>PgUp</keycap></keycombo></shortcut> <guimenu>Bookmarks</guimenu><guimenuitem>Previous</guimenuitem></menuchoice> </term> <listitem><para>This will move the cursor to beginning of the first above line with a bookmark. The menuitem text will include the line number and the first piece of text on the line. This item is only available when there is a bookmark in a line above the cursor.</para></listitem> </varlistentry> <varlistentry id="bookmarks-next"> <term><menuchoice><shortcut><keycombo action="simul">&Alt; <keycap>PgDown</keycap></keycombo></shortcut> <guimenu>Bookmarks</guimenu><guimenuitem>Next</guimenuitem></menuchoice></term> <listitem><para>This will move the cursor to beginning of the next line with a bookmark. The menuitem text will include the line number and the first piece of text on the line. This item is only available when there is a bookmark in a line below the cursor.</para></listitem> </varlistentry> </variablelist> <para> At the bottom of this menu, a list of bookmarks appears if any bookmarks are available for this window. </para> </sect1> <!-- This is also valid for kates menu tools, kate has additional items: Pipe to Terminal, Syncronizise Terminal with Current Document, Focus Terminal at top--> <sect1 id="tools"> <title>The Tools Menu</title> <variablelist> <varlistentry> <term><anchor id="tools-read-only"/><menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Read Only Mode</guimenuitem></menuchoice></term> <listitem> <para>Set the current document to Read Only mode. This prevents any text addition and any changes in the document formatting.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-filetype"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>Mode</guisubmenu></menuchoice></term> <listitem> <para>Choose the filetype scheme you prefer for the active document. This overwrites the global filetype mode set in <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the Filetypes tab for your current document only.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-highlighting"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>Highlighting</guisubmenu></menuchoice></term> <listitem> <para>Choose the Highlighting scheme you prefer for the active document. This overwrites the global highlighting mode set in <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem></menuchoice> for your current document only.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-indentation"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>Indentation</guisubmenu></menuchoice></term> <listitem> <para>Choose the style of indentation you want for your active document. This overwrites the global indentation mode set in <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem></menuchoice> for your current document only.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-encoding"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>Encoding</guisubmenu></menuchoice></term> <listitem> <para>You can overwrite the default encoding set in <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the <guilabel>Open/Save</guilabel> page to set a different encoding for your current document. The encoding you set here will be only valid for your current document.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-end-of-line"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>End of Line</guisubmenu></menuchoice></term> <listitem> <para>Choose your preferred end of line mode for your active document. This overwrites the global end of line mode set in <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem></menuchoice> for your current document only.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-add-byte-mark-order"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>Add Byte Mark Order (BOM)</guisubmenu></menuchoice></term> <listitem> <para>Checking this action you can explicitly add a byte order mark for unicode encoded documents. The byte order mark (BOM) is a Unicode character used to signal the endianness (byte order) of a text file or stream, for more information see <ulink url="http://en.wikipedia.org/wiki/Byte_Order_Mark">Byte Order Mark</ulink>.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-scripts"/><menuchoice> <guimenu>Tools</guimenu> <guisubmenu>Scripts</guisubmenu></menuchoice></term> <listitem> <para>This submenu contains a list of all scripted actions. The list can easily be modified by <ulink url="help:/kate/dev-scripting.html#dev-scripting-command-line">writing own scripts</ulink>. This way, &kwrite; can be extended with user-defined tools. </para> <para>For more information about the scripts included with &kate;, see <ulink url="help:/kate/scripts.html">Scripts</ulink>.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Invoke Code Completion</guimenuitem> </menuchoice></term> <listitem> <para>Manually invoke command completion, usually by using a shortcut bound to this action.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Word Completion</guimenuitem> </menuchoice></term> <listitem> <para><guimenuitem>Reuse Word Below</guimenuitem> (<keycombo action="simul">&Ctrl; <keycap>9</keycap></keycombo>) and <guimenuitem>Reuse Word Above</guimenuitem> (<keycombo action="simul">&Ctrl; <keycap>8</keycap></keycombo>) complete the currently typed text by searching for similar words backward or forward from the current cursor position. <guimenuitem>Shell Completion</guimenuitem> pops up a completion box with matching entries.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu> <guimenuitem>Automatic Spell Checking</guimenuitem> </menuchoice></term> <listitem> <para>When <guimenuitem>Automatic Spell Checking</guimenuitem> is enabled, wrong text is underlined in the document on-the-fly.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="Spelling..."/><menuchoice> <guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu><guimenuitem>Spelling...</guimenuitem></menuchoice> </term> <!--para>These options are described in the documentation for the <ulink url="help:/sonnet/index.html">Check Spelling Dialog</ulink>.</para Move / merge the following into kdelibs/doc/sonnet/index.docbook and replace it with the para above --> <listitem><para><action>This initiates the spellchecking program - a program designed to help the user catch and correct any spelling errors.</action> Clicking on this entry will start the checker and bring up the speller dialog box through which the user can control the process. There are four settings lined up vertically in the center of the dialog with their corresponding labels just to the left. Starting at the top they are:</para> <variablelist> <varlistentry> <term><guilabel>Unknown word:</guilabel></term> <listitem><para>Here, the spellchecker indicates the word currently under consideration. This happens when the checker encounters a word not in its dictionary - a file containing a list of correctly spelled words against which it compares each word in the editor.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Replace with:</guilabel></term> <listitem><para> If the checker has any similar words in its dictionary the first one will be listed here. The user can accept the suggestion, type in his or her own correction, or choose a different suggestion from the next box.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Language:</guilabel></term> <listitem><para> If you have installed multiple dictionaries, here you can select which dictionary/language should be used.</para></listitem> </varlistentry> </variablelist> <para>On the right side of the dialog box are 6 buttons that allow the user to control the spellcheck process. They are:</para> <variablelist> <varlistentry> <term><guibutton>Add to Dictionary</guibutton></term> <listitem><para>Pressing this button adds the <guilabel>Unknown word </guilabel> to the checker's dictionary. This means that in the future the checker will always consider this word to be correctly spelled.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Suggest</guilabel></term> <listitem><para> The checker may list here a number of possible replacements for the word under consideration. Clicking on any one of the suggestions will cause that word to be entered in the <guilabel>Replace with</guilabel> box, above.</para></listitem> </varlistentry> <varlistentry> <term><guibutton>Replace</guibutton></term> <listitem><para> This button has the checker replace the word under consideration in the document with the word in the <guilabel>Replace with</guilabel> box.</para></listitem> </varlistentry> <varlistentry> <term><guibutton>Replace All</guibutton></term> <listitem><para> This button causes the checker to replace not only the current <guilabel>Unknown word:</guilabel> but to automatically make the same substitution for any other occurrences of this <guilabel>Unknown word</guilabel> in the document.</para></listitem> </varlistentry> <varlistentry> <term><guibutton>Ignore</guibutton></term> <listitem><para>Activating this button will have the checker move on without making any changes.</para></listitem> </varlistentry> <varlistentry> <term><guibutton>Ignore All</guibutton></term> <listitem><para> This button tells the checker to do nothing with the current <guilabel>Unknown word:</guilabel> and to pass over any other instances of the same word.</para> <note><para>This only applies to the current spellcheck run. If the checker is run again later it will stop on this same word.</para></note></listitem> </varlistentry> </variablelist> <para>Three more buttons are located horizontally along the bottom of the spellcheck dialog. They are:</para> <variablelist> <varlistentry> <term><guibutton>Help</guibutton></term> <listitem><para> This invokes the &kde; help system with the help page for this dialog.</para></listitem> </varlistentry> <varlistentry> <term><guibutton>Finished</guibutton></term> <listitem><para> This button ends the spellcheck process, and returns to the document.</para></listitem> </varlistentry> <varlistentry> <term><guibutton>Cancel</guibutton></term> <listitem><para> This button cancels the spellcheck process, all modifications are reverted, and you will return to your document.</para></listitem> </varlistentry> </variablelist> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term><anchor id="tools-spelling-from-cursor"/><menuchoice> <guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu> <guimenuitem>Spelling (from cursor)...</guimenuitem></menuchoice></term> <listitem> <para>This initiates the spellchecking program but it starts where your cursor is instead of at the beginning of the document.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-spellcheck-selection"/><menuchoice> <guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu> <guimenuitem>Spellcheck Selection...</guimenuitem></menuchoice></term> <listitem> <para>Spellchecks the current selection.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-change-dictionary"/><menuchoice> <guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu> <guimenuitem>Change Dictionary</guimenuitem></menuchoice></term> <listitem> <para>Displays a drop down box with all available dictionaries for spellchecking at the bottom of the editor window. This allows easy switching of the spellcheck dictionary ⪚ for automatic spellcheck of text in different languages.</para> </listitem> </varlistentry> <!-- Indent/Unindent no longer in the menu ???, but shortcuts work--> <!-- <varlistentry> <term><anchor id="indent"/><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu><guimenuitem>Indent</guimenuitem></menuchoice></term> <listitem> <para>This increases the paragraph's indentation by one step. The size of the step depends on the <link linkend="pref-edit-indent"> indentation settings</link>.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="unindent"/><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu><guimenuitem>Unindent</guimenuitem></menuchoice></term> <listitem> <para>This reduces the paragraph's indentation by one step. The size of the step depends on the <link linkend="pref-edit-indent"> indentation settings</link>.</para> </listitem> </varlistentry> --> <varlistentry> <term><anchor id="cleanindent"/><menuchoice> <guimenu>Tools</guimenu><guimenuitem>Clean Indentation</guimenuitem></menuchoice></term> <listitem> <para>This cleans the indentation for the current selection or for the line the cursor is currently in. Cleaning the indentation ensures that all your selected text follows the indentation mode you choose.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-align"/><menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Align</guimenuitem> </menuchoice></term> <listitem> <para>Causes a realign of the current line or selected lines using the indentation mode and indentation settings in the document.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Comment</guimenuitem> </menuchoice></term> <listitem><para>This adds one space to the beginning of the line where the text cursor is located or to the beginning of any selected lines.</para> </listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Uncomment</guimenuitem> </menuchoice></term> <listitem><para>This removes one space (if any exist) from the beginning of the line where the text cursor is located or from the beginning of any selected lines.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Uppercase</guimenuitem> </menuchoice></term> <listitem><para>Put the selected text or the letter after the cursor in uppercase.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Lowercase</guimenuitem> </menuchoice></term> <listitem><para>Put the selected text or the letter after the cursor in lowercase.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Alt;<keycap>U</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Capitalize</guimenuitem> </menuchoice></term> <listitem><para>Capitalize the selected text or the current word.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo> </shortcut> <guimenu>Tools</guimenu> <guimenuitem>Join Lines</guimenuitem> </menuchoice></term> <listitem><para>Joins the selected lines, or the current line and the line below with one white space character as a separator. Leading/trailing white space on joined lines is removed in the affected ends.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Apply Word Wrap</guimenuitem> </menuchoice></term> <listitem><para>Apply static word wrapping on all the document. That means that a new line of text will automatically start when the current line exceeds the length specified by the <guilabel>Wrap words at</guilabel> option in the Editing tab in <menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem></menuchoice></para></listitem> </varlistentry> <varlistentry> <term><anchor id="tools-create-snippet"/><menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Create Snippet</guimenuitem> </menuchoice></term> <listitem> <para>Create a new snippet, which is a reusable chunk of text you may insert in any part of any document.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="tools-snippets"/><menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Snippets...</guimenuitem> </menuchoice></term> <listitem> <para>Display a list of available snippets.</para> </listitem> </varlistentry> </variablelist> <para>If the <link linkend="pref-plugins">plugin</link> Insert File is enabled, you will find here an additional menu item <guimenuitem>Insert File...</guimenuitem>. </para> <!-- Data Tools and Insane HTML (LE) Expansion Ctrl+. when plugins are enabled--> </sect1> <sect1 id="settings"> <!-- This is also valid for kates menu settings, only the items Show Toolbar and Show Statusbar are swapped and Configure kate is the last item--> <title>The Settings Menu</title> <variablelist> <varlistentry> <term><anchor id="show-statusbar"/><menuchoice> <guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice></term> <listitem> <para>When checked, this displays a small bar at the bottom of the editor containing information about the status of the current document. When unchecked the status bar is hidden.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="show-toolbar"/><menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Show Toolbar</guimenuitem> </menuchoice> </term> <listitem> <para> When checked, this displays a movable toolbar containing buttons used to initiate frequently used commands. When unchecked the toolbar is hidden. </para> </listitem> </varlistentry> <varlistentry> <term><anchor id="show-path"/><menuchoice> <guimenu>Settings</guimenu><guimenuitem>Show Path</guimenuitem></menuchoice></term> <listitem> <para>When selected, this displays in the titlebar the path (its location in the file system) of the current document. When unchecked the path is hidden.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="preferences"/><menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem> <!-- in kate Configure &kate; ... --> </menuchoice> </term> <listitem> <para> This menu item opens a dialog whereby several different <link linkend="config-dialog">settings</link> may be adjusted. </para> </listitem> </varlistentry> <varlistentry> <term><anchor id="configure-keybindings"/><menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> <listitem> <para>Displays the familiar &kde; Keyboard Shortcut Configuration Dialog. For more information on using this, see the <ulink url="help:/fundamentals/shortcuts.html"><emphasis>Using and Customizing Shortcuts</emphasis> section of the <emphasis>&kde; Fundamentals</emphasis> documentation</ulink>.</para> </listitem> </varlistentry> <varlistentry> <term><anchor id="configure-toolbars"/><menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem></menuchoice></term> <listitem> <para>Displays the familiar &kde; Toolbar Configuration Dialog. For more information on using this, see the <ulink url="help:/fundamentals/config.html#toolbars"><emphasis>Customizing Toolbars</emphasis> section of the <emphasis>&kde; Fundamentals</emphasis> documentation</ulink>.</para> </listitem> </varlistentry> </variablelist> </sect1> <sect1 id="help"> <title>The Help Menu</title> <!-- additional "About Editor Component" , but no "Tip of the Day"--> &help.menu.documentation; </sect1> </chapter>
