[kde-doc-english] [kwin] doc: Add docbook for kwineffects kcm

Fri May 13 06:11:49 UTC 2016

Git commit 7dbad7bade7a4387dbc8e8787ccf11947992bb4c by Burkhard Lück.
Committed on 13/05/2016 at 06:11.
Pushed by lueck into branch 'master'.

Add docbook for kwineffects kcm

REVIEW:124341

M  +1    -0    doc/CMakeLists.txt
A  +2    -0    doc/kwineffects/CMakeLists.txt
A  +-    --    doc/kwineffects/configure-effects.png
A  +-    --    doc/kwineffects/configure-filter.png
A  +-    --    doc/kwineffects/dialog-information.png
A  +86   -0    doc/kwineffects/index.docbook
A  +-    --    doc/kwineffects/video.png

http://commits.kde.org/kwin/7dbad7bade7a4387dbc8e8787ccf11947992bb4c

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 8e2d1cb..4b9858e 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -4,3 +4,4 @@ ecm_optional_add_subdirectory(kwinscreenedges)
 ecm_optional_add_subdirectory(kwintabbox)
 ecm_optional_add_subdirectory(windowbehaviour)
 ecm_optional_add_subdirectory(windowspecific)
+ecm_optional_add_subdirectory(kwineffects)
diff --git a/doc/kwineffects/CMakeLists.txt b/doc/kwineffects/CMakeLists.txt
new file mode 100644
index 0000000..8f01b06
--- /dev/null
+++ b/doc/kwineffects/CMakeLists.txt
@@ -0,0 +1,2 @@
+########### install files ###############
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/kwineffects)
diff --git a/doc/kwineffects/configure-effects.png b/doc/kwineffects/configure-effects.png
new file mode 100644
index 0000000..4b13fb6
Binary files /dev/null and b/doc/kwineffects/configure-effects.png differ
diff --git a/doc/kwineffects/configure-filter.png b/doc/kwineffects/configure-filter.png
new file mode 100644
index 0000000..a7df970
Binary files /dev/null and b/doc/kwineffects/configure-filter.png differ
diff --git a/doc/kwineffects/dialog-information.png b/doc/kwineffects/dialog-information.png
new file mode 100644
index 0000000..7b8ec32
Binary files /dev/null and b/doc/kwineffects/dialog-information.png differ
diff --git a/doc/kwineffects/index.docbook b/doc/kwineffects/index.docbook
new file mode 100644
index 0000000..3cef55a
--- /dev/null
+++ b/doc/kwineffects/index.docbook
@@ -0,0 +1,86 @@
+<?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="kwineffects" lang="&language;">
+<articleinfo>
+
+<title>Desktop Effects</title>
+<authorgroup>
+<author>&Mike.McBride; &Mike.McBride.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2016-04-14</date>
+<releaseinfo>Plasma 5.6</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>KControl</keyword>
+<keyword>desktop</keyword>
+<keyword>effects</keyword>
+</keywordset>
+</articleinfo>
+
+<!--FIXME Compositor Enable compositor on startup necessary to have effects?-->
+
+<para>This module is used to enable and configure desktop effects
+for Plasma.</para>
+
+<para>The main part of this page is a list of all available effects grouped 
+by <guilabel>Accessibility</guilabel>, <guilabel>Appearance</guilabel>, 
+<guilabel>Focus</guilabel>, <guilabel>Tools</guilabel>, <guilabel>Candy</guilabel> 
+and <guilabel>Window Management</guilabel>.</para>
+<para>Use the incremental search bar above the list window to find items in the list.</para>
+
+<para>Normally there is no reason for users to change that, but 
+there is a <inlinemediaobject><imageobject><imagedata fileref="configure-filter.png" format="PNG"/>
+</imageobject></inlinemediaobject> configuration button to modify the filtering of the list to show 
+also those effects.
+</para>
+
+<para>The easiest way of installing new effects is by using the built-in
+KNewStuff support in &kwin;. Press the <guibutton>Get New Effects</guibutton> button to open 
+a dialog with a list of available effects from the Internet and to install and uninstall effects.</para>
+<note><para>Please keep in mind that changing these sensible defaults can break your system.</para>
+</note>
+
+<para>Check an effect in the list to enable it. Display information about Author and License by 
+clicking the <inlinemediaobject><imageobject><imagedata fileref="dialog-information.png" format="PNG"/>
+</imageobject> </inlinemediaobject> info button at the right side of the list item.</para>
+
+<para>Some effects have settings options, in this case there is a <inlinemediaobject><imageobject>
+<imagedata fileref="configure-effects.png" format="PNG"/></imageobject></inlinemediaobject> configure button 
+at the left of the info button. Click it to open a configuration dialog.</para>
+<para>To see a video preview of an effect click on the <inlinemediaobject><imageobject><imagedata fileref="video.png" format="PNG"/>
+</imageobject></inlinemediaobject> button.</para>
+
+<para>Some effects are mutual exclusive to other effects. For example one would only want to activate the 
+<guilabel>Minimize Animations</guilabel> or the <guilabel>Magic Lamp</guilabel> effect. Both activated at the same 
+time result in broken animations. 
+</para>
+
+<para>For effects in a mutual exclusive group the &GUI; uses radio buttons and manages that only one of these 
+effects can be activated.
+</para>
+
+<para>All effects which are not supported by the currently used compositing backend 
+are hidden by default (⪚ OpenGL effects when using XRender).
+</para> 
+
+<para>Also all internal or helper effects are hidden by default. These are effects which replace 
+functionality from KWin Core or provide interaction with other elements of the desktop shell.
+</para>
+
+<!--FIXME 
+39 effects + 7 internal (XRender compositor)
+Internal effects
+Appearance (Dashboard, Highlight Windows, KSreen, Screenshot, Window Geometry)
+Candy (Startup feedback)
+Window Management (Cover Switch)
+-->
+
+</article>
diff --git a/doc/kwineffects/video.png b/doc/kwineffects/video.png
new file mode 100644
index 0000000..ac8e8c0
Binary files /dev/null and b/doc/kwineffects/video.png differ
