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

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