[plasma/kwin] /: Add touch screen KCM docs
Yuri Chornoivan
null at kde.org
Sat Apr 10 17:00:07 BST 2021
Git commit 60d12b91f2688a379b12de756aed065faa6fb5c3 by Yuri Chornoivan.
Committed on 10/04/2021 at 15:59.
Pushed by yurchor into branch 'master'.
Add touch screen KCM docs
M +1 -0 doc/CMakeLists.txt
A +2 -0 doc/kwintouchscreen/CMakeLists.txt
A +40 -0 doc/kwintouchscreen/index.docbook
M +1 -0 src/kcmkwin/kwinscreenedges/kwintouchscreen.desktop
https://invent.kde.org/plasma/kwin/commit/60d12b91f2688a379b12de756aed065faa6fb5c3
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 4b9858e59..22bd4a3a6 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -2,6 +2,7 @@ ecm_optional_add_subdirectory(desktop)
ecm_optional_add_subdirectory(kwindecoration)
ecm_optional_add_subdirectory(kwinscreenedges)
ecm_optional_add_subdirectory(kwintabbox)
+ecm_optional_add_subdirectory(kwintouchscreen)
ecm_optional_add_subdirectory(windowbehaviour)
ecm_optional_add_subdirectory(windowspecific)
ecm_optional_add_subdirectory(kwineffects)
diff --git a/doc/kwintouchscreen/CMakeLists.txt b/doc/kwintouchscreen/CMakeLists.txt
new file mode 100644
index 000000000..3c3bb4497
--- /dev/null
+++ b/doc/kwintouchscreen/CMakeLists.txt
@@ -0,0 +1,2 @@
+########### install files ###############
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/kwintouchscreen)
diff --git a/doc/kwintouchscreen/index.docbook b/doc/kwintouchscreen/index.docbook
new file mode 100644
index 000000000..ca051bcca
--- /dev/null
+++ b/doc/kwintouchscreen/index.docbook
@@ -0,0 +1,40 @@
+<?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>&Mike.McBride; &Mike.McBride.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2021-04-10</date>
+<releaseinfo>Plasma 5.20</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>Systemsettings</keyword>
+<keyword>touch</keyword>
+<keyword>screen</keyword>
+</keywordset>
+</articleinfo>
+
+<para>Swiping from the screen edge towards the center of the screen allow you to activate effects. Here you can configure which effect will get activated on each edge of the screen.
+</para>
+
+<para>Click with any mouse button onto a square and select an effect
+in the context menu. Edges with a blue square have already an attached effect,
+a grey-colored square indicates that no effect is selected for this edge.</para>
+
+<para>The number of accessible items in the context menu depends on the settings in the module
+ <ulink url="help:/kcontrol/kwineffects/index.html">
+<guilabel>Desktop Effects</guilabel></ulink> in the <guilabel>Workspace</guilabel>
+category. Select your favorite effects from the <guilabel>Window Management</guilabel>
+group. This activates the corresponding items in the context menu.</para>
+</article>
diff --git a/src/kcmkwin/kwinscreenedges/kwintouchscreen.desktop b/src/kcmkwin/kwinscreenedges/kwintouchscreen.desktop
index ee9ceaa97..49e9728b0 100644
--- a/src/kcmkwin/kwinscreenedges/kwintouchscreen.desktop
+++ b/src/kcmkwin/kwinscreenedges/kwintouchscreen.desktop
@@ -2,6 +2,7 @@
Icon=preferences-desktop-gestures-touch
Type=Service
X-KDE-ServiceTypes=KCModule
+X-DocPath=kcontrol/kwintouchscreen/index.html
X-KDE-Library=kcm_kwintouchscreen
X-KDE-ParentApp=kcontrol
More information about the kde-doc-english
mailing list