workspace/doc/kcontrol/joystick/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4   <!ENTITY % addindex "IGNORE">
   5   <!ENTITY % English "INCLUDE">
   6 ]>
   7 <article>
   8 <articleinfo>
   9 <authorgroup>
  10 <author>
  11 <firstname>Michael</firstname>
  12 <surname>Anderson</surname>
  13 <affiliation>
  14 <address><email>nosrednaekim@gmail.com</email></address>
  15 </affiliation>
  16 </author>
  17 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  18 </authorgroup>
  19
  20 <date>2008-05-23</date>
  21 <releaseinfo>1.0</releaseinfo>
  22
  23 <keywordset>
  24 <keyword>KDE</keyword>
  25 <keyword>System Settings</keyword>
  26 <keyword>joystick</keyword>
  27 <keyword>calibrate</keyword>
  28 </keywordset>
  29 </articleinfo>
  30
  31 <sect1 id="kcm_joystick">
  32 <title><guilabel>Joystick configuration module</guilabel></title>
  33
  34 <para>This module provides an interface to calibrate your joystick device as well as
  35 see which functions on your joystick are mapped to which logical button or
  36 axis.</para>
  37
  38 <para>
  39 <screenshot>
  40 <screeninfo>Here's a screenshot of the joystick module</screeninfo>
  41   <mediaobject>
  42     <imageobject>
  43       <imagedata fileref="joystick-main.png" format="PNG"/>
  44     </imageobject>
  45     <textobject>
  46       <phrase>The joystick module</phrase>
  47     </textobject>
  48   </mediaobject>
  49 </screenshot>
  50 </para>
  51
  52 <variablelist>
  53 <varlistentry><term><guilabel>Device</guilabel></term>
  54 <listitem>
  55 <para>
  56 Here you can see the logical location of the device. If you have more
  57 than one joystick device, you can also select which one to configure.
  58 </para>
  59 </listitem>
  60 </varlistentry>
  61
  62 <varlistentry><term><guilabel>Position</guilabel></term>
  63 <listitem>
  64 <para>
  65 The plotted location of the X and Y axes of the joystick. Enable <guibutton>Show trace</guibutton>
  66 to plot the path of the joystick from one point to another.
  67 </para>
  68 <tip><para>
  69 If the joystick cannot reach every point on this graph, or if it does not center correctly, you need to calibrate your device.
  70 </para></tip>
  71 </listitem>
  72 </varlistentry>
  73
  74 <varlistentry><term><guilabel>Buttons</guilabel></term>
  75 <listitem>
  76 <para>
  77 A place to see the pressed state of buttons on your joystick and if the buttons
  78 are mapped correctly. When a joystick button is pressed, <guilabel>PRESSED</guilabel> will appear
  79 next to the logical number (as the computer sees it) of the button which was
  80 pressed.
  81 </para>
  82 </listitem>
  83 </varlistentry>
  84
  85 <varlistentry><term><guilabel>Axes</guilabel></term>
  86 <listitem>
  87 <para>
  88 This displays the numerical values of the axis positions. 0 is centered and the
  89 maximum and minimum values depend on the joystick and the particular axis.
  90 </para>
  91 </listitem>
  92 </varlistentry>
  93
  94 <varlistentry><term><guilabel>Calibrate</guilabel></term>
  95 <listitem>
  96 <para>
  97 Clicking on <guibutton>Calibrate</guibutton> will open a dialog to calibrate every axis on your joystick.
  98 </para>
  99
 100 <para>
 101 <screenshot>
 102 <screeninfo>Calibrating your joystick</screeninfo>
 103   <mediaobject>
 104     <imageobject>
 105       <imagedata fileref="joystick-calibration.png" format="PNG"/>
 106     </imageobject>
 107     <textobject>
 108       <phrase>Calibrating your joystick</phrase>
 109     </textobject>
 110   </mediaobject>
 111 </screenshot>
 112 </para>
 113
 114 <para>
 115 Each axis will have to be moved to the minimum position, then the center, and finally the
 116 maximum position. A meter in the bottom left corner of the dialog will help
 117 determine which way increases and which way decreases the values.
 118 </para>
 119 </listitem>
 120 </varlistentry>
 121 </variablelist>
 122 </sect1>
 123 </article>
 124
 125 <!--
 126 Local Variables:
 127 mode: xml
 128 sgml-minimize-attributes:nil
 129 sgml-general-insert-case:lower
 130 sgml-indent-step:0
 131 sgml-indent-data:nil
 132 End:
 133
 134 vim:tabstop=2:shiftwidth=2:expandtab
 135 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
 136 -->