Warning, /plasma/wacomtablet/doc/user/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY tablet "<application>KCM Tablet</application>">
0004   <!ENTITY kappname "&tablet;">
0005   <!ENTITY package "kcontrol">
0006   <!ENTITY kappversion "2.0"><!--Application version. Use this variable everywhere it's needed.-->
0007   <!ENTITY % addindex "IGNORE">
0008   <!ENTITY % English "INCLUDE">
0009 ]>
0010 <book id="wacomtablet" lang="&language;">
0011     <bookinfo>
0012     <title>The &tablet; Handbook</title>
0013 
0014     <authorgroup>
0015         <author>
0016             <firstname>Jörg</firstname>
0017             <surname>Ehrichs</surname>
0018             <affiliation>
0019                 <address><email>joerg.ehrichs@gmx.de</email></address>
0020             </affiliation>
0021         </author>
0022         <!-- TRANS:ROLES_OF_TRANSLATORS -->
0023     </authorgroup>
0024     <copyright>
0025         <year>2013</year>
0026         <holder>Jörg Ehrichs</holder>
0027     </copyright>
0028 
0029     <legalnotice>&FDLNotice;</legalnotice>
0030 
0031     <date>2020-10-17</date><!-- Date of (re)writing, or update.-->
0032     <releaseinfo>&kappversion;</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
0033 
0034     <abstract>
0035         <para>This is the documentation for the &kde; &systemsettings; module that configures graphic tablets.</para>
0036     </abstract>
0037 
0038     <keywordset>
0039         <keyword>KDE</keyword><!-- do not change this! -->
0040         <keyword>System Settings</keyword>
0041         <keyword>Wacom</keyword>
0042         <keyword>Tablet</keyword>
0043     </keywordset>
0044 
0045     </bookinfo>
0046 
0047     <chapter id="introduction">
0048     <title>Wacom Tablet Settings</title>
0049     <para>
0050         The tablet &systemsettings; module handles all setting for your graphic tablet. All tablets supported by
0051         the <ulink url="https://linuxwacom.github.io">&Linux; Wacom driver</ulink> project are handled by this settings interface.
0052         Make sure your tablet is detected either via xorg.conf or udev and works in general. Refer to the <link linkend="detection">tablet detection</link> section for more information.
0053     </para>
0054     <important>
0055         <para>
0056             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.
0057         </para>
0058     </important>
0059     <para>
0060         The module is split into various tab pages that handle all aspects of your tablet and the pen:
0061         <link linkend="tablet-profiles">Profiles</link>,
0062         <link linkend="tablet-general">General Information</link>,
0063         <link linkend="stylus">Stylus Settings</link>,
0064         <link linkend="pad-buttons">Express Buttons</link>,
0065         <link linkend="pad-mapping">Pad Mapping</link> and
0066         <link linkend="touch-mapping">Touch Mapping</link>.
0067     </para>
0068     <sect1 id="tablet-profiles">
0069         <title>Profile Management</title>
0070 
0071         <para>
0072             This is the small drop down box with the two buttons next to it. You can create new profiles and delete already existing ones.
0073             Each profile is saved and specified for the currently connected tablet. If you create a new profile, it automatically creates one
0074             with the default settings as returned by the driver.
0075         </para>
0076 
0077         <para>
0078             Here you can specify different profiles for your settings.
0079             For example if you like to have a different behavior of the pen when you use it
0080             as a mouse replacement for your day to day work or using it as pen to draw something.
0081         </para>
0082         <para>
0083             Each profile can be changed on the fly and directly changes the behavior of your tablet input.
0084         </para>
0085         <note>
0086             <para>
0087                 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.
0088                 All the work is done by the daemon. The &systemsettings; module just change the profile settings for it.
0089             </para>
0090         </note>
0091     </sect1>
0092 
0093     <sect1 id="tablet-general">
0094         <title>General Tablet Settings and Information</title>
0095 
0096         <para>
0097             Shows some general Information about the detected tablet.
0098             Beside the name and company of your tablet an image is shown and all detected input devices are listed.
0099         </para>
0100 
0101         <note>
0102             <para>
0103                 The tablet must be connected and the <link linkend="kded">kded</link> must be running to allow the module to work correctly.
0104             </para>
0105             <para>
0106                 See the <link linkend="troubles">Detection problems</link> section for further help on the tablet detection.
0107             </para>
0108         </note>
0109 
0110         <para>
0111             In addition to the tablet information the general tab allows to set various global shortcuts. Each shortcut allows to dynamically
0112             change the options for the current connected tablet.
0113         </para>
0114 
0115     </sect1>
0116 
0117     <sect1 id="stylus">
0118         <title>Stylus Settings</title>
0119 
0120         <para>
0121             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.
0122             In this tab you can change any aspect of the pen from the button assignment to the pressure curve and threshold.
0123         </para>
0124 
0125         <sect2 id="eraser-settings">
0126             <title>Eraser Feel</title>
0127             <para>
0128                 The slider allows to alter the threshold of the eraser. For a more fine grained setting of the pressure it is possible
0129                 to alter the complete pressure curve in the <guilabel>Edit Pressure Curve</guilabel> dialog.
0130                 See <link linkend="presscurve">Press Curve Dialog</link> for more information.
0131             </para>
0132         </sect2>
0133 
0134         <sect2 id="pen-button-settings">
0135             <title>Button Settings</title>
0136             <para>
0137                 The <guilabel>Button Settings</guilabel> box allows to alter the executed action assigned to each button of the pen.
0138                 A simple click into the edit box opens a new dialog where different key combinations, modifier keys and mouse buttons can be selected.
0139             </para>
0140 
0141             <para>
0142                 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
0143                 to be executed. If this option is disabled each button action works also when the stylus is hovering above the tablet.
0144             </para>
0145         </sect2>
0146 
0147         <sect2 id="tip-settings">
0148             <title>Tip Feel</title>
0149             <para>
0150                 The slider allows to alter the threshold of the stylus tip. For a more fine grained setting of the pressure it is possible
0151                 to alter the complete pressure curve in the <guilabel>Edit Pressure Curve</guilabel> dialog.
0152                 See <link linkend="presscurve">Presscurve Dialog</link> for more information.
0153             </para>
0154         </sect2>
0155     </sect1>
0156 
0157     <sect1 id="pad-buttons">
0158         <title>Express Buttons</title>
0159 
0160         <para>
0161             The <guilabel>Express Buttons</guilabel> tab allows to set specific button actions for all hardware buttons for the tablet.
0162             To change the used action, you need to click into the edit box and choose the action in the new dialog.
0163         </para>
0164     </sect1>
0165 
0166 
0167    <sect1 id="pad-mapping">
0168        <title>Tablet</title>
0169 
0170        <para>
0171            The <guilabel>Tablet</guilabel> tab allows to set further properties of the tablet area when used together with a pen.
0172            In here the orientation of the tablet area, valid space of the used tablet and the cursor tracking mode can be specified.
0173        </para>
0174        <sect2 id="tablet-tracking">
0175            <title>Stylus Tracking Mode</title>
0176 
0177            <itemizedlist>
0178                <listitem>
0179                    <para>
0180                        <guilabel>Map to Screen</guilabel> :
0181                        This mode maps the pen cursor with absolute movement to the tablet.
0182                        The edges of the tablet represent directly the space of the screen.
0183                    </para>
0184                </listitem>
0185                <listitem>
0186                    <para>
0187                        <guilabel>Map to Cursor</guilabel> :
0188                        This mode maps the pen cursor with relative movement to the tablet.
0189                    </para>
0190                </listitem>
0191            </itemizedlist>
0192        </sect2>
0193        <sect2 id="tablet-orientation">
0194            <title>Orientation</title>
0195            <para>
0196                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
0197                the xrandr events when the screen is rotated.
0198            </para>
0199            <para>
0200                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 invert this.
0201            </para>
0202        </sect2>
0203        <sect2 id="tablet-area-mapping">
0204            <title>Tablet Mapping</title>
0205            <para>
0206                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. For more information check the <link linkend="area-selection">Area Selection Dialog</link> section.
0207            </para>
0208            <note>
0209                <para>
0210                    This option does not work for relative cursor mode.
0211                </para>
0212            </note>
0213        </sect2>
0214    </sect1>
0215 
0216    <sect1 id="touch-mapping">
0217        <title>Touch</title>
0218 
0219        <para>
0220            The <guilabel>Touch</guilabel> tab allows to set further properties for the touch part of the tablet (if available).
0221            It is possible to disable the touch feature via the <guilabel>Enable Touch</guilabel> check box. Also a global shortcut exist that allows to enable/disable the touch feature.
0222        </para>
0223 
0224        <sect2 id="touch-tracking">
0225            <title>Touch Tracking Mode</title>
0226 
0227            <itemizedlist>
0228                <listitem>
0229                    <para>
0230                        <guilabel>Map to Screen</guilabel> :
0231                        This mode maps the touch cursor with absolute movement to the tablet.
0232                        The edges of the tablet represent directly the space of the screen.
0233                    </para>
0234                </listitem>
0235                <listitem>
0236                    <para>
0237                        <guilabel>Map to Cursor</guilabel> :
0238                        This mode maps the touch cursor with relative movement to the tablet.
0239                    </para>
0240                </listitem>
0241            </itemizedlist>
0242        </sect2>
0243 
0244        <sect2 id="touch-gestures">
0245            <title>Gestures</title>
0246 
0247            <para>
0248                If <guilabel>Enable Gestures</guilabel> is enabled, the tablet can generate gesture events for the touch device.
0249            </para>
0250 
0251            <itemizedlist>
0252                <listitem>
0253                    <para>
0254                        <guilabel>Scroll Distance</guilabel> :
0255                        Allows to scroll through windows when two fingers are placed on the tablet, moving them up/down creates a scroll event.
0256                        The Distance is given in tablet units.
0257                    </para>
0258                </listitem>
0259                <listitem>
0260                    <para>
0261                        <guilabel>Zoom Distance</guilabel> :
0262                        Allows to zoom in/out by moving two fingers together or apart from each other.
0263                        The Distance is given in tablet units.
0264                    </para>
0265                </listitem>
0266                <listitem>
0267                    <para>
0268                        <guilabel>Tap Time</guilabel> :
0269                        This time in milliseconds specifies when a double tap on the device is recognized as right-click
0270                    </para>
0271                </listitem>
0272            </itemizedlist>
0273        </sect2>
0274 
0275        <sect2 id="touch-area-mapping">
0276            <title>Touch Mapping</title>
0277            <para>
0278                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. For more information check the <link linkend="area-selection">Area Selection Dialog</link> section.
0279            </para>
0280            <note>
0281                <para>
0282                    This option does not work for relative cursor mode.
0283                </para>
0284            </note>
0285        </sect2>
0286 
0287     </sect1>
0288 
0289 
0290     <sect1 id="presscurve">
0291         <title>Press Curve Dialog</title>
0292 
0293         <para>
0294             <screenshot>
0295                 <screeninfo>Here's a screenshot of the Press Curve dialog</screeninfo>
0296                 <mediaobject>
0297                     <imageobject>
0298                         <imagedata fileref="presscurve.png" format="PNG"/>
0299                     </imageobject>
0300                     <textobject>
0301                         <phrase>Changing the press curve</phrase>
0302                     </textobject>
0303                 </mediaobject>
0304             </screenshot>
0305         </para>
0306 
0307         <para>
0308             The press curve defines how the pressure of the stylus is translated. The press curve is defined via four points of a Bézier curve.
0309             To change this curve you can alter the red dots and move the curve around.
0310         </para>
0311         <note>
0312             <para>
0313                 Use your pen inside the press curve dialog to see the changes in the press curve directly.
0314                 A blue area below the curve shows the applied pressure of the pen.
0315             </para>
0316         </note>
0317     </sect1>
0318 
0319     <sect1 id="area-selection">
0320         <title>Area Selection Dialog</title>
0321 
0322         <para>
0323             <screenshot>
0324                 <screeninfo>Here's a screenshot of the Tablet Area Dialog</screeninfo>
0325                 <mediaobject>
0326                     <imageobject>
0327                         <imagedata fileref="tabletarea.png" format="PNG"/>
0328                     </imageobject>
0329                     <textobject>
0330                         <phrase>Defining the Tablet Area</phrase>
0331                     </textobject>
0332                 </mediaobject>
0333             </screenshot>
0334         </para>
0335 
0336         <para>
0337             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
0338             is necessary to reduce the tablet area depending on the screen resolution. This Dialog allows to specify them for each screen individually.
0339         </para>
0340         <para>
0341             Use the <guilabel>Toggle Screen</guilabel> button to switch between fullscreen (all connected monitors) and each individual monitor.
0342             The settings will be saved for each screen configuration and applied to the tablet whenever the screen selection is switched by the global shortcut action.
0343         </para>
0344         <para>
0345             It is possible to map the screen with the <guimenuitem>Full Tablet</guimenuitem> area or just defined <guimenuitem>Tablet Area</guimenuitem> on the <guilabel>Tablet</guilabel> pane rightwards. The proportions of the area can be locked or unlocked using the <guibutton>Lock proportions</guibutton> switch button.
0346         </para>
0347         <para>
0348             If you want to keep the aspect ratio of the tablet with the current screen selection you can press the <guilabel>Set Screen Proportions</guilabel> button. The tablet area will be calculated and changed automatically.
0349         </para>
0350         <para>
0351         In addition you can open the <guilabel>Calibrate</guilabel> dialog to calibrate your tablet with the help of four points on the screen.
0352         </para>
0353         <para>
0354             When the dialog is closed, the last selected screen will be used. If you want to switch the screen later on, you can use the <link linkend="tablet-general">Global Shortcut</link>.
0355         </para>
0356         <note>
0357             <para>
0358                 The tablet area only works for absolute tracking mode of the touch and pen cursor device.
0359                 In relative mode the full tablet is used.
0360             </para>
0361         </note>
0362     </sect1>
0363     </chapter>
0364 
0365 
0366 
0367 
0368 
0369     <chapter id="kded">
0370     <title>Tablet daemon</title>
0371     <para>
0372         The tablet daemon runs in the background and does the ground work. Detecting the tablet and set it up with the selected profiles.
0373         If the daemon is not running the &systemsettings; module and the plasma applet cannot work properly and the tablet cannot be used with the profiles.
0374     </para>
0375 
0376     <sect1 id="detection">
0377         <title>Tablet detection</title>
0378         <para>
0379             The detection of the <hardware>tablet device</hardware> is done in several ways.
0380             <application>Solid</application> is used in the first step and does the hotplug support.
0381             If Solid fails the next steps are <command>xsetwacom list dev</command>, <command>lsusb</command> and <command>xinput --list</command>.
0382         </para>
0383         <para>
0384             Should none of the commands above return the name of the tablet, it is not supported and cannot be used by this module.
0385         </para>
0386     </sect1>
0387     <sect1 id="troubles">
0388         <title>Detection problems</title>
0389         <para>
0390             If the tablet is not detected check the <ulink url="https://linuxwacom.github.io">&Linux; Wacom driver</ulink> or <ulink url="https://digimend.github.io">DIGImend driver</ulink> page if your tablet is supported.
0391             Furthermore check via <command>lsusb</command> if you can find your tablet.
0392         </para>
0393         <para>
0394             If udev does not handle the detection add the tablet to your <filename>/etc/X11/xorg.conf.d/50-tablet.conf</filename> file (create it if it does not exist) and restart the x-server.
0395         </para>
0396         <para>
0397             In case of a serial device (Tablet PC and such) check if <command>xinput --list</command> lists your input devices (Stylus/Eraser/Pad).
0398             Should they be listed take a look at the internal tablet device id via <command>xsetwacom get "Name of your pad or stylus" TabletID</command>.
0399             If an id is returned please mail all the necessary information to the author.
0400         </para>
0401         <note>
0402         <para>
0403             Hotplug support is only available if the tablet is found via <application>Solid</application> and its notification API.
0404         </para>
0405         <para>
0406             <application>Solid</application> checks if the value for the entry <command>input.x11_options.Type</command> is <command>pen</command>,
0407             <command>stylus</command>, <command>eraser</command> or <command>cursor</command> or if the value for the entry <command>input.x11_driver</command> is <command>wacom</command>.
0408         </para>
0409         <para>
0410             Please mail the author if your tablet is detected by Solid but with other values to enhance the tablet support.
0411         </para>
0412         </note>
0413     </sect1>
0414     </chapter>
0415 
0416     <chapter id="applet">
0417     <title>Tablet plasma applet</title>
0418     <para>
0419         The tablet applet makes it possible to change the available profiles on the fly. Furthermore you can change the pad rotation and switch between absolute/relative mode
0420         of the stylus/eraser regardless of the current profile settings.
0421     </para>
0422     <para>
0423         It is not necessary to add the plasmoid for this module to work. The default profile will be activated by the  <link linkend="kded">tablet daemon</link> as soon as it
0424         detects your tablet even if the plasmoid is not used. The plasmoid is just a visual helper to switch easily between the profiles.
0425     </para>
0426     </chapter>
0427     <chapter id="credits"><title>Credits and License</title>
0428     <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0429 
0430     &underFDL;
0431 
0432     &underGPL;
0433 
0434     </chapter>
0435 </book>