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.2">
6 <!ENTITY manrevision "2.2">
7 <!ENTITY date "December 2007">
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. -->
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
26 <!-- =============Document Header ============================= -->
27 <article id="index" lang="en">
28 <!-- please do not change the id; for translations, change lang to -->
29 <!-- appropriate code -->
31 <title>&app; Manual V&manrevision;</title>
32 <abstract role="description">
34 User manual for the gLabels label and business card creation program
38 <year>2003-2007</year>
39 <holder>Jim Evins</holder>
42 <publishername> Jim Evins </publishername>
46 <!-- This file contains link to license for the documentation (GNU FDL), and
47 other legal stuff such as "NO WARRANTY" statement. Please do not change
51 <author role="maintainer">
52 <firstname>Jim</firstname>
53 <surname>Evins</surname>
56 <!-- This is appropriate place for other contributors: translators,
57 maintainers, etc. Commented out by default.
59 <othercredit role="translator">
60 <firstname>Latin</firstname>
61 <surname>Translator 1</surname>
63 <orgname>Latin Translation Team</orgname>
64 <address> <email>translator@gnome.org</email> </address>
66 <contrib>Latin translation</contrib>
72 <!-- According to GNU FDL, revision history is mandatory if you are -->
73 <!-- modifying/reusing someone else's document. If not, you can omit it. -->
74 <!-- Remember to remove the &manrevision; entity from the revision entries other
76 <!-- than the current revision. -->
77 <!-- The revision numbering system for GNOME manuals is as follows: -->
78 <!-- * the revision number consists of two components -->
79 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
80 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
81 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
82 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
83 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
84 <!-- to V3.0, and so on. -->
87 <revnumber>gLabels Manual V&manrevision;</revnumber>
90 <para role="author">Jim Evins
91 <email>evins@snaught.com</email>
93 <para role="publisher">Jim Evins</para>
98 <releaseinfo>This manual describes version &appversion; of gLabels.
101 <title>Feedback</title>
102 <para>To report a bug or make a suggestion regarding the &app; application or
103 this manual, follow the directions in the <ulink url="http://glabels.sourceforge.net/contact/"
104 type="http">gLabels Contact Page</ulink>.
106 <!-- Translators may also add here feedback address for translations -->
110 <indexterm zone="index">
111 <primary>gLabels</primary>
113 <indexterm zone="index">
114 <primary>glabels</primary>
120 <!-- ============= Document Body ============================= -->
121 <!-- ============= Introduction ============================== -->
122 <!-- Use the Introduction section to give a brief overview of what
123 the application is and what it does. -->
124 <sect1 id="glabels-introduction">
125 <title>Introduction</title>
127 <para>The &app; application is a lightweight program for creating labels
128 and business cards for the <systemitem>GNOME desktop</systemitem>
129 environment. It is designed to work with various laser/ink-jet
130 peel-off label and business card sheets that you'll find at most
131 office supply stores.</para>
138 <!-- =========== Getting Started ============================== -->
139 <!-- Use the Getting Started section to describe the steps required
140 to start the application and to describe the user interface components
141 of the application. If there is other information that it is important
142 for readers to know before they start using the application, you should
143 also include this information here.
144 If the information about how to get started is very short, you can
145 include it in the Introduction and omit this section. -->
147 <sect1 id="glabels-getting-started">
148 <title>Getting Started</title>
150 <sect2 id="glabels-start">
151 <title>To Start &app;</title>
152 <para>You can start <application>&app;</application> in the following ways:
156 <term><guimenu>Applications</guimenu> menu</term>
160 <guisubmenu>Office</guisubmenu>
161 <guimenuitem>gLabels</guimenuitem>
162 </menuchoice>. </para>
166 <term>Command line</term>
168 <para>Type <command>glabels</command>,
169 then press <keycap>Return</keycap>:</para>
175 <sect2 id="glabels-when-start">
176 <title>When You Start &app;</title>
177 <para>When you start <application>&app;</application>, the following window is displayed.</para>
179 <!-- ==== Figure ==== -->
180 <figure id="mainwindow-fig">
181 <title>&app; Start Up Window</title>
184 <imageobject><imagedata
185 fileref="figures/main-window-empty.png" format="PNG"/>
190 <!-- ==== End of Figure ==== -->
192 <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
193 <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
195 <para>The &app; window contains the following elements:
199 <term>Menubar. </term>
201 <para>The menus on the menubar contain all of the commands you
202 need to create and edit labels and business cards in
203 <application>&app;</application>.</para>
207 <term>Main toolbar. </term>
209 <para>The main toolbar contains a subset of common File and Edit
210 commands that you can access from the menubar.</para>
214 <term>Drawing toolbar. </term>
216 <para>The drawing toolbar contains a subset of commands for
217 editing the current glabels document.</para>
221 <term>Display area. </term>
223 <para>The display area is the main drawing interface to
224 <application>&app;</application>.</para>
228 <term>Object sidebar. </term>
230 <para>The object sidebar provides an interface for viewing and
231 editing all properties of an individual object. </para>
235 <term>Properties toolbar. </term>
237 <para>The properties toolbar contains a set of tools to
238 manipulate the properties of selected objects and set default
239 properties for new objects.</para>
243 <term>Statusbar. </term>
245 <para>The statusbar displays information about current
246 <application>&app;</application> activity and contextual
247 information about the menu items. </para>
257 <!-- ================ Usage ================================ -->
258 <!-- Use this section to describe how to use the application to perform the tasks for
259 which the application is designed. -->
260 <sect1 id="glabels-usage">
263 <!-- ============= To create a new file ============================= -->
264 <sect2 id="glabels-open-new">
265 <title>To Create a New Label or Card</title>
267 <para>To create a new label or business card, choose
268 <menuchoice> <guimenu>File</guimenu> <guimenuitem>New</guimenuitem>
270 to display the <guilabel>New Label or Card</guilabel> dialog. Select
271 the media type and orientation for the new document,
272 then click <guibutton>OK</guibutton>. A new document is
273 displayed in the display area of the <application>&app;</application>
276 <para>If your particular media type is missing from this dialog,
277 see <xref linkend="glabels-create-template"/></para>
281 <!-- ============= To Open a File ============================= -->
282 <sect2 id="glabels-open-file">
283 <title>To Open a File</title>
285 <para>To open a file, choose
286 <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open</guimenuitem>
287 </menuchoice> to display the <guilabel>Open File</guilabel> dialog.
288 Select the file that you want to open, then click
289 <guibutton>OK</guibutton>. The file is displayed in the display area
290 of the <application>&app;</application> window. </para>
292 <para>You can also open multiple files in
293 <application>&app;</application>. The application creates a separate
294 application window for each open file.</para>
296 <para>The application records the paths and filenames of the
297 most recent files that you have edited and displays the files as menu
298 items on the <menuchoice>
299 <guimenu>File</guimenu><guisubmenu>Recent Files</guisubmenu>
300 </menuchoice> menu.</para>
304 <!-- ============= To Open Multiple Files from the Command Line ========= -->
305 <sect2 id="glabels-run-from-cmd-line">
306 <title>To Open Multiple Files from a Command Line</title>
308 <para>You can run <application>&app;</application> from a command line
309 and open a single file or multiple files. To open multiple files from
310 a command line, type the following command, then press
311 <keycap>Return</keycap>:</para>
313 <para><command>glabels
314 <replaceable>file1.glabels file2.glabels file3.glabels</replaceable>
317 <para>When the application starts, the files that you specify are
318 displayed in separate <application>&app;</application> windows.</para>
322 <!-- ============= To Save a File ========= -->
323 <sect2 id="glabels-save-file">
324 <title>To Save a File</title>
326 <para>You can save files in the following ways:</para>
331 <para>To save changes to an existing file, choose
332 <menuchoice> <guimenu>File</guimenu>
333 <guimenuitem>Save</guimenuitem> </menuchoice>. </para>
338 <para>To save a new file or to save an existing file under a new
339 filename, choose <menuchoice> <guimenu>File</guimenu>
340 <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name
341 for the file in the <guilabel>Save As</guilabel> dialog box,
342 then click <guibutton>OK</guibutton>.</para>
349 <!-- ============= To Change Label Properties ========= -->
350 <sect2 id="glabels-label-properties">
351 <title>To Change Label Properties</title>
353 <para>To change the media type and/or orientation of a label, choose
354 <menuchoice> <guimenu>File</guimenu>
355 <guimenuitem>Properties</guimenuitem> </menuchoice> to display the
356 <guilabel>Label properties</guilabel> dialog. Select the
357 new media type and orientation for the document, then click
358 <guibutton>OK</guibutton>.</para>
362 <!-- ============= To create a custom template ======================= -->
363 <sect2 id="glabels-create-template">
364 <title>To Create a Custom Template</title>
366 <para>To create a new custom template, choose
367 <menuchoice> <guimenu>File</guimenu>
368 <guimenuitem>Template Designer ...</guimenuitem> </menuchoice>
369 to display the <guilabel>Template Designer</guilabel> dialog.
370 This dialog will assist you in creating a custom template for
371 most types of label or card stationery that you may encounter.</para>
373 <para>If you prefer, you can create your templates manually.
374 For this option see <xref linkend="glabels-manual-create-template"/>
379 <!-- ============= To Close a File ========= -->
380 <sect2 id="glabels-close-file">
381 <title>To Close a File</title>
383 <para>To close the current document, choose
384 <menuchoice> <guimenu>File</guimenu>
385 <guimenuitem>Close</guimenuitem> </menuchoice> to close the application
386 window. If the current document is modified, a confirmation dialog
387 will be presented, allowing you to save the document or cancel
388 the command. If the window being closed is the only open window,
389 <application>&app;</application> will exit.</para>
393 <!-- ============= To Quit ========= -->
394 <sect2 id="glabels-quit">
395 <title>To Quit <application>&app;</application></title>
397 <para>To quit <application>&app;</application>, choose
398 <menuchoice> <guimenu>File</guimenu>
399 <guimenuitem>Quit</guimenuitem> </menuchoice>. This is equivalent
400 to closing all open windows. See
401 <xref linkend="glabels-close-file"/>.</para>
405 <!-- ============= To Print Labels and Cards ========= -->
406 <sect2 id="glabels-print-file">
407 <title>To Print Labels or Cards</title>
409 <para>To print labels or cards, choose
410 <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem>
411 </menuchoice> to display the <guilabel>Print</guilabel> dialog.
412 Once print options have been selected, click <guilabel>Print</guilabel>
413 to print the labels or cards. To simply preview the results,
414 click <guilabel>Print Preview</guilabel> instead.</para>
416 <para>The <guilabel>Print</guilabel> dialog allows you to specify the
417 following print options:</para>
419 <sect3 id="print-dialog-job">
420 <title>The Labels Tab of the Print Dialog</title>
425 <term><guilabel>Print control (Simple)</guilabel></term>
428 <para>For simple labels or cards (no document merge), the job
429 tabbed section contains the following copy controls.</para>
431 <!-- ==== Figure ==== -->
432 <figure id="print-copies-fig">
433 <title>Print Copy Controls</title>
436 <imageobject><imagedata
437 fileref="figures/print-copies.png" format="PNG"/>
442 <!-- ==== End of Figure ==== -->
444 <para>The number of copies of the label can be selected by
445 choosing the number of full sheets to print, or a specific
446 subset of labels on a single sheet.</para>
448 <para>The mini-preview can also be used to graphically select
449 the subset of labels by clicking the first label on the
450 mini-preview and dragging to the last label.</para>
456 <term><guilabel>Print control (Merge)</guilabel></term>
459 <para>For labels or cards using the document merge (also known
460 as "mail merge") capability, the job tabbed section contains
461 the following merge controls instead of copy controls.</para>
463 <!-- ==== Figure ==== -->
464 <figure id="print-merge-fig">
465 <title>Print Document Merge Controls</title>
468 <imageobject><imagedata
469 fileref="figures/print-merge.png" format="PNG"/>
474 <!-- ==== End of Figure ==== -->
476 <para>The total number of labels or cards printed is the
477 product of the number of records in the merge source and
478 the number of copies selected. If multiple copies are
479 selected, these can be either collated (copies of the
480 same record grouped together) or un-collated (one copy
481 each record is printed before next copy).</para>
483 <para>Printing can begin on any label on the first sheet.
484 This can be selected with the <guilabel>Start on
485 label</guilabel> spinbutton.</para>
487 <para>The mini-preview can also be used to graphically select
488 this first label, by clicking on the desired label in the
494 <varlistentry> <term><guilabel>Options</guilabel> </term>
496 <para>The following options can also be selected.</para>
499 <para><guilabel>print outlines</guilabel></para>
500 <para>Print outlines of labels. This option is useful for
501 dry-runs, to test printer alignment.</para>
504 <para><guilabel>print in reverse</guilabel></para>
505 <para>Prints the labels as mirror images. This option is
506 useful for printing on clear labels that will be viewed
507 from the reverse side (e.g. in a car window).</para>
510 <para><guilabel>print crop marks</guilabel></para>
511 <para>Prints crop marks along the edge of the sheet.
512 This option is useful for printing on blank stock, to
513 be cut after printing. This option does not work well
514 with all templates.</para>
524 <!-- ============= To Create New Objects ========= -->
525 <sect2 id="glabels-new-objects">
526 <title>To Create New Objects</title>
528 <para>Objects are created by choosing the appropriate selection under
529 the <menuchoice> <guimenu>Objects</guimenu>
530 <guimenuitem>Create Object</guimenuitem> </menuchoice> submenu or
531 the <guilabel>Drawing Toolbar</guilabel>. This will place the
532 display area into object creation mode as indicated by its cursor.
533 To return to the default object selection mode without creating
534 an object, choose <menuchoice> <guimenu>Objects</guimenu>
535 <guimenuitem>Select Mode</guimenuitem> </menuchoice>. This will
536 return the display area's cursor to the default selection arrow.</para>
538 <para>The following describes the object creation mode for each object
546 <para>Click the desired location of the upper left corner of the
547 text object. New text objects are initialized with the
548 string "Text." To change this text, or other properties, see
549 <xref linkend="glabels-object-properties"/>.</para>
556 <para>Click the desired location of the upper left corner of the
557 box object and drag to the desired location of the lower right
558 corner. If you simply click in a single location, a square
559 box will be created. To change properties of the box object, see
560 <xref linkend="glabels-object-properties"/>.</para>
567 <para>Click the desired location of one end of the
568 line object and drag to the desired location of the other end.
569 If you simply click in a single location, a diagonal line
570 will be created. To change properties of the line object, see
571 <xref linkend="glabels-object-properties"/>.</para>
578 <para>Click the desired location of the upper left corner of the
579 ellipse object and drag to the desired location of the lower
580 right corner. If you simply click in a single location, a circle
581 will be created. To change properties of the ellipse object, see
582 <xref linkend="glabels-object-properties"/>.</para>
589 <para>Click the desired location of the upper left corner of the
590 image object and drag to the desired location of the lower
591 right corner. If you simply click in a single location, a square
592 will be created. New image objects are initialized with a
593 simple checkerboard image. To change this image, or other
594 properties of the image object, see
595 <xref linkend="glabels-object-properties"/>.</para>
602 <para>Click the desired location of the upper left corner of the
603 barcode object. New barcode objects are initialized to a
604 POSTNET barcode with representative data. To change data
605 and properties of the barcode object, see
606 <xref linkend="glabels-object-properties"/>.</para>
615 <!-- ============= To Select Objects ========= -->
616 <sect2 id="glabels-select-objects">
617 <title>To Select Objects</title>
619 <para>A prerequisite for performing operations on objects is the
620 selection of individual objects or groups of objects. The
621 display area must be in the object selection mode to create new
622 selections, as indicated by an arrow cursor. The object
623 selection mode is selected by the
624 <menuchoice> <guimenu>Objects</guimenu>
625 <guimenuitem>Select Mode</guimenuitem> </menuchoice> menu item,
626 or the corresponding command on the <guilabel>Drawing
627 Toolbar</guilabel>.</para>
632 <term>Selecting a single object</term>
634 <para>A single object can be selected simply by clicking
635 on the desired object in the display area.
636 Once selected the object will be highlighted with a set of
637 resizing handles.</para>
642 <term>Aggregate object selections</term>
644 <para>Multiple objects can be selected by first selecting the first
645 object as above and then by holding the <keycap>Ctrl</keycap>
646 key while selecting additional objects.
647 Individual objects can be added to an existing selection
648 at any time by holding the <keycap>Ctrl</keycap> key while
649 selecting the desired objects. All objects can also be
650 selected by using the <menuchoice> <guimenu>Edit</guimenu>
651 <guimenuitem>Select All</guimenuitem> </menuchoice>
652 menu item. All objects in an aggregate object selection will be
658 <term>Area selections</term>
660 <para>Multiple objects can also be selected by clicking an empty
661 area and dragging to form a rectangular area. When released,
662 all objects contained in the area will form an aggregate
663 selection. An area selection can be used to add to an existing
664 selection by holding the <keycap>Ctrl</keycap> key while
665 performing the selection.</para>
670 <term>Unselecting objects</term>
672 <para>Individual objects can be removed from an existing
673 selection by holding the <keycap>Ctrl</keycap> key while
674 clicking on a previously selected object. An entire selection
675 can be dismissed by using the <menuchoice>
676 <guimenu>Edit</guimenu> <guimenuitem>Un-select All</guimenuitem>
677 </menuchoice> menu item
678 or by simply clicking any empty space in the display area.
679 Once an object is unselected its highlight is removed.</para>
687 <!-- ============= Clipboard Commands ========= -->
688 <sect2 id="glabels-clipboard">
689 <title>Clipboard Commands</title>
691 <para>Object selections can be manipulated using the standard clipboard
692 operations <guimenuitem>Cut</guimenuitem>,
693 <guimenuitem>Copy</guimenuitem>, <guimenuitem>Paste</guimenuitem>,
694 and <guimenuitem>Delete</guimenuitem>.</para>
702 <keycombo><keycap>Ctrl</keycap><keycap>X</keycap></keycombo>
704 <guimenuitem>Cut</guimenuitem>
708 <para>Moves selected objects to the clipboard. The objects are
709 then available for pasting back into the current document or
710 another document.</para>
718 <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
720 <guimenuitem>Copy</guimenuitem>
724 <para>Copies selected objects to the clipboard without deleting
725 them. The objects are then available for pasting back into
726 the current document or another document.</para>
734 <keycombo><keycap>Ctrl</keycap><keycap>V</keycap></keycombo>
736 <guimenuitem>Paste</guimenuitem>
740 <para>Pastes objects from the clipboard into the current document.
741 <application>&app;</application> can only paste objects from
742 another <application>&app;</application> document.</para>
750 <keycap>Delete</keycap>
752 <guimenuitem>Delete</guimenuitem>
756 <para>Deletes selected objects without placing them on the
765 <!-- ============= To Edit object Properties ========= -->
766 <sect2 id="glabels-object-properties">
767 <title>To Edit Object Properties</title>
769 <para>Most object properties can be modified through the object
770 editor sidebar, illustrated below. To use the object editor,
771 a single object must first be selected. See
772 <xref linkend="glabels-select-objects" />.</para>
774 <!-- ==== Figure ==== -->
775 <figure id="object-editor-sidebar-fig">
776 <title>Object Editor Sidebar</title>
779 <imageobject><imagedata
780 fileref="figures/object-editor-sidebar.png" format="PNG"/>
785 <!-- ==== End of Figure ==== -->
787 <para>The object editor will contain a subset of the following
788 tabbed sections, depending on object type:</para>
790 <sect3 id="object-editor-text">
791 <title>Text Tabbed Section (Text objects)</title>
793 <para>This section contains a small editor for changing the content
794 of a text object. It also contains a dropdown menu of available
795 document merge keys, that can be inserted into text.</para>
799 <sect3 id="object-editor-image">
800 <title>Image Tabbed Section (Image objecs)</title>
802 <para>This section contains a file entry with preview to select
803 image files. The browse button can be used to easily locate
804 image files. Alternatively, a document merge key can be used
805 instead to provide a filename at print time.</para>
809 <sect3 id="object-editor-data">
810 <title>Data Tabbed Section (Barcode objecs)</title>
812 <para>This section contains a text entry to enter literal barcode
813 data. Alternatively, a document merge key can be used to
814 provide this data at print time.</para>
818 <sect3 id="object-editor-style">
819 <title>Style Tabbed Section (Text objects)</title>
821 <para>This section contains controls to select text properties,
822 including font family, font size, font weight, color, and
823 text justification.</para>
827 <sect3 id="object-editor-barcode">
828 <title>Style Tabbed Section (Barcode objecs)</title>
830 <para>This section contains controls to select barcode properties,
831 including barcode style, color, whether to print text, and whether
832 to include a checksum digit.</para>
836 <sect3 id="object-editor-line">
837 <title>Line Tabbed Section</title>
839 <para>This section contains controls to select properties of lines
840 and outlines. These properties include line width and color.</para>
844 <sect3 id="object-editor-fill">
845 <title>Fill Tabbed Section</title>
847 <para>This section contains controls to select fill properties of box
848 and ellipse objects. Currently the only fill property is fill
853 <sect3 id="object-editor-size">
854 <title>Size Tabbed Section (All except line objects)</title>
856 <para>This section contains controls to select the width and height
857 of an object. A checkbox is provided, so that the current aspect
858 ratio can be locked while manipulating the width and height controls.
859 Image objects also provide a button to reset the size to the
860 image's natural size (Assumes 72DPI).</para>
864 <sect3 id="object-editor-size-line">
865 <title>Size Tabbed Section (Line objects)</title>
867 <para>This section contains controls to select the length and angle
868 of a line object.</para>
872 <sect3 id="object-editor-position">
873 <title>Position Tabbed Section</title>
875 <para>This section contains controls to change the position of an
881 <sect3 id="object-editor-shadow">
882 <title>Shadow Tabbed Section (All except image and barcode objects)</title>
884 <para>This section contains controls to add a shadow to an object.</para>
891 <!-- ============= Other Manipulations of Objects ========= -->
892 <sect2 id="glabels-object-manipulation">
893 <title>Other Manipulations of Objects</title>
895 <para>Objects can also be manipulated in the following ways.</para>
897 <sect3 id="other-moving-resizing">
898 <title>Moving and Resizing Objects</title>
900 <para>Objects can be moved by simply clicking on a selected
901 object and dragging the object to its new location. If the object
902 is part of an aggregate selection, all objects in the selection
903 will move with the object being dragged, maintaining their relative
904 positions to one another. If no object is selected, clicking on
905 an object will create a new selection containing that object.
906 See <xref linkend="glabels-select-objects" />.</para>
908 <para>A selected object can be resized by clicking one of its resize
909 handle and dragging it to obtain the new size.</para>
913 <sect3 id="other-stacking-order">
914 <title>Changing Stacking Order</title>
916 <para>Stacking order refers to relative position in the z-axis of
917 objects. That is when objects overlap, which object will appear
918 on top of the other. By default, newer objects will appear above
919 older objects. To change this order, select one or more objects
920 and choose <menuchoice> <guimenu>Objects</guimenu>
921 <guimenuitem>Order</guimenuitem>
922 <guimenuitem>Bring to Front</guimenuitem> </menuchoice>
923 to raise the selection to the top of the stacking
924 order, or choose <menuchoice> <guimenu>Objects</guimenu>
925 <guimenuitem>Order</guimenuitem>
926 <guimenuitem>Send to Back</guimenuitem> </menuchoice>
927 to lower the selection to the bottom of the
928 stacking order. These menuitems are also available by right-clicking
929 the display area when there is a non-empty selection.</para>
933 <sect3 id="other-rotating-flipping">
934 <title>Rotating and Flipping Objects</title>
936 <para>Objects can be rotated 90 degrees in either direction, or flipped
937 horizontally or vertically, by choosing the appropriate menuitem
938 in the <menuchoice> <guimenu>Objects</guimenu>
939 <guimenuitem>Rotate/Flip</guimenuitem> </menuchoice> sub-menu. These
940 menuitems are also available by right-clicking
941 the display area when there is a non-empty selection.</para>
945 <sect3 id="other-alignment">
946 <title>Aligning Objects</title>
948 <para>Objects can be aligned horizontally or vertically, relative to
949 one another, or relative to the center line of the label, by
950 choosing the appropriate menuitem from the <menuchoice>
951 <guimenu>Objects</guimenu>
952 <guimenuitem>Align Horizontal</guimenuitem>
953 </menuchoice> or <menuchoice> <guimenu>Objects</guimenu>
954 <guimenuitem>Align Horizontal</guimenuitem> </menuchoice> sub-menus.
955 These menuitems are also available by right-clicking
956 the display area when there is a non-empty selection.</para>
960 <sect3 id="other-property-bar">
961 <title>Using the Property Bar</title>
963 <para>The property bar can be used to change some common properties
964 of objects en-masse. These properties include font family, font
965 size, font weight, text alignment, text color, fill color, line
966 or outline color, and line width. The property bar also controls
967 the defaults for these properties for any newly created objects.
976 <!-- ============= Document Merge Features ========= -->
977 <sect2 id="glabels-merge">
978 <title>Performing a Document Merge</title>
980 <para>Document Merge (sometimes called "Mail Merge") is a powerful
981 feature that allows a unique label or card to be printed for each
982 record in an external data source.</para>
984 <para>The first step to performing a document merge is to prepare
985 a source document that contains your merge data. This data could
986 be mailing addresses or any other data that you wish to create
987 unique labels or cards for. Currently back-ends only exist for
988 text files and the evolution data server -- others are planned. The currently
989 supported text-file format is very simple: each line is a record;
990 fields are delimited by commas (CSV), tabs, or colons; and newlines
991 can be embedded into fields by using the "\n" entity. This file
992 could be created using any text editor or could be created by
993 another program or script. A common way of creating CSV files is
994 to export them from a spreadsheet program.</para>
996 <para>A label must then be configured to "point at" this data file.
997 To configure the merge properties of a document, choose
998 <menuchoice> <guimenu>Objects</guimenu>
999 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item
1000 to display the <guilabel>merge properties</guilabel> dialog. This
1001 dialog is used to select the exact data file format and file
1002 name (location) of the merge data.</para>
1004 <para>Finally, once the label has been configured for a data file,
1005 field keys can be inserted into text objects and used as source
1006 or data for barcode objects and image filenames for image objects.
1007 See <xref linkend="glabels-object-properties" /> for more information
1008 on using merge data for these object types.</para>
1010 <para>Now that your label is configured, gLabels will print a unique
1011 label for each record in your source document -- substituting fields
1012 from each record for field keys in the all text, barcode, and
1013 image objects.</para>
1015 <para>See <xref linkend="glabels-merge-tutorial" /> for a detailed
1016 tutorial on the document merge feature.</para>
1027 <!-- ============= Customization ============================= -->
1028 <!-- Use this section to describe how to customize the application. -->
1029 <sect1 id="glabels-prefs">
1030 <title>Settings</title>
1031 <para>To configure &app;, choose
1033 <guimenu>Settings</guimenu>
1034 <guimenuitem>Preferences</guimenuitem>
1036 <guilabel>Preferences</guilabel> dialog contains the following tabbed
1041 <xref linkend="glabels-prefs-locale"/></para>
1045 <xref linkend="glabels-prefs-object-defaults"/></para>
1048 <!-- =============== Customization Subsection ================ -->
1049 <!-- Use a new section to describe different tabbed sections on the Settings or Preferences
1051 <sect2 id="glabels-prefs-locale">
1052 <title>Locale</title>
1056 <guilabel>Units</guilabel> </term>
1058 <para>Use this radio button group to specify your prefered units.
1059 Select one of the following options:</para>
1063 <guilabel>Points</guilabel> </para>
1064 <para>Use points (1 point = 1/72 in = 0.352778 mm).</para>
1068 <guilabel>Inches</guilabel> </para>
1069 <para>Use inches.</para>
1073 <guilabel>Millimeters</guilabel> </para>
1074 <para>Use millimeters.</para>
1078 <guilabel>Inches</guilabel>.</para>
1083 <guilabel>Default page size</guilabel> </term>
1085 <para>Use this radio button group to specify your prefered page size.
1086 This will make it quicker for you to locate media types when creating a new
1087 label or card.</para>
1091 <guilabel>US Letter</guilabel> </para>
1092 <para>Most of your media will be of the US Letter page size (8.5 x 11 inches).</para>
1096 <guilabel>ISO A4</guilabel> </para>
1097 <para>Most of your media will be of the ISO A4 page size (210 x 297 mm).</para>
1101 <guilabel>US Letter</guilabel>.</para>
1106 <!-- ============= Customization Subsection ===================== -->
1107 <!-- Another tabbed section on the Preferences dialog. -->
1108 <sect2 id="glabels-prefs-object-defaults">
1109 <title>Object defaults</title>
1113 <guilabel>Text</guilabel> </term>
1115 <para>Use these controls to set the default properties of new text objects.
1116 These properties are</para>
1120 <guilabel>Font</guilabel> </para>
1121 <para>These controls are used to select font family and font size, and
1122 whether the font should bold or in italics.</para>
1126 <guilabel>Color</guilabel> </para>
1127 <para>This control selects the default text color.</para>
1131 <guilabel>Alignment</guilabel> </para>
1132 <para>These controls are used to select the default text alignment (left, center or right).</para>
1139 <guilabel>Line</guilabel> </term>
1141 <para>Use these controls to set the default properties of lines and outlines of
1142 new objects. These properties are</para>
1146 <guilabel>Width</guilabel> </para>
1147 <para>This control selects the default line width.</para>
1151 <guilabel>Color</guilabel> </para>
1152 <para>This control selects the default line color.</para>
1159 <guilabel>Fill</guilabel> </term>
1161 <para>Use these controls to set the default fill properties of
1162 new objects. These properties are</para>
1166 <guilabel>Color</guilabel> </para>
1167 <para>This control selects the default fill color.</para>
1179 <!-- ============= Document Merge Tutorial ================================== -->
1180 <sect1 id="glabels-merge-tutorial">
1181 <title>Document Merge Tutorial</title>
1183 <para>Document Merge (sometimes called "Mail Merge") is a powerful
1184 feature that allows a unique label or card to be printed for each
1185 record in an external data source. It is however, the most mis-understood
1186 feature of <application>glabels</application>. The following examples
1187 will step through a couple of common tasks using the document merge
1190 <sect2 id="merge-ex1">
1191 <title>Example 1: Name Tags</title>
1193 <para>In this example we are organizing an orientation party for the new
1194 crew members of our ship. We have a list of freshman crew members that we
1195 created in <application>gnumeric</application> and exported as the following
1196 CSV file. We could have created this file by using a text editor, but heck it
1197 is the 23rd century.</para>
1201 "Jim Kirk",Management,"SC937-0176 CEC"
1202 "Mr. Spock",Sciences,S179-276SP
1203 "Leonard McCoy",Medicine,unknown
1204 "Montgomery Scott",Engineering,SE-197-54T
1207 <para>In <application>glabels</application> we have created a new glabels
1208 document using the Avery 5395 "Name Badge Labels" template. Next we use the
1209 <menuchoice> <guimenu>Objects</guimenu>
1210 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item to display
1211 the <guilabel>merge properties</guilabel> dialog. We use this dialog to
1212 select the source type (in our case CSV) and the merge source (filename) as
1215 <!-- ==== Figure ==== -->
1216 <figure id="merge-ex1-1-fig">
1217 <title>Merge properties dialog</title>
1220 <imageobject><imagedata
1221 fileref="figures/merge-ex1-1.png" format="PNG"/>
1226 <!-- ==== End of Figure ==== -->
1228 <para>Before applying the merge source, we uncheck the first record since it is only
1229 column headers from our original <application>gnumeric</application> spreadsheet
1230 and would simply waste our first label. We could also unselect any other records
1231 that we didn't want to print a label for.</para>
1233 <para>We can also view each record in more detail by clicking on the appropriate
1234 expander (the little triangles) as shown. Once we are satisfied with the
1235 selections in this dialog we click <guibutton>OK</guibutton> to accept the
1238 <para>Now we start adding objects to our glabels document as shown.</para>
1240 <!-- ==== Figure ==== -->
1241 <figure id="merge-ex1-2-fig">
1242 <title>Adding objects</title>
1245 <imageobject><imagedata
1246 fileref="figures/merge-ex1-2.png" format="PNG"/>
1251 <!-- ==== End of Figure ==== -->
1253 <para>In this example we have added three text objects and a barcode object. The
1254 first text object contains only simple literal text ("Hello, my name is"). The
1255 second text object contains a single merge field ("${1}") corresponding to the
1256 first field of a record (first column of a line) which contains the new crew
1257 member's full name. The third text field contains both literal text
1258 ("Department: ") followed by a single merge field ("${2}") corresponding to
1259 the second field or the crew member's department. The barcode object is
1260 configured to use field (or key) "3" which contains our crew member's
1261 starfleet serial number.</para>
1263 <para>Now we can print our name tags by selecting the
1264 <menuchoice> <guimenu>File</guimenu>
1265 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1266 print dialog as shown below.</para>
1268 <!-- ==== Figure ==== -->
1269 <figure id="merge-ex1-3-fig">
1270 <title>Printing name tags</title>
1273 <imageobject><imagedata
1274 fileref="figures/merge-ex1-3.png" format="PNG"/>
1279 <!-- ==== End of Figure ==== -->
1281 <para>Just to make sure our labels are going to look okay, we select the
1282 <guilabel>Print outlines</guilabel> option and click
1283 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1284 as shown below.</para>
1286 <!-- ==== Figure ==== -->
1287 <figure id="merge-ex1-4-fig">
1288 <title>Name tags preview</title>
1291 <imageobject><imagedata
1292 fileref="figures/merge-ex1-4.png" format="PNG"/>
1297 <!-- ==== End of Figure ==== -->
1299 <para>Everything looks good, so we can now load up our printer with
1300 the appropriate label stock, print our name tags and start beaming our guests
1305 <sect2 id="merge-ex2">
1306 <title>Example 2: Address Labels</title>
1308 <para>In this example we are going to throw a party and need to print mailing
1309 address labels for our invitations. We have a list of our closest friends
1310 that we created in <application>gnumeric</application> and exported as the
1311 following CSV file. It should be noted that not everyone has a middle initial or
1312 a two line address.</para>
1315 LAST,FIRST,MI,ADDR1,ADDR2,CITY,STATE,ZIP
1317 Critter,Ess,S,"123 Faux St.",,Alexandria,VA,22310
1318 Doe,John,,"Apt 1X","451 Mystery St.",Trenton,NJ,08601
1319 Summers,Joyce,,"1630 Revello Dr",,Sunnydale,CA,95037
1320 McGarret,Steve,O,"404 Piikoi Street",,Honolulu,HI,96813
1321 Kramer,Cosmo,,"Apt 5B","129 W. 81 St.","New York",NY,10024-7207
1324 <para>In <application>glabels</application> we have created a new glabels
1325 document using the Avery 5512 "Address Labels" template. Next we use the
1326 <menuchoice> <guimenu>Objects</guimenu>
1327 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item to display
1328 the <guilabel>merge properties</guilabel> dialog. We use this dialog to
1329 select the source type (in our case CSV) and the merge source (filename) as
1332 <!-- ==== Figure ==== -->
1333 <figure id="merge-ex2-1-fig">
1334 <title>Merge properties dialog</title>
1337 <imageobject><imagedata
1338 fileref="figures/merge-ex2-1.png" format="PNG"/>
1343 <!-- ==== End of Figure ==== -->
1345 <para>Before applying the merge source, we uncheck the first record since it is only
1346 column headers from our original <application>gnumeric</application> spreadsheet
1347 and would simply waste our first label. We also unselect the second record
1348 which is empty (an artifact of our original spreadsheet). We could also unselect
1349 any other records that we didn't want to print a label for.</para>
1351 <para>We can also view each record in more detail by clicking on the appropriate
1352 expander (the little triangles) as shown. Once we are satisfied with the
1353 selections in this dialog we click <guibutton>OK</guibutton> to accept the
1356 <para>Now we start adding objects to our glabels document as shown.</para>
1358 <!-- ==== Figure ==== -->
1359 <figure id="merge-ex2-2-fig">
1360 <title>Adding objects</title>
1363 <imageobject><imagedata
1364 fileref="figures/merge-ex2-2.png" format="PNG"/>
1369 <!-- ==== End of Figure ==== -->
1371 <para>In this example we have a single text object. This text object contains
1372 all of our merge fields organized on multiple lines as a mailing address.
1373 Notice that fields ${4} and ${5} (corresponding to ADDR1 and ADDR2) are each
1374 located with no other text on their own lines. When
1375 <application>glabels</application> encounters a field as the only text on
1376 a line, it will not expand the line if the field is empty.</para>
1378 <para>Now we can print our address labels by selecting the
1379 <menuchoice> <guimenu>File</guimenu>
1380 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1381 print dialog as shown below.</para>
1383 <!-- ==== Figure ==== -->
1384 <figure id="merge-ex2-3-fig">
1385 <title>Printing address labels</title>
1388 <imageobject><imagedata
1389 fileref="figures/merge-ex2-3.png" format="PNG"/>
1394 <!-- ==== End of Figure ==== -->
1396 <para>Just to make sure our labels are going to look okay, we select the
1397 <guilabel>Print outlines</guilabel> option and click
1398 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1399 as shown below.</para>
1401 <!-- ==== Figure ==== -->
1402 <figure id="merge-ex2-4-fig">
1403 <title>Address labels preview</title>
1406 <imageobject><imagedata
1407 fileref="figures/merge-ex2-4.png" format="PNG"/>
1412 <!-- ==== End of Figure ==== -->
1414 <para>Everything looks good, so we can now load up our printer with
1415 the appropriate label stock, print our address labels and start mailing
1416 our party invitations.</para>
1425 <!-- ============= Creating templates ================================== -->
1426 <sect1 id="glabels-manual-create-template">
1427 <title>Manually Creating New Templates</title>
1429 <para>Predefined templates are defined by XML files located in
1430 <filename>${prefix}/share/glabels/</filename>,
1431 where <filename>${prefix}</filename> is usually something like
1432 <filename>/usr/local</filename> or <filename>/usr</filename> depending
1433 on the configuration option <filename>prefix</filename>. gLabels will
1434 use all files of the form <filename>*-templates.xml</filename>
1435 or <filename>*.template</filename>, that it finds in
1436 <filename>${prefix}/share/glabels/</filename> and
1437 <filename>${HOME}/.glabels/</filename>.
1438 Additional templates can be added by creating additional
1439 <filename>*.template</filename> files in either of these directories.
1442 <para>The format for these files is defined in the DTD:
1443 <ulink url="http://glabels.sourceforge.net/doc/glabels-2.0.dtd.txt"
1444 type="http">glabels-2.2.dtd</ulink>. (This DTD also describes other
1445 XML formats used by glabels.)</para>
1447 <sect2 id="template-assumptions">
1448 <title>Assumptions/caveats</title>
1451 <para>A sheet contains only one size of label or card (if a sheet
1452 contains more than one size of item, it can be split into
1453 multiple templates for multiple pass printing)</para>
1456 <para>Distances can be expressed in units of <emphasis>pt</emphasis>,
1457 <emphasis>in</emphasis>, <emphasis>mm</emphasis>,
1458 <emphasis>cm</emphasis>, or <emphasis>pc</emphasis>. For example:
1459 "<literal>1.0in</literal>" or "<literal>2.54cm</literal>". If no
1460 units are specified, computer points (<emphasis>pt</emphasis>) will
1461 be assumed (1 <emphasis>pt</emphasis> =
1462 1/72 <emphasis>in</emphasis> = 0.352778 <emphasis>mm</emphasis>).
1468 <sect2 id="template-file">
1469 <title>Template Files</title>
1472 <?xml version="1.0"?>
1473 <Glabels-templates>
1475 <replaceable>...templates...</replaceable>
1477 </Glabels-templates>
1482 <sect2 id="template-example">
1483 <title>Example Template</title>
1485 <Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels">
1486 <Label-rectangle id="0" width="189pt" height="72pt" round="5pt">
1487 <Markup-margin size="5pt"/>
1488 <Layout nx="3" ny="10" x0="11.25pt" y0="36pt" dx="200pt" dy="72pt"/>
1489 </Label-rectangle>
1490 <Alias brand="Avery" part="5160"/>
1491 <Alias brand="Avery" part="6233"/>
1496 <sect2 id="template-template-node">
1497 <title>Template Node</title>
1499 <para>A <emphasis>Template</emphasis> node describes a single stationary
1500 product. It must contain one instance of any type of Label node
1501 (<emphasis>Label-rectangle</emphasis>,
1502 <emphasis>Label-round</emphasis>, or <emphasis>Label-cd</emphasis>).
1503 This node can be followed by zero or more
1504 <emphasis>Alias</emphasis> nodes.</para>
1506 <informaltable frame="topbot">
1508 <colspec colname="col1"/>
1509 <colspec colname="col2"/>
1512 <entry colname="col1" colsep="0" valign="top">
1513 <para>Property</para>
1515 <entry colname="col2" valign="top">
1516 <para>Description</para>
1522 <entry><para>brand</para></entry>
1524 <para>Brand or manufacturer of stationary product.
1529 <entry><para>part</para></entry>
1531 <para>Part number or name of stationary product.
1536 <entry><para>size</para></entry>
1538 <para>Size of sheet. E.g., "US-Letter," "A4", ...</para>
1542 <entry><para>description</para></entry>
1544 <para>Description of stationary product. E.g,
1545 "Mailing Labels."</para>
1549 <entry><para>_description</para></entry>
1551 <para>Translatable description of stationary product.
1552 E.g, "Mailing Labels." (Only useful for predefined
1557 <entry><para>width</para></entry>
1559 <para>Page width. Only valid if size="Other"</para>
1563 <entry><para>height</para></entry>
1565 <para>Page height. Only valid if size="Other"</para>
1574 <sect2 id="template-label-rectangle-node">
1575 <title>Label-rectangle Node</title>
1577 <para>A <emphasis>Label-rectangle</emphasis> node describes the
1578 dimensions of a single label or business card that is rectangular
1579 in shape (may have rounded edges).</para>
1581 <informaltable frame="topbot">
1583 <colspec colname="col1"/>
1584 <colspec colname="col2"/>
1587 <entry colname="col1" colsep="0" valign="top">
1588 <para>Property</para>
1590 <entry colname="col2" valign="top">
1591 <para>Description</para>
1597 <entry><para>id</para></entry>
1599 <para>Reserved for future use. Should always be 0.</para>
1603 <entry><para>width</para></entry>
1604 <entry><para>Width of label/card</para></entry>
1607 <entry><para>height</para></entry>
1608 <entry><para>Height of label/card</para></entry>
1611 <entry><para>round</para></entry>
1613 <para>Radius of corners. For items with square edges
1614 (business cards), the radius should be 0.</para>
1618 <entry><para>x_waste</para></entry>
1620 <para>Amount of horizontal waste (over-print) to allow. This is useful
1621 for minimizing alignment problems when using non-white
1622 backgrounds (e.g. images).</para>
1626 <entry><para>y_waste</para></entry>
1628 <para>Amount of vertical waste (over-print) to allow. This is useful
1629 for minimizing alignment problems when using non-white
1630 backgrounds (e.g. images).</para>
1637 <!-- ==== Figure ==== -->
1638 <figure id="template-label-fig">
1639 <title>Label-rectangle Parameters</title>
1642 <imageobject><imagedata
1643 fileref="figures/glabels-template-label.png" format="PNG"/>
1648 <!-- ==== End of Figure ==== -->
1652 <sect2 id="template-label-round-node">
1653 <title>Label-round Node</title>
1655 <para>A <emphasis>Label-round</emphasis> node describes the dimensions
1656 of a simple round label (not a CD).</para>
1658 <informaltable frame="topbot">
1660 <colspec colname="col1"/>
1661 <colspec colname="col2"/>
1664 <entry colname="col1" colsep="0" valign="top">
1665 <para>Property</para>
1667 <entry colname="col2" valign="top">
1668 <para>Description</para>
1674 <entry><para>id</para></entry>
1676 <para>Reserved for future use. Should always be 0.</para>
1680 <entry><para>radius</para></entry>
1681 <entry><para>Radius (1/2 diameter) of label</para></entry>
1684 <entry><para>waste</para></entry>
1686 <para>Amount of waste (over-print) to allow. This is useful
1687 for minimizing alignment problems when using non-white
1688 backgrounds (e.g. images).</para>
1697 <sect2 id="template-label-cd-node">
1698 <title>Label-cd Node</title>
1700 <para>A <emphasis>Label-cd</emphasis> node describes the dimensions
1701 of a CD, DVD, or business card CD.</para>
1703 <informaltable frame="topbot">
1705 <colspec colname="col1"/>
1706 <colspec colname="col2"/>
1709 <entry colname="col1" colsep="0" valign="top">
1710 <para>Property</para>
1712 <entry colname="col2" valign="top">
1713 <para>Description</para>
1719 <entry><para>id</para></entry>
1721 <para>Reserved for future use. Should always be 0.</para>
1725 <entry><para>radius</para></entry>
1726 <entry><para>Outer radius of label</para></entry>
1729 <entry><para>hole</para></entry>
1730 <entry><para>Radius of concentric hole</para></entry>
1733 <entry><para>width</para></entry>
1735 <para>If present, the label is clipped to the given width.
1736 (Useful for "business card CDs").</para>
1740 <entry><para>height</para></entry>
1742 <para>If present, the label is clipped to the given height.
1743 (Useful for "business card CDs").</para>
1747 <entry><para>waste</para></entry>
1749 <para>Amount of waste (over-print) to allow. This is useful
1750 for minimizing alignment problems when using non-white
1751 backgrounds (e.g. images).</para>
1758 <!-- ==== Figure ==== -->
1759 <figure id="template-label-cd-fig">
1760 <title>CD Label Parameters</title>
1763 <imageobject><imagedata
1764 fileref="figures/glabels-template-cd.png" format="PNG"/>
1769 <!-- ==== End of Figure ==== -->
1773 <sect2 id="template-markup-margin-node">
1774 <title>Markup-margin Node</title>
1776 <para>A <emphasis>Markup-margin</emphasis> describes a margin along
1777 all edges of a label.</para>
1779 <informaltable frame="topbot">
1781 <colspec colname="col1"/>
1782 <colspec colname="col2"/>
1785 <entry colname="col1" colsep="0" valign="top">
1786 <para>Property</para>
1788 <entry colname="col2" valign="top">
1789 <para>Description</para>
1795 <entry><para>size</para></entry>
1797 <para>Size of the margin. I.e. the distance of the margin
1798 line from the edge of the card/label.</para>
1807 <sect2 id="template-markup-line-node">
1808 <title>Markup-line Node</title>
1810 <para>A <emphasis>Markup-line</emphasis> describes a markup line.</para>
1812 <informaltable frame="topbot">
1814 <colspec colname="col1"/>
1815 <colspec colname="col2"/>
1818 <entry colname="col1" colsep="0" valign="top">
1819 <para>Property</para>
1821 <entry colname="col2" valign="top">
1822 <para>Description</para>
1828 <entry><para>x1</para></entry>
1830 <para>x coordinate of 1st endpoint of the line segment.</para>
1834 <entry><para>y1</para></entry>
1836 <para>y coordinate of 1st endpoint of the line segment.</para>
1840 <entry><para>x2</para></entry>
1842 <para>x coordinate of 2nd endpoint of the line segment.</para>
1846 <entry><para>y2</para></entry>
1848 <para>y coordinate of 2nd endpoint of the line segment.</para>
1857 <sect2 id="template-markup-circle-node">
1858 <title>Markup-circle Node</title>
1860 <para>A <emphasis>Markup-circle</emphasis> describes a markup circle.
1863 <informaltable frame="topbot">
1865 <colspec colname="col1"/>
1866 <colspec colname="col2"/>
1869 <entry colname="col1" colsep="0" valign="top">
1870 <para>Property</para>
1872 <entry colname="col2" valign="top">
1873 <para>Description</para>
1879 <entry><para>x0</para></entry>
1881 <para>x coordinate of circle origin (center).</para>
1885 <entry><para>y0</para></entry>
1887 <para>y coordinate of circle origin (center).</para>
1891 <entry><para>radius</para></entry>
1892 <entry><para>Radius of circle.</para></entry>
1900 <sect2 id="template-markup-rect-node">
1901 <title>Markup-rect Node</title>
1903 <para>A <emphasis>Markup-rect</emphasis> describes a markup rectangle.
1906 <informaltable frame="topbot">
1908 <colspec colname="col1"/>
1909 <colspec colname="col2"/>
1912 <entry colname="col1" colsep="0" valign="top">
1913 <para>Property</para>
1915 <entry colname="col2" valign="top">
1916 <para>Description</para>
1922 <entry><para>x1</para></entry>
1924 <para>x coordinate of upper left corner of rectangle.</para>
1928 <entry><para>y1</para></entry>
1930 <para>y coordinate of upper left corner of rectangle.</para>
1934 <entry><para>w</para></entry>
1936 <para>Width of rectangle.</para>
1940 <entry><para>h</para></entry>
1942 <para>Height of rectangle.</para>
1946 <entry><para>r</para></entry>
1947 <entry><para>Radius of rounded corners of rectangle.</para></entry>
1955 <sect2 id="template-layout-node">
1956 <title>Layout Node</title>
1958 <para>A label node may contain multiple <emphasis>Layout</emphasis>
1959 children. If labels are arranged in a simple grid pattern, only
1960 one layout is needed. However, if labels are arranged in multiple
1961 grids, such as a running bond pattern, multiple
1962 <emphasis>layout</emphasis> tags can be used. Note: a single label
1963 can always be treated as a grid of one.</para>
1965 <informaltable frame="topbot">
1967 <colspec colname="col1"/>
1968 <colspec colname="col2"/>
1971 <entry colname="col1" colsep="0" valign="top">
1972 <para>Property</para>
1974 <entry colname="col2" valign="top">
1975 <para>Description</para>
1981 <entry><para>nx</para></entry>
1983 <para>Number of labels/cards across in the grid
1988 <entry><para>ny</para></entry>
1990 <para>Number of labels/cards up and down in the grid
1995 <entry><para>x0</para></entry>
1997 <para>Distance from left edge of sheet to the left edge of
1998 the left column of cards/labels in the layout.</para>
2002 <entry><para>y0</para></entry>
2004 <para>Distance from the top edge of sheet to the top edge of
2005 the top row of labels/cards in the layout.</para>
2009 <entry><para>dx</para></entry>
2010 <entry><para>Horizontal pitch of grid.</para></entry>
2013 <entry><para>dy</para></entry>
2014 <entry><para>Vertical pitch of grid.</para></entry>
2020 <!-- ==== Figure ==== -->
2021 <figure id="template-layout-fig">
2022 <title>Layout Parameters</title>
2025 <imageobject><imagedata
2026 fileref="figures/glabels-template-layout.png" format="PNG"/>
2031 <!-- ==== End of Figure ==== -->
2035 <sect2 id="template-alias-node">
2036 <title>Alias Node</title>
2038 <para>An <emphasis>Alias</emphasis> node provides the name of a
2039 product with the same size and layout characteristics as the
2040 parent template.</para>
2042 <informaltable frame="topbot">
2044 <colspec colname="col1"/>
2045 <colspec colname="col2"/>
2048 <entry colname="col1" colsep="0" valign="top">
2049 <para>Property</para>
2051 <entry colname="col2" valign="top">
2052 <para>Description</para>
2058 <entry><para>brand</para></entry>
2060 <para>The brand or manufacturer of the equivalent product.</para>
2064 <entry><para>part</para></entry>
2066 <para>The part number or name of the equivalent product.</para>
2080 <!-- ============= Bugs ================================== -->
2081 <!-- This section is optional and is commented out by default.
2082 You can use it to describe known bugs and limitations of the
2083 program if there are any - please be frank and list all
2084 problems you know of.
2086 <sect1 id="mayapp-bugs">
2087 <title>Known Bugs and Limitations</title>
2095 <!-- ============= About ================================== -->
2096 <!-- This section contains info about the program (not docs), such as
2097 author's name(s), web page, license, feedback address. This
2098 section is optional: primary place for this info is "About.." box of
2099 the program. However, if you do wish to include this info in the
2100 manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
2101 <sect1 id="glabels-about">
2102 <title>About &app;</title>
2103 <para> &app; was written by Jim Evins
2104 (<email>evins@snaught.com</email>). To find more information about
2105 &app;, please visit the
2106 <ulink url="http://glabels.sourceforge.net" type="http">gLabels Web
2107 page</ulink>. </para>
2109 To report a bug or make a suggestion regarding this application or
2110 this manual, follow the directions at the
2111 <ulink url="http://glabels.sourceforge.net/contact/" type="http">gLabels Contact Page</ulink>.
2114 <para> This program is distributed under the terms of the GNU
2115 General Public license as published by the Free Software
2116 Foundation; either version 2 of the License, or (at your option)
2117 any later version. A copy of this license can be found at this
2118 <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
2119 COPYING included with the source code of this program. </para>