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">
6 <!ENTITY manrevision "2.2.6">
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 &app; label and business card creation program
38 <year>2003-2009</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 V2.2.6</revnumber>
88 <date>October 2009</date>
90 <para role="author">Mario Blättermann
91 <email>mariobl@gnome.org</email>
93 <para role="publisher">Jim Evins</para>
97 <revnumber>gLabels Manual V2.2</revnumber>
98 <date>December 2007</date>
100 <para role="author">Jim Evins
101 <email>evins@snaught.com</email>
103 <para role="publisher">Jim Evins</para>
108 <releaseinfo>This manual describes version &appversion; of &app;.
111 <title>Feedback</title>
112 <para>To report a bug or make a suggestion regarding the &app; application or
113 this manual, follow the directions in the <ulink url="http://glabels.sourceforge.net/contact/"
114 type="http">&app; Contact Page</ulink>.
116 <!-- Translators may also add here feedback address for translations -->
120 <indexterm zone="index">
121 <primary>gLabels</primary>
123 <indexterm zone="index">
124 <primary>glabels</primary>
130 <!-- ============= Document Body ============================= -->
131 <!-- ============= Introduction ============================== -->
132 <!-- Use the Introduction section to give a brief overview of what
133 the application is and what it does. -->
134 <sect1 id="glabels-introduction">
135 <title>Introduction</title>
137 <para>The &app; application is a lightweight program for creating labels
138 and business cards for the <systemitem>GNOME desktop</systemitem>
139 environment. It is designed to work with various laser/ink-jet
140 peel-off label and business card sheets that you'll find at most
141 office supply stores.</para>
148 <!-- =========== Getting Started ============================== -->
149 <!-- Use the Getting Started section to describe the steps required
150 to start the application and to describe the user interface components
151 of the application. If there is other information that it is important
152 for readers to know before they start using the application, you should
153 also include this information here.
154 If the information about how to get started is very short, you can
155 include it in the Introduction and omit this section. -->
157 <sect1 id="glabels-getting-started">
158 <title>Getting Started</title>
160 <sect2 id="glabels-start">
161 <title>To Start &app;</title>
162 <para>You can start &app; in the following ways:
166 <term><guimenu>Applications</guimenu> menu</term>
170 <guisubmenu>Office</guisubmenu>
171 <guimenuitem>gLabels</guimenuitem>
172 </menuchoice>. </para>
176 <term>Command line</term>
178 <para>Type <command>glabels</command>,
179 then press <keycap>Return</keycap>:</para>
185 <sect2 id="glabels-when-start">
186 <title>When You Start &app;</title>
187 <para>When you start &app;, the following window is displayed.</para>
189 <!-- ==== Figure ==== -->
190 <figure id="mainwindow-fig">
191 <title>&app; Start Up Window</title>
194 <imageobject><imagedata
195 fileref="figures/main-window-empty.png" format="PNG"/>
200 <!-- ==== End of Figure ==== -->
202 <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
203 <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
205 <para>The &app; window contains the following elements:
209 <term>Menubar. </term>
211 <para>The menus on the menubar contain all of the commands you
212 need to create and edit labels and business cards in
217 <term>Main toolbar. </term>
219 <para>The main toolbar contains a subset of common File and Edit
220 commands that you can access from the menubar.</para>
224 <term>Drawing toolbar.</term>
226 <para>The drawing toolbar contains a subset of commands for
227 editing the current &app; document.</para>
231 <term>Display area.</term>
233 <para>The display area is the main drawing interface to
238 <term>Object sidebar.</term>
240 <para>The object sidebar provides an interface for viewing and
241 editing all properties of an individual object. </para>
245 <term>Properties toolbar. </term>
247 <para>The properties toolbar contains a set of tools to
248 manipulate the properties of selected objects and set default
249 properties for new objects.</para>
253 <term>Statusbar. </term>
255 <para>The statusbar displays information about current
256 &app; activity and contextual
257 information about the menu items. </para>
267 <!-- ================ Usage ================================ -->
268 <!-- Use this section to describe how to use the application to perform the tasks for
269 which the application is designed. -->
270 <sect1 id="glabels-usage">
273 <!-- ============= To create a new file ============================= -->
274 <sect2 id="glabels-open-new">
275 <title>To Create a New Label or Card</title>
277 <para>To create a new label or business card, choose
278 <menuchoice> <guimenu>File</guimenu> <guimenuitem>New</guimenuitem>
280 to display the <guilabel>New Label or Card</guilabel> dialog. Select
281 the media type and orientation for the new document,
282 then click <guibutton>OK</guibutton>. A new document is
283 displayed in the display area of the &app;
286 <para>If your particular media type is missing from this dialog,
287 see <xref linkend="glabels-create-template"/></para>
291 <!-- ============= To Open a File ============================= -->
292 <sect2 id="glabels-open-file">
293 <title>To Open a File</title>
295 <para>To open a file, choose
296 <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open</guimenuitem>
297 </menuchoice> to display the <guilabel>Open File</guilabel> dialog.
298 Select the file that you want to open, then click
299 <guibutton>OK</guibutton>. The file is displayed in the display area
300 of the &app; window. </para>
302 <para>You can also open multiple files in
303 &app;. The application creates a separate
304 application window for each open file.</para>
306 <para>The application records the paths and filenames of the
307 most recent files that you have edited and displays the files as menu
308 items on the <menuchoice>
309 <guimenu>File</guimenu><guisubmenu>Recent Files</guisubmenu>
310 </menuchoice> menu.</para>
314 <!-- ============= To Open Multiple Files from the Command Line ========= -->
315 <sect2 id="glabels-run-from-cmd-line">
316 <title>To Open Multiple Files from a Command Line</title>
318 <para>You can run &app; from a command line
319 and open a single file or multiple files. To open multiple files from
320 a command line, type the following command, then press
321 <keycap>Return</keycap>:</para>
323 <para><command>glabels
324 <replaceable>file1.glabels file2.glabels file3.glabels</replaceable>
327 <para>When the application starts, the files that you specify are
328 displayed in separate &app; windows.</para>
332 <!-- ============= To Save a File ========= -->
333 <sect2 id="glabels-save-file">
334 <title>To Save a File</title>
336 <para>You can save files in the following ways:</para>
341 <para>To save changes to an existing file, choose
342 <menuchoice> <guimenu>File</guimenu>
343 <guimenuitem>Save</guimenuitem> </menuchoice>. </para>
348 <para>To save a new file or to save an existing file under a new
349 filename, choose <menuchoice> <guimenu>File</guimenu>
350 <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name
351 for the file in the <guilabel>Save As</guilabel> dialog box,
352 then click <guibutton>OK</guibutton>.</para>
359 <!-- ============= To Change Label Properties ========= -->
360 <sect2 id="glabels-label-properties">
361 <title>To Change Label Properties</title>
363 <para>To change the media type and/or orientation of a label, choose
364 <menuchoice> <guimenu>File</guimenu>
365 <guimenuitem>Properties</guimenuitem> </menuchoice> to display the
366 <guilabel>Label properties</guilabel> dialog. Select the
367 new media type and orientation for the document, then click
368 <guibutton>OK</guibutton>.</para>
372 <!-- ============= To create a custom template ======================= -->
373 <sect2 id="glabels-create-template">
374 <title>To Create a Custom Template</title>
376 <para>To create a new custom template, choose
377 <menuchoice> <guimenu>File</guimenu>
378 <guimenuitem>Template Designer ...</guimenuitem> </menuchoice>
379 to display the <guilabel>Template Designer</guilabel> dialog.
380 This dialog will assist you in creating a custom template for
381 most types of label or card stationery that you may encounter.</para>
383 <para>If you prefer, you can create your templates manually.
384 For this option see <xref linkend="glabels-manual-create-template"/>
389 <!-- ============= To Close a File ========= -->
390 <sect2 id="glabels-close-file">
391 <title>To Close a File</title>
393 <para>To close the current document, choose
394 <menuchoice> <guimenu>File</guimenu>
395 <guimenuitem>Close</guimenuitem> </menuchoice> to close the application
396 window. If the current document is modified, a confirmation dialog
397 will be presented, allowing you to save the document or cancel
398 the command. If the window being closed is the only open window,
399 &app; will exit.</para>
403 <!-- ============= To Quit ========= -->
404 <sect2 id="glabels-quit">
405 <title>To Quit &app;</title>
407 <para>To quit &app;, choose
408 <menuchoice> <guimenu>File</guimenu>
409 <guimenuitem>Quit</guimenuitem> </menuchoice>. This is equivalent
410 to closing all open windows. See
411 <xref linkend="glabels-close-file"/>.</para>
415 <!-- ============= To Print Labels and Cards ========= -->
416 <sect2 id="glabels-print-file">
417 <title>To Print Labels or Cards</title>
419 <para>To print labels or cards, choose
420 <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem>
421 </menuchoice> to display the <guilabel>Print</guilabel> dialog.
422 Once print options have been selected, click <guilabel>Print</guilabel>
423 to print the labels or cards. To simply preview the results,
424 click <guilabel>Print Preview</guilabel> instead.</para>
426 <para>The <guilabel>Print</guilabel> dialog allows you to specify the
427 following print options:</para>
429 <sect3 id="print-dialog-job">
430 <title>The Labels Tab of the Print Dialog</title>
435 <term><guilabel>Print control (Simple)</guilabel></term>
438 <para>For simple labels or cards (no document merge), the <guilabel>labels</guilabel>
439 tabbed section contains the following copy controls.</para>
441 <!-- ==== Figure ==== -->
442 <figure id="print-copies-fig">
443 <title>Print Copy Controls</title>
446 <imageobject><imagedata
447 fileref="figures/print-copies.png" format="PNG"/>
452 <!-- ==== End of Figure ==== -->
454 <para>The number of copies of the label can be selected by
455 choosing the number of full sheets to print, or a specific
456 subset of labels on a single sheet.</para>
458 <para>The mini-preview can also be used to graphically select
459 the subset of labels by clicking the first label on the
460 mini-preview and dragging to the last label.</para>
466 <term><guilabel>Print control (Merge)</guilabel></term>
469 <para>For labels or cards using the document merge (also known
470 as "mail merge") capability, the <guilabel>labels</guilabel> tabbed section contains
471 the following merge controls instead of copy controls.</para>
473 <!-- ==== Figure ==== -->
474 <figure id="print-merge-fig">
475 <title>Print Document Merge Controls</title>
478 <imageobject><imagedata
479 fileref="figures/print-merge.png" format="PNG"/>
484 <!-- ==== End of Figure ==== -->
486 <para>The total number of labels or cards printed is the
487 product of the number of records in the merge source and
488 the number of copies selected. If multiple copies are
489 selected, these can be either collated (copies of the
490 same record grouped together) or un-collated (one copy
491 each record is printed before next copy).</para>
493 <para>Printing can begin on any label on the first sheet.
494 This can be selected with the <guilabel>Start on
495 label</guilabel> spinbutton.</para>
497 <para>The mini-preview can also be used to graphically select
498 this first label, by clicking on the desired label in the
504 <varlistentry> <term><guilabel>Options</guilabel> </term>
506 <para>The following options can also be selected.</para>
509 <para><guilabel>print outlines</guilabel></para>
510 <para>Print outlines of labels. This option is useful for
511 dry-runs, to test printer alignment.</para>
514 <para><guilabel>print in reverse</guilabel></para>
515 <para>Prints the labels as mirror images. This option is
516 useful for printing on clear labels that will be viewed
517 from the reverse side (e.g. in a car window).</para>
520 <para><guilabel>print crop marks</guilabel></para>
521 <para>Prints crop marks along the edge of the sheet.
522 This option is useful for printing on blank stock, to
523 be cut after printing. This option does not work well
524 with all templates.</para>
534 <!-- ============= To Create New Objects ========= -->
535 <sect2 id="glabels-new-objects">
536 <title>To Create New Objects</title>
538 <para>Objects are created by choosing the appropriate selection under
539 the <menuchoice> <guimenu>Objects</guimenu>
540 <guimenuitem>Create Object</guimenuitem> </menuchoice> submenu or
541 the <guilabel>Drawing Toolbar</guilabel>. This will place the
542 display area into object creation mode as indicated by its cursor.
543 To return to the default object selection mode without creating
544 an object, choose <menuchoice> <guimenu>Objects</guimenu>
545 <guimenuitem>Select Mode</guimenuitem> </menuchoice>. This will
546 return the display area's cursor to the default selection arrow.</para>
548 <para>The following describes the object creation mode for each object
556 <para>Click the desired location of the upper left corner of the
557 text object. New text objects are initialized with the
558 string "Text." To change this text, or other properties, see
559 <xref linkend="glabels-object-properties"/>.</para>
566 <para>Click the desired location of the upper left corner of the
567 box object and drag to the desired location of the lower right
568 corner. If you simply click in a single location, a square
569 box will be created. To change properties of the box object, see
570 <xref linkend="glabels-object-properties"/>.</para>
577 <para>Click the desired location of one end of the
578 line object and drag to the desired location of the other end.
579 If you simply click in a single location, a diagonal line
580 will be created. To change properties of the line object, see
581 <xref linkend="glabels-object-properties"/>.</para>
588 <para>Click the desired location of the upper left corner of the
589 ellipse object and drag to the desired location of the lower
590 right corner. If you simply click in a single location, a circle
591 will be created. To change properties of the ellipse object, see
592 <xref linkend="glabels-object-properties"/>.</para>
599 <para>Click the desired location of the upper left corner of the
600 image object and drag to the desired location of the lower
601 right corner. If you simply click in a single location, a square
602 will be created. New image objects are initialized with a
603 simple checkerboard image. To change this image, or other
604 properties of the image object, see
605 <xref linkend="glabels-object-properties"/>.</para>
612 <para>Click the desired location of the upper left corner of the
613 barcode object. New barcode objects are initialized to a
614 POSTNET barcode with representative data. To change data
615 and properties of the barcode object, see
616 <xref linkend="glabels-object-properties"/>.</para>
625 <!-- ============= To Select Objects ========= -->
626 <sect2 id="glabels-select-objects">
627 <title>To Select Objects</title>
629 <para>A prerequisite for performing operations on objects is the
630 selection of individual objects or groups of objects. The
631 display area must be in the object selection mode to create new
632 selections, as indicated by an arrow cursor. The object
633 selection mode is selected by the
634 <menuchoice> <guimenu>Objects</guimenu>
635 <guimenuitem>Select Mode</guimenuitem> </menuchoice> menu item,
636 or the corresponding command on the <guilabel>Drawing
637 Toolbar</guilabel>.</para>
642 <term>Selecting a single object</term>
644 <para>A single object can be selected simply by clicking
645 on the desired object in the display area.
646 Once selected the object will be highlighted with a set of
647 resizing handles.</para>
652 <term>Aggregate object selections</term>
654 <para>Multiple objects can be selected by first selecting the first
655 object as above and then by holding the <keycap>Ctrl</keycap>
656 key while selecting additional objects.
657 Individual objects can be added to an existing selection
658 at any time by holding the <keycap>Ctrl</keycap> key while
659 selecting the desired objects. All objects can also be
660 selected by using the <menuchoice> <guimenu>Edit</guimenu>
661 <guimenuitem>Select All</guimenuitem> </menuchoice>
662 menu item. All objects in an aggregate object selection will be
668 <term>Area selections</term>
670 <para>Multiple objects can also be selected by clicking an empty
671 area and dragging to form a rectangular area. When released,
672 all objects contained in the area will form an aggregate
673 selection. An area selection can be used to add to an existing
674 selection by holding the <keycap>Ctrl</keycap> key while
675 performing the selection.</para>
680 <term>Unselecting objects</term>
682 <para>Individual objects can be removed from an existing
683 selection by holding the <keycap>Ctrl</keycap> key while
684 clicking on a previously selected object. An entire selection
685 can be dismissed by using the <menuchoice>
686 <guimenu>Edit</guimenu> <guimenuitem>Un-select All</guimenuitem>
687 </menuchoice> menu item
688 or by simply clicking any empty space in the display area.
689 Once an object is unselected its highlight is removed.</para>
697 <!-- ============= Clipboard Commands ========= -->
698 <sect2 id="glabels-clipboard">
699 <title>Clipboard Commands</title>
701 <para>Object selections can be manipulated using the standard clipboard
702 operations <guimenuitem>Cut</guimenuitem>,
703 <guimenuitem>Copy</guimenuitem>, <guimenuitem>Paste</guimenuitem>,
704 and <guimenuitem>Delete</guimenuitem>.</para>
712 <keycombo><keycap>Ctrl</keycap><keycap>X</keycap></keycombo>
714 <guimenuitem>Cut</guimenuitem>
718 <para>Moves selected objects to the clipboard. The objects are
719 then available for pasting back into the current document or
720 another document.</para>
728 <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
730 <guimenuitem>Copy</guimenuitem>
734 <para>Copies selected objects to the clipboard without deleting
735 them. The objects are then available for pasting back into
736 the current document or another document.</para>
744 <keycombo><keycap>Ctrl</keycap><keycap>V</keycap></keycombo>
746 <guimenuitem>Paste</guimenuitem>
750 <para>Pastes objects from the clipboard into the current document.
751 &app; can only paste objects from
752 another &app; document.</para>
760 <keycap>Delete</keycap>
762 <guimenuitem>Delete</guimenuitem>
766 <para>Deletes selected objects without placing them on the
775 <!-- ============= To Edit object Properties ========= -->
776 <sect2 id="glabels-object-properties">
777 <title>To Edit Object Properties</title>
779 <para>Most object properties can be modified through the object
780 editor sidebar, illustrated below. To use the object editor,
781 a single object must first be selected. See
782 <xref linkend="glabels-select-objects" />.</para>
784 <!-- ==== Figure ==== -->
785 <figure id="object-editor-sidebar-fig">
786 <title>Object Editor Sidebar</title>
789 <imageobject><imagedata
790 fileref="figures/object-editor-sidebar.png" format="PNG"/>
795 <!-- ==== End of Figure ==== -->
797 <para>The object editor will contain a subset of the following
798 tabbed sections, depending on object type:</para>
800 <sect3 id="object-editor-text">
801 <title>Text Tabbed Section (Text objects)</title>
803 <para>This section contains a small editor for changing the content
804 of a text object. It also contains a dropdown menu of available
805 document merge keys, that can be inserted into text.</para>
809 <sect3 id="object-editor-image">
810 <title>Image Tabbed Section (Image objecs)</title>
812 <para>This section contains a file entry with preview to select
813 image files. The browse button can be used to easily locate
814 image files. Alternatively, a document merge key can be used
815 instead to provide a filename at print time.</para>
819 <sect3 id="object-editor-data">
820 <title>Data Tabbed Section (Barcode objecs)</title>
822 <para>This section contains a text entry to enter literal barcode
823 data. Alternatively, a document merge key can be used to
824 provide this data at print time.</para>
828 <sect3 id="object-editor-style">
829 <title>Style Tabbed Section (Text objects)</title>
831 <para>This section contains controls to select text properties,
832 including font family, font size, font weight, color, and
833 text justification.</para>
837 <sect3 id="object-editor-barcode">
838 <title>Style Tabbed Section (Barcode objecs)</title>
840 <para>This section contains controls to select barcode properties,
841 including barcode style, color, whether to print text, and whether
842 to include a checksum digit.</para>
846 <sect3 id="object-editor-line">
847 <title>Line Tabbed Section</title>
849 <para>This section contains controls to select properties of lines
850 and outlines. These properties include line width and color.</para>
854 <sect3 id="object-editor-fill">
855 <title>Fill Tabbed Section</title>
857 <para>This section contains controls to select fill properties of box
858 and ellipse objects. Currently the only fill property is fill
863 <sect3 id="object-editor-size">
864 <title>Size Tabbed Section (All except line objects)</title>
866 <para>This section contains controls to select the width and height
867 of an object. A checkbox is provided, so that the current aspect
868 ratio can be locked while manipulating the width and height controls.
869 Image objects also provide a button to reset the size to the
870 image's natural size (Assumes 72DPI).</para>
874 <sect3 id="object-editor-size-line">
875 <title>Size Tabbed Section (Line objects)</title>
877 <para>This section contains controls to select the length and angle
878 of a line object.</para>
882 <sect3 id="object-editor-position">
883 <title>Position Tabbed Section</title>
885 <para>This section contains controls to change the position of an
891 <sect3 id="object-editor-shadow">
892 <title>Shadow Tabbed Section (All except image and barcode objects)</title>
894 <para>This section contains controls to add a shadow to an object.</para>
901 <!-- ============= Other Manipulations of Objects ========= -->
902 <sect2 id="glabels-object-manipulation">
903 <title>Other Manipulations of Objects</title>
905 <para>Objects can also be manipulated in the following ways.</para>
907 <sect3 id="other-moving-resizing">
908 <title>Moving and Resizing Objects</title>
910 <para>Objects can be moved by simply clicking on a selected
911 object and dragging the object to its new location. If the object
912 is part of an aggregate selection, all objects in the selection
913 will move with the object being dragged, maintaining their relative
914 positions to one another. If no object is selected, clicking on
915 an object will create a new selection containing that object.
916 See <xref linkend="glabels-select-objects" />.</para>
918 <para>A selected object can be resized by clicking one of its resize
919 handle and dragging it to obtain the new size.</para>
923 <sect3 id="other-stacking-order">
924 <title>Changing Stacking Order</title>
926 <para>Stacking order refers to relative position in the z-axis of
927 objects. That is when objects overlap, which object will appear
928 on top of the other. By default, newer objects will appear above
929 older objects. To change this order, select one or more objects
930 and choose <menuchoice> <guimenu>Objects</guimenu>
931 <guimenuitem>Order</guimenuitem>
932 <guimenuitem>Bring to Front</guimenuitem> </menuchoice>
933 to raise the selection to the top of the stacking
934 order, or choose <menuchoice> <guimenu>Objects</guimenu>
935 <guimenuitem>Order</guimenuitem>
936 <guimenuitem>Send to Back</guimenuitem> </menuchoice>
937 to lower the selection to the bottom of the
938 stacking order. These menuitems are also available by right-clicking
939 the display area when there is a non-empty selection.</para>
943 <sect3 id="other-rotating-flipping">
944 <title>Rotating and Flipping Objects</title>
946 <para>Objects can be rotated 90 degrees in either direction, or flipped
947 horizontally or vertically, by choosing the appropriate menuitem
948 in the <menuchoice> <guimenu>Objects</guimenu>
949 <guimenuitem>Rotate/Flip</guimenuitem> </menuchoice> sub-menu. These
950 menuitems are also available by right-clicking
951 the display area when there is a non-empty selection.</para>
955 <sect3 id="other-alignment">
956 <title>Aligning Objects</title>
958 <para>Objects can be aligned horizontally or vertically, relative to
959 one another, or relative to the center line of the label, by
960 choosing the appropriate menuitem from the <menuchoice>
961 <guimenu>Objects</guimenu>
962 <guimenuitem>Align Horizontal</guimenuitem>
963 </menuchoice> or <menuchoice> <guimenu>Objects</guimenu>
964 <guimenuitem>Align Horizontal</guimenuitem> </menuchoice> sub-menus.
965 These menuitems are also available by right-clicking
966 the display area when there is a non-empty selection.</para>
970 <sect3 id="other-property-bar">
971 <title>Using the Property Bar</title>
973 <para>The property bar can be used to change some common properties
974 of objects en-masse. These properties include font family, font
975 size, font weight, text alignment, text color, fill color, line
976 or outline color, and line width. The property bar also controls
977 the defaults for these properties for any newly created objects.
986 <!-- ============= Document Merge Features ========= -->
987 <sect2 id="glabels-merge">
988 <title>Performing a Document Merge</title>
990 <para>Document Merge (sometimes called "Mail Merge") is a powerful
991 feature that allows a unique label or card to be printed for each
992 record in an external data source.</para>
994 <para>The first step to performing a document merge is to prepare
995 a source document that contains your merge data. This data could
996 be mailing addresses or any other data that you wish to create
997 unique labels or cards for. Currently back-ends only exist for
998 text files and the evolution data server -- others are planned. The currently
999 supported text-file format is very simple: each line is a record;
1000 fields are delimited by commas (CSV), tabs, or colons; and newlines
1001 can be embedded into fields by using the "\n" entity. This file
1002 could be created using any text editor or could be created by
1003 another program or script. A common way of creating CSV files is
1004 to export them from a spreadsheet program.</para>
1006 <para>A label must then be configured to "point at" this data file.
1007 To configure the merge properties of a document, choose
1008 <menuchoice> <guimenu>Objects</guimenu>
1009 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item
1010 to display the <guilabel>merge properties</guilabel> dialog. This
1011 dialog is used to select the exact data file format and file
1012 name (location) of the merge data.</para>
1014 <para>Finally, once the label has been configured for a data file,
1015 field keys can be inserted into text objects and used as source
1016 or data for barcode objects and image filenames for image objects.
1017 See <xref linkend="glabels-object-properties" /> for more information
1018 on using merge data for these object types.</para>
1020 <para>Now that your label is configured, &app; will print a unique
1021 label for each record in your source document -- substituting fields
1022 from each record for field keys in the all text, barcode, and
1023 image objects.</para>
1025 <para>See <xref linkend="glabels-merge-tutorial" /> for a detailed
1026 tutorial on the document merge feature.</para>
1037 <!-- ============= Customization ============================= -->
1038 <!-- Use this section to describe how to customize the application. -->
1039 <sect1 id="glabels-prefs">
1040 <title>Settings</title>
1041 <para>To configure &app;, choose
1043 <guimenu>Settings</guimenu>
1044 <guimenuitem>Preferences</guimenuitem>
1046 <guilabel>Preferences</guilabel> dialog contains the following tabbed
1051 <xref linkend="glabels-prefs-locale"/></para>
1055 <xref linkend="glabels-prefs-object-defaults"/></para>
1058 <!-- =============== Customization Subsection ================ -->
1059 <!-- Use a new section to describe different tabbed sections on the Settings or Preferences
1061 <sect2 id="glabels-prefs-locale">
1062 <title>Locale</title>
1066 <guilabel>Units</guilabel> </term>
1068 <para>Use this radio button group to specify your preferred units.
1069 Select one of the following options:</para>
1073 <guilabel>Points</guilabel> </para>
1074 <para>Use points (1 point = 1/72 in = 0.352778 mm).</para>
1078 <guilabel>Inches</guilabel> </para>
1079 <para>Use inches.</para>
1083 <guilabel>Millimeters</guilabel> </para>
1084 <para>Use millimeters.</para>
1088 <guilabel>Inches</guilabel>.</para>
1093 <guilabel>Default page size</guilabel> </term>
1095 <para>Use this radio button group to specify your preferred page size.
1096 This will make it quicker for you to locate media types when creating a new
1097 label or card.</para>
1101 <guilabel>US Letter</guilabel> </para>
1102 <para>Most of your media will be of the US Letter page size (8.5 x 11 inches).</para>
1106 <guilabel>ISO A4</guilabel> </para>
1107 <para>Most of your media will be of the ISO A4 page size (210 x 297 mm).</para>
1111 <guilabel>US Letter</guilabel>.</para>
1116 <!-- ============= Customization Subsection ===================== -->
1117 <!-- Another tabbed section on the Preferences dialog. -->
1118 <sect2 id="glabels-prefs-object-defaults">
1119 <title>Object defaults</title>
1123 <guilabel>Text</guilabel> </term>
1125 <para>Use these controls to set the default properties of new text objects.
1126 These properties are</para>
1130 <guilabel>Font</guilabel> </para>
1131 <para>These controls are used to select font family and font size, and
1132 whether the font should bold or in italics.</para>
1136 <guilabel>Color</guilabel> </para>
1137 <para>This control selects the default text color.</para>
1141 <guilabel>Alignment</guilabel> </para>
1142 <para>These controls are used to select the default text alignment (left, center or right).</para>
1149 <guilabel>Line</guilabel> </term>
1151 <para>Use these controls to set the default properties of lines and outlines of
1152 new objects. These properties are</para>
1156 <guilabel>Width</guilabel> </para>
1157 <para>This control selects the default line width.</para>
1161 <guilabel>Color</guilabel> </para>
1162 <para>This control selects the default line color.</para>
1169 <guilabel>Fill</guilabel> </term>
1171 <para>Use these controls to set the default fill properties of
1172 new objects. These properties are</para>
1176 <guilabel>Color</guilabel> </para>
1177 <para>This control selects the default fill color.</para>
1189 <!-- ============= Document Merge Tutorial ================================== -->
1190 <sect1 id="glabels-merge-tutorial">
1191 <title>Document Merge Tutorial</title>
1193 <para>Document Merge (sometimes called "Mail Merge") is a powerful
1194 feature that allows a unique label or card to be printed for each
1195 record in an external data source. It is however, the most mis-understood
1196 feature of &app;. The following examples
1197 will step through a couple of common tasks using the document merge
1200 <sect2 id="merge-ex1">
1201 <title>Example 1: Name Tags Using a CSV File</title>
1203 <para>In this example we are organizing an orientation party for the new
1204 crew members of our ship. We have a list of freshman crew members that we
1205 created in <application>gnumeric</application> and exported as the following
1206 CSV file. We could have created this file by using a text editor, but heck it
1207 is the 23rd century.</para>
1211 "Jim Kirk",Management,"SC937-0176 CEC"
1212 "Mr. Spock",Sciences,S179-276SP
1213 "Leonard McCoy",Medicine,unknown
1214 "Montgomery Scott",Engineering,SE-197-54T
1217 <para>In &app; we have created a new &app;
1218 document using the Avery 5395 "Name Badge Labels" template. Next we use the
1219 <menuchoice> <guimenu>Objects</guimenu>
1220 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item to display
1221 the <guilabel>merge properties</guilabel> dialog. We use this dialog to
1222 select the source type (in our case CSV) and the merge source (filename) as
1225 <!-- ==== Figure ==== -->
1226 <figure id="merge-ex1-1-fig">
1227 <title>Merge properties dialog</title>
1230 <imageobject><imagedata
1231 fileref="figures/merge-ex1-1.png" format="PNG"/>
1236 <!-- ==== End of Figure ==== -->
1238 <para>Before applying the merge source, we uncheck the first record since it is only
1239 column headers from our original <application>gnumeric</application> spreadsheet
1240 and would simply waste our first label. We could also unselect any other records
1241 that we didn't want to print a label for.</para>
1243 <para>We can also view each record in more detail by clicking on the appropriate
1244 expander (the little triangles) as shown. Once we are satisfied with the
1245 selections in this dialog we click <guibutton>OK</guibutton> to accept the
1248 <para>Now we start adding objects to our &app; document as shown.</para>
1250 <!-- ==== Figure ==== -->
1251 <figure id="merge-ex1-2-fig">
1252 <title>Adding objects</title>
1255 <imageobject><imagedata
1256 fileref="figures/merge-ex1-2.png" format="PNG"/>
1261 <!-- ==== End of Figure ==== -->
1263 <para>In this example we have added three text objects and a barcode object. The
1264 first text object contains only simple literal text ("Hello, my name is"). The
1265 second text object contains a single merge field ("${1}") corresponding to the
1266 first field of a record (first column of a line) which contains the new crew
1267 member's full name. The third text field contains both literal text
1268 ("Department: ") followed by a single merge field ("${2}") corresponding to
1269 the second field or the crew member's department. The barcode object is
1270 configured to use field (or key) "3" which contains our crew member's
1271 starfleet serial number.</para>
1273 <para>Now we can print our name tags by selecting the
1274 <menuchoice> <guimenu>File</guimenu>
1275 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1276 print dialog as shown below.</para>
1278 <!-- ==== Figure ==== -->
1279 <figure id="merge-ex1-3-fig">
1280 <title>Printing name tags</title>
1283 <imageobject><imagedata
1284 fileref="figures/merge-ex1-3.png" format="PNG"/>
1289 <!-- ==== End of Figure ==== -->
1291 <para>Just to make sure our labels are going to look okay, we select the
1292 <guilabel>Print outlines</guilabel> option and click
1293 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1294 as shown below.</para>
1296 <!-- ==== Figure ==== -->
1297 <figure id="merge-ex1-4-fig">
1298 <title>Name tags preview</title>
1301 <imageobject><imagedata
1302 fileref="figures/merge-ex1-4.png" format="PNG"/>
1307 <!-- ==== End of Figure ==== -->
1309 <para>Everything looks good, so we can now load up our printer with
1310 the appropriate label stock, print our name tags and start beaming our guests
1315 <sect2 id="merge-ex2">
1316 <title>Example 2: Address Labels Using a CSV File</title>
1318 <para>In this example we are going to throw a party and need to print mailing
1319 address labels for our invitations. We have a list of our closest friends
1320 that we created in <application>gnumeric</application> and exported as the
1321 following CSV file. It should be noted that not everyone has a middle initial or
1322 a two line address.</para>
1325 LAST,FIRST,MI,ADDR1,ADDR2,CITY,STATE,ZIP
1327 Critter,Ess,S,"123 Faux St.",,Alexandria,VA,22310
1328 Doe,John,,"Apt 1X","451 Mystery St.",Trenton,NJ,08601
1329 Summers,Joyce,,"1630 Revello Dr",,Sunnydale,CA,95037
1330 McGarret,Steve,O,"404 Piikoi Street",,Honolulu,HI,96813
1331 Kramer,Cosmo,,"Apt 5B","129 W. 81 St.","New York",NY,10024-7207
1334 <para>In &app; we have created a new &app;
1335 document using the Avery 5512 "Address Labels" template. Next we use the
1336 <menuchoice> <guimenu>Objects</guimenu>
1337 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item to display
1338 the <guilabel>merge properties</guilabel> dialog. We use this dialog to
1339 select the source type (in our case CSV) and the merge source (filename) as
1342 <!-- ==== Figure ==== -->
1343 <figure id="merge-ex2-1-fig">
1344 <title>Merge properties dialog</title>
1347 <imageobject><imagedata
1348 fileref="figures/merge-ex2-1.png" format="PNG"/>
1353 <!-- ==== End of Figure ==== -->
1355 <para>Before applying the merge source, we uncheck the first record since it is only
1356 column headers from our original <application>gnumeric</application> spreadsheet
1357 and would simply waste our first label. We also unselect the second record
1358 which is empty (an artifact of our original spreadsheet). We could also unselect
1359 any other records that we didn't want to print a label for.</para>
1361 <para>We can also view each record in more detail by clicking on the appropriate
1362 expander (the little triangles) as shown. Once we are satisfied with the
1363 selections in this dialog we click <guibutton>OK</guibutton> to accept the
1366 <para>Now we start adding objects to our &app; document as shown.</para>
1368 <!-- ==== Figure ==== -->
1369 <figure id="merge-ex2-2-fig">
1370 <title>Adding objects</title>
1373 <imageobject><imagedata
1374 fileref="figures/merge-ex2-2.png" format="PNG"/>
1379 <!-- ==== End of Figure ==== -->
1381 <para>In this example we have a single text object. This text object contains
1382 all of our merge fields organized on multiple lines as a mailing address.
1383 Notice that fields ${4} and ${5} (corresponding to ADDR1 and ADDR2) are each
1384 located with no other text on their own lines. When
1385 &app; encounters a field as the only text on
1386 a line, it will not expand the line if the field is empty.</para>
1388 <para>Now we can print our address labels by selecting the
1389 <menuchoice> <guimenu>File</guimenu>
1390 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1391 print dialog as shown below.</para>
1393 <!-- ==== Figure ==== -->
1394 <figure id="merge-ex2-3-fig">
1395 <title>Printing address labels</title>
1398 <imageobject><imagedata
1399 fileref="figures/merge-ex2-3.png" format="PNG"/>
1404 <!-- ==== End of Figure ==== -->
1406 <para>Just to make sure our labels are going to look okay, we select the
1407 <guilabel>Print outlines</guilabel> option and click
1408 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1409 as shown below.</para>
1411 <!-- ==== Figure ==== -->
1412 <figure id="merge-ex2-4-fig">
1413 <title>Address labels preview</title>
1416 <imageobject><imagedata
1417 fileref="figures/merge-ex2-4.png" format="PNG"/>
1422 <!-- ==== End of Figure ==== -->
1424 <para>Everything looks good, so we can now load up our printer with
1425 the appropriate label stock, print our address labels and start mailing
1426 our party invitations.</para>
1430 <sect2 id="merge-ex3">
1431 <title>Example 3: Address Labels Using the <application>Evolution</application> Addressbook</title>
1433 <para>Our last party was a great success, and now we need to print mailing
1434 address labels for the invitations to a new one. To simplify this, we can use
1435 the <application>Evolution</application> addressbook, because the address
1436 data of all our friends is stored there.</para>
1439 <para>Depending on how your copy of &app; was packaged, this option could be unavailable.
1440 Support for the <application>Evolution</application> addressbook will only be available
1441 if the <application>evolution-data-server</application> and its development files
1442 were present when &app; was built. Please keep this in mind if you build &app;
1443 directly from source.</para>
1445 <para>If the &app; package from your distribution lacks this support,
1446 you may wish to contact the package maintainer or file a bug against the package
1447 to request it.</para>
1450 <para>In <application>glabels</application> we have created a new &app;
1451 document using the Avery 5512 "Address Labels" template. Next we use the
1452 <menuchoice> <guimenu>Objects</guimenu>
1453 <guimenuitem>Merge Properties</guimenuitem></menuchoice> menu item to display
1454 the <guilabel>Merge properties</guilabel> dialog. We use this dialog to
1455 select the source type (in our case <guilabel>Data from default Evolution
1456 addressbook</guilabel>) as shown.</para>
1458 <!-- ==== Figure ==== -->
1459 <figure id="merge-ex3-1-fig">
1460 <title>Merge properties dialog</title>
1463 <imageobject><imagedata
1464 fileref="figures/merge-ex3-1.png" format="PNG"/>
1469 <!-- ==== End of Figure ==== -->
1471 <para>Once we have chosen <guilabel>Data from default Evolution addressbook
1472 </guilabel> as our merge source, we will get a full list of its content. Initially,
1473 all entries are checked. Assuming we were planning a really big party, we could
1474 leave this selection untouched (but let's keep our budget in mind). We will now select or
1475 unselect certain entries by clicking on the appropriate checkboxes, or we could use
1476 the <guibutton>Select all</guibutton> and <guibutton>Unselect all
1477 </guibutton> buttons to activate or deactivate all entries in the address book.</para>
1479 <para>We can also view each entry in more detail by clicking on the appropriate
1480 expander (the little triangles) as shown. Once we are satisfied with the
1481 selections in this dialog, we will click the <guibutton>OK</guibutton> button to
1482 accept the changes.</para>
1484 <para>Now we start adding objects to our glabels document as shown.</para>
1486 <!-- ==== Figure ==== -->
1487 <figure id="merge-ex3-2-fig">
1488 <title>Adding objects</title>
1491 <imageobject><imagedata
1492 fileref="figures/merge-ex3-2.png" format="PNG"/>
1497 <!-- ==== End of Figure ==== -->
1499 <para>In this example we have a single text object again. This text object contains
1500 all of our merge fields organized on multiple lines as a mailing address.</para>
1502 <para>Now we can print our address labels by selecting the
1503 <menuchoice> <guimenu>File</guimenu>
1504 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1505 the print dialog as shown below.</para>
1507 <!-- ==== Figure ==== -->
1508 <figure id="merge-ex3-3-fig">
1509 <title>Printing address labels</title>
1512 <imageobject><imagedata
1513 fileref="figures/merge-ex2-3.png" format="PNG"/>
1518 <!-- ==== End of Figure ==== -->
1520 <para>Just to make sure our labels are going to look okay, we select the
1521 <guilabel>Print outlines</guilabel> option and click
1522 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1523 as shown below.</para>
1525 <!-- ==== Figure ==== -->
1526 <figure id="merge-ex3-4-fig">
1527 <title>Address labels preview</title>
1530 <imageobject><imagedata
1531 fileref="figures/merge-ex2-4.png" format="PNG"/>
1536 <!-- ==== End of Figure ==== -->
1538 <para>Everything looks good, so we can now load up our printer with
1539 the appropriate label stock, print our address labels and start mailing
1540 our party invitations.</para>
1549 <!-- ============= Creating templates ================================== -->
1550 <sect1 id="glabels-manual-create-template">
1551 <title>Manually Creating New Templates</title>
1553 <para>Predefined templates are defined by XML files located in
1554 <filename>${prefix}/share/glabels/</filename>,
1555 where <filename>${prefix}</filename> is usually something like
1556 <filename>/usr/local</filename> or <filename>/usr</filename> depending
1557 on the configuration option <filename>prefix</filename>. &app; will
1558 use all files of the form <filename>*-templates.xml</filename>
1559 or <filename>*.template</filename>, that it finds in
1560 <filename>${prefix}/share/glabels/</filename> and
1561 <filename>${HOME}/.glabels/</filename>.
1562 Additional templates can be added by creating additional
1563 <filename>*.template</filename> files in either of these directories.
1566 <para>The format for these files is defined in the DTD:
1567 <ulink url="http://glabels.sourceforge.net/doc/glabels-2.0.dtd.txt"
1568 type="http">glabels-2.2.dtd</ulink>. (This DTD also describes other
1569 XML formats used by &app;.)</para>
1571 <sect2 id="template-assumptions">
1572 <title>Assumptions/caveats</title>
1575 <para>A sheet contains only one size of label or card (if a sheet
1576 contains more than one size of item, it can be split into
1577 multiple templates for multiple pass printing)</para>
1580 <para>Distances can be expressed in units of <emphasis>pt</emphasis>,
1581 <emphasis>in</emphasis>, <emphasis>mm</emphasis>,
1582 <emphasis>cm</emphasis>, or <emphasis>pc</emphasis>. For example:
1583 "<literal>1.0in</literal>" or "<literal>2.54cm</literal>". If no
1584 units are specified, computer points (<emphasis>pt</emphasis>) will
1585 be assumed (1 <emphasis>pt</emphasis> =
1586 1/72 <emphasis>in</emphasis> = 0.352778 <emphasis>mm</emphasis>).
1592 <sect2 id="template-file">
1593 <title>Template Files</title>
1596 <?xml version="1.0"?>
1597 <Glabels-templates>
1599 <replaceable>...templates...</replaceable>
1601 </Glabels-templates>
1606 <sect2 id="template-example">
1607 <title>Example Template</title>
1609 <Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels">
1610 <Label-rectangle id="0" width="189pt" height="72pt" round="5pt">
1611 <Markup-margin size="5pt"/>
1612 <Layout nx="3" ny="10" x0="11.25pt" y0="36pt" dx="200pt" dy="72pt"/>
1613 </Label-rectangle>
1614 <Alias brand="Avery" part="5160"/>
1615 <Alias brand="Avery" part="6233"/>
1620 <sect2 id="template-template-node">
1621 <title>Template Node</title>
1623 <para>A <emphasis>Template</emphasis> node describes a single stationary
1624 product. It must contain one instance of any type of Label node
1625 (<emphasis>Label-rectangle</emphasis>,
1626 <emphasis>Label-round</emphasis>, or <emphasis>Label-cd</emphasis>).
1627 This node can be followed by zero or more
1628 <emphasis>Alias</emphasis> nodes.</para>
1630 <informaltable frame="topbot">
1632 <colspec colname="col1"/>
1633 <colspec colname="col2"/>
1636 <entry colname="col1" colsep="0" valign="top">
1637 <para>Property</para>
1639 <entry colname="col2" valign="top">
1640 <para>Description</para>
1646 <entry><para>brand</para></entry>
1648 <para>Brand or manufacturer of stationary product.
1653 <entry><para>part</para></entry>
1655 <para>Part number or name of stationary product.
1660 <entry><para>size</para></entry>
1662 <para>Size of sheet. E.g., "US-Letter," "A4", ...</para>
1666 <entry><para>description</para></entry>
1668 <para>Description of stationary product. E.g,
1669 "Mailing Labels."</para>
1673 <entry><para>_description</para></entry>
1675 <para>Translatable description of stationary product.
1676 E.g, "Mailing Labels." (Only useful for predefined
1681 <entry><para>width</para></entry>
1683 <para>Page width. Only valid if size="Other"</para>
1687 <entry><para>height</para></entry>
1689 <para>Page height. Only valid if size="Other"</para>
1698 <sect2 id="template-label-rectangle-node">
1699 <title>Label-rectangle Node</title>
1701 <para>A <emphasis>Label-rectangle</emphasis> node describes the
1702 dimensions of a single label or business card that is rectangular
1703 in shape (may have rounded edges).</para>
1705 <informaltable frame="topbot">
1707 <colspec colname="col1"/>
1708 <colspec colname="col2"/>
1711 <entry colname="col1" colsep="0" valign="top">
1712 <para>Property</para>
1714 <entry colname="col2" valign="top">
1715 <para>Description</para>
1721 <entry><para>id</para></entry>
1723 <para>Reserved for future use. Should always be 0.</para>
1727 <entry><para>width</para></entry>
1728 <entry><para>Width of label/card</para></entry>
1731 <entry><para>height</para></entry>
1732 <entry><para>Height of label/card</para></entry>
1735 <entry><para>round</para></entry>
1737 <para>Radius of corners. For items with square edges
1738 (business cards), the radius should be 0.</para>
1742 <entry><para>x_waste</para></entry>
1744 <para>Amount of horizontal waste (over-print) to allow. This is useful
1745 for minimizing alignment problems when using non-white
1746 backgrounds (e.g. images).</para>
1750 <entry><para>y_waste</para></entry>
1752 <para>Amount of vertical waste (over-print) to allow. This is useful
1753 for minimizing alignment problems when using non-white
1754 backgrounds (e.g. images).</para>
1761 <!-- ==== Figure ==== -->
1762 <figure id="template-label-fig">
1763 <title>Label-rectangle Parameters</title>
1766 <imageobject><imagedata
1767 fileref="figures/glabels-template-label.png" format="PNG"/>
1772 <!-- ==== End of Figure ==== -->
1776 <sect2 id="template-label-round-node">
1777 <title>Label-round Node</title>
1779 <para>A <emphasis>Label-round</emphasis> node describes the dimensions
1780 of a simple round label (not a CD).</para>
1782 <informaltable frame="topbot">
1784 <colspec colname="col1"/>
1785 <colspec colname="col2"/>
1788 <entry colname="col1" colsep="0" valign="top">
1789 <para>Property</para>
1791 <entry colname="col2" valign="top">
1792 <para>Description</para>
1798 <entry><para>id</para></entry>
1800 <para>Reserved for future use. Should always be 0.</para>
1804 <entry><para>radius</para></entry>
1805 <entry><para>Radius (1/2 diameter) of label</para></entry>
1808 <entry><para>waste</para></entry>
1810 <para>Amount of waste (over-print) to allow. This is useful
1811 for minimizing alignment problems when using non-white
1812 backgrounds (e.g. images).</para>
1821 <sect2 id="template-label-cd-node">
1822 <title>Label-cd Node</title>
1824 <para>A <emphasis>Label-cd</emphasis> node describes the dimensions
1825 of a CD, DVD, or business card CD.</para>
1827 <informaltable frame="topbot">
1829 <colspec colname="col1"/>
1830 <colspec colname="col2"/>
1833 <entry colname="col1" colsep="0" valign="top">
1834 <para>Property</para>
1836 <entry colname="col2" valign="top">
1837 <para>Description</para>
1843 <entry><para>id</para></entry>
1845 <para>Reserved for future use. Should always be 0.</para>
1849 <entry><para>radius</para></entry>
1850 <entry><para>Outer radius of label</para></entry>
1853 <entry><para>hole</para></entry>
1854 <entry><para>Radius of concentric hole</para></entry>
1857 <entry><para>width</para></entry>
1859 <para>If present, the label is clipped to the given width.
1860 (Useful for "business card CDs").</para>
1864 <entry><para>height</para></entry>
1866 <para>If present, the label is clipped to the given height.
1867 (Useful for "business card CDs").</para>
1871 <entry><para>waste</para></entry>
1873 <para>Amount of waste (over-print) to allow. This is useful
1874 for minimizing alignment problems when using non-white
1875 backgrounds (e.g. images).</para>
1882 <!-- ==== Figure ==== -->
1883 <figure id="template-label-cd-fig">
1884 <title>CD Label Parameters</title>
1887 <imageobject><imagedata
1888 fileref="figures/glabels-template-cd.png" format="PNG"/>
1893 <!-- ==== End of Figure ==== -->
1897 <sect2 id="template-markup-margin-node">
1898 <title>Markup-margin Node</title>
1900 <para>A <emphasis>Markup-margin</emphasis> describes a margin along
1901 all edges of a label.</para>
1903 <informaltable frame="topbot">
1905 <colspec colname="col1"/>
1906 <colspec colname="col2"/>
1909 <entry colname="col1" colsep="0" valign="top">
1910 <para>Property</para>
1912 <entry colname="col2" valign="top">
1913 <para>Description</para>
1919 <entry><para>size</para></entry>
1921 <para>Size of the margin. I.e. the distance of the margin
1922 line from the edge of the card/label.</para>
1931 <sect2 id="template-markup-line-node">
1932 <title>Markup-line Node</title>
1934 <para>A <emphasis>Markup-line</emphasis> describes a markup line.</para>
1936 <informaltable frame="topbot">
1938 <colspec colname="col1"/>
1939 <colspec colname="col2"/>
1942 <entry colname="col1" colsep="0" valign="top">
1943 <para>Property</para>
1945 <entry colname="col2" valign="top">
1946 <para>Description</para>
1952 <entry><para>x1</para></entry>
1954 <para>x coordinate of 1st endpoint of the line segment.</para>
1958 <entry><para>y1</para></entry>
1960 <para>y coordinate of 1st endpoint of the line segment.</para>
1964 <entry><para>x2</para></entry>
1966 <para>x coordinate of 2nd endpoint of the line segment.</para>
1970 <entry><para>y2</para></entry>
1972 <para>y coordinate of 2nd endpoint of the line segment.</para>
1981 <sect2 id="template-markup-circle-node">
1982 <title>Markup-circle Node</title>
1984 <para>A <emphasis>Markup-circle</emphasis> describes a markup circle.
1987 <informaltable frame="topbot">
1989 <colspec colname="col1"/>
1990 <colspec colname="col2"/>
1993 <entry colname="col1" colsep="0" valign="top">
1994 <para>Property</para>
1996 <entry colname="col2" valign="top">
1997 <para>Description</para>
2003 <entry><para>x0</para></entry>
2005 <para>x coordinate of circle origin (center).</para>
2009 <entry><para>y0</para></entry>
2011 <para>y coordinate of circle origin (center).</para>
2015 <entry><para>radius</para></entry>
2016 <entry><para>Radius of circle.</para></entry>
2024 <sect2 id="template-markup-rect-node">
2025 <title>Markup-rect Node</title>
2027 <para>A <emphasis>Markup-rect</emphasis> describes a markup rectangle.
2030 <informaltable frame="topbot">
2032 <colspec colname="col1"/>
2033 <colspec colname="col2"/>
2036 <entry colname="col1" colsep="0" valign="top">
2037 <para>Property</para>
2039 <entry colname="col2" valign="top">
2040 <para>Description</para>
2046 <entry><para>x1</para></entry>
2048 <para>x coordinate of upper left corner of rectangle.</para>
2052 <entry><para>y1</para></entry>
2054 <para>y coordinate of upper left corner of rectangle.</para>
2058 <entry><para>w</para></entry>
2060 <para>Width of rectangle.</para>
2064 <entry><para>h</para></entry>
2066 <para>Height of rectangle.</para>
2070 <entry><para>r</para></entry>
2071 <entry><para>Radius of rounded corners of rectangle.</para></entry>
2079 <sect2 id="template-layout-node">
2080 <title>Layout Node</title>
2082 <para>A label node may contain multiple <emphasis>Layout</emphasis>
2083 children. If labels are arranged in a simple grid pattern, only
2084 one layout is needed. However, if labels are arranged in multiple
2085 grids, such as a running bond pattern, multiple
2086 <emphasis>layout</emphasis> tags can be used. Note: a single label
2087 can always be treated as a grid of one.</para>
2089 <informaltable frame="topbot">
2091 <colspec colname="col1"/>
2092 <colspec colname="col2"/>
2095 <entry colname="col1" colsep="0" valign="top">
2096 <para>Property</para>
2098 <entry colname="col2" valign="top">
2099 <para>Description</para>
2105 <entry><para>nx</para></entry>
2107 <para>Number of labels/cards across in the grid
2112 <entry><para>ny</para></entry>
2114 <para>Number of labels/cards up and down in the grid
2119 <entry><para>x0</para></entry>
2121 <para>Distance from left edge of sheet to the left edge of
2122 the left column of cards/labels in the layout.</para>
2126 <entry><para>y0</para></entry>
2128 <para>Distance from the top edge of sheet to the top edge of
2129 the top row of labels/cards in the layout.</para>
2133 <entry><para>dx</para></entry>
2134 <entry><para>Horizontal pitch of grid.</para></entry>
2137 <entry><para>dy</para></entry>
2138 <entry><para>Vertical pitch of grid.</para></entry>
2144 <!-- ==== Figure ==== -->
2145 <figure id="template-layout-fig">
2146 <title>Layout Parameters</title>
2149 <imageobject><imagedata
2150 fileref="figures/glabels-template-layout.png" format="PNG"/>
2155 <!-- ==== End of Figure ==== -->
2159 <sect2 id="template-alias-node">
2160 <title>Alias Node</title>
2162 <para>An <emphasis>Alias</emphasis> node provides the name of a
2163 product with the same size and layout characteristics as the
2164 parent template.</para>
2166 <informaltable frame="topbot">
2168 <colspec colname="col1"/>
2169 <colspec colname="col2"/>
2172 <entry colname="col1" colsep="0" valign="top">
2173 <para>Property</para>
2175 <entry colname="col2" valign="top">
2176 <para>Description</para>
2182 <entry><para>brand</para></entry>
2184 <para>The brand or manufacturer of the equivalent product.</para>
2188 <entry><para>part</para></entry>
2190 <para>The part number or name of the equivalent product.</para>
2204 <!-- ============= Bugs ================================== -->
2205 <!-- This section is optional and is commented out by default.
2206 You can use it to describe known bugs and limitations of the
2207 program if there are any - please be frank and list all
2208 problems you know of.
2210 <sect1 id="mayapp-bugs">
2211 <title>Known Bugs and Limitations</title>
2219 <!-- ============= About ================================== -->
2220 <!-- This section contains info about the program (not docs), such as
2221 author's name(s), web page, license, feedback address. This
2222 section is optional: primary place for this info is "About.." box of
2223 the program. However, if you do wish to include this info in the
2224 manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
2225 <sect1 id="glabels-about">
2226 <title>About &app;</title>
2227 <para> &app; was written by Jim Evins
2228 (<email>evins@snaught.com</email>). To find more information about
2229 &app;, please visit the
2230 <ulink url="http://glabels.sourceforge.net" type="http">gLabels Web
2231 page</ulink>. </para>
2233 To report a bug or make a suggestion regarding this application or
2234 this manual, follow the directions at the
2235 <ulink url="http://glabels.sourceforge.net/contact/" type="http">&app; Contact Page</ulink>.
2238 <para> This program is distributed under the terms of the GNU
2239 General Public license as published by the Free Software
2240 Foundation; either version 2 of the License, or (at your option)
2241 any later version. A copy of this license can be found at this
2242 <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
2243 COPYING included with the source code of this program. </para>