The Editor Component ConfigurationThis 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.AppearanceGeneralDynamic Word WrapIf 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 HighlightingHighlight tabulatorsThe editor will display a » symbol to indicate the presence
of a tab in the text.Highlight trailing spacesThe editor will display dots to indicate the presence of extra
whitespace at the end of lines.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.BordersBordersShow 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 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 & ColorsThis 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;.ColorsText Area BackgroundNormal textThis is the default background for the editor area, it will be
the dominant color on the editor area.Selected textThis is the background for selected text. The default is
the global selection color, as set in your &kde; color preferences.
Current lineSet the color for the current line. Setting this a bit different
from the Normal text background helps to keep focus on the current line.
BookmarkThis 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 ElementsLeft border backgroundThis 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 numbersThis color is used to draw the line numbers on the left side of
the view when displayed.Bracket highlightThis color is used to draw the background of matching brackets.
Word wrap markersThis 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 markersThis color is used to draw white space indicators when enabled.
Spelling mistake linesets the color of the line that is used to indicate spelling mistakes.
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 StylesThe 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 &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, rightclick to use the
context menu.Highlighting Text StylesHere 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.
EditingGeneralStatic 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 wrapTurns 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 SettingsConfigure 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.MiscRemove trailing spaces while editing&kappname; will automatically eliminate extra spaces
at the ends of lines of text.Auto bracketsWhen
the user types a left bracket ([, (, or {) &kappname; automatically enters the
right bracket (}, ), or ]) to the right of the cursor.Copy/Cut the current line if no selectionIf 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.Allow scrolling past the end of the documentThis 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.Cursor & SelectionText Cursor MovementSmart home and smart endWhen selected, pressing the home key will cause the cursor to
skip white space and go to the start of a line's text.Wrap cursorWhen 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 cursorThis 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 (lines):Sets the number of lines to maintain visible above and below the cursor
when possible.Text Selection ModeNormalSelections will be overwritten by typed text and will be lost on
cursor movement.PersistentSelections will stay even after cursor movement and typing.IndentationDefault 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 usingTabulatorsWhen this is enabled the editor will insert tabulator characters when you
press the 	 key or use automatic
indentation.SpacesWhen 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 SpacesWhen 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 PropertiesKeep Extra SpacesIf 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 clipboardIf this option is selected, pasted code from the clipboard is indented.
Triggering the Undo action removes the indentation.Indentation ActionsBackspace key in leading blank space unindentsIf 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 positionIf 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 levelIf 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 spaceIf 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 CompletionGeneralEnable auto completionIf 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 completeWhile 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.Vi Input ModeGeneralUse VI input modeWhen selected, the vi 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.Let Vi commands override Kate shortcutsWhen 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).Hide the Vi mode status barBy default, an extra status bar will be used when the Vi input mode is
enabled. This status bar shows commands while they are being typed and
messages/errors produced by Vi commands.Checking this option will hide this extra status line.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.
SpellcheckThese configuration options are described in the documentation for the
&systemsettings; module Spell Checker.Open/SaveGeneralFile FormatEncoding: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 DetectionSelect 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 EncodingThis 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 marker 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 detectionCheck 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 markerThe 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 LimitUnfortunately, due to defencies 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 Load/SaveRemove trailing spacesThe editor will automatically eliminate extra spaces at the ends of lines
of text while loading/saving the file.AdvancedFolder Config FileSearch depth for config file:The editor will search the given number of folder levels upwards
for &kappname; config file and load the settings line from it.
Further information about these hidden folder config files you find in the
document variables section.
Backup on SaveBacking 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 filesCheck this if you want backups of local files when
saving.Remote filesCheck this if you want backups of remote files when saving.PrefixEnter the prefix to prepend to the backup file names.SuffixEnter the suffix to add to the backup file names.Disable swap file syncing&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 checking the Disable swap file syncing box,
but this can lead to more data loss.Modes & FiletypesThis 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.NewThis 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.DeleteTo remove an existing filetype, select it from the drop down
box and press the Delete button.Properties of current filetypeThe 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
ToolsFiletypesSection: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.
ExtensionsThe 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 configurable plugin is checked, the
Configure button is enabled and you can click it
in order to configure the highlighted plugin.Editor Component PluginsAutoBraceThe autobrace plugin supersedes the &kappname; internal
Auto Brackets feature.
It automatically inserts a closing brace } at the beginning
of the next line after ending a line with an opening one {
and pressing the &Enter; key.Data ToolsEnables data tools like thesaurus and spell check (if installed).
Data tools are only available when text is selected, or when the right mouse
button is clicked over a word. If no data tools are offered even when text
is selected, you need to install them. Some data tools are part of the
&koffice; package.
If this plugin is enabled and data tools are installed, additional items
appear at the end of the context menu.ExporterThis command allows you to export the current document with all highlighting
information into a HTML document using FileExport
as HTML. Additionally you can use EditCopy as HTML to copy the currently selected text
as HTML to the system clipboard.IconInserterThe icon inserter plugin is only of use for &kde; developers: It adds an item
Insert KIcon-Code into the context menu of the editor.
If activated, the &kde;'s icon chooser opens (showing application icons, action icons &etc;..).
If you click on it, the file name without file extension will be inserted as
text. Useful only for setting icons via &kde;'s framework through the KIcon() class.
Insane (not ZEN) HTML coding (light edition)A plugin, which does zen-coding like selector completion.
For more information see
Zen Coding.Insert FileThis plugin allows you to insert any readable file at the cursor position.
If enabled, the Tools menu has an additional menu item
Insert File.