[kde-doc-english] [kate] doc: Update Kate docbook to recent changes in master
Burkhard Lück
lueck at hube-lueck.de
Sat Aug 1 19:58:55 UTC 2015
Git commit 777cdae21c98437b936974b0c7e73a33b0c8e999 by Burkhard Lück.
Committed on 01/08/2015 at 19:58.
Pushed by lueck into branch 'master'.
Update Kate docbook to recent changes in master
Follow code removal of plugins (kttsd, xmlcheck, pate, filetemplates, mailfiles)
Proofreading
Fix broken links
New main screenshots
REVIEW:124546
M +- -- doc/kate/configdialog01.png
M +2 -2 doc/kate/configuring.docbook
M +5 -22 doc/kate/development.docbook
M +5 -48 doc/kate/fundamentals.docbook
M +7 -9 doc/kate/index.docbook
M +- -- doc/kate/kate.png
M +13 -14 doc/kate/menus.docbook
M +12 -679 doc/kate/plugins.docbook
M +2 -3 doc/katepart/index.docbook
M +1 -2 doc/katepart/menus.docbook
M +2 -2 doc/kwrite/index.docbook
http://commits.kde.org/kate/777cdae21c98437b936974b0c7e73a33b0c8e999
diff --git a/doc/kate/configdialog01.png b/doc/kate/configdialog01.png
index 50fad46..e1459e1 100644
Binary files a/doc/kate/configdialog01.png and b/doc/kate/configdialog01.png differ
diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook
index 6fd4646..444e625 100644
--- a/doc/kate/configuring.docbook
+++ b/doc/kate/configuring.docbook
@@ -257,7 +257,7 @@ View.</para></listitem>
<title>The Editor Component Configuration</title>
<para>For information about this section of the configuration dialog, see the
-<ulink url="help:katepart/config-dialog-editor.html">Editor Component
+<ulink url="help:/katepart/config-dialog-editor.html">Editor Component
Configuration section of the &katepart; Handbook</ulink>.</para>
</sect1>
@@ -266,7 +266,7 @@ Configuration section of the &katepart; Handbook</ulink>.</para>
<title>Configuring With Document Variables</title>
<para>For information about using document variables with &kate;, see the
-<ulink url="help:katepart/config-variables.html">Configuring with Document
+<ulink url="help:/katepart/config-variables.html">Configuring with Document
Variables section of the &katepart; Handbook</ulink>.</para>
</sect1>
diff --git a/doc/kate/development.docbook b/doc/kate/development.docbook
index 22f2084..1c70411 100644
--- a/doc/kate/development.docbook
+++ b/doc/kate/development.docbook
@@ -15,9 +15,8 @@ its functionality. You can <link linkend="dev-scripting">write simple scripts
to add functionality with JavaScript</link>, add enhanced functionality to the
editor component with <link linkend="dev-part">Editor Component Plugins</link>,
or add even more functionality to the editor itself with
-<link linkend="dev-app">&kate; Application Plugins written in C++</link> or
-<link linkend="dev-pate">&pate; Plugins written in Python</link>. Finally, once
-you have extended &kate;, you are welcome to
+<link linkend="dev-app">&kate; Application Plugins written in C++</link>.
+Finally, once you have extended &kate;, you are welcome to
<ulink url="http://kate-editor.org/join-us/">join us</ulink> and share your
enhancements with the world!</para>
@@ -27,7 +26,7 @@ enhancements with the world!</para>
<title>Working with Syntax Highlighting</title>
<para>For information about adding or modifying syntax highlighting definitions,
-see the <ulink url="help:katepart/dev-scripting.html">Working with Syntax
+see the <ulink url="help:/katepart/dev-scripting.html">Working with Syntax
Highlighting section of the Development chapter of the &katepart;
Handbook</ulink>.</para>
@@ -37,7 +36,7 @@ Handbook</ulink>.</para>
<title>Scripting with JavaScript</title>
<para>For information about scripting with JavaScript, see the
-<ulink url="help:katepart/dev-scripting.html">Scripting with JavaScript
+<ulink url="help:/katepart/dev-scripting.html">Scripting with JavaScript
section of the Development chapter of the &katepart; Handbook</ulink>.</para>
</sect1>
@@ -46,7 +45,7 @@ section of the Development chapter of the &katepart; Handbook</ulink>.</para>
<title>Editor Component Extensions</title>
<para>For information about writing &katepart; plugins, see the
-<ulink url="help:katepart/dev-part.html">Editor Component Extensions
+<ulink url="help:/katepart/dev-part.html">Editor Component Extensions
section of the Development chapter of the &katepart; Handbook</ulink>.</para>
</sect1>
@@ -67,20 +66,4 @@ source code</ulink>.</para>
</sect1>
-<sect1 id="dev-pate">
-<title>&pate; Python Plugins</title>
-
-<para><link linkend="pate">&pate; Plugins</link> also allow you to extend the
-functionality of &kate; in any way you like, using the Python programming
-language.</para>
-
-<para>To get started, see the
-<ulink url="http://kate-editor.org/2012/07/01/python-plugin-developer-guide-part-1/">
-Python plugin developer guide on the &kate; website</ulink>.</para>
-
-<para>You can also access the API reference in the
-<link linkend="pate-config">&pate; Configuration</link> screen.</para>
-
-</sect1>
-
</chapter>
diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook
index 45232ae..f016585 100644
--- a/doc/kate/fundamentals.docbook
+++ b/doc/kate/fundamentals.docbook
@@ -19,7 +19,7 @@ quickly.
<title>Starting &kate;</title>
<para>
-You can start &kate; from the &kmenu; or from the
+You can start &kate; from the application launcher or from the
command line.
</para>
@@ -27,7 +27,7 @@ command line.
<title>From the Menu</title>
<para>
Open the &kde; program menu by clicking on the
-big <guiicon>K</guiicon> icon on the toolbar at the bottom left of your
+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 <menuchoice><guimenu>Applications</guimenu><guisubmenu>Utilities</guisubmenu>
<guimenuitem>Advanced Text Editor &kate;</guimenuitem></menuchoice> menu item.
@@ -70,28 +70,7 @@ of &kde;'s network transparency to open files on the internet.
<term><userinput><command>kate</command> <option>--help</option></userinput></term>
<listitem>
<para>
-This lists the most basic options available at the command line.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><userinput><command>kate</command>
-<option>--help-qt</option></userinput></term>
-<listitem>
-<para>
-This lists the options available for changing the way &kate; interacts
-with &Qt;.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><userinput><command>kate</command> <option>--help-kde</option></userinput></term>
-<listitem>
-<para>
-This lists the options available for changing the way &kate; interacts
-with &kde;.
+This lists the options available at the command line.
</para>
</listitem>
</varlistentry>
@@ -112,17 +91,6 @@ well.
<varlistentry>
<term><userinput><command>kate</command>
-<option>-u</option> <option>--use</option> <parameter>URL</parameter></userinput></term>
-<listitem>
-<para>
-Causes &kate; to use an existing instance if there is one. This is now the
-default behavior, but this option remains for compatibility.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><userinput><command>kate</command>
<option>-p</option> <option>--pid</option> <parameter>PID</parameter></userinput></term>
<listitem>
<para>
@@ -199,24 +167,13 @@ downloaded to a temporary) and should be reuploaded, after you saved it.
<varlistentry>
<term><userinput><command>kate</command>
<option>--tempfile</option></userinput></term>
-<listitem><para>Since &kate; 2.5.1 this standard &kde; option is supported.
-When used, the specified files are treated as temporary files and
+<listitem><para>When 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.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kate</command>
-<option>--help-all</option></userinput></term>
-<listitem>
-<para>
-This lists all of the command line options.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><userinput><command>kate</command>
<option>--author</option></userinput></term>
<listitem>
<para>
@@ -230,7 +187,7 @@ Lists &kate;'s authors in the terminal window.
<option>-v</option> <option>--version</option></userinput></term>
<listitem>
<para>
-Lists version information for &Qt;, &kde;, and &kate;.
+Lists version information for &kate;.
</para>
</listitem>
</varlistentry>
diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook
index 2c53659..3aad430 100644
--- a/doc/kate/index.docbook
+++ b/doc/kate/index.docbook
@@ -2,11 +2,9 @@
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
<!ENTITY kappname "&kate;">
- <!ENTITY package "kdesdk">
<!ENTITY imgpath "../katepart/">
<!ENTITY rcfile "katerc">
<!ENTITY gdb "<acronym>GDB</acronym>">
- <!ENTITY pate "Pâté">
<!ENTITY configuring-chapter SYSTEM "configuring.docbook">
<!ENTITY fundamentals-chapter SYSTEM "fundamentals.docbook">
<!ENTITY menu-chapter SYSTEM "menus.docbook">
@@ -47,13 +45,13 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2013-02-22</date>
-<releaseinfo>5.0 &kde; 5.0</releaseinfo>
+<date>2015-07-31</date>
+<releaseinfo>Applications 15.12</releaseinfo>
<abstract>
<para>&kate; is a programmer's text editor for &kde; 4 and above.</para>
-<para>This handbook documents &kate; Version 3.11</para>
+<para>This handbook documents &kate; Version 15.12</para>
</abstract>
<keywordset>
@@ -111,7 +109,7 @@ configuration files. This document was written in &kate;.
<title>Working with the &kate; Editor</title>
<para>For information about the basics of working with the editor component
underlying &kate;, see the
-<ulink url="help:katepart/kate-part.html">Working with the
+<ulink url="help:/katepart/kate-part.html">Working with the
&katepart; Editor chapter of the &katepart; Handbook</ulink>.</para>
</chapter>
@@ -120,7 +118,7 @@ underlying &kate;, see the
<chapter id="advanced-editing-tools">
<title>Advanced Editing Tools</title>
<para>For information about the advanced editing tools included with &kate;,
-see the <ulink url="help:katepart/advanced-editing-tools.html">Advanced Editing Tools chapter
+see the <ulink url="help:/katepart/advanced-editing-tools.html">Advanced Editing Tools chapter
of the &katepart; Handbook</ulink>.</para>
</chapter>
@@ -129,7 +127,7 @@ of the &katepart; Handbook</ulink>.</para>
<chapter id="vi-input-mode-chapter">
<title>The VI Input Mode</title>
<para>For information about &kate;'s VI input mode, see the
-<ulink url="help:katepart/vi-input-mode-chapter.html">VI Input Mode chapter
+<ulink url="help:/katepart/vi-input-mode-chapter.html">VI Input Mode chapter
of the &katepart; Handbook</ulink>.</para>
</chapter>
@@ -275,7 +273,7 @@ documentation</para></listitem>
<title>Regular Expressions</title>
<para>For information about using regular expressions in &kate;, see the
-<ulink url="help:katepart/regular-expressions.html">Regular Expressions appendix
+<ulink url="help:/katepart/regular-expressions.html">Regular Expressions appendix
to the &katepart; Handbook</ulink>.</para>
</appendix>
diff --git a/doc/kate/kate.png b/doc/kate/kate.png
index 6b20f28..12940a9 100644
Binary files a/doc/kate/kate.png and b/doc/kate/kate.png differ
diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook
index dec96c4..6e65d27 100644
--- a/doc/kate/menus.docbook
+++ b/doc/kate/menus.docbook
@@ -509,7 +509,7 @@ Mode</guimenuitem></menuchoice></term>
and motions from vim's normal and visual mode and has an optional vi mode status bar.
This status bar shows commands while they are being entered, output from commands and
the current mode.The behavior of this mode can be configured in the
-<ulink url="help:katepart/config-dialog-editor.html#pref-edit-vi-input-mode">Vi
+<ulink url="help:/katepart/config-dialog-editor.html#pref-edit-vi-input-mode">Vi
Input Mode</ulink> section of the <guilabel>Editing</guilabel> page in
&kappname;'s settings dialog.</para>
</listitem>
@@ -1019,7 +1019,7 @@ enabled by default.</para>
<guimenu>View</guimenu><guimenuitem>Switch to Command Line</guimenuitem>
</menuchoice></term>
<listitem><para>This command will toggle the display of the
-<ulink url="help:katepart/advanced-editing-tools-commandline.html">built-in
+<ulink url="help:/katepart/advanced-editing-tools-commandline.html">built-in
command line</ulink>.
</para></listitem>
</varlistentry>
@@ -1039,7 +1039,7 @@ interactively. For more information, see
</menuchoice></term>
<listitem><para>This menu lists the available color schemes. You can change the
schema for the current view here, to change the default schema you need to
-use the <ulink url="help:katepart/config-dialog-editor.html#prefcolors">Fonts
+use the <ulink url="help:/katepart/config-dialog-editor.html#prefcolors">Fonts
& Colors</ulink> page of the config dialog.</para>
</listitem>
</varlistentry>
@@ -1073,7 +1073,7 @@ Wrap</guilabel> option is checked.</para>
Wrap Marker</guimenuitem></menuchoice></term>
<listitem><para>Toggles the display of a vertical line indicating the position
of the wrap width as configured in the
-<ulink url="help:katepart/config-dialog-editor.html#pref-wrap-words-at">config
+<ulink url="help:/katepart/config-dialog-editor.html#pref-wrap-words-at">config
dialog</ulink>. This feature requires that you use a true fixed-width font.
</para>
</listitem>
@@ -1125,7 +1125,7 @@ to a position near the mark.</para></listitem>
Minimap</guimenuitem></menuchoice></term>
<listitem><para>This will replace the scrollbar with a visualization of the
current document. For more information on the scrollbar minimap, see the
-<ulink url="help:katepart/kate-part-scrollbar-minimap.html">Scrollbar Minimap
+<ulink url="help:/katepart/kate-part-scrollbar-minimap.html">Scrollbar Minimap
section of the &katepart; Handbook</ulink>.</para></listitem>
</varlistentry>
@@ -1136,7 +1136,7 @@ section of the &katepart; Handbook</ulink>.</para></listitem>
</menuchoice></term>
<listitem><para>Toggles the display of the folding marker pane in the left
side of the view. See
-<ulink url="help:katepart/advanced-editing-tools-code-folding.html">Using Code
+<ulink url="help:/katepart/advanced-editing-tools-code-folding.html">Using Code
Folding</ulink>.</para></listitem>
</varlistentry>
@@ -1147,7 +1147,7 @@ Folding</ulink>.</para></listitem>
<guimenu>View</guimenu><guimenuitem>Code Folding</guimenuitem>
</menuchoice></term>
<listitem><para>These options pertain to
-<ulink url="help:katepart/advanced-editing-tools-code-folding.html">code
+<ulink url="help:/katepart/advanced-editing-tools-code-folding.html">code
folding</ulink>:</para>
<variablelist>
@@ -1401,7 +1401,7 @@ addition and any changes in the document formatting.</para>
<listitem>
<para>Choose the filetype scheme you prefer for the active document. This
overwrites the global
-<ulink url="help:katepart/pref-open-save-modes-filetypes.html">filetype</ulink>
+<ulink url="help:/katepart/pref-open-save-modes-filetypes.html">filetype</ulink>
mode set in <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure
&kate;...</guimenuitem></menuchoice> in the Filetypes tab for your current
document only.</para>
@@ -1425,7 +1425,7 @@ overwrites the global highlighting mode set in <menuchoice>
<guimenu>Tools</guimenu>
<guisubmenu>Indentation</guisubmenu></menuchoice></term>
<listitem>
-<para>Choose the <ulink url="help:katepart/kate-part-autoindent.html">style of
+<para>Choose the <ulink url="help:/katepart/kate-part-autoindent.html">style of
indentation</ulink> you want for your active document.
This overwrites the global indentation mode set in <menuchoice>
<guimenu>Settings</guimenu> <guimenuitem>Configure Editor...</guimenuitem>
@@ -1480,11 +1480,11 @@ the endianness (byte order) of a text file or stream, for more information see
<listitem>
<para>This submenu contains a list of all scripted actions. The list can easily be
modified by
-<ulink url="help:katepart/dev-scripting.html#dev-scripting-command-line">writing
+<ulink url="help:/katepart/dev-scripting.html#dev-scripting-command-line">writing
your own scripts</ulink>. This way, &kate; can be extended with user-defined tools.
</para>
-<para><ulink url="help:katepart/tools.html#scripts">There is a complete list of
+<para><ulink url="help:/katepart/tools.html#scripts">There is a complete list of
scripts in the &katepart; documentation.</ulink></para>
</listitem>
</varlistentry>
@@ -1733,7 +1733,7 @@ may insert in any part of any document.</para>
</variablelist>
<para>Menu items for the selected
-<ulink url="help:katepart/config-dialog-editor.html#pref-plugins">plugins</ulink>
+<ulink url="help:/katepart/config-dialog-editor.html#pref-plugins">plugins</ulink>
are displayed at the end of this menu.
</para>
@@ -1852,8 +1852,7 @@ documentation</ulink>.</para>
<title>The Help Menu</title>
<para>Apart from standard &kde; <guimenu>Help</guimenu> menu items
-described below you will have menu entries to show the
-<guimenuitem>Tip of the Day</guimenuitem> and the <guimenuitem>About
+described below you will have a menu entriy to show the <guimenuitem>About
Editor Component</guimenuitem> information.</para>
&help.menu.documentation;
diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index d0bb183..605d867 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -30,7 +30,7 @@ and exporting text as &HTML;.</para>
<title>Editor Component Extensions</title>
<para>For information about available plugins, see the
-<ulink url="help:katepart/editor-component-plugins.html">Editor Component
+<ulink url="help:/katepart/editor-component-plugins.html">Editor Component
Extensions section of the &katepart; Handbook</ulink>.</para>
</sect1>
@@ -66,26 +66,21 @@ The available application plugins are:
<para>CTags - Look up definitions/declarations with CTags</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-fsbrowser">File system browser</link> -
- File system browser tool view</para>
+<para>Document switcher - Quick document switching with <keycombo action="simul">&Alt; </keycombo> behavior</para>
</listitem>
<listitem>
-<para><link linkend="kate-application-plugin-filetemplate">File Templates</link> -
- Create new files from templates</para>
+<para><link linkend="kate-application-plugin-fsbrowser">File system browser</link> -
+ File system browser tool view</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-gdb">&gdb;</link> - Provides a
simple &gdb; frontend</para>
</listitem>
<listitem>
-<para>Jovie Text-to-Speech - Adds a menu entry for speaking the text</para>
-</listitem>
-<listitem>
-<para><link linkend="kate-application-plugin-mail">Mail files</link> - Send files
- via email</para>
+<para>Icon picker - Invokes Cuttlefish icon picker</para>
</listitem>
<listitem>
-<para>Multiline Tab Bar - Add a tab bar with multiple rows to &kate;'s main window</para>
+<para>Lumen - Lumen is a Autocompletion Plugin for D, using the DCD autocompletion server</para>
</listitem>
<listitem>
<para>Open Header - Opens the corresponding .h/[.cpp|.c] file</para>
@@ -94,7 +89,10 @@ simple &gdb; frontend</para>
<para>Project Plugin - Project plugin for kate</para>
</listitem>
<listitem>
-<para>Python Plugins - &pate; host for Python plugins</para>
+<para>Replicode</para>
+</listitem>
+<listitem>
+<para>Rust code completion - Code completion for Rust source code</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-searchinfiles">Search & Replace</link> -
@@ -111,10 +109,6 @@ query on SQL databases</para>
<para>Symbol Viewer - Extract and show reference symbols from source</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/-->
-</listitem>
-<listitem>
<para>Terminal tool view - Tool view embedding a terminal widget</para>
</listitem>
<listitem>
@@ -124,9 +118,6 @@ 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>
-<listitem>
-<para><link linkend="kate-application-plugin-xmlcheck">&XML; Validation</link>- Validates &XML; files using xmllint</para>
-</listitem>
<!-- not in 4.10
<listitem>
@@ -148,636 +139,7 @@ http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/
</itemizedlist>
</sect1>
-<sect1 id="pate">
-<title>Python &pate; Plugins</title>
-
-<para>The &pate; Python Plugin host makes available many plugins written in the
-<ulink url="http://www.python.org/">Python programming language</ulink>.</para>
-
-<para>To enable &pate; plugins, you must first enable the
-<guilabel>Python Plugins</guilabel> plugin in the
-<link linkend="config-dialog-plugins"><guilabel>Plugins</guilabel> page of
-&kate;'s configuration dialog</link>. You may then enable, disable, and
-configure them in the <guilabel>Python Plugins</guilabel> page of the
-configuration dialog. For more information about configuring &pate; plugins, see
-<xref linkend="pate-config"/>.</para>
-
-<sect2 id="pate-plugins">
-<title>Available Plugins</title>
-
-<variablelist>
-
-<varlistentry id="pate-plugin-block">
-<term><guilabel>block</guilabel></term>
-<listitem><para>
-Plugins to help code editing
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-cmake_utils">
-<term><guilabel>cmake_utils</guilabel></term>
-<listitem><para>
-CMake helper plugin
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-color_tools">
-<term><guilabel>color_tools</guilabel></term>
-<listitem><para>
-Class encapsuling the ability to show color swatches (colored tooltips)
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-commentar">
-<term><guilabel>commentar</guilabel></term>
-<listitem><para>
-Move an inlined comment before the current line with the same indentation level
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-django_utils">
-<term><guilabel>django_utils</guilabel></term>
-<listitem><para>
-Django utilities: Snippets, and template utilities
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-expand">
-<term><guilabel>expand</guilabel></term>
-<listitem>
-<para>User-defined text expansions.</para>
-
-<para>Each text expansion is a simple function which must return a string.
-This string will be inserted into a document by the <command>expandAtCursor</command> action.
-For example, if you have a function <quote>foo</quote> in the
-<filename>all.expand</filename> file which is defined as:</para>
-
-<informalexample><programlisting>
-def foo:
- return 'Hello from foo!'
-</programlisting></informalexample>
-
-<para>after typing <quote>foo</quote>, the action will replace <quote>foo</quote>
-with <quote>Hello from foo!</quote>. The expansion function may have parameters
-as well. For example, the <filename>text_x-c++src.expand</filename> file
-contains the <function>cl</function> function which creates a class (or class template). This will
-expand <quote>cl(test)</quote> into:</para>
-
-<informalexample><programlisting>
-/**
- * \\brief Class \c test
- */
-class test
-{
-public:
- /// Default constructor
- explicit test()
- {
- }
- /// Destructor
- virtual ~test()
- {
- }
-};
-</programlisting></informalexample>
-
-<para>but <quote>cl(test, T1, T2, T3)</quote> will expand to:</para>
-
-<informalexample><programlisting>
-/**
- * \\brief Class \c test
- */
-template <typename T1, typename T2, typename T3>
-class test
-{
-public:
- /// Default constructor
- explicit test()
- {
- }
- /// Destructor
- virtual ~test()
- {
- }
-};
-</programlisting></informalexample>
-</listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-format">
-<term><guilabel>format</guilabel></term>
-<listitem><para>
-Plugins to work with C++ code formatting
-</para></listitem>
-</varlistentry>
-
-<!--not in 4.12
-<varlistentry id="pate-plugin-gdb">
-<term><guilabel>gdb</guilabel></term>
-<listitem><para>
-Use <application>gdb</application>, the GNU debugger, from &kate;
-</para></listitem>
-</varlistentry>
--->
-
-<varlistentry id="pate-plugin-gid">
-<term><guilabel>gid</guilabel></term>
-<listitem>
-<para>Browse the tokens in a <application>GNU idutils</application> ID file, and
-use it to navigate within a codebase.</para>
-
-<para>The necessary parts of the ID file are held in memory to allow sufficient
-performance for token completion, when looking up the usage of a token, or
-jumping to the definition. <command>etags(1)</command> is used to locate the
-definition.</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-js_utils">
-<term><guilabel>js_utils</guilabel></term>
-<listitem><para>
-JavaScript utilities: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty
-JSON, Snippets
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-python_autocomplete">
-<term><guilabel>python_autocomplete</guilabel></term>
-<listitem><para>
-Python Autocompletion (beta, only for Python 2)
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-python_console_classic">
-<term><guilabel>python_console_classic</guilabel></term>
-<listitem><para>
-Interactive console for inspecting &kate;'s internals and playing about
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-python_console_ipython">
-<term><guilabel>python_console_ipython</guilabel></term>
-<listitem><para>
-IPython console for hacking &kate; and doing science
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-python_utils">
-<term><guilabel>python_utils</guilabel></term>
-<listitem><para>
-Python Utilities: Parse Checker, PEP8 Checker, Pyflakes Checker, Snippets
-</para></listitem>
-</varlistentry>
-
-<varlistentry id="pate-plugin-xml_pretty">
-<term><guilabel>xml_pretty</guilabel></term>
-<listitem><para>
-A simple &XML; pretty printer. It formats &XML; with good indentation.
-</para></listitem>
-</varlistentry>
-
-</variablelist>
-</sect2>
-
-<sect2 id="pate-config">
-<title>Configuring &pate;</title>
-
-<sect3 id="pate-config-manager">
-<title>The <guilabel>Manager</guilabel> Tab</title>
-
-<para>This tab contains a list of &pate; plugins. To enable or disable them,
-simply select or unselect the checkbox to the left of the plugin name.</para>
-
-<para>To refresh the list of plugins, reload any currently running plugins, or
-start any newly selected plugins, select the
-<guibutton>Reload Plugins</guibutton> button at the bottom of the window.</para>
-
-<warning><para>Reloading a plugin may have unpredictable effects. Consider
-saving your work before using this command.</para></warning>
-
-</sect3>
-
-<sect3 id="pate-config-documentation">
-<title>The <guilabel>Documentation</guilabel> Tab</title>
-
-<para>The <guilabel>Documentation</guilabel> tab contains information about the
-actions, menu items, keyboard shortcuts, and configuration pages offered by
-&pate; plugins, as well as a reference for programmers using the functionality
-of the plugins.</para>
-
-<para>The following tabs are available:</para>
-
-<variablelist>
-
-<varlistentry>
-<term><guilabel>Actions</guilabel></term>
-<listitem><para>Lists all the actions offered by the plugin, including the menu
-item, icon, and keyboard shortcut that will invoke the action.</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><guilabel>Configuration Pages</guilabel></term>
-<listitem><para>Lists all the configuration pages offered by the plugin,
-including their titles and icons.</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><guilabel>Programmer's Reference</guilabel></term>
-<listitem><para>Includes information about all the modules, classes, and
-functions offered by a plugin, as generated by <command>pydoc</command>.</para>
-</listitem>
-</varlistentry>
-
-</variablelist>
-
-</sect3>
-
-</sect2>
-
-</sect1>
-
-<!-- from doc/kate-addons/filetemplates.docbook -->
-<sect1 id="kate-application-plugin-filetemplate">
-<sect1info>
-<authorgroup>
-<author>&Anders.Lund; &Anders.Lund.mail;</author>
-</authorgroup>
-</sect1info>
-<title>File Templates</title>
-
- <para>The File Templates plugin allows you to create files based on other
- files.</para>
- <para>When you first install &kate;, you need to enable the plugin:</para>
- <orderedlist>
- <listitem>
- <para>
- Click <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kate;</guimenuitem></menuchoice>
- </para>
- </listitem>
- <listitem>
- <para>
- In the tree on the left of the screen, click <guilabel>Plugins</guilabel>.
- </para>
- </listitem>
- <listitem>
- <para>
- In the <guilabel>Plugin Manager</guilabel> panel on the right, select <guilabel>File Templates</guilabel>, and then click <guibutton>OK</guibutton>.
- </para>
- </listitem>
- </orderedlist>
- <para>You can now use any file as a template (this creates a copy of the
- file with an empty &URL;.) Special template files can contain
- macros to fill in information such as your name, email address, the
- current date, and position the cursor at a
- convenient position in the new file.</para>
- <para>You can easily create a new template from an open document.</para>
- <para>Templates that you save to the template folder are
- listed under the menu item <menuchoice><guimenu>File</guimenu><guimenuitem>New from
- Template</guimenuitem></menuchoice>.</para>
- <para>The template folder is part of the &kde; file system, and
- consists of at least</para>
- <itemizedlist>
- <listitem>
- <para>
- <filename role="directory">$<envar>KDEDIR</envar>/share/applications/kate/plugins/katefiletemplates/templates</filename>
- </para>
- </listitem>
- <listitem>
- <para>
- <filename role="directory">$<envar>KDEHOME</envar>/share/applications/kate/plugins/katefiletemplates/templates.</filename>
- </para>
- </listitem>
- </itemizedlist>
- <para>If your <envar>KDEDIRS</envar> environment variable contains additional directories, those are
- searched for a similar subdirectory as well. If equally named templates are
- found, the one in the local (KDEHOME) folder is chosen.</para>
- <sect2 id="katefiletemplates-menu">
- <title>Menu Structure</title>
-
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice>
- <guimenu>File</guimenu>
- <guisubmenu>New From Template</guisubmenu>
- <guimenuitem>Any File...</guimenuitem>
- </menuchoice>
- </term>
- <listitem><para>Presents you with an Open File dialog that allows
- you to use any file as a template. If the chosen file has the
- extension <filename>katetemplate</filename> it will be parsed
- for template information and macros.</para></listitem>
- </varlistentry>
- <!-- not in 4.4
- <varlistentry>
- <term>
- <menuchoice>
- <guimenu>File</guimenu>
- <guisubmenu>New From Template</guisubmenu>
- <guimenuitem>Use Recent</guimenuitem>
- </menuchoice>
- </term>
- <listitem><para>Presents a list of files recently used as
- templates, represented by their &URL;.</para></listitem>
- </varlistentry>
- -->
- <varlistentry>
- <term>
- <menuchoice>
- <guimenu>File</guimenu>
- <guimenuitem>New From Template</guimenuitem>
- </menuchoice>
- </term>
- <listitem><para>The remainder of submenus contain links to
- templates. Click a menu item to create a file as described by
- the menu item text.</para></listitem>
- </varlistentry>
-
- <!-- Settings menu -->
-
- <varlistentry>
- <term>
- <menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage
- Templates...</guimenuitem></menuchoice></term>
- <listitem><para>This will launch a dialog with a list of all templates
- found within the template directories, along with options to add,
- edit or remove templates.</para></listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="katefiletemplates-use">
- <title>Using a &kate; Template</title>
- <para>When creating a file from a template that contains template
- macros, some macros appear as editable variables in the text. Such
- variables appear as underlined words in the text.</para>
- <para>The first variable will be selected, so you just have to type to edit
- it. If the document text contains more instances of the same variable,
- they are changed as you edit. To move to the next editable variable,
- press the key. When the last variable is edited, the list is
- dropped, and your key works as normal.</para>
- </sect2>
-
- <sect2 id="katefiletemplates-create">
- <title>Creating your own templates</title>
- <para>To create a new template, use the
- <menuchoice><guimenu>Settings</guimenu>
- <guimenuitem>Manage Templates</guimenuitem></menuchoice> Item to launch
- the template management dialog. In that, click
- <guibutton>New...</guibutton> to launch the File Template Wizard. You
- will be asked for an optional file to turn into a template and prompted
- for template information settings, and a template file will be created for
- you.</para> <para>Alternatively, you can create a template manually by
- adding template information to the top of any file, add text and macros,
- and save it with the <filename>katetemplate</filename> extension.</para>
- <para>The template menu is automatically updated if you chose to store
- your template in the template directory.</para>
- </sect2>
-
- <sect2 id="katefiletemplates-edit">
- <title>Editing templates</title>
- <para>To edit a template, use the
- <menuchoice><guimenu>Settings</guimenu>
- <guimenuitem>Manage Templates...</guimenuitem></menuchoice>. Select the
- template you want to work on and click <guibutton>Edit...</guibutton>,
- and the template file will be opened. Close the dialog, edit the template
- file as desired, save it and close it. Changes to templates take
- immediate effect; you can activate the template to test your changes after
- saving it.</para>
- </sect2>
-
- <sect2 id="katefiletemplates-format">
- <title>The &kate; Template Format</title>
- <para>If you use files with the extension
- <filename>katetemplate</filename>, they will be parsed for template
- information, macros and a cursor position.</para>
-
- <sect3 id="katefiletemplates-template-info">
- <title>Template information</title>
- <para>While reading in the file, the parser keeps
- lines beginning with the phrase
- <constant>katetemplate:</constant> and searches them for
- template information in the form VARIABLENAME=VALUE. The first line not
- starting with <constant>katetemplate:</constant> will be taken as the
- start of the template contents. VALUE may contain any character but
- equal sign (=). Legal variable names are:
- <variablelist>
- <varlistentry>
- <term><varname>Template</varname></term>
- <listitem><para>This is the template name, displayed in the
- <menuchoice><guimenu>File</guimenu><guimenuitem>New from
- Template</guimenuitem></menuchoice> menu.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><varname>Group</varname></term>
- <listitem><para>The group places the template in a submenu of
- the <menuchoice><guimenu>File</guimenu><guimenuitem>New from
- Template</guimenuitem></menuchoice> menu.</para></listitem>
- </varlistentry>
- <varlistentry><term><varname>Name</varname></term>
- <listitem><para>This is the name that will be set for the
- document, and displayed in the file list and title bar. If the
- name contains <userinput>%N</userinput> that will be replaced
- with a number, incrementing if more documents have the same
- name.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><varname>Highlight</varname></term>
- <listitem><para>The plugin will try to set the Highlight for
- the new document to the value of this variable. The value
- should be the name, as found in
- <menuchoice><guimenu>Tools</guimenu>
- <guimenuitem>Highlighting</guimenuitem>
- </menuchoice>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><varname>Description</varname></term>
- <listitem><para>A short informative description of the
- template. This is currently used to set a <guimenuitem>What's this?</guimenuitem> string for
- the menu item, but may be used for additional purposes in the
- future.</para></listitem>
- </varlistentry>
- <varlistentry><term>Author</term>
- <listitem><para>A string identifying the author, for example
- in the form <userinput>Name <email address></userinput>.
- This is currently used to set a <guimenuitem>What's this?</guimenuitem> string for the menu
- item, but may be used for additional purposes in the
- future.</para></listitem>
- </varlistentry>
- </variablelist>
- </para>
-
- </sect3>
-
- <sect3 id="katetemplates-macros">
- <title>Template Macros</title>
-
- <para>While parsing the template contents, macros in the form
- <userinput>%{NAME}</userinput> or <userinput>${NAME}</userinput> are
- expanded. If you use the <userinput>$</userinput> prefix, the
- expanded macro will be treated as a editable variable when a document
- is created from the template, whereas if you use
- <userinput>%</userinput> it is not, unless expanding failed.</para>
- <para>The following macros are expanded:
- <variablelist>
- <varlistentry><term><literal>time</literal></term>
- <listitem><para>Expands to the current time in your locale
- format.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>date</literal></term>
- <listitem><para>Expands to the current date in short
- format.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>datetime</literal></term>
- <listitem><para>Expands to the current date and time,
- formatted as a string according to your
- locale.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>year</literal></term>
- <listitem><para>The current year as a four digit
- number.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>month</literal></term>
- <listitem><para>The full name of the current month, according
- to your locale.</para></listitem>
- </varlistentry>
- <varlistentry><term><literal>day</literal></term>
- <listitem><para>Expands to the current day of the month.</para>
- </listitem>
- </varlistentry>
- <varlistentry><term><literal>hostname</literal></term>
- <listitem><para>Expands to the hostname of your computer.</para>
- </listitem>
- </varlistentry>
- <varlistentry><term><literal>index</literal></term>
- <listitem><para>Expands to 'i'.</para></listitem>
- </varlistentry>
- <varlistentry><term><literal>fullname</literal></term>
- <listitem><para>Expands to your full name, as defined in the
- owner addressee in your standard &kde;
- addressbook.</para></listitem>
- </varlistentry>
- <varlistentry><term><literal>firstname</literal></term>
- <listitem><para>Expands to your first name, as defined in the owner
- addressee in your standard &kde; addressbook.</para>
- </listitem>
- </varlistentry>
- <varlistentry><term><literal>lastname</literal></term>
- <listitem><para>Expands to your last name, as defined in the owner
- addressee in your standard &kde; addressbook.</para>
- </listitem>
- </varlistentry>
- <!-- <varlistentry>
- <term>username</term>
- <listitem><para>Expands to your username.</para></listitem>
- </varlistentry> -->
- <varlistentry>
- <term>email</term>
- <listitem><para>Expands to your email address, as defined in
- the owner address in your standard &kde;
- addressbook.</para></listitem>
- </varlistentry>
- <!--<varlistentry>
- <term>organisation</term>
- <listitem><para>This is your organisation, as defined by
- the owner address in your standard KDE
- addressbook.</para></listitem>
- </varlistentry>-->
- </variablelist>
- </para>
- <para>Any macro not in the above list is treated as an editable variable
- no matter the prefix.
- If the same variable occurs multiple times in the template, they can be
- edited at once after creating a document from the template.</para>
- </sect3>
-
- <sect3 id="katefiletemplates-cursor">
- <title>Setting the cursor position</title>
- <para>The special macro <userinput>${cursor}</userinput> will be replaced
- with a vertical bar and added to the end of the list of editable variables,
- independent of its location in the text.</para>
- </sect3>
-
- </sect2>
- <sect2>
- <title>Thanks and Acknowledgments</title>
- <para>
- &kate; Plugin <quote>File Templates</quote> copyright 2004 &Anders.Lund;
- &Anders.Lund.mail;.
- </para>
- <para>Documentation copyright 2004 &Anders.Lund;</para>
- </sect2>
-</sect1>
-
<!-- from doc/kate-addons/xmlcheck.docbook -->
-<sect1 id="kate-application-plugin-xmlcheck">
-<sect1info>
-<authorgroup><author>
-&Daniel.Naber; &Daniel.Naber.mail;
-</author></authorgroup>
-</sect1info>
-
-<title>&XML; Validation</title>
-
-<para>This plugin checks &XML; files for validity and being well-formed.</para>
-<para>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 <quote>DOCTYPE</quote>
-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 <quote>DTD/xhtml1-transitional.dtd</quote> and the file is <filename>/home/peter/test.xml</filename>
-the DTD is expected to be located at <filename>/home/peter/DTD/xhtml1-transitional.dtd</filename>.
-However, remote DTDs specified via http are supported.</para>
-
-<para>If the file has no doctype it will be checked for being well-formed.</para>
-
-<para>To learn more about &XML; check out the <ulink url="http://www.w3.org/XML/"> official W3C &XML; pages</ulink>.</para>
-
-<para>Internally this plugin calls the external command <command>xmllint</command>, which
-is part of libxml2. If this command is not correctly installed on your system, the plugin
-will not work.</para>
-
-<note><para>A temporary file needs to be written to the same folder as the file
-that is being checked is in, so you need to have write access to that folder.</para></note>
-
-<para>To load this plugin open &kate;'s configuration dialog under <menuchoice><guimenu>Settings</guimenu>
-<guimenuitem>Configure &kate;...</guimenuitem></menuchoice>.
-Then select <guilabel>&XML; Validation</guilabel> which will appear
-in the <guilabel>Application</guilabel> / <guilabel>Plugins</guilabel> section and close the dialog.
-</para>
-
-<sect2 id="xmlcheck-menu">
-<title>Menu Structure</title>
-
-<variablelist>
-<varlistentry>
-<term>
-<menuchoice>
-<guimenu>&XML;</guimenu>
-<guimenuitem>Validate &XML;</guimenuitem>
-</menuchoice>
-</term>
-<listitem><para>This will start the check, as described above.</para></listitem>
-</varlistentry>
-</variablelist>
-
-</sect2>
-
-<sect2 id="xmlcheck-thanks-and-acknowledgements">
-<title>Thanks and Acknowledgments</title>
-<para>
-&kate; Plugin <quote>&XML; Validation</quote> copyright 2002 &Daniel.Naber;
-&Daniel.Naber.mail;.
-</para>
-<para>Documentation copyright 2002 &Daniel.Naber;</para>
-
-</sect2>
-</sect1>
-
<sect1 id="kate-application-plugin-xmltools">
<sect1info>
<authorgroup><author>
@@ -984,7 +346,7 @@ Export your file in &HTML; format so your document can be viewed as a web page.
<sect2 id="searchinfiles-intro">
<title>Introduction</title>
<para>&kappname;'s Search & Replace plugin allows you to search for text or
-<ulink url="help:katepart/regular-expressions.html">regular expressions</ulink>
+<ulink url="help:/katepart/regular-expressions.html">regular expressions</ulink>
in many different files at once. You can search all open files, all the files
in one directory and optionally its subdirectories, or all files in the current
project. You can even filter by filename, for instance searching only files
@@ -1096,7 +458,7 @@ of upper and lower case letters as your search query.
<varlistentry>
<term><guilabel>Regular expressions</guilabel></term>
<listitem><para>
-Permits you to use <ulink url="help:katepart/regular-expressions.html">regular
+Permits you to use <ulink url="help:/katepart/regular-expressions.html">regular
expressions</ulink> instead of simple text as your search query.
</para></listitem>
</varlistentry>
@@ -1310,35 +672,6 @@ plugin.</para>
</sect2>
</sect1>
-<sect1 id="kate-application-plugin-mail">
-<!--<sect1info>
-<authorgroup><author>
-&TC.Hollingsworth; &TC.Hollingsworth.mail;
-</sect1info>-->
-<title>Mail Files</title>
-
-<sect2 id="mail-menu">
-<title>Menu Structure</title>
-<variablelist>
-
-<varlistentry>
-<term>
-<menuchoice>
-<guimenu>File</guimenu>
-<guimenuitem>Mail...</guimenuitem>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Open your mail client and attach the file in the mail.
-</para>
-</listitem>
-</varlistentry>
-
-</variablelist>
-</sect2>
-</sect1>
-
<sect1 id="kate-application-plugin-fsbrowser">
<!--<sect1info>
<authorgroup><author>
diff --git a/doc/katepart/index.docbook b/doc/katepart/index.docbook
index bf22973..bc91dbf 100644
--- a/doc/katepart/index.docbook
+++ b/doc/katepart/index.docbook
@@ -2,7 +2,6 @@
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
<!ENTITY kappname "&katepart;">
- <!ENTITY package "kdebase">
<!ENTITY imgpath "./">
<!ENTITY rcfile "kwriterc">
<!ENTITY fundamentals-chapter SYSTEM "fundamentals.docbook">
@@ -55,8 +54,8 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2014-02-22</date>
-<releaseinfo>5.0 (&kde; 5.0)</releaseinfo>
+<date>2015-07-31</date>
+<releaseinfo>Applications 15.12</releaseinfo>
<abstract>
<para>&katepart; is a fully featured editor component for &Qt; and &kde;
diff --git a/doc/katepart/menus.docbook b/doc/katepart/menus.docbook
index 5554c8f..05ef550 100644
--- a/doc/katepart/menus.docbook
+++ b/doc/katepart/menus.docbook
@@ -929,8 +929,7 @@ that with <computeroutput><div></div></computeroutput>.
</menuchoice></term>
<listitem><para>
Wraps the selected text with the tag provided on the
-<ulink url="help:katepart/dev-scripting.html#dev-scripting-command-line">command
-line</ulink>.
+<link linkend="dev-scripting-command-line">command line</link>.
</para></listitem>
</varlistentry>
diff --git a/doc/kwrite/index.docbook b/doc/kwrite/index.docbook
index d6ecd14..d336a4d 100644
--- a/doc/kwrite/index.docbook
+++ b/doc/kwrite/index.docbook
@@ -26,8 +26,8 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2014-10-21</date>
-<releaseinfo>5</releaseinfo>
+<date>2015-07-31</date>
+<releaseinfo>Applications 15.12</releaseinfo>
<abstract>
<para>&kwrite; is a text editor for &kde; allowing you to edit one file at the time per window.</para>
More information about the kde-doc-english
mailing list