[kde-doc-english] [plasma-workspace] /: Add screenlocker docbook

[Burkhard Lück]

Git commit d9adb0b3fccf4e2c367619a13923b0cea08625e8 by Burkhard Lück.
Committed on 06/07/2015 at 10:41.
Pushed by lueck into branch 'master'.

Add screenlocker docbook
REVIEW:124250

M  +1    -0    doc/CMakeLists.txt
A  +1    -0    doc/kcontrol/CMakeLists.txt
A  +2    -0    doc/kcontrol/screenlocker/CMakeLists.txt
A  +53   -0    doc/kcontrol/screenlocker/index.docbook
M  +1    -0    ksmserver/screenlocker/kcm/screenlocker.desktop

http://commits.kde.org/plasma-workspace/d9adb0b3fccf4e2c367619a13923b0cea08625e8

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 0eb36a6..b4b353e 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,4 +1,5 @@
 ecm_optional_add_subdirectory(klipper)
+ecm_optional_add_subdirectory(kcontrol)
 if(POLKITQT_FOUND)
   ecm_optional_add_subdirectory(PolicyKit-kde)
 endif()
diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt
new file mode 100644
index 0000000..732ccd2
--- /dev/null
+++ b/doc/kcontrol/CMakeLists.txt
@@ -0,0 +1 @@
+ecm_optional_add_subdirectory(screenlocker)
diff --git a/doc/kcontrol/screenlocker/CMakeLists.txt b/doc/kcontrol/screenlocker/CMakeLists.txt
new file mode 100644
index 0000000..bead228
--- /dev/null
+++ b/doc/kcontrol/screenlocker/CMakeLists.txt
@@ -0,0 +1,2 @@
+########### install files ###############
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/screenlocker)
diff --git a/doc/kcontrol/screenlocker/index.docbook b/doc/kcontrol/screenlocker/index.docbook
new file mode 100644
index 0000000..2949e51
--- /dev/null
+++ b/doc/kcontrol/screenlocker/index.docbook
@@ -0,0 +1,53 @@
+<?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="screenlocker" lang="&language;">
+<articleinfo>
+<title>Screen Locking</title>
+<authorgroup>
+<author>&Mike.McBride; &Mike.McBride.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2015-05-20</date>
+<releaseinfo>Plasma 5.3</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>systemsettings</keyword>
+<keyword>screenlocker</keyword>
+<keyword>screen locker</keyword>
+</keywordset>
+</articleinfo>
+<!--https://bugs.kde.org/show_bug.cgi?id=317156 does this effect screenlock in kf5?-->
+<para>Using this module, you can determine
+how much time must pass before the screen locker is activated, and add
+or remove password protection to your screen locker.</para>
+
+<para>At the top is a check box to have the screen locker <guilabel>Lock screen automatically after</guilabel>, 
+and a spin box which determines the period of inactivity before the screen locker should be started. 
+You can enter any positive number of minutes in this box.</para>
+
+<para>Below that is a spinbox labeled <guilabel>Require password 
+after locking</guilabel>.  If it is checked, when you click a key
+or click a mouse button to end the screen locker after the time in the spinbox and return to your
+work, you must enter a password.  The password used is the same
+password you used to login to your machine. <!--FIXME --></para>
+
+<para>Locking the screen manually causes the password protection to engage immediately.</para>
+
+<para>The default shortcut <keycombo action="simul">&Ctrl;&Alt;<keycap>L</keycap></keycombo> provides a quick 
+way to lock the screen manually.</para>
+
+<para>Check <guilabel>Lock screen on resume</guilabel> if you want a password protected system
+when waking up from suspension.</para>
+
+<para>If you would like to change the background in locked status click on the image button right 
+to <guilabel>Custom Background</guilabel> to opel a menu with actions to load an image from 
+file or clear the currently used image.</para>
+
+</article>
diff --git a/ksmserver/screenlocker/kcm/screenlocker.desktop b/ksmserver/screenlocker/kcm/screenlocker.desktop
index 19caa3b..87d41a0 100644
--- a/ksmserver/screenlocker/kcm/screenlocker.desktop
+++ b/ksmserver/screenlocker/kcm/screenlocker.desktop
@@ -5,6 +5,7 @@ Icon=preferences-system
 Exec=kcmshell5 screenlocker
 X-KDE-Library=screenlocker_kcm
 X-KDE-ParentApp=kcontrol
+X-DocPath=kcontrol/screenlocker/index.html
 
 X-KDE-System-Settings-Parent-Category=desktopbehavior
 X-KDE-Weight=60