[kde-doc-english] [plasma-desktop] /: Add a basic doc file for the Baloo KCM

[Vishesh Handa]

Git commit 76b5e7c31678856750a1704f26c6f63a1af6a901 by Vishesh Handa.
Committed on 17/10/2014 at 14:21.
Pushed by vhanda into branch 'master'.

Add a basic doc file for the Baloo KCM

BUG: 332030

M  +1    -0    doc/kcontrol/CMakeLists.txt
A  +3    -0    doc/kcontrol/baloo/CMakeLists.txt
A  +51   -0    doc/kcontrol/baloo/index.docbook
M  +2    -0    kcms/baloo/kcm_baloofile.desktop

http://commits.kde.org/plasma-desktop/76b5e7c31678856750a1704f26c6f63a1af6a901

diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt
index b7e136c..d053f56 100644
--- a/doc/kcontrol/CMakeLists.txt
+++ b/doc/kcontrol/CMakeLists.txt
@@ -17,6 +17,7 @@ add_subdirectory(khtml-java-js)
 add_subdirectory(khtml-behavior)
 add_subdirectory(khtml-adblock)
 add_subdirectory(emoticons)
+add_subdirectory(baloo)
 
 if ( Q_WS_X11 )
     add_subdirectory(autostart)
diff --git a/doc/kcontrol/baloo/CMakeLists.txt b/doc/kcontrol/baloo/CMakeLists.txt
new file mode 100644
index 0000000..cb87a71
--- /dev/null
+++ b/doc/kcontrol/baloo/CMakeLists.txt
@@ -0,0 +1,3 @@
+kdoctools_create_handbook(index.docbook
+                          INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en
+                          SUBDIR kcontrol/baloo)
diff --git a/doc/kcontrol/baloo/index.docbook b/doc/kcontrol/baloo/index.docbook
new file mode 100644
index 0000000..ef6169a
--- /dev/null
+++ b/doc/kcontrol/baloo/index.docbook
@@ -0,0 +1,51 @@
+<?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">
+]>
+<article id="baloo" lang="&language;">
+<title>File Search Settings</title>
+<articleinfo>
+<authorgroup>
+<author>
+    <firstname>Vishesh</firstname>
+    <surname>Handa</surname>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2014-10-17</date>
+<releaseinfo>&kde; 5.2</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>Systemsettings</keyword>
+<keyword>search</keyword>
+<keyword>file</keyword>
+<keyword>baloo</keyword>
+</keywordset>
+</articleinfo>
+
+<para>
+This &systemsettings; module allows you to configure which files should be
+indexed for fast searching.
+</para>
+
+<variablelist>
+<varlistentry><term><guilabel>Exclude Folders</guilabel></term>
+<listitem>
+    <para>
+        You are presented with a list of folders which should not be searched. By default
+        your entire $HOME directory is indexed, and no other drives are indexed.
+    </para>
+    <para>
+        Removable media is never indexed by default. It can be explictly removed from
+        the list of exclude folders and it will then be indexed.
+    </para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+
+</article>
diff --git a/kcms/baloo/kcm_baloofile.desktop b/kcms/baloo/kcm_baloofile.desktop
index 91e171a..a62ed23 100644
--- a/kcms/baloo/kcm_baloofile.desktop
+++ b/kcms/baloo/kcm_baloofile.desktop
@@ -10,6 +10,8 @@ X-KDE-ParentApp=kcontrol
 X-KDE-System-Settings-Parent-Category=search
 X-KDE-Weight=20
 
+X-DocPath=kcontrol/baloo/index.html
+
 Name=File Search
 Name[ca]=Cerca de fitxers
 Name[de]=Dateisuche