[plasma/kwin] /: Add docs for virtual keyboard KCM

[Yuri Chornoivan]

Git commit 22ee512ba6ab203e0e3dfd26eb6296602256dce9 by Yuri Chornoivan.
Committed on 27/04/2021 at 14:09.
Pushed by yurchor into branch 'master'.

Add docs for virtual keyboard KCM

M  +1    -0    doc/CMakeLists.txt
A  +2    -0    doc/kwinvirtualkeyboard/CMakeLists.txt
A  +44   -0    doc/kwinvirtualkeyboard/index.docbook
M  +1    -0    src/kcmkwin/kwinvirtualkeyboard/kcm_virtualkeyboard.desktop

https://invent.kde.org/plasma/kwin/commit/22ee512ba6ab203e0e3dfd26eb6296602256dce9

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 22bd4a3a6..c305cdd48 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -3,6 +3,7 @@ ecm_optional_add_subdirectory(kwindecoration)
 ecm_optional_add_subdirectory(kwinscreenedges)
 ecm_optional_add_subdirectory(kwintabbox)
 ecm_optional_add_subdirectory(kwintouchscreen)
+ecm_optional_add_subdirectory(kwinvirtualkeyboard)
 ecm_optional_add_subdirectory(windowbehaviour)
 ecm_optional_add_subdirectory(windowspecific)
 ecm_optional_add_subdirectory(kwineffects)
diff --git a/doc/kwinvirtualkeyboard/CMakeLists.txt b/doc/kwinvirtualkeyboard/CMakeLists.txt
new file mode 100644
index 000000000..ec32b7efa
--- /dev/null
+++ b/doc/kwinvirtualkeyboard/CMakeLists.txt
@@ -0,0 +1,2 @@
+########### install files ###############
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/kwinvirtualkeyboard)
diff --git a/doc/kwinvirtualkeyboard/index.docbook b/doc/kwinvirtualkeyboard/index.docbook
new file mode 100644
index 000000000..7e2a3e1ac
--- /dev/null
+++ b/doc/kwinvirtualkeyboard/index.docbook
@@ -0,0 +1,44 @@
+<?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="kwinscreenedges" lang="&language;">
+<articleinfo>
+
+<title>Touch Screen</title>
+<authorgroup>
+<author>
+<firstname>Yuri</firstname>
+<surname>Chornoivan</surname>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2021-04-27</date>
+<releaseinfo>Plasma 5.22</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>Systemsettings</keyword>
+<keyword>virtual</keyword>
+<keyword>keyboard</keyword>
+</keywordset>
+</articleinfo>
+
+<para>
+    This module lets you choose the virtual keyboard to use. The virtual keyboard will be automatically enabled when there is no hardware keyboard detected.
+</para>
+
+<para>
+    Select a <ulink url="https://en.wikipedia.org/wiki/Virtual_keyboard">virtual keyboard</ulink>
+    from the list or choose <guilabel>None</guilabel> if you do not want to use any virtual keyboard.
+</para>
+
+<para>
+    It is advisable to install corresponding input method engines before using this module.
+</para>
+
+</article>
diff --git a/src/kcmkwin/kwinvirtualkeyboard/kcm_virtualkeyboard.desktop b/src/kcmkwin/kwinvirtualkeyboard/kcm_virtualkeyboard.desktop
index 8be953df7..c6927b9a1 100644
--- a/src/kcmkwin/kwinvirtualkeyboard/kcm_virtualkeyboard.desktop
+++ b/src/kcmkwin/kwinvirtualkeyboard/kcm_virtualkeyboard.desktop
@@ -11,6 +11,7 @@ X-KDE-ParentApp=kcontrol
 
 X-KDE-System-Settings-Parent-Category=input-devices
 X-KDE-OnlyShowOnQtPlatforms=wayland;
+X-DocPath=kcontrol/kwinvirtualkeyboard/index.html
 
 Name=Virtual Keyboard
 Comment=Select which virtual keyboard to use