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>
34 <year>2003-2007</year>
35 <holder>Jim Evins</holder>
38 <!-- translators: uncomment this:
42 <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
47 <!-- An address can be added to the publisher information. If a role is
48 not specified, the publisher/author is the same for all versions of the
51 <publishername> Jim Evins </publishername>
55 <!-- This file contains link to license for the documentation (GNU FDL), and
56 other legal stuff such as "NO WARRANTY" statement. Please do not change
61 <firstname>Jim</firstname>
62 <surname>Evins</surname>
65 <!-- This is appropriate place for other contributors: translators,
66 maintainers, etc. Commented out by default.
68 <othercredit role="translator">
69 <firstname>Latin</firstname>
70 <surname>Translator 1</surname>
72 <orgname>Latin Translation Team</orgname>
73 <address> <email>translator@gnome.org</email> </address>
75 <contrib>Latin translation</contrib>
81 <!-- According to GNU FDL, revision history is mandatory if you are -->
82 <!-- modifying/reusing someone else's document. If not, you can omit it. -->
83 <!-- Remember to remove the &manrevision; entity from the revision entries other
85 <!-- than the current revision. -->
86 <!-- The revision numbering system for GNOME manuals is as follows: -->
87 <!-- * the revision number consists of two components -->
88 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
89 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
90 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
91 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
92 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
93 <!-- to V3.0, and so on. -->
96 <revnumber>gLabels Manual V&manrevision;</revnumber>
99 <para role="author">Jim Evins
100 <email>evins@snaught.com</email>
102 <para role="publisher">Jim Evins</para>
107 <releaseinfo>This manual describes version &appversion; of gLabels.
110 <title>Feedback</title>
111 <para>To report a bug or make a suggestion regarding the &app; application or
112 this manual, follow the directions in the <ulink url="http://glabels.sourceforge.net/contact/"
113 type="http">gLabels Contact Page</ulink>.
115 <!-- Translators may also add here feedback address for translations -->
119 <indexterm zone="index">
120 <primary>gLabels</primary>
122 <indexterm zone="index">
123 <primary>glabels</primary>
129 <!-- ============= Document Body ============================= -->
130 <!-- ============= Introduction ============================== -->
131 <!-- Use the Introduction section to give a brief overview of what
132 the application is and what it does. -->
133 <sect1 id="glabels-introduction">
134 <title>Introduction</title>
136 <para>The &app; application is a lightweight program for creating labels
137 and business cards for the <systemitem>GNOME desktop</systemitem>
138 environment. It is designed to work with various laser/ink-jet
139 peel-off label and business card sheets that you'll find at most
140 office supply stores.</para>
147 <!-- =========== Getting Started ============================== -->
148 <!-- Use the Getting Started section to describe the steps required
149 to start the application and to describe the user interface components
150 of the application. If there is other information that it is important
151 for readers to know before they start using the application, you should
152 also include this information here.
153 If the information about how to get started is very short, you can
154 include it in the Introduction and omit this section. -->
156 <sect1 id="glabels-getting-started">
157 <title>Getting Started</title>
159 <sect2 id="glabels-start">
160 <title>To Start &app;</title>
161 <para>You can start <application>&app;</application> in the following ways:
165 <term><guimenu>Applications</guimenu> menu</term>
169 <guisubmenu>Office</guisubmenu>
170 <guimenuitem>gLabels</guimenuitem>
171 </menuchoice>. </para>
175 <term>Command line</term>
177 <para>Type <command>glabels</command>,
178 then press <keycap>Return</keycap>:</para>
184 <sect2 id="glabels-when-start">
185 <title>When You Start &app;</title>
186 <para>When you start <application>&app;</application>, the following window is displayed.</para>
188 <!-- ==== Figure ==== -->
189 <figure id="mainwindow-fig">
190 <title>&app; Start Up Window</title>
193 <imageobject><imagedata
194 fileref="figures/main-window-empty.png" format="PNG"/>
199 <!-- ==== End of Figure ==== -->
201 <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
202 <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
204 <para>The &app; window contains the following elements:
208 <term>Menubar. </term>
210 <para>The menus on the menubar contain all of the commands you
211 need to create and edit labels and business cards in
212 <application>&app;</application>.</para>
216 <term>Main toolbar. </term>
218 <para>The main toolbar contains a subset of common File and Edit
219 commands that you can access from the menubar.</para>
223 <term>Drawing toolbar. </term>
225 <para>The drawing toolbar contains a subset of commands for
226 editing the current glabels document.</para>
230 <term>Display area. </term>
232 <para>The display area is the main drawing interface to
233 <application>&app;</application>.</para>
237 <term>Object sidebar. </term>
239 <para>The object sidebar provides an interface for viewing and
240 editing all properties of an individual object. </para>
244 <term>Properties toolbar. </term>
246 <para>The properties toolbar contains a set of tools to
247 manipulate the properties of selected objects and set default
248 properties for new objects.</para>
252 <term>Statusbar. </term>
254 <para>The statusbar displays information about current
255 <application>&app;</application> activity and contextual
256 information about the menu items. </para>
266 <!-- ================ Usage ================================ -->
267 <!-- Use this section to describe how to use the application to perform the tasks for
268 which the application is designed. -->
269 <sect1 id="glabels-usage">
272 <!-- ============= To create a new file ============================= -->
273 <sect2 id="glabels-open-new">
274 <title>To Create a New Label or Card</title>
276 <para>To create a new label or business card, choose
277 <menuchoice> <guimenu>File</guimenu> <guimenuitem>New</guimenuitem>
279 to display the <guilabel>New Label or Card</guilabel> dialog. Select
280 the media type and orientation for the new document,
281 then click <guibutton>OK</guibutton>. A new document is
282 displayed in the display area of the <application>&app;</application>
285 <para>If your particular media type is missing from this dialog,
286 see <xref linkend="glabels-create-template"/></para>
290 <!-- ============= To Open a File ============================= -->
291 <sect2 id="glabels-open-file">
292 <title>To Open a File</title>
294 <para>To open a file, choose
295 <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open</guimenuitem>
296 </menuchoice> to display the <guilabel>Open File</guilabel> dialog.
297 Select the file that you want to open, then click
298 <guibutton>OK</guibutton>. The file is displayed in the display area
299 of the <application>&app;</application> window. </para>
301 <para>You can also open multiple files in
302 <application>&app;</application>. The application creates a separate
303 application window for each open file.</para>
305 <para>The application records the paths and filenames of the
306 most recent files that you have edited and displays the files as menu
307 items on the <menuchoice>
308 <guimenu>File</guimenu><guisubmenu>Recent Files</guisubmenu>
309 </menuchoice> menu.</para>
313 <!-- ============= To Open Multiple Files from the Command Line ========= -->
314 <sect2 id="glabels-run-from-cmd-line">
315 <title>To Open Multiple Files from a Command Line</title>
317 <para>You can run <application>&app;</application> from a command line
318 and open a single file or multiple files. To open multiple files from
319 a command line, type the following command, then press
320 <keycap>Return</keycap>:</para>
322 <para><command>glabels
323 <replaceable>file1.glabels file2.glabels file3.glabels</replaceable>
326 <para>When the application starts, the files that you specify are
327 displayed in separate <application>&app;</application> windows.</para>
331 <!-- ============= To Save a File ========= -->
332 <sect2 id="glabels-save-file">
333 <title>To Save a File</title>
335 <para>You can save files in the following ways:</para>
340 <para>To save changes to an existing file, choose
341 <menuchoice> <guimenu>File</guimenu>
342 <guimenuitem>Save</guimenuitem> </menuchoice>. </para>
347 <para>To save a new file or to save an existing file under a new
348 filename, choose <menuchoice> <guimenu>File</guimenu>
349 <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name
350 for the file in the <guilabel>Save As</guilabel> dialog box,
351 then click <guibutton>OK</guibutton>.</para>
358 <!-- ============= To Change Label Properties ========= -->
359 <sect2 id="glabels-label-properties">
360 <title>To Change Label Properties</title>
362 <para>To change the media type and/or orientation of a label, choose
363 <menuchoice> <guimenu>File</guimenu>
364 <guimenuitem>Properties</guimenuitem> </menuchoice> to display the
365 <guilabel>Label properties</guilabel> dialog. Select the
366 new media type and orientation for the document, then click
367 <guibutton>OK</guibutton>.</para>
371 <!-- ============= To create a custom template ======================= -->
372 <sect2 id="glabels-create-template">
373 <title>To Create a Custom Template</title>
375 <para>To create a new custom template, choose
376 <menuchoice> <guimenu>File</guimenu>
377 <guimenuitem>Template Designer ...</guimenuitem> </menuchoice>
378 to display the <guilabel>Template Designer</guilabel> dialog.
379 This dialog will assist you in creating a custom template for
380 most types of label or card stationery that you may encounter.</para>
382 <para>If you prefer, you can create your templates manually.
383 For this option see <xref linkend="glabels-manual-create-template"/>
388 <!-- ============= To Close a File ========= -->
389 <sect2 id="glabels-close-file">
390 <title>To Close a File</title>
392 <para>To close the current document, choose
393 <menuchoice> <guimenu>File</guimenu>
394 <guimenuitem>Close</guimenuitem> </menuchoice> to close the application
395 window. If the current document is modified, a confirmation dialog
396 will be presented, allowing you to save the document or cancel
397 the command. If the window being closed is the only open window,
398 <application>&app;</application> will exit.</para>
402 <!-- ============= To Quit ========= -->
403 <sect2 id="glabels-quit">
404 <title>To Quit <application>&app;</application></title>
406 <para>To quit <application>&app;</application>, choose
407 <menuchoice> <guimenu>File</guimenu>
408 <guimenuitem>Quit</guimenuitem> </menuchoice>. This is equivalent
409 to closing all open windows. See
410 <xref linkend="glabels-close-file"/>.</para>
414 <!-- ============= To Print Labels and Cards ========= -->
415 <sect2 id="glabels-print-file">
416 <title>To Print Labels or Cards</title>
418 <para>To print labels or cards, choose
419 <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem>
420 </menuchoice> to display the <guilabel>Print</guilabel> dialog.
421 Once print options have been selected, click <guilabel>Print</guilabel>
422 to print the labels or cards. To simply preview the results,
423 click <guilabel>Print Preview</guilabel> instead.</para>
425 <para>The <guilabel>Print</guilabel> dialog allows you to specify the
426 following print options:</para>
428 <sect3 id="print-dialog-job">
429 <title>The Labels Tab of the Print Dialog</title>
434 <term><guilabel>Print control (Simple)</guilabel></term>
437 <para>For simple labels or cards (no document merge), the job
438 tabbed section contains the following copy controls.</para>
440 <!-- ==== Figure ==== -->
441 <figure id="print-copies-fig">
442 <title>Print Copy Controls</title>
445 <imageobject><imagedata
446 fileref="figures/print-copies.png" format="PNG"/>
451 <!-- ==== End of Figure ==== -->
453 <para>The number of copies of the label can be selected by
454 choosing the number of full sheets to print, or a specific
455 subset of labels on a single sheet.</para>
457 <para>The mini-preview can also be used to graphically select
458 the subset of labels by clicking the first label on the
459 mini-preview and dragging to the last label.</para>
465 <term><guilabel>Print control (Merge)</guilabel></term>
468 <para>For labels or cards using the document merge (also known
469 as "mail merge") capability, the job tabbed section contains
470 the following merge controls instead of copy controls.</para>
472 <!-- ==== Figure ==== -->
473 <figure id="print-merge-fig">
474 <title>Print Document Merge Controls</title>
477 <imageobject><imagedata
478 fileref="figures/print-merge.png" format="PNG"/>
483 <!-- ==== End of Figure ==== -->
485 <para>The total number of labels or cards printed is the
486 product of the number of records in the merge source and
487 the number of copies selected. If multiple copies are
488 selected, these can be either collated (copies of the
489 same record grouped together) or un-collated (one copy
490 each record is printed before next copy).</para>
492 <para>Printing can begin on any label on the first sheet.
493 This can be selected with the <guilabel>Start on
494 label</guilabel> spinbutton.</para>
496 <para>The mini-preview can also be used to graphically select
497 this first label, by clicking on the desired label in the
503 <varlistentry> <term><guilabel>Options</guilabel> </term>
505 <para>The following options can also be selected.</para>
508 <para><guilabel>print outlines</guilabel></para>
509 <para>Print outlines of labels. This option is useful for
510 dry-runs, to test printer alignment.</para>
513 <para><guilabel>print in reverse</guilabel></para>
514 <para>Prints the labels as mirror images. This option is
515 useful for printing on clear labels that will be viewed
516 from the reverse side (e.g. in a car window).</para>
519 <para><guilabel>print crop marks</guilabel></para>
520 <para>Prints crop marks along the edge of the sheet.
521 This option is useful for printing on blank stock, to
522 be cut after printing. This option does not work well
523 with all templates.</para>
533 <!-- ============= To Create New Objects ========= -->
534 <sect2 id="glabels-new-objects">
535 <title>To Create New Objects</title>
537 <para>Objects are created by choosing the appropriate selection under
538 the <menuchoice> <guimenu>Objects</guimenu>
539 <guimenuitem>Create Object</guimenuitem> </menuchoice> submenu or
540 the <guilabel>Drawing Toolbar</guilabel>. This will place the
541 display area into object creation mode as indicated by its cursor.
542 To return to the default object selection mode without creating
543 an object, choose <menuchoice> <guimenu>Objects</guimenu>
544 <guimenuitem>Select Mode</guimenuitem> </menuchoice>. This will
545 return the display area's cursor to the default selection arrow.</para>
547 <para>The following describes the object creation mode for each object
555 <para>Click the desired location of the upper left corner of the
556 text object. New text objects are initialized with the
557 string "Text." To change this text, or other properties, see
558 <xref linkend="glabels-object-properties"/>.</para>
565 <para>Click the desired location of the upper left corner of the
566 box object and drag to the desired location of the lower right
567 corner. If you simply click in a single location, a square
568 box will be created. To change properties of the box object, see
569 <xref linkend="glabels-object-properties"/>.</para>
576 <para>Click the desired location of one end of the
577 line object and drag to the desired location of the other end.
578 If you simply click in a single location, a diagonal line
579 will be created. To change properties of the line object, see
580 <xref linkend="glabels-object-properties"/>.</para>
587 <para>Click the desired location of the upper left corner of the
588 ellipse object and drag to the desired location of the lower
589 right corner. If you simply click in a single location, a circle
590 will be created. To change properties of the ellipse object, see
591 <xref linkend="glabels-object-properties"/>.</para>
598 <para>Click the desired location of the upper left corner of the
599 image object and drag to the desired location of the lower
600 right corner. If you simply click in a single location, a square
601 will be created. New image objects are initialized with a
602 simple checkerboard image. To change this image, or other
603 properties of the image object, see
604 <xref linkend="glabels-object-properties"/>.</para>
611 <para>Click the desired location of the upper left corner of the
612 barcode object. New barcode objects are initialized to a
613 POSTNET barcode with representative data. To change data
614 and properties of the barcode object, see
615 <xref linkend="glabels-object-properties"/>.</para>
624 <!-- ============= To Select Objects ========= -->
625 <sect2 id="glabels-select-objects">
626 <title>To Select Objects</title>
628 <para>A prerequisite for performing operations on objects is the
629 selection of individual objects or groups of objects. The
630 display area must be in the object selection mode to create new
631 selections, as indicated by an arrow cursor. The object
632 selection mode is selected by the
633 <menuchoice> <guimenu>Objects</guimenu>
634 <guimenuitem>Select Mode</guimenuitem> </menuchoice> menu item,
635 or the corresponding command on the <guilabel>Drawing
636 Toolbar</guilabel>.</para>
641 <term>Selecting a single object</term>
643 <para>A single object can be selected simply by clicking
644 on the desired object in the display area.
645 Once selected the object will be highlighted with a set of
646 resizing handles.</para>
651 <term>Aggregate object selections</term>
653 <para>Multiple objects can be selected by first selecting the first
654 object as above and then by holding the <keycap>Ctrl</keycap>
655 key while selecting additional objects.
656 Individual objects can be added to an existing selection
657 at any time by holding the <keycap>Ctrl</keycap> key while
658 selecting the desired objects. All objects can also be
659 selected by using the <menuchoice> <guimenu>Edit</guimenu>
660 <guimenuitem>Select All</guimenuitem> </menuchoice>
661 menu item. All objects in an aggregate object selection will be
667 <term>Area selections</term>
669 <para>Multiple objects can also be selected by clicking an empty
670 area and dragging to form a rectangular area. When released,
671 all objects contained in the area will form an aggregate
672 selection. An area selection can be used to add to an existing
673 selection by holding the <keycap>Ctrl</keycap> key while
674 performing the selection.</para>
679 <term>Unselecting objects</term>
681 <para>Individual objects can be removed from an existing
682 selection by holding the <keycap>Ctrl</keycap> key while
683 clicking on a previously selected object. An entire selection
684 can be dismissed by using the <menuchoice>
685 <guimenu>Edit</guimenu> <guimenuitem>Un-select All</guimenuitem>
686 </menuchoice> menu item
687 or by simply clicking any empty space in the display area.
688 Once an object is unselected its highlight is removed.</para>
696 <!-- ============= Clipboard Commands ========= -->
697 <sect2 id="glabels-clipboard">
698 <title>Clipboard Commands</title>
700 <para>Object selections can be manipulated using the standard clipboard
701 operations <guimenuitem>Cut</guimenuitem>,
702 <guimenuitem>Copy</guimenuitem>, <guimenuitem>Paste</guimenuitem>,
703 and <guimenuitem>Delete</guimenuitem>.</para>
711 <keycombo><keycap>Ctrl</keycap><keycap>X</keycap></keycombo>
713 <guimenuitem>Cut</guimenuitem>
717 <para>Moves selected objects to the clipboard. The objects are
718 then available for pasting back into the current document or
719 another document.</para>
727 <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
729 <guimenuitem>Copy</guimenuitem>
733 <para>Copies selected objects to the clipboard without deleting
734 them. The objects are then available for pasting back into
735 the current document or another document.</para>
743 <keycombo><keycap>Ctrl</keycap><keycap>V</keycap></keycombo>
745 <guimenuitem>Paste</guimenuitem>
749 <para>Pastes objects from the clipboard into the current document.
750 <application>&app;</application> can only paste objects from
751 another <application>&app;</application> document.</para>
759 <keycap>Delete</keycap>
761 <guimenuitem>Delete</guimenuitem>
765 <para>Deletes selected objects without placing them on the
774 <!-- ============= To Edit object Properties ========= -->
775 <sect2 id="glabels-object-properties">
776 <title>To Edit Object Properties</title>
778 <para>Most object properties can be modified through the object
779 editor sidebar, illustrated below. To use the object editor,
780 a single object must first be selected. See
781 <xref linkend="glabels-select-objects" />.</para>
783 <!-- ==== Figure ==== -->
784 <figure id="object-editor-sidebar-fig">
785 <title>Object Editor Sidebar</title>
788 <imageobject><imagedata
789 fileref="figures/object-editor-sidebar.png" format="PNG"/>
794 <!-- ==== End of Figure ==== -->
796 <para>The object editor will contain a subset of the following
797 tabbed sections, depending on object type:</para>
799 <sect3 id="object-editor-text">
800 <title>Text Tabbed Section (Text objects)</title>
802 <para>This section contains a small editor for changing the content
803 of a text object. It also contains a dropdown menu of available
804 document merge keys, that can be inserted into text.</para>
808 <sect3 id="object-editor-image">
809 <title>Image Tabbed Section (Image objecs)</title>
811 <para>This section contains a file entry with preview to select
812 image files. The browse button can be used to easily locate
813 image files. Alternatively, a document merge key can be used
814 instead to provide a filename at print time.</para>
818 <sect3 id="object-editor-data">
819 <title>Data Tabbed Section (Barcode objecs)</title>
821 <para>This section contains a text entry to enter literal barcode
822 data. Alternatively, a document merge key can be used to
823 provide this data at print time.</para>
827 <sect3 id="object-editor-style">
828 <title>Style Tabbed Section (Text objects)</title>
830 <para>This section contains controls to select text properties,
831 including font family, font size, font weight, color, and
832 text justification.</para>
836 <sect3 id="object-editor-barcode">
837 <title>Style Tabbed Section (Barcode objecs)</title>
839 <para>This section contains controls to select barcode properties,
840 including barcode style, color, whether to print text, and whether
841 to include a checksum digit.</para>
845 <sect3 id="object-editor-line">
846 <title>Line Tabbed Section</title>
848 <para>This section contains controls to select properties of lines
849 and outlines. These properties include line width and color.</para>
853 <sect3 id="object-editor-fill">
854 <title>Fill Tabbed Section</title>
856 <para>This section contains controls to select fill properties of box
857 and ellipse objects. Currently the only fill property is fill
862 <sect3 id="object-editor-size">
863 <title>Size Tabbed Section (All except line objects)</title>
865 <para>This section contains controls to select the width and height
866 of an object. A checkbox is provided, so that the current aspect
867 ratio can be locked while manipulating the width and height controls.
868 Image objects also provide a button to reset the size to the
869 image's natural size (Assumes 72DPI).</para>
873 <sect3 id="object-editor-size-line">
874 <title>Size Tabbed Section (Line objects)</title>
876 <para>This section contains controls to select the length and angle
877 of a line object.</para>
881 <sect3 id="object-editor-position">
882 <title>Position Tabbed Section</title>
884 <para>This section contains controls to change the position of an
890 <sect3 id="object-editor-shadow">
891 <title>Shadow Tabbed Section (All except image and barcode objects)</title>
893 <para>This section contains controls to add a shadow to an object.</para>
900 <!-- ============= Other Manipulations of Objects ========= -->
901 <sect2 id="glabels-object-manipulation">
902 <title>Other Manipulations of Objects</title>
904 <para>Objects can also be manipulated in the following ways.</para>
906 <sect3 id="other-moving-resizing">
907 <title>Moving and Resizing Objects</title>
909 <para>Objects can be moved by simply clicking on a selected
910 object and dragging the object to its new location. If the object
911 is part of an aggregate selection, all objects in the selection
912 will move with the object being dragged, maintaining their relative
913 positions to one another. If no object is selected, clicking on
914 an object will create a new selection containing that object.
915 See <xref linkend="glabels-select-objects" />.</para>
917 <para>A selected object can be resized by clicking one of its resize
918 handle and dragging it to obtain the new size.</para>
922 <sect3 id="other-stacking-order">
923 <title>Changing Stacking Order</title>
925 <para>Stacking order refers to relative position in the z-axis of
926 objects. That is when objects overlap, which object will appear
927 on top of the other. By default, newer objects will appear above
928 older objects. To change this order, select one or more objects
929 and choose <menuchoice> <guimenu>Objects</guimenu>
930 <guimenuitem>Order</guimenuitem>
931 <guimenuitem>Bring to Front</guimenuitem> </menuchoice>
932 to raise the selection to the top of the stacking
933 order, or choose <menuchoice> <guimenu>Objects</guimenu>
934 <guimenuitem>Order</guimenuitem>
935 <guimenuitem>Send to Back</guimenuitem> </menuchoice>
936 to lower the selection to the bottom of the
937 stacking order. These menuitems are also available by right-clicking
938 the display area when there is a non-empty selection.</para>
942 <sect3 id="other-rotating-flipping">
943 <title>Rotating and Flipping Objects</title>
945 <para>Objects can be rotated 90 degrees in either direction, or flipped
946 horizontally or vertically, by choosing the appropriate menuitem
947 in the <menuchoice> <guimenu>Objects</guimenu>
948 <guimenuitem>Rotate/Flip</guimenuitem> </menuchoice> sub-menu. These
949 menuitems are also available by right-clicking
950 the display area when there is a non-empty selection.</para>
954 <sect3 id="other-alignment">
955 <title>Aligning Objects</title>
957 <para>Objects can be aligned horizontally or vertically, relative to
958 one another, or relative to the center line of the label, by
959 choosing the appropriate menuitem from the <menuchoice>
960 <guimenu>Objects</guimenu>
961 <guimenuitem>Align Horizontal</guimenuitem>
962 </menuchoice> or <menuchoice> <guimenu>Objects</guimenu>
963 <guimenuitem>Align Horizontal</guimenuitem> </menuchoice> sub-menus.
964 These menuitems are also available by right-clicking
965 the display area when there is a non-empty selection.</para>
969 <sect3 id="other-property-bar">
970 <title>Using the Property Bar</title>
972 <para>The property bar can be used to change some common properties
973 of objects en-masse. These properties include font family, font
974 size, font weight, text alignment, text color, fill color, line
975 or outline color, and line width. The property bar also controls
976 the defaults for these properties for any newly created objects.
985 <!-- ============= Document Merge Features ========= -->
986 <sect2 id="glabels-merge">
987 <title>Performing a Document Merge</title>
989 <para>Document Merge (sometimes called "Mail Merge") is a powerful
990 feature that allows a unique label or card to be printed for each
991 record in an external data source.</para>
993 <para>The first step to performing a document merge is to prepare
994 a source document that contains your merge data. This data could
995 be mailing addresses or any other data that you wish to create
996 unique labels or cards for. Currently back-ends only exist for
997 text files and the evolution data server -- others are planned. The currently
998 supported text-file format is very simple: each line is a record;
999 fields are delimited by commas (CSV), tabs, or colons; and newlines
1000 can be embedded into fields by using the "\n" entity. This file
1001 could be created using any text editor or could be created by
1002 another program or script. A common way of creating CSV files is
1003 to export them from a spreadsheet program.</para>
1005 <para>A label must then be configured to "point at" this data file.
1006 To configure the merge properties of a document, choose
1007 <menuchoice> <guimenu>Objects</guimenu>
1008 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item
1009 to display the <guilabel>merge properties</guilabel> dialog. This
1010 dialog is used to select the exact data file format and file
1011 name (location) of the merge data.</para>
1013 <para>Finally, once the label has been configured for a data file,
1014 field keys can be inserted into text objects and used as source
1015 or data for barcode objects and image filenames for image objects.
1016 See <xref linkend="glabels-object-properties" /> for more information
1017 on using merge data for these object types.</para>
1019 <para>Now that your label is configured, gLabels will print a unique
1020 label for each record in your source document -- substituting fields
1021 from each record for field keys in the all text, barcode, and
1022 image objects.</para>
1024 <para>See <xref linkend="glabels-merge-tutorial" /> for a detailed
1025 tutorial on the document merge feature.</para>
1036 <!-- ============= Customization ============================= -->
1037 <!-- Use this section to describe how to customize the application. -->
1038 <sect1 id="glabels-prefs">
1039 <title>Settings</title>
1040 <para>To configure &app;, choose
1042 <guimenu>Settings</guimenu>
1043 <guimenuitem>Preferences</guimenuitem>
1045 <guilabel>Preferences</guilabel> dialog contains the following tabbed
1050 <xref linkend="glabels-prefs-locale"/></para>
1054 <xref linkend="glabels-prefs-object-defaults"/></para>
1057 <!-- =============== Customization Subsection ================ -->
1058 <!-- Use a new section to describe different tabbed sections on the Settings or Preferences
1060 <sect2 id="glabels-prefs-locale">
1061 <title>Locale</title>
1065 <guilabel>Units</guilabel> </term>
1067 <para>Use this radio button group to specify your prefered units.
1068 Select one of the following options:</para>
1072 <guilabel>Points</guilabel> </para>
1073 <para>Use points (1 point = 1/72 in = 0.352778 mm).</para>
1077 <guilabel>Inches</guilabel> </para>
1078 <para>Use inches.</para>
1082 <guilabel>Millimeters</guilabel> </para>
1083 <para>Use millimeters.</para>
1087 <guilabel>Inches</guilabel>.</para>
1092 <guilabel>Default page size</guilabel> </term>
1094 <para>Use this radio button group to specify your prefered page size.
1095 This will make it quicker for you to locate media types when creating a new
1096 label or card.</para>
1100 <guilabel>US Letter</guilabel> </para>
1101 <para>Most of your media will be of the US Letter page size (8.5 x 11 inches).</para>
1105 <guilabel>ISO A4</guilabel> </para>
1106 <para>Most of your media will be of the ISO A4 page size (210 x 297 mm).</para>
1110 <guilabel>US Letter</guilabel>.</para>
1115 <!-- ============= Customization Subsection ===================== -->
1116 <!-- Another tabbed section on the Preferences dialog. -->
1117 <sect2 id="glabels-prefs-object-defaults">
1118 <title>Object defaults</title>
1122 <guilabel>Text</guilabel> </term>
1124 <para>Use these controls to set the default properties of new text objects.
1125 These properties are</para>
1129 <guilabel>Font</guilabel> </para>
1130 <para>These controls are used to select font family and font size, and
1131 whether the font should bold or in italics.</para>
1135 <guilabel>Color</guilabel> </para>
1136 <para>This control selects the default text color.</para>
1140 <guilabel>Alignment</guilabel> </para>
1141 <para>These controls are used to select the default text alignment (left, center or right).</para>
1148 <guilabel>Line</guilabel> </term>
1150 <para>Use these controls to set the default properties of lines and outlines of
1151 new objects. These properties are</para>
1155 <guilabel>Width</guilabel> </para>
1156 <para>This control selects the default line width.</para>
1160 <guilabel>Color</guilabel> </para>
1161 <para>This control selects the default line color.</para>
1168 <guilabel>Fill</guilabel> </term>
1170 <para>Use these controls to set the default fill properties of
1171 new objects. These properties are</para>
1175 <guilabel>Color</guilabel> </para>
1176 <para>This control selects the default fill color.</para>
1188 <!-- ============= Document Merge Tutorial ================================== -->
1189 <sect1 id="glabels-merge-tutorial">
1190 <title>Document Merge Tutorial</title>
1192 <para>Document Merge (sometimes called "Mail Merge") is a powerful
1193 feature that allows a unique label or card to be printed for each
1194 record in an external data source. It is however, the most mis-understood
1195 feature of <application>glabels</application>. The following examples
1196 will step through a couple of common tasks using the document merge
1199 <sect2 id="merge-ex1">
1200 <title>Example 1: Name Tags</title>
1202 <para>In this example we are organizing an orientation party for the new
1203 crew members of our ship. We have a list of freshman crew members that we
1204 created in <application>gnumeric</application> and exported as the following
1205 CSV file. We could have created this file by using a text editor, but heck it
1206 is the 23rd century.</para>
1210 "Jim Kirk",Management,"SC937-0176 CEC"
1211 "Mr. Spock",Sciences,S179-276SP
1212 "Leonard McCoy",Medicine,unknown
1213 "Montgomery Scott",Engineering,SE-197-54T
1216 <para>In <application>glabels</application> we have created a new glabels
1217 document using the Avery 5395 "Name Badge Labels" template. Next we use the
1218 <menuchoice> <guimenu>Objects</guimenu>
1219 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item to display
1220 the <guilabel>merge properties</guilabel> dialog. We use this dialog to
1221 select the source type (in our case CSV) and the merge source (filename) as
1224 <!-- ==== Figure ==== -->
1225 <figure id="merge-ex1-1-fig">
1226 <title>Merge properties dialog</title>
1229 <imageobject><imagedata
1230 fileref="figures/merge-ex1-1.png" format="PNG"/>
1235 <!-- ==== End of Figure ==== -->
1237 <para>Before applying the merge source, we uncheck the first record since it is only
1238 column headers from our original <application>gnumeric</application> spreadsheet
1239 and would simply waste our first label. We could also unselect any other records
1240 that we didn't want to print a label for.</para>
1242 <para>We can also view each record in more detail by clicking on the appropriate
1243 expander (the little triangles) as shown. Once we are satisfied with the
1244 selections in this dialog we click <guibutton>OK</guibutton> to accept the
1247 <para>Now we start adding objects to our glabels document as shown.</para>
1249 <!-- ==== Figure ==== -->
1250 <figure id="merge-ex1-2-fig">
1251 <title>Adding objects</title>
1254 <imageobject><imagedata
1255 fileref="figures/merge-ex1-2.png" format="PNG"/>
1260 <!-- ==== End of Figure ==== -->
1262 <para>In this example we have added three text objects and a barcode object. The
1263 first text object contains only simple literal text ("Hello, my name is"). The
1264 second text object contains a single merge field ("${1}") corresponding to the
1265 first field of a record (first column of a line) which contains the new crew
1266 member's full name. The third text field contains both literal text
1267 ("Department: ") followed by a single merge field ("${2}") corresponding to
1268 the second field or the crew member's department. The barcode object is
1269 configured to use field (or key) "3" which contains our crew member's
1270 starfleet serial number.</para>
1272 <para>Now we can print our name tags by selecting the
1273 <menuchoice> <guimenu>File</guimenu>
1274 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1275 print dialog as shown below.</para>
1277 <!-- ==== Figure ==== -->
1278 <figure id="merge-ex1-3-fig">
1279 <title>Printing name tags</title>
1282 <imageobject><imagedata
1283 fileref="figures/merge-ex1-3.png" format="PNG"/>
1288 <!-- ==== End of Figure ==== -->
1290 <para>Just to make sure our labels are going to look okay, we select the
1291 <guilabel>Print outlines</guilabel> option and click
1292 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1293 as shown below.</para>
1295 <!-- ==== Figure ==== -->
1296 <figure id="merge-ex1-4-fig">
1297 <title>Name tags preview</title>
1300 <imageobject><imagedata
1301 fileref="figures/merge-ex1-4.png" format="PNG"/>
1306 <!-- ==== End of Figure ==== -->
1308 <para>Everything looks good, so we can now load up our printer with
1309 the appropriate label stock, print our name tags and start beaming our guests
1314 <sect2 id="merge-ex2">
1315 <title>Example 2: Address Labels</title>
1317 <para>In this example we are going to throw a party and need to print mailing
1318 address labels for our invitations. We have a list of our closest friends
1319 that we created in <application>gnumeric</application> and exported as the
1320 following CSV file. It should be noted that not everyone has a middle initial or
1321 a two line address.</para>
1324 LAST,FIRST,MI,ADDR1,ADDR2,CITY,STATE,ZIP
1326 Critter,Ess,S,"123 Faux St.",,Alexandria,VA,22310
1327 Doe,John,,"Apt 1X","451 Mystery St.",Trenton,NJ,08601
1328 Summers,Joyce,,"1630 Revello Dr",,Sunnydale,CA,95037
1329 McGarret,Steve,O,"404 Piikoi Street",,Honolulu,HI,96813
1330 Kramer,Cosmo,,"Apt 5B","129 W. 81 St.","New York",NY,10024-7207
1333 <para>In <application>glabels</application> we have created a new glabels
1334 document using the Avery 5512 "Address Labels" template. Next we use the
1335 <menuchoice> <guimenu>Objects</guimenu>
1336 <guimenuitem>Merge Properties</guimenuitem> </menuchoice> menu item to display
1337 the <guilabel>merge properties</guilabel> dialog. We use this dialog to
1338 select the source type (in our case CSV) and the merge source (filename) as
1341 <!-- ==== Figure ==== -->
1342 <figure id="merge-ex2-1-fig">
1343 <title>Merge properties dialog</title>
1346 <imageobject><imagedata
1347 fileref="figures/merge-ex2-1.png" format="PNG"/>
1352 <!-- ==== End of Figure ==== -->
1354 <para>Before applying the merge source, we uncheck the first record since it is only
1355 column headers from our original <application>gnumeric</application> spreadsheet
1356 and would simply waste our first label. We also unselect the second record
1357 which is empty (an artifact of our original spreadsheet). We could also unselect
1358 any other records that we didn't want to print a label for.</para>
1360 <para>We can also view each record in more detail by clicking on the appropriate
1361 expander (the little triangles) as shown. Once we are satisfied with the
1362 selections in this dialog we click <guibutton>OK</guibutton> to accept the
1365 <para>Now we start adding objects to our glabels document as shown.</para>
1367 <!-- ==== Figure ==== -->
1368 <figure id="merge-ex2-2-fig">
1369 <title>Adding objects</title>
1372 <imageobject><imagedata
1373 fileref="figures/merge-ex2-2.png" format="PNG"/>
1378 <!-- ==== End of Figure ==== -->
1380 <para>In this example we have a single text object. This text object contains
1381 all of our merge fields organized on multiple lines as a mailing address.
1382 Notice that fields ${4} and ${5} (corresponding to ADDR1 and ADDR2) are each
1383 located with no other text on their own lines. When
1384 <application>glabels</application> encounters a field as the only text on
1385 a line, it will not expand the line if the field is empty.</para>
1387 <para>Now we can print our address labels by selecting the
1388 <menuchoice> <guimenu>File</guimenu>
1389 <guimenuitem>Print</guimenuitem> </menuchoice> menu item. This will display
1390 print dialog as shown below.</para>
1392 <!-- ==== Figure ==== -->
1393 <figure id="merge-ex2-3-fig">
1394 <title>Printing address labels</title>
1397 <imageobject><imagedata
1398 fileref="figures/merge-ex2-3.png" format="PNG"/>
1403 <!-- ==== End of Figure ==== -->
1405 <para>Just to make sure our labels are going to look okay, we select the
1406 <guilabel>Print outlines</guilabel> option and click
1407 <guibutton>Print Preview</guibutton>. This will display a print preview dialog
1408 as shown below.</para>
1410 <!-- ==== Figure ==== -->
1411 <figure id="merge-ex2-4-fig">
1412 <title>Address labels preview</title>
1415 <imageobject><imagedata
1416 fileref="figures/merge-ex2-4.png" format="PNG"/>
1421 <!-- ==== End of Figure ==== -->
1423 <para>Everything looks good, so we can now load up our printer with
1424 the appropriate label stock, print our address labels and start mailing
1425 our party invitations.</para>
1434 <!-- ============= Creating templates ================================== -->
1435 <sect1 id="glabels-manual-create-template">
1436 <title>Manually Creating New Templates</title>
1438 <para>Predefined templates are defined by XML files located in
1439 <filename>${prefix}/share/glabels/</filename>,
1440 where <filename>${prefix}</filename> is usually something like
1441 <filename>/usr/local</filename> or <filename>/usr</filename> depending
1442 on the configuration option <filename>prefix</filename>. gLabels will
1443 use all files of the form <filename>*-templates.xml</filename>
1444 or <filename>*.template</filename>, that it finds in
1445 <filename>${prefix}/share/glabels/</filename> and
1446 <filename>${HOME}/.glabels/</filename>.
1447 Additional templates can be added by creating additional
1448 <filename>*.template</filename> files in either of these directories.
1451 <para>The format for these files is defined in the DTD:
1452 <ulink url="http://glabels.sourceforge.net/doc/glabels-2.0.dtd.txt"
1453 type="http">glabels-2.2.dtd</ulink>. (This DTD also describes other
1454 XML formats used by glabels.)</para>
1456 <sect2 id="template-assumptions">
1457 <title>Assumptions/caveats</title>
1460 <para>A sheet contains only one size of label or card (if a sheet
1461 contains more than one size of item, it can be split into
1462 multiple templates for multiple pass printing)</para>
1465 <para>Distances can be expressed in units of <emphasis>pt</emphasis>,
1466 <emphasis>in</emphasis>, <emphasis>mm</emphasis>,
1467 <emphasis>cm</emphasis>, or <emphasis>pc</emphasis>. For example:
1468 "<literal>1.0in</literal>" or "<literal>2.54cm</literal>". If no
1469 units are specified, computer points (<emphasis>pt</emphasis>) will
1470 be assumed (1 <emphasis>pt</emphasis> =
1471 1/72 <emphasis>in</emphasis> = 0.352778 <emphasis>mm</emphasis>).
1477 <sect2 id="template-file">
1478 <title>Template Files</title>
1481 <?xml version="1.0"?>
1482 <Glabels-templates>
1484 <replaceable>...templates...</replaceable>
1486 </Glabels-templates>
1491 <sect2 id="template-example">
1492 <title>Example Template</title>
1494 <Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels">
1495 <Label-rectangle id="0" width="189pt" height="72pt" round="5pt">
1496 <Markup-margin size="5pt"/>
1497 <Layout nx="3" ny="10" x0="11.25pt" y0="36pt" dx="200pt" dy="72pt"/>
1498 </Label-rectangle>
1499 <Alias brand="Avery" part="5160"/>
1500 <Alias brand="Avery" part="6233"/>
1505 <sect2 id="template-template-node">
1506 <title>Template Node</title>
1508 <para>A <emphasis>Template</emphasis> node describes a single stationary
1509 product. It must contain one instance of any type of Label node
1510 (<emphasis>Label-rectangle</emphasis>,
1511 <emphasis>Label-round</emphasis>, or <emphasis>Label-cd</emphasis>).
1512 This node can be followed by zero or more
1513 <emphasis>Alias</emphasis> nodes.</para>
1515 <informaltable frame="topbot">
1517 <colspec colname="col1"/>
1518 <colspec colname="col2"/>
1521 <entry colname="col1" colsep="0" valign="top">
1522 <para>Property</para>
1524 <entry colname="col2" valign="top">
1525 <para>Description</para>
1531 <entry><para>brand</para></entry>
1533 <para>Brand or manufacturer of stationary product.
1538 <entry><para>part</para></entry>
1540 <para>Part number or name of stationary product.
1545 <entry><para>size</para></entry>
1547 <para>Size of sheet. E.g., "US-Letter," "A4", ...</para>
1551 <entry><para>description</para></entry>
1553 <para>Description of stationary product. E.g,
1554 "Mailing Labels."</para>
1558 <entry><para>_description</para></entry>
1560 <para>Translatable description of stationary product.
1561 E.g, "Mailing Labels." (Only useful for predefined
1566 <entry><para>width</para></entry>
1568 <para>Page width. Only valid if size="Other"</para>
1572 <entry><para>height</para></entry>
1574 <para>Page height. Only valid if size="Other"</para>
1583 <sect2 id="template-label-rectangle-node">
1584 <title>Label-rectangle Node</title>
1586 <para>A <emphasis>Label-rectangle</emphasis> node describes the
1587 dimensions of a single label or business card that is rectangular
1588 in shape (may have rounded edges).</para>
1590 <informaltable frame="topbot">
1592 <colspec colname="col1"/>
1593 <colspec colname="col2"/>
1596 <entry colname="col1" colsep="0" valign="top">
1597 <para>Property</para>
1599 <entry colname="col2" valign="top">
1600 <para>Description</para>
1606 <entry><para>id</para></entry>
1608 <para>Reserved for future use. Should always be 0.</para>
1612 <entry><para>width</para></entry>
1613 <entry><para>Width of label/card</para></entry>
1616 <entry><para>height</para></entry>
1617 <entry><para>Height of label/card</para></entry>
1620 <entry><para>round</para></entry>
1622 <para>Radius of corners. For items with square edges
1623 (business cards), the radius should be 0.</para>
1627 <entry><para>x_waste</para></entry>
1629 <para>Amount of horizontal waste (over-print) to allow. This is useful
1630 for minimizing alignment problems when using non-white
1631 backgrounds (e.g. images).</para>
1635 <entry><para>y_waste</para></entry>
1637 <para>Amount of vertical waste (over-print) to allow. This is useful
1638 for minimizing alignment problems when using non-white
1639 backgrounds (e.g. images).</para>
1646 <!-- ==== Figure ==== -->
1647 <figure id="template-label-fig">
1648 <title>Label-rectangle Parameters</title>
1651 <imageobject><imagedata
1652 fileref="figures/glabels-template-label.png" format="PNG"/>
1657 <!-- ==== End of Figure ==== -->
1661 <sect2 id="template-label-round-node">
1662 <title>Label-round Node</title>
1664 <para>A <emphasis>Label-round</emphasis> node describes the dimensions
1665 of a simple round label (not a CD).</para>
1667 <informaltable frame="topbot">
1669 <colspec colname="col1"/>
1670 <colspec colname="col2"/>
1673 <entry colname="col1" colsep="0" valign="top">
1674 <para>Property</para>
1676 <entry colname="col2" valign="top">
1677 <para>Description</para>
1683 <entry><para>id</para></entry>
1685 <para>Reserved for future use. Should always be 0.</para>
1689 <entry><para>radius</para></entry>
1690 <entry><para>Radius (1/2 diameter) of label</para></entry>
1693 <entry><para>waste</para></entry>
1695 <para>Amount of waste (over-print) to allow. This is useful
1696 for minimizing alignment problems when using non-white
1697 backgrounds (e.g. images).</para>
1706 <sect2 id="template-label-cd-node">
1707 <title>Label-cd Node</title>
1709 <para>A <emphasis>Label-cd</emphasis> node describes the dimensions
1710 of a CD, DVD, or business card CD.</para>
1712 <informaltable frame="topbot">
1714 <colspec colname="col1"/>
1715 <colspec colname="col2"/>
1718 <entry colname="col1" colsep="0" valign="top">
1719 <para>Property</para>
1721 <entry colname="col2" valign="top">
1722 <para>Description</para>
1728 <entry><para>id</para></entry>
1730 <para>Reserved for future use. Should always be 0.</para>
1734 <entry><para>radius</para></entry>
1735 <entry><para>Outer radius of label</para></entry>
1738 <entry><para>hole</para></entry>
1739 <entry><para>Radius of concentric hole</para></entry>
1742 <entry><para>width</para></entry>
1744 <para>If present, the label is clipped to the given width.
1745 (Useful for "business card CDs").</para>
1749 <entry><para>height</para></entry>
1751 <para>If present, the label is clipped to the given height.
1752 (Useful for "business card CDs").</para>
1756 <entry><para>waste</para></entry>
1758 <para>Amount of waste (over-print) to allow. This is useful
1759 for minimizing alignment problems when using non-white
1760 backgrounds (e.g. images).</para>
1767 <!-- ==== Figure ==== -->
1768 <figure id="template-label-cd-fig">
1769 <title>CD Label Parameters</title>
1772 <imageobject><imagedata
1773 fileref="figures/glabels-template-cd.png" format="PNG"/>
1778 <!-- ==== End of Figure ==== -->
1782 <sect2 id="template-markup-margin-node">
1783 <title>Markup-margin Node</title>
1785 <para>A <emphasis>Markup-margin</emphasis> describes a margin along
1786 all edges of a label.</para>
1788 <informaltable frame="topbot">
1790 <colspec colname="col1"/>
1791 <colspec colname="col2"/>
1794 <entry colname="col1" colsep="0" valign="top">
1795 <para>Property</para>
1797 <entry colname="col2" valign="top">
1798 <para>Description</para>
1804 <entry><para>size</para></entry>
1806 <para>Size of the margin. I.e. the distance of the margin
1807 line from the edge of the card/label.</para>
1816 <sect2 id="template-markup-line-node">
1817 <title>Markup-line Node</title>
1819 <para>A <emphasis>Markup-line</emphasis> describes a markup line.</para>
1821 <informaltable frame="topbot">
1823 <colspec colname="col1"/>
1824 <colspec colname="col2"/>
1827 <entry colname="col1" colsep="0" valign="top">
1828 <para>Property</para>
1830 <entry colname="col2" valign="top">
1831 <para>Description</para>
1837 <entry><para>x1</para></entry>
1839 <para>x coordinate of 1st endpoint of the line segment.</para>
1843 <entry><para>y1</para></entry>
1845 <para>y coordinate of 1st endpoint of the line segment.</para>
1849 <entry><para>x2</para></entry>
1851 <para>x coordinate of 2nd endpoint of the line segment.</para>
1855 <entry><para>y2</para></entry>
1857 <para>y coordinate of 2nd endpoint of the line segment.</para>
1866 <sect2 id="template-markup-circle-node">
1867 <title>Markup-circle Node</title>
1869 <para>A <emphasis>Markup-circle</emphasis> describes a markup circle.
1872 <informaltable frame="topbot">
1874 <colspec colname="col1"/>
1875 <colspec colname="col2"/>
1878 <entry colname="col1" colsep="0" valign="top">
1879 <para>Property</para>
1881 <entry colname="col2" valign="top">
1882 <para>Description</para>
1888 <entry><para>x0</para></entry>
1890 <para>x coordinate of circle origin (center).</para>
1894 <entry><para>y0</para></entry>
1896 <para>y coordinate of circle origin (center).</para>
1900 <entry><para>radius</para></entry>
1901 <entry><para>Radius of circle.</para></entry>
1909 <sect2 id="template-markup-rect-node">
1910 <title>Markup-rect Node</title>
1912 <para>A <emphasis>Markup-rect</emphasis> describes a markup rectangle.
1915 <informaltable frame="topbot">
1917 <colspec colname="col1"/>
1918 <colspec colname="col2"/>
1921 <entry colname="col1" colsep="0" valign="top">
1922 <para>Property</para>
1924 <entry colname="col2" valign="top">
1925 <para>Description</para>
1931 <entry><para>x1</para></entry>
1933 <para>x coordinate of upper left corner of rectangle.</para>
1937 <entry><para>y1</para></entry>
1939 <para>y coordinate of upper left corner of rectangle.</para>
1943 <entry><para>w</para></entry>
1945 <para>Width of rectangle.</para>
1949 <entry><para>h</para></entry>
1951 <para>Height of rectangle.</para>
1955 <entry><para>r</para></entry>
1956 <entry><para>Radius of rounded corners of rectangle.</para></entry>
1964 <sect2 id="template-layout-node">
1965 <title>Layout Node</title>
1967 <para>A label node may contain multiple <emphasis>Layout</emphasis>
1968 children. If labels are arranged in a simple grid pattern, only
1969 one layout is needed. However, if labels are arranged in multiple
1970 grids, such as a running bond pattern, multiple
1971 <emphasis>layout</emphasis> tags can be used. Note: a single label
1972 can always be treated as a grid of one.</para>
1974 <informaltable frame="topbot">
1976 <colspec colname="col1"/>
1977 <colspec colname="col2"/>
1980 <entry colname="col1" colsep="0" valign="top">
1981 <para>Property</para>
1983 <entry colname="col2" valign="top">
1984 <para>Description</para>
1990 <entry><para>nx</para></entry>
1992 <para>Number of labels/cards across in the grid
1997 <entry><para>ny</para></entry>
1999 <para>Number of labels/cards up and down in the grid
2004 <entry><para>x0</para></entry>
2006 <para>Distance from left edge of sheet to the left edge of
2007 the left column of cards/labels in the layout.</para>
2011 <entry><para>y0</para></entry>
2013 <para>Distance from the top edge of sheet to the top edge of
2014 the top row of labels/cards in the layout.</para>
2018 <entry><para>dx</para></entry>
2019 <entry><para>Horizontal pitch of grid.</para></entry>
2022 <entry><para>dy</para></entry>
2023 <entry><para>Vertical pitch of grid.</para></entry>
2029 <!-- ==== Figure ==== -->
2030 <figure id="template-layout-fig">
2031 <title>Layout Parameters</title>
2034 <imageobject><imagedata
2035 fileref="figures/glabels-template-layout.png" format="PNG"/>
2040 <!-- ==== End of Figure ==== -->
2044 <sect2 id="template-alias-node">
2045 <title>Alias Node</title>
2047 <para>An <emphasis>Alias</emphasis> node provides the name of a
2048 product with the same size and layout characteristics as the
2049 parent template.</para>
2051 <informaltable frame="topbot">
2053 <colspec colname="col1"/>
2054 <colspec colname="col2"/>
2057 <entry colname="col1" colsep="0" valign="top">
2058 <para>Property</para>
2060 <entry colname="col2" valign="top">
2061 <para>Description</para>
2067 <entry><para>brand</para></entry>
2069 <para>The brand or manufacturer of the equivalent product.</para>
2073 <entry><para>part</para></entry>
2075 <para>The part number or name of the equivalent product.</para>
2089 <!-- ============= Bugs ================================== -->
2090 <!-- This section is optional and is commented out by default.
2091 You can use it to describe known bugs and limitations of the
2092 program if there are any - please be frank and list all
2093 problems you know of.
2095 <sect1 id="mayapp-bugs">
2096 <title>Known Bugs and Limitations</title>
2104 <!-- ============= About ================================== -->
2105 <!-- This section contains info about the program (not docs), such as
2106 author's name(s), web page, license, feedback address. This
2107 section is optional: primary place for this info is "About.." box of
2108 the program. However, if you do wish to include this info in the
2109 manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
2110 <sect1 id="glabels-about">
2111 <title>About &app;</title>
2112 <para> &app; was written by Jim Evins
2113 (<email>evins@snaught.com</email>). To find more information about
2114 &app;, please visit the
2115 <ulink url="http://glabels.sourceforge.net" type="http">gLabels Web
2116 page</ulink>. </para>
2118 To report a bug or make a suggestion regarding this application or
2119 this manual, follow the directions at the
2120 <ulink url="http://glabels.sourceforge.net/contact/" type="http">gLabels Contact Page</ulink>.
2123 <para> This program is distributed under the terms of the GNU
2124 General Public license as published by the Free Software
2125 Foundation; either version 2 of the License, or (at your option)
2126 any later version. A copy of this license can be found at this
2127 <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
2128 COPYING included with the source code of this program. </para>