docs.kde.org
The Editor Component Configuration
Prev
Next

The Editor Component Configuration

This group contains all pages related to the editor component of Kate. 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

Word Wrap
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.

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.

Borders
Show folding markers (if available)

If this option is checked, the current view will display marks for code folding, if code folding is available.

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 scrollbar marks

If this option is checked the current view will show marks on the vertical scrollbar. These marks will for instance show bookmarks.

Sort Bookmarks Menu

By position

The bookmarks will be ordered by the line numbers they are placed at.

By creation

Each new bookmark will be added to the bottom, independently from where it is placed in the document.

Advanced

Enable Power User Mode (KDE 3 mode)

This option has no effect in Kate.

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.

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.

Kate 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 Kate.

Colors

Text Area Background
Normal text

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.

Bookmark

This combobox lets you set overlay colors for various mark types. The color is mixed into the background color of a marked line, so that a line with more marks or a marked line that is current has a background that is a mix of more colors. The mark colors are also used if you enable display of scrollbar marks.

Additional Elements
Left border background

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.

Bracket highlight

This color is used to draw the background of matching brackets.

Word wrap markers

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.

Tab and space markers

This color is used to draw white space indicators when enabled.

Fonts

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.

Normal Text Styles

The normal 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 Kate 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, rightclick 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, rightclick 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

Tabulators
Insert spaces instead of tabulators

When this is enabled the editor will insert a calculated number of spaces according to the position in the text and the tab-width setting when you press the Tab key.

Show tabulators

When this is enabled Kate will display a small dot as a visual representation of tabulator characters.

Note

This also causes dots to be drawn to indicate trailing white space. This will be fixed in a future version of Kate

Tab width

If the Insert spaces instead of tabulators option is selected this entry determines the number of spaces with which the editor will automatically replace tabs.

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. Kate 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 markers (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.

Misc
Remove trailing spaces

Kate will automatically eliminate extra spaces at the ends of lines of text.

Highlight trailing spaces

Kate will highlight extra spaces at the ends of lines of text.

Auto brackets

When the user types a left bracket ([, (, or {) Kate automatically enters the right bracket (}, ), or ]) to the right of the cursor.

Cursor & Selection

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.

Wrap cursor

When on, moving the insertion cursor using the Left and Right keys will go on to previous/next line at beginning/end of the line, similar to most editors.

When off, the insertion cursor cannot be moved left of the line start, but it can be moved off the line end, which can be very handy for programmers. When this option is chosen, moving the cursor with the arrow keys off the end of a line (to the right) causes it to jump down to the beginning of the next line. Likewise when the cursor is moved past the beginning of a line (to the left) it jumps up to the end of the preceding line. When this option is not selected, moving the cursor right past the end of a line merely causes it to continue horizontally in the same line and trying to move it left past the beginning does nothing.

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 Kate 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 (lines):

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.

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.

Indentation Properties
Indentation width:

The indentation width is the number of spaces which is used to indent a line. If the option Insert spaces instead of tabulators on the General tab in the Editing page is disabled, a Tab character is inserted if the indentation is divisible by the tab width.

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 code pasted from the clipboard

If this option is selected, pasted code 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 Tab to align the current line in the current code block like in emacs, make Tab a shortcut to the action Align.

Always advance to the next tab position

If this option is selected, the Tab 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 Tab 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 Tab 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
Auto Completion enabled

If this is enabled, the editor will calculate the number of spaces up to the next tab position as defined by the tab width, and insert that number of spaces instead of a Tab character.

Open & Save

General

File Format
Encoding:

This sets the default character encoding for your files.

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.

Automatic Cleanups on Load/Save
Remove trailing spaces

The editor will automatically eliminate extra spaces at the ends of lines of text while loading/saving the file.

Advanced

Folder Config File
Search depth for config file:

The editor will search the given number of folder levels upwards for Kate config file and load the settings line from it.

Backup on Save

Backing up on save will cause Kate 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.

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 Tools->Filetypes

Section:

The section name is used to organize the file types in menus. This is also used in the Tools->Filetypes menu.

Variables:

This string allows you to configure Kate's settings for the files selected by this mimetype using Kate variables. You can set almost any configuration option, such as highlight, indent-mode, encoding, etc.

For a full list of known variables, see the manual.

Highlighting:

If you create a new file type, this drop down box allows you to select a filetype for highlighting.

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 Kate website.

Shortcuts

You can change here the shortcut keys configuration. Select an action and click on Custom if you want a different shortcut for this action.

The search line allows you to look for a specific action and see its associated shortcut.

Extensions

This Plugins tab lists all available plugins and you can check those you want to use. Click on the Information button to open the About dialog of this plugin. Once a plugin is checked, the Configure button is enabled and you can click it in order to configure the highlighted plugin.

The selected plugins are available in the Tools menu.

Prev
Next
Contents


docs.kde.org