From 7dbad7bade7a4387dbc8e8787ccf11947992bb4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Burkhard=20L=C3=BCck?= Date: Fri, 13 May 2016 08:11:17 +0200 Subject: [PATCH] Add docbook for kwineffects kcm REVIEW:124341 --- doc/CMakeLists.txt | 1 + doc/kwineffects/CMakeLists.txt | 2 + doc/kwineffects/configure-effects.png | Bin 0 -> 483 bytes doc/kwineffects/configure-filter.png | Bin 0 -> 402 bytes doc/kwineffects/dialog-information.png | Bin 0 -> 619 bytes doc/kwineffects/index.docbook | 86 +++++++++++++++++++++++++ doc/kwineffects/video.png | Bin 0 -> 400 bytes 7 files changed, 89 insertions(+) create mode 100644 doc/kwineffects/CMakeLists.txt create mode 100644 doc/kwineffects/configure-effects.png create mode 100644 doc/kwineffects/configure-filter.png create mode 100644 doc/kwineffects/dialog-information.png create mode 100644 doc/kwineffects/index.docbook create mode 100644 doc/kwineffects/video.png 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 0000000000000000000000000000000000000000..4b13fb6e2a1f45622f1eff96affb3c35198e08a8 GIT binary patch literal 483 zcmV<90UZ8`P)UTnz$I$kRZg+SS^z+ZqErq5tBYaTNBQ9Z_c~@ za!=k%1=n@i_028b9S1>(Qi9Em41|lz2GdtGsEQH@i1qS{=Uxwz<2q1MDKN$Y0a4Tx z9$PJlfqZ?6LIWZJ2rQOyg=Qn60a-*dDT&8?d~^uYG<|tBO~cOa9v_I`XiU>Yx7+nS zoG0@C8O>56frDxlwr!7ks=ADLJod$F7zRIx-xZ32h<5u4r^d;sw_mBC)9HA8`TQ0{ zLF9^tYa`z&olbjdN-6h@xqu86iAc!haz8pd7m#5zu~>XI5dT>+V8Y87P$+CemSsev z(Xm!~E=z5W!NW70`B+1<&`|Lx4~h}C+drqdZ; zQG`ybR3ta8CgsUwMzeKI-L|y?tUlK)mLHU&IKr;gP)cbXcD+U%$CR{QJHw0vlmV1d z#sG|Gz&Jor0^oIh_Op#;$6d+e$2S$Ft!1YLyB;8Mvgn{cZ z@&nWX4fuTn=b8|LeyYf6{lbgJ7B>oNNf-)st^*Wh(HQSu@fA79*Z=h#E}@M zk?aLOX*QmDH9;#M-Zd|*Hdj8_2T)23S)n+pnkj|H{eA?f~ z3&MbAqk)Lz0@7S<@NRDpoy*&2s4yTNkXu@gt1ylf2Ba{l@mv?S4-M@@m1*-hqNxu2Q@7)ff}TC38mEJHYeApCpYtvrAXr)KO(`uW+iV#z8b)`&zXYrvHM z#5kTv_v%ZIzH&-YlwcDD)}YYHFh+SAv>C@ZDnpHc#OaNH#X@W~Sg=e004s=f=E&fP zo$biu-61~$i&zC>P@=&qK*ljyKwR?J@5dy)2moaaYH3^tpQ92ojIc?9(w5`(-|uTg z+T7k+5+lWaswDAz;p?XRUB^ zWx)0wL&+?rY0l-y`soqdcMWB8awjIr*2Ru=ea$QkV4}j@M+$R8D-6j0)J&@|AfE46 z=yto*>-Ag!z8xIk`xR8D(~&oCcNq+Zxq$eU3hP%c^Bb{~C2L0*VUYj;002ovPDHLk FV1g?=6T<)i literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..ac8e8c0349b7f4f82c6e73a10da45aabc22dd048 GIT binary patch literal 400 zcmV;B0dM|^P)1R9J=WmceSmKomu9Bos2y7D6Jl zrb3GpKgFM^mVQWW^=GsdNPAV zPn^XQSL$fCSwpEydaM9&blbrC?hy;S^{GsyD%W+$GwQb)7RW_xR2{j*K6lO$LB=KmuRNduBc6PGj~Dq|Wv&x2tYLIA#J uGccw>ab1_cy?