[utilities/kate] doc/kate: Add docs for the color picker plugin

[Yuri Chornoivan]

Git commit 193a471171397d1adfedd281e45e093a6b4e6bd1 by Yuri Chornoivan.
Committed on 22/12/2020 at 15:47.
Pushed by yurchor into branch 'master'.

Add docs for the color picker plugin

M  +53   -0    doc/kate/plugins.docbook

https://invent.kde.org/utilities/kate/commit/193a471171397d1adfedd281e45e093a6b4e6bd1

diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index ff5cb1779..a0a39ae78 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -48,6 +48,10 @@ The available application plugins are:
 - Close group of documents based on a common path or file extension</para>
 </listitem>
 <listitem>
+<para><link linkend="kate-application-plugin-colorpicker">Color Picker</link>
+- Show preview for known color names</para>
+</listitem>
+<listitem>
 <para><link linkend="kate-application-plugin-ctags">CTags</link> -
 Look up definitions/declarations with CTags</para>
 </listitem>
@@ -432,6 +436,55 @@ which match the path or file extension selected from the submenu.</para>
 
 </sect1>
 
+<sect1 id="kate-application-plugin-colorpicker">
+
+<title>Color Picker Plugin</title>
+
+<sect2 id="colorpicker-intro">
+<title>Introduction</title>
+
+<para>This plugin adds an inline color preview/picker to colors in the text (⪚, <literal>#FFFFFF</literal>, 
+<literal>white</literal>).</para>
+
+<para>To load this plugin open &kate;'s configuration dialog under <menuchoice><guimenu>Settings</guimenu>
+<guimenuitem>Configure &kate;...</guimenuitem></menuchoice>.
+Then select <guilabel>Color Picker</guilabel> and close the dialog.
+</para>
+</sect2>
+
+<sect2 id="colorpicker-config">
+<title>Configuration</title>
+
+<para>On the Color Picker settings page in &kate;'s configuration, you can configure the following options of the plugin behavior.</para>
+
+<variablelist>
+
+<varlistentry>
+<term><guilabel>Show preview for known color names</guilabel></term>
+<listitem>
+<para>Whether to show the color picker for known color names (⪚, <literal>skyblue</literal>). See <ulink url="https://www.w3.org/TR/SVG11/types.html#ColorKeywords">this page</ulink> for the list of colors.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Place preview after text color</guilabel></term>
+<listitem>
+<para>Whether to place the inline preview after text color in the text.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Hex color matching</guilabel></term>
+<listitem>
+<para>Here, you can choose the best matching option for the colors used in your code.</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect2>
+
+</sect1>
 
 <sect1 id="kate-application-plugin-ctags">
 <!--https://kate-editor.org/2012/11/02/using-the-projects-plugin-in-kate/-->