[kde-doc-english] [kate] doc/kate: kate doc update to 4.10, not finished
Burkhard Lück
lueck at hube-lueck.de
Thu Jan 24 20:22:40 UTC 2013
Git commit 2db36c4590bd3ac2b689c9c4f800f3b9bc9c2426 by Burkhard Lück.
Committed on 24/01/2013 at 21:22.
Pushed by lueck into branch 'master'.
kate doc update to 4.10, not finished
M +27 -28 doc/kate/configuring-part.docbook
M +1 -1 doc/kate/configuring.docbook
M +3 -2 doc/kate/fundamentals.docbook
M +7 -4 doc/kate/index.docbook
M +66 -32 doc/kate/menus.docbook
M +59 -165 doc/kate/plugins.docbook
D +- -- doc/kate/snippets-config.png
M +- -- doc/kate/snippets-form.png
A +- -- doc/kate/snippets-panel.png
http://commits.kde.org/kate/2db36c4590bd3ac2b689c9c4f800f3b9bc9c2426
diff --git a/doc/kate/configuring-part.docbook b/doc/kate/configuring-part.docbook
index 06a3129..cb7cbd2 100644
--- a/doc/kate/configuring-part.docbook
+++ b/doc/kate/configuring-part.docbook
@@ -124,6 +124,21 @@ For more information, see <xref linkend="kate-part-line-modification"/>.
will show marks on the vertical scrollbar. These marks will
for instance show bookmarks.</para></listitem>
</varlistentry>
+<varlistentry>
+<term><guilabel>Show Mini-Map
+</guilabel></term>
+<listitem><para>If this option is checked, every new view will show a mini map of the
+<!--FIXME remove when next option is enabled-->whole<!--FIXME-->
+document on the vertical scrollbar.</para></listitem>
+</varlistentry>
+<!--FIXME disabled in 4.10/master
+<varlistentry>
+<term><guilabel>Map the whole document
+</guilabel></term>
+<listitem><para>If this option is checked, every new view will show a mini map of the whole
+document on the vertical scrollbar, otherwise only a map of the current page.</para></listitem>
+</varlistentry>
+-->
</variablelist>
</listitem>
</varlistentry>
@@ -422,7 +437,7 @@ documentation</ulink>.</para></listitem>
</sect3>
<sect3 id="prefcolors-fonts">
-<title>Fonts</title>
+<title>Font</title>
<para>
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
@@ -431,8 +446,8 @@ displays at the bottom of the dialog, so you can see the effect of your choices.
</sect3>
<sect3 id="prefcolors-normal-text-styles">
-<title>Normal Text Styles</title>
-<para>The normal text styles are inherited by the highlight text styles,
+<title>Default Text Styles</title>
+<para>The default text styles are inherited by the highlight text styles,
allowing the editor to present text in a very consistent way, for example comment
text is using the same style in almost all of the text formats that &kappname; can
highlight.</para>
@@ -522,12 +537,6 @@ automatically start a new line.</para>
<para>If this option is enabled and the text selection is empty, copy and cut
action are performed for the line of text at the actual cursor position.</para></listitem>
</varlistentry>
-
-<varlistentry>
-<term><guilabel>Allow scrolling past the end of the document</guilabel></term> <listitem>
-<para>This option lets you scroll past the end of the document. This can be used to vertically centre the bottom of the document, or put it on top of the current view.</para></listitem>
-</varlistentry>
-
</variablelist>
</listitem>
</varlistentry>
@@ -536,7 +545,7 @@ action are performed for the line of text at the actual cursor position.</para><
</sect3>
<sect3 id="pref-edit-cursor-selection">
-<title>Cursor & Selection</title>
+<title>Text Navigation</title>
<variablelist>
@@ -592,6 +601,11 @@ cursor movement.</para>
<para>Selections will stay even after cursor movement and typing.</para>
</listitem>
</varlistentry>
+<varlistentry>
+<term><guilabel>Allow scrolling past the end of the document</guilabel></term> <listitem>
+<para>This option lets you scroll past the end of the document. This can be used to vertically centre the bottom of the document, or put it on top of the current view.</para></listitem>
+</varlistentry>
+
</variablelist>
</listitem>
</varlistentry>
@@ -1147,6 +1161,7 @@ want to use. Click on the <guibutton>Information</guibutton> button to open the
<para>Once a configurable plugin is checked, the
<guibutton>Configure</guibutton> button is enabled and you can click it
in order to configure the highlighted plugin.</para>
+<!--FIXME duplicated content also in plugins.docbook-->
<variablelist>
<title>Editor Component Plugins</title>
<!-- not released with 4.7
@@ -1170,16 +1185,6 @@ You, the developer, are writing a line of code, and want to open a new block del
If you press Enter and AutoBrace is enabled, it will insert your favorite new brace where it belongs. Looks like this:
-->
<varlistentry>
-<term><guilabel>Data Tools</guilabel></term>
-<listitem><para>Enables 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.</para></listitem>
-</varlistentry>
-<varlistentry>
<term><guilabel>Exporter</guilabel></term>
<listitem><para>This command allows you to export the current document with all highlighting
information into a HTML document using <menuchoice><guimenu>File</guimenu><guimenuitem>Export
@@ -1187,12 +1192,12 @@ as HTML</guimenuitem></menuchoice>. Additionally you can use <menuchoice><guimen
<guimenuitem>Copy as HTML</guimenuitem></menuchoice> to copy the currently selected text
as HTML to the system clipboard.</para></listitem>
</varlistentry>
-<!-- not in 4.7
+<!--FIXME not in master, but in 4.10 ??-->
<varlistentry>
<term><guilabel>Highlight Selection</guilabel></term>
+<!--http://kate-editor.org/2010/11/14/highlight-selected-text/-->
<listitem><para>Highlights all words that match the currently selected text.</para></listitem>
</varlistentry>
--->
<varlistentry>
<term><guilabel>IconInserter</guilabel></term>
<listitem><para>The icon inserter plugin is only of use for &kde; developers: It adds an item
@@ -1203,12 +1208,6 @@ text. Useful only for setting icons via &kde;'s framework through the KIcon() cl
</para></listitem>
</varlistentry>
<varlistentry>
-<term><guilabel>Insane (not ZEN) HTML coding (light edition)</guilabel></term>
-<listitem><para>A plugin, which does zen-coding like selector completion.
-For more information see <ulink url="http://en.wikipedia.org/wiki/Zen_Coding">
-Zen Coding</ulink>.</para></listitem>
-</varlistentry>
-<varlistentry>
<term><guilabel>Insert File</guilabel></term>
<listitem><para>This plugin allows you to insert any readable file at the cursor position.
If enabled, the <guimenu>Tools</guimenu> menu has an additional menu item
diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook
index 9849c00..e578765 100644
--- a/doc/kate/configuring.docbook
+++ b/doc/kate/configuring.docbook
@@ -204,7 +204,7 @@ window configuration) will always be saved.</para>
</sect2>
<sect2 id="config-dialog-treeview">
-<title>Tree View</title> <!-- Tree View was renamed to Documents - http://commit-digest.org/issues/2011-08-28/ -->
+<title>Documents</title> <!-- Tree View was renamed to Documents - http://commit-digest.org/issues/2011-08-28/ -->
<!-- Tree View plugin http://kate-editor.org/2010/09/10/tree-view-plugin-introduction/ -->
<variablelist>
<varlistentry>
diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook
index a451880..1879161 100644
--- a/doc/kate/fundamentals.docbook
+++ b/doc/kate/fundamentals.docbook
@@ -314,7 +314,8 @@ this is in mdi.docbook
</term>
<listitem>
<para>
-Toggles the Documents on and off. If the Documents/Filesystem Browser window is
+Toggles the Documents on and off.
+<!--FIXME no longer in kate 3.10/kde 4.10-->If the Documents/Filesystem Browser window is
not open, &kate; launches the side bar as a separate, undocked,
window. To dock the window grab the two thin parallel lines above the
tabs by clicking on them with your &LMB; and holding the button
@@ -325,7 +326,7 @@ prefer.
<tip>
<para>
-If you have grabbed the two parallel lines successfully your mouse
+<!--FIXME no longer in kate 3.10/kde 4.10-->If you have grabbed the two parallel lines successfully your mouse
pointer will turn into two crossed arrows as you drag.
</para>
</tip>
diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook
index 18bfa45..825b3d4 100644
--- a/doc/kate/index.docbook
+++ b/doc/kate/index.docbook
@@ -54,13 +54,13 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2012-02-26</date>
-<releaseinfo>3.9 &kde; 4.9</releaseinfo>
+<date>2012-11-12</date>
+<releaseinfo>3.10 &kde; 4.10</releaseinfo>
<abstract>
<para>&kate; is a programmer's text editor for &kde; 4 and above.</para>
-<para>This handbook documents &kate; Version 3.9</para>
+<para>This handbook documents &kate; Version 3.10</para>
</abstract>
<keywordset>
@@ -81,7 +81,10 @@
</keywordset>
</bookinfo>
-
+<!-- FIXME
+ckeck http://kate-editor.org/2012/06/30/kate-in-kde-4-9/
+http://kate-editor.org/2012/11/02/using-the-projects-plugin-in-kate/
+ -->
<chapter id="introduction">
<title>Introduction</title>
diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook
index ee9dd03..d843545 100644
--- a/doc/kate/menus.docbook
+++ b/doc/kate/menus.docbook
@@ -370,7 +370,10 @@ all to work with the currently active document.</para>
<note><para>If Overwrite Selection is enabled, the pasted text will overwrite the selection, if any.</para></note>
</listitem>
</varlistentry>
-
+<!--FIXME
+Clipboard history
+list of items copied to clipboard
+ -->
<varlistentry>
<term>
<anchor id="edit-select-all"/>
@@ -468,7 +471,7 @@ Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para>
<anchor id="edit-find-next"/>
<menuchoice>
<shortcut><keycombo action="simul"><keycap>F3</keycap></keycombo></shortcut>
-<guimenu>Edit</guimenu>
+<guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu>
<guimenuitem>Find Next</guimenuitem>
</menuchoice>
</term>
@@ -482,7 +485,7 @@ Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para>
<anchor id="edit-find-previous"/>
<menuchoice>
<shortcut><keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo></shortcut>
-<guimenu>Edit</guimenu>
+<guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu>
<guimenuitem>Find Previous</guimenuitem>
</menuchoice>
</term>
@@ -492,25 +495,12 @@ Mode, either <guilabel>INS</guilabel> or <guilabel>OVR</guilabel>.</para>
</varlistentry>
<varlistentry>
-<term>
-<anchor id="edit-replace"/>
-<menuchoice>
-<shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut>
-<guimenu>Edit</guimenu>
-<guimenuitem>Replace...</guimenuitem>
-</menuchoice>
-</term>
-<listitem>
-<para>Launch the power search and replace bar to replace one or more instances of a defined text with something else.</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
<term id="find-selected">
<menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
-<guimenu>Edit</guimenu><guimenuitem>Find Selected</guimenuitem></menuchoice></term>
+<guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu>
+<guimenuitem>Find Selected</guimenuitem></menuchoice></term>
<listitem>
<para>Finds next occurrence of selected text.</para>
</listitem>
@@ -521,7 +511,8 @@ action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
<menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></shortcut>
-<guimenu>Edit</guimenu><guimenuitem>Find Selected Backwards</guimenuitem></menuchoice></term>
+<guimenu>Edit</guimenu><guisubmenu>Find Variants</guisubmenu>
+<guimenuitem>Find Selected Backwards</guimenuitem></menuchoice></term>
<listitem>
<para>Finds previous occurrence of selected text.</para>
</listitem>
@@ -529,6 +520,20 @@ action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></shortcut>
<varlistentry>
<term>
+<anchor id="edit-replace"/>
+<menuchoice>
+<shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut>
+<guimenu>Edit</guimenu>
+<guimenuitem>Replace...</guimenuitem>
+</menuchoice>
+</term>
+<listitem>
+<para>Launch the power search and replace bar to replace one or more instances of a defined text with something else.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>
<anchor id="edit-go-to-line"/>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></shortcut>
@@ -615,6 +620,27 @@ The new instance will be identical to your previous instance.
<varlistentry>
<term>
+<anchor id="view-quick-open"/>
+<menuchoice>
+<shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>O</keycap></keycombo></shortcut>
+<guimenu>View</guimenu>
+<guimenuitem>Quick Open</guimenuitem>
+</menuchoice>
+</term>
+<listitem>
+<para>Show a search field and a list of opened files in the editor area.
+While entering text in the search
+field the document names and document urls are searched for matching text.
+While entering text in the search field you can use
+the cursor keys <keysym>Up</keysym> and <keysym>Down</keysym> to navigate in the
+list view. Pressing the &Enter; key or double clicking on an item in the list switches
+the view to the document selected in the list view. This makes switching between
+documents easier, if there are a lot of them open.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>
<anchor id="view-split-previous"/>
<menuchoice>
<shortcut><keycombo action="simul">&Shift;<keycap>F8</keycap></keycombo></shortcut>
@@ -695,9 +721,8 @@ the File List.</para> <para>See also <link linkend="kate-mdi">Working with the
&kate; MDI</link></para>
</listitem>
</varlistentry>
-<!-- missing
+<!-- FIXME missing
Split View -> Move Splitter Left/Right/Up/Down
- not in 4.6
-->
<varlistentry>
<term><menuchoice><guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu>
@@ -750,7 +775,7 @@ change to the directory of the active document, if it is a local file.</para>
enabled by default.</para>
</listitem>
</varlistentry>
-
+<!--FIXME depending on selected plugins more items here e.g. Show Snippets -->
</variablelist>
</listitem>
</varlistentry>
@@ -858,7 +883,7 @@ vertical scrollbar. When enabled, marks are represented by a thin line in the
mark color at the scrollbar, middleclicking on the lines will scroll the view
to a position near the mark.</para></listitem>
</varlistentry>
-
+<!--FIXME Show Mini-Map missing-->
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul"><keycap>F9</keycap>
</keycombo></shortcut>
@@ -898,6 +923,7 @@ Code Folding</link>.</para></listitem>
</term>
<listitem><para>Expand all regions in the document.</para></listitem>
</varlistentry>
+<!--FIXME Fold Multiline Comments missing -->
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;
&Shift;<keycap>-</keycap></keycombo></shortcut>
@@ -952,13 +978,17 @@ Code Folding</link>.</para></listitem>
</varlistentry>
<varlistentry>
-<term><menuchoice><guimenu>View</guimenu><guimenuitem>Enlarge Font</guimenuitem></menuchoice>
+<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;
+<keycap>+</keycap></keycombo></shortcut>
+<guimenu>View</guimenu><guimenuitem>Enlarge Font</guimenuitem></menuchoice>
</term>
<listitem><para>This increases the display font size.</para></listitem>
</varlistentry>
<varlistentry>
-<term><menuchoice><guimenu>View</guimenu><guimenuitem>Shrink Font</guimenuitem></menuchoice>
+<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;
+<keycap>-</keycap></keycombo></shortcut>
+<guimenu>View</guimenu><guimenuitem>Shrink Font</guimenuitem></menuchoice>
</term>
<listitem><para>This decreases the display font size.</para></listitem>
</varlistentry>
@@ -1235,7 +1265,7 @@ own scripts</link>. This way, &kate; can be extended with user-defined tools.
<para>The following scripts are included by default:</para>
<variablelist>
-
+ <!--FIXME more items in 4.10 -->
<varlistentry id="tools-scripts-sort">
<term><menuchoice>
<guimenu>Tools</guimenu><guisubmenu>Scripts</guisubmenu>
@@ -1327,7 +1357,7 @@ Completion</guimenuitem> pops up a completion box with matching entries.</para>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
</shortcut>
-<guimenu>Tools</guimenu>
+<guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu>
<guimenuitem>Automatic Spell Checking</guimenuitem>
</menuchoice></term>
<listitem>
@@ -1338,7 +1368,7 @@ is underlined in the document on-the-fly.</para>
<varlistentry>
<term><anchor id="tools-spelling"/><menuchoice>
-<guimenu>Tools</guimenu><guimenuitem>Spelling...</guimenuitem></menuchoice>
+<guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu><guimenuitem>Spelling...</guimenuitem></menuchoice>
</term>
<!--para>These options are described in the documentation for the
@@ -1450,7 +1480,7 @@ are reverted, and you will return to your document.</para></listitem>
<variablelist>
<varlistentry>
<term><anchor id="tools-spelling-from-cursor"/><menuchoice>
-<guimenu>Tools</guimenu>
+<guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu>
<guimenuitem>Spelling (from cursor)...</guimenuitem></menuchoice></term>
<listitem>
<para>This initiates the spellchecking program but it starts where your cursor
@@ -1460,7 +1490,7 @@ is instead of at the beginning of the document.</para>
<varlistentry>
<term><anchor id="tools-spellcheck-selection"/><menuchoice>
-<guimenu>Tools</guimenu>
+<guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu>
<guimenuitem>Spellcheck Selection...</guimenuitem></menuchoice></term>
<listitem>
<para>Spellchecks the current selection.</para>
@@ -1469,7 +1499,7 @@ is instead of at the beginning of the document.</para>
<varlistentry>
<term><anchor id="tools-change-dictionary"/><menuchoice>
-<guimenu>Tools</guimenu>
+<guimenu>Tools</guimenu><guisubmenu>Spelling</guisubmenu>
<guimenuitem>Change Dictionary</guimenuitem></menuchoice></term>
<listitem>
<para>Displays a drop down box with all available dictionaries for spellchecking
@@ -1612,7 +1642,11 @@ in the Editing tab in <menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Configure
Editor...</guimenuitem></menuchoice></para></listitem>
</varlistentry>
-
+<!--FIXME
+Create Snippets
+Snippets... -> Snippets tool view as separate window
+missing
+ -->
</variablelist>
<para>Menu items for the selected <link linkend="pref-plugins">plugins</link>
are displayed at the end of this menu
diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index b13a23d..80a9ff9 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -23,92 +23,11 @@ that.</para>
<para>There are many plugins for various purposes available
and you can search the web for more. A few plugins are shipped with the
editor component, for inserting automatic braces, insert files,
-data tools and exporting text as &HTML;.</para>
+and exporting text as &HTML;.</para>
-<sect1 id="kate-editor-plugins">
-<title>Editor Component Plugins</title>
-
-<para>The <guilabel>Plugins</guilabel> tab on the <guilabel>Extensions</guilabel> page
-lists all available plugins and you can check those you
-want to use. Click on the <guibutton>Information</guibutton> button to open the
-<guilabel>About</guilabel> dialog of this plugin.</para>
-<para>Once a configurable plugin is checked, the
-<guibutton>Configure</guibutton> button is enabled and you can click it
-in order to configure the highlighted plugin.</para>
-
-<variablelist>
-<varlistentry>
-<term><guilabel>AutoBrace</guilabel></term>
-<listitem><para>The autobrace plugin supersedes the &kate; internal
-<quote>Auto Brackets</quote> feature.
-It automatically inserts a closing brace <keycap>}</keycap> at the beginning
-of the next line after ending a line with an opening one <keycap>{</keycap>
-and pressing the &Enter; key.</para></listitem>
-</varlistentry>
-<!--http://jakob.petsovits.at/topic/kate-->
-<!--Right, it's the automatic insertion of a closing brace ("}") after you ended a line with an opening one ("{"). Kate's standard insertion of parentheses, brackets and braces is simply too obtrusive for me, so even if I tried it several times I always had to disable it again because I can't stand it. So here's how AutoBrace works.
-You, the developer, are writing a line of code, and want to open a new block delimited by braces. Looks like this:
-If you press Enter and AutoBrace is enabled, it will insert your favorite new brace where it belongs. Looks like this:
--->
-<varlistentry>
-<term><guilabel>Data Tools</guilabel></term>
-<listitem><para>Enables 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.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><link linkend="kate-editor-plugin-exporter"><guilabel>Exporter</guilabel></link></term>
-<listitem><para>This command allows you to export the current document with all highlighting
-information into a HTML document using <menuchoice><guimenu>File</guimenu><guimenuitem>Export
-as HTML</guimenuitem></menuchoice>. Additionally you can use <menuchoice><guimenu>Edit</guimenu>
-<guimenuitem>Copy as HTML</guimenuitem></menuchoice> to copy the currently selected text
-as HTML to the system clipboard.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><guilabel>IconInserter</guilabel></term>
-<listitem><para>The icon inserter plugin is only of use for &kde; developers: It adds an item
-<guimenuitem>Insert KIcon-Code</guimenuitem> 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.
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><guilabel>Insane (not ZEN) HTML coding (light edition)</guilabel></term>
-<listitem><para>A plugin, which does zen-coding like selector completion.
-For more information see <ulink url="http://en.wikipedia.org/wiki/Zen_Coding">
-Zen Coding</ulink>.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><guilabel>Insert File</guilabel></term>
-<listitem><para>This plugin allows you to insert any readable file at the cursor position.
-If enabled, the <guimenu>Tools</guimenu> menu has an additional menu item
-<guimenuitem>Insert File</guimenuitem>.</para></listitem>
-</varlistentry>
-<!-- not build any longer in kde 4.5
-<varlistentry>
-<term>Python Encoding check</term>
-<listitem><para>This plugin is always enabled.
-If you are trying to save a python file as non ASCII, without specifying a
-correct source encoding line like ⪚ <quote># -*- coding: utf-8 -*-</quote>,
-a warning dialog pops up and allows you to add a proper source encoding line for the
-current encoding to the file.
-</para></listitem>
-</varlistentry>
--->
-</variablelist>
-<!--
-kdelibs/kate/plugins/ has additional plugins
-autobookmark not build, its broken!
-timedate not build? plugin is for howto-write-a-plugin purposes!
--->
-
-<!-- Scripts tab ??? empty: Not implemented yet, hidden in 4.4 + 4.7 branch, removed in master bye bye-->
-</sect1>
+<para>All available <link linkend="pref-plugins">Editor Component Plugins</link>
+you find in the configuration dialog.
+</para>
<sect1 id="kate-application-plugins">
<title>&kate; Application Plugins</title>
@@ -129,75 +48,68 @@ The available application plugins are:
</para>
<itemizedlist>
<listitem>
-<para><link linkend="kate-application-plugin-gdb">&gdb;</link> - Provides a
-simple &gdb; frontend</para>
+<para>Backtrace Browser - Backtrace navigation tool view</para>
</listitem>
<listitem>
-<para>Backtrace Browser - Backtrace navigation tool view</para>
+<para><link linkend="kate-application-plugin-build">Build Plugin</link> - Compile or Make and parse error messages</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-quickswitcher">Quick Document switcher</link> -
- Quickly switch to another already opened document</para>
+<para>CTags Plugin - Look up definitions/declarations with CTags</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-sql">SQL Plugin</link> - Execute
-query on SQL databases</para>
+<para><link linkend="kate-application-plugin-fsbrowser">File system browser</link> -
+ File system browser tool view</para>
</listitem>
<listitem>
-<para>Search and Replace Plugin - Search or replace patterns in all open files or all files in a folder</para>
+<para><link linkend="kate-application-plugin-filetemplate">File Templates</link> -
+ Create new files from templates</para>
</listitem>
<listitem>
-<para>Tab Bar - Adds a standard tab bar to &kate;'s main window</para>
-<!--http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/-->
+<para><link linkend="kate-application-plugin-gdb">&gdb;</link> - Provides a
+simple &gdb; frontend</para>
</listitem>
-<!--listitem>
-<para>Text Snippets - Configurable Text Snippets</para>
-</listitem-->
<listitem>
-<para>Text Filter - Easy text filtering</para>
+<para>Jovie Text-to-Speech - Adds a menu entry for speaking the text</para>
</listitem>
<listitem>
-<para>Symbol Viewer - Extract and show reference symbols from source</para>
+<para><link linkend="kate-application-plugin-mail">Mail files</link> - Send files
+ via email</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-fsbrowser">File system browser</link> -
- File system browser tool view</para>
+<para>Multiline Tab Bar - Add a tab bar with multiple rows to &kate;'s main window</para>
</listitem>
<listitem>
-<para>Terminal tool view - Toolview embedding a terminal widget</para>
+<para>Open Header - Opens the corresponding .h/[.cpp|.c] file</para>
</listitem>
-<!--listitem>
-<para>Kate Python Browser Plugin - A Python browser plugin for Kate</para>
-</listitem-->
<listitem>
-<para>CTags Plugin - Look up definitions/declarations with CTags</para>
+<para>Project Plugin - Project plugin for kate</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-filetemplate">File Templates</link> -
- Create new files from templates</para>
+<para>Python Plugins - Pâté host for Python plugins</para>
</listitem>
<listitem>
-<para>Open Header - Opens the corresponding .h/[.cpp|.c] file</para>
+<para>Search and Replace Plugin - Search or replace patterns in all open files or all files in a folder</para>
+<!-- FIXME add info from http://kate-editor.org/2011/06/28/kate-plugin-updates-part-3/-->
</listitem>
-<!--<listitem>
-<para><link linkend="kate-application-plugin-exttools">External Tools</link></para>
-</listitem>-->
<listitem>
-<para><link linkend="kate-application-plugin-build">Build Plugin</link> - Compile or Make and parse error messages</para>
-<!-- http://kate-editor.org/2011/06/21/kate-plugin-updates-part-1/ -->
+<para>Snippets tool view - Toolview embedding the snippets management</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-mail">Mail files</link> - Send files
- via email</para>
+<para><link linkend="kate-application-plugin-sql">SQL Plugin</link> - Execute
+query on SQL databases</para>
</listitem>
<listitem>
-<para>Multiline Tab Bar - Add a tab bar with multiple rows to &kate;'s main window</para>
+<para>Symbol Viewer - Extract and show reference symbols from source</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-snippets">Kate Snippets</link> - Snippets plugin with code completion support</para>
+<para>Tab Bar - Adds a standard tab bar to &kate;'s main window</para>
+<!--http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/-->
</listitem>
<listitem>
-<para>Jovie Text-to-Speech Plugin - Adds a menu entry for speaking the text</para>
+<para>Terminal tool view - Toolview embedding a terminal widget</para>
+</listitem>
+<listitem>
+<para>Text Filter - Easy text filtering</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-xmlcheck">&XML; Validation</link>- Validates &XML; files using xmllint</para>
@@ -206,10 +118,24 @@ query on SQL databases</para>
<para><link linkend="kate-application-plugin-xmltools">&XML;Completetion</link> - Lists &XML; elements,
attributes, attribute values and entities allowed by DTD</para>
</listitem>
+
+<!-- not in 4.10
+<listitem>
+<para>Text Snippets - Configurable Text Snippets</para>
+</listitem-->
+<!--listitem>
+<para>Kate Python Browser Plugin - A Python browser plugin for Kate</para>
+</listitem-->
+<!--<listitem>
+<para><link linkend="kate-application-plugin-exttools">External Tools</link></para>
+</listitem>
<listitem>
+<para><link linkend="kate-application-plugin-snippets">Kate Snippets</link> - Snippets plugin with code completion support</para>
+</listitem>
<para>Tabify - Adds a tab bar to Kate's main window</para>
-<!--http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/-->
+http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/
</listitem>
+-->
</itemizedlist>
</sect1>
@@ -749,37 +675,6 @@ You will have to repeat it when you start &kate; the next time.</para></listitem
</sect1>
-<sect1 id="kate-application-plugin-quickswitcher">
-<!--<sect1info>
-<authorgroup><author>
-&TC.Hollingsworth; &TC.Hollingsworth.mail;
-</author></authorgroup>
-</sect1info>-->
-<title>Quick Document Switcher</title>
-
-<sect2 id="quickswitcher-menu">
-<title>Menu Structure</title>
-
-<variablelist>
-<varlistentry>
-<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>1</keycap>
-</keycombo></shortcut><guimenu>Go</guimenu><guimenuitem>Quickswitch
-</guimenuitem></menuchoice></term>
-<listitem><para>Opens the <guilabel>Document Quick Switch</guilabel> dialog
-with a search field and a list of opened files. While entering text in the search
-field the document names and document urls are searched for matching text.
-While entering text in the search field you can use
-the cursor keys <keysym>Up</keysym> and <keysym>Down</keysym> to navigate in the
-list view. If the dialog is left with <guilabel>OK</guilabel> the plugin switches
-the view to the document selected in the list view. This makes switching between
-documents easier, if there are a lot of them open.
-</para></listitem>
-</varlistentry>
-</variablelist>
-
-</sect2>
-</sect1>
-
<sect1 id="kate-editor-plugin-exporter">
<!--<sect1info>
<authorgroup><author>
@@ -1427,6 +1322,7 @@ from disk.</para></listitem>
</sect2>
</sect1>-->
+ <!--FIXME needs an update to 4.10 -->
<sect1 id="kate-application-plugin-snippets">
<sect1info>
<authorgroup>
@@ -1449,7 +1345,7 @@ also supports code completion and QtScript.</para>
<variablelist>
<varlistentry>
<term><menuchoice><guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu>
-<guimenuitem>Show Kate Snippets</guimenuitem></menuchoice></term>
+<guimenuitem>Show Snippets</guimenuitem></menuchoice></term>
<listitem><para>Shows snippets panel containing all snippets in your repository
that are for the currently opened file type.</para></listitem>
</varlistentry>
@@ -1457,23 +1353,19 @@ that are for the currently opened file type.</para></listitem>
</sect2>
-<sect2 id="snippets-config">
-<title>Configuration</title>
-
-<para>The configuration for Kate Snippets can be accessed in <menuchoice>
-<guimenu>Settings</guimenu><guimenuitem>Configure Kate</guimenuitem></menuchoice>,
-in <guilabel>Kate Snippets</guilabel> under <guilabel>Application</guilabel>.</para>
+<sect2 id="snippets-panel">
+<title>Snippets panel</title>
<screenshot id="screenshot-snippets-config">
-<screeninfo>Kate Snippets Configuration</screeninfo>
+<screeninfo>Kate Snippets Panel</screeninfo>
<mediaobject>
-<imageobject><imagedata fileref="snippets-config.png" format="PNG"/></imageobject>
-<textobject><phrase>The Kate snippets configuration panel.</phrase></textobject>
-<caption><para>The configuration panel for Kate Snippets.</para></caption>
+<imageobject><imagedata fileref="snippets-panel.png" format="PNG"/></imageobject>
+<textobject><phrase>The Kate snippets panel.</phrase></textobject>
+<caption><para>The panel for Kate Snippets.</para></caption>
</mediaobject>
</screenshot>
-<para>In the configuration panel you should see a list of snippet repositories,
+<para>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
@@ -1485,7 +1377,7 @@ repositories.</para>
<guibutton>Get New Snippets</guibutton> and a window with a list of snippet
repositories will open. After downloading the desired snippet, make sure that
you have activated it.</para>
-
+<!--FIXME no way to load a local file ?-->
<para>You can also load snippet repositories from a local file using the file
browser at the bottom of the panel. Click <guibutton>Copy to repository</guibutton>
when finished.</para>
@@ -1613,6 +1505,7 @@ writing much of this section.</para>
</sect1>
<sect1 id="kate-application-plugin-build">
+<!--http://kate-editor.org/2011/06/21/kate-plugin-updates-part-1/ -->
<sect1info>
<authorgroup>
<author><firstname>Salma</firstname> <surname>Sultana</surname></author>
@@ -2024,6 +1917,7 @@ writing much of this section.</para>
</sect1>
<sect1 id="kate-application-plugin-gdb">
+<!--http://kate-editor.org/2011/06/23/kate-plugin-updates-part-2/-->
<sect1info>
<authorgroup>
<author><firstname>Martin</firstname> <surname>Gergov</surname></author>
diff --git a/doc/kate/snippets-config.png b/doc/kate/snippets-config.png
deleted file mode 100644
index c8151dc..0000000
Binary files a/doc/kate/snippets-config.png and /dev/null differ
diff --git a/doc/kate/snippets-form.png b/doc/kate/snippets-form.png
index 278be05..66875c1 100644
Binary files a/doc/kate/snippets-form.png and b/doc/kate/snippets-form.png differ
diff --git a/doc/kate/snippets-panel.png b/doc/kate/snippets-panel.png
new file mode 100644
index 0000000..281948c
Binary files /dev/null and b/doc/kate/snippets-panel.png differ
More information about the kde-doc-english
mailing list