diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook
index 28616efdf..c4878e92e 100644
--- a/doc/kate/fundamentals.docbook
+++ b/doc/kate/fundamentals.docbook
@@ -1,633 +1,647 @@
The Fundamentals
If you have ever used a text editor, you will have no problem using
&kate;. In the next two sections, Starting
&kate; and in Working with
&kate;, we will show you everything you need to get up and running
quickly.
Starting &kate;
You can start &kate; from the application launcher or from the
command line.
From the Menu
Open the &kde; program menu by clicking on the
application launcher icon on the toolbar at the bottom left of your
screen. This will raise a menu. Move your
cursor up the menu to the ApplicationsUtilitiesAdvanced Text Editor &kate; menu item.
From the Command Line
You can start &kate; by typing its name on the command line. If you give
it a file name, as in the example below, it will open or create that
file.
%kate
If you have an active connection, and permission, you can take advantage
of &kde;'s network transparency to open files on the internet.
%kate
+To change the directory for temporary files, which defaults to /tmp
+set the TMPDIR environment variable before starting &kate;, ⪚
+
+
+%mkdir /tmp/kate -p && export TMPDIR=/tmp/kate && kate
+
+
+
+
Command Line Options&kate; accepts following command line options:kate
This lists the options available at the command line.
katename
Starts kate with the session name. The session is created
if it does not exist already. If a &kate; instance running the specified session
exists, the specified files are loaded in that instance.
katePID
Only reuses an instance with the specified PID (Process ID).
kateencodingURLUses the specified encoding for the document.
katelineURLNavigates to the specified line after opening the document.
katecolumnURLNavigates to the specified column after opening the document.
kateReads the document content from STDIN. This
is similar to the common option used in many command line
programs, and allows you to pipe command output into &kate;.kateStart &kate; with a new anonymous session, implies
.kateForce start of a new &kate; instance (is ignored if is
used and another &kate; instance already has the given session opened), forced
if no parameters and no URLs are given at all.kateIf using an already running &kate; instance, block until it exits, if URLs
given to open.
You can use &kate; with this option as editor for typing in commit messages for version
control systems like Git or Subversion.
These systems expect to block the editor till you have entered your
message, because they then open the temporary file, which would be empty
if kate immediately returned to the caller.
This option is also needed with KIO (&kde; Input/Output), if you open a remote file (which has been
downloaded to a temporary) and should be reuploaded, after you saved it.
kateWhen used, the specified files are treated as temporary files and
deleted (if they are local files and you have sufficient permissions) when
closed, unless they were modified since they were opened.
-
+
katefilename
-The base file name of the desktop entry for this application.
+The base file name of the desktop entry for this application.
+This is in particular useful for wrapper applications and
+applications having in general multiple desktop files. Thus each desktop
+file can have its own command line for the entry.
+kate
Lists &kate;'s authors in the terminal window.
kate
Lists version information for &kate;.
kate
Shows license information.
+
Drag and Drop
&kate; uses the &kde; Drag and Drop protocol. Files may be dragged and
dropped onto &kate; from the Desktop, the filemanager &dolphin; or some remote ftp
site opened in one of &dolphin;'s windows.
Working with &kate;
Quick Start will show you how to
toggle four simple options that will let you configure some of &kate;'s
more powerful features right away.
Shortcuts lays out some of the default keystroke
shortcuts for those who can't or don't want to use a mouse.
Quick Start
This section will describe some of the items on the
View menu so that you can quickly configure
&kate; to work the way you want it.
When you start &kate; for the first time you will see two windows
with white backgrounds. Above the two windows is a toolbar with the
usual labeled icons. And above that, a menubar.
The left-hand window is a side bar. It combines the Documents
and Filesystem Browser windows. Switch between the two by clicking on the tabs
to the left of the window.
If you've started &kate; with a file, the right-hand window will show
the file you are editing and the Documents on the side bar will show the
name of the file. Use the Filesystem Browser window to open files.
You can toggle all sidebar windows on and off in
ViewTool Views
menu or use &Ctrl;&Alt;&Shift;F.
This menu offers you your first glimpse into &kate;'s power and
flexibility.
In Tool Views you have a list of all enabled plugins.
Click the checkbox in front of each item or click with the &LMB; on the tool buttons
in the sidebar to toggle this tool view on and off.
Shortcuts
Many of &kate;'s keystroke commands (shortcuts) are configurable by
way of the Settings menu. By default
&kate; honors the following key bindings.
Insert
Toggle between Insert and Overwrite mode. When in insert mode the editor
will add any typed characters to the text and push any previously typed
data to the right of the text cursor. Overwrite mode causes the entry of
each character to eliminate the current character.Left ArrowMove the cursor one character to the left Right Arrow Move the cursor one character to the right Up Arrow Move the cursor up one line Down Arrow Move the cursor down one line Page Up Move the cursor up one page Page DownMove the cursor down one page &Backspace; Delete the character to the left of the cursor Home Move the cursor to the beginning of the line End Move the cursor to the end of the line DeleteDelete the character to the right of the cursor (or any selected
text)&Shift;&Enter;Insert newline including leading characters of the current line which are not letters or numbers.
It is useful ⪚ to write comments in the code: At the end of the line // some text press
this shortcut and the next line starts already with // . So you do not have to enter the comment
characters at the beginning of each new line with comments.&Shift;Left Arrow Mark text one character to the left &Shift;Right Arrow Mark text one character to the right F1 Help&Shift;F1What's this?&Ctrl;F FindF3 Find Next&Ctrl;BSet a Bookmark&Ctrl;C Copy the marked text to the clipboard &Ctrl;N New document&Ctrl;PPrint &Ctrl;QQuit - close active copy of editor &Ctrl;R Replace&Ctrl;SSave your file&Ctrl;V Paste&Ctrl;XDelete the marked text and copy it to the clipboard &Ctrl;ZUndo&Ctrl;&Shift;ZRedoWorking With the &kate; MDIOverviewWindow, View, Document, Frame, Editor... What are they all in
the terminology of &kate;, and how do you get the most out of it? This
chapter will explain all of that, and even more.The Main WindowMain window
The &kate; Main Window is a standard &kde; application window,
with the addition of side bars containing tool views. It has a
menubar with all the common menus, and some more, and a toolbar
providing access to commonly used commands.The most important part of the window is the editing area, by
default displaying a single text editor component, in which you can
work with your documents.The docking capabilities of the window is used for the tool
windows of any plugin enabled in the settings dialog.Tool views can be positioned in any sidebar, to move a tool right click
its sidebar button and select from the &RMB; menuA tool view can be marked as persistent in the &RMB;
menu for its sidebar button. The sidebar can contain
more tools at one time so that when a tool is persistent other tools can be
shown simultaneously.If a plugin has configuration options you can use the first item
in the context menu to open the corresponding page in &kate;'s
settings dialog.The Editor areaEditing Area
&kate; is capable of having more than one document open at the
same time, and also of splitting the editing area into any number of
frames, similar to how for example &konqueror; or the popular
emacs text editor works. This way you can
view several documents at the same time, or more instances of the same
document, handy for example if your document contains definitions in
the top that you want to see often for reference. Or you could view a
program source header in one frame, while editing the implementation
file in another.When a document is available in more than one editor, changes
made in one editor will immediately be reflected in the others as
well. This includes changing the text as well as selecting
text. Search operations or cursor movement is only reflected in the
current editor.It is currently not possible to have more instances of the same
document open in the sense that one instance will be edited while the
other will not.When splitting an editor into two frames, it is divided into two
equally sized frames, both displaying the current document of that
editor. The new frame will be at the bottom (in the case of a
horizontal split) or at the right (for a vertical split). The new
frame gets the focus, which is visualized by the blinking cursor bar in the
focused frame.Using SessionsSessions is how &kate; lets you keep more than one list of files and
GUI configuration around. You can have as many named sessions as you want,
and you can use unnamed or anonymous sessions for files you want to use only
once. Currently &kate; can save the list of open files, and the general window
configuration in the session; future versions of &kate; may add more features
that can be saved in sessions. With the introduction of sessions, &kate; also
allows you to open any number of instances of the application instead of just
one as it used to do as the default behavior.Sessions are supported in three areas:
Command line
options that lets you select and start sessions when launching
kate from the command line.The Sessions
menu that lets you switch, save, start and manage your
sessions.Configuration
options that lets you decide how sessions generally should
behave.When starting a new session, the GUI configuration of Default
Session is loaded. To save window configuration in the default
session, you need to enable saving window configuration in the sessions
configuration page of the configuration dialog and then load the default
session, set up the window as desired and save the session again.When a named session is loaded, &kate; will display the session name at
the start of the window title, which then has the form
"Session Name: Document name or
&URL; - &kate;"When opening files on the command line with or if a session is selected using the
session chooser, the specified session is loaded prior to the files specified
on the command line. To open files from the command line in a new, unnamed
session, configure kate to start a new session as default in the session page of
the configuration dialog or use with an empty string:
''.Since &kate; 2.5.1 the PID of the current instance is
exported to the environment variable KATE_PID. When opening files
from the built in terminal Kate will automatically select the current instance
if nothing else is indicated on the command line.Getting HelpWith &kate;This manualOffers detailed documentation on all menu commands,
configuration options, tools, dialogs, plugins &etc; as well as
descriptions of the &kate; window, the editor and various concepts
used in the application.Press F1 or use the
Help&kate; Handbook menu topic to view this
manual.What's This HelpWhat's This help offers immediate help with single elements of
graphical windows, such as buttons or other window areas.We strive to provide What's This help for any elements for which
it makes sense. It is available throughout the configuration dialog,
and in many other dialogs as well.To employ What's This help, press
&Shift;F1 or use the
HelpWhat's
This menu item to enable What's This
mode. The cursor will turn into an arrow with a question mark, and you
can now click any element in the window to read the What's This help
for that element, if it is available.Help Buttons in DialogsSome dialogs have a Help Button. Pressing
it will start the &khelpcenter; and open the relevant
documentation.With Your Text Files&kate; does not (yet!) provide any means for reading document
related documentation. Depending on the file you are editing, you may
find the Built in
Terminal Emulator helpful for viewing related &UNIX; manual pages or
info documentation, or you can use &konqueror;.Articles on &kate;&kate;'s homepage provides some
Articles and Howtos with further information beyond the scope of this handbook.
diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook
index 19a1b4087..7596c1c79 100644
--- a/doc/kate/index.docbook
+++ b/doc/kate/index.docbook
@@ -1,315 +1,315 @@
GDB">
]>
The &kate; Handbook&Anders.Lund; &Anders.Lund.mail;&Seth.Rothberg; &Seth.Rothberg.mail;&Dominik.Haumann; &Dominik.Haumann.mail;&TC.Hollingsworth; &TC.Hollingsworth.mail;20002001&Seth.Rothberg;200220032005&Anders.Lund;20052009&Dominik.Haumann;2011201220132014&TC.Hollingsworth;&FDLNotice;
-2016-08-27
-Applications 16.08
+2018-03-23
+Applications 18.04&kate; is a programmer's text editor by &kde;.
-This handbook documents &kate; Version 16.08
+This handbook documents &kate; Version 18.04KDEkdebaseKatetexteditorprogrammerprogrammingprojectsMDIMultiDocumentInterfaceterminalconsoleIntroduction
Welcome to &kate;, a programmer's text editor by &kde;.
Some of &kate;'s many features include configurable syntax
highlighting for languages ranging from C and C++ to
&HTML; to bash scripts, the ability to create and
maintain projects, a multiple document interface
(MDI), and a self-contained terminal emulator.
But &kate; is more than a programmer's editor. Its ability to open
several files at once makes it ideal for editing &UNIX;'s many
configuration files. This document was written in &kate;.
Editing this manual...
&fundamentals-chapter;
Working with the &kate; EditorFor information about the basics of working with the editor component
underlying &kate;, see the
Working with the
&katepart; Editor chapter of the &katepart; Handbook.
&plugins-chapter;
Advanced Editing ToolsFor information about the advanced editing tools included with &kate;,
see the Advanced Editing Tools chapter
of the &katepart; Handbook.
&development-chapter;
The VI Input ModeFor information about &kate;'s VI input mode, see the
VI Input Mode chapter
of the &katepart; Handbook.
&menu-chapter;
&configuring-chapter;
Credits and License
&kate;. Program copyright 2000, 2001, 2002 - 2005 by the &kate; developer team.
The &kate; team:&Christoph.Cullmann; &Christoph.Cullmann.mail;Project Manager & Core Developer&Anders.Lund; &Anders.Lund.mail;Core Developer, Perl syntax highlighting,
documentation&Joseph.Wenninger; &Joseph.Wenninger.mail;Core Developer, syntax highlightingMichael Bartl michael.bartl1@chello.atCore DeveloperPhlip phlip_cpp@my-deja.comThe project compiler&Waldo.Bastian; &Waldo.Bastian.mail;The cool buffer systemMatt Newell newellm@proaxis.comTesting...Michael McCallum gholam@xtra.co.nzCore DeveloperJochen Wilhemly digisnap@cs.tu-berlin.de&kwrite; Author&Michael.Koch; &Michael.Koch.mail;&kwrite; port to KParts&Christian.Gebauer; gebauer@bigfoot.comUnspecified&Simon.Hausmann; &Simon.Hausmann.mail;UnspecifiedGlen Parker glenebob@nwlink.com&kwrite; Undo History, KSpell integrationScott Manson sdmanson@alltel.net&kwrite; &XML; syntax highlighting support&John.Firebaugh; &John.Firebaugh.mail;Various Patches&Dominik.Haumann; &Dominik.Haumann.mail;Developer, Highlight wizardMany other people have contributed:Matteo Merli merlim@libero.itHighlighting for RPM Spec-Files, Diff and moreRocky Scaletta rocky@purdue.eduHighlighting for VHDLYury Lebedev Highlighting for SQLChris RossHighlighting for FeriteNick RouxHighlighting for ILERPG&John.Firebaugh;Highlighting for &Java;, and much more&Carsten.Niehaus;Highlighting for LaTeXPer WigrenHighlighting for Makefiles, PythonJan FritzHighlighting for Python&Daniel.Naber;Small bugfixes, &XML; pluginDocumentation copyright 2000,2001 &Seth.Rothberg;
&Seth.Rothberg.mail;Documentation copyright 2002, 2003, 2005 &Anders.Lund;
&Anders.Lund.mail;
&underFDL;
&underGPL;
Regular ExpressionsFor information about using regular expressions in &kate;, see the
Regular Expressions appendix
to the &katepart; Handbook.InstallationTo learn how to install &kate; and other &kde; applications on your system,
see the Installing chapter of the
&kde; Fundamentals documentation.
&documentation.index;
diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index 8c822be18..e243cc1f7 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -1,3071 +1,3162 @@
&Anders.Lund; &Anders.Lund.mail;Working with Plugins&kate; offers several plugins. There are two types of these plugins:
some are written in native C++, while others are written in the Python programming
language. There are subtle differences in these, described below.You can enable any type of plugin in the configuration dialog, which also
provides access to additional configuration options for plugins that require
it.&kate; Application Plugins
&kate; plugins are additional functions for the &kate; editor. They can
add extra menus and shortcuts, and extend &kate;'s features. You can
install as many or as few as you like, from within &kate;.
Open &kate;'s configuration dialog with
SettingsConfigure &kate;...
Select ApplicationPlugins to
choose the wanted plugins.
The available application plugins are:
Backtrace Browser
- Backtrace navigation tool viewBuild Plugin - Compile or Make and parse error messagesClose Except/Like
- Close group of documents based on a common path or file extensionCTags -
Look up definitions/declarations with CTags
+Document preview -
+Preview the document in the target format.
+
+Document switcher -
Quick document switching with &Alt;	 behaviorFile system browser -
File system browser tool viewDocuments - Displays the open files in a file tree&gdb; - Provides a
simple &gdb; frontendLumen - Lumen
is a Autocompletion Plugin for D, using the DCD autocompletion serverOpen Header
- Opens the corresponding .h/[.cpp|.c] fileProject Plugin - Project plugin for kateReplicodeRust code completion
- Code completion for Rust source codeSearch & Replace -
Search or replace patterns in opened documents or in files on diskSnippets tool view - Tool view embedding the snippets managementSQL Plugin - Execute
query on SQL databasesSymbol Viewer
- Extract and show reference symbols from sourceTerminal tool view - Tool view embedding a terminal widgetText Filter - Easy text filtering&XML;Completetion - Lists &XML; elements,
attributes, attribute values and entities allowed by DTD&XML; Validation- Validates &XML; files using xmllintBacktrace Browser PluginUsing the Backtrace Browser PluginThis plugin is meant for developers and probably of little use for users.
It shows a backtrace delivered by gdb in a listview in a &kate; toolview.
Clicking on an item opens the selected file and jumps to the correct line number.
It works for backtraces generated on your own machine, but it will also work for
backtraces from other people, &ie; with /home/dummy/qt-copy/…/qwidget.cpp
will still be found on other machines. For that to work, you have to index the
directories where the source code is located.
Sometimes there are several files with the same name, ⪚kdegraphics/okular/generators/dvi/config.hkdepim-runtime/resources/gmail/saslplugin/config.hTo pick the right choice, the plugin picks the last two parts of the url,
in this case this would bedvi/config.hsaslplugin/config.hAnd then usually the plugin finds the correct one.Indexing master and a branches of course will lead to a clash.ConfigurationOn the configuration page add the directories containing the source code.Backtrace Browser
Configure Paths in Backtrace browser tool view
Clicking OK will start indexing.
When indexing is finished, open the toolview Backtrace Browser.Now you can load a backtrace from the clipboard (⪚, when you clicked
Copy to Clipboard in DrKonqi) or from a file.SalmaSultana&TC.Hollingsworth; &TC.Hollingsworth.mail;Build PluginIntroductionThe Build plugin allows you to run actions like build, clean and compile
on a project.Using the Build PluginThe Build plugin adds a Build Output tool view at the
bottom and a Build menu on the menubar. The tool view can be used to configure
build target settings, while the menu can be used to perform build, clean and
compile actions.Build OutputThe Build Output tool view has two tabs:Target SettingsOutputTarget Settings tabThe target settings tab can be used to configure various build targets and define targets sets.To change the names or commands double click on the entries in the table and use the
dropdown box to select the active target set. Use the checkbox in front of each target to define a default.A new target set contains several configuration options:Working DirectoryYou can set the path to the project here. Leave this empty to
use the directory the current document is located in.BuildThis option lets you define the build command. It is set to
make by default.CleanThe option lets you define the clean command. It is set to
make clean by default.ConfigThis option lets you define the config command. It is set
to cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/usr/local ../
by default.On the top this plugin has a toolbar with the following buttons :
Build the selected target
Add a new build target
Create a new build target set
Copy a command or target set
Delete the current command or target setOutput tabThe Output tab shows the console output generated by
the last command.Use the slider at the top to show or hide categories of output:Full Output, Parsed Output,
Errors and Warnings or Only ErrorsEach line contains a message and the file name and line number if available.
Clicking on the error or warning takes you to the appropriate file and places
the cursor on the corresponding line number.To navigate to the previous error, press
&Ctrl;&Alt;Left.
To navigate to the next error, press
&Ctrl;&Alt;Right.Menu StructureBuildSelect TargetSelect from a list of targets configured by the user.BuildBuild Default TargetBuilds the target defined as default in the active target set.BuildBuild Previous TargetSwitch to the previous target configured by the user.BuildStopStop building a target.&Ctrl;&Alt;LeftBuildPrevious ErrorMoves the cursor to the location of the previous error in the
document.&Ctrl;&Alt;RightBuildNext ErrorMoves the cursor to the location of the next error in the
document.Thanks and AcknowledgmentsThe &kate; Build Plugin was written by Kåre Särs.Special thanks to Google Code-In 2011 participant Salma Sultana for
writing much of this section.Close Except/Like PluginIntroductionThis plugin allows you to close a group of documents based on their extension and path.Using the Close Except/Like PluginAssumed you have these documents opened in &kate;:/tmp/subfolder/test.h/tmp/test.cpp/tmp/test.txtThen you have the following options to close documents as displayed in the screenshot:Close ExceptUse the checkbox in the last item of the list to enable or disable a confirmation dialog.
The selected option will be applied to both close actions.
Menu StructureFileClose ExceptClose all open documents, except
those which match the path or file extension selected from the submenu.FileClose LikeClose all open documents
which match the path or file extension selected from the submenu.CTags PluginIntroductionCTags generates an
index (or tag) file of language objects found in source files that allows these
items to be quickly and easily located using this plugin in &kate;.
A tag signifies a language object for which an index entry is available
(or, alternatively, the index entry created for that object).Tag generation is supported for these
programming languages.
ConfigurationThe CTags plugin uses two different database files for the index.On the CTags settings page in &kate;'s configuration you can add or remove
directories containing the source code and regenerate the common CTags database.Common IndexCTags Settings
Configure CTags Global Database
At the bottom of the settings page you can adapt the CTags command.
For more information about all available options please read the CTags man page. This man page
is available in &khelpcenter; and you can also enter the &URL; man/:ctags
directly into &konqueror;
Clicking Update will start indexing.
When indexing is finished, close the dialog.Session IndexTo configure the session index open the CTags view.Index TargetsOn this tab you can add or remove directories containing the source code and manually
regenerate the session specific CTags database.DatabaseDatabase Settings
Configure CTags Session Database
Select another CTags database file, configure the CTags command or revert
to the default command.Using the CTags Plugin
You place the mouse cursor on the language object like function, symbol &etc;
that you are interested in and then select one of the actions in the
CTags menu to jump to the line and file where the object is
defined or declared.By default the actions in the CTags menu have no shortcuts assigned.
Use the keyboard shortcut editor
to configure your own shortcuts.Alternatively use the search field on the Lookup tab of the
CTags view.Entering characters into the search field will start the search and display matching names
of language objects like functions, classes, symbols &etc; together with type and filename.Select an item in the list to jump to the corresponding line in the source file.Menu StructureCTagsJump back one stepNavigate back in the history to the last visited tag.CTagsLookup Current TextOpens the Lookup tab of the CTags view and displays all
language objects matching the current text selection in the list.CTagsGo to DeclarationIf the cursor is in a definition object this will open the document
containing the corresponding declaration if needed, activate its view and
place the cursor at the start of the declaration.CTagsGo to DefinitionIf the cursor is in a declaration object this will open the document
containing the corresponding definition if needed, activate its view and
place the cursor at the start of the definition.
+
+
+
+
+Document Preview Plugin
+
+
+Introduction
+
+The plugin enables a live preview of the currently edited text document in the
+final format in the sidebar. So when editing ⪚ a Markdown text or an SVG image,
+the result is instantly visible next to the source text.
+
+
+For the display the plugin uses that KParts plugin which is currently selected
+as the preferred one for the &MIME; type of the document.
+If there is no KParts plugin for that type, no preview is possible.
+
+
+To change the preferred plugin open the File Associations
+module in the &systemsettings; and edit the Services Preference Order
+on the Embedding tab.
+
+
+
+
+
+
+Menu Structure
+
+
+
+
+ViewTool Views
+Show Preview
+
+
+Toggle the display of &kate;'s Document preview in a sidebar.
+
+
+
+
+
+
+Interface
+The buttons at the top of the preview window provide these actions:
+
+
+
+Lock the preview to a given document. Selecting this option ensures
+that if switching the focus to the view of another document in the same &kate;
+window, the preview will not follow to that document, but keep previewing
+this document.
+
+
+Enable or disable updates of the preview of the current document content
+
+
+Manually update the preview of the current document content
+
+
+A dropdown menu with actions from the KParts plugin
+
+
+
+
Document Switcher PluginMenu Structure&Ctrl;	ViewLast Used ViewsOpens a list with the last viewed documents:Last viewed documentsKeep the shortcut &Ctrl;	 pressed and
can use the Up, Down, Home or
End keys to navigate in the list. Pressing a char key consecutively
will cycle through all items with the first matching in the list.
If you release the shortcut keys the view will switch to the selected document in the list.
Filesystem BrowserThe Filesystem Browser is a folder viewer, allowing you to open
files from a displayed folder in the current frame.Menu StructureViewTool ViewsShow Filesystem BrowserToggle the display of &kate;'s Filesystem Browser.InterfaceFrom the top down, the Filesystem Browser consists of the following
elements:A ToolbarThis contains standard navigations tool buttons: BackCauses the folder view to cd to the previously displayed folder in the history.
This button is disabled, if there is no previous item. ForwardCauses the folder view to cd to the next folder in the history.
This button is disabled, if there is no next folder. BookmarksOpens a submenu to edit or add bookmarks and to add a new bookmark folder. Current Document FolderThis button will cause the folder view to
cd to the folder of the currently active
document if possible. This button is disabled, if the active document
is a new, unsaved file, or the folder in which it resides can not
be decided. OptionsShort ViewDisplays only the filenames.Detailed ViewDisplays Name, Date and
Size of the files.Tree ViewLike Short View, but folders can be expanded to view their contents.Detailed Tree ViewThis also allows folders to be expanded, but displays the additional columns
available in Detailed View.Show Hidden FilesDisplays files normally hidden by your &OS;.Automatically synchronize with current documentWhen this option is enabled the filesystem browser will automatically cd
to the folder of the document currently open in the editing area every time it changes.A Location EntryThis displays a breadcrumb navigation to the currently open folder, similarly to
&dolphin;. You can click on a any folder to browse to it, or click on one of the
arrows to the left of a folder to select any folders beneath it. You may also
select from your list of Places by clicking the leftmost icon in the breadcrumb
navigation, which displays an icon that represents your current Place.You can also click to the right of the breadcrumbs to change them to a text box
where you can type the path of a folder to browse. The &URL;
entry maintains a list of previously typed paths. To choose one, use
the arrow button to the right of the entry.The &URL; entry has folder auto-completion. The completion
method can be set using the &RMB; menu of the text
entry.A Folder ViewThis is a standard &kde; folder view.A Filter EntryThe Filter entry allows you to enter a filter for the files
displayed in the folder view. The filter uses standard globs; patterns
must be separated by white space. Example: *.cpp *.h
*.mocTo display all files, enter a single asterisk
*.The filter entry saves the last 10 filters entered between
sessions. To use one, press the arrow button on the right of the entry
and select the desired filter string. You can disable the filter by pressing
the Clear text button to the left of the autocompletion
arrow button.ConfigurationThis plugin can be configured on the Filesystem Browser page
of &kate;'s configuration.ToolbarConfigure the buttons on the Filesystem Browser toolbar
by moving the ones you want enabled to the Selected Actions
list, and order them using the arrow buttons at the side of the list.The Documents ListIntroductionDocuments list
The documents list displays a list of all documents currently open in
&kate;. Modified files will have a small floppy
disk icon on their left to indicate that state.On the top the Documents list has a toolbar with the following buttons:
Create new document
Open an existing document
Previous Document
Next Document
Save the current document
Save the current document under a new nameBy default, the Documents list appears in
Tree Mode, which displays the folder structure
surrounding all currently open documents. Also available is
List Mode, which displays a simple list of all
open documents. You can switch modes by right-clicking on the list and selecting
from the View Mode menu.If two or more files with the same name (located in different
folders) are open in List Mode, the names of the second will be prepended
(2) and so on. The tool-tip for the file will
display its full name including the path, allowing you to choose the
desired one.To display a document in the currently
active frame, click the document name in the list.The context menu has some common actions from the File menu.Additionally there are filemanager actions to rename or delete the file. With
Copy Filename you can copy the full path of the document
to the clipboard.You can sort the list in a few different ways by right clicking the
list and selecting from the Sort By menu.
The options are:
Document NameLists the documents alphabetically by their name.Document PathLists the documents alphabetically by the path to them.Opening OrderLists the documents in the order of opening.The document list will per default visualize your history by shading the
entries for the most recent documents with a background color. If the document
was edited, an extra color is blended in. The most recent document has the
strongest color, so that you can easily find the documents you are working on.
This feature can be disabled in the
Documents page
of the configuration dialog.The default location of the document list in the &kate; window is to the left of the
editing area.Menu Structure&Alt;UpViewPrevious DocumentOpens the document displayed above the currently open document in the Documents list.&Alt;DownViewNext DocumentOpens the document displayed below the currently open document in the Documents list.ViewShow ActiveDisplays the currently open document in the Documents list.ConfigurationBackground ShadingThis section allows you to enable or disable the background
shading visualization of your recent activity, and choose which colors to use if
enabled.Sort BySet how you want the document list sorted. This can be set
from the &RMB; menu in the document list as well.View ModeThis provides two options that effect the display of the
Documents tool view. The Tree View option will display
the documents in a tree underneath the folders they are in, while the
List View option will display a flat list of documents.
Show Full PathWhen Tree View and this option are enabled, the folder entries
displayed in the Documents tool view will display the full filesystem path to
the folder in addition to the name of the folder. It has no effect in List
View.MartinGergov&TC.Hollingsworth; &TC.Hollingsworth.mail;&gdb; PluginIntroduction&kate;'s &gdb; plugin provides a simple frontend to the popular &GNU;
Project Debugger.Previous experience with &gdb; is strongly recommended. For more
information on using &gdb;, visit the
&gdb; website.You can enable the &gdb; plugin in
the Plugins section of &kate;'s
configuration.For the plugin to work properly, you must have a source file (of any type
supported by &gdb;) and an executable.If you compile using &gcc;/g++ you might want to use
the -ggdb command line argument.
After these preparations are made, open the source file in &kate;,
enter the path to the executable in the Settings tab of the
Debug View tool view, and select
DebugStart Debugging
from the menu to get started.Menu and Toolbar StructureAll of these options are available in &kate;'s menus, and many are
available on the Debug toolbar as well.ViewTool ViewShow Debug ViewShows a tool view containing &gdb; output, the &gdb; command
line used, and other settings.ViewTool ViewShow Locals and StackShows a list of all currently loaded variables and their values and a &gdb; backtrace.
DebugTargetsA submenu containing a list of targets (executables).
DebugStart DebuggingStarts &gdb; with a target.DebugKill / Stop DebuggingStops &gdb;.DebugRestart DebuggingRestarts &gdb;.DebugToggle Breakpoint / BreakSet a breakpoint at the current cursor position.
DebugStep InExecute the present statement (function call will be debugged).
DebugStep OverExecute the present statement (function call will not be
debugged).DebugStep OutResumes execution until the program that is executing
terminates.DebugMove PCMove program counter (next execution).DebugRun To CursorRuns the program until it reaches current cursor position.
DebugContinueIgnores any breakpoints and executes program until it terminates
(successfully or not).DebugPrint ValuePrints the value of the variable that the cursor is currently
pointing to.SettingsToolbars Shown&gdb; PluginDisplay the debugging toolbar.Debug ViewThe Debug View tool view consists of several tabs:
&gdb; OutputContains output from &gdb; and a &gdb; command line.The Output TabThe Output tab.
The Output tab displaying the output from a
debugging session.
SettingsExecutablePath to the target (executable) for debugging.Working DirectoryThe current working directory provided to the target.
ArgumentsArguments passed to the program.Keep focusKeeps focus on the &gdb; command line.Redirect IOOpens a new IO tab in the Debug
View where you can view output and provide input to the running
program.The Settings dialogThe Settings dialog
The Settings dialog displaying the configuration
of a debugging session.
IOContains an area that displays output from the running program and a
command line where you may provide input to it.The IO TabThe IO tab.
The IO tab displaying output from a simple
test program.
Call Stack and LocalsThe Call Stack tool view contains a list of the formatted
backtrace returned from &gdb;.The &gdb; Call Stack Tool ViewThe Call Stack tool view.
The &gdb; Plugin's Call Stack tool view.
The Locals tool view contains a list of all currently
loaded variables from the program and their corresponding values.The &gdb; Locals Tool ViewThe Locals tool view.
The &gdb; Plugin's Locals tool view.
Thanks and AcknowledgmentsSpecial thanks to Google Code-In 2011 participant Martin Gergov for
writing much of this section.Lumen PluginLumen is a plugin providing code-completion for the
D programming language. It is just a connection between the editor and the D Completion
Daemon (a server providing all the information) called DCD. The plugin currently supports
all major features of the completion server: feeding the server with import files,
displaying documentation and several types of completion:
Imports:ImportsBasic Completion:Basic CompletionCompletion (overloaded Function):Completion (overloaded Function)Calltips:CalltipsTo make Lumen work you have to install DCD, using the information provided by
the D community.
After installing DCD edit ~/.config/dcd/dcd.conf (create if it does not exist already)
and add a path to your D include/import files ⪚ /usr/include/dlang/dmd
or /usr/include/d.
Furthermore Lumen will try to read a .lumenconfig in every parent folder
of the currently opened D source file and add every line in this file as include path to the
DCD server. Add all dependencies of your current project to this file.
Now start the completion server with dcd-server, enable the Lumen
plugin in your settings and you will have code completion for the D programming
language in &kate;
Open Header PluginUsing the Open Header PluginWhen editing C or C++ code, this command will switch between a header file and
its corresponding C/C++ file or vice versa.For example, if you are editing myclass.cpp, this action will change
to myclass.h if this file is available in the same folder.Pairs of the following filename extensions will work:Header files: h, H, hh, hppSource files: c, cpp, cc, cp, cxxMenu StructureF12FileOpen .h/.cpp/.cOpen the corresponding header or source files for the active document.Project PluginIntroductionThe basic idea of the Project plugin is to have a structured list of
files belonging to the project with the following properties:Provide a structured view of the filesMake it easy and very fast to open and switch projectsSupport search and replace for a projectProvide simple auto completionMake it simple to quickly open files in the projectSupport for building the projectStructured View of the FilesOnce the Project plugin is loaded in the &kate; configuration page, open a file
in a project and a sidebar
appears that lists all projects as well as the project files as follows:Project ViewAs you can see, the currently active project is Kate, and its contents is
listed in the tree view. Clicking on files in the tree view opens the file in the
editor. Further, a context menu is provided with which you can open files with
other applications, such as a .ui file with Qt Designer.You can filter the items by typing parts of the file name you are looking for into the search bar
at the bottom of the list.Switching ProjectsThe idea is that you never have to open a project manually, this is even not
supported at all. Hence, what happens if you open a file, the Project plugin quickly
scans the folder and its parent folders for a .kateproject file. If found, the project
is automatically loaded.Furthermore, if you open another document in &kate;, that belongs to another project,
the Project plugin automatically switches the current project. So intuitively, always the
correct project is active. Of course, you can also switch the currently active project
using the combo box.Search and Replace in Projects&kate; has a Search and Replace plugin that shows up in the
bottom sidebar. If a project is loaded, open the Search and Replace sidebar,
and switch to the mode to search and replace in the current project:Search in ProjectsSimple Auto CompletionWith the knowledge of all files belonging to a project, the Project plugin provides
simple auto completion facilities based on CTags. If a project is initially opened, CTags
parses all project files in a background thread and saves the CTags information to
/tmp. This file then is used to populate the auto
completion popup in &kate;.In contrast, without this auto completion, &kate; is only capable of showing auto
completion items based on the words in the current file. So the auto completion provided
by the Project plugin is much more powerful.Completion in ProjectsIf CTags is missing, a passive popup warns you about this issue. It is also noteworthy,
that the CTags file in /tmp is cleaned up when &kate;
exits, so the plugin does not pollute any folder with unwanted files.Quick Opening FilesAs clicking on files in the tree view is not the fastest way to open a file, &kate;
provides a built-in quick open mechanism you can activate with
&Ctrl;&Alt;O.
What you the get is a list like this:Quick OpenYou can filter by typing parts of the file name you are looking for, and you can
also navigate with the arrow keys and page up/down through the list.
Hitting &Enter; activates the selected file, while &Esc; hides the quick open view again.Further, the quick open remembers the previous file. So when you change to the
quick open view the previously activated file is automatically selected and you just
need to hit &Enter;, which comes very handy at times.Support for Building the ProjectAnother feature is to have support for the Build Plugin,
so that it automatically is configured correctly.Creating ProjectsLoading Projects AutomaticallyThe Project plugin has an auto-loading feature. You can read the file list from
the version control system. To this end, auto-loading for the respective version control
system needs to be enabled in the settings (enabled by default):
Project Plugin ConfigurationCreating Projects Manually
You just have to create a .kateproject file in the root folder of the project.
For instance, the Kate.kateproject file looks like this:
{
"name": "Kate"
, "files": [ { "git": 1 } ]
}
The file content is written in JSON syntax. The project name is Kate, and
the files contained in should be read from git.
Also supported instead of git is subversion through svn and
mercurial through hg.
If you do not want to read from a version control system, you can tell it to recursively
load files from directories as follows:
{
"name": "Kate"
, "files": [ { "directory": "kate", "filters": ["*.cpp", "*.h", "*.ui", "CMakeLists.txt", "Find*.cmake"], "recursive": 1 } ]
}
Here, subfolders and filters define what’s part of the project.
You can also mix version control and files based on filters.
If you want to add support for the Build plugin, you could write a
.kateproject like this:
{
"name": "Kate"
, "files": [ { "git": 1 } ]
, "build": {
"directory": "build"
, "build": "make all"
, "clean": "make clean"
, "install": "make install"
}
}
Current ProjectUsing &Alt;1ProjectsGo To you can open the
Current Project view at the bottom of the editor window with four tabs:Current ProjectTerminalA Terminal emulator starting in the
root folder of the project.Code IndexEntering characters into the search bar will start the search and display matching names
of functions, classes, symbols &etc; together with kind, filename and line number.Select an item in the list to jump to the corresponding line in the source file.Code AnalysisClick Start Analysis to run a static code analysis for the C and C++
using cppcheck and to generate a report showing filename, line number, severity
(style, warning &etc;) and the issue found.Select an item in the list to jump to the corresponding line in the source file.NotesText entered in this tab will be saved in the file
projectname.kateproject.notes.The Projects MenuThe Projects menu allows you to switch between
currently open projects. It is displayed by the Project plugin.&Ctrl;&Alt;LeftProjectsBackSwitch to the previous project.&Ctrl;&Alt;RightProjectsForwardSwitch to the next project.&Alt;1ProjectsGo ToOpen the Current Project view at the bottom of the editor window.Rust code completion PluginThis plugin provides code completion for the Rust
programming language.Once you have enabled the Rust code completion item in the plugin page, a new
page will appear in your &kate; configuration dialog.
Rust ConfigurationEdit the command to run Racer,
an utility intended to provide Rust code completion for editors.You also need the Rust source code and have to provide the path to the source tree.
While typing code a popup list appears with items for completion:
Rust CompletionIn addition to code completion popups, the plugin also installs
a Go to Definition action in the Edit menu and
in the context menu. You can configure a keyboard shortcut for it as well.
This action will open the document containing the definition if needed, activate
its view and place the cursor at the start of the definition.
&TC.Hollingsworth; &TC.Hollingsworth.mail;
Search & ReplaceIntroduction&kate;'s Search & Replace plugin allows you to search for text or
regular expressions
in many different files at once. You can search all open files, all the files
in one directory and optionally its subdirectories, or in the active file.
You can even filter by filename, for instance searching only files
that end with a particular file extension.InterfaceSearch QueryThe following options are always displayed at the top of the Search in
Files tool view:
You can have as many searches as you want open at the same time. Simply click
the new tab button at the top-left corner of the Search
tool view and a new results tab will open permitting you to perform another
search.
The button in the top right-corner of the Search in Files tool view will
toggle the bottom half of the tool view between displaying additional options
for the Search in Folder mode and the results of your search.
Find
This is where you type in what you want to find. You may enter standard text,
or a regular expression if enabled.
Replace (text box)
Replacement text that will be added to file(s) in place of the text in the
Find text box.
Search
When you've finished configuring everything, just press the
Search button to perform your search. You may also press
&Enter; in the Find text box to do the same.
Replace
When you've finished configuring everything, just press the
Replace button to replace the text entered in the
Find text box with that of the Replace
text box. You may also press &Enter; in the Replace text
box to do the same.
Next
Go to the next match of your search query, switching files if necessary.
Replace Checked
The same as Replace, but will only perform replacements
in files that are checked in the pane below.
Search in Folder OptionsThese options are displayed below the aforementioned query options. If search
results are being displayed instead, press the
button to display them.Search in
This has three options. Select Open Files to search all
files currently open in &kate;. Select Folder to
search inside a folder and optionally its subfolders. Select Current
File to search only in the active file.
If the Projects plugin is loaded, you can also search in
the Current Project or in All Open Projects.
Match case
Restricts search results to only those that have the exact same combination
of upper and lower case letters as your search query.
Regular expressions
Permits you to use regular
expressions instead of simple text as your search query.
Expand results
Display all the results found in each file, instead of just a list of files
that contain the search query.
Folder
You may enter the path of the folder you wish to search. For instance, you might
enter ~/development/kde/kate/ if you wished to search the
&kate; source code. This option is only available when using
in Folder mode.
Open file dialog
Press this button to locate the folder in your desktop's folder browser. This
button only works when using Folder mode.
Press this button to change Folder to the parent of the
currently selected folder. This button only works when using
Folder mode.
This button will set the Folder entry to the folder in which
the currently open document is located. This button only works when using
Folder mode.
Filter
This permits you to only search filenames that match a particular pattern. For
instance, to only search files written in C++, change it to
*.cpp. To search only files beginning with
kate, change it to kate*. You can
enter multiple filters separated with a comma (,). This
option is not available when using Open files mode.
Exclude
The opposite of Filter, this prevents &kate; from
searching files that match the specified patterns. As with
Filter, you can enter multiple patterns separated with a
comma (,). This option is not available when using
Open files mode.
Recursive
If this option is enabled, &kate; will also search in all subfolders of the
selected folder. This option is only available when using
Folder mode.
Include hidden
If this option is enabled, &kate; will also search in files or folders that
are typically hidden by your &OS;. This option is only available when using
Folder mode.
Follow symbolic links
The Search in Files plugin typically does not follow
symbolic links.
When this option is enabled, the plugin will follow them instead and search inside
the files or folders they reference. This option is only available when using
Folder mode.
It's possible for symbolic links to reference a folder that is the
parent of the folder currently being searched, or other folders that contain
symbolic links to their parent. If there is such a link in the folder being
searched and this option is enabled, &kate; will repeatedly follow the link
and search the folder, and the search will never complete.Include binary files
If enabled, &kate; will also search in files that do not appear to be text
files.
Search ResultsThe results of your search are displayed below the query options. If
options for Search in Folder mode are displayed, simply press the
button to display them. They will also
automatically be displayed as soon as a search is performed.The search results display a list of files that contains text that matches
your search query, followed by the number of matches found in that file.To see a list of matches in that file, simply click the expansion arrow
to the left of the file name. (If you selected the Expand
results option, this will already be done for you.) The line number
each match is found on will be displayed, followed by the contents of that line,
with your search query indicated in bold text.To open the file your result was found in, simply double-click it. &kate;
will open the file if needed. You can also move the cursor to the location of
a particular match by double-clicking on its listing instead of the file name.
Menu StructureEditSearch in FilesLaunches the Search and Replace tool view.EditGo to Next MatchGo to the next match in a search performed by the Search and Replace
plugin.EditGo to Previous MatchGo to the previous match in a search performed by the Search and Replace
plugin.ViewTool ViewsShow Search and ReplaceToggle the display of &kate;'s Search and Replace tool.
MartinGergov&TC.Hollingsworth; &TC.Hollingsworth.mail;Kate SnippetsIntroductionKate Snippets is a plugin used to save you some time by adding support for
so-called snippets (re-usable source code, machine code or text). The plugin
also supports code completion and JavaScript.Menu StructureViewTool ViewsShow SnippetsShows snippets panel containing all snippets in your repository
that are for the currently opened file type.ToolsCreate SnippetCreate a new snippet, which is a reusable chunk of text you
may insert in any part of any document.Snippets panelKate Snippets PanelThe &kate; snippets panel.
The panel for &kate; Snippets.
In the panel you should see a list of snippet repositories,
along with options to create your own, get them from the Internet or load
them from a local file. Each repository has a checkbox that can be used to
activate or deactivate it. There are also buttons to edit and delete existing
repositories.Loading Snippet Repository FilesYou can download snippet repositories from the Internet. Just click
Get New Snippets and a window with a list of snippet
repositories will open. After downloading the desired snippet, make sure that
you have activated it.Creating and Editing RepositoriesTo create a new snippet repository, click Add Repository.
You should now see a dialog that asks for the name of the snippet file, license and
author. After choosing the desired options, click OK.Snippet EditorThe repository editor.
The repository editor interface.
The snippet repository editor contains the following options:NameAppears in the list of snippets in the tool view and is also
searched when using the code completion feature.NamespacePrefix used while using code completion.LicenseSelect the license for you snippet repository.AuthorsEnter the name(s) of the author(s) of the snippet file.File typesSelect the file type(s) you want the snippet repository to apply
to. It is set to by default, so the repository applies to all files. You
can change it to something like C++ for instance, or select
from a list by clicking on the items. You can specify more
than one file type pressing the &Shift; while adding types.Creating and Editing SnippetsSnippet EditorThe snippet editor.
The snippet editor interface.
NameThe name will be shown in the completion list.ShortcutPressing this shortcut will insert the snippet into the document.SnippetsThe text your snippet will insert into the document.A snippet can contain editable fields. They can be cycled by
pressing 	. The following expressions can be used in the template
text to create fields:${field_name} creates a
simple, editable field. All subsequent occurrences of the same
field_name create fields which mirror the contents
of the first during editing.${field_name=default}
can be used to specify a default value for the field.
default can be any JavaScript expression.Use ${field_name=text}
to specify a fixed string as default value.${func(other_field1,
other_field2, ...)} can be used to create a
field which evaluates a JavaScript function on each edit and contains its
contents. See the Scripts tab for more information.${cursor} can be used to mark the end position
of the cursor after everything else was filled in.ScriptsJavaScript helper functions to use in your snippets.All JavaScript functions should return the contents you want to place in a
template field as a string.Functions are called in a scope which contains the contents of all
editable template fields as local variables. For example in a snippet
containing ${field},
a variable called field will be present which contains
the up-to-date contents of the template field. Those variables can either
be used in the function statically or passed as arguments, by using the
${func(field)} or ${field2=func(field)}
syntax in the snippet string.You can use
the &kate; scripting API to get the selected text, full text, file name and
more by using the appropriate methods of the document
and view objects. Refer to the scripting API
documentation for more informationUsing SnippetsKate Snippets in ActionAccessing &kate; Snippets from a tool view and a drop down menu.
Selecting from a list of snippets.
You can call snippets in two ways:By choosing the snippet from the tool view.While writing, you can press &Ctrl;
Space, which will display all the snippets in a
convenient window from which you can choose. This key combination provides
functionality similar to code completion.If the snippet contains variables (besides ${cursor})
the cursor will automatically go to the first occurrence of a variable and will
wait for you to write something. When you are done, you can press 	 to move
to the next variable, and so on.Thanks and Acknowledgments&kate; Snippets was written by Joseph Wenninger.Special thanks to Google Code-In 2011 participant Martin Gergov for
writing much of this section.ÖmerFarukORUÇ&TC.Hollingsworth; &TC.Hollingsworth.mail;SQL PluginIntroductionThe Structured Query Language (SQL) is a specialized language for updating,
deleting, and requesting information from databases.The &kate; SQL Plugin allows you to:Create a databaseConnect to existing databasesInsert and delete data in the databaseExecute queriesDisplay results in a tableConnecting to a DatabaseSelect Add Connection from the SQL
menu or toolbar, and then select the Qt database driver you want to use (including
QSQLITE, QMYSQL3, QMYSQL, QODBC3, QODBC, QPSQL7, and QPSQL). If you can't see
the desired driver, you need to install it. Then, press Next.
If the database you selected uses a file, simply indicate the database's
location and press the Next button. If it requires connecting
to a server, you must enter the hostname of the server, your username and password,
and any other information that particular driver may require. Then press
Next.Finally, give a name to your connection, and press Finish.Running QueriesINSERT/DELETE/UPDATEYou can insert, delete, and update data using the SQL plugin just as
you would from the command line or from within a program. Simply enter a query
and press the Run query button in the toolbar or
use SQLRun query
(&Ctrl;E).Some Example QueriesINSERT
INSERT INTO table_name ("feature1", "feature2", "feature3", "feature4", "feature5")
VALUES ("value1", "value2", "value3", "value4", "value5" )
DELETE
DELETE FROM table_name WHERE name = "text"
UPDATE
UPDATE table_name SET "feature1" = "text", "feature2" = "text", "feature3" = "text", "feature4" = "text", "feature5" = "text"
SELECTAfter running a SELECT query, you can view the results
as a table that will appear in the SQL Data Output tool view at
the bottom of &kate;, or as text in the SQL Text Output.
If there is an error, you can see it in the text output.Example SELECT Query
SELECT * FROM table_nameIn the SQL Data Output tool view, there are several buttons:Resize columns to contentsChanges the size of columns to fit their contents.Resize rows to contentsChanges the size of rows to fit their contents.CopySelects all of the table contents and copies it to the clipboard buffer.ExportExports all of the table contents to a file, the clipboard, or the
current document in the Comma Separated Values format.ClearRemoves everything from the table viewYou can now change the colors displayed in the table in the SQL
section of SettingsConfigure &kate;.BrowsingYou can browse your database using the Database schema browser
tool view on the left. The information displayed varies depending on which
database driver you are using.To refresh this list, right-click anywhere in the tool view and select
Refresh. To generate a query on any entry in the list,
right-click on an entry, select Generate, and select the
query type (SELECT, UPDATE,
INSERT, or DELETE) from
the submenu that appears.Menu StructureSQLAdd connection...
Adds a new connection using any database driver.
SQLRemove connection
Removes the selected connection.
SQLEdit connection...
Edits the current connection's settings.
Connections
All database connections you have created are listed between the
Edit connection and Run query
menu items. Select one to run queries or make modifications to it.
&Ctrl;ESQLRun query
Runs your query.
Thanks and AcknowledgmentsThe SQL Plugin was written by Marco Mentasti.Special thanks to Google Code-In 2011 participant Ömer Faruk ORUÇ for
writing much of this section.Symbol Viewer PluginUsing the Close Except/Like PluginIt allows developers to view symbols (functions, macros and structures) from source code.By clicking the parsed information you can easily browse the code.At the moment the following languages are supported:C/C++, Java, Perl, PHP, Python, Ruby, XSLT, Tcl/Tk, FortranFeature list:List/Tree modeEnable/disable sortingHide/Show Functions ParametersExpand/collapse tree modeAuto-update on document changeCode parsing is based on the Syntax-Highlighting framework from &kde-frameworks;Menu Structure&Ctrl;\ViewTool ViewsShow Symbol ListToggle the display of &kate;'s Symbol List displaying Functions, Macros and
Structures of the source code in the active document.ConfigurationSymbol Viewer
Choose the default parser options
Terminal Tool View PluginTerminal emulator
The built in Terminal Emulator is a copy of the &kde; &konsole;
terminal application, for your convenience. It is available from the
ViewTool ViewsShow Terminal menu item and will get the focus
whenever displayed. Additionally, if the Automatically synchronize
the terminal with the current document when possible option is enabled, it will
change to the directory of the current document if
possible when it is displayed, or when the current document
changes.The default location in the &kate; window is at the bottom,
below the editing area.You can configure the &konsole; using its &RMB; menu, for more
information, see the &konsole; manual.The built-in terminal emulator is provided by the Terminal Tool View plugin.Menu StructureViewTool ViewsShow TerminalToggles the display of the built-in terminal emulator.When activated for the first time, the terminal will be created.When the terminal emulator is displayed, it will get the focus, so that
you can start typing in commands immediately. If the Automatically synchronize the terminal
with the current document when possible option is enabled in the
Terminal page of the Main configuration dialog the shell session will
change to the directory of the active document, if it is a local file.ToolsPipe to
TerminalFeed the currently selected text into the built-in terminal
emulator. No newline is added after the text.ToolsSynchronize Terminal with Current DocumentThis will cause the built-in Terminal to cd into the
directory of the active document.Alternatively, you can configure &kate; to always keep the terminal in
sync with the current document. See
for more information.ToolsFocus/Defocus TerminalSwitch the focus from the current document to the terminal and vice versa.
ConfigurationYou can configure the Terminal Tool View plugin on the
Terminal page of the
configuration dialog.The following options are available:Automatically synchronize the terminal with the current document when possibleThis will cause the built-in terminal to
cd into the directory of the active document when
launched and when a new document gets the focus. If not enabled, you
have to do all your navigation in the terminal on your own.
Set EDITOR environment variable to 'kate -b'This sets the EDITOR environment variable so programs
run in the built-in terminal that automatically open a file in an editor will open
them in &kate; instead of the default editor configured in your shell. You will
not be able to continue using the terminal until you have closed the file in &kate;,
so the calling program is aware you have finished editing the file.Text Filter PluginUsing the Text Filter PluginYou can use this plugin to execute shell commands. A selection will
be used as argument for the shell command, the output will either replace the selection
or copied to the clipboard.
Examples:less /etc/fstab - paste the contents of this file or copy it to the clipboard
wc - count lines, words and characters of the selection and
paste this into the document or copy it to the clipboard
sort - sort lines of the selection and paste the result into
the document or copy it to the clipboard
Menu Structure&Ctrl;\ToolsFilter TextOpens the Text Filter dialog:Text Filter dialogEnter the shell command into the combobox or select a previous command from the history.Copy the result instead of pasting itCopy the result to clipboard leaving a document unchanged.Merge STDOUT and STDERR
If checked, an output from STDOUT and STDERR will be merged and no errors will be reported.
Otherwise, STDERR will be displayed as a passive message.
&Daniel.Naber; &Daniel.Naber.mail;
&XML; ValidationThis plugin checks &XML; files for validity and being well-formed.This plugin checks the current file. A list of warnings and errors
will appear at the bottom of &kate;'s main window. You can click on an error message
to jump to the corresponding place in the file. If the file has a DOCTYPE
the DTD given with this doctype will be used to check the file for validity. The
DTD is expected at a position relative to the current file, ⪚ if the doctype
refers to DTD/xhtml1-transitional.dtd and the file is /home/peter/test.xml
the DTD is expected to be located at /home/peter/DTD/xhtml1-transitional.dtd.
However, remote DTDs specified via http are supported.If the file has no doctype it will be checked for being well-formed.To learn more about &XML; check out the official W3C &XML; pages.Internally this plugin calls the external command xmllint, which
is part of libxml2. If this command is not correctly installed on your system, the plugin
will not work.To load this plugin open &kate;'s configuration dialog under SettingsConfigure &kate;....
Then select &XML; Validation which will appear
in the Application / Plugins section and close the dialog.
Menu Structure&XML;Validate &XML;This will start the check, as described above.Thanks and Acknowledgments
&kate; Plugin &XML; Validation copyright 2002 &Daniel.Naber;
&Daniel.Naber.mail;.
Documentation copyright 2002 &Daniel.Naber;
&Daniel.Naber; &Daniel.Naber.mail;
&XML; CompletionThis plugin gives hints about what is allowed at a certain position in
an &XML; file, according to the file's DTD. It will list possible
elements, attributes, attribute values or entities, depending on the
cursor position (⪚ all entities are listed if the character on the left
of the cursor is &). It's also possible to close the nearest
open tag on the left.The DTD must exist in &XML; format, as produced by the Perl program
dtdparse. We will call a DTD in this format meta DTD.
Some meta DTDs are supplied. They are installed in
katexmltools/ in
qtpaths,
which is also the default folder when you choose
Assign Meta DTD....
To produce your own meta DTDs, get dtdparse from
http://dtdparse.sourceforge.net.How to UseStart &kate; and open the configuration dialog under SettingsConfigure &kate;....
Then select &XML; Completion which will appear
in the ApplicationPlugins page and close the dialog. After
that, select &XML;Assign Meta DTD....
If your document contains no DOCTYPE or the doctype is unknown, you will have to
select a meta DTD from the file system. Otherwise the meta DTD that
matches the current document's DOCTYPE will be loaded automatically.You can now use the plugin while typing your text:< (less than key)This will trigger a list of possible elements unless the
cursor is inside a tag already. Note that you currently cannot use
this to insert the top level element (⪚ <html>).</(less than key + slash)Entering these characters will offer to close the current element
(nearest open one to the left of the cursor). Press &Enter; to accept the suggestion.
Unlike the Close Element menu item, this works only with
a DTD assigned." (quote key)The quote key will trigger a list of possible attribute
values (if there are any) if you are inside a tag. (space key)This key will trigger a list of possible attributes for the
current element if you are inside a tag.& (ampersand key)This key will trigger a list of named entities.Features and LimitationsYou can test all functions and limitations by loading
katexmltools/testcases.xml in
qtpaths
into &kate; and following the instructions.Menu Structure&Ctrl;Return&XML;Insert Element...This will open a dialog that lets you insert an &XML; element.
The <, > characters and the closing tag will be inserted automatically.
If you have selected text when this menu item is selected, the selected
text will be surrounded by the opening and the closing tag.
The dialog also offers completion of all elements that may be inserted
at the current cursor position if you have assigned a meta DTD by
using Assign Meta DTD....
&Ctrl;<&XML;Close ElementThis will search your text for a tag that is not yet closed
and will close it by inserting the corresponding closing tag.
The search starts at the cursor position and goes left. If
it cannot find an open tag nothing will happen.&XML;Assign Meta DTD...This will tell the plugin which meta DTD to use for the
current document. Note that this assignment will not be saved.
You will have to repeat it when you start &kate; the next time.Thanks and Acknowledgments
&kate; Plugin &XML; Completion copyright 2001,2002 &Daniel.Naber;
&Daniel.Naber.mail;.
KDE SC 4 version copyright 2010 Tomáš TrnkaDocumentation copyright 2001,2002 &Daniel.Naber;