diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook index 93891d606..c64c59f00 100644 --- a/doc/kate/menus.docbook +++ b/doc/kate/menus.docbook @@ -1,1714 +1,1715 @@ The Menu Entries The File Menu &Ctrl;N File New This command starts a new document in the editing window. In the Documents list on the left the new file is named Untitled. &Ctrl;O File Open... Displays a standard &kde; Open File dialog. Use the file view to select the file you want to open, and click on Open to open it. File Open Recent 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. File Open With This submenu presents a list of applications known to handle the mime type of your current document. Activating an entry will open the current document with that application. In addition, an entry Other... launches the open with dialog box that allows you to select another application to open the active file. Your file will still be open in &kate;. &Ctrl;S File Save 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. &Ctrl;&Shift;S File Save As... 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 Open section of this help file. File Save As with Encoding Save a document with a new file name in a different encoding. File Save Copy As Save a copy of the document with a new file name and continue editing the original document. &Ctrl;L File Save All This command saves all modified open files. F5 File Reload 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;. File Reload All Reloads all opened files.. &Ctrl;P File Print... Opens a simple print dialog allowing the user to specify what, where, and how to print. File Export as HTML Save the currently open document as an &HTML; file, which will be formatted using the current syntax highlighting and color scheme settings. &Ctrl;W File Close Close the active file with this command. If you have made unsaved changes, you will be prompted to save the file before &kate; closes it. File Close Other Close other open documents. File Close All This command closes all the files you have open in &kate;. File Close Orphaned Close all documents in the file list, which could not be reopened during startup, because they are not accessible anymore. &Ctrl;Q File Quit This command closes &kate; and any files you were editing. If you have made unsaved changes to any of the files you were editing, you will be prompted to save them. The Edit Menu &Ctrl;Z Edit Undo Undo the last editing command (typing, copying, cutting etc.) This may undo several editing commands of the same type, like typing in characters. &Ctrl;&Shift;Z Edit Redo This will reverse the most recent change (if any) made using Undo &Ctrl;X Edit Cut This command deletes the current selection and places it on the clipboard. The clipboard works invisibly and provides a way to transfer data between applications. &Ctrl;C Edit Copy This copies the currently selected text to the clipboard so that it may be pasted elsewhere. The clipboard works invisibly and provides a way to transfer data between applications. &Ctrl;V Edit Paste This will insert the first item in the clipboard at the cursor position. The clipboard works invisibly and provides a way to transfer data between applications. If Overwrite Selection is enabled, the pasted text will overwrite the selection, if any. Edit Clipboard History 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. Edit Copy as HTML Copy the selection as &HTML;, formatted using the current syntax highlighting and color scheme settings. &Ctrl;A Edit Select All This will select the entire document. This could be very useful for copying the entire file to another application. &Ctrl;&Shift;A Edit Deselect Deselects the selected text in the editor if any. &Ctrl;&Shift;B Edit Block Selection Mode Toggles Selection Mode. When the Selection Mode is BLOCK, the status bar contains the string [BLOCK] and you can make vertical selections, ⪚ select column 5 to 10 in lines 9 to 15. Edit Input Modes Switch between a normal and a vi-like, modal editing mode. The vi input 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 Vi Input Mode section of the Editing page in &kappname;'s settings dialog. Ins Edit Overwrite Mode Toggles the Insert/Overwrite modes. When the mode is INS, you insert characters where the cursor is. When the mode is OVR, 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 INS or OVR. &Ctrl;F Edit Find... 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. 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. Use the or button to jump to the next or previous match in the document. Matches in the document are highlighted even when you close the search bar. To clear this highlighting, press the &Esc; key. You can choose whether the search should be case sensitive. Selecting will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. Click on the button at the right side of the incremental search bar to switch to the power search and replace bar. F3 Edit Find Variants Find Next This repeats the last find operation, if any, without calling the incremental search bar, and searching forwards through the document starting from the cursor position. &Shift;F3 Edit Find Variants Find Previous This repeats the last find operation, if any, without calling the incremental search bar, and searching backwards instead of forwards through the document. &Ctrl;H Edit Find Variants Find Selected Finds next occurrence of selected text. &Ctrl;&Shift;H Edit Find Variants Find Selected Backwards Finds previous occurrence of selected text. &Ctrl;R Edit Replace... 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. You can control the search mode by selecting Plain text, Whole words, Escape sequences or Regular expression from the drop down box. If Escape sequences or Regular expression are selected, the Add... 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. Use the or button to jump to the next or previous match in the document. Enter the text to replace with in the text box labeled Replace and click the Replace button to replace only the highlighted text or the Replace All button to replace the search text in the whole document. You can modify the search and replace behavior by selecting different options at the bottom of the bar. Selecting will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. will search and replace within the current selection only. The Find All button highlights all matches in the document and shows the number of found matches in a small popup. Click on the button at the right side of the power search and replace bar to switch to the incremental search bar. &Ctrl;6 Edit +Go To Move to Matching Bracket Move the cursor to the associated opening or closing bracket. &Ctrl;&Shift;6 Edit +Go To Select to Matching Bracket Selects the text between associated opening and closing brackets. Edit +Go To Move to Previous Modified Line Lines that were changed since opening the file are called modified lines. This action jumps the previous modified line. Edit +Go To Move to Next Modified Line Lines that were changed since opening the file are called modified lines. This action jumps the next modified line. &Ctrl;G Edit +Go To Go to Line... 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. - The View Menu View New Window Opens another instance of &kate;. The new instance will be identical to your previous instance. &Alt;Right View Next Tab Activates the next tab in the tabbar. &Alt;Left View Previous Tab Activates the previous tab in the tabbar. &Ctrl;&Alt;O View Quick Open Show a search field and a list of opened files in the editor area. While entering text in the search field the document names and document &URL;s are searched for matching text. While entering text in the search field you can use the cursor keys Up and Down to navigate in the list view. Pressing the &Enter; key or double clicking on an item in the list switches the view to the document selected in the list view. This makes switching between documents easier, if there are a lot of them open. This action is available also using the icon at the top right of the editor window. &Shift;F8 View Split View Previous Split View Focus the previous document view, if you have split the editor area in more views. F8 View Split View Next Split View Focus the next document view, if you have split the editor area in more views. &Ctrl;&Shift;L ViewSplit View Split Vertical This will split the frame (which may be the main editing area) in two equally sized frames, the new one to the left of the current one. The new frame gets the focus, and will display the same document as the old one. See also Working with the &kate; MDI &Ctrl;&Shift;T ViewSplit View Split Horizontal Splits the current frame (which may be the main editing area) in two equally sized frames, the new one below the current one. The new frame gets the focus, and displays the same document as the old one. See also Working with the &kate; MDI ViewSplit View Toggle Orientation Switch between horizontal and vertical split. &Ctrl;&Shift;R ViewSplit View Close Current View Closes the active frame, which can be identified as the one displaying a blinking cursor. This is disabled, if there is only one frame (the main editing area). No documents get closed by closing a frame – they will still be available in the View Menu as well as in the File List. See also Working with the &kate; MDI ViewSplit View Close Inactive Views Closes all frames except the active frame (the one with a blinking cursor). This is disabled, if there is only one frame (the main editing area). No documents get closed by closing a frame – they will still be available in the View Menu as well as in the File List. ViewSplit View Hide Inactive Views This hides all split views except the currently active one. ViewSplit View Move Splitter Left When Split View is enabled, this will move the border between two vertically split documents further left. ViewSplit View Move Splitter Right When Split View is enabled, this will move the border between two vertically split documents further right. ViewSplit View Move Splitter Up When Split View is enabled, this will move the border between two horizontally split documents further up. ViewSplit View Move Splitter Down When Split View is enabled, this will move the border between two horizontally split documents further down. Some common actions in the ViewSplit View menu are available using the button at the top right corner of the editor window View Tool Views &Ctrl;&Alt;&Shift;F ViewTool Views Show Sidebars Toggles the display of the sidebar button rows. This command does not affect the display of the sidebar content widgets, any sidebar that is visible will stay visible, and if you assigned shortcuts to the commands below those will of course continue to work. View Tool Views Show Plugin A list of all enabled plugins. Use the checkbox in front of each item to toggle the display of the tool view. F7 View Switch to Command Line This command will toggle the display of the built-in command line. &Ctrl;+ View Enlarge Font This increases the display font size. &Ctrl;- View Shrink Font This decreases the display font size. View Schema This menu lists the available color schemes. You can change the schema for the current view here, to change the default schema you need to use the Fonts & Colors page of the config dialog. F10 View Word Wrap Dynamic Word Wrap Toggles dynamic word wrap in the current view. Dynamic word wrap makes all the text in a view visible without the need for horizontal scrolling by rendering one actual line on more visual lines as needed. View Word Wrap Dynamic Word Wrap Indicators Choose when and how the dynamic word wrap indicators should be displayed. This is only available if the Dynamic Word Wrap option is checked. View Word Wrap Show Static Word Wrap Marker Toggles the display of a vertical line indicating the position of the wrap width as configured in the config dialog. This feature requires that you use a true fixed-width font. F6 View Borders Show Icon Border 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. F11 View Borders Show Line Numbers 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. View Borders Show Scrollbar Marks Toggles the visualization of bookmarks (and other marks) on the vertical scrollbar. When enabled, a mark is represented by a thin line in the mark color at the scrollbar, clicking the &MMB; on the line will scroll the view to a position near the mark. View Borders Show Scrollbar Mini-Map This will replace the scrollbar with a visualization of the current document. For more information on the scrollbar minimap, see the Scrollbar Minimap section of the &katepart; Handbook. View Code Folding These options pertain to code folding: F9 Show Folding Markers Toggles the display of the folding marker pane in the left side of the view. Fold Current Node Collapse the region that contains the cursor. Unfold Current Node Expand the region that contains the cursor. &Ctrl;&Shift;- Fold Toplevel Nodes Collapse all toplevel regions in the document. Click on the right pointing triangle to expand all toplevel regions. - + - + + +Show Non-Printable Spaces + +Show/hide bounding box around non-printable spaces. + The Bookmarks Menu Below the entries described here, one entry for each bookmark in the active document will be available. The text will be the first few words of the marked line. Choose an item to move the cursor to the start of that line. The editor will scroll as necessary to make that line visible. &Ctrl;B Bookmarks Set Bookmark Sets or removes a bookmark in the current line of the active document. (If it's there, it is removed, otherwise one is set.) Bookmarks Clear All Bookmarks 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. &Alt;PgUp Bookmarks Previous 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. &Alt;PgDown Bookmarks Next 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. The Sessions Menu This menu contains entries for using and managing &kate; sessions. For more information, read Using Sessions. Sessions New Creates a new empty session. All currently open files will be closed. Sessions Open Session... Open an existing session. The Session Chooser dialog is displayed to let you choose one. Sessions Quick Open Session This submenu lets you open an existing session. Sessions Save Session Save the current session. If the session is anonymous, you will be prompted for a session name. Sessions Save Session As... Save the current session under a new name. You are prompted for a name to use. Sessions Manage Sessions... Displays the Session Manager dialog which allows you to rename and delete sessions. The Tools Menu Tools Read Only Mode Set the current document to Read Only mode. This prevents any text addition and any changes in the document formatting. Tools Mode Choose the filetype scheme you prefer for the active document. This overwrites the global filetype mode set in Settings Configure &kate;... in the Filetypes tab for your current document only. Tools Highlighting Choose the Highlighting scheme you prefer for the active document. This overwrites the global highlighting mode set in SettingsConfigure Editor... for your current document only. Tools Indentation Choose the style of indentation you want for your active document. This overwrites the global indentation mode set in SettingsConfigure Editor... for your current document only. Tools Encoding You can overwrite the default encoding set in SettingsConfigure Editor... in the Open/Save page to set a different encoding for your current document. The encoding you set here will be only valid for your current document. Tools End of Line Choose your preferred end of line mode for your active document. This overwrites the global end of line mode set in SettingsConfigure Editor... for your current document only. Tools Add Byte Mark Order (BOM) 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 Byte Order Mark. Tools Scripts This submenu contains a list of all scripted actions. The list can easily be modified by writing your own scripts. This way, &kate; can be extended with user-defined tools. -There is a complete list of +There is a complete list of scripts in the &katepart; documentation. &Ctrl;Space Tools Invoke Code Completion Manually invoke command completion, usually by using a shortcut bound to this action. Tools Word Completion Reuse Word Below (&Ctrl; 9) and Reuse Word Above (&Ctrl; 8) complete the currently typed text by searching for similar words backward or forward from the current cursor position. Shell Completion pops up a completion box with matching entries. &Ctrl;&Shift;O Tools Spelling Automatic Spell Checking When Automatic Spell Checking is enabled, wrongly spelled text is underlined in the document on-the-fly. Tools Spelling Spelling... This initiates the spellchecking program - a program designed to help the user catch and correct any spelling errors. For more information on how to use the &kde; spellchecking program, see the Check Spelling section of the &kde; Fundamentals documentation. Tools Spelling Spelling (from cursor)... This initiates the spellchecking program but it starts where your cursor is instead of at the beginning of the document. Tools Spelling Spellcheck Selection... Spellchecks the current selection. Tools Spelling Change Dictionary 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. Tools Clean Indentation 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. Tools Align Causes a realign of the current line or selected lines using the indentation mode and indentation settings in the document. &Ctrl;D Tools Comment This adds one space to the beginning of the line where the text cursor is located or to the beginning of any selected lines. &Ctrl;&Shift;D Tools Uncomment 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. &Ctrl;U Tools Uppercase Put the selected text or the letter after the cursor in uppercase. &Ctrl;&Shift;U Tools Lowercase Put the selected text or the letter after the cursor in lowercase. &Ctrl;&Alt;U Tools Capitalize Capitalize the selected text or the current word. &Ctrl;J Tools Join Lines 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. Tools Apply Word Wrap 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 Wrap words at option in the Editing tab in SettingsConfigure Editor... The Settings and Help Menu &kate; has the common &kde; Settings and Help menu items, for more information read the sections about the Settings Menu and Help Menu of the &kde; Fundamentals with two additional entries: Settings Show Tabs Tabs are moveable using the &LMB; and have actions in the context menu to close documents, copy the path to the clipboard or open the folder of the document in the filemanager. Using the Quick Open button makes switching between documents easy. Click the button with the &LMB; to open a menu with actions from the ViewSplit View menu. Settings Show Path in Titlebar If enabled the full path of the active document is displayed, otherwise only the filename. This is useful if you edit several files with the same filename to distinguish them. diff --git a/doc/katepart/configuring.docbook b/doc/katepart/configuring.docbook index 02f05d86b..7d2867d80 100644 --- a/doc/katepart/configuring.docbook +++ b/doc/katepart/configuring.docbook @@ -1,1608 +1,1613 @@ Configure &kappname; Selecting SettingsConfigure Application... from the menu brings up the Configure dialog box. This dialog can be used to alter a number of different settings. The settings available for change vary according to which category the user chooses from a vertical list on the left side of the dialog. By means of three buttons along the bottom of the box the user can control the process. You may invoke the Help system, accept the current settings and close the dialog by means of the OK button, or Cancel the process. The categories Appearance, Fonts & Colors, Editing, Open/Save and Extensions are detailed below. The Editor Component Configuration This group contains all pages related to the editor component of &kappname;. Most of the settings here are defaults, they can be overridden by defining a filetype, by Document Variables or by changing them per document during an editing session. Appearance General Dynamic Word Wrap If this option is checked, the text lines will be wrapped at the view border on the screen. Dynamic word wrap indicators (if applicable) Choose when the Dynamic word wrap indicators should be displayed, either Off, Follow Line Numbers or Always on. Align dynamically wrapped lines to indentation depth: Enables the start of dynamically wrapped lines to be aligned vertically to the indentation level of the first line. This can help to make code and markup more readable.Additionally, this allows you to set a maximum width of the screen, as a percentage, after which dynamically wrapped lines will no longer be vertically aligned. For example, at 50%, lines whose indentation levels are deeper than 50% of the width of the screen will not have vertical alignment applied to subsequent wrapped lines. Whitespace Highlighting Highlight tabulators The editor will display a » symbol to indicate the presence of a tab in the text. Highlight trailing spaces The editor will display dots to indicate the presence of extra whitespace at the end of lines. Highlight marker size Use the slider to change the size of the visible highlight marker. Advanced Show indentation lines If this is checked, the editor will display vertical lines to help identifying indent lines. Highlight range between selected brackets If this is enabled, the range between the selected matching brackets will be highlighted. Animate bracket matching If enabled, moving on the brackets ({, [, ], },( or )) will quickly animate the matching bracket. Fold first line If enabled, the first line is folded, if possible. This is useful, if the file starts with a comment, such as a copyright + +Show Word Count + +Displays the number of words and characters in the document and in the current selection. + Borders Borders Show folding markers If this option is checked, the current view will display marks for code folding, if code folding is available. Show preview of folded code If checked, hovering over a folded region shows a preview of the folded text in a popup. Show icon border If this is checked, you will see an icon border on the left hand side. The icon border shows bookmark signs for instance. Show line numbers If this is checked, you will see line numbers on the left hand side. Show line modification markers If this is checked, line modification markers will be visible. For more information, see . Show scrollbar marks If this option is checked the current view will show marks on the vertical scrollbar. These marks will for instance show bookmarks. Show text preview on scrollbar If this option is checked, and you hover the scrollbar with the mouse cursor a small text preview with several lines of the current document around the cursor position will be displayed. This allows you to quickly switch to another part of the document. Show scrollbar mini-map If this option is checked, every new view will show a mini map of the document on the vertical scrollbar. For more information on the scrollbar minimap, see Minimap Width Adjusts the width of the scrollbar mini-map, defined in pixels. Scrollbars visibility Switch the scrollbar on, off or show the scrollbar only when needed. Click with the &LMB; on the blue rectangle to display the line number range of the document displayed on the screen. Keep the &LMB; pressed outside the blue rectangle to automatically scroll through the document. Sort Bookmarks Menu By creation Each new bookmark will be added to the bottom, independently from where it is placed in the document. By position The bookmarks will be ordered by the line numbers they are placed at. Fonts & Colors This section of the dialog lets you configure all fonts and colors in any color scheme you have, as well creating new schemes or deleting existing ones. Each scheme has settings for colors, fonts and normal and highlight text styles. &kappname; will preselect the currently active scheme for you, if you want to work on a different scheme start by selecting that from the Schema combobox. With the New and Delete button you can create a new scheme or delete existing ones. At the bottom of the page you can select the Default schema for &kappname;. By default, &kappname; will base its color scheme on the current &kde; color scheme. You can reset an individual color back to default by clicking the reset arrow to the right of the entry in the color editor, or you can reset all colors back to default by clicking the Use &kde; Color Scheme at the bottom of the panel. You can adjust the &kde; color scheme in the Colors module in &systemsettings;. Colors Editor Background Colors Text Area This is the default background for the editor area, it will be the dominant color on the editor area. Selected Text This is the background for selected text. The default is the global selection color, as set in your &kde; color preferences. Current Line Set the color for the current line. Setting this a bit different from the Normal text background helps to keep focus on the current line. Search Highlight Set the color for the text that matches your last search. Replace Highlight Set the color for the text that matches your last replace operation. Icon Border Background Area This color is used for the marks, line numbers and folding marker borders in the left side of the editor view when they are displayed. Line Numbers This color is used to draw the line numbers on the left side of the view when displayed. Word Wrap Marker This color is used to draw a pattern to the left of dynamically wrapped lines when those are aligned vertically, as well as for the static word wrap marker. Code Folding This color is used to highlight the section of code that would be folded when you click on the code folding arrow to the left of a document. For more information, see the code folding documentation. Modified Lines This color is used to highlight to the left of a document lines that have been modified but not yet saved. For more information, see Saved Lines This color is used to highlight to the left of a document lines that have been modified this session and saved. For more information, see Text Decorations Spelling Mistake Line This color is used to indicate spelling mistakes. Tab and Space Markers This color is used to draw white space indicators, when they are enabled. Indentation Line This color is used to draw a line to the left of indented blocks, if that feature is enabled. Bracket Highlight This color is used to draw the background of matching brackets. Marker Colors Bookmark This color is used to indicate bookmarks. For more information, see . Active Breakpoint This color is used by the GDB plugin to indicate an active breakpoint. For more information, see the GDB Plugin documentation. Reached Breakpoint This color is used by the GDB plugin to indicate a breakpoint you have reached while debugging. For more information, see the GDB Plugin documentation. Disabled Breakpoint This color is used by the GDB plugin to indicate an inactive breakpoint. For more information, see the GDB Plugin documentation. Execution This color is used by the GDB plugin the line presently being executed. For more information, see the GDB Plugin documentation. Warning This color is used by the build plugin to indicate a line that has caused a compiler warning. For more information, see the Build Plugin documentation. Error This color is used by the build plugin to indicate a line that has caused a compiler error. For more information, see the Build Plugin documentation. Text Templates & Snippets Background This color is used by the &kate; Snippets plugin to mark the background of a snippet. Editable Placeholder This color is used by the &kate; Snippets plugin to mark a placeholder that you can click in to edit manually. Focused Editable Placeholder This color is used by the &kate; Snippets plugin to mark the placeholder that you are presently editing. Not Editable Placeholder This color is used by the &kate; Snippets plugin to mark a placeholder that cannot be edited manually, such as one that is automatically populated. For more information, see the &kate; Snippets documentation. Use &kde; Color Scheme Clicking this button will set all the above defined colors to match the current color scheme defined in &kde;'s &systemsettings;. For more information, see the documentation for the Colors &kde; Control Module. If you do not use the &kde; &plasma; Workspaces, this button will have no effect, and may not be present. Font Here you can choose the font for the schema. You can choose from any font available on your system, and set a default size. A sample text displays at the bottom of the dialog, so you can see the effect of your choices. For more information about selecting a font, see the Choosing Fonts section of the &kde; Fundamentals documentation. Default Text Styles The default text styles are inherited by the highlight text styles, allowing the editor to present text in a very consistent way, for example comment text is using the same style in almost all of the text formats that &kappname; can highlight. The name in the list of styles is using the style configured for the item, providing you with an immediate preview when configuring a style. Each style lets you select common attributes as well as foreground and background colors. To unset a background color, right-click to use the context menu. Highlighting Text Styles Here you can edit the text styles used by a specific highlight definition. The editor preselects the highlight used by your current document. To work on a different highlight, select one in the Highlight combobox above the style list. The name in the list of styles is using the style configured for the item, providing you with an immediate preview when configuring a style. Each style lets you select common attributes as well as foreground and background colors. To unset a background color, right-click to use the context menu. In addition you can see if a style is equal to the default style used for the item, and set it to that if not. You will notice that many highlights contain other highlights represented by groups in the style list. For example most highlights import the Alert highlight, and many source code formats imports the Doxygen highlight. Editing colors in those groups only affects the styles when used in the edited highlight format. Editing General Static Word Wrap Word wrap is a feature that causes the editor to automatically start a new line of text and move (wrap) the cursor to the beginning of that new line. &kappname; will automatically start a new line of text when the current line reaches the length specified by the Wrap Words At: option. Enable static word wrap Turns static word wrap on or off. Show static word wrap marker (if applicable) If this option is checked, a vertical line will be drawn at the word wrap column as defined in the Settings Configure Editor... in the Editing tab. Please note that the word wrap marker is only drawn if you use a fixed pitch font. Wrap words at: If the Enable static word wrap option is selected this entry determines the length (in characters) at which the editor will automatically start a new line. Input Mode The selected input mode will be enabled when opening a new view. You can still toggle the vi input mode on/off for a particular view in the Edit menu. Auto brackets When the user types a left bracket ([, (, or {) &kappname; automatically enters the right bracket (}, ), or ]) to the right of the cursor. When text is selected, typing one of the characters wraps the selected text. Copy and Paste Copy/Cut the current line if no selection If this option is enabled and the text selection is empty, copy and cut action are performed for the line of text at the actual cursor position. Text Navigation Text Cursor Movement Smart home and smart end When selected, pressing the home key will cause the cursor to skip white space and go to the start of a line's text. PageUp/PageDown moves cursor This option changes the behavior of the cursor when the user presses the Page Up or Page Down key. If unselected the text cursor will maintain its relative position within the visible text in &kappname; as new text becomes visible as a result of the operation. So if the cursor is in the middle of the visible text when the operation occurs it will remain there (except when one reaches the beginning or end.) With this option selected, the first key press will cause the cursor to move to either the top or bottom of the visible text as a new page of text is displayed. Autocenter cursor: Sets the number of lines to maintain visible above and below the cursor when possible. Text Selection Mode Normal Selections will be overwritten by typed text and will be lost on cursor movement. Persistent Selections will stay even after cursor movement and typing. Allow scrolling past the end of the document This option lets you scroll past the end of the document. This can be used to vertically centre the bottom of the document, or put it on top of the current view. Backspace key removes character’s base with its diacritics When selected, composed characters are removed with their diacritics instead of only removing the base character. This is useful for Indic locales. Indentation Default indentation mode: Select the automatic indentation mode you want to use as default. It is strongly recommended to use None or Normal here, and use filetype configurations to set other indentation modes for text formats like C/C++ code or &XML;. Indent using Tabulators When this is enabled the editor will insert tabulator characters when you press the key or use automatic indentation. Spaces When this is enabled the editor will insert a calculated number of spaces according to the position in the text and the setting when you press the key or use automatic indentation. Tabulators and Spaces When this is enabled, the editor will insert spaces as describe above when indenting or pressing at the beginning of a line, but insert tabulators when the key is pressed in the middle or end of a line. Tab width: This configures the number of spaces that are displayed in place of a tabulator character. Indentation width: The indentation width is the number of spaces which is used to indent a line. If configured to indent using tabulators, a tabulator character is inserted if the indentation is divisible by the tab width. Indentation Properties Keep extra spaces If this option is disabled, changing the indentation level aligns a line to a multiple of the width specified in Indentation width. Adjust indentation of text pasted from the clipboard If this option is selected, text pasted from the clipboard is indented. Triggering the Undo action removes the indentation. Indentation Actions Backspace key in leading blank space unindents If this option is selected, the &Backspace; key decreases the indentation level if the cursor is located in the leading blank space of a line. Tab key action (if no selection exists) If you want to align the current line in the current code block like in emacs, make a shortcut to the action Align. Always advance to the next tab position If this option is selected, the key always inserts white space so that the next tab position is reached. If the option Insert spaces instead of tabulators on the General tab in the Editing page is enabled, spaces are inserted; otherwise, a single tabulator is inserted. Always increase indentation level If this option is selected, the key always indents the current line by the number of character positions specified in Indentation width. Increase indentation level if in leading blank space If this option is selected, the key either indents the current line or advances to the next tab position. If the insertion point is at or before the first non-space character in the line, or if there is a selection, the current line is indented by the number of character positions specified in Indentation width. If the insertion point is located after the first non-space character in the line and there is no selection, white space is inserted so that the next tab position is reached: if the option Insert spaces instead of tabulators on the General tab in the Editing page is enabled, spaces are inserted; otherwise, a single tabulator is inserted. Auto Completion General Enable auto completion If enabled, a word completion box automatically pops up during typing showing a list of text entries to complete the current text under the cursor. Minimal word length to complete While typing text, the word completion searches for words in the document starting with the already typed text. This option configures the minimal amount of characters that are needed to make the word completion active and pop up a completion box. Remove tail on complete Remove the tail of a previous word when the completion item is chosen from a list. Keyword completion If enabled, the built-in autocompletion uses the keywords defined by the syntax highlighting. Spellcheck These configuration options are described in the documentation for the &systemsettings; module Spell Checker. Vi Input Mode General Let Vi commands override Kate shortcuts When selected, Vi commands will override &kappname;'s built-in commands. For example: &Ctrl;R will redo, and override the standard action (showing the search and replace dialog). Display relative line numbers if this is enabled, the current line always refers to line 0. Lines above and below increase the line number relatively. Key Mapping Key mapping is used to change the meaning of typed keys. This allows you to move commands to other keys or make special keypresses for doing a series of commands. Example: F2 -> I-- &Esc; This will prepend I-- to a line when pressing F2. Open/Save General File Format Encoding This defines the standard encoding to use to open/save files, if not changed in the open/save dialog or by using a command line option. Encoding Detection Select an item from the drop down box, either to disable autodetection or use Universal to enable autodetection for all encodings. But as this may probably only detect utf-8/utf-16, selecting a region will use custom heuristics for better results. If neither the encoding chosen as standard above, nor the encoding specified in the open/save dialog, nor the encoding specified on command line match the content of the file, this detection will be run. Fallback Encoding This defines the fallback encoding to try for opening files if neither the encoding chosen as standard above, nor the encoding specified in the open/ save dialog, nor the encoding specified on command line match the content of the file. Before this is used, an attempt will be made to determine the encoding to use by looking for a byte order mark at start of file: if one is found, the right unicode encoding will be chosen; otherwise encoding detection will run, if both fail fallback encoding will be tried. End of line Choose your preferred end of line mode for your active document. You have the choice between &UNIX;, DOS/&Windows; or Macintosh. Automatic end of line detection Check this if you want the editor to autodetect the end of line type. The first found end of line type will be used for the whole file. Enable byte order mark (BOM) The byte order mark is a special sequence at the beginning of unicode encoded documents. It helps editors to open text documents with the correct unicode encoding. For more information see Byte Order Mark. Line Length Limit Unfortunately, due to deficiencies in &Qt;, &kappname; experiences poor performance when working with extremely long lines. For that reason, &kappname; will automatically wrap lines when they are longer than the number of characters specified here. To disable this, set this to 0. Automatic Cleanups on Save Remove trailing spaces The editor will automatically eliminate extra spaces at the ends of lines of text while saving the file. You can select Never to disable this functionality, On Modified Lines to do so only on lines that you have modified since you last saved the document, or In Entire Document to remove them unconditionally from the entire document. Append newline at end of file on save The editor will automatically append a newline to the end of the file if one is not already present upon saving the file. Advanced Backup on Save Backing up on save will cause &kappname; to copy the disk file to <prefix><filename><suffix> before saving changes. The suffix defaults to ~ and prefix is empty by default. Local files Check this if you want backups of local files when saving. Remote files Check this if you want backups of remote files when saving. Prefix Enter the prefix to prepend to the backup file names. Suffix Enter the suffix to add to the backup file names. Swap file options &kappname; is able to recover (most of) what was written after last save in case of a crash or power failure. A swap file (.swp.<filename>) is created after the first editing action on a document. If the user doesn’t save the changes and &kappname; crashes, the swap file remains on the disk. When opening a file, &kappname; checks if there is a swap file for the document and if it is, it asks the user whether he wants to recover the lost data or not. The user has the possibility to view the differences between the original file and the recovered one, too. The swap file is deleted after every save and on normal exit. &kappname; syncs the swap files on the disk every 15 seconds, but only if they have changed since the last sync. The user can disable the swap files syncing if he wants, by selecting Disable, but this can lead to more data loss. When enabled, the swap files are saved in the same folder as the file. -When Alternative Folder is chosen, swap files are created in the specified folder. +When Alternative Directory is chosen, swap files are created in the specified folder. This is useful for network file systems to avoid unnecessary network traffic. Modes & Filetypes This page allows you to override the default configuration for documents of specified mimetypes. When the editor loads a document, it will try if it matches the file masks or mimetypes for one of the defined filetypes, and if so apply the variables defined. If more filetypes match, the one with the highest priority will be used. Filetype: The filetype with the highest priority is the one displayed in the first drop down box. If more filetypes were found, they are also listed. New This is used to create a new filetype. After you click on this button, the fields below get empty and you can fill the properties you want for the new filetype. Delete To remove an existing filetype, select it from the drop down box and press the Delete button. Properties of current filetype The filetype with the highest priority is the one displayed in the first drop down box. If more filetypes were found, they are also listed. Name: The name of the filetype will be the text of the corresponding menu item. This name is displayed in the ToolsFiletypes Section: The section name is used to organize the file types in menus. This is also used in the ToolsFiletypes menu. Variables: This string allows you to configure &kappname;'s settings for the files selected by this mimetype using &kappname; variables. You can set almost any configuration option, such as highlight, indent-mode, etc. Press Edit to see a list of all available variables and their descriptions. Select the checkbox on the left to enable a particular variable and then set the value of the variable on the right. Some variables provide a drop-down box to select possible values from while others require you to enter a valid value manually. For complete information on these variables, see Configuring with Document Variables. Highlighting: If you create a new file type, this drop down box allows you to select a filetype for highlighting. Indentation Mode: The drop down box specifies the indentation mode for new documents. File extensions: The wildcards mask allows you to select files by filename. A typical mask uses an asterisk and the file extension, for example *.txt; *.text. The string is a semicolon-separated list of masks. MIME types: Displays a wizard that helps you easily select mimetypes. Priority: Sets a priority for this file type. If more than one file type selects the same file, the one with the highest priority will be used. Download Highlighting Files... Click this button to download new or updated syntax highlight descriptions from the &kappname; website. Configuring With Document Variables &kappname; variables is &kappname;'s implementation of document variables, similar to &Emacs; and vi modelines. In katepart, the lines have the following format: kate: VARIABLENAME VALUE; [ VARIABLENAME VALUE; ... ] The lines can of course be in a comment, if the file is in a format with comments. Variable names are single words (no whitespace), and anything up to the next semicolon is the value. The semicolon is required. Here is an example variable line, forcing indentation settings for a C++, java or javascript file: // kate: replace-tabs on; indent-width 4; indent-mode cstyle; Only the first and last 10 lines are searched for variable lines. Additionally, document variables can be placed in a file called .kateconfig in any directory, and the configured settings will be applied as if the modelines were entered on every file in the directory and its subdirectories. Document variables in .kateconfig use the same syntax as in modelines, but with extended options. There are variables to support almost all configurations in &kappname;, and additionally plugins can use variables, in which case it should be documented in the plugin's documentation. &kappname; has support for reading configurations from .editorconfig files, when the editorconfig library is installed. &kappname; automatically searches for a .editorconfig whenever you open a file. It gives priority to .kateconfig files, though. How &kappname; uses Variables When reading configuration, katepart looks in the following places (in that order): The global configuration. Optional session data. The "Filetype" configuration. Document variables in .kateconfig. Document variables in the document itself. Settings made during editing from menu or command line. As you can see, document variables are only overridden by changes made at runtime. Whenever a document is saved, the document variables are reread, and will overwrite changes made using menu items or the command line. Any variable not listed below is stored in the document and can be queried by other objects such as plugins, which can use them for their own purpose. For example, the variable indent mode uses document variables for its configuration. The variables listed here documents &kappname; version 5.38. More variables may be added in the future. There are 3 possible types of values for variables, with the following valid expressions: BOOL - on|off|true|false|1|0 INTEGER - any integer number STRING - anything else Available Variables auto-bracketsBOOL Enable automatic insertion of brackets. auto-center-linesINT Set the number of autocenter lines. background-colorSTRING Set the document background color. The value must be something that can be evaluated to a valid color, for example #ff0000. backspace-indentsBOOL Enable or disable unindenting when &Backspace; is pressed. block-selectionBOOL Turn block selection on or off. bom | byte-order-mark | byte-order-markerBOOL Enable/disable the byte order mark (BOM) when saving files in Unicode format (utf8, utf16, utf32). Since: &kate; 3.4 (&kde; 4.4) bracket-highlight-colorSTRING Set the color for the bracket highlight. The value must be something that can be evaluated to a valid color, for example #ff0000. current-line-colorSTRING Set the color for the current line. The value must be something that can be evaluated to a valid color, for example #ff0000. default-dictionarySTRING Sets the default dictionary used for spellchecking. Since: &kate; 3.4 (&kde; 4.4) dynamic-word-wrapBOOL Turns dynamic word wrap on or off. eol | end-of-lineSTRING Set the end of line mode. Valid settings are unix, mac and dos. folding-markersBOOL Set the display of folding markers on or off. folding-previewBOOL Enable folding preview in the editor border. font-sizeINT Set the point size of the document font. fontSTRING Set the font of the document. The value should be a valid font name, for example courier. hl | syntaxSTRING Set the syntax highlighting. Valid strings are all the names available in the menus. For instance, for C++ simply write C++. icon-bar-colorSTRING Set the icon bar color. The value must be something that can be evaluated to a valid color, for example #ff0000. icon-borderBOOL Set the display of the icon border on or off. indent-modeSTRING Set the auto-indentation mode. The options none, normal, cstyle, haskell, lilypond, lisp, python, ruby and xml are recognized. See the section for details. indent-pasted-textBOOL Enable/disable adjusting indentation of text pasted from the clipboard. Since: &kate; 3.11 (&kde; 4.11) indent-widthINT Set the indentation width. keep-extra-spacesBOOL Set whether to keep extra spaces when calculating indentation width. line-numbersBOOL Set the display of line numbers on or off. newline-at-eofBOOL Add an empty line at the end of the file (EOF) when saving the document. Since: &kate; 3.9 (&kde; 4.9) overwrite-modeBOOL Set overwrite mode on or off. persistent-selectionBOOL Set persistent selection on or off. replace-tabs-saveBOOL Set tab to space conversion on save on or off. replace-tabsBOOL Set dynamic tab to space conversion on or off. remove-trailing-spacesSTRING Removes trailing spaces when saving the document. Valid options are: none, - or 0: never remove trailing spaces. modified, mod, + or 1: remove trailing spaces only in modified lines. The modified lines are marked by the line modification system. all, * or 2: remove trailing spaces in the entire document. Since: &kde; 4.10. scrollbar-minimapBOOL Show scrollbar minimap. scrollbar-previewBOOL Show scrollbar preview. schemeSTRING Set the color scheme. The string must be the name of a color scheme that exists in your configuration to have any effect. selection-colorSTRING Set the selection color. The value must be something that can be evaluated to a valid color, for example #ff0000. show-tabsBOOL Set the visual tab character on or off. smart-homeBOOL Set smart home navigation on or off. tab-indentsBOOL Set key indentation on or off. tab-widthINT Set the tab character display width. undo-stepsINT Set the number of undo steps to remember. Note: Deprecated since &kate; 3 in &kde;4. This variable is ignored. The maximal count of undo steps is unlimited. word-wrap-columnINT Set the static word wrap width. word-wrap-marker-colorSTRING Set the word wrap marker color. The value must be something that can be evaluated to a valid color, for example #ff0000. word-wrapBOOL Set static word wrapping on or off. Extended Options in <filename>.kateconfig</filename> files &kappname; always search for a .kateconfig file for local files (not remote files). In addition, it is possible to set options based on wildcards (file extensions) as follows: kate: tab-width 4; indent-width 4; replace-tabs on; kate-wildcard(*.xml): indent-width 2; kate-wildcard(Makefile): replace-tabs off; In this example, all files use a tab-width of 4 spaces, an indent-width of 4 spaces, and tabs are replaced expanded to spaces. However, for all *.xml files, the indent width is set to 2 spaces. And Makefiles use tabs, &ie; tabs are not replaced with spaces. Wildcards are semicolon separated, &ie; you can also specify multiple file extensions as follows: kate-wildcard(*.json;*.xml): indent-width 2; Further, you can also use the mimetype to match certain files, ⪚ to indent all C++ source files with 4 spaces, you can write: kate-mimetype(text/x-c++src): indent-width 4; Next to the support in .kateconfig files, wildcard and mimetype dependent document variables are also supported in the files itself as comments. diff --git a/doc/katepart/menus.docbook b/doc/katepart/menus.docbook index 32279179d..c62d02c30 100644 --- a/doc/katepart/menus.docbook +++ b/doc/katepart/menus.docbook @@ -1,1729 +1,1722 @@ The Menu Entries The File Menu &Ctrl;N File New This starts a new document in a new and independent editor window. &Ctrl;O File Open... Displays a standard &kde; Open File dialog. Use the file view to select the file you want to open, and click on Open to open it. File Open Recent 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. &Ctrl;S File Save 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. &Ctrl;&Shift;S File Save As... 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 Open section of this help file. File Save As with Encoding Save a document with a new file name in a different encoding. File Save Copy As Save a copy of the document with a new file name and continue editing the original document. F5 File Reload 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;. &Ctrl;P File Print... Opens a simple print dialog allowing the user to specify what, where, and how to print. File Export as HTML Save the currently open document as an &HTML; file, which will be formatted using the current syntax highlighting and color scheme settings. &Ctrl;W File Close 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. &Ctrl;Q File Quit This will close the editor window, if you have more than one instance of &kappname; running, through the New or New Window menu items, those instances will not be closed. The Edit Menu &Ctrl;Z Edit Undo Undo the last editing command (typing, copying, cutting etc.) This may undo several editing commands of the same type, like typing in characters. &Ctrl;&Shift;Z Edit Redo This will reverse the most recent change (if any) made using Undo &Ctrl;X Edit Cut This command deletes the current selection and places it on the clipboard. The clipboard works invisibly and provides a way to transfer data between applications. &Ctrl;C Edit Copy This copies the currently selected text to the clipboard so that it may be pasted elsewhere. The clipboard works invisibly and provides a way to transfer data between applications. &Ctrl;V Edit Paste This will insert the first item in the clipboard at the cursor position. The clipboard works invisibly and provides a way to transfer data between applications. If Overwrite Selection is enabled, the pasted text will overwrite the selection, if any. Edit Clipboard History 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. Edit Copy as HTML Copy the selection as &HTML;, formatted using the current syntax highlighting and color scheme settings. &Ctrl;A Edit Select All This will select the entire document. This could be very useful for copying the entire file to another application. &Ctrl;&Shift;A Edit Deselect Deselects the selected text in the editor if any. &Ctrl;&Shift;B Edit Block Selection Mode Toggles Selection Mode. When the Selection Mode is BLOCK, the status bar contains the string [BLOCK] and you can make vertical selections, ⪚ select column 5 to 10 in lines 9 to 15. Edit Input Modes Switch between a normal and a vi-like, modal editing mode. The vi input 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 Vi Input Mode tab of the Editing page in &kappname;'s settings dialog. Ins Edit Overwrite Mode Toggles the Insert/Overwrite modes. When the mode is INS, you insert characters where the cursor is. When the mode is OVR, 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 INS or OVR. &Ctrl;F Edit Find... 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. 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. Use the or button to jump to the next or previous match in the document. Matches in the document are highlighted even when you close the search bar. To clear this highlighting, press the &Esc; key. You can choose whether the search should be case sensitive. Selecting will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. Click on the button at the right side of the incremental search bar to switch to the power search and replace bar. F3 Edit Find Variants Find Next This repeats the last find operation, if any, without calling the incremental search bar, and searching forwards through the document starting from the cursor position. &Shift;F3 Edit Find Variants Find Previous This repeats the last find operation, if any, without calling the incremental search bar, and searching backwards instead of forwards through the document. &Ctrl;H Edit Find Variants Find Selected Finds next occurrence of selected text. &Ctrl;&Shift;H Edit Find Variants Find Selected Backwards Finds previous occurrence of selected text. &Ctrl;R Edit Replace... 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. You can control the search mode by selecting Plain text, Whole words, Escape sequences or Regular expression from the drop down box. If Escape sequences or Regular expression are selected, the Add... 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. Use the or button to jump to the next or previous match in the document. Enter the text to replace with in the text box labeled Replace and click the Replace button to replace only the highlighted text or the Replace All button to replace the search text in the whole document. You can modify the search and replace behavior by selecting different options at the bottom of the bar. Selecting will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. will search and replace within the current selection only. The Find All button highlights all matches in the document and shows the number of found matches in a small popup. Click on the button at the right side of the power search and replace bar to switch to the incremental search bar. &Ctrl;6 Edit Go To Move to Matching Bracket Move the cursor to the associated opening or closing bracket. &Ctrl;&Shift;6 Edit Go To Select to Matching Bracket Selects the text between associated opening and closing brackets. Edit Go To Move to Previous Modified Line Lines that were changed since opening the file are called modified lines. This action jumps the previous modified line. Edit Go To Move to Next Modified Line Lines that were changed since opening the file are called modified lines. This action jumps the next modified line. &Ctrl;G Edit Go To Go to Line... 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. The View Menu View New Window Create another window containing the current document. All changes to the document in one window are reflected in the other window and vice versa. F7 View Switch to Command Line Displays the &katepart; command line at the bottom of the window. In the command line, type help to get help and help list to get a list of commands. For more information on the command line, see The Editor Component Command Line. &Ctrl;+ View Enlarge Font This increases the display font size. &Ctrl;- View Shrink Font This decreases the display font size. View Schema This menu lists the available color schemes. You can change the schema for the current view here, to change the default schema you need to use the Fonts & Colors page of the config dialog. F10 View Word Wrap Dynamic Word Wrap Toggles dynamic word wrap in the current view. Dynamic word wrap makes all the text in a view visible without the need for horizontal scrolling by rendering one actual line on more visual lines as needed. View Word Wrap Dynamic Word Wrap Indicators Choose when and how the dynamic word wrap indicators should be displayed. This is only available if the Dynamic Word Wrap option is checked. View Word Wrap Show Static Word Wrap Marker If this option is checked, a vertical line will be drawn at the word wrap column as defined in the Settings Configure Editor... in the Editing tab. Please note that the word wrap marker is only drawn if you use a fixed pitch font. F6 View Borders Show Icon Border 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. F11 View Borders Show Line Numbers 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. View Borders Show Scrollbar Marks If this option is checked, the view will show marks on the vertical scrollbar. The marks are equivalent to the marks on the Icon Border. View Borders Show Scrollbar Mini-Map This will replace the scrollbar with a visualization of the current document. For more information on the scrollbar minimap, see View Code Folding These options pertain to code folding: F9 Show Folding Markers Toggles the display of the folding marker pane in the left side of the view. Fold Current Node Collapse the region that contains the cursor. Unfold Current Node Expand the region that contains the cursor. &Ctrl;&Shift;- Fold Toplevel Nodes Collapse all toplevel regions in the document. Click on the right pointing triangle to expand all toplevel regions. &Ctrl;&Shift;+ Unfold Toplevel Nodes Expand all toplevel regions in the document. Show Non-Printable Spaces Show/hide bounding box around non-printable spaces. - - -Show Word Count - -Displays the number of words and characters in the document and in the current selection. - - The Bookmarks Menu Below the entries described here, one entry for each bookmark in the active document will be available. The text will be the first few words of the marked line. Choose an item to move the cursor to the start of that line. The editor will scroll as necessary to make that line visible. &Ctrl;B Bookmarks Set Bookmark Sets or removes a bookmark in the current line of the active document. (If it's there, it is removed, otherwise one is set.) Bookmarks Clear All Bookmarks 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. &Alt;PgUp Bookmarks Previous 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. &Alt;PgDown Bookmarks Next 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. The Tools Menu Tools Read Only Mode Set the current document to Read Only mode. This prevents any text addition and any changes in the document formatting. Tools Mode Choose the filetype scheme you prefer for the active document. This overwrites the global filetype mode set in SettingsConfigure Editor... in the Filetypes tab for your current document only. Tools Highlighting Choose the Highlighting scheme you prefer for the active document. This overwrites the global highlighting mode set in SettingsConfigure Editor... for your current document only. Tools Indentation Choose the style of indentation you want for your active document. This overwrites the global indentation mode set in SettingsConfigure Editor... for your current document only. Tools Encoding You can overwrite the default encoding set in SettingsConfigure Editor... in the Open/Save page to set a different encoding for your current document. The encoding you set here will be only valid for your current document. Tools End of Line Choose your preferred end of line mode for your active document. This overwrites the global end of line mode set in SettingsConfigure Editor... for your current document only. Tools Add Byte Mark Order (BOM) 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 Byte Order Mark. Tools Scripts This submenu contains a list of all scripted actions. The list can easily be modified by writing your own scripts. This way, &katepart; can be extended with user-defined tools. Tools Scripts Navigation &Alt;&Shift;Up Tools Scripts Navigation Move cursor to previous matching indent Moves the cursor to the first line above the current line that is indented at the same level as the current line. &Alt;&Shift;Down Tools Scripts Navigation Move cursor to next matching indent Moves the cursor to the first line below the current line that is indented at the same level as the current line. Tools Scripts Editing Tools Scripts Editing Sort Selected Text Sorts the selected text or whole document in ascending order. &Ctrl;&Shift;Down Tools Scripts Editing Move Lines Down Move selected lines down. &Ctrl;&Shift;Up Tools Scripts Editing Move Lines Up Move selected lines up. &Ctrl;&Alt;Down Tools Scripts Editing Duplicate Selected Lines Down Duplicates the selected lines down. &Ctrl;&Alt;Up Tools Scripts Editing Duplicate Selected Lines Up Duplicates the selected lines up. Tools Scripts Editing URI-encode selected text Encodes the selected text so that it can be used as part of a query string in a &URL;, replacing the selection with the encoded text. Tools Scripts Editing URI-decode selected text If part of the query string of a &URL; is selected, this will decode it and replace the selection with the original raw text. Tools Scripts Emmet Tools Scripts Emmet Expand abbreviation Converts the selected text to a pair of opening and closing &HTML; or &XML; tags. For example, if div is selected, this item will replace that with <div></div>. Tools Scripts Emmet Wrap with tag Wraps the selected text with the tag provided on the command line. Tools Scripts Emmet Move cursor to matching tag If the cursor is inside an opening &HTML;/&XML; tag, this item will move it to the closing tag. If the cursor is inside the closing tag, it will instead move it to the opening tag. Tools Scripts Emmet Select &HTML;/&XML; tag contents inwards When the cursor is inside a pair of &HTML;/&XML; tags, this option will change the selection to include the contents of those &HTML;/&XML; tags, without selecting the tags themselves. Tools Scripts Emmet Select &HTML;/&XML; tag contents outwards When the cursor is inside a pair of &HTML;/&XML; tags, this item will change the selection to include the contents of those &HTML;/&XML; tags, including the tags themselves. Tools Scripts Emmet Toggle Comment If the selected portion is not a comment, this item will enclose that portion in &HTML;/&XML; comments (⪚ <!-- selected text -->). If the selected portion is a comment, the comment tags will be removed instead. ToolsScriptsEmmet Delete tag under cursor If the cursor is presently inside a &HTML;/&XML; tag, this item will delete the entire tag. Tools Scripts Emmet Decrement number by 1 This item will subtract one from the currently selected text, if it is a number. For example, if 5 is selected, it will become 4. Tools Scripts Emmet Decrement number by 10 This item will subtract 10 from the currently selected text, if it is a number. For example, if 15 is selected, it will become 5. Tools Scripts Emmet Decrement number by 0.1 This item will subtract 0.1 from the currently selected text, if it is a number. For example, if 4.5 is selected, it will become 4.4. Tools Scripts Emmet Increment number by 1 This item will add one to the currently selected text, if it is a number. For example, if 5 is selected, it will become 6. Tools Scripts Emmet Increment number by 10 This item will add 10 to the currently selected text, if it is a number. For example, if 5 is selected, it will become 15. Tools Scripts Emmet Increment number by 0.1 This item will add 0.1 to the currently selected text, if it is a number. For example, if 4.5 is selected, it will become 4.6. &Ctrl;Space Tools Invoke Code Completion Manually invoke command completion, usually by using a shortcut bound to this action. Tools Word Completion Reuse Word Below (&Ctrl; 9) and Reuse Word Above (&Ctrl; 8) complete the currently typed text by searching for similar words backward or forward from the current cursor position. Shell Completion pops up a completion box with matching entries. &Ctrl;&Shift;O Tools Spelling Automatic Spell Checking When Automatic Spell Checking is enabled, wrongly spelled text is underlined in the document on-the-fly. Tools Spelling Spelling... This initiates the spellchecking program - a program designed to help the user catch and correct any spelling errors. 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: Unknown word: 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. Replace with: 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. Language: If you have installed multiple dictionaries, here you can select which dictionary/language should be used. On the right side of the dialog box are 6 buttons that allow the user to control the spellcheck process. They are: Add to Dictionary Pressing this button adds the Unknown word to the checker's dictionary. This means that in the future the checker will always consider this word to be correctly spelled. Suggest 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 Replace with box, above. Replace This button has the checker replace the word under consideration in the document with the word in the Replace with box. Replace All This button causes the checker to replace not only the current Unknown word: but to automatically make the same substitution for any other occurrences of this Unknown word in the document. Ignore Activating this button will have the checker move on without making any changes. Ignore All This button tells the checker to do nothing with the current Unknown word: and to pass over any other instances of the same word. This only applies to the current spellcheck run. If the checker is run again later it will stop on this same word. Three more buttons are located horizontally along the bottom of the spellcheck dialog. They are: Help This invokes the &kde; help system with the help page for this dialog. Finished This button ends the spellcheck process, and returns to the document. Cancel This button cancels the spellcheck process, all modifications are reverted, and you will return to your document. Tools Spelling Spelling (from cursor)... This initiates the spellchecking program but it starts where your cursor is instead of at the beginning of the document. Tools Spelling Spellcheck Selection... Spellchecks the current selection. Tools Spelling Change Dictionary 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. Tools Clean Indentation 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. Tools Align Causes a realign of the current line or selected lines using the indentation mode and indentation settings in the document. &Ctrl;D Tools Comment This adds one space to the beginning of the line where the text cursor is located or to the beginning of any selected lines. &Ctrl;&Shift;D Tools Uncomment 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. &Ctrl;U Tools Uppercase Put the selected text or the letter after the cursor in uppercase. &Ctrl;&Shift;U Tools Lowercase Put the selected text or the letter after the cursor in lowercase. &Ctrl;&Alt;U Tools Capitalize Capitalize the selected text or the current word. &Ctrl;J Tools Join Lines 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. Tools Apply Word Wrap 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 Wrap words at option in the Editing tab in SettingsConfigure Editor... The Settings and Help Menu &katepart; has the common &kde; Settings and Help menu items, for more information read the sections about the Settings Menu and Help Menu of the &kde; Fundamentals.