tag: Add better documentation

This commit is contained in:
Emmanuel Lepage Vallee 2016-04-06 23:13:13 -04:00
parent dd52f1ce86
commit 7772386f23
2 changed files with 275 additions and 0 deletions

273
docs/images/tag_props.svg Normal file
View File

@ -0,0 +1,273 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="519pt"
height="400pt"
viewBox="0 0 519 400"
version="1.1"
id="svg5783"
inkscape:version="0.91 r13725"
sodipodi:docname="tag_props.svg">
<metadata
id="metadata5846">
<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>
<defs
id="defs5844" />
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1918"
inkscape:window-height="1032"
id="namedview5842"
showgrid="false"
inkscape:zoom="1.44"
inkscape:cx="275.51935"
inkscape:cy="265.93078"
inkscape:window-x="0"
inkscape:window-y="16"
inkscape:window-maximized="1"
inkscape:current-layer="svg5783" />
<path
inkscape:connector-curvature="0"
id="path5786"
d="m 99.744949,82.18258 318.500001,0 0,238.5 -318.500001,0 z m 0,0"
style="fill:none;stroke:#000000;stroke-width:1.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:10, 4;stroke-dashoffset:1;stroke-opacity:0.26666703" />
<path
inkscape:connector-curvature="0"
id="path5788"
d="m 108.99495,91.43258 300,0 0,220 -300,0 z m 0,0"
style="fill:none;stroke:#000000;stroke-width:1.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:10, 4;stroke-dashoffset:1;stroke-opacity:0.2" />
<path
inkscape:connector-curvature="0"
id="path5792"
d="m 264.94334,104.86123 c 0,-2.76172 2.23828,-5 5,-5 l 121.90041,0 c 2.76172,0 5,2.23828 5,5 l 0,48.33333 c 0,2.76172 -2.23828,5 -5,5 l -121.90041,0 c -2.76172,0 -5,-2.23828 -5,-5 z"
style="fill:#617fff;fill-opacity:0.49019602;fill-rule:nonzero;stroke:#617fff;stroke-width:1.55999994;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
sodipodi:nodetypes="sssssssss" />
<path
sodipodi:nodetypes="sssssssss"
style="fill:#617fff;fill-opacity:0.49019602;fill-rule:nonzero;stroke:#617fff;stroke-width:1.55999994;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 119.01924,104.86123 c 0,-2.76172 2.23828,-5 5,-5 l 121.9004,0 c 2.76172,0 5,2.23828 5,5 l 0,83.54115 c 0,2.76172 -2.23828,5 -5,5 l -121.9004,0 c -2.76172,0 -5,-2.23828 -5,-5 z"
id="path7583"
inkscape:connector-curvature="0" />
<path
inkscape:connector-curvature="0"
id="path7587"
d="m 119.01924,210.53441 c 0,-2.76172 2.23828,-5 5,-5 l 121.9004,0 c 2.76172,0 5,2.23828 5,5 l 0,83.54115 c 0,2.76172 -2.23828,5 -5,5 l -121.9004,0 c -2.76172,0 -5,-2.23828 -5,-5 z"
style="fill:#617fff;fill-opacity:0.49019602;fill-rule:nonzero;stroke:#617fff;stroke-width:1.55999994;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
sodipodi:nodetypes="sssssssss" />
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 118.6368,77.0879 0,-10.21376 135.92164,0 0,11.39227"
id="path7589"
inkscape:connector-curvature="0" />
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.36000001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 182.27641,66.4813 0,-10.99944"
id="path7595"
inkscape:connector-curvature="0" />
<path
inkscape:connector-curvature="0"
id="path7597"
d="m 427.60318,224.3777 10.21376,0 0,15.32064 -10.14227,0"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
sodipodi:nodetypes="cccc" />
<path
inkscape:connector-curvature="0"
id="path7599"
d="m 438.44336,232.64825 10.99944,0"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.36000001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
<path
sodipodi:nodetypes="cccc"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 265.37038,328.5978 0,10.21376 -15.32064,0 0,-10.14227"
id="path7601"
inkscape:connector-curvature="0" />
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 258.99495,338.6548 0,9.44444 183.33334,0 0,-114.44443"
id="path7603"
inkscape:connector-curvature="0"
sodipodi:nodetypes="cccc" />
<text
sodipodi:linespacing="125%"
id="text7607"
y="235.37877"
x="452.8934"
style="font-style:normal;font-weight:normal;font-size:11.81261539px;line-height:125%;font-family:sans-serif;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="235.37877"
x="452.8934"
id="tspan7609"
sodipodi:role="line">Gaps</tspan></text>
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 399.82829,90.321468 0,-26.432579 -20.55556,0.04369"
id="path7611"
inkscape:connector-curvature="0"
sodipodi:nodetypes="ccc" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:11.81261539px;line-height:125%;font-family:sans-serif;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="320.79419"
y="67.281029"
id="text7613"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan7615"
x="320.79419"
y="67.281029">Work area</tspan></text>
<path
inkscape:connector-curvature="0"
id="path7617"
d="m 123.14816,328.5978 0,10.21376 -15.32064,0 0,-10.14227"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
sodipodi:nodetypes="cccc" />
<path
sodipodi:nodetypes="cccc"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 96.150273,107.47611 -10.213761,0 0,-15.32064 10.142271,0"
id="path7619"
inkscape:connector-curvature="0" />
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 85.10606,100.32147 -8.333333,0 0,248.33333 38.333333,0"
id="path7623"
inkscape:connector-curvature="0" />
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 115.10606,339.21036 0,24.84505 4.91046,0.0712"
id="path7625"
inkscape:connector-curvature="0"
sodipodi:nodetypes="ccc" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:11.81261539px;line-height:125%;font-family:sans-serif;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="122.60548"
y="366.58011"
id="text7627"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan7629"
x="122.60548"
y="366.58011">Screen padding</tspan></text>
<path
style="fill:#ff5555;fill-rule:evenodd;stroke:#9c39bf;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:9.6, 4.8;stroke-dashoffset:0;stroke-opacity:1"
d="m 257.88384,24.76591 0,276.66667"
id="path7631"
inkscape:connector-curvature="0" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:11.81261539px;line-height:125%;font-family:sans-serif;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="130.15106"
y="52.780128"
id="text7591"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan7593"
x="130.15106"
y="52.780128">Master width factor</tspan></text>
<path
sodipodi:nodetypes="sssssssss"
style="fill:#617fff;fill-opacity:0.49019602;fill-rule:nonzero;stroke:#617fff;stroke-width:1.55999994;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 264.94334,175.41679 c 0,-2.76172 2.23828,-5 5,-5 l 121.90041,0 c 2.76172,0 5,2.23828 5,5 l 0,48.33333 c 0,2.76172 -2.23828,5 -5,5 l -121.90041,0 c -2.76172,0 -5,-2.23828 -5,-5 z"
id="path7643"
inkscape:connector-curvature="0" />
<path
inkscape:connector-curvature="0"
id="path7645"
d="m 264.94334,246.5279 c 0,-2.76172 2.23828,-5 5,-5 l 121.90041,0 c 2.76172,0 5,2.23828 5,5 l 0,48.33333 c 0,2.76172 -2.23828,5 -5,5 l -121.90041,0 c -2.76172,0 -5,-2.23828 -5,-5 z"
style="fill:#617fff;fill-opacity:0.49019602;fill-rule:nonzero;stroke:#617fff;stroke-width:1.55999994;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
sodipodi:nodetypes="sssssssss" />
<path
inkscape:connector-curvature="0"
id="path7647"
d="m 176.21717,144.76591 -107.222221,0 10e-7,114.44445 105.55556,0"
style="fill:none;fill-rule:evenodd;stroke:#9c39bf;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:9.6, 4.8;stroke-dashoffset:0;stroke-opacity:1"
sodipodi:nodetypes="cccc" />
<path
inkscape:connector-curvature="0"
id="path7649"
d="m 68.578283,204.27776 -13.814013,-0.0674 -0.537961,175.00485 65.366651,0.22526"
style="fill:none;fill-rule:evenodd;stroke:#9c39bf;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:9.6, 4.8;stroke-dashoffset:0;stroke-opacity:1"
sodipodi:nodetypes="cccc" />
<text
sodipodi:linespacing="125%"
id="text7651"
y="382.34006"
x="122.60548"
style="font-style:normal;font-weight:normal;font-size:11.81261539px;line-height:125%;font-family:sans-serif;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="382.34006"
x="122.60548"
id="tspan7653"
sodipodi:role="line">Masters</tspan></text>
<path
inkscape:connector-curvature="0"
id="path8456"
d="m 118.6368,77.0879 0,-10.21376 135.92164,0 0,11.39227"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
<path
sodipodi:nodetypes="ccc"
inkscape:connector-curvature="0"
id="path8458"
d="m 413.99495,82.265912 0,-40.877023 -33.88889,0.321471"
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.20000005;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
<text
sodipodi:linespacing="125%"
id="text8460"
y="38.719765"
x="285.3501"
style="font-style:normal;font-weight:normal;font-size:17.02204132px;line-height:125%;font-family:sans-serif;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="38.719765"
x="285.3501"
id="tspan8462"
sodipodi:role="line" /><tspan
y="59.997314"
x="285.3501"
sodipodi:role="line"
id="tspan8464" /></text>
<text
sodipodi:linespacing="125%"
id="text8466"
y="45.725838"
x="310.60031"
style="font-style:normal;font-weight:normal;font-size:11.81261539px;line-height:125%;font-family:sans-serif;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="45.725838"
x="310.60031"
id="tspan8468"
sodipodi:role="line">Screen area</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.9279623px;line-height:125%;font-family:sans-serif;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="237.01671"
y="18.350338"
id="text6363"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
id="tspan6365"
x="237.01671"
y="18.350338">Columns</tspan></text>
</svg>

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -24,6 +24,8 @@
* Furthermore to the classes described here, one can also use signals as * Furthermore to the classes described here, one can also use signals as
* described in @{signals}. * described in @{signals}.
* *
* ![Client geometry](../images/tag_props.svg)
*
* Some signal names are starting with a dot. These dots are artefacts from * Some signal names are starting with a dot. These dots are artefacts from
* the documentation generation, you get the real signal name by * the documentation generation, you get the real signal name by
* removing the starting dot. * removing the starting dot.