Add new kcontrol joystick help handbook.

4 files changed, 212 insertions, 62 deletions

diff --git a/doc/kcontrol/joystick/CMakeLists.txt b/doc/kcontrol/joystick/CMakeLists.txt
new file mode 100644
index 000000000..cd9842628
--- /dev/null
+++ b/doc/kcontrol/joystick/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+#  Improvements and feedback are welcome
+#
+#  This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION kcontrol/joystick )
diff --git a/doc/kcontrol/joystick/Makefile.am b/doc/kcontrol/joystick/Makefile.am
new file mode 100644
index 000000000..416915575
--- /dev/null
+++ b/doc/kcontrol/joystick/Makefile.am
@@ -0,0 +1,3 @@
+KDE_LANG = en
+KDE_DOCS = AUTO
+
diff --git a/doc/kcontrol/joystick/index.docbook b/doc/kcontrol/joystick/index.docbook
new file mode 100644
index 000000000..a1314d01b
--- /dev/null
+++ b/doc/kcontrol/joystick/index.docbook
@@ -0,0 +1,137 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE">
+]>
+
+<article lang="&language;">
+<title>Joystick</title>
+
+<articleinfo>
+
+<authorgroup>
+<author>
+<firstname>Michael</firstname>
+<surname>Anderson</surname>
+</author>
+<author>&tde-authors;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<releaseinfo>&tde-release-version;</releaseinfo>
+<date>Reviewed: &tde-release-date;</date>
+
+<copyright>
+<year>2008</year>
+<holder>Michael Anderson</holder>
+</copyright>
+<copyright>
+<year>&tde-copyright-date;</year>
+<holder>&tde-team;</holder>
+</copyright>
+
+<keywordset>
+<keyword>TDE</keyword>
+<keyword>System Settings</keyword>
+<keyword>joystick</keyword>
+<keyword>calibrate</keyword>
+</keywordset>
+
+</articleinfo>
+
+<sect1 id="kcm_joystick">
+<title>Joystick Configuration</title>
+
+<para>This module provides an interface to calibrate your joystick device as well as
+viewing which functions on your joystick are mapped to which logical button or
+axis.</para>
+
+<para>
+<screenshot>
+<screeninfo>Here's a screenshot of the joystick module</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="joystick-main.png" format="PNG"/>
+    </imageobject>
+    <textobject>
+      <phrase>The joystick module</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+</para>
+
+<variablelist>
+<varlistentry><term><guilabel>Device</guilabel></term>
+<listitem>
+<para>
+Here you can see the logical location of the device. When you have more
+than one joystick device, you can also select which device to configure.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry><term><guilabel>Position</guilabel></term>
+<listitem>
+<para>
+The plotted location of the X and Y axes of the joystick. Enable <guibutton>Show trace</guibutton>
+to plot the path of the joystick from one point to another.
+</para>
+<tip><para>
+When the joystick cannot reach every point on this graph, or does not center correctly, you need to calibrate your device.
+</para></tip> 
+</listitem>
+</varlistentry>
+
+<varlistentry><term><guilabel>Buttons</guilabel></term>
+<listitem>
+<para>
+A place to observe the pressed state of buttons on your joystick and when the buttons
+are mapped correctly. When a joystick button is pressed, <guilabel>PRESSED</guilabel> will appear
+next to the logical number (as the computer sees it) of the button which was
+pressed.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry><term><guilabel>Axes</guilabel></term>
+<listitem>
+<para>
+This displays the numerical values of the axis positions. 0 is centered and the
+maximum and minimum values depend on the joystick and the particular axis.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry><term><guilabel>Calibrate</guilabel></term>
+<listitem>
+<para>
+Clicking on <guibutton>Calibrate</guibutton> will open a dialog to calibrate every axis on your joystick. 
+</para>
+
+<para>
+<screenshot>
+<screeninfo>Calibrating your joystick</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="joystick-calibration.png" format="PNG"/>
+    </imageobject>
+    <textobject>
+      <phrase>Calibrating your joystick</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+</para>
+
+<para>
+Each axis will have to be moved to the minimum position, then the center, and finally the
+maximum position. A meter in the bottom left corner of the dialog will help
+determine which way increases and which way decreases the values.
+</para>
+
+</listitem>
+</varlistentry>
+</variablelist>
+
+</sect1>
+
+</article>
diff --git a/kcontrol/joystick/joystick.desktop b/kcontrol/joystick/joystick.desktop
index 243393457..d33cbeb1c 100644
--- a/kcontrol/joystick/joystick.desktop
+++ b/kcontrol/joystick/joystick.desktop
@@ -1,4 +1,67 @@
 [Desktop Entry]
+Exec=tdecmshell joystick
+Terminal=false
+Type=Application
+X-TDE-FactoryName=kcm_joystick
+X-TDE-Library=joystick
+X-TDE-Test-Module=true
+Icon=joystick
+DocPath=kcontrol/joystick/index.html
+Categories=Qt;TDE;X-TDE-settings-hardware;
+Name=Joystick
+Name[be]=Джойстык
+Name[bg]=Джойстик
+Name[bn]=জয়-স্টিক
+Name[br]=Lanker-c'hoari
+Name[ca]=Palanca de control
+Name[cy]=Ffôn reoli
+Name[el]=Χειριστήριο
+Name[eo]=Stirstango
+Name[et]=Juhtpult
+Name[fa]=اهرم کنترل
+Name[fi]=Peliohjain
+Name[ga]=Luamhán Stiúrtha
+Name[he]=ג'ויסטיק
+Name[hi]=जॉयस्टिक
+Name[hr]=Igraća palica
+Name[hu]=Botkormány
+Name[is]=Stýripinnar
+Name[ja]=ジョイスティック
+Name[ka]=ჯოისტიკი
+Name[kk]=Джойстик
+Name[km]=យ៉យស្ទីក
+Name[ko]=조이스틱
+Name[lo]=จอยสติ๊ก
+Name[lt]=Valdymo svirtis
+Name[lv]=Kursorsvira
+Name[ms]=Kayu Bidik
+Name[nb]=Styrepinne
+Name[ne]=जोयस्टिक
+Name[nn]=Styrespak
+Name[oc]=Palanca de jogs
+Name[pa]=ਜਾਏਸਟਿੱਕ
+Name[ru]=Джойстик
+Name[rw]=Agakoreshamukino
+Name[se]=Stivrensággi
+Name[sl]=Igralna palica
+Name[sr]=Џојстик
+Name[sr@Latn]=Džojstik
+Name[sv]=Styrspak
+Name[ta]=இயக்கு கருவி
+Name[te]=జాయ్ స్టిక్
+Name[th]=จอยสติก
+Name[tr]=Oyun Çubuğu
+Name[tt]=Joystik
+Name[uk]=Джойстик
+Name[uz]=Joystik
+Name[uz@cyrillic]=Жойстик
+Name[ven]=Thambo dzau tumanya na tshishumiswa
+Name[vi]=Cần điều khiển
+Name[wa]=Djîsse di djeu
+Name[xh]=Uvuyo
+Name[zh_CN]=游戏杆
+Name[zh_TW]=玩具
+Name[zu]=Induku yenjabulo
 Comment=Joystick - a kcontrol module to test Joysticks
 Comment[af]=Joystick - 'n beheer module om Joysticks mee te toets
 Comment[be]=Модуль настаўлення джойстыка
@@ -66,7 +129,6 @@ Comment[vi]=cần điều khiển - một mô đun điều khiển TDE đêr ki�
 Comment[wa]=djîsse di djeu - on module di kcontrol po sayî les djîsses di djeu
 Comment[zh_CN]=Joystick - 测试游戏杆的 kcontrol 模块
 Comment[zh_TW]=搖桿 - 用來測試搖桿的 kcontrol 模組
-Exec=tdecmshell joystick
 Keywords=joystick,gamepad
 Keywords[be]=Джойстык,joystick,gamepad
 Keywords[bg]=джойстик, игра, игри, управление, joystick, gamepad
@@ -114,64 +176,3 @@ Keywords[vi]=cần điều khiển,bàn điều khiển trò chơi
 Keywords[wa]=joystick,gamepad,djîsse,djîsse di djeu
 Keywords[zh_CN]=joystick,gamepad,游戏杆,手柄
 Keywords[zh_TW]=joystick,gamepad,搖桿,遊戲台
-Name=Joystick
-Name[be]=Джойстык
-Name[bg]=Джойстик
-Name[bn]=জয়-স্টিক
-Name[br]=Lanker-c'hoari
-Name[ca]=Palanca de control
-Name[cy]=Ffôn reoli
-Name[el]=Χειριστήριο
-Name[eo]=Stirstango
-Name[et]=Juhtpult
-Name[fa]=اهرم کنترل
-Name[fi]=Peliohjain
-Name[ga]=Luamhán Stiúrtha
-Name[he]=ג'ויסטיק
-Name[hi]=जॉयस्टिक
-Name[hr]=Igraća palica
-Name[hu]=Botkormány
-Name[is]=Stýripinnar
-Name[ja]=ジョイスティック
-Name[ka]=ჯოისტიკი
-Name[kk]=Джойстик
-Name[km]=យ៉យស្ទីក
-Name[ko]=조이스틱
-Name[lo]=จอยสติ๊ก
-Name[lt]=Valdymo svirtis
-Name[lv]=Kursorsvira
-Name[ms]=Kayu Bidik
-Name[nb]=Styrepinne
-Name[ne]=जोयस्टिक
-Name[nn]=Styrespak
-Name[oc]=Palanca de jogs
-Name[pa]=ਜਾਏਸਟਿੱਕ
-Name[ru]=Джойстик
-Name[rw]=Agakoreshamukino
-Name[se]=Stivrensággi
-Name[sl]=Igralna palica
-Name[sr]=Џојстик
-Name[sr@Latn]=Džojstik
-Name[sv]=Styrspak
-Name[ta]=இயக்கு கருவி
-Name[te]=జాయ్ స్టిక్
-Name[th]=จอยสติก
-Name[tr]=Oyun Çubuğu
-Name[tt]=Joystik
-Name[uk]=Джойстик
-Name[uz]=Joystik
-Name[uz@cyrillic]=Жойстик
-Name[ven]=Thambo dzau tumanya na tshishumiswa
-Name[vi]=Cần điều khiển
-Name[wa]=Djîsse di djeu
-Name[xh]=Uvuyo
-Name[zh_CN]=游戏杆
-Name[zh_TW]=玩具
-Name[zu]=Induku yenjabulo
-Terminal=false
-Type=Application
-X-TDE-FactoryName=kcm_joystick
-X-TDE-Library=joystick
-X-TDE-Test-Module=true
-Icon=joystick
-Categories=Qt;TDE;X-TDE-settings-hardware;