[kde-doc-english] [wacomtablet] doc/user: update the docbook for 2.0
Jörg Ehrichs
Joerg.Ehrichs at gmx.de
Sat Mar 16 19:27:50 UTC 2013
Git commit 0b0149c2592c6905eba4c705d1bb523c5522a002 by Jörg Ehrichs.
Committed on 16/03/2013 at 20:27.
Pushed by jehrichs into branch 'master'.
update the docbook for 2.0
M +305 -288 doc/user/index.docbook
A +- -- doc/user/presscurve.png
A +- -- doc/user/tabletarea.png
http://commits.kde.org/wacomtablet/0b0149c2592c6905eba4c705d1bb523c5522a002
diff --git a/doc/user/index.docbook b/doc/user/index.docbook
index 061cf6a..033cb6f 100644
--- a/doc/user/index.docbook
+++ b/doc/user/index.docbook
@@ -3,7 +3,7 @@
<!ENTITY tablet "<application>KCM Tablet</application>">
<!ENTITY kappname "&tablet;">
<!ENTITY package "kcontrol">
- <!ENTITY kappversion "1.2"><!--Application version. Use this variable everywhere it's needed.-->
+ <!ENTITY kappversion "2.0"><!--Application version. Use this variable everywhere it's needed.-->
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
@@ -12,34 +12,34 @@
<title>The &tablet; Handbook</title>
<authorgroup>
- <author>
- <firstname>Jörg</firstname>
- <surname>Ehrichs</surname>
- <affiliation>
- <address><email>joerg.ehrichs at gmx.de</email></address>
- </affiliation>
- </author>
- <!-- TRANS:ROLES_OF_TRANSLATORS -->
+ <author>
+ <firstname>Jörg</firstname>
+ <surname>Ehrichs</surname>
+ <affiliation>
+ <address><email>joerg.ehrichs at gmx.de</email></address>
+ </affiliation>
+ </author>
+ <!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
- <year>2009</year>
- <holder>Jörg Ehrichs</holder>
+ <year>2013</year>
+ <holder>Jörg Ehrichs</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
- <date>2010-02-28</date><!-- Date of (re)writing, or update.-->
+ <date>2013-03-16</date><!-- Date of (re)writing, or update.-->
<releaseinfo>&kappversion;</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
<abstract>
- <para>This is the documentation for the &kde; &systemsettings; module that configures graphic tablets.</para>
+ <para>This is the documentation for the &kde; &systemsettings; module that configures graphic tablets.</para>
</abstract>
<keywordset>
- <keyword>KDE</keyword><!-- do not change this! -->
- <keyword>System Settings</keyword>
- <keyword>Wacom</keyword>
- <keyword>Tablet</keyword>
+ <keyword>KDE</keyword><!-- do not change this! -->
+ <keyword>System Settings</keyword>
+ <keyword>Wacom</keyword>
+ <keyword>Tablet</keyword>
</keywordset>
</bookinfo>
@@ -47,296 +47,313 @@
<chapter id="introduction">
<title>Wacom Tablet Settings</title>
<para>
- The tablet &systemsettings; module handles all setting for your graphic tablet. All tablets supported by
- the <ulink url="http://linuxwacom.sourceforge.net">&Linux; Wacom driver</ulink> project are handled by this settings interface.
- Make sure your tablet is detected either via xorg.conf or HAL and works in general. Refer to the <link linkend="detection">tablet detection</link> section for more information.
+ The tablet &systemsettings; module handles all setting for your graphic tablet. All tablets supported by
+ the <ulink url="http://linuxwacom.sourceforge.net">&Linux; Wacom driver</ulink> project are handled by this settings interface.
+ Make sure your tablet is detected either via xorg.conf or HAL and works in general. Refer to the <link linkend="detection">tablet detection</link> section for more information.
</para>
<important>
- <para>
- The <application>wacom-tools</application> or the <application>xf86-input-wacom</application> driver must be installed on your computer and <command>xsetwacom</command> must be available
- in order to make this module work correctly.
- </para>
+ <para>
+ The <application>wacom-tools</application> or the <application>xf86-input-wacom</application> driver must be installed on your computer and <command>xsetwacom</command> must be available in order to make this module work correctly.
+ </para>
</important>
<para>
- The module is split into various tab pages that handle all aspects of your tablet and the pen:
- <link linkend="tablet-profiles">Profiles</link>,
- <link linkend="tablet-general">General Information</link>,
- <link linkend="pad-buttons">Pad Buttons</link>,
- <link linkend="pad-mapping">Pad Mapping</link>,
- <link linkend="screen-setup">Screen Setup</link>,
- <link linkend="stylus">Stylus Settings</link> and
- <link linkend="eraser">Eraser Settings</link>.
+ The module is split into various tab pages that handle all aspects of your tablet and the pen:
+ <link linkend="tablet-profiles">Profiles</link>,
+ <link linkend="tablet-general">General Information</link>,
+ <link linkend="stylus">Stylus Settings</link>,
+ <link linkend="pad-buttons">Express Buttons</link>,
+ <link linkend="pad-mapping">Pad Mapping</link> and
+ <link linkend="touch-mapping">Touch Mapping</link>.
</para>
<sect1 id="tablet-profiles">
- <title>Profile Management</title>
-
- <para>
- This is the small drop down box with the two buttons next to it. You can create new profiles and delete already existing ones.
- Each profile is saved and specified for the currently connected tablet. If you create a new profile, it automatically creates one
- with the default settings as returned by the wacom-tools.
- </para>
-
- <para>
- Here you can specify different profiles for your settings.
- For example if you like to have a different behavior of the pen when you use it
- as a mouse replacement for your day to day work or using it as pen to draw something.
- </para>
- <para>
- Each profile can be changed on the fly and directly changes the behavior of your tablet input.
- </para>
- <note>
- <para>
- The <link linkend="kded">kded tablet daemon</link> must be running in the background to be able to change the profiles and apply them to the tablet.
- All the work is done by the daemon. The &systemsettings; module just change the profile settings for it.
- </para>
- </note>
+ <title>Profile Management</title>
+
+ <para>
+ This is the small drop down box with the two buttons next to it. You can create new profiles and delete already existing ones.
+ Each profile is saved and specified for the currently connected tablet. If you create a new profile, it automatically creates one
+ with the default settings as returned by the wacom-tools.
+ </para>
+
+ <para>
+ Here you can specify different profiles for your settings.
+ For example if you like to have a different behavior of the pen when you use it
+ as a mouse replacement for your day to day work or using it as pen to draw something.
+ </para>
+ <para>
+ Each profile can be changed on the fly and directly changes the behavior of your tablet input.
+ </para>
+ <note>
+ <para>
+ The <link linkend="kded">kded tablet daemon</link> must be running in the background to be able to change the profiles and apply them to the tablet.
+ All the work is done by the daemon. The &systemsettings; module just change the profile settings for it.
+ </para>
+ </note>
</sect1>
-
+
<sect1 id="tablet-general">
- <title>General Tablet Settings and Information</title>
-
- <para>
- Shows some general Information about the detected tablet.
- Beside the name and company of your tablet an image is shown and all detected input devices are listed.
- </para>
-
- <note>
- <para>
- The tablet must be connected and the <link linkend="kded">kded</link> must be running to allow the module to work correctly.
- </para>
- <para>
+ <title>General Tablet Settings and Information</title>
+
+ <para>
+ Shows some general Information about the detected tablet.
+ Beside the name and company of your tablet an image is shown and all detected input devices are listed.
+ </para>
+
+ <note>
+ <para>
+ The tablet must be connected and the <link linkend="kded">kded</link> must be running to allow the module to work correctly.
+ </para>
+ <para>
See the <link linkend="troubles">Detection problems</link> section for further help on the tablet detection.
- </para>
- </note>
- </sect1>
-
- <sect1 id="pad-buttons">
- <title>Pad Button Settings</title>
-
- <para>
- Here you can set different actions for each pad button, the touch ring or touch strip on your tablet if available.
- </para>
- <para>
- Available actions are:
- <itemizedlist>
- <listitem>
- <para><guilabel>Disable</guilabel> :
- disables the button.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Button</guilabel> :
- emulates a general button event press.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Keystroke</guilabel> :
- emulates a keystroke or special key press (for example <keycap>F1</keycap> or <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>).
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>QuoteDbl</guilabel> :
- emulates a text string. For example you could print <quote>Hello World</quote> at the current cursor position.
- </para>
- </listitem>
- </itemizedlist>
- </para>
+ </para>
+ </note>
+
+ <para>
+ In addition to the tablet information the general tab allows to set various global shortcuts. Each shortcut allows to dynamically
+ change the options for the current connected tablet.
+ </para>
+
</sect1>
- <sect1 id="pad-mapping">
- <title>Pad Mapping Settings</title>
+ <sect1 id="stylus">
+ <title>Stylus Settings</title>
<para>
- This pages change the behavior of the tablet working area. It can be rotated and reduced in size.
+ The pen that is used together with the tablet has two different sides, the main side is called stylus the other end is the eraser.
+ In this tab you can change any aspect of the pen from the button assignement to the pressure curve and threshold.
</para>
+
+ <sect2 id="eraser-settings">
+ <title>Eraser Feel</title>
+ <para>
+ The slider allows to alter the threshold of the eraser. For a more fine grained setting of the pressure it is possible
+ to alter the complete pressure curve in the <guilabel>Edit Pressure Curve</guilabel> dialog.
+ See <link linkend="presscurve">Presscurve Dialog</link> for more information.
+ </para>
+ </sect2>
+
+ <sect2 id="pen-button-settings">
+ <title>Button Settings</title>
+ <para>
+ The <guilabel>Button Settings</guilabel> box allows to alter the executed action assigned to each button of the pen.
+ A simple click into the edit box opens a new dialog where different key combinations, modifier keys and mouse buttons can be selected.
+ </para>
+
+ <para>
+ If <guilabel>Tap to execute action</guilabel> is enabled the stylus must be in contact with the tablet in order to allow the button action
+ to be executed. If this option is disabled each the butto naction work also when the stylus is hovering above the tablet.
+ </para>
+ </sect2>
+
+ <sect2 id="tip-settings">
+ <title>Tip Feel</title>
+ <para>
+ The slider allows to alter the threshold of the stylus tip. For a more fine grained setting of the pressure it is possible
+ to alter the complete pressure curve in the <guilabel>Edit Pressure Curve</guilabel> dialog.
+ See <link linkend="presscurve">Presscurve Dialog</link> for more information.
+ </para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="pad-buttons">
+ <title>Express Buttons</title>
+
<para>
- The <guilabel>Working area</guilabel> spans the whole tablet by default. The <guilabel>Top X/Y</guilabel> and <guilabel>Bottom X/Y</guilabel> coordinates can be changed to change the aspect ratio of the tablet and thus match
- the screen ratio.
+ The <guilabel>Express Buttons</guilabel> tab allow to set specific button actions for all hardware buttons for the tablet.
+ To change the used action, you need to click into the editbox and choose the action in the new dialog.
</para>
</sect1>
-
- <sect1 id="screen-setup">
- <title>Screen Setup</title>
-
- <para>
- This will setup your tablet to match your screens. The multi monitor setup is realized via Nvidia TwinView support.
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para><guilabel>TwinView</guilabel> :
- Nvidia TwinView option. Select how to connect your multi monitor setup.
- You need to specify the right screen resolutions as well, otherwise it won't work as you expect.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Resolution</guilabel> :
- Specifies the Meta Mode for the monitors.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Multi Monitor</guilabel> :
- Turns on/off across monitor movement in multi-monitor desktop.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Map to screen</guilabel> :
- Maps the cursor to a specific monitor if across monitor movement is switched off.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <note><para>
- The button actions screen toggle and display toggle change the multi monitor behavior on the fly. See the <link linkend="stylus">stylus</link> section for more information.
- </para></note>
+
+
+ <sect1 id="pad-mapping">
+ <title>Tablet</title>
+
+ <para>
+ The <guilabel>Tablet</guilabel> tab allows to set further properties of the tablet area when used together with a pen.
+ In here the orientation of the tablet area, valid space of the used tablet and the cursor tracking mode can be specified.
+ </para>
+ <sect2 id="tablet-tracking">
+ <title>Stylus Tracking Mode</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Map to Screen</guilabel> :
+ This mode maps the pen cursor with absolute movement to the tablet.
+ The edges of the tablet represent directly the space of the screen.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Map to Cursor</guilabel> :
+ This mode maps the pen cursor with relative movement to the tablet.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ <sect2 id="tablet-orientation">
+ <title>Orientation</title>
+ <para>
+ The orientation box specifies how the tablet area is rotated. You can set a specific rotation on your own in the combobox or if you enable the <guilabel>Auto-Rotate with Screen</guilabel> option, the tablet will automatically rotated together with the screen. This is done by listening to
+ the xrandr events when the screen is rotated.
+ </para>
+ <para>
+ If you have problems with the autorotation option and the tablet is always rotated into the wrong direction, enable the <guilabel>Invert Auto-Rotation</guilabel> option to inverse this.
+ </para>
+ </sect2>
+ <sect2 id="tablet-area-mapping">
+ <title>Tablet Mapping</title>
+ <para>
+ This mapping allows to specify the proportions of the tablet that will be used for each screen. This is necessary to keep the tablet area proportional to the used screen space in absolute stylus tracking mode.
+ </para>
+ <note>
+ <para>
+ This option does not work for relative cursor mode.
+ </para>
+ </note>
+ </sect2>
+ </sect1>
+
+ <sect1 id="touch-mapping">
+ <title>Touch</title>
+
+ <para>
+ The <guilabel>Touch</guilabel> tab allows to set further properties for the touch part of the tablet (if available).
+ It is possible to disable the touch feature via the <guilabel>Enable Touch</guilabel> checkbox. Also a global shortcut exist that allows to enable/disable the touch feature.
+ </para>
+
+ <sect2 id="touch-tracking">
+ <title>Touch Tracking Mode</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Map to Screen</guilabel> :
+ This mode maps the touch cursor with absolute movement to the tablet.
+ The edges of the tablet represent directly the space of the screen.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Map to Cursor</guilabel> :
+ This mode maps the touch cursor with relative movement to the tablet.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="touch-gestures">
+ <title>Gestures</title>
+
+ <para>
+ If <guilabel>Enable Gestures</guilabel> is enabled, the tablet can generate gesture events for the touch device.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Scroll Distance</guilabel> :
+ Allows to scroll through windows when two fingers are placed on the tablet, moving them up/down creates a scroll event.
+ The Distance is given in tablet units.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Zoom Distance</guilabel> :
+ Allows to zoom in/out by moving two fingers together or apart from each other.
+ The Distance is given in tablet units.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Tap Time</guilabel> :
+ This time in milliseconds specifies when a double tab on the device is recognized as right-click
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="touch-area-mapping">
+ <title>Touch Mapping</title>
+ <para>
+ This mapping allows to specify the proportions of the touch device that will be used for each screen. This is necessary to keep the tablet area proportional to the used screen space in absolute stylus tracking mode.
+ </para>
+ <note>
+ <para>
+ This option does not work for relative cursor mode.
+ </para>
+ </note>
+ </sect2>
+
</sect1>
-
- <sect1 id="stylus">
- <title>Stylus Settings</title>
-
- <para>
- The pen that is used together with the tablet has two different sides, the main side is called stylus.
- With this dialog you can change any aspect of the stylus side and the buttons on the pen to adjust them to your needs.
- </para>
-
- <sect2 id="cursor-settings"><title>Cursor Settings</title>
- <para>
- <itemizedlist>
- <listitem>
- <para><guilabel>Mode</guilabel> :
- Change the pen mode between absolute and relative input.
- Relative acts more like a mouse while absolute is like a pen on the paper position.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Speed</guilabel> :
- Sets relative cursor movement speed
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Threshold</guilabel> :
- Sets tip/eraser pressure threshold.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Pressure</guilabel> :
- Change the press curve. The curve is shown in a new dialog and you can change the Bézier curve with the
- red dots. The curve defines how the pressure of the pen is translated.
- </para>
- <note><para>
- Use your pen inside the press curve dialog to see the changes in the press curve directly.
- A blue area below the curve shows the applied pressure of the pen.
- </para></note>
- </listitem>
- </itemizedlist>
- </para>
- </sect2>
-
- <sect2 id="tip-double-click-distance"><title>Tip Double Click Distance</title>
- <para>
- Defines how fast you need to tap the tip of the pen on the tablet to be recognize it as a double click instead
- of two single clicks.
- </para>
- </sect2>
-
- <sect2 id="pen-button-settings"><title>Button Settings</title>
- <para>
- This lets you map the tip and the two additional buttons on your pen with different actions.
- </para>
- <para>
- Available actions are:
- <itemizedlist>
- <listitem>
- <para><guilabel>Disable</guilabel> :
- disables the button.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Button</guilabel> :
- emulates a general button event press.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Left Click</guilabel> :
- emulates a left mouse button click event.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Middle Click</guilabel> :
- emulates a middle mouse button click event.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Right Click</guilabel> :
- emulates a right mouse button click event.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Double Click</guilabel> :
- emulates a double click event.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Keystroke</guilabel> :
- emulates a keystroke or special key press (for example <keycap>F1</keycap> or <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>).
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>QuoteDbl</guilabel> :
- emulates a text string. For example you could print <quote>Hello World</quote> at the current cursor position.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Mode Toggle</guilabel> :
- change the pen mode between absolute and relative input.
- Relative acts more like a mouse while absolute is like a pen on the paper position.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Screen Toggle</guilabel> :
- If more than one screen is connected and TwinView is deactivated this allows you to switch the current used screen.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Display Toggle</guilabel> :
- Toggles between multi monitor and single monitor mode. Thus allows to move from one screen to another.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </sect2>
+
+
+ <sect1 id="presscurve">
+ <title>Presscurve Dialog</title>
+
+ <para>
+ The Presscurve defines how the pressure of the stylus is translated. The Presscurve is defined via four points of a Bézier curve.
+ To change this curve you can alter the red dots and move the curve around.
+ </para>
+ <note>
+ <para>
+ Use your pen inside the press curve dialog to see the changes in the press curve directly.
+ A blue area below the curve shows the applied pressure of the pen.
+ </para>
+ </note>
+
+ <para>
+ <screenshot>
+ <screeninfo>Here's a screenshot of the Presscurve Dialog</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="presscurve.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Changing the Presscurve</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </para>
</sect1>
-
- <sect1 id="eraser">
- <title>Eraser Settings</title>
-
- <para>
- If you turn around the pen it will be recognized as eraser instead as pen. This allows to change the settings independent to the stylus side.
- All parameters are as described in the <link linkend="stylus">stylus</link> section.
- </para>
+
+ <sect1 id="area-selection">
+ <title>Area Selection Dialog</title>
+
+ <para>
+ This dialog allows to specify the available tablet area for each selected screen space. In order to keep the aspect ratio of the tablet it
+ is necessary to reduce the tablet area depending on the screen resolution. This Dialog allows to specify them for each screen individually.
+ </para>
+ <para>
+ Use the <guilabel>Toggle Screen</guilabel> button to switch between fullscreen (all connected monitors) and each individual monitor.
+ The settings will be saved for each screen configuration and applied to the tablet whenever the screen are switched by the global shortcut action.
+ </para>
+ <note>
+ <para>
+ The tablet area only works for absolute tracking mode of the touch and pen cursor device.
+ In relative mode the full tablet is used.
+ </para>
+ </note>
+
+ <para>
+ <screenshot>
+ <screeninfo>Here's a screenshot of the Tablet Area Dialog</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tabletarea.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Defining the Tablet Area</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </para>
</sect1>
</chapter>
-
+
+
+
+
+
<chapter id="kded">
<title>Tablet daemon</title>
<para>
@@ -395,12 +412,12 @@
detects your tablet even if the plasmoid is not used. The plasmoid is just a visual helper to switch easily between the profiles.
</para>
</chapter>
- <chapter id="credits"><title>Credits and License</title>
+ <chapter id="credits"><title>Credits and License</title>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
-
+
</chapter>
</book>
diff --git a/doc/user/presscurve.png b/doc/user/presscurve.png
new file mode 100644
index 0000000..971710a
Binary files /dev/null and b/doc/user/presscurve.png differ
diff --git a/doc/user/tabletarea.png b/doc/user/tabletarea.png
new file mode 100644
index 0000000..db9d42a
Binary files /dev/null and b/doc/user/tabletarea.png differ
More information about the kde-doc-english
mailing list