From c2c526a7c5287cf2c0beeff0cfbce66c51d79ce8 Mon Sep 17 00:00:00 2001
From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Wed, 10 Feb 2016 14:13:10 +1000
Subject: [PATCH] doc: add a graphic illustrating pad vs tool support

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Jason Gerecke <jason.gerecke@wacom.com>
Reviewed-by: Carlos Garnacho <carlosg@gnome.org>
---
 doc/svg/tablet-interfaces.svg | 325 ++++++++++++++++++++++++++++++++++
 doc/tablet-support.dox        |   2 +
 2 files changed, 327 insertions(+)
 create mode 100644 doc/svg/tablet-interfaces.svg

diff --git a/doc/svg/tablet-interfaces.svg b/doc/svg/tablet-interfaces.svg
new file mode 100644
index 00000000..d64fe9f3
--- /dev/null
+++ b/doc/svg/tablet-interfaces.svg
@@ -0,0 +1,325 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="229.5488mm"
+   height="86.66362mm"
+   viewBox="0 0 813.36188 307.07582"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="tablet-interfaces.svg">
+  <defs
+     id="defs4">
+    <linearGradient
+       inkscape:collect="always"
+       id="linearGradient4294">
+      <stop
+         style="stop-color:#1a1a1a;stop-opacity:1;"
+         offset="0"
+         id="stop4296" />
+      <stop
+         style="stop-color:#808080;stop-opacity:1"
+         offset="1"
+         id="stop4298" />
+    </linearGradient>
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient4294"
+       id="linearGradient4300"
+       x1="465.81339"
+       y1="666.13727"
+       x2="454.82117"
+       y2="658.65521"
+       gradientUnits="userSpaceOnUse" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="2.8"
+     inkscape:cx="587.87559"
+     inkscape:cy="104.80851"
+     inkscape:document-units="px"
+     inkscape:current-layer="g3663-9-5"
+     showgrid="false"
+     showguides="true"
+     inkscape:guide-bbox="true"
+     inkscape:window-width="1920"
+     inkscape:window-height="1016"
+     inkscape:window-x="0"
+     inkscape:window-y="27"
+     inkscape:window-maximized="1"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0" />
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="tablet"
+     inkscape:groupmode="layer"
+     id="layer1"
+     style="display:inline"
+     transform="translate(67.109152,-133.63374)">
+    <g
+       id="g4309"
+       inkscape:export-xdpi="90"
+       inkscape:export-ydpi="90">
+      <rect
+         y="134.15933"
+         x="75.787216"
+         height="306.02466"
+         width="522.19733"
+         id="rect4136"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:1.05118144;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:4.20472551, 1.05118138;stroke-dashoffset:0;stroke-opacity:1" />
+      <rect
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.74813837;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:2.99255325, 0.74813831;stroke-dashoffset:0;stroke-opacity:1"
+         id="rect4140"
+         width="357.34042"
+         height="226.52563"
+         x="199.33878"
+         y="175.42407" />
+      <rect
+         y="175.72914"
+         x="103.10225"
+         height="22.142857"
+         width="65"
+         id="rect4142"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1" />
+      <rect
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1"
+         id="rect4148"
+         width="65"
+         height="22.142857"
+         x="103.10225"
+         y="203.72914" />
+      <rect
+         y="231.72913"
+         x="103.10225"
+         height="22.142857"
+         width="65"
+         id="rect4150"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1" />
+      <rect
+         y="323.72913"
+         x="103.10225"
+         height="22.142857"
+         width="65"
+         id="rect4154"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1" />
+      <rect
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1"
+         id="rect4156"
+         width="65"
+         height="22.142857"
+         x="103.10225"
+         y="351.72913" />
+      <circle
+         r="22.98097"
+         cy="287.06125"
+         cx="135.61298"
+         id="path4158"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1" />
+      <ellipse
+         ry="12.608653"
+         rx="11.5985"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.52043104;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:2.08172421, 0.52043105;stroke-dashoffset:0;stroke-opacity:1"
+         id="circle4160"
+         cx="135.61298"
+         cy="287.06125" />
+      <rect
+         y="379.72913"
+         x="103.10225"
+         height="22.142857"
+         width="65"
+         id="rect4162"
+         style="opacity:0.92000002;fill:#4d4d4d;fill-opacity:1;stroke:#4d4d4d;stroke-width:0.98900002;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:3.956, 0.989;stroke-dashoffset:0;stroke-opacity:1" />
+    </g>
+  </g>
+  <g
+     inkscape:groupmode="layer"
+     id="layer3"
+     inkscape:label="stylus"
+     style="display:inline"
+     transform="translate(67.109152,-133.63374)">
+    <g
+       id="g4304"
+       transform="matrix(0.37129971,0.09948946,-0.09618892,0.35898192,295.60339,7.6883643)">
+      <path
+         sodipodi:nodetypes="czcc"
+         inkscape:connector-curvature="0"
+         id="path4286"
+         d="m 387.83544,799.76093 c -1.1128,3.61694 -3.2211,13.05163 -1.08543,14.07769 2.13567,1.02606 7.81039,-3.72162 10.99756,-6.69095 z"
+         style="display:inline;fill:#cccccc;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+      <path
+         sodipodi:nodetypes="ssssccssscsssssssssssssssssss"
+         inkscape:connector-curvature="0"
+         id="path4283"
+         d="m 392.64431,804.79039 c -8.52094,-5.90399 -8.49394,-11.01546 0.22879,-43.30647 1.03999,-3.85 2.46829,-9.67602 3.17399,-12.9467 0.99731,-4.62219 2.39455,-7.29497 6.27321,-12 2.74456,-3.32932 5.25157,-6.2783 5.57113,-6.5533 40.78433,-60.97488 80.48307,-125.1652 118.27253,-184 9.86283,-15.675 26.59424,-42.225 37.18089,-59 10.58666,-16.775 34.01422,-53.9 52.06125,-82.5 18.04703,-28.6 35.04505,-55.31677 37.77338,-59.37059 l 4.9606,-7.3706 4.1828,0.57332 c 4.16371,0.5707 4.19706,0.54958 7.30887,-4.62941 3.75631,-6.2516 8.82067,-11.57582 12.2516,-12.88026 5.99391,-2.27888 14.03303,2.9506 14.03303,9.12854 0,3.90203 -2.51704,10.62127 -6.02878,16.09385 -1.63417,2.54664 -2.97122,4.85949 -2.97122,5.13969 0,0.28019 0.9,1.54715 2,2.81546 2.28453,2.63408 2.47267,4.21918 0.86833,7.31574 -1.28218,2.47476 -26.61383,45.18798 -55.85724,94.18426 -10.83283,18.15 -25.72943,43.1137 -33.10357,55.47489 -7.37413,12.3612 -13.69273,23.17153 -14.04131,24.02297 -0.34859,0.85144 -7.50972,12.78774 -15.91363,26.52511 -15.54138,25.40455 -32.24417,52.9052 -70.74345,116.47703 -40.26028,66.47968 -43.66308,72.46026 -49.21634,86.5 -1.74036,4.4 -3.92035,8.675 -4.8444,9.5 -0.92405,0.825 -4.36246,3.75 -7.6409,6.5 -3.27845,2.75 -9.57132,8.3067 -13.98415,12.34823 -10.62726,9.73304 -16.99729,13.87361 -22.52334,14.64034 -3.99187,0.55386 -5.03885,0.251 -9.27207,-2.6821 z"
+         style="display:inline;fill:#000000" />
+      <path
+         sodipodi:nodetypes="scccs"
+         inkscape:connector-curvature="0"
+         id="path4292"
+         d="m 450.89044,688.88586 c 8.71518,5.62513 45.74035,-59.18436 43.57923,-75.43494 l -7.07107,-6.56599 c -29.93081,25.86352 -47.78438,74.72281 -47.78438,74.72281 0,0 0,0 11.27622,7.27812 z"
+         style="fill:url(#linearGradient4300);fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+    </g>
+    <g
+       style="display:inline"
+       transform="matrix(0.98314313,0.18283763,-0.18283763,0.98314313,124.70585,-392.20667)"
+       id="g3663-9-5">
+      <rect
+         style="opacity:1;fill:none;fill-opacity:1;stroke:#000000;stroke-width:2.39000654;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="rect6268"
+         width="98.462646"
+         height="99.005119"
+         x="-37.056244"
+         y="554.24286"
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)" />
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+         d="m 71.874136,599.56332 -149.77963,27.8549"
+         id="path6270"
+         inkscape:connector-curvature="0"
+         sodipodi:nodetypes="cc" />
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="-193.01566"
+         y="595.05914"
+         id="text6272"
+         sodipodi:linespacing="125%"
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"><tspan
+           sodipodi:role="line"
+           id="tspan6274"
+           x="-193.01566"
+           y="595.05914">Pad buttons</tspan></text>
+      <rect
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"
+         y="706.24286"
+         x="-37.056244"
+         height="99.005119"
+         width="98.462646"
+         id="rect6276"
+         style="opacity:1;fill:none;fill-opacity:1;stroke:#000000;stroke-width:2.39000654;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
+      <text
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"
+         sodipodi:linespacing="125%"
+         id="text6282"
+         y="755.05914"
+         x="-193.01566"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         xml:space="preserve"><tspan
+           y="755.05914"
+           x="-193.01566"
+           id="tspan6284"
+           sodipodi:role="line">Pad buttons</tspan></text>
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="-193.01566"
+         y="755.05914"
+         id="text6286"
+         sodipodi:linespacing="125%"
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"><tspan
+           sodipodi:role="line"
+           id="tspan6288"
+           x="-193.01566"
+           y="755.05914">Pad buttons</tspan></text>
+      <text
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"
+         sodipodi:linespacing="125%"
+         id="text6290"
+         y="675.05914"
+         x="-193.01566"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         xml:space="preserve"><tspan
+           y="675.05914"
+           x="-193.01566"
+           id="tspan6292"
+           sodipodi:role="line">Pad ring</tspan></text>
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path6296"
+         d="M 125.82687,670.90125 -63.278482,706.06966"
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+         d="M 101.12816,756.8662 -48.65147,784.7211"
+         id="path6298"
+         inkscape:connector-curvature="0"
+         sodipodi:nodetypes="cc" />
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+         d="M 734.27856,551.64315 407.53319,612.40883"
+         id="path6300"
+         inkscape:connector-curvature="0"
+         sodipodi:nodetypes="cc" />
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="-193.01566"
+         y="675.05914"
+         id="text6302"
+         sodipodi:linespacing="125%"
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"><tspan
+           sodipodi:role="line"
+           id="tspan6304"
+           x="-193.01566"
+           y="675.05914">Pad ring</tspan></text>
+      <text
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"
+         sodipodi:linespacing="125%"
+         id="text6306"
+         y="669.05914"
+         x="514.98431"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         xml:space="preserve"><tspan
+           y="669.05914"
+           x="514.98431"
+           id="tspan6308"
+           sodipodi:role="line">Tool buttons</tspan></text>
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path6310"
+         d="M 744.15182,604.7329 368.24929,674.64046"
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-weight:normal;font-size:17.5px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="558.98431"
+         y="723.05914"
+         id="text6312"
+         sodipodi:linespacing="125%"
+         transform="matrix(0.98314312,-0.18283763,0.18283763,0.98314312,0,0)"><tspan
+           sodipodi:role="line"
+           id="tspan6314"
+           x="558.98431"
+           y="723.05914">Tool tip</tspan></text>
+    </g>
+  </g>
+</svg>
diff --git a/doc/tablet-support.dox b/doc/tablet-support.dox
index 07de478b..0a44010b 100644
--- a/doc/tablet-support.dox
+++ b/doc/tablet-support.dox
@@ -23,6 +23,8 @@ Pad events do not require a tool to be in proximity. Note that both
 capabilities may exist on the same device though usually they are split
 across multiple kernel devices.
 
+@image html tablet-interfaces.svg "Difference between Pad and Tool buttons"
+
 Touch events on the tablet integrated into a screen itself are exposed
 through the @ref LIBINPUT_DEVICE_CAP_TOUCH capability. Touch events on a
 standalone tablet are exposed through the @ref LIBINPUT_DEVICE_CAP_POINTER