git.sur5r.net Git - glabels/blob - help/C/mancreate.page

   1 <page xmlns="http://projectmallard.org/1.0/"
   2       xmlns:e="http://projectmallard.org/experimental/"
   3       xmlns:its="http://www.w3.org/2005/11/its"
   4       type="guide"
   5       id="mancreate">
   6
   7   <info>
   8     <link type="guide" xref="index#advanced"/>
   9     <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
  10     <revision pkgversion="3.0.1" version="0.1" date="2011-06-20" status="incomplete"/>
  11     <desc>
  12       Create your templates manually.
  13     </desc>
  14     <credit type="author">
  15       <name>Jim Evins</name>
  16       <email>evins@snaught.com</email>
  17     </credit>
  18     <credit type="author">
  19       <name>Mario Blättermann</name>
  20       <email>mariobl@gnome.org</email>
  21     </credit>
  22     <license>
  23       <p>Creative Commons Share Alike 3.0</p>
  24     </license>
  25   </info>
  26
  27   <title>Manually creating new templates</title>
  28
  29
  30
  31   <!-- ****************** -->
  32   <!-- BEGIN Introduction -->
  33   <!-- ****************** -->
  34   <p>This page is a reference guide to manually creating <app>gLabels</app> templates.
  35   <app>gLabels</app> templates are defined in simple XML files as described in the DTD:
  36   <link href="http://glabels.org/xmlns/2.3/glabels-2.3.dtd.txt">glabels-2.3.dtd</link>
  37   (this DTD also describes other XML files used by <app>gLabels</app>).</p>
  38
  39   <p>Manually created template files should be placed in the <file>${HOME}/.glabels</file>
  40   and be named with a <file>.template</file> extension.</p>
  41
  42   <note style="advanced">
  43     <p><app>gLabels</app> searches for templates in several other locations as defined here:</p>
  44     <table frame="all" rules="rows">
  45       <tr>
  46         <td><p>Location</p></td>
  47         <td><p>Description</p></td>
  48       </tr>
  49       <tr>
  50         <td><p></p></td>
  51         <td><p></p></td>
  52       </tr>
  53       <tr>
  54         <td><p><file>${prefix}/share/libglabels-3.0/templates</file></p></td>
  55         <td><p>Predefined templates distributed with <app>gLabels</app>.</p>
  56             <p><file>${prefix}</file> is usually <file>/usr</file> or <file>/usr/local</file>,
  57             depending on where <app>gLabels</app> was installed.</p></td>
  58       </tr>
  59       <tr>
  60         <td><p><file>${XDG_CONFIG_HOME}/libglabels/templates</file></p></td>
  61         <td><p>User defined templates created with the <app>gLabels</app> <gui>Template Designer</gui>.
  62             <em>Do not put manually created templates in this directory.</em></p>
  63             <p>If <file>${XDG_CONFIG_HOME}</file> is not defined, it defaults to
  64             <file>${HOME}/.config</file>.</p></td>
  65       </tr>
  66       <tr>
  67         <td><p><file>${HOME}/.glabels</file></p></td>
  68         <td><p>User defined templates that have been created manually should be placed in this
  69             directory.
  70             Older versions of the <app>gLabels</app> <gui>Template Designer</gui> (prior to 3.0)
  71             would also put templates in this directory.</p></td>
  72       </tr>
  73     </table>
  74   </note>
  75
  76   <note><p>Completed template files can be sent to the
  77         <app>gLabels</app> template
  78         <link href="mailto:glabels-templates@lists.sourceforge.net">mailing list</link>
  79         for possible inclusion in future versions of <app>gLabels</app>.</p>
  80   </note>
  81   <!-- ****************** -->
  82   <!-- END Introduction   -->
  83   <!-- ****************** -->
  84
  85
  86   <!-- ***************** -->
  87   <!-- BEGIN Assumptions -->
  88   <!-- ***************** -->
  89   <section id="template-assumptions">
  90     <title>Assumptions/caveats</title>
  91     <list>
  92       <item>
  93         <p>A sheet contains only one size of label or card (if a sheet
  94           contains more than one size of item, it can be split into
  95            multiple templates for multiple pass printing)</p>
  96       </item>
  97       <item>
  98         <p>Distances can be expressed in units of <code its:translate="no">pt</code>,
  99           <code its:translate="no">in</code>, <code its:translate="no">mm</code>,
 100           <code its:translate="no">cm</code>, or <code its:translate="no">pc</code>.  For example:
 101           "<code its:translate="no">1.0in</code>" or "<code its:translate="no">2.54cm</code>".  If no
 102           units are specified, computer points (<code its:translate="no">pt</code>) will
 103           be assumed (1 <em>pt</em> =
 104           1/72 <em>in</em> = 0.352778 <em>mm</em>).
 105           </p>
 106       </item>
 107     </list>
 108   </section>
 109   <!-- ***************** -->
 110   <!-- END Assumptions   -->
 111   <!-- ***************** -->
 112
 113
 114
 115   <!-- ******************** -->
 116   <!-- BEGIN Template Files -->
 117   <!-- ******************** -->
 118   <section id="template-file">
 119     <title>Template Files</title>
 120
 121     <p>A template file contains a single <code its:translate="no">Glabels-templates</code> top-level
 122     node.</p>
 123
 124     <code mime="text/xml" its:translate="no">
 125 &lt;?xml version="1.0"?&gt;
 126 &lt;Glabels-templates&gt;
 127
 128    <var its:translate="yes">...templates...</var>
 129
 130 &lt;/Glabels-templates&gt;</code>
 131
 132     <listing>
 133       <title>Example Template</title>
 134       <desc>Example <app>gLabels</app> template file containing a single
 135             <code its:translate="no">Template</code> node.</desc>
 136       <code mime="text/xml" its:translate="no">
 137 &lt;?xml version="1.0"?&gt;
 138 &lt;Glabels-templates&gt;
 139
 140   &lt;Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels"&gt;
 141     &lt;Meta category="label"/&gt;
 142     &lt;Meta category="mail"/&gt;
 143     &lt;Meta product_url="http://www.avery.com/avery/en_us/"/&gt;
 144     &lt;Label-rectangle id="0" width="189pt" height="72pt" round="5pt"&gt;
 145       &lt;Markup-margin size="5pt"/&gt;
 146       &lt;Layout nx="3" ny="10" x0="11.25pt" y0="36pt" dx="200pt" dy="72pt"/&gt;
 147     &lt;/Label-rectangle&gt;
 148   &lt;/Template&gt;
 149
 150 &lt;/Glabels-templates&gt;</code>
 151     </listing>
 152
 153   </section>
 154   <!-- ******************** -->
 155   <!-- END Template Files   -->
 156   <!-- ******************** -->
 157
 158
 159
 160   <!-- ******************** -->
 161   <!-- BEGIN Template Node  -->
 162   <!-- ******************** -->
 163   <section id="template-template-node">
 164     <title><span its:translate="no">Template</span> Node</title>
 165
 166     <p>A <code its:translate="no">Template</code> node describes a single
 167       stationery product.  It must contain one instance of any type of Label node
 168       (<code its:translate="no">Label-rectangle</code>,
 169       <code its:translate="no">Label-round</code>, or
 170       <code its:translate="no">Label-cd</code>).</p>
 171
 172     <table frame="all" rules="rows">
 173       <tr>
 174         <td><p>Property</p></td>  <td><p>Description</p></td>
 175       </tr>
 176       <tr>
 177         <td><p></p></td>  <td><p></p></td>
 178       </tr>
 179       <tr>
 180         <td><p><code its:translate="no">brand</code></p></td>
 181         <td><p>Brand or manufacturer of stationery product. E.g. "Avery"</p></td>
 182       </tr>
 183       <tr>
 184         <td><p><code its:translate="no">part</code></p></td>
 185         <td><p>Part number or name of stationery product. E.g. "8160"</p></td>
 186       </tr>
 187       <tr>
 188         <td><p><code its:translate="no">size</code></p></td>
 189         <td><p>Size of sheet.
 190                E.g., "<code its:translate="no">US-Letter</code>", "<code its:translate="no">A4</code>", ...
 191             </p></td>
 192       </tr>
 193       <tr>
 194         <td><p><code its:translate="no">description</code></p></td>
 195         <td><p>Description of stationery product.  E.g, "Mailing Labels."</p></td>
 196       </tr>
 197       <tr>
 198         <td><p><code its:translate="no">_description</code></p></td>
 199         <td><p>Translatable description of stationery product. E.g, "Mailing Labels."
 200             (Only useful for predefined templates)</p></td>
 201       </tr>
 202       <tr>
 203         <td><p><code its:translate="no">width</code></p></td>
 204         <td><p>Page width.  Only valid if size="Other"</p></td>
 205       </tr>
 206       <tr>
 207         <td><p><code its:translate="no">height</code></p></td>
 208         <td><p>Page height.  Only valid if size="Other"</p></td>
 209       </tr>
 210       <tr>
 211         <td><p><code its:translate="no">equiv</code></p></td>
 212         <td><p>Equivalent part number.  If this property is present, the template
 213             is a clone of another template of the same brand.  The template will
 214             inherit all properties, except brand and name from the other template.
 215             This equiv property must refer to a previously defined template -
 216             <app>gLabels</app> does not currently support forward references.</p></td>
 217       </tr>
 218     </table>
 219
 220   </section>
 221   <!-- ******************** -->
 222   <!-- END Template Node    -->
 223   <!-- ******************** -->
 224
 225
 226   <!-- ******************** -->
 227   <!-- BEGIN Meta Node      -->
 228   <!-- ******************** -->
 229   <section id="meta-template-node">
 230     <title><span its:translate="no">Meta</span> Node</title>
 231
 232     <p>A <code its:translate="no">Meta</code> node contains some additional
 233          information about the template. A <code its:translate="no">Template</code>
 234          node may contain zero or more <code its:translate="no">Meta</code> nodes.</p>
 235
 236     <table frame="all" rules="rows">
 237       <tr>
 238         <td><p>Subnode</p></td>  <td><p>Description</p></td>
 239       </tr>
 240       <tr>
 241         <td><p></p></td>  <td><p></p></td>
 242       </tr>
 243       <tr>
 244         <td><p><code its:translate="no">category</code></p></td>
 245         <td><p>A category for the template.
 246             A template can belong to multiple categories by simply adding multiple
 247             <code its:translate="no">Meta</code> nodes to the parent
 248             <code its:translate="no">Template</code> node.
 249             Template categories are used by the <app>gLabels</app> <gui>New Label
 250             Dialog</gui> to filter the results of template searches.</p>
 251
 252             <p>The value of this category must match a predefined category ID defined in
 253             the file <file>${prefix}/libglabels-3.0/templates/categories.xml</file>.
 254               Currently defined category IDs include:</p>
 255             <list>
 256               <item><p><code its:translate="no">label</code></p></item>
 257               <item><p><code its:translate="no">round-label</code></p></item>
 258               <item><p><code its:translate="no">elliptical-label</code></p></item>
 259               <item><p><code its:translate="no">square-label</code></p></item>
 260               <item><p><code its:translate="no">rectangle-label</code></p></item>
 261               <item><p><code its:translate="no">card</code></p></item>
 262               <item><p><code its:translate="no">business-card</code></p></item>
 263               <item><p><code its:translate="no">media</code></p></item>
 264               <item><p><code its:translate="no">mail</code></p></item>
 265               <item><p><code its:translate="no">foldable</code></p></item>
 266               <item><p><code its:translate="no">photo</code></p></item>
 267             </list>
 268
 269
 270         </td>
 271       </tr>
 272       <tr>
 273         <td><p><code its:translate="no">product_url</code></p></td>
 274         <td><p>A URL pointing to the vendor's webpage for the specific product, if available.</p></td>
 275       </tr>
 276     </table>
 277
 278     <note><p>Suggestions for additional categories can be sent to the
 279           <app>gLabels</app> developer's
 280           <link href="mailto:glabels-devel@lists.sourceforge.net">mailing list</link>.</p>
 281           <p>Product URLs may be of limited use, because they may not be permanent.</p>
 282     </note>
 283
 284   </section>
 285   <!-- ******************** -->
 286   <!-- END Meta Node        -->
 287   <!-- ******************** -->
 288
 289
 290   <!-- ************************** -->
 291   <!-- BEGIN Label-rectangle Node -->
 292   <!-- ************************** -->
 293   <section id="template-label-rectangle-node">
 294     <title><span its:translate="no">Label-rectangle</span> Node</title>
 295
 296     <p>A <code its:translate="no">Label-rectangle</code> node describes the
 297       dimensions of a single label or business card that is rectangular
 298       in shape (may have rounded edges).</p>
 299
 300     <table frame="all" rules="rows">
 301       <tr>
 302         <td><p>Property</p></td>  <td><p>Description</p></td>
 303       </tr>
 304       <tr>
 305         <td><p></p></td>  <td><p></p></td>
 306       </tr>
 307       <tr>
 308         <td><p><code its:translate="no">id</code></p></td>
 309         <td><p>Reserved for future use.  Should always be 0.</p></td>
 310       </tr>
 311       <tr>
 312         <td><p><code its:translate="no">width</code></p></td>
 313         <td><p>Width of label/card</p></td>
 314       </tr>
 315       <tr>
 316         <td><p><code its:translate="no">height</code></p></td>
 317         <td><p>Heigth of label/card</p></td>
 318       </tr>
 319       <tr>
 320         <td><p><code its:translate="no">round</code></p></td>
 321         <td><p>Radius of corners.  For items with square edges (business cards),
 322                the radius should be 0.</p></td>
 323       </tr>
 324       <tr>
 325         <td><p><code its:translate="no">x_waste</code></p></td>
 326         <td><p>Amount of horizontal waste (over-print) to allow.  This is useful
 327                       for minimizing alignment problems when using non-white
 328                       backgrounds (e.g. images).</p></td>
 329       </tr>
 330       <tr>
 331         <td><p><code its:translate="no">y_waste</code></p></td>
 332         <td><p>Amount of vertical waste (over-print) to allow.  This is useful
 333                       for minimizing alignment problems when using non-white
 334                       backgrounds (e.g. images).</p></td>
 335       </tr>
 336     </table>
 337
 338     <!-- ==== Figure ==== -->
 339     <figure>
 340       <desc><span its:translate="no">Label-rectangle</span> parameters</desc>
 341       <media type="image" src="figures/glabels-template-rect-label.png" mime="image/png" style="right">
 342         <p><span its:translate="no">Label-rectangle</span> parameters</p>
 343       </media>
 344     </figure>
 345     <!-- ==== End of Figure ==== -->
 346
 347   </section>
 348   <!-- ************************** -->
 349   <!-- END Label-rectangle Node   -->
 350   <!-- ************************** -->
 351
 352
 353   <!-- ************************ -->
 354   <!-- BEGIN Label-ellipse Node -->
 355   <!-- ************************ -->
 356   <section id="template-label-ellipse-node">
 357     <title><span its:translate="no">Label-ellipse</span> Node</title>
 358
 359     <p>A <code its:translate="no">Label-ellipse</code> node describes the
 360       dimensions of a single label or business card that is elliptic
 361       in shape.</p>
 362
 363     <table frame="all" rules="rows">
 364       <tr>
 365         <td><p>Property</p></td>  <td><p>Description</p></td>
 366       </tr>
 367       <tr>
 368         <td><p></p></td>  <td><p></p></td>
 369       </tr>
 370       <tr>
 371         <td><p><code its:translate="no">id</code></p></td>
 372         <td><p>Reserved for future use.  Should always be 0.</p></td>
 373       </tr>
 374       <tr>
 375         <td><p><code its:translate="no">width</code></p></td>
 376         <td><p>Width of the ellipse</p></td>
 377       </tr>
 378       <tr>
 379         <td><p><code its:translate="no">height</code></p></td>
 380         <td><p>Heigth of the ellipse</p></td>
 381       </tr>
 382       <tr>
 383         <td><p><code its:translate="no">waste</code></p></td>
 384         <td><p>Amount of waste (over-print) to allow.  This is useful
 385             for minimizing alignment problems when using non-white
 386             backgrounds (e.g. images).</p></td>
 387       </tr>
 388     </table>
 389
 390     <!-- ==== Figure ==== -->
 391     <figure>
 392       <desc><span its:translate="no">Label-ellipse</span> parameters</desc>
 393       <media type="image" src="figures/glabels-template-ellipse-label.png" mime="image/png" style="right">
 394         <p><span its:translate="no">Label-ellipse</span> parameters</p>
 395       </media>
 396     </figure>
 397     <!-- ==== End of Figure ==== -->
 398
 399   </section>
 400   <!-- ************************ -->
 401   <!-- END Label-ellipse Node   -->
 402   <!-- ************************ -->
 403
 404
 405   <!-- ********************** -->
 406   <!-- BEGIN Label-round Node -->
 407   <!-- ********************** -->
 408   <section id="template-label-round-node">
 409     <title><span its:translate="no">Label-round</span> Node</title>
 410
 411     <p>A <code its:translate="no">Label-round</code> node describes the dimensions
 412       of a simple round label (not a CD).</p>
 413
 414     <table frame="all" rules="rows">
 415       <tr>
 416         <td><p>Property</p></td>  <td><p>Description</p></td>
 417       </tr>
 418       <tr>
 419         <td><p></p></td>  <td><p></p></td>
 420       </tr>
 421       <tr>
 422         <td><p><code its:translate="no">id</code></p></td>
 423         <td><p>Reserved for future use.  Should always be 0.</p></td>
 424       </tr>
 425       <tr>
 426         <td><p><code its:translate="no">radius</code></p></td>
 427         <td><p>Radius (1/2 diameter) of label</p></td>
 428       </tr>
 429       <tr>
 430         <td><p><code its:translate="no">waste</code></p></td>
 431         <td><p>Amount of waste (over-print) to allow.  This is useful
 432                 for minimizing alignment problems when using non-white
 433                 backgrounds (e.g. images).</p></td>
 434       </tr>
 435     </table>
 436
 437     <!-- ==== Figure ==== -->
 438     <figure>
 439       <desc><span its:translate="no">Label-ellipse</span> parameters</desc>
 440       <media type="image" src="figures/glabels-template-circle-label.png" mime="image/png" style="right">
 441         <p><span its:translate="no">Label-ellipse</span> parameters</p>
 442       </media>
 443     </figure>
 444     <!-- ==== End of Figure ==== -->
 445
 446   </section>
 447   <!-- ********************** -->
 448   <!-- END Label-round Node   -->
 449   <!-- ********************** -->
 450
 451
 452   <!-- ******************* -->
 453   <!-- BEGIN Label-cd Node -->
 454   <!-- ******************* -->
 455   <section id="template-label-cd-node">
 456     <title><span its:translate="no">Label-cd</span> Node</title>
 457
 458     <p>A <code its:translate="no">Label-cd</code> node describes the dimensions
 459       of a CD, DVD, or business card CD.</p>
 460
 461     <table frame="all" rules="rows">
 462       <tr>
 463         <td><p>Property</p></td>  <td><p>Description</p></td>
 464       </tr>
 465       <tr>
 466         <td><p></p></td>  <td><p></p></td>
 467       </tr>
 468       <tr>
 469         <td><p><code its:translate="no">id</code></p></td>
 470         <td><p>Reserved for future use.  Should always be 0.</p></td>
 471       </tr>
 472       <tr>
 473         <td><p><code its:translate="no">radius</code></p></td>
 474         <td><p>Outer radius of label</p></td>
 475       </tr>
 476       <tr>
 477         <td><p><code its:translate="no">hole</code></p></td>
 478         <td><p>Radius of concentric hole</p></td>
 479       </tr>
 480       <tr>
 481         <td><p><code its:translate="no">width</code></p></td>
 482         <td><p>If present, the label is clipped to the given width.
 483                       (Useful for "business card CDs").</p></td>
 484       </tr>
 485       <tr>
 486         <td><p><code its:translate="no">height</code></p></td>
 487         <td><p>If present, the label is clipped to the given height.
 488                       (Useful for "business card CDs").</p></td>
 489       </tr>
 490       <tr>
 491         <td><p><code its:translate="no">waste</code></p></td>
 492         <td><p>Amount of waste (over-print) to allow.  This is useful
 493                       for minimizing alignment problems when using non-white
 494                       backgrounds (e.g. images).</p></td>
 495       </tr>
 496     </table>
 497
 498     <!-- ==== Figure ==== -->
 499     <figure>
 500       <desc><span its:translate="no">Label-cd</span> parameters</desc>
 501       <media type="image" src="figures/glabels-template-cd-label.png" mime="image/png" style="right">
 502         <p>CD label parameters</p>
 503       </media>
 504     </figure>
 505     <!-- ==== End of Figure ==== -->
 506
 507   </section>
 508   <!-- ******************* -->
 509   <!-- END Label-cd Node   -->
 510   <!-- ******************* -->
 511
 512
 513   <!-- ***************** -->
 514   <!-- BEGIN Markup Node -->
 515   <!-- ***************** -->
 516   <section id="template-markup">
 517     <title><span its:translate="no">Markup</span> Nodes</title>
 518
 519     <p>Templates may contain optional markup nodes.  These nodes are used to describe
 520     a simple set of markup lines that are visible in the <app>glabels</app> drawing canvas, but
 521     not visible when printed.  These lines can represent margins, fold lines, center lines,
 522     special areas, or other helpful hints to the user of a template.</p>
 523
 524
 525     <!-- ======================== -->
 526     <!-- BEGIN Markup-margin Node -->
 527     <!-- ======================== -->
 528     <section id="template-markup-margin-node">
 529       <title><span its:translate="no">Markup-margin</span> Node</title>
 530
 531       <p>A <code its:translate="no">Markup-margin</code> describes a margin along
 532       all edges of a label.</p>
 533
 534       <table frame="all" rules="rows">
 535         <tr>
 536           <td><p>Property</p></td>  <td><p>Description</p></td>
 537         </tr>
 538         <tr>
 539           <td><p></p></td>  <td><p></p></td>
 540         </tr>
 541         <tr>
 542           <td><p><code its:translate="no">size</code></p></td>
 543           <td><p>Size of the margin.  I.e. the distance of the margin
 544                         line from the edge of the card/label.</p></td>
 545         </tr>
 546       </table>
 547     </section>
 548     <!-- ======================== -->
 549     <!-- END Markup-margin Node   -->
 550     <!-- ======================== -->
 551
 552
 553     <!-- ====================== -->
 554     <!-- BEGIN Markup-line Node -->
 555     <!-- ====================== -->
 556     <section id="template-markup-line-node">
 557       <title><span its:translate="no">Markup-line</span> Node</title>
 558
 559       <p>A <code its:translate="no">Markup-line</code> node describes a markup line.</p>
 560
 561       <table frame="all" rules="rows">
 562         <tr>
 563           <td><p>Property</p></td>  <td><p>Description</p></td>
 564         </tr>
 565         <tr>
 566           <td><p></p></td>  <td><p></p></td>
 567         </tr>
 568         <tr>
 569           <td><p><code its:translate="no">x1</code></p></td>
 570           <td><p>x coordinate of 1st endpoint of the line segment.</p></td>
 571         </tr>
 572         <tr>
 573           <td><p><code its:translate="no">y1</code></p></td>
 574           <td><p>y coordinate of 1st endpoint of the line segment.</p></td>
 575         </tr>
 576         <tr>
 577           <td><p><code its:translate="no">x2</code></p></td>
 578           <td><p>x coordinate of 2st endpoint of the line segment.</p></td>
 579         </tr>
 580         <tr>
 581           <td><p><code its:translate="no">y2</code></p></td>
 582           <td><p>y coordinate of 2st endpoint of the line segment.</p></td>
 583         </tr>
 584       </table>
 585     </section>
 586     <!-- ====================== -->
 587     <!-- END Markup-line Node   -->
 588     <!-- ====================== -->
 589
 590
 591     <!-- ======================== -->
 592     <!-- BEGIN Markup-circle Node -->
 593     <!-- ======================== -->
 594     <section id="template-markup-circle-node">
 595       <title><span its:translate="no">Markup-circle</span> Node</title>
 596
 597       <p>A <code its:translate="no">Markup-circle</code> describes a markup circle.</p>
 598
 599       <table frame="all" rules="rows">
 600         <tr>
 601           <td><p>Property</p></td>  <td><p>Description</p></td>
 602         </tr>
 603         <tr>
 604           <td><p></p></td>  <td><p></p></td>
 605         </tr>
 606         <tr>
 607           <td><p><code its:translate="no">x0</code></p></td>
 608           <td><p>x coordinate of circle origin (center).</p></td>
 609         </tr>
 610         <tr>
 611           <td><p><code its:translate="no">y0</code></p></td>
 612           <td><p>y coordinate of circle origin (center).</p></td>
 613         </tr>
 614         <tr>
 615           <td><p><code its:translate="no">radius</code></p></td>
 616           <td><p>Radius of circle.</p></td>
 617         </tr>
 618       </table>
 619     </section>
 620     <!-- ======================== -->
 621     <!-- END Markup-circle Node   -->
 622     <!-- ======================== -->
 623
 624
 625     <!-- ====================== -->
 626     <!-- BEGIN Markup-rect Node -->
 627     <!-- ====================== -->
 628     <section id="template-markup-rect-node">
 629       <title><span its:translate="no">Markup-rect</span> Node</title>
 630
 631       <p>A <code its:translate="no">Markup-rect</code> describes a markup rectangle.</p>
 632
 633       <table frame="all" rules="rows">
 634         <tr>
 635           <td><p>Property</p></td>  <td><p>Description</p></td>
 636         </tr>
 637         <tr>
 638           <td><p></p></td>  <td><p></p></td>
 639         </tr>
 640         <tr>
 641           <td><p><code its:translate="no">x1</code></p></td>
 642           <td><p>x coordinate of upper left corner of rectangle.</p></td>
 643         </tr>
 644         <tr>
 645           <td><p><code its:translate="no">y1</code></p></td>
 646           <td><p>y coordinate of upper left corner of rectangle.</p></td>
 647         </tr>
 648         <tr>
 649           <td><p><code its:translate="no">w</code></p></td>
 650           <td><p>Width of rectangle.</p></td>
 651         </tr>
 652         <tr>
 653           <td><p><code its:translate="no">h</code></p></td>
 654           <td><p>Height of rectangle.</p></td>
 655         </tr>
 656         <tr>
 657           <td><p><code its:translate="no">r</code></p></td>
 658           <td><p>Radius of rounded corners of rectangle.</p></td>
 659         </tr>
 660       </table>
 661     </section>
 662     <!-- ====================== -->
 663     <!-- END Markup-rect Node   -->
 664     <!-- ====================== -->
 665
 666
 667     <!-- ========================= -->
 668     <!-- BEGIN Markup-ellipse Node -->
 669     <!-- ========================= -->
 670     <section id="template-markup-ellipse-node">
 671       <title><span its:translate="no">Markup-ellipse</span> Node</title>
 672
 673       <p>A <code its:translate="no">Markup-ellipse</code> describes a markup ellipse.</p>
 674
 675       <table frame="all" rules="rows">
 676         <tr>
 677           <td><p>Property</p></td>  <td><p>Description</p></td>
 678         </tr>
 679         <tr>
 680           <td><p></p></td>  <td><p></p></td>
 681         </tr>
 682         <tr>
 683           <td><p><code its:translate="no">x1</code></p></td>
 684           <td><p>x coordinate of upper left corner of ellipse.</p></td>
 685         </tr>
 686         <tr>
 687           <td><p><code its:translate="no">y1</code></p></td>
 688           <td><p>y coordinate of upper left corner of ellipse.</p></td>
 689         </tr>
 690         <tr>
 691           <td><p><code its:translate="no">w</code></p></td>
 692           <td><p>Width of ellipse.</p></td>
 693         </tr>
 694         <tr>
 695           <td><p><code its:translate="no">h</code></p></td>
 696           <td><p>Height of ellipse.</p></td>
 697         </tr>
 698       </table>
 699     </section>
 700     <!-- ========================= -->
 701     <!-- END Markup-ellipse Node   -->
 702     <!-- ========================= -->
 703
 704   </section>
 705   <!-- ***************** -->
 706   <!-- END Markup Node   -->
 707   <!-- ***************** -->
 708
 709
 710   <!-- ***************** -->
 711   <!-- BEGIN Layout Node -->
 712   <!-- ***************** -->
 713   <section id="template-layout-node">
 714     <title><span its:translate="no">Layout</span> Node</title>
 715
 716     <p>A label node may contain multiple <code its:translate="no">Layout</code>
 717       children.  If labels are arranged in a simple grid pattern, only
 718       one layout is needed.  However, if labels are arranged in multiple
 719       grids, such as a running bond pattern, multiple
 720       <code its:translate="no">Layout</code> tags can be used. </p>
 721     <p>A common example for multiple layouts is a sheet with three
 722        CD labels:</p>
 723
 724     <!-- ==== Figure ==== -->
 725     <figure>
 726       <desc>CD label sheet</desc>
 727       <media type="image" src="figures/layouts-cdlabel.png" mime="image/png" style="right">
 728         <p>CD label sheet</p>
 729       </media>
 730     </figure>
 731     <!-- ==== End of Figure ==== -->
 732
 733     <p>The two labels on the left edge can be assigned to a grid, assuming we
 734        can define the coordinates for the top left label and the distance to
 735        the second label properly. The distance to the left edge is common to
 736        these labels. The third one on the right edge has no common distance
 737        values with the other ones, that's why we have to define a second layout,
 738        with unique coordinates for the top left corner of that label.</p>
 739
 740         <note style="tip">
 741         <p>You can define multiple layouts only if the labels on the sheet
 742         have the same shape. If your sheet contains different shapes, you have
 743         to define each shape in another template seperately. Future versions
 744         of <app>gLabels</app> will probably be able to concatenate such sheets
 745         with different shapes within a single template.</p>
 746       </note>
 747
 748         <note style="tip">
 749         <p>A single label can always be treated as a grid of one.</p>
 750       </note>
 751
 752     <table frame="all" rules="rows">
 753       <tr>
 754         <td><p>Property</p></td>  <td><p>Description</p></td>
 755       </tr>
 756       <tr>
 757         <td><p></p></td>  <td><p></p></td>
 758       </tr>
 759       <tr>
 760         <td><p><code its:translate="no">nx</code></p></td>
 761         <td><p>Number of labels/cards across in the grid (horizontal)</p></td>
 762       </tr>
 763       <tr>
 764         <td><p><code its:translate="no">ny</code></p></td>
 765         <td><p>Number of labels/cards across in the grid (vertical)</p></td>
 766       </tr>
 767       <tr>
 768         <td><p><code its:translate="no">x0</code></p></td>
 769         <td><p>Distance from left edge of sheet to the left edge of
 770             the left column of cards/labels in the layout.</p></td>
 771       </tr>
 772       <tr>
 773         <td><p><code its:translate="no">y0</code></p></td>
 774         <td><p>Distance from the top edge of sheet to the top edge of
 775              the top row of labels/cards in the layout.</p></td>
 776       </tr>
 777       <tr>
 778         <td><p><code its:translate="no">dx</code></p></td>
 779         <td><p>Horizontal pitch of grid.</p></td>
 780       </tr>
 781       <tr>
 782         <td><p><code its:translate="no">dy</code></p></td>
 783         <td><p>Vertical pitch of grid.</p></td>
 784       </tr>
 785     </table>
 786
 787     <!-- ==== Figure ==== -->
 788     <figure>
 789       <desc><span its:translate="no">Layout</span> parameters</desc>
 790       <media type="image" src="figures/glabels-template-layout.png" mime="image/png" style="right">
 791         <p><span its:translate="no">Layout</span> Parameters</p>
 792       </media>
 793     </figure>
 794     <!-- ==== End of Figure ==== -->
 795
 796   </section>
 797   <!-- ***************** -->
 798   <!-- END Layout Node   -->
 799   <!-- ***************** -->
 800
 801
 802 </page>