diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 8e2d1cb08a..4b9858e596 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 0000000000..8f01b062a1 --- /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 0000000000..4b13fb6e2a 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 0000000000..a7df970e8b 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 0000000000..7b8ec32de5 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 0000000000..3cef55a919 --- /dev/null +++ b/doc/kwineffects/index.docbook @@ -0,0 +1,86 @@ + + + +]> + +
+ + +Desktop Effects + +&Mike.McBride; &Mike.McBride.mail; + + + +2016-04-14 +Plasma 5.6 + + +KDE +KControl +desktop +effects + + + + + +This module is used to enable and configure desktop effects +for Plasma. + +The main part of this page is a list of all available effects grouped +by Accessibility, Appearance, +Focus, Tools, Candy +and Window Management. +Use the incremental search bar above the list window to find items in the list. + +Normally there is no reason for users to change that, but +there is a + configuration button to modify the filtering of the list to show +also those effects. + + +The easiest way of installing new effects is by using the built-in +KNewStuff support in &kwin;. Press the Get New Effects button to open +a dialog with a list of available effects from the Internet and to install and uninstall effects. +Please keep in mind that changing these sensible defaults can break your system. + + +Check an effect in the list to enable it. Display information about Author and License by +clicking the + info button at the right side of the list item. + +Some effects have settings options, in this case there is a + configure button +at the left of the info button. Click it to open a configuration dialog. +To see a video preview of an effect click on the + button. + +Some effects are mutual exclusive to other effects. For example one would only want to activate the +Minimize Animations or the Magic Lamp effect. Both activated at the same +time result in broken animations. + + +For effects in a mutual exclusive group the &GUI; uses radio buttons and manages that only one of these +effects can be activated. + + +All effects which are not supported by the currently used compositing backend +are hidden by default (⪚ OpenGL effects when using XRender). + + +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. + + + + +
diff --git a/doc/kwineffects/video.png b/doc/kwineffects/video.png new file mode 100644 index 0000000000..ac8e8c0349 Binary files /dev/null and b/doc/kwineffects/video.png differ