diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/kcontrol/joystick/CMakeLists.txt | 9 | ||||
-rw-r--r-- | doc/kcontrol/joystick/Makefile.am | 3 | ||||
-rw-r--r-- | doc/kcontrol/joystick/index.docbook | 137 |
3 files changed, 149 insertions, 0 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> |