[plasma-desktop] /: add workspaceoptions docbook

[Burkhard Lück]

Git commit 6229570c3da21072fdb887e585a9b68d9bcaf11e by Burkhard Lück.
Committed on 25/05/2018 at 19:01.
Pushed by lueck into branch 'master'.

add workspaceoptions docbook

in systemsettings it is not possible to find the module
containing the single / double click settings using the search field
but that works in khelpcenter and on docs.kde.org
-> therefore add a workspaceoptions docbook

Differential Revision: https://phabricator.kde.org/D13022

M  +1    -0    doc/kcontrol/CMakeLists.txt
A  +1    -0    doc/kcontrol/workspaceoptions/CMakeLists.txt
A  +74   -0    doc/kcontrol/workspaceoptions/index.docbook
M  +1    -0    kcms/workspaceoptions/kcm_workspace.desktop

https://commits.kde.org/plasma-desktop/6229570c3da21072fdb887e585a9b68d9bcaf11e

diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt
index 544643e8..e900eabd 100644
--- a/doc/kcontrol/CMakeLists.txt
+++ b/doc/kcontrol/CMakeLists.txt
@@ -29,4 +29,5 @@ ecm_optional_add_subdirectory(componentchooser)
 ecm_optional_add_subdirectory(kded)
 ecm_optional_add_subdirectory(solid-device-automounter)
 ecm_optional_add_subdirectory(phonon)
+ecm_optional_add_subdirectory(workspaceoptions)
 
diff --git a/doc/kcontrol/workspaceoptions/CMakeLists.txt b/doc/kcontrol/workspaceoptions/CMakeLists.txt
new file mode 100644
index 00000000..104db489
--- /dev/null
+++ b/doc/kcontrol/workspaceoptions/CMakeLists.txt
@@ -0,0 +1 @@
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/workspaceoptions)
diff --git a/doc/kcontrol/workspaceoptions/index.docbook b/doc/kcontrol/workspaceoptions/index.docbook
new file mode 100644
index 00000000..4676ada3
--- /dev/null
+++ b/doc/kcontrol/workspaceoptions/index.docbook
@@ -0,0 +1,74 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
+"dtd/kdedbx45.dtd" [
+<!ENTITY % addindex "IGNORE">
+<!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article id="workspaceoptions" lang="&language;">
+<articleinfo>
+<title>Workspace Behaviour</title>
+<authorgroup>
+<author>&Burkhard.Lueck; &Burkhard.Lueck.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2018-05-21</date>
+
+<releaseinfo>&plasma; 5.13</releaseinfo>
+
+<keywordset>
+<keyword>System Settings</keyword>
+<keyword>desktop</keyword>
+<keyword>workspace</keyword>
+</keywordset>
+
+</articleinfo>
+
+<para>This is a module to configure global options for the &plasma; workspace.
+</para>
+
+<variablelist>
+
+<varlistentry>
+<term><guilabel>Display informational tooltips on mouse hover</guilabel></term>
+<listitem>
+<para>If this option is checked, tooltips are displayed hovering items in the
+&plasma; panel or on the desktop.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Display visual feedback for status changes</guilabel></term>
+<listitem>
+<para>If you change ⪚ brightness and volume using the keyboard these status
+changes are displayed in an OSD.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Single-click to open files and folders</guilabel></term>
+<listitem>
+<para>This is the default setting. Clicking once on an icon
+will open it.  To select you can drag around the icon(s) or <keycombo
+action="simul">&Ctrl;<mousebutton>Right</mousebutton></keycombo> click,
+or simply click and hold to drag it.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Double-click to open files and folders (select icons on first click)</guilabel></term>
+<listitem>
+<para>If this option is not checked, icons/files will be opened with a
+single click of the <mousebutton>left</mousebutton> mouse-button. This
+default behavior is consistent with what you would expect when you click
+links in most web browsers. If checked however, icons/files will be
+opened with a double click, while a single click will only select the
+icon or file. This is the behavior you may know from other desktops or
+operating systems.</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+
+</article>
diff --git a/kcms/workspaceoptions/kcm_workspace.desktop b/kcms/workspaceoptions/kcm_workspace.desktop
index bd832746..b6911b03 100644
--- a/kcms/workspaceoptions/kcm_workspace.desktop
+++ b/kcms/workspaceoptions/kcm_workspace.desktop
@@ -7,6 +7,7 @@ X-KDE-Library=kcm_workspace
 X-KDE-ParentApp=kcontrol
 X-KDE-System-Settings-Parent-Category=desktopbehavior
 X-KDE-Weight=40
+X-DocPath=kcontrol/workspaceoptions/index.html
 Name=Workspace
 Name[ar]=مساحة العمل
 Name[bs]=Radna površina