git.sur5r.net Git - glabels/blob - glabels2/help/C/glabels.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4   <!ENTITY legal SYSTEM "legal.xml">
   5   <!ENTITY appversion "2.0">
   6   <!ENTITY manrevision "1.93.2">
   7   <!ENTITY date "December 2003">
   8   <!ENTITY app "<application>gLabels</application>">
   9   <!-- Information about the entities
  10        The legal.xml file contains legal information, there is no need to edit the file.
  11        Use the appversion entity to specify the version of the application.
  12        Use the manrevision entity to specify the revision number of this manual.
  13        Use the date entity to specify the release date of this manual.
  14        Use the app entity to specify the name of the application. -->
  15 ]>
  16
  17
  18 <!--
  19       (Do not remove this comment block.)
  20   Maintained by the GNOME Documentation Project
  21   http://developer.gnome.org/projects/gdp
  22   Template version: 2.0 beta
  23   Template last modified Apr 11, 2002
  24 -->
  25
  26 <!-- =============Document Header ============================= -->
  27 <article id="index" lang="en">
  28 <!-- please do not change the id; for translations, change lang to -->
  29 <!-- appropriate code -->
  30   <articleinfo>
  31     <title>&app; Manual V&manrevision;</title>
  32
  33     <copyright>
  34       <year>2003</year>
  35       <holder>Jim Evins</holder>
  36     </copyright>
  37
  38 <!-- translators: uncomment this:
  39
  40   <copyright>
  41    <year>2002</year>
  42    <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  43   </copyright>
  44
  45    -->
  46
  47 <!-- An address can be added to the publisher information.  If a role is
  48      not specified, the publisher/author is the same for all versions of the
  49      document.  -->
  50     <publisher>
  51       <publishername> Jim Evins </publishername>
  52     </publisher>
  53
  54    &legal;
  55    <!-- This file  contains link to license for the documentation (GNU FDL), and
  56         other legal stuff such as "NO WARRANTY" statement. Please do not change
  57         any of this. -->
  58
  59     <authorgroup>
  60       <author>
  61                 <firstname>Jim</firstname>
  62                 <surname>Evins</surname>
  63       </author>
  64
  65 <!-- This is appropriate place for other contributors: translators,
  66      maintainers,  etc. Commented out by default.
  67
  68       <othercredit role="translator">
  69                 <firstname>Latin</firstname>
  70                 <surname>Translator 1</surname>
  71                 <affiliation>
  72                         <orgname>Latin Translation Team</orgname>
  73                         <address> <email>translator@gnome.org</email> </address>
  74                 </affiliation>
  75                 <contrib>Latin translation</contrib>
  76       </othercredit>
  77 -->
  78     </authorgroup>
  79
  80
  81 <!-- According to GNU FDL, revision history is mandatory if you are -->
  82 <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
  83 <!-- Remember to remove the &manrevision; entity from the revision entries other
  84 -->
  85 <!-- than the current revision. -->
  86 <!-- The revision numbering system for GNOME manuals is as follows: -->
  87 <!-- * the revision number consists of two components -->
  88 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
  89 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
  90 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
  91 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
  92 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
  93 <!-- to V3.0, and so on. -->
  94     <revhistory>
  95       <revision>
  96                 <revnumber>gLabels Manual V&manrevision;</revnumber>
  97                 <date>&date;</date>
  98                 <revdescription>
  99                         <para role="author">Jim Evins
 100                 <email>evins@snaught.com</email>
 101                         </para>
 102                         <para role="publisher">Jim Evins</para>
 103                 </revdescription>
 104       </revision>
 105     </revhistory>
 106
 107     <releaseinfo>This manual describes version &appversion; of gLabels.
 108     </releaseinfo>
 109     <legalnotice>
 110       <title>Feedback</title>
 111       <para>To report a bug or make a suggestion regarding the &app; application or
 112       this manual, follow the directions in the <ulink url="http://glabels.sourceforge.net/contact/"
 113           type="http">gLabels Contact Page</ulink>.
 114       </para>
 115 <!-- Translators may also add here feedback address for translations -->
 116     </legalnotice>
 117   </articleinfo>
 118
 119   <indexterm zone="index">
 120     <primary>gLabels</primary>
 121   </indexterm>
 122   <indexterm zone="index">
 123     <primary>glabels</primary>
 124   </indexterm>
 125
 126
 127
 128
 129 <!-- ============= Document Body ============================= -->
 130 <!-- ============= Introduction ============================== -->
 131 <!-- Use the Introduction section to give a brief overview of what
 132      the application is and what it does. -->
 133   <sect1 id="glabels-introduction">
 134     <title>Introduction</title>
 135
 136     <para>The &app; application is a lightweight program for creating labels
 137       and business cards for the <systemitem>GNOME desktop</systemitem>
 138       environment.  It is designed to work with various laser/ink-jet
 139       peel-off label and business card sheets that you'll find at most
 140       office supply stores.</para>
 141
 142   </sect1>
 143
 144
 145
 146
 147 <!-- =========== Getting Started ============================== -->
 148 <!-- Use the Getting Started section to describe the steps required
 149      to start the application and to describe the user interface components
 150      of the application. If there is other information that it is important
 151      for readers to know before they start using the application, you should
 152      also include this information here.
 153      If the information about how to get started is very short, you can
 154      include it in the Introduction and omit this section. -->
 155
 156   <sect1 id="glabels-getting-started">
 157     <title>Getting Started</title>
 158
 159     <sect2 id="glabels-start">
 160     <title>To Start &app;</title>
 161     <para>You can start <application>&app;</application> in the following ways:
 162     </para>
 163     <variablelist>
 164         <varlistentry>
 165                 <term><guimenu>Applications</guimenu> menu</term>
 166                 <listitem>
 167                 <para>Choose
 168                 <menuchoice>
 169                 <guisubmenu>Office</guisubmenu>
 170                 <guimenuitem>gLabels</guimenuitem>
 171                 </menuchoice>. </para>
 172                 </listitem>
 173         </varlistentry>
 174         <varlistentry>
 175                 <term>Command line</term>
 176                 <listitem>
 177                 <para>Type <command>glabels</command>,
 178                 then press <keycap>Return</keycap>:</para>
 179                 </listitem>
 180         </varlistentry>
 181     </variablelist>
 182     </sect2>
 183
 184     <sect2 id="glabels-when-start">
 185     <title>When You Start &app;</title>
 186     <para>When you start <application>&app;</application>, the following window is displayed.</para>
 187
 188     <!-- ==== Figure ==== -->
 189       <figure id="mainwindow-fig">
 190         <title>&app; Start Up Window</title>
 191         <screenshot>
 192           <mediaobject>
 193             <imageobject><imagedata
 194                 fileref="figures/main-window-empty.png" format="PNG"/>
 195             </imageobject>
 196           </mediaobject>
 197         </screenshot>
 198       </figure>
 199     <!-- ==== End of Figure ==== -->
 200
 201     <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
 202     <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
 203
 204     <para>The &app; window contains the following elements:
 205     </para>
 206       <variablelist>
 207         <varlistentry>
 208         <term>Menubar. </term>
 209         <listitem>
 210             <para>The menus on the menubar contain all of the commands you
 211               need to create and edit labels and business cards in
 212               <application>&app;</application>.</para>
 213         </listitem>
 214         </varlistentry>
 215         <varlistentry>
 216         <term>Main toolbar. </term>
 217         <listitem>
 218             <para>The main toolbar contains a subset of common File and Edit
 219               commands that you can access from the menubar.</para>
 220         </listitem>
 221         </varlistentry>
 222         <varlistentry>
 223         <term>Drawing toolbar. </term>
 224         <listitem>
 225             <para>The drawing toolbar contains a subset of commands for
 226               editing the current glabels document.</para>
 227         </listitem>
 228         </varlistentry>
 229         <varlistentry>
 230         <term>Display area. </term>
 231         <listitem>
 232             <para>The display area is the main drawing interface to
 233               <application>&app;</application>.</para>
 234         </listitem>
 235         </varlistentry>
 236         <varlistentry>
 237         <term>Object sidebar. </term>
 238         <listitem>
 239             <para>The object sidebar provides an interface for viewing and
 240               editing all properties of an individual object. </para>
 241         </listitem>
 242         </varlistentry>
 243         <varlistentry>
 244         <term>Properties toolbar. </term>
 245         <listitem>
 246             <para>The properties toolbar contains a set of tools to
 247               manipulate the properties of selected objects and set default
 248               properties for new objects.</para>
 249         </listitem>
 250         </varlistentry>
 251         <varlistentry>
 252         <term>Statusbar. </term>
 253         <listitem>
 254             <para>The statusbar displays information about current
 255               <application>&app;</application> activity and contextual
 256               information about the menu items. </para>
 257         </listitem>
 258         </varlistentry>
 259         </variablelist>
 260     </sect2>
 261   </sect1>
 262
 263
 264
 265
 266 <!-- ================ Usage ================================ -->
 267 <!-- Use this section to describe how to use the application to perform the tasks for
 268   which the application is designed. -->
 269   <sect1 id="glabels-usage">
 270     <title>Usage</title>
 271
 272 <!-- ============= To create a new file ============================= -->
 273     <sect2 id="glabels-open-new">
 274       <title>To Create a New Label or Card</title>
 275
 276       <para>To create a new label or business card, choose
 277         <menuchoice> <guimenu>File</guimenu> <guimenuitem>New</guimenuitem>
 278         </menuchoice>
 279         to display the <guilabel>New Label or Card</guilabel> dialog. Select
 280         the media type and orientation for the new document,
 281         then click <guibutton>OK</guibutton>. A new document is
 282         displayed in the display area of the <application>&app;</application>
 283         window. </para>
 284
 285       <para>If your particular media type is missing from this dialog,
 286         see <xref linkend="glabels-create-template"/></para>
 287
 288     </sect2>
 289
 290 <!-- ============= To Open a File ============================= -->
 291     <sect2 id="glabels-open-file">
 292       <title>To Open a File</title>
 293
 294       <para>To open a file, choose
 295         <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open</guimenuitem>
 296         </menuchoice> to display the <guilabel>Open File</guilabel> dialog.
 297         Select the file that you want to open, then click
 298         <guibutton>OK</guibutton>. The file is displayed in the display area
 299         of the <application>&app;</application> window. </para>
 300
 301       <para>You can also open multiple files in
 302         <application>&app;</application>. The application creates a separate
 303         application window for each open file.</para>
 304
 305       <para>The application records the paths and filenames of the four
 306         most recent files that you edited and displays the files as menu
 307         items on the <menuchoice>
 308         <guimenu>File</guimenu><guisubmenu>Recent Files</guisubmenu>
 309         </menuchoice> menu.</para>
 310
 311     </sect2>
 312
 313 <!-- ============= To Open Multiple Files from the Command Line ========= -->
 314     <sect2 id="glabels-run-from-cmd-line">
 315       <title>To Open Multiple Files from a Command Line</title>
 316
 317       <para>You can run <application>&app;</application> from a command line
 318         and open a single file or multiple files. To open multiple files from
 319         a command line, type the following command, then press
 320         <keycap>Return</keycap>:</para>
 321
 322       <para><command>glabels
 323       <replaceable>file1.glabels file2.glabels file3.glabels</replaceable>
 324       </command></para>
 325
 326       <para>When the application starts, the files that you specify are
 327         displayed in separate <application>&app;</application> windows.</para>
 328
 329     </sect2>
 330
 331 <!-- ============= To Save a File ========= -->
 332     <sect2 id="glabels-save-file">
 333       <title>To Save a File</title>
 334
 335       <para>You can save files in the following ways:</para>
 336
 337       <itemizedlist>
 338         <listitem>
 339
 340           <para>To save changes to an existing file, choose
 341             <menuchoice> <guimenu>File</guimenu>
 342             <guimenuitem>Save</guimenuitem> </menuchoice>. </para>
 343
 344         </listitem>
 345         <listitem>
 346
 347           <para>To save a new file or to save an existing file under a new
 348             filename, choose <menuchoice> <guimenu>File</guimenu>
 349             <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name
 350             for the file in the <guilabel>Save As</guilabel> dialog box,
 351             then click <guibutton>OK</guibutton>.</para>
 352
 353         </listitem>
 354       </itemizedlist>
 355
 356     </sect2>
 357
 358 <!-- ============= To Change Label Properties ========= -->
 359     <sect2 id="glabels-label-properties">
 360       <title>To Change Label Properties</title>
 361
 362       <para>To change the media type and/or orientation of a label, choose
 363         <menuchoice> <guimenu>File</guimenu>
 364         <guimenuitem>Properties</guimenuitem> </menuchoice> to display the
 365         <guilabel>Label properties</guilabel> dialog.  Select the
 366         new media type and orientation for the document, then click
 367         <guibutton>OK</guibutton>.</para>
 368
 369     </sect2>
 370
 371 <!-- ============= To create a custom template ======================= -->
 372     <sect2 id="glabels-create-template">
 373       <title>To Create a Custom Template</title>
 374
 375       <para>To create a new custom template, choose
 376         <menuchoice> <guimenu>File</guimenu>
 377         <guimenuitem>Template Designer ...</guimenuitem> </menuchoice>
 378         to display the <guilabel>Template Designer</guilabel> dialog.
 379         This dialog will assist you in creating a custom template for
 380         most types of label or card stationery that you may encounter.</para>
 381
 382       <para>If you prefer, you can create your templates manually.
 383         For this option see <xref linkend="glabels-manual-create-template"/>
 384       </para>
 385
 386     </sect2>
 387
 388 <!-- ============= To Close a File ========= -->
 389     <sect2 id="glabels-close-file">
 390       <title>To Close a File</title>
 391
 392       <para>To close the current document, choose
 393         <menuchoice> <guimenu>File</guimenu>
 394         <guimenuitem>Close</guimenuitem> </menuchoice> to close the application
 395         window.  If the current document is modified, a confirmation dialog
 396         will be presented, allowing you to save the document or cancel
 397         the command.  If the window being closed is the only open window,
 398         <application>&app;</application> will exit.</para>
 399
 400     </sect2>
 401
 402 <!-- ============= To Quit ========= -->
 403     <sect2 id="glabels-quit">
 404       <title>To Quit <application>&app;</application></title>
 405
 406       <para>To quit <application>&app;</application>, choose
 407         <menuchoice> <guimenu>File</guimenu>
 408         <guimenuitem>Quit</guimenuitem> </menuchoice>. This is equivalent
 409         to closing all open windows.  See
 410         <xref linkend="glabels-close-file"/>.</para>
 411
 412     </sect2>
 413
 414 <!-- ============= To Print Labels and Cards ========= -->
 415     <sect2 id="glabels-print-file">
 416       <title>To Print Labels or Cards</title>
 417
 418       <para>To print labels or cards, choose
 419         <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem>
 420         </menuchoice> to display the <guilabel>Print</guilabel> dialog.
 421         Once print options have been selected, click <guilabel>Print</guilabel>
 422         to print the labels or cards.  To simply preview the results,
 423         click <guilabel>Print Preview</guilabel> instead.</para>
 424
 425       <para>The <guilabel>Print</guilabel> dialog allows you to specify the
 426         following print options:</para>
 427
 428       <sect3 id="print-dialog-job">
 429         <title>Job Tabbed Section</title>
 430
 431         <variablelist>
 432
 433           <varlistentry>
 434             <term><guilabel>Copies (Simple only)</guilabel></term>
 435             <listitem>
 436
 437               <para>For simple labels or cards (no document merge), the job
 438                 tabbed section contains the following copy controls.</para>
 439
 440               <!-- ==== Figure ==== -->
 441               <figure id="print-copies-fig">
 442                 <title>Print Copy Controls</title>
 443                 <screenshot>
 444                   <mediaobject>
 445                     <imageobject><imagedata
 446                        fileref="figures/print-copies.png" format="PNG"/>
 447                     </imageobject>
 448                   </mediaobject>
 449                 </screenshot>
 450               </figure>
 451               <!-- ==== End of Figure ==== -->
 452
 453               <para>The number of copies of the label can be selected by
 454                 choosing the number of full sheets to print, or a specific
 455                 subset of labels on a single sheet.</para>
 456
 457               <para>The mini-preview can also be used to graphically select
 458                 the subset of labels by clicking the first label on the
 459                 mini-preview and dragging to the last label.</para>
 460
 461             </listitem>
 462           </varlistentry>
 463
 464           <varlistentry>
 465             <term><guilabel>Document Merge Control (Document merge only)</guilabel></term>
 466             <listitem>
 467
 468               <para>For labels or cards using the document merge (also known
 469                 as "mail merge") capability, the job tabbed section contains
 470                 the following merge controls instead of copy controls.</para>
 471
 472               <!-- ==== Figure ==== -->
 473               <figure id="print-merge-fig">
 474                 <title>Print Document Merge Controls</title>
 475                 <screenshot>
 476                   <mediaobject>
 477                     <imageobject><imagedata
 478                        fileref="figures/print-merge.png" format="PNG"/>
 479                     </imageobject>
 480                   </mediaobject>
 481                 </screenshot>
 482               </figure>
 483               <!-- ==== End of Figure ==== -->
 484
 485               <para>The total number of labels or cards printed is the
 486                 product of the number of records in the merge source and
 487                 the number of copies selected.  If multiple copies are
 488                 selected, these can be either collated (copies of the
 489                 same record grouped together) or un-collated (one copy
 490                 each record is printed before next copy).</para>
 491
 492               <para>Printing can begin on any label on the first sheet.
 493                 This can be selected with the <guilabel>Start on
 494                 label</guilabel> spinbutton.</para>
 495
 496               <para>The mini-preview can also be used to graphically select
 497                 this first label, by clicking on the desired label in the
 498                 mini-preview.</para>
 499
 500             </listitem>
 501           </varlistentry>
 502
 503           <varlistentry> <term><guilabel>Options</guilabel> </term>
 504             <listitem>
 505               <para>The following options can also be selected.</para>
 506               <itemizedlist>
 507                 <listitem>
 508                   <para><guilabel>print outlines</guilabel></para>
 509                   <para>Print outlines of labels.  This option is useful for
 510                     dry-runs, to test printer alignment.</para>
 511                 </listitem>
 512                 <listitem>
 513                   <para><guilabel>print in reverse</guilabel></para>
 514                   <para>Prints the labels as mirror images.  This option is
 515                     useful for printing on clear labels that will be viewed
 516                     from the reverse side (e.g. in a car window).</para>
 517                 </listitem>
 518                 <listitem>
 519                   <para><guilabel>print crop marks</guilabel></para>
 520                   <para>Prints crop marks along the edge of the sheet.
 521                     This option is useful for printing on blank stock, to
 522                     be cut after printing.  This option does not work well
 523                     with all templates.</para>
 524                 </listitem>
 525               </itemizedlist>
 526             </listitem>
 527           </varlistentry>
 528         </variablelist>
 529       </sect3>
 530
 531       <sect3 id="print-dialog-printer">
 532         <title>Printer Tabbed Section</title>
 533         <variablelist>
 534           <varlistentry> <term><guilabel>Printer</guilabel> </term>
 535             <listitem>
 536               <para>Use this drop-down list box to select the printer to
 537                 which you want to print the file.</para>
 538             </listitem>
 539           </varlistentry>
 540           <varlistentry> <term><guilabel>Settings</guilabel> </term>
 541             <listitem>
 542               <para>Use this drop-down list box to select the printer settings.
 543                 To configure the printer, click
 544                 <guibutton>Configure</guibutton>.</para>
 545             </listitem>
 546           </varlistentry>
 547           <varlistentry> <term><guilabel>Location</guilabel> </term>
 548             <listitem>
 549               <para>Use this drop-down list box to select the print
 550                 destination. To print the file to a printer, choose
 551                 <guilabel>lpr</guilabel>. To print the file to a print file,
 552                 choose <guilabel>File</guilabel>. If you select
 553                 <guilabel>File</guilabel>, type the name of the output file
 554                 in the text box provided. To print a file to a location of
 555                 your choice, choose <guilabel>Custom</guilabel>. Type the
 556                 location you want in the <guilabel>Custom</guilabel> text
 557                 box.</para>
 558             </listitem>
 559           </varlistentry>
 560         </variablelist>
 561       </sect3>
 562
 563
 564     </sect2>
 565
 566 <!-- ============= To Create New Objects ========= -->
 567     <sect2 id="glabels-new-objects">
 568       <title>To Create New Objects</title>
 569
 570       <para>Objects are created by choosing the appropriate selection under
 571         the <menuchoice> <guimenu>Objects</guimenu>
 572         <guimenuitem>Create Object</guimenuitem> </menuchoice> submenu or
 573         the <guilabel>Drawing Toolbar</guilabel>.  This will place the
 574         display area into object creation mode as indicated by its cursor.
 575         To return to the default object selection mode without creating
 576         an object, choose <menuchoice> <guimenu>Objects</guimenu>
 577         <guimenuitem>Select Mode</guimenuitem> </menuchoice>.  This will
 578         return the display area's cursor to the default selection arrow.</para>
 579
 580       <para>The following describes the object creation mode for each object
 581         type:</para>
 582
 583       <variablelist>
 584
 585         <varlistentry>
 586           <term>Text</term>
 587           <listitem>
 588             <para>Click the desired location of the upper left corner of the
 589               text object.  New text objects are initialized with the
 590               string "Text."  To change this text, or other properties, see
 591               <xref linkend="glabels-object-properties"/>.</para>
 592           </listitem>
 593         </varlistentry>
 594
 595         <varlistentry>
 596           <term>Box</term>
 597           <listitem>
 598             <para>Click the desired location of the upper left corner of the
 599               box object and drag to the desired location of the lower right
 600               corner.  If you simply click in a single location, a square
 601               box will be created. To change properties of the box object, see
 602               <xref linkend="glabels-object-properties"/>.</para>
 603           </listitem>
 604         </varlistentry>
 605
 606         <varlistentry>
 607           <term>Line</term>
 608           <listitem>
 609             <para>Click the desired location of one end of the
 610               line object and drag to the desired location of the other end.
 611               If you simply click in a single location, a diagonal line
 612               will be created. To change properties of the line object, see
 613               <xref linkend="glabels-object-properties"/>.</para>
 614           </listitem>
 615         </varlistentry>
 616
 617         <varlistentry>
 618           <term>Ellipse</term>
 619           <listitem>
 620             <para>Click the desired location of the upper left corner of the
 621               ellipse object and drag to the desired location of the lower
 622               right corner.  If you simply click in a single location, a circle
 623               will be created. To change properties of the ellipse object, see
 624               <xref linkend="glabels-object-properties"/>.</para>
 625           </listitem>
 626         </varlistentry>
 627
 628         <varlistentry>
 629           <term>Image</term>
 630           <listitem>
 631             <para>Click the desired location of the upper left corner of the
 632               image object and drag to the desired location of the lower
 633               right corner.  If you simply click in a single location, a square
 634               will be created.  New image objects are initialized with a
 635               simple checkerboard image.  To change this image, or other
 636               properties of the image object, see
 637               <xref linkend="glabels-object-properties"/>.</para>
 638           </listitem>
 639         </varlistentry>
 640
 641         <varlistentry>
 642           <term>Barcode</term>
 643           <listitem>
 644             <para>Click the desired location of the upper left corner of the
 645               barcode object.  New barcode objects are initialized to a
 646               POSTNET barcode with representative data.  To change data
 647               and properties of the barcode object, see
 648               <xref linkend="glabels-object-properties"/>.</para>
 649           </listitem>
 650         </varlistentry>
 651
 652       </variablelist>
 653
 654
 655     </sect2>
 656
 657 <!-- ============= To Select Objects ========= -->
 658     <sect2 id="glabels-select-objects">
 659       <title>To Select Objects</title>
 660
 661       <para>A prerequisite for performing operations on objects is the
 662         selection of individual objects or groups of objects.  The
 663         display area must be in the object selection mode to create new
 664         selections, as indicated by an arrow cursor.  The object
 665         selection mode is selected by the
 666         <menuchoice> <guimenu>Objects</guimenu>
 667         <guimenuitem>Select Mode</guimenuitem> </menuchoice> menu item,
 668         or the corresponding command on the <guilabel>Drawing
 669         Toolbar</guilabel>.</para>
 670
 671       <variablelist>
 672
 673         <varlistentry>
 674           <term>Selecting a single object</term>
 675           <listitem>
 676             <para>A single object can be selected simply by clicking
 677              on the desired object in the display area.
 678              Once selected the object will be highlighted with a set of
 679              resizing handles.</para>
 680           </listitem>
 681         </varlistentry>
 682
 683         <varlistentry>
 684           <term>Aggregate object selections</term>
 685           <listitem>
 686             <para>Multiple objects can be selected by first selecting the first
 687               object as above and then by holding the <keycap>Ctrl</keycap>
 688               key while selecting additional objects.
 689               Individual objects can be added to an existing selection
 690               at any time by holding the <keycap>Ctrl</keycap> key while
 691               selecting the desired objects.  All objects can also be
 692               selected by using the <menuchoice> <guimenu>Edit</guimenu>
 693               <guimenuitem>Select All</guimenuitem> </menuchoice>
 694               menu item.  All objects in an aggregate object selection will be
 695               highlighted.</para>
 696           </listitem>
 697         </varlistentry>
 698
 699         <varlistentry>
 700           <term>Area selections</term>
 701           <listitem>
 702             <para>Multiple objects can also be selected by clicking an empty
 703               area and dragging to form a rectangular area.  When released,
 704               all objects contained in the area will form an aggregate
 705               selection.  An area selection can be used to add to an existing
 706               selection by holding the <keycap>Ctrl</keycap> key while
 707               performing the selection.</para>
 708           </listitem>
 709         </varlistentry>
 710
 711         <varlistentry>
 712           <term>Unselecting objects</term>
 713           <listitem>
 714             <para>Individual objects can be removed from an existing
 715               selection by holding the <keycap>Ctrl</keycap> key while
 716               clicking on a previously selected object.  An entire selection
 717               can be dismissed by using the <menuchoice>
 718               <guimenu>Edit</guimenu> <guimenuitem>Un-select All</guimenuitem>
 719               </menuchoice> menu item
 720               or by simply clicking any empty space in the display area.
 721               Once an object is unselected its highlight is removed.</para>
 722           </listitem>
 723         </varlistentry>
 724
 725       </variablelist>
 726
 727     </sect2>
 728
 729 <!-- ============= Clipboard Commands ========= -->
 730     <sect2 id="glabels-clipboard">
 731       <title>Clipboard Commands</title>
 732
 733       <para>Object selections can be manipulated using the standard clipboard
 734         operations <guimenuitem>Cut</guimenuitem>,
 735         <guimenuitem>Copy</guimenuitem>, <guimenuitem>Paste</guimenuitem>,
 736         and <guimenuitem>Delete</guimenuitem>.</para>
 737
 738       <variablelist>
 739
 740         <varlistentry>
 741           <term>
 742             <menuchoice>
 743               <shortcut>
 744                 <keycombo><keycap>Ctrl</keycap><keycap>X</keycap></keycombo>
 745               </shortcut>
 746               <guimenuitem>Cut</guimenuitem>
 747             </menuchoice>
 748           </term>
 749           <listitem>
 750             <para>Moves selected objects to the clipboard.  The objects are
 751               then available for pasting back into the current document or
 752               another document.</para>
 753           </listitem>
 754         </varlistentry>
 755
 756         <varlistentry>
 757           <term>
 758             <menuchoice>
 759               <shortcut>
 760                 <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
 761               </shortcut>
 762               <guimenuitem>Copy</guimenuitem>
 763             </menuchoice>
 764           </term>
 765           <listitem>
 766             <para>Copies selected objects to the clipboard without deleting
 767               them.  The objects are then available for pasting back into
 768               the current document or another document.</para>
 769           </listitem>
 770         </varlistentry>
 771
 772         <varlistentry>
 773           <term>
 774             <menuchoice>
 775               <shortcut>
 776                 <keycombo><keycap>Ctrl</keycap><keycap>V</keycap></keycombo>
 777               </shortcut>
 778               <guimenuitem>Paste</guimenuitem>
 779             </menuchoice>
 780           </term>
 781           <listitem>
 782             <para>Pastes objects from the clipboard into the current document.
 783               <application>&app;</application> can only paste objects from
 784               another <application>&app;</application> document.</para>
 785           </listitem>
 786         </varlistentry>
 787
 788         <varlistentry>
 789           <term>
 790             <menuchoice>
 791               <shortcut>
 792                 <keycap>Delete</keycap>
 793               </shortcut>
 794               <guimenuitem>Delete</guimenuitem>
 795             </menuchoice>
 796           </term>
 797           <listitem>
 798             <para>Deletes selected objects without placing them on the
 799               clipboard.</para>
 800           </listitem>
 801         </varlistentry>
 802
 803       </variablelist>
 804
 805     </sect2>
 806
 807 <!-- ============= To Edit object Properties ========= -->
 808     <sect2 id="glabels-object-properties">
 809       <title>To Edit Object Properties</title>
 810
 811       <para>Most object properties can be modified through the object
 812         editor sidebar, illustrated below.  To use the object editor,
 813         a single object must first be selected.  See
 814         <xref linkend="glabels-select-objects" />.</para>
 815
 816       <!-- ==== Figure ==== -->
 817       <figure id="object-editor-sidebar-fig">
 818         <title>Object Editor Sidebar</title>
 819         <screenshot>
 820           <mediaobject>
 821             <imageobject><imagedata
 822               fileref="figures/object-editor-sidebar.png" format="PNG"/>
 823             </imageobject>
 824           </mediaobject>
 825         </screenshot>
 826       </figure>
 827       <!-- ==== End of Figure ==== -->
 828
 829       <para>The object editor will contain a subset of the following
 830         tabbed sections, depending on object type:</para>
 831
 832       <sect3 id="object-editor-text">
 833         <title>Text Tabbed Section (Text objects)</title>
 834
 835         <para>This section contains a small editor for changing the content
 836           of a text object.  It also contains a dropdown menu of available
 837           document merge keys, that can be inserted into text.</para>
 838
 839       </sect3>
 840
 841       <sect3 id="object-editor-image">
 842         <title>Image Tabbed Section (Image objecs)</title>
 843
 844         <para>This section contains a file entry with preview to select
 845           image files.  The browse button can be used to easily locate
 846           image files.  Alternatively, a document merge key can be used
 847           instead to provide a filename at print time.</para>
 848
 849       </sect3>
 850
 851       <sect3 id="object-editor-data">
 852         <title>Data Tabbed Section (Barcode objecs)</title>
 853
 854         <para>This section contains a text entry to enter literal barcode
 855           data.  Alternatively, a document merge key can be used to
 856           provide this data at print time.</para>
 857
 858       </sect3>
 859
 860       <sect3 id="object-editor-style">
 861         <title>Style Tabbed Section (Text objects)</title>
 862
 863         <para>This section contains controls to select text properties,
 864           including font family, font size, font weight, color, and
 865           text justification.</para>
 866
 867       </sect3>
 868
 869       <sect3 id="object-editor-barcode">
 870         <title>Style Tabbed Section (Barcode objecs)</title>
 871
 872         <para>This section contains controls to select barcode properties,
 873           including barcode style, color, whether to print text, and whether
 874           to include a checksum digit.</para>
 875
 876       </sect3>
 877
 878       <sect3 id="object-editor-line">
 879         <title>Line Tabbed Section</title>
 880
 881         <para>This section contains controls to select properties of lines
 882           and outlines.  These properties include line width and color.</para>
 883
 884       </sect3>
 885
 886       <sect3 id="object-editor-fill">
 887         <title>Fill Tabbed Section</title>
 888
 889         <para>This section contains controls to select fill properties of box
 890           and ellipse objects.  Currently the only fill property is fill
 891           color.</para>
 892
 893       </sect3>
 894
 895       <sect3 id="object-editor-size">
 896         <title>Size Tabbed Section (All except line objects)</title>
 897
 898         <para>This section contains controls to select the width and height
 899           of an object.  A checkbox is provided, so that the current aspect
 900           ratio can be locked while manipulating the width and height controls.
 901           Image objects also provide a button to reset the size to the
 902           image's natural size (Assumes 72DPI).</para>
 903
 904       </sect3>
 905
 906       <sect3 id="object-editor-size-line">
 907         <title>Size Tabbed Section (Line objects)</title>
 908
 909         <para>This section contains controls to select the length and angle
 910           of a line object.</para>
 911
 912       </sect3>
 913
 914       <sect3 id="object-editor-position">
 915         <title>Position Tabbed Section</title>
 916
 917         <para>This section contains controls to change the position of an
 918           object.</para>
 919
 920       </sect3>
 921
 922
 923     </sect2>
 924
 925 <!-- ============= Other Manipulations of Objects ========= -->
 926     <sect2 id="glabels-object-manipulation">
 927       <title>Other Manipulations of Objects</title>
 928
 929       <para>Objects can also be manipulated in the following ways.</para>
 930
 931       <sect3 id="other-moving-resizing">
 932         <title>Moving and Resizing Objects</title>
 933
 934         <para>Objects can be moved by simply clicking on a selected
 935           object and dragging the object to its new location.  If the object
 936           is part of an aggregate selection, all objects in the selection
 937           will move with the object being dragged, maintaining their relative
 938           positions to one another.  If no object is selected, clicking on
 939           an object will create a new selection containing that object.
 940           See <xref linkend="glabels-select-objects" />.</para>
 941
 942         <para>A selected object can be resized by clicking one of its resize
 943           handle and dragging it to obtain the new size.</para>
 944
 945       </sect3>
 946
 947       <sect3 id="other-stacking-order">
 948         <title>Changing Stacking Order</title>
 949
 950         <para>Stacking order refers to relative position in the z-axis of
 951           objects.  That is when objects overlap, which object will appear
 952           on top of the other.  By default, newer objects will appear above
 953           older objects.  To change this order, select one or more objects
 954           and choose <menuchoice> <guimenu>Objects</guimenu>
 955           <guimenuitem>Order</guimenuitem>
 956           <guimenuitem>Bring to Front</guimenuitem> </menuchoice>
 957           to raise the selection to the top of the stacking
 958           order, or choose <menuchoice> <guimenu>Objects</guimenu>
 959           <guimenuitem>Order</guimenuitem>
 960           <guimenuitem>Send to Back</guimenuitem> </menuchoice>
 961           to lower the selection to the bottom of the
 962           stacking order.  These menuitems are also available by right-clicking
 963           the display area when there is a non-empty selection.</para>
 964
 965       </sect3>
 966
 967       <sect3 id="other-rotating-flipping">
 968         <title>Rotating and Flipping Objects</title>
 969
 970         <para>Objects can be rotated 90 degrees in either direction, or flipped
 971           horizontally or vertically, by choosing the appropriate menuitem
 972           in the  <menuchoice> <guimenu>Objects</guimenu>
 973           <guimenuitem>Rotate/Flip</guimenuitem> </menuchoice> sub-menu.  These
 974           menuitems are also available by right-clicking
 975           the display area when there is a non-empty selection.</para>
 976
 977       </sect3>
 978
 979       <sect3 id="other-alignment">
 980         <title>Aligning Objects</title>
 981
 982         <para>Objects can be aligned horizontally or vertically, relative to
 983           one another, or relative to the center line of the label, by
 984           choosing the appropriate menuitem from the  <menuchoice>
 985           <guimenu>Objects</guimenu>
 986           <guimenuitem>Align Horizontal</guimenuitem>
 987           </menuchoice> or  <menuchoice> <guimenu>Objects</guimenu>
 988           <guimenuitem>Align Horizontal</guimenuitem> </menuchoice> sub-menus.
 989           These menuitems are also available by right-clicking
 990           the display area when there is a non-empty selection.</para>
 991
 992       </sect3>
 993
 994       <sect3 id="other-property-bar">
 995         <title>Using the Property Bar</title>
 996
 997         <para>The property bar can be used to change some common properties
 998           of objects en-masse.  These properties include font family, font
 999           size, font weight, text alignment, text color, fill color, line
1000           or outline color, and line width.  The property bar also controls
1001           the defaults for these properties for any newly created objects.
1002           </para>
1003
1004       </sect3>
1005
1006
1007
1008     </sect2>
1009
1010 <!-- ============= Document Merge Features ========= -->
1011     <sect2 id="glabels-merge">
1012       <title>Performing a Document Merge</title>
1013
1014       <para>Document Merge (sometimes called "Mail Merge") is a powerful
1015         feature that allows a unique label or card to be printed for each
1016         record in an external data source.</para>
1017
1018       <para>The first step to performing a document merge is to prepare
1019         a source document that contains your merge data.  This data could
1020         be mailing addresses or any other data that you wish to create
1021         unique labels or cards for.  Currently only a simple back-end
1022         for text files exists -- others are planned.  The currently
1023         supported text-file format is very simple:  each line is a record;
1024         fields are delimited by commas (CSV), tabs, or colons; and newlines
1025         can be embedded into fields by using the "\n" entity.  This file
1026         could be created using any text editor or could be created by
1027         another program or script.</para>
1028
1029       <para>A label must then be configured to "point at" this data file.
1030         To configure the merge properties of a document, choose
1031         <menuchoice> <guimenu>Objects</guimenu>
1032         <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item
1033         to display the <guilabel>merge properties</guilabel> dialog.  This
1034         dialog is used to select the exact data file format and file
1035         name (location) of the merge data.</para>
1036
1037       <para>Finally, once the label has been configured for a data file,
1038         field keys can be inserted into text objects and used as source
1039         or data for barcode objects and image filenames for image objects.
1040         See <xref linkend="glabels-object-properties" /> for more information
1041         on using merge data for these object types.</para>
1042
1043       <para>Now that your label is configured, gLabels will print a unique
1044         label for each record in your source document -- substituting fields
1045         from each record for field keys in the all text, barcode, and
1046         image objects.</para>
1047
1048     </sect2>
1049
1050
1051   </sect1>
1052
1053
1054
1055
1056   <!-- ============= Customization ============================= -->
1057   <!-- Use this section to describe how to customize the application. -->
1058   <sect1 id="glabels-prefs">
1059     <title>Settings</title>
1060     <para>To configure &app;, choose
1061       <menuchoice>
1062         <guimenu>Settings</guimenu>
1063         <guimenuitem>Preferences</guimenuitem>
1064       </menuchoice>. The
1065       <guilabel>Preferences</guilabel> dialog contains the following tabbed
1066       sections:</para>
1067     <itemizedlist>
1068       <listitem>
1069         <para>
1070           <xref linkend="glabels-prefs-locale"/></para>
1071       </listitem>
1072       <listitem>
1073         <para>
1074           <xref linkend="glabels-prefs-object-defaults"/></para>
1075       </listitem>
1076     </itemizedlist>
1077 <!-- =============== Customization Subsection ================ -->
1078 <!-- Use a new section to describe different tabbed sections on the Settings or Preferences
1079              dialog. -->
1080     <sect2 id="glabels-prefs-locale">
1081       <title>Locale</title>
1082       <variablelist>
1083         <varlistentry>
1084           <term>
1085             <guilabel>Units</guilabel> </term>
1086           <listitem>
1087             <para>Use this radio button group to specify your prefered units.
1088               Select one of the following options:</para>
1089             <itemizedlist>
1090               <listitem>
1091                 <para>
1092                   <guilabel>Points</guilabel> </para>
1093                 <para>Use points (1 point = 1/72 in = 0.352778 mm).</para>
1094               </listitem>
1095               <listitem>
1096                 <para>
1097                   <guilabel>Inches</guilabel> </para>
1098                 <para>Use inches.</para>
1099               </listitem>
1100               <listitem>
1101                 <para>
1102                   <guilabel>Millimeters</guilabel> </para>
1103                 <para>Use millimeters.</para>
1104               </listitem>
1105             </itemizedlist>
1106             <para>Default:
1107               <guilabel>Inches</guilabel>.</para>
1108           </listitem>
1109         </varlistentry>
1110         <varlistentry>
1111           <term>
1112             <guilabel>Default page size</guilabel> </term>
1113           <listitem>
1114             <para>Use this radio button group to specify your prefered page size.
1115               This will make it quicker for you to locate media types when creating a new
1116               label or card.</para>
1117             <itemizedlist>
1118               <listitem>
1119                 <para>
1120                   <guilabel>US Letter</guilabel> </para>
1121                 <para>Most of your media will be of the US Letter page size (8.5 x 11 inches).</para>
1122               </listitem>
1123               <listitem>
1124                 <para>
1125                   <guilabel>ISO A4</guilabel> </para>
1126                 <para>Most of your media will be of the ISO A4 page size (210 x 297 mm).</para>
1127               </listitem>
1128             </itemizedlist>
1129             <para>Default:
1130               <guilabel>US Letter</guilabel>.</para>
1131           </listitem>
1132         </varlistentry>
1133       </variablelist>
1134     </sect2>
1135     <!-- ============= Customization Subsection ===================== -->
1136     <!-- Another tabbed section on the Preferences dialog. -->
1137     <sect2 id="glabels-prefs-object-defaults">
1138       <title>Object defaults</title>
1139       <variablelist>
1140         <varlistentry>
1141           <term>
1142             <guilabel>Text</guilabel> </term>
1143           <listitem>
1144             <para>Use these controls to set the default properties of new text objects.
1145               These properties are</para>
1146             <itemizedlist>
1147               <listitem>
1148                 <para>
1149                   <guilabel>Font</guilabel> </para>
1150                 <para>These controls are used to select font family and font size, and
1151                   whether the font should bold or in italics.</para>
1152               </listitem>
1153               <listitem>
1154                 <para>
1155                   <guilabel>Color</guilabel> </para>
1156                 <para>This control selects the default text color.</para>
1157               </listitem>
1158               <listitem>
1159                 <para>
1160                   <guilabel>Alignment</guilabel> </para>
1161                 <para>These controls are used to select the default text alignment (left, center or right).</para>
1162               </listitem>
1163             </itemizedlist>
1164           </listitem>
1165         </varlistentry>
1166         <varlistentry>
1167           <term>
1168             <guilabel>Line</guilabel> </term>
1169           <listitem>
1170             <para>Use these controls to set the default properties of lines and outlines of
1171               new objects.  These properties are</para>
1172             <itemizedlist>
1173               <listitem>
1174                 <para>
1175                   <guilabel>Width</guilabel> </para>
1176                 <para>This control selects the default line width.</para>
1177               </listitem>
1178               <listitem>
1179                 <para>
1180                   <guilabel>Color</guilabel> </para>
1181                 <para>This control selects the default line color.</para>
1182               </listitem>
1183             </itemizedlist>
1184           </listitem>
1185         </varlistentry>
1186         <varlistentry>
1187           <term>
1188             <guilabel>Fill</guilabel> </term>
1189           <listitem>
1190             <para>Use these controls to set the default fill properties of
1191               new objects.  These properties are</para>
1192             <itemizedlist>
1193               <listitem>
1194                 <para>
1195                   <guilabel>Color</guilabel> </para>
1196                 <para>This control selects the default fill color.</para>
1197               </listitem>
1198             </itemizedlist>
1199           </listitem>
1200         </varlistentry>
1201       </variablelist>
1202     </sect2>
1203   </sect1>
1204
1205
1206
1207
1208 <!-- ============= Creating templates ================================== -->
1209   <sect1 id="glabels-manual-create-template">
1210     <title>Manually Creating New Templates</title>
1211
1212     <para>Predefined templates are defined by XML files located in
1213       <filename>${prefix}/share/glabels/</filename>,
1214       where <filename>${prefix}</filename> is usually something like
1215       <filename>/usr/local</filename> or <filename>/usr</filename> depending
1216       on the configuration option <filename>prefix</filename>.  gLabels will
1217       use all files of the form <filename>*-templates.xml</filename>
1218       or <filename>*.template</filename>, that it finds in
1219       <filename>${prefix}/share/glabels/</filename> and
1220       <filename>${HOME}/.glabels/</filename>.
1221       Additional templates can be added by creating additional
1222       <filename>*.template</filename> files in either of these directories.
1223       </para>
1224
1225     <para>The format for these files is defined in the DTD:
1226       <ulink url="http://glabels.sourceforge.net/doc/glabels-2.0.dtd.txt"
1227        type="http">glabels-2.0.dtd</ulink>. (This DTD also describes other
1228        XML formats used by glabels.)</para>
1229
1230     <sect2 id="template-assumptions">
1231       <title>Assumptions/caveats</title>
1232       <itemizedlist>
1233         <listitem>
1234           <para>A sheet contains only one size of label or card (if a sheet
1235             contains more than one size of item, it can be split into
1236              multiple templates for multiple pass printing)</para>
1237         </listitem>
1238         <listitem>
1239           <para>Distances can be expressed in units of <emphasis>pt</emphasis>,
1240             <emphasis>in</emphasis>, <emphasis>mm</emphasis>,
1241             <emphasis>cm</emphasis>, or <emphasis>pc</emphasis>.  For example:
1242             "<literal>1.0in</literal>" or "<literal>2.54cm</literal>".  If no
1243             units are specified, computer points (<emphasis>pt</emphasis>) will
1244             be assumed (1 <emphasis>pt</emphasis> =
1245             1/72 <emphasis>in</emphasis> = 0.352778 <emphasis>mm</emphasis>).
1246             </para>
1247         </listitem>
1248       </itemizedlist>
1249     </sect2>
1250
1251     <sect2 id="template-file">
1252       <title>Template Files</title>
1253
1254       <programlisting>
1255 &lt;?xml version="1.0"?&gt;
1256 &lt;Glabels-templates&gt;
1257
1258    <replaceable>...templates...</replaceable>
1259
1260 &lt;/Glabels-templates&gt;
1261       </programlisting>
1262     </sect2>
1263
1264
1265     <sect2 id="template-example">
1266       <title>Example Template</title>
1267       <programlisting>
1268   &lt;Template name="Avery 8160" size="US-Letter" description="Mailing Labels"&gt;
1269     &lt;Label-rectangle id="0" width="189" height="72" round="5"&gt;
1270       &lt;Markup-margin size="5"/&gt;
1271       &lt;Layout nx="3" ny="10" x0="11.25" y0="36" dx="200" dy="72"/&gt;
1272     &lt;/Label-rectangle&gt;
1273     &lt;Alias name="Avery 5160"/&gt;
1274     &lt;Alias name="Avery 6233"/&gt;
1275   &lt;/Template&gt;
1276       </programlisting>
1277     </sect2>
1278
1279     <sect2 id="template-template-node">
1280       <title>Template Node</title>
1281
1282       <para>A <emphasis>Template</emphasis> node describes a single stationary
1283         product.  It must contain one instance of any type of Label node
1284         (<emphasis>Label-rectangle</emphasis>,
1285         <emphasis>Label-round</emphasis>, or <emphasis>Label-cd</emphasis>).
1286         This node can be followed by zero or more
1287         <emphasis>Alias</emphasis> nodes.</para>
1288
1289       <informaltable frame="topbot">
1290         <tgroup cols="2">
1291           <colspec colname="col1"/>
1292           <colspec colname="col2"/>
1293           <thead>
1294             <row valign="top">
1295               <entry colname="col1" colsep="0" valign="top">
1296                 <para>Property</para>
1297               </entry>
1298               <entry colname="col2" valign="top">
1299                 <para>Description</para>
1300               </entry>
1301             </row>
1302           </thead>
1303           <tbody>
1304             <row valign="top">
1305               <entry><para>name</para></entry>
1306               <entry>
1307                 <para>Name or part # of stationary product.
1308                   E.g. "Avery 8160"</para>
1309               </entry>
1310             </row>
1311             <row valign="top">
1312               <entry><para>size</para></entry>
1313               <entry>
1314                 <para>Size of sheet.  E.g., "US-Letter," "A4", ...</para>
1315               </entry>
1316             </row>
1317             <row valign="top">
1318               <entry><para>description</para></entry>
1319               <entry>
1320                 <para>Description of stationary product.  E.g,
1321                    "Mailing Labels."</para>
1322               </entry>
1323             </row>
1324             <row valign="top">
1325               <entry><para>_description</para></entry>
1326               <entry>
1327                 <para>Translatable description of stationary product.
1328                   E.g, "Mailing Labels." (Only useful for predefined
1329                   templates)</para>
1330               </entry>
1331             </row>
1332             <row valign="top">
1333               <entry><para>width</para></entry>
1334               <entry>
1335                 <para>Page width.  Only valid if size="Other"</para>
1336               </entry>
1337             </row>
1338             <row valign="top">
1339               <entry><para>height</para></entry>
1340               <entry>
1341                 <para>Page height.  Only valid if size="Other"</para>
1342                </entry>
1343             </row>
1344           </tbody>
1345         </tgroup>
1346       </informaltable>
1347
1348     </sect2>
1349
1350     <sect2 id="template-label-rectangle-node">
1351       <title>Label-rectangle Node</title>
1352
1353       <para>A <emphasis>Label-rectangle</emphasis> node describes the
1354         dimensions of a single label or business card that is rectangular
1355         in shape (may have rounded edges).</para>
1356
1357       <informaltable frame="topbot">
1358         <tgroup cols="2">
1359           <colspec colname="col1"/>
1360           <colspec colname="col2"/>
1361           <thead>
1362             <row valign="top">
1363               <entry colname="col1" colsep="0" valign="top">
1364                 <para>Property</para>
1365               </entry>
1366               <entry colname="col2" valign="top">
1367                 <para>Description</para>
1368               </entry>
1369             </row>
1370           </thead>
1371           <tbody>
1372             <row valign="top">
1373               <entry><para>id</para></entry>
1374               <entry>
1375                 <para>Reserved for future use.  Should always be 0.</para>
1376               </entry>
1377             </row>
1378             <row valign="top">
1379               <entry><para>width</para></entry>
1380               <entry><para>Width of label/card</para></entry>
1381             </row>
1382             <row valign="top">
1383               <entry><para>height</para></entry>
1384               <entry><para>Height of label/card</para></entry>
1385             </row>
1386             <row valign="top">
1387               <entry><para>round</para></entry>
1388               <entry>
1389                 <para>Radius of corners.  For items with square edges
1390                   (business cards), the radius should be 0.</para>
1391               </entry>
1392             </row>
1393             <row valign="top">
1394               <entry><para>waste</para></entry>
1395               <entry>
1396                 <para>Amount of waste (over-print) to allow.  This is useful
1397                   for minimizing alignment problems when using non-white
1398                   backgrounds (e.g. images).</para>
1399               </entry>
1400             </row>
1401           </tbody>
1402         </tgroup>
1403       </informaltable>
1404
1405       <!-- ==== Figure ==== -->
1406       <figure id="template-label-fig">
1407         <title>Label-rectangle Parameters</title>
1408         <screenshot>
1409           <mediaobject>
1410             <imageobject><imagedata
1411                 fileref="figures/glabels-template-label.png" format="PNG"/>
1412             </imageobject>
1413           </mediaobject>
1414         </screenshot>
1415       </figure>
1416       <!-- ==== End of Figure ==== -->
1417
1418     </sect2>
1419
1420     <sect2 id="template-label-round-node">
1421       <title>Label-round Node</title>
1422
1423       <para>A <emphasis>Label-round</emphasis> node describes the dimensions
1424         of a simple round label (not a CD).</para>
1425
1426       <informaltable frame="topbot">
1427         <tgroup cols="2">
1428           <colspec colname="col1"/>
1429           <colspec colname="col2"/>
1430           <thead>
1431             <row valign="top">
1432               <entry colname="col1" colsep="0" valign="top">
1433                 <para>Property</para>
1434               </entry>
1435               <entry colname="col2" valign="top">
1436                 <para>Description</para>
1437               </entry>
1438             </row>
1439           </thead>
1440           <tbody>
1441             <row valign="top">
1442               <entry><para>id</para></entry>
1443               <entry>
1444                 <para>Reserved for future use.  Should always be 0.</para>
1445               </entry>
1446             </row>
1447             <row valign="top">
1448               <entry><para>radius</para></entry>
1449               <entry><para>Radius (1/2 diameter) of label</para></entry>
1450             </row>
1451             <row valign="top">
1452               <entry><para>waste</para></entry>
1453               <entry>
1454                 <para>Amount of waste (over-print) to allow.  This is useful
1455                   for minimizing alignment problems when using non-white
1456                   backgrounds (e.g. images).</para>
1457               </entry>
1458             </row>
1459           </tbody>
1460         </tgroup>
1461       </informaltable>
1462
1463     </sect2>
1464
1465     <sect2 id="template-label-cd-node">
1466       <title>Label-cd Node</title>
1467
1468       <para>A <emphasis>Label-cd</emphasis> node describes the dimensions
1469         of a CD, DVD, or business card CD.</para>
1470
1471       <informaltable frame="topbot">
1472         <tgroup cols="2">
1473           <colspec colname="col1"/>
1474           <colspec colname="col2"/>
1475           <thead>
1476             <row valign="top">
1477               <entry colname="col1" colsep="0" valign="top">
1478                 <para>Property</para>
1479               </entry>
1480               <entry colname="col2" valign="top">
1481                 <para>Description</para>
1482               </entry>
1483             </row>
1484           </thead>
1485           <tbody>
1486             <row valign="top">
1487               <entry><para>id</para></entry>
1488               <entry>
1489                 <para>Reserved for future use.  Should always be 0.</para>
1490               </entry>
1491             </row>
1492             <row valign="top">
1493               <entry><para>radius</para></entry>
1494               <entry><para>Outer radius of label</para></entry>
1495             </row>
1496             <row valign="top">
1497               <entry><para>hole</para></entry>
1498               <entry><para>Radius of concentric hole</para></entry>
1499             </row>
1500             <row valign="top">
1501               <entry><para>width</para></entry>
1502               <entry>
1503                 <para>If present, the label is clipped to the given width.
1504                   (Useful for "business card CDs").</para>
1505               </entry>
1506             </row>
1507             <row valign="top">
1508               <entry><para>height</para></entry>
1509               <entry>
1510                 <para>If present, the label is clipped to the given height.
1511                   (Useful for "business card CDs").</para>
1512               </entry>
1513             </row>
1514             <row valign="top">
1515               <entry><para>waste</para></entry>
1516               <entry>
1517                 <para>Amount of waste (over-print) to allow.  This is useful
1518                   for minimizing alignment problems when using non-white
1519                   backgrounds (e.g. images).</para>
1520               </entry>
1521             </row>
1522           </tbody>
1523         </tgroup>
1524       </informaltable>
1525
1526       <!-- ==== Figure ==== -->
1527       <figure id="template-label-cd-fig">
1528         <title>CD Label Parameters</title>
1529         <screenshot>
1530           <mediaobject>
1531             <imageobject><imagedata
1532                 fileref="figures/glabels-template-cd.png" format="PNG"/>
1533             </imageobject>
1534           </mediaobject>
1535         </screenshot>
1536       </figure>
1537       <!-- ==== End of Figure ==== -->
1538
1539     </sect2>
1540
1541     <sect2 id="template-markup-margin-node">
1542       <title>Markup-margin Node</title>
1543
1544       <para>A <emphasis>Markup-margin</emphasis> describes a margin along
1545         all edges of a label.</para>
1546
1547       <informaltable frame="topbot">
1548         <tgroup cols="2">
1549           <colspec colname="col1"/>
1550           <colspec colname="col2"/>
1551           <thead>
1552             <row valign="top">
1553               <entry colname="col1" colsep="0" valign="top">
1554                 <para>Property</para>
1555               </entry>
1556               <entry colname="col2" valign="top">
1557                 <para>Description</para>
1558               </entry>
1559             </row>
1560           </thead>
1561           <tbody>
1562             <row valign="top">
1563               <entry><para>size</para></entry>
1564               <entry>
1565                 <para>Size of the margin.  I.e. the distance of the margin
1566                   line from the edge of the card/label.</para>
1567               </entry>
1568             </row>
1569           </tbody>
1570         </tgroup>
1571       </informaltable>
1572
1573     </sect2>
1574
1575     <sect2 id="template-markup-line-node">
1576       <title>Markup-line Node</title>
1577
1578       <para>A <emphasis>Markup-line</emphasis> describes a markup line.</para>
1579
1580       <informaltable frame="topbot">
1581         <tgroup cols="2">
1582           <colspec colname="col1"/>
1583           <colspec colname="col2"/>
1584           <thead>
1585             <row valign="top">
1586               <entry colname="col1" colsep="0" valign="top">
1587                 <para>Property</para>
1588               </entry>
1589               <entry colname="col2" valign="top">
1590                 <para>Description</para>
1591               </entry>
1592             </row>
1593           </thead>
1594           <tbody>
1595             <row valign="top">
1596               <entry><para>x1</para></entry>
1597               <entry>
1598                 <para>x coordinate of 1st endpoint of the line segment.</para>
1599               </entry>
1600             </row>
1601             <row valign="top">
1602               <entry><para>y1</para></entry>
1603               <entry>
1604                 <para>y coordinate of 1st endpoint of the line segment.</para>
1605               </entry>
1606             </row>
1607             <row valign="top">
1608               <entry><para>x2</para></entry>
1609               <entry>
1610                 <para>x coordinate of 2nd endpoint of the line segment.</para>
1611               </entry>
1612             </row>
1613             <row valign="top">
1614               <entry><para>y2</para></entry>
1615               <entry>
1616                 <para>y coordinate of 2nd endpoint of the line segment.</para>
1617               </entry>
1618             </row>
1619           </tbody>
1620         </tgroup>
1621       </informaltable>
1622
1623     </sect2>
1624
1625     <sect2 id="template-markup-circle-node">
1626       <title>Markup-circle Node</title>
1627
1628       <para>A <emphasis>Markup-circle</emphasis> describes a markup circle.
1629         </para>
1630
1631       <informaltable frame="topbot">
1632         <tgroup cols="2">
1633           <colspec colname="col1"/>
1634           <colspec colname="col2"/>
1635           <thead>
1636             <row valign="top">
1637               <entry colname="col1" colsep="0" valign="top">
1638                 <para>Property</para>
1639               </entry>
1640               <entry colname="col2" valign="top">
1641                 <para>Description</para>
1642               </entry>
1643             </row>
1644           </thead>
1645           <tbody>
1646             <row valign="top">
1647               <entry><para>x0</para></entry>
1648               <entry>
1649                 <para>x coordinate of circle origin (center).</para>
1650               </entry>
1651             </row>
1652             <row valign="top">
1653               <entry><para>y0</para></entry>
1654               <entry>
1655                 <para>y coordinate of circle origin (center).</para>
1656               </entry>
1657             </row>
1658             <row valign="top">
1659               <entry><para>radius</para></entry>
1660               <entry><para>Radius of circle.</para></entry>
1661             </row>
1662           </tbody>
1663         </tgroup>
1664       </informaltable>
1665
1666     </sect2>
1667
1668     <sect2 id="template-layout-node">
1669       <title>Layout Node</title>
1670
1671       <para>A label node may contain multiple <emphasis>Layout</emphasis>
1672         children.  If labels are arranged in a simple grid pattern, only
1673         one layout is needed.  However, if labels are arranged in multiple
1674         grids, such as a running bond pattern, multiple
1675         <emphasis>layout</emphasis> tags can be used.  Note: a single label
1676         can always be treated as a grid of one.</para>
1677
1678       <informaltable frame="topbot">
1679         <tgroup cols="2">
1680           <colspec colname="col1"/>
1681           <colspec colname="col2"/>
1682           <thead>
1683             <row valign="top">
1684               <entry colname="col1" colsep="0" valign="top">
1685                 <para>Property</para>
1686               </entry>
1687               <entry colname="col2" valign="top">
1688                 <para>Description</para>
1689               </entry>
1690             </row>
1691           </thead>
1692           <tbody>
1693             <row valign="top">
1694               <entry><para>nx</para></entry>
1695               <entry>
1696                 <para>Number of labels/cards across in the grid
1697                   (horizontal)</para>
1698               </entry>
1699             </row>
1700             <row valign="top">
1701               <entry><para>ny</para></entry>
1702               <entry>
1703                 <para>Number of labels/cards up and down in the grid
1704                   (vertical)</para>
1705               </entry>
1706             </row>
1707             <row valign="top">
1708               <entry><para>x0</para></entry>
1709               <entry>
1710                 <para>Distance from left edge of sheet to the left edge of
1711                   the left column of cards/labels in the layout.</para>
1712               </entry>
1713             </row>
1714             <row valign="top">
1715               <entry><para>y0</para></entry>
1716               <entry>
1717                 <para>Distance from the top edge of sheet to the top edge of
1718                   the top row of labels/cards in the layout.</para>
1719               </entry>
1720             </row>
1721             <row valign="top">
1722               <entry><para>dx</para></entry>
1723               <entry><para>Horizontal pitch of grid.</para></entry>
1724             </row>
1725             <row valign="top">
1726               <entry><para>dy</para></entry>
1727               <entry><para>Vertical pitch of grid.</para></entry>
1728             </row>
1729           </tbody>
1730         </tgroup>
1731       </informaltable>
1732
1733       <!-- ==== Figure ==== -->
1734       <figure id="template-layout-fig">
1735         <title>Layout Parameters</title>
1736         <screenshot>
1737           <mediaobject>
1738             <imageobject><imagedata
1739                 fileref="figures/glabels-template-layout.png" format="PNG"/>
1740             </imageobject>
1741           </mediaobject>
1742         </screenshot>
1743       </figure>
1744       <!-- ==== End of Figure ==== -->
1745
1746     </sect2>
1747
1748     <sect2 id="template-alias-node">
1749       <title>Alias Node</title>
1750
1751       <para>An <emphasis>Alias</emphasis> node provides the name of a
1752         product with the same size and layout characteristics as the
1753         parent template.</para>
1754
1755       <informaltable frame="topbot">
1756         <tgroup cols="2">
1757           <colspec colname="col1"/>
1758           <colspec colname="col2"/>
1759           <thead>
1760             <row valign="top">
1761               <entry colname="col1" colsep="0" valign="top">
1762                 <para>Property</para>
1763               </entry>
1764               <entry colname="col2" valign="top">
1765                 <para>Description</para>
1766               </entry>
1767             </row>
1768           </thead>
1769           <tbody>
1770             <row valign="top">
1771               <entry><para>name</para></entry>
1772               <entry>
1773                 <para>The name or part # of a product with the same size and
1774                   layout characteristics.</para>
1775               </entry>
1776             </row>
1777           </tbody>
1778         </tgroup>
1779       </informaltable>
1780
1781       </sect2>
1782
1783   </sect1>
1784
1785
1786
1787
1788 <!-- ============= Bugs ================================== -->
1789 <!-- This section is optional and is commented out by default.
1790      You can use it to describe known bugs and limitations of the
1791           program if there are any - please be frank and list all
1792      problems you know of.
1793
1794   <sect1 id="mayapp-bugs">
1795   <title>Known Bugs and Limitations</title>
1796   <para> </para>
1797  </sect1>
1798 -->
1799
1800
1801
1802
1803 <!-- ============= About ================================== -->
1804 <!-- This section contains info about the program (not docs), such as
1805       author's name(s), web page, license, feedback address. This
1806       section is optional: primary place for this info is "About.." box of
1807       the program. However, if you do wish to include this info in the
1808       manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
1809   <sect1 id="glabels-about">
1810     <title>About &app;</title>
1811     <para> &app; was written by Jim Evins
1812       (<email>evins@snaught.com</email>). To find more information about
1813       &app;, please visit the
1814       <ulink url="http://glabels.sourceforge.net" type="http">gLabels Web
1815         page</ulink>. </para>
1816     <para>
1817       To report a bug or make a suggestion regarding this application or
1818       this manual, follow the directions at the
1819       <ulink url="http://glabels.sourceforge.net/contact/" type="http">gLabels Contact Page</ulink>.
1820     </para>
1821
1822     <para> This program is distributed under the terms of the GNU
1823       General Public license as published by the Free Software
1824       Foundation; either version 2 of the License, or (at your option)
1825       any later version. A copy of this license can be found at this
1826       <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
1827       COPYING included with the source code of this program. </para>
1828
1829   </sect1>
1830
1831
1832
1833
1834
1835 </article>