Git commit 42e0ada05d4cb50f765c3093a1a6ee97fd511530 by T.C. Hollingsworth. Committed on 04/02/2013 at 10:04. Pushed by hollingsworth into branch 'master'.
give KatePart plugin docs a new home M +1 -1 doc/kate/configuring-part.docbook M +1 -0 doc/kate/index.docbook A +62 -0 doc/kate/plugins-part.docbook M +2 -4 doc/kate/plugins.docbook M +2 -0 doc/kwrite/configuring.docbook M +1 -0 doc/kwrite/index.docbook http://commits.kde.org/kate/42e0ada05d4cb50f765c3093a1a6ee97fd511530 diff --git a/doc/kate/configuring-part.docbook b/doc/kate/configuring-part.docbook index 2458e88..a53bfaf 100644 --- a/doc/kate/configuring-part.docbook +++ b/doc/kate/configuring-part.docbook @@ -1169,6 +1169,6 @@ want to use. Click on the <guibutton>Information</guibutton> button to open the in order to configure the highlighted plugin.</para> <para>For more information on the available plugins, see -<!--FIXME: need to add this docbook to kwrite <xref linkend="plugins"/>-->.</para> +<xref linkend="editor-component-plugins"/>.</para> </sect2> </sect1> diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook index 825b3d4..bf03a64 100644 --- a/doc/kate/index.docbook +++ b/doc/kate/index.docbook @@ -17,6 +17,7 @@ <!ENTITY menu-chapter SYSTEM "menus.docbook"> <!ENTITY part-chapter SYSTEM "part.docbook"> <!ENTITY plugins-chapter SYSTEM "plugins.docbook"> + <!ENTITY plugins-part-sections SYSTEM "plugins-part.docbook"> <!ENTITY vi-chapter SYSTEM "vi.docbook"> <!ENTITY regexp-appendix SYSTEM "regular-expressions.docbook"> <!ENTITY % addindex "IGNORE"> diff --git a/doc/kate/plugins-part.docbook b/doc/kate/plugins-part.docbook new file mode 100644 index 0000000..d3cd505 --- /dev/null +++ b/doc/kate/plugins-part.docbook @@ -0,0 +1,62 @@ +<!--pulled in by kwrite--> +<sect1 id="editor-component-plugins"> +<title>Editor Component Extensions</title> +<variablelist> + +<!-- not released with 4.7 +<varlistentry> +<term><guilabel>Artistic Comment</guilabel></term> +<listitem><para>Format long source-code comments like license-headers +or descriptions using different style.</para></listitem> +</varlistentry> +--> + +<varlistentry> +<term><guilabel>AutoBrace</guilabel></term> +<listitem><para>The autobrace plugin supersedes the &kappname; 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>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 +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> + +<!--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 +<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>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> + +</variablelist> +</sect1> diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook index 1fb91aa..d5c05c9 100644 --- a/doc/kate/plugins.docbook +++ b/doc/kate/plugins.docbook @@ -25,10 +25,6 @@ and you can search the web for more. A few plugins are shipped with the editor component, for inserting automatic braces, insert files, and exporting text as &HTML;.</para> -<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> @@ -139,6 +135,8 @@ http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/ </itemizedlist> </sect1> +&plugins-part-sections; + <!-- from doc/kate-addons/filetemplates.docbook --> <sect1 id="kate-application-plugin-filetemplate"> <sect1info> diff --git a/doc/kwrite/configuring.docbook b/doc/kwrite/configuring.docbook index bb61c3f..26364b2 100644 --- a/doc/kwrite/configuring.docbook +++ b/doc/kwrite/configuring.docbook @@ -23,4 +23,6 @@ process. The categories <guilabel>Appearance</guilabel>, &configuring-part-sections; +&plugins-part-sections; + </chapter> \ No newline at end of file diff --git a/doc/kwrite/index.docbook b/doc/kwrite/index.docbook index 015655a..f356810 100644 --- a/doc/kwrite/index.docbook +++ b/doc/kwrite/index.docbook @@ -11,6 +11,7 @@ <!ENTITY configuring-part-sections SYSTEM "../kate/configuring-part.docbook"> <!ENTITY menus-chapter SYSTEM "menus.docbook"> <!ENTITY part-chapter SYSTEM "../kate/part.docbook"> + <!ENTITY plugins-part-sections SYSTEM "../kate/plugins-part.docbook"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE" > <!-- change language only here --> ]>
