[kate] doc: update kate docbooks to reflect the split off of syntax highlighting to frameworks

[Burkhard Lück]

Git commit 5b12273b7ee32f55c9593c04d0786286b717e031 by Burkhard Lück.
Committed on 05/02/2017 at 08:00.
Pushed by lueck into branch 'master'.

update kate docbooks to reflect the split off of syntax highlighting to frameworks

bump date + releaseinfo in katepart
adapt to changes using the frameworks syntax-highlighting (no *xml installed, compiled into a library)
fix location of language.xsd, no longer installed

REVIEW:129880

M  +1    -1    doc/kate/plugins.docbook
M  +22   -9    doc/katepart/development.docbook
M  +2    -2    doc/katepart/index.docbook

https://commits.kde.org/kate/5b12273b7ee32f55c9593c04d0786286b717e031

diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index 7409b6d9a..9b22ffc26 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -2612,7 +2612,7 @@ writing much of this section.</para>
 <member>Hide/Show Functions Parameters</member>
 <member>Expand/collapse tree mode</member>
 <member>Auto-update on document change</member>
-<member>Code parsing is based on &kate; highlighting</member>
+<member>Code parsing is based on the Syntax-Highlighting framework from &kde-frameworks;</member>
 </simplelist>
 
 </sect2>
diff --git a/doc/katepart/development.docbook b/doc/katepart/development.docbook
index 3c106bb1e..63cfdd015 100644
--- a/doc/katepart/development.docbook
+++ b/doc/katepart/development.docbook
@@ -219,20 +219,29 @@ will be explained later.</para>
 <sect3>
 <title>Overview</title>
 
+<para>&kappname; uses the Syntax-Highlighting framework from &kde-frameworks;.
+The default highlighting xml files shipped with &kappname; are compiled
+into the Syntax-Highlighting library by default.
+</para>
+
 <para>This section is an overview of the Highlight Definition &XML;
 format. Based on a small example it will describe the main components
 and their meaning and usage. The next section will go into detail with
 the highlight detection rules.</para>
 
-<para>The formal definition, also known as the <acronym>XSD</acronym>, is stored
-in the file <filename>language.xsd</filename> which should be
-installed on your system in the folder
-<filename>$<envar>XDG_DATA_DIRS</envar>/katepart5/syntax</filename>. Therein,
-the environment variable <envar>XDG_DATA_DIRS</envar> typically expands to
-<filename>/usr/share</filename>.
+<para>The formal definition, also known as the <acronym>XSD</acronym> you
+find in <ulink url="https://commits.kde.org/syntax-highlighting?path=data/schema">Syntax
+Highlighting repository</ulink> in the file <filename>language.xsd</filename>
+</para>
+
+<para>Custom <filename class="extension">.xml</filename> highlight definition files are
+located in <filename class="directory">org.kde.syntax-highlighting/syntax/</filename> in
+your user folder found with <userinput><command>qtpaths</command><option>--paths
+GenericDataLocation</option></userinput> which usually is
+<filename class="directory"><envar>$HOME</envar>/.local</filename>
 </para>
 
-<para>On &Windows; these files are located in <filename>%USER%\AppData\Local\katepart5\syntax</filename>.
+<para>On &Windows; these files are located <filename>%USERPROFILE%/AppData/Local/org.kde.syntax-highlighting/syntax</filename>.
 <replaceable>%USER%</replaceable> usually expands to <filename>C:\\Users\\<replaceable>user</replaceable></filename>.</para>
 
 <variablelist>
@@ -1006,7 +1015,11 @@ keep the matched string for the next context.
 </listitem>
 <listitem>
 <para>You can validate every XML file by using the command
-<command>xmllint --schema language.xsd mySyntax.xml</command>.</para>
+<command>validatehl.sh language.xsd mySyntax.xml</command>.
+The files <filename>validatehl.sh</filename> and <filename>language.xsd</filename>
+are available in <ulink url="https://commits.kde.org/syntax-highlighting?path=data/schema">Syntax
+Highlighting repository</ulink>.
+</para>
 </listitem>
 <listitem>
 <para>If you repeat complex regular expression very often you can use
@@ -1056,7 +1069,7 @@ Therein, the environment variable <envar>XDG_DATA_HOME</envar> typically expands
 either <filename>~/.local</filename> or <filename>~/.local/share</filename>.
 </para>
 <para>On &Windows; these files are located in <filename>%USER%\AppData\Local\katepart5\indentation</filename>.
-<replaceable>%USER%</replaceable> usually expands to <filename>C:\\Users\\<replaceable>user</replaceable></filename>.</para>
+<replaceable>%USERPROFILE%</replaceable> usually expands to <filename>C:\\Users\\<replaceable>user</replaceable></filename>.</para>
 
 <sect3 id="dev-scripting-indentation-header">
 <title>The Indentation Script Header</title>
diff --git a/doc/katepart/index.docbook b/doc/katepart/index.docbook
index 83a22adf3..480da2f5f 100644
--- a/doc/katepart/index.docbook
+++ b/doc/katepart/index.docbook
@@ -52,8 +52,8 @@
 </copyright>
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2016-04-09</date>
-<releaseinfo>Frameworks 5.21</releaseinfo>
+<date>2017-01-24</date>
+<releaseinfo>Frameworks 5.31</releaseinfo>
 
 <abstract>
 <para>&katepart; is a fully featured editor component by &kde;.</para>