From: Jim Evins Date: Mon, 1 Mar 2010 00:13:00 +0000 (-0500) Subject: Additional changes to support parallel installation X-Git-Tag: glabels-2_3_0~74 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=7838152cdfea71a3676e40593ab4cb4a30484ffe;p=glabels Additional changes to support parallel installation Changed GETTEXT_PACKAGE to glabels-3.0 and renamed help files to support parallel installation with other versions of glabels. --- diff --git a/.gitignore b/.gitignore index b9f9a4f9..ea213aec 100644 --- a/.gitignore +++ b/.gitignore @@ -59,12 +59,12 @@ glabels-*.tar.gz /po/*.gmo /po/POTFILES /po/stamp-it -/po/glabels.pot +/po/glabels*.pot /help/glabels-*.omf /help/*/.xml2po.mo -/help/*/glabels.xml -!/help/C/glabels.xml +/help/*/glabels*.xml +!/help/C/glabels*.xml /docs/libglabels/*.stamp /docs/libglabels/xml/ diff --git a/configure.ac b/configure.ac index 86c7b723..ec3665b4 100644 --- a/configure.ac +++ b/configure.ac @@ -232,7 +232,7 @@ AM_CONDITIONAL(ENABLE_UPDATE_DESKTOPDB, test x$enable_update_desktopdb = xyes) dnl --------------------------------------------------------------------------- dnl - i18n support dnl --------------------------------------------------------------------------- -GETTEXT_PACKAGE=glabels +GETTEXT_PACKAGE=${GLABELS_BRANCH} AC_SUBST(GETTEXT_PACKAGE) AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE", [Gettext package]) diff --git a/help/C/glabels-3.0.xml b/help/C/glabels-3.0.xml new file mode 100644 index 00000000..e74eb322 --- /dev/null +++ b/help/C/glabels-3.0.xml @@ -0,0 +1,2127 @@ + + + + + + gLabels"> + +]> + + + + + +
+ + + + &app; Manual V&manrevision; + + + User manual for the gLabels label and business card creation program + + + + 2003-2007 + Jim Evins + + + Jim Evins + + + &legal; + + + + + Jim + Evins + + + + + + + + + + + + + + + + + + + + + gLabels Manual V&manrevision; + &date; + + Jim Evins + evins@snaught.com + + Jim Evins + + + + + This manual describes version &appversion; of gLabels. + + + Feedback + To report a bug or make a suggestion regarding the &app; application or + this manual, follow the directions in the gLabels Contact Page. + + + + + + + gLabels + + + glabels + + + + + + + + + + Introduction + + The &app; application is a lightweight program for creating labels + and business cards for the GNOME desktop + environment. It is designed to work with various laser/ink-jet + peel-off label and business card sheets that you'll find at most + office supply stores. + + + + + + + + + + + Getting Started + + + To Start &app; + You can start &app; in the following ways: + + + + Applications menu + + Choose + + Office + gLabels + . + + + + Command line + + Type glabels, + then press Return: + + + + + + + When You Start &app; + When you start &app;, the following window is displayed. + + +
+ &app; Start Up Window + + + + + + +
+ + + + + + The &app; window contains the following elements: + + + + Menubar. + + The menus on the menubar contain all of the commands you + need to create and edit labels and business cards in + &app;. + + + + Main toolbar. + + The main toolbar contains a subset of common File and Edit + commands that you can access from the menubar. + + + + Drawing toolbar. + + The drawing toolbar contains a subset of commands for + editing the current glabels document. + + + + Display area. + + The display area is the main drawing interface to + &app;. + + + + Object sidebar. + + The object sidebar provides an interface for viewing and + editing all properties of an individual object. + + + + Properties toolbar. + + The properties toolbar contains a set of tools to + manipulate the properties of selected objects and set default + properties for new objects. + + + + Statusbar. + + The statusbar displays information about current + &app; activity and contextual + information about the menu items. + + + + + + + + + + + + + Usage + + + + To Create a New Label or Card + + To create a new label or business card, choose + File New + + to display the New Label or Card dialog. Select + the media type and orientation for the new document, + then click OK. A new document is + displayed in the display area of the &app; + window. + + If your particular media type is missing from this dialog, + see + + + + + + To Open a File + + To open a file, choose + File Open + to display the Open File dialog. + Select the file that you want to open, then click + OK. The file is displayed in the display area + of the &app; window. + + You can also open multiple files in + &app;. The application creates a separate + application window for each open file. + + The application records the paths and filenames of the + most recent files that you have edited and displays the files as menu + items on the + FileRecent Files + menu. + + + + + + To Open Multiple Files from a Command Line + + You can run &app; from a command line + and open a single file or multiple files. To open multiple files from + a command line, type the following command, then press + Return: + + glabels + file1.glabels file2.glabels file3.glabels + + + When the application starts, the files that you specify are + displayed in separate &app; windows. + + + + + + To Save a File + + You can save files in the following ways: + + + + + To save changes to an existing file, choose + File + Save . + + + + + To save a new file or to save an existing file under a new + filename, choose File + Save As . Enter a name + for the file in the Save As dialog box, + then click OK. + + + + + + + + + To Change Label Properties + + To change the media type and/or orientation of a label, choose + File + Properties to display the + Label properties dialog. Select the + new media type and orientation for the document, then click + OK. + + + + + + To Create a Custom Template + + To create a new custom template, choose + File + Template Designer ... + to display the Template Designer dialog. + This dialog will assist you in creating a custom template for + most types of label or card stationery that you may encounter. + + If you prefer, you can create your templates manually. + For this option see + + + + + + + To Close a File + + To close the current document, choose + File + Close to close the application + window. If the current document is modified, a confirmation dialog + will be presented, allowing you to save the document or cancel + the command. If the window being closed is the only open window, + &app; will exit. + + + + + + To Quit <application>&app;</application> + + To quit &app;, choose + File + Quit . This is equivalent + to closing all open windows. See + . + + + + + + To Print Labels or Cards + + To print labels or cards, choose + File Print + to display the Print dialog. + Once print options have been selected, click Print + to print the labels or cards. To simply preview the results, + click Print Preview instead. + + The Print dialog allows you to specify the + following print options: + + + The Labels Tab of the Print Dialog + + + + + Print control (Simple) + + + For simple labels or cards (no document merge), the job + tabbed section contains the following copy controls. + + + + + + The number of copies of the label can be selected by + choosing the number of full sheets to print, or a specific + subset of labels on a single sheet. + + The mini-preview can also be used to graphically select + the subset of labels by clicking the first label on the + mini-preview and dragging to the last label. + + + + + + Print control (Merge) + + + For labels or cards using the document merge (also known + as "mail merge") capability, the job tabbed section contains + the following merge controls instead of copy controls. + + + + + + The total number of labels or cards printed is the + product of the number of records in the merge source and + the number of copies selected. If multiple copies are + selected, these can be either collated (copies of the + same record grouped together) or un-collated (one copy + each record is printed before next copy). + + Printing can begin on any label on the first sheet. + This can be selected with the Start on + label spinbutton. + + The mini-preview can also be used to graphically select + this first label, by clicking on the desired label in the + mini-preview. + + + + + Options + + The following options can also be selected. + + + print outlines + Print outlines of labels. This option is useful for + dry-runs, to test printer alignment. + + + print in reverse + Prints the labels as mirror images. This option is + useful for printing on clear labels that will be viewed + from the reverse side (e.g. in a car window). + + + print crop marks + Prints crop marks along the edge of the sheet. + This option is useful for printing on blank stock, to + be cut after printing. This option does not work well + with all templates. + + + + + + + + + + + + To Create New Objects + + Objects are created by choosing the appropriate selection under + the Objects + Create Object submenu or + the Drawing Toolbar. This will place the + display area into object creation mode as indicated by its cursor. + To return to the default object selection mode without creating + an object, choose Objects + Select Mode . This will + return the display area's cursor to the default selection arrow. + + The following describes the object creation mode for each object + type: + + + + + Text + + Click the desired location of the upper left corner of the + text object. New text objects are initialized with the + string "Text." To change this text, or other properties, see + . + + + + + Box + + Click the desired location of the upper left corner of the + box object and drag to the desired location of the lower right + corner. If you simply click in a single location, a square + box will be created. To change properties of the box object, see + . + + + + + Line + + Click the desired location of one end of the + line object and drag to the desired location of the other end. + If you simply click in a single location, a diagonal line + will be created. To change properties of the line object, see + . + + + + + Ellipse + + Click the desired location of the upper left corner of the + ellipse object and drag to the desired location of the lower + right corner. If you simply click in a single location, a circle + will be created. To change properties of the ellipse object, see + . + + + + + Image + + Click the desired location of the upper left corner of the + image object and drag to the desired location of the lower + right corner. If you simply click in a single location, a square + will be created. New image objects are initialized with a + simple checkerboard image. To change this image, or other + properties of the image object, see + . + + + + + Barcode + + Click the desired location of the upper left corner of the + barcode object. New barcode objects are initialized to a + POSTNET barcode with representative data. To change data + and properties of the barcode object, see + . + + + + + + + + + + + To Select Objects + + A prerequisite for performing operations on objects is the + selection of individual objects or groups of objects. The + display area must be in the object selection mode to create new + selections, as indicated by an arrow cursor. The object + selection mode is selected by the + Objects + Select Mode menu item, + or the corresponding command on the Drawing + Toolbar. + + + + + Selecting a single object + + A single object can be selected simply by clicking + on the desired object in the display area. + Once selected the object will be highlighted with a set of + resizing handles. + + + + + Aggregate object selections + + Multiple objects can be selected by first selecting the first + object as above and then by holding the Ctrl + key while selecting additional objects. + Individual objects can be added to an existing selection + at any time by holding the Ctrl key while + selecting the desired objects. All objects can also be + selected by using the Edit + Select All + menu item. All objects in an aggregate object selection will be + highlighted. + + + + + Area selections + + Multiple objects can also be selected by clicking an empty + area and dragging to form a rectangular area. When released, + all objects contained in the area will form an aggregate + selection. An area selection can be used to add to an existing + selection by holding the Ctrl key while + performing the selection. + + + + + Unselecting objects + + Individual objects can be removed from an existing + selection by holding the Ctrl key while + clicking on a previously selected object. An entire selection + can be dismissed by using the + Edit Un-select All + menu item + or by simply clicking any empty space in the display area. + Once an object is unselected its highlight is removed. + + + + + + + + + + Clipboard Commands + + Object selections can be manipulated using the standard clipboard + operations Cut, + Copy, Paste, + and Delete. + + + + + + + + CtrlX + + Cut + + + + Moves selected objects to the clipboard. The objects are + then available for pasting back into the current document or + another document. + + + + + + + + CtrlC + + Copy + + + + Copies selected objects to the clipboard without deleting + them. The objects are then available for pasting back into + the current document or another document. + + + + + + + + CtrlV + + Paste + + + + Pastes objects from the clipboard into the current document. + &app; can only paste objects from + another &app; document. + + + + + + + + Delete + + Delete + + + + Deletes selected objects without placing them on the + clipboard. + + + + + + + + + + To Edit Object Properties + + Most object properties can be modified through the object + editor sidebar, illustrated below. To use the object editor, + a single object must first be selected. See + . + + +
+ Object Editor Sidebar + + + + + + +
+ + + The object editor will contain a subset of the following + tabbed sections, depending on object type: + + + Text Tabbed Section (Text objects) + + This section contains a small editor for changing the content + of a text object. It also contains a dropdown menu of available + document merge keys, that can be inserted into text. + + + + + Image Tabbed Section (Image objecs) + + This section contains a file entry with preview to select + image files. The browse button can be used to easily locate + image files. Alternatively, a document merge key can be used + instead to provide a filename at print time. + + + + + Data Tabbed Section (Barcode objecs) + + This section contains a text entry to enter literal barcode + data. Alternatively, a document merge key can be used to + provide this data at print time. + + + + + Style Tabbed Section (Text objects) + + This section contains controls to select text properties, + including font family, font size, font weight, color, and + text justification. + + + + + Style Tabbed Section (Barcode objecs) + + This section contains controls to select barcode properties, + including barcode style, color, whether to print text, and whether + to include a checksum digit. + + + + + Line Tabbed Section + + This section contains controls to select properties of lines + and outlines. These properties include line width and color. + + + + + Fill Tabbed Section + + This section contains controls to select fill properties of box + and ellipse objects. Currently the only fill property is fill + color. + + + + + Size Tabbed Section (All except line objects) + + This section contains controls to select the width and height + of an object. A checkbox is provided, so that the current aspect + ratio can be locked while manipulating the width and height controls. + Image objects also provide a button to reset the size to the + image's natural size (Assumes 72DPI). + + + + + Size Tabbed Section (Line objects) + + This section contains controls to select the length and angle + of a line object. + + + + + Position Tabbed Section + + This section contains controls to change the position of an + object. + + + + + + Shadow Tabbed Section (All except image and barcode objects) + + This section contains controls to add a shadow to an object. + + + + + + + + + Other Manipulations of Objects + + Objects can also be manipulated in the following ways. + + + Moving and Resizing Objects + + Objects can be moved by simply clicking on a selected + object and dragging the object to its new location. If the object + is part of an aggregate selection, all objects in the selection + will move with the object being dragged, maintaining their relative + positions to one another. If no object is selected, clicking on + an object will create a new selection containing that object. + See . + + A selected object can be resized by clicking one of its resize + handle and dragging it to obtain the new size. + + + + + Changing Stacking Order + + Stacking order refers to relative position in the z-axis of + objects. That is when objects overlap, which object will appear + on top of the other. By default, newer objects will appear above + older objects. To change this order, select one or more objects + and choose Objects + Order + Bring to Front + to raise the selection to the top of the stacking + order, or choose Objects + Order + Send to Back + to lower the selection to the bottom of the + stacking order. These menuitems are also available by right-clicking + the display area when there is a non-empty selection. + + + + + Rotating and Flipping Objects + + Objects can be rotated 90 degrees in either direction, or flipped + horizontally or vertically, by choosing the appropriate menuitem + in the Objects + Rotate/Flip sub-menu. These + menuitems are also available by right-clicking + the display area when there is a non-empty selection. + + + + + Aligning Objects + + Objects can be aligned horizontally or vertically, relative to + one another, or relative to the center line of the label, by + choosing the appropriate menuitem from the + Objects + Align Horizontal + or Objects + Align Horizontal sub-menus. + These menuitems are also available by right-clicking + the display area when there is a non-empty selection. + + + + + Using the Property Bar + + The property bar can be used to change some common properties + of objects en-masse. These properties include font family, font + size, font weight, text alignment, text color, fill color, line + or outline color, and line width. The property bar also controls + the defaults for these properties for any newly created objects. + + + + + + + + + + + Performing a Document Merge + + Document Merge (sometimes called "Mail Merge") is a powerful + feature that allows a unique label or card to be printed for each + record in an external data source. + + The first step to performing a document merge is to prepare + a source document that contains your merge data. This data could + be mailing addresses or any other data that you wish to create + unique labels or cards for. Currently back-ends only exist for + text files and the evolution data server -- others are planned. The currently + supported text-file format is very simple: each line is a record; + fields are delimited by commas (CSV), tabs, or colons; and newlines + can be embedded into fields by using the "\n" entity. This file + could be created using any text editor or could be created by + another program or script. A common way of creating CSV files is + to export them from a spreadsheet program. + + A label must then be configured to "point at" this data file. + To configure the merge properties of a document, choose + Objects + Merge Properties menu item + to display the merge properties dialog. This + dialog is used to select the exact data file format and file + name (location) of the merge data. + + Finally, once the label has been configured for a data file, + field keys can be inserted into text objects and used as source + or data for barcode objects and image filenames for image objects. + See for more information + on using merge data for these object types. + + Now that your label is configured, gLabels will print a unique + label for each record in your source document -- substituting fields + from each record for field keys in the all text, barcode, and + image objects. + + See for a detailed + tutorial on the document merge feature. + + + + + + + + + + + + + + Settings + To configure &app;, choose + + Settings + Preferences + . The + Preferences dialog contains the following tabbed + sections: + + + + + + + + + + + + + + Locale + + + + Units + + Use this radio button group to specify your prefered units. + Select one of the following options: + + + + Points + Use points (1 point = 1/72 in = 0.352778 mm). + + + + Inches + Use inches. + + + + Millimeters + Use millimeters. + + + Default: + Inches. + + + + + Default page size + + Use this radio button group to specify your prefered page size. + This will make it quicker for you to locate media types when creating a new + label or card. + + + + US Letter + Most of your media will be of the US Letter page size (8.5 x 11 inches). + + + + ISO A4 + Most of your media will be of the ISO A4 page size (210 x 297 mm). + + + Default: + US Letter. + + + + + + + + Object defaults + + + + Text + + Use these controls to set the default properties of new text objects. + These properties are + + + + Font + These controls are used to select font family and font size, and + whether the font should bold or in italics. + + + + Color + This control selects the default text color. + + + + Alignment + These controls are used to select the default text alignment (left, center or right). + + + + + + + Line + + Use these controls to set the default properties of lines and outlines of + new objects. These properties are + + + + Width + This control selects the default line width. + + + + Color + This control selects the default line color. + + + + + + + Fill + + Use these controls to set the default fill properties of + new objects. These properties are + + + + Color + This control selects the default fill color. + + + + + + + + + + + + + + Document Merge Tutorial + + Document Merge (sometimes called "Mail Merge") is a powerful + feature that allows a unique label or card to be printed for each + record in an external data source. It is however, the most mis-understood + feature of glabels. The following examples + will step through a couple of common tasks using the document merge + feature. + + + Example 1: Name Tags + + In this example we are organizing an orientation party for the new + crew members of our ship. We have a list of freshman crew members that we + created in gnumeric and exported as the following + CSV file. We could have created this file by using a text editor, but heck it + is the 23rd century. + + +Name,Department,SN +"Jim Kirk",Management,"SC937-0176 CEC" +"Mr. Spock",Sciences,S179-276SP +"Leonard McCoy",Medicine,unknown +"Montgomery Scott",Engineering,SE-197-54T + + + In glabels we have created a new glabels + document using the Avery 5395 "Name Badge Labels" template. Next we use the + Objects + Merge Properties menu item to display + the merge properties dialog. We use this dialog to + select the source type (in our case CSV) and the merge source (filename) as + shown. + + +
+ Merge properties dialog + + + + + + +
+ + + Before applying the merge source, we uncheck the first record since it is only + column headers from our original gnumeric spreadsheet + and would simply waste our first label. We could also unselect any other records + that we didn't want to print a label for. + + We can also view each record in more detail by clicking on the appropriate + expander (the little triangles) as shown. Once we are satisfied with the + selections in this dialog we click OK to accept the + changes. + + Now we start adding objects to our glabels document as shown. + + +
+ Adding objects + + + + + + +
+ + + In this example we have added three text objects and a barcode object. The + first text object contains only simple literal text ("Hello, my name is"). The + second text object contains a single merge field ("${1}") corresponding to the + first field of a record (first column of a line) which contains the new crew + member's full name. The third text field contains both literal text + ("Department: ") followed by a single merge field ("${2}") corresponding to + the second field or the crew member's department. The barcode object is + configured to use field (or key) "3" which contains our crew member's + starfleet serial number. + + Now we can print our name tags by selecting the + File + Print menu item. This will display + print dialog as shown below. + + +
+ Printing name tags + + + + + + +
+ + + Just to make sure our labels are going to look okay, we select the + Print outlines option and click + Print Preview. This will display a print preview dialog + as shown below. + + +
+ Name tags preview + + + + + + +
+ + + Everything looks good, so we can now load up our printer with + the appropriate label stock, print our name tags and start beaming our guests + aboard. + + + + + Example 2: Address Labels + + In this example we are going to throw a party and need to print mailing + address labels for our invitations. We have a list of our closest friends + that we created in gnumeric and exported as the + following CSV file. It should be noted that not everyone has a middle initial or + a two line address. + + +LAST,FIRST,MI,ADDR1,ADDR2,CITY,STATE,ZIP +,,,,,,, +Critter,Ess,S,"123 Faux St.",,Alexandria,VA,22310 +Doe,John,,"Apt 1X","451 Mystery St.",Trenton,NJ,08601 +Summers,Joyce,,"1630 Revello Dr",,Sunnydale,CA,95037 +McGarret,Steve,O,"404 Piikoi Street",,Honolulu,HI,96813 +Kramer,Cosmo,,"Apt 5B","129 W. 81 St.","New York",NY,10024-7207 + + + In glabels we have created a new glabels + document using the Avery 5512 "Address Labels" template. Next we use the + Objects + Merge Properties menu item to display + the merge properties dialog. We use this dialog to + select the source type (in our case CSV) and the merge source (filename) as + shown. + + +
+ Merge properties dialog + + + + + + +
+ + + Before applying the merge source, we uncheck the first record since it is only + column headers from our original gnumeric spreadsheet + and would simply waste our first label. We also unselect the second record + which is empty (an artifact of our original spreadsheet). We could also unselect + any other records that we didn't want to print a label for. + + We can also view each record in more detail by clicking on the appropriate + expander (the little triangles) as shown. Once we are satisfied with the + selections in this dialog we click OK to accept the + changes. + + Now we start adding objects to our glabels document as shown. + + +
+ Adding objects + + + + + + +
+ + + In this example we have a single text object. This text object contains + all of our merge fields organized on multiple lines as a mailing address. + Notice that fields ${4} and ${5} (corresponding to ADDR1 and ADDR2) are each + located with no other text on their own lines. When + glabels encounters a field as the only text on + a line, it will not expand the line if the field is empty. + + Now we can print our address labels by selecting the + File + Print menu item. This will display + print dialog as shown below. + + +
+ Printing address labels + + + + + + +
+ + + Just to make sure our labels are going to look okay, we select the + Print outlines option and click + Print Preview. This will display a print preview dialog + as shown below. + + +
+ Address labels preview + + + + + + +
+ + + Everything looks good, so we can now load up our printer with + the appropriate label stock, print our address labels and start mailing + our party invitations. + + + + + + + + + + + Manually Creating New Templates + + Predefined templates are defined by XML files located in + ${prefix}/share/glabels/, + where ${prefix} is usually something like + /usr/local or /usr depending + on the configuration option prefix. gLabels will + use all files of the form *-templates.xml + or *.template, that it finds in + ${prefix}/share/glabels/ and + ${HOME}/.glabels/. + Additional templates can be added by creating additional + *.template files in either of these directories. + + + The format for these files is defined in the DTD: + glabels-2.2.dtd. (This DTD also describes other + XML formats used by glabels.) + + + Assumptions/caveats + + + A sheet contains only one size of label or card (if a sheet + contains more than one size of item, it can be split into + multiple templates for multiple pass printing) + + + Distances can be expressed in units of pt, + in, mm, + cm, or pc. For example: + "1.0in" or "2.54cm". If no + units are specified, computer points (pt) will + be assumed (1 pt = + 1/72 in = 0.352778 mm). + + + + + + + Template Files + + +<?xml version="1.0"?> +<Glabels-templates> + + ...templates... + +</Glabels-templates> + + + + + + Example Template + + <Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels"> + <Label-rectangle id="0" width="189pt" height="72pt" round="5pt"> + <Markup-margin size="5pt"/> + <Layout nx="3" ny="10" x0="11.25pt" y0="36pt" dx="200pt" dy="72pt"/> + </Label-rectangle> + <Alias brand="Avery" part="5160"/> + <Alias brand="Avery" part="6233"/> + </Template> + + + + + Template Node + + A Template node describes a single stationary + product. It must contain one instance of any type of Label node + (Label-rectangle, + Label-round, or Label-cd). + This node can be followed by zero or more + Alias nodes. + + + + + + + + + Property + + + Description + + + + + + brand + + Brand or manufacturer of stationary product. + E.g. "Avery" + + + + part + + Part number or name of stationary product. + E.g. "8160" + + + + size + + Size of sheet. E.g., "US-Letter," "A4", ... + + + + description + + Description of stationary product. E.g, + "Mailing Labels." + + + + _description + + Translatable description of stationary product. + E.g, "Mailing Labels." (Only useful for predefined + templates) + + + + width + + Page width. Only valid if size="Other" + + + + height + + Page height. Only valid if size="Other" + + + + + + + + + + Label-rectangle Node + + A Label-rectangle node describes the + dimensions of a single label or business card that is rectangular + in shape (may have rounded edges). + + + + + + + + + Property + + + Description + + + + + + id + + Reserved for future use. Should always be 0. + + + + width + Width of label/card + + + height + Height of label/card + + + round + + Radius of corners. For items with square edges + (business cards), the radius should be 0. + + + + x_waste + + Amount of horizontal waste (over-print) to allow. This is useful + for minimizing alignment problems when using non-white + backgrounds (e.g. images). + + + + y_waste + + Amount of vertical waste (over-print) to allow. This is useful + for minimizing alignment problems when using non-white + backgrounds (e.g. images). + + + + + + + +
+ Label-rectangle Parameters + + + + + + +
+ + + + + + Label-round Node + + A Label-round node describes the dimensions + of a simple round label (not a CD). + + + + + + + + + Property + + + Description + + + + + + id + + Reserved for future use. Should always be 0. + + + + radius + Radius (1/2 diameter) of label + + + waste + + Amount of waste (over-print) to allow. This is useful + for minimizing alignment problems when using non-white + backgrounds (e.g. images). + + + + + + + + + + Label-cd Node + + A Label-cd node describes the dimensions + of a CD, DVD, or business card CD. + + + + + + + + + Property + + + Description + + + + + + id + + Reserved for future use. Should always be 0. + + + + radius + Outer radius of label + + + hole + Radius of concentric hole + + + width + + If present, the label is clipped to the given width. + (Useful for "business card CDs"). + + + + height + + If present, the label is clipped to the given height. + (Useful for "business card CDs"). + + + + waste + + Amount of waste (over-print) to allow. This is useful + for minimizing alignment problems when using non-white + backgrounds (e.g. images). + + + + + + + +
+ CD Label Parameters + + + + + + +
+ + + + + + Markup-margin Node + + A Markup-margin describes a margin along + all edges of a label. + + + + + + + + + Property + + + Description + + + + + + size + + Size of the margin. I.e. the distance of the margin + line from the edge of the card/label. + + + + + + + + + + Markup-line Node + + A Markup-line describes a markup line. + + + + + + + + + Property + + + Description + + + + + + x1 + + x coordinate of 1st endpoint of the line segment. + + + + y1 + + y coordinate of 1st endpoint of the line segment. + + + + x2 + + x coordinate of 2nd endpoint of the line segment. + + + + y2 + + y coordinate of 2nd endpoint of the line segment. + + + + + + + + + + Markup-circle Node + + A Markup-circle describes a markup circle. + + + + + + + + + + Property + + + Description + + + + + + x0 + + x coordinate of circle origin (center). + + + + y0 + + y coordinate of circle origin (center). + + + + radius + Radius of circle. + + + + + + + + + Markup-rect Node + + A Markup-rect describes a markup rectangle. + + + + + + + + + + Property + + + Description + + + + + + x1 + + x coordinate of upper left corner of rectangle. + + + + y1 + + y coordinate of upper left corner of rectangle. + + + + w + + Width of rectangle. + + + + h + + Height of rectangle. + + + + r + Radius of rounded corners of rectangle. + + + + + + + + + Layout Node + + A label node may contain multiple Layout + children. If labels are arranged in a simple grid pattern, only + one layout is needed. However, if labels are arranged in multiple + grids, such as a running bond pattern, multiple + layout tags can be used. Note: a single label + can always be treated as a grid of one. + + + + + + + + + Property + + + Description + + + + + + nx + + Number of labels/cards across in the grid + (horizontal) + + + + ny + + Number of labels/cards up and down in the grid + (vertical) + + + + x0 + + Distance from left edge of sheet to the left edge of + the left column of cards/labels in the layout. + + + + y0 + + Distance from the top edge of sheet to the top edge of + the top row of labels/cards in the layout. + + + + dx + Horizontal pitch of grid. + + + dy + Vertical pitch of grid. + + + + + + +
+ Layout Parameters + + + + + + +
+ + + + + + Alias Node + + An Alias node provides the name of a + product with the same size and layout characteristics as the + parent template. + + + + + + + + + Property + + + Description + + + + + + brand + + The brand or manufacturer of the equivalent product. + + + + part + + The part number or name of the equivalent product. + + + + + + + + + + + + + + + + + + + + + + + About &app; + &app; was written by Jim Evins + (evins@snaught.com). To find more information about + &app;, please visit the + gLabels Web + page. + + To report a bug or make a suggestion regarding this application or + this manual, follow the directions at the + gLabels Contact Page. + + + This program is distributed under the terms of the GNU + General Public license as published by the Free Software + Foundation; either version 2 of the License, or (at your option) + any later version. A copy of this license can be found at this + link, or in the file + COPYING included with the source code of this program. + + + + + + + +
diff --git a/help/C/glabels.xml b/help/C/glabels.xml deleted file mode 100644 index e74eb322..00000000 --- a/help/C/glabels.xml +++ /dev/null @@ -1,2127 +0,0 @@ - - - - - - gLabels"> - -]> - - - - - -
- - - - &app; Manual V&manrevision; - - - User manual for the gLabels label and business card creation program - - - - 2003-2007 - Jim Evins - - - Jim Evins - - - &legal; - - - - - Jim - Evins - - - - - - - - - - - - - - - - - - - - - gLabels Manual V&manrevision; - &date; - - Jim Evins - evins@snaught.com - - Jim Evins - - - - - This manual describes version &appversion; of gLabels. - - - Feedback - To report a bug or make a suggestion regarding the &app; application or - this manual, follow the directions in the gLabels Contact Page. - - - - - - - gLabels - - - glabels - - - - - - - - - - Introduction - - The &app; application is a lightweight program for creating labels - and business cards for the GNOME desktop - environment. It is designed to work with various laser/ink-jet - peel-off label and business card sheets that you'll find at most - office supply stores. - - - - - - - - - - - Getting Started - - - To Start &app; - You can start &app; in the following ways: - - - - Applications menu - - Choose - - Office - gLabels - . - - - - Command line - - Type glabels, - then press Return: - - - - - - - When You Start &app; - When you start &app;, the following window is displayed. - - -
- &app; Start Up Window - - - - - - -
- - - - - - The &app; window contains the following elements: - - - - Menubar. - - The menus on the menubar contain all of the commands you - need to create and edit labels and business cards in - &app;. - - - - Main toolbar. - - The main toolbar contains a subset of common File and Edit - commands that you can access from the menubar. - - - - Drawing toolbar. - - The drawing toolbar contains a subset of commands for - editing the current glabels document. - - - - Display area. - - The display area is the main drawing interface to - &app;. - - - - Object sidebar. - - The object sidebar provides an interface for viewing and - editing all properties of an individual object. - - - - Properties toolbar. - - The properties toolbar contains a set of tools to - manipulate the properties of selected objects and set default - properties for new objects. - - - - Statusbar. - - The statusbar displays information about current - &app; activity and contextual - information about the menu items. - - - - - - - - - - - - - Usage - - - - To Create a New Label or Card - - To create a new label or business card, choose - File New - - to display the New Label or Card dialog. Select - the media type and orientation for the new document, - then click OK. A new document is - displayed in the display area of the &app; - window. - - If your particular media type is missing from this dialog, - see - - - - - - To Open a File - - To open a file, choose - File Open - to display the Open File dialog. - Select the file that you want to open, then click - OK. The file is displayed in the display area - of the &app; window. - - You can also open multiple files in - &app;. The application creates a separate - application window for each open file. - - The application records the paths and filenames of the - most recent files that you have edited and displays the files as menu - items on the - FileRecent Files - menu. - - - - - - To Open Multiple Files from a Command Line - - You can run &app; from a command line - and open a single file or multiple files. To open multiple files from - a command line, type the following command, then press - Return: - - glabels - file1.glabels file2.glabels file3.glabels - - - When the application starts, the files that you specify are - displayed in separate &app; windows. - - - - - - To Save a File - - You can save files in the following ways: - - - - - To save changes to an existing file, choose - File - Save . - - - - - To save a new file or to save an existing file under a new - filename, choose File - Save As . Enter a name - for the file in the Save As dialog box, - then click OK. - - - - - - - - - To Change Label Properties - - To change the media type and/or orientation of a label, choose - File - Properties to display the - Label properties dialog. Select the - new media type and orientation for the document, then click - OK. - - - - - - To Create a Custom Template - - To create a new custom template, choose - File - Template Designer ... - to display the Template Designer dialog. - This dialog will assist you in creating a custom template for - most types of label or card stationery that you may encounter. - - If you prefer, you can create your templates manually. - For this option see - - - - - - - To Close a File - - To close the current document, choose - File - Close to close the application - window. If the current document is modified, a confirmation dialog - will be presented, allowing you to save the document or cancel - the command. If the window being closed is the only open window, - &app; will exit. - - - - - - To Quit <application>&app;</application> - - To quit &app;, choose - File - Quit . This is equivalent - to closing all open windows. See - . - - - - - - To Print Labels or Cards - - To print labels or cards, choose - File Print - to display the Print dialog. - Once print options have been selected, click Print - to print the labels or cards. To simply preview the results, - click Print Preview instead. - - The Print dialog allows you to specify the - following print options: - - - The Labels Tab of the Print Dialog - - - - - Print control (Simple) - - - For simple labels or cards (no document merge), the job - tabbed section contains the following copy controls. - - - - - - The number of copies of the label can be selected by - choosing the number of full sheets to print, or a specific - subset of labels on a single sheet. - - The mini-preview can also be used to graphically select - the subset of labels by clicking the first label on the - mini-preview and dragging to the last label. - - - - - - Print control (Merge) - - - For labels or cards using the document merge (also known - as "mail merge") capability, the job tabbed section contains - the following merge controls instead of copy controls. - - - - - - The total number of labels or cards printed is the - product of the number of records in the merge source and - the number of copies selected. If multiple copies are - selected, these can be either collated (copies of the - same record grouped together) or un-collated (one copy - each record is printed before next copy). - - Printing can begin on any label on the first sheet. - This can be selected with the Start on - label spinbutton. - - The mini-preview can also be used to graphically select - this first label, by clicking on the desired label in the - mini-preview. - - - - - Options - - The following options can also be selected. - - - print outlines - Print outlines of labels. This option is useful for - dry-runs, to test printer alignment. - - - print in reverse - Prints the labels as mirror images. This option is - useful for printing on clear labels that will be viewed - from the reverse side (e.g. in a car window). - - - print crop marks - Prints crop marks along the edge of the sheet. - This option is useful for printing on blank stock, to - be cut after printing. This option does not work well - with all templates. - - - - - - - - - - - - To Create New Objects - - Objects are created by choosing the appropriate selection under - the Objects - Create Object submenu or - the Drawing Toolbar. This will place the - display area into object creation mode as indicated by its cursor. - To return to the default object selection mode without creating - an object, choose Objects - Select Mode . This will - return the display area's cursor to the default selection arrow. - - The following describes the object creation mode for each object - type: - - - - - Text - - Click the desired location of the upper left corner of the - text object. New text objects are initialized with the - string "Text." To change this text, or other properties, see - . - - - - - Box - - Click the desired location of the upper left corner of the - box object and drag to the desired location of the lower right - corner. If you simply click in a single location, a square - box will be created. To change properties of the box object, see - . - - - - - Line - - Click the desired location of one end of the - line object and drag to the desired location of the other end. - If you simply click in a single location, a diagonal line - will be created. To change properties of the line object, see - . - - - - - Ellipse - - Click the desired location of the upper left corner of the - ellipse object and drag to the desired location of the lower - right corner. If you simply click in a single location, a circle - will be created. To change properties of the ellipse object, see - . - - - - - Image - - Click the desired location of the upper left corner of the - image object and drag to the desired location of the lower - right corner. If you simply click in a single location, a square - will be created. New image objects are initialized with a - simple checkerboard image. To change this image, or other - properties of the image object, see - . - - - - - Barcode - - Click the desired location of the upper left corner of the - barcode object. New barcode objects are initialized to a - POSTNET barcode with representative data. To change data - and properties of the barcode object, see - . - - - - - - - - - - - To Select Objects - - A prerequisite for performing operations on objects is the - selection of individual objects or groups of objects. The - display area must be in the object selection mode to create new - selections, as indicated by an arrow cursor. The object - selection mode is selected by the - Objects - Select Mode menu item, - or the corresponding command on the Drawing - Toolbar. - - - - - Selecting a single object - - A single object can be selected simply by clicking - on the desired object in the display area. - Once selected the object will be highlighted with a set of - resizing handles. - - - - - Aggregate object selections - - Multiple objects can be selected by first selecting the first - object as above and then by holding the Ctrl - key while selecting additional objects. - Individual objects can be added to an existing selection - at any time by holding the Ctrl key while - selecting the desired objects. All objects can also be - selected by using the Edit - Select All - menu item. All objects in an aggregate object selection will be - highlighted. - - - - - Area selections - - Multiple objects can also be selected by clicking an empty - area and dragging to form a rectangular area. When released, - all objects contained in the area will form an aggregate - selection. An area selection can be used to add to an existing - selection by holding the Ctrl key while - performing the selection. - - - - - Unselecting objects - - Individual objects can be removed from an existing - selection by holding the Ctrl key while - clicking on a previously selected object. An entire selection - can be dismissed by using the - Edit Un-select All - menu item - or by simply clicking any empty space in the display area. - Once an object is unselected its highlight is removed. - - - - - - - - - - Clipboard Commands - - Object selections can be manipulated using the standard clipboard - operations Cut, - Copy, Paste, - and Delete. - - - - - - - - CtrlX - - Cut - - - - Moves selected objects to the clipboard. The objects are - then available for pasting back into the current document or - another document. - - - - - - - - CtrlC - - Copy - - - - Copies selected objects to the clipboard without deleting - them. The objects are then available for pasting back into - the current document or another document. - - - - - - - - CtrlV - - Paste - - - - Pastes objects from the clipboard into the current document. - &app; can only paste objects from - another &app; document. - - - - - - - - Delete - - Delete - - - - Deletes selected objects without placing them on the - clipboard. - - - - - - - - - - To Edit Object Properties - - Most object properties can be modified through the object - editor sidebar, illustrated below. To use the object editor, - a single object must first be selected. See - . - - -
- Object Editor Sidebar - - - - - - -
- - - The object editor will contain a subset of the following - tabbed sections, depending on object type: - - - Text Tabbed Section (Text objects) - - This section contains a small editor for changing the content - of a text object. It also contains a dropdown menu of available - document merge keys, that can be inserted into text. - - - - - Image Tabbed Section (Image objecs) - - This section contains a file entry with preview to select - image files. The browse button can be used to easily locate - image files. Alternatively, a document merge key can be used - instead to provide a filename at print time. - - - - - Data Tabbed Section (Barcode objecs) - - This section contains a text entry to enter literal barcode - data. Alternatively, a document merge key can be used to - provide this data at print time. - - - - - Style Tabbed Section (Text objects) - - This section contains controls to select text properties, - including font family, font size, font weight, color, and - text justification. - - - - - Style Tabbed Section (Barcode objecs) - - This section contains controls to select barcode properties, - including barcode style, color, whether to print text, and whether - to include a checksum digit. - - - - - Line Tabbed Section - - This section contains controls to select properties of lines - and outlines. These properties include line width and color. - - - - - Fill Tabbed Section - - This section contains controls to select fill properties of box - and ellipse objects. Currently the only fill property is fill - color. - - - - - Size Tabbed Section (All except line objects) - - This section contains controls to select the width and height - of an object. A checkbox is provided, so that the current aspect - ratio can be locked while manipulating the width and height controls. - Image objects also provide a button to reset the size to the - image's natural size (Assumes 72DPI). - - - - - Size Tabbed Section (Line objects) - - This section contains controls to select the length and angle - of a line object. - - - - - Position Tabbed Section - - This section contains controls to change the position of an - object. - - - - - - Shadow Tabbed Section (All except image and barcode objects) - - This section contains controls to add a shadow to an object. - - - - - - - - - Other Manipulations of Objects - - Objects can also be manipulated in the following ways. - - - Moving and Resizing Objects - - Objects can be moved by simply clicking on a selected - object and dragging the object to its new location. If the object - is part of an aggregate selection, all objects in the selection - will move with the object being dragged, maintaining their relative - positions to one another. If no object is selected, clicking on - an object will create a new selection containing that object. - See . - - A selected object can be resized by clicking one of its resize - handle and dragging it to obtain the new size. - - - - - Changing Stacking Order - - Stacking order refers to relative position in the z-axis of - objects. That is when objects overlap, which object will appear - on top of the other. By default, newer objects will appear above - older objects. To change this order, select one or more objects - and choose Objects - Order - Bring to Front - to raise the selection to the top of the stacking - order, or choose Objects - Order - Send to Back - to lower the selection to the bottom of the - stacking order. These menuitems are also available by right-clicking - the display area when there is a non-empty selection. - - - - - Rotating and Flipping Objects - - Objects can be rotated 90 degrees in either direction, or flipped - horizontally or vertically, by choosing the appropriate menuitem - in the Objects - Rotate/Flip sub-menu. These - menuitems are also available by right-clicking - the display area when there is a non-empty selection. - - - - - Aligning Objects - - Objects can be aligned horizontally or vertically, relative to - one another, or relative to the center line of the label, by - choosing the appropriate menuitem from the - Objects - Align Horizontal - or Objects - Align Horizontal sub-menus. - These menuitems are also available by right-clicking - the display area when there is a non-empty selection. - - - - - Using the Property Bar - - The property bar can be used to change some common properties - of objects en-masse. These properties include font family, font - size, font weight, text alignment, text color, fill color, line - or outline color, and line width. The property bar also controls - the defaults for these properties for any newly created objects. - - - - - - - - - - - Performing a Document Merge - - Document Merge (sometimes called "Mail Merge") is a powerful - feature that allows a unique label or card to be printed for each - record in an external data source. - - The first step to performing a document merge is to prepare - a source document that contains your merge data. This data could - be mailing addresses or any other data that you wish to create - unique labels or cards for. Currently back-ends only exist for - text files and the evolution data server -- others are planned. The currently - supported text-file format is very simple: each line is a record; - fields are delimited by commas (CSV), tabs, or colons; and newlines - can be embedded into fields by using the "\n" entity. This file - could be created using any text editor or could be created by - another program or script. A common way of creating CSV files is - to export them from a spreadsheet program. - - A label must then be configured to "point at" this data file. - To configure the merge properties of a document, choose - Objects - Merge Properties menu item - to display the merge properties dialog. This - dialog is used to select the exact data file format and file - name (location) of the merge data. - - Finally, once the label has been configured for a data file, - field keys can be inserted into text objects and used as source - or data for barcode objects and image filenames for image objects. - See for more information - on using merge data for these object types. - - Now that your label is configured, gLabels will print a unique - label for each record in your source document -- substituting fields - from each record for field keys in the all text, barcode, and - image objects. - - See for a detailed - tutorial on the document merge feature. - - - - - - - - - - - - - - Settings - To configure &app;, choose - - Settings - Preferences - . The - Preferences dialog contains the following tabbed - sections: - - - - - - - - - - - - - - Locale - - - - Units - - Use this radio button group to specify your prefered units. - Select one of the following options: - - - - Points - Use points (1 point = 1/72 in = 0.352778 mm). - - - - Inches - Use inches. - - - - Millimeters - Use millimeters. - - - Default: - Inches. - - - - - Default page size - - Use this radio button group to specify your prefered page size. - This will make it quicker for you to locate media types when creating a new - label or card. - - - - US Letter - Most of your media will be of the US Letter page size (8.5 x 11 inches). - - - - ISO A4 - Most of your media will be of the ISO A4 page size (210 x 297 mm). - - - Default: - US Letter. - - - - - - - - Object defaults - - - - Text - - Use these controls to set the default properties of new text objects. - These properties are - - - - Font - These controls are used to select font family and font size, and - whether the font should bold or in italics. - - - - Color - This control selects the default text color. - - - - Alignment - These controls are used to select the default text alignment (left, center or right). - - - - - - - Line - - Use these controls to set the default properties of lines and outlines of - new objects. These properties are - - - - Width - This control selects the default line width. - - - - Color - This control selects the default line color. - - - - - - - Fill - - Use these controls to set the default fill properties of - new objects. These properties are - - - - Color - This control selects the default fill color. - - - - - - - - - - - - - - Document Merge Tutorial - - Document Merge (sometimes called "Mail Merge") is a powerful - feature that allows a unique label or card to be printed for each - record in an external data source. It is however, the most mis-understood - feature of glabels. The following examples - will step through a couple of common tasks using the document merge - feature. - - - Example 1: Name Tags - - In this example we are organizing an orientation party for the new - crew members of our ship. We have a list of freshman crew members that we - created in gnumeric and exported as the following - CSV file. We could have created this file by using a text editor, but heck it - is the 23rd century. - - -Name,Department,SN -"Jim Kirk",Management,"SC937-0176 CEC" -"Mr. Spock",Sciences,S179-276SP -"Leonard McCoy",Medicine,unknown -"Montgomery Scott",Engineering,SE-197-54T - - - In glabels we have created a new glabels - document using the Avery 5395 "Name Badge Labels" template. Next we use the - Objects - Merge Properties menu item to display - the merge properties dialog. We use this dialog to - select the source type (in our case CSV) and the merge source (filename) as - shown. - - -
- Merge properties dialog - - - - - - -
- - - Before applying the merge source, we uncheck the first record since it is only - column headers from our original gnumeric spreadsheet - and would simply waste our first label. We could also unselect any other records - that we didn't want to print a label for. - - We can also view each record in more detail by clicking on the appropriate - expander (the little triangles) as shown. Once we are satisfied with the - selections in this dialog we click OK to accept the - changes. - - Now we start adding objects to our glabels document as shown. - - -
- Adding objects - - - - - - -
- - - In this example we have added three text objects and a barcode object. The - first text object contains only simple literal text ("Hello, my name is"). The - second text object contains a single merge field ("${1}") corresponding to the - first field of a record (first column of a line) which contains the new crew - member's full name. The third text field contains both literal text - ("Department: ") followed by a single merge field ("${2}") corresponding to - the second field or the crew member's department. The barcode object is - configured to use field (or key) "3" which contains our crew member's - starfleet serial number. - - Now we can print our name tags by selecting the - File - Print menu item. This will display - print dialog as shown below. - - -
- Printing name tags - - - - - - -
- - - Just to make sure our labels are going to look okay, we select the - Print outlines option and click - Print Preview. This will display a print preview dialog - as shown below. - - -
- Name tags preview - - - - - - -
- - - Everything looks good, so we can now load up our printer with - the appropriate label stock, print our name tags and start beaming our guests - aboard. - - - - - Example 2: Address Labels - - In this example we are going to throw a party and need to print mailing - address labels for our invitations. We have a list of our closest friends - that we created in gnumeric and exported as the - following CSV file. It should be noted that not everyone has a middle initial or - a two line address. - - -LAST,FIRST,MI,ADDR1,ADDR2,CITY,STATE,ZIP -,,,,,,, -Critter,Ess,S,"123 Faux St.",,Alexandria,VA,22310 -Doe,John,,"Apt 1X","451 Mystery St.",Trenton,NJ,08601 -Summers,Joyce,,"1630 Revello Dr",,Sunnydale,CA,95037 -McGarret,Steve,O,"404 Piikoi Street",,Honolulu,HI,96813 -Kramer,Cosmo,,"Apt 5B","129 W. 81 St.","New York",NY,10024-7207 - - - In glabels we have created a new glabels - document using the Avery 5512 "Address Labels" template. Next we use the - Objects - Merge Properties menu item to display - the merge properties dialog. We use this dialog to - select the source type (in our case CSV) and the merge source (filename) as - shown. - - -
- Merge properties dialog - - - - - - -
- - - Before applying the merge source, we uncheck the first record since it is only - column headers from our original gnumeric spreadsheet - and would simply waste our first label. We also unselect the second record - which is empty (an artifact of our original spreadsheet). We could also unselect - any other records that we didn't want to print a label for. - - We can also view each record in more detail by clicking on the appropriate - expander (the little triangles) as shown. Once we are satisfied with the - selections in this dialog we click OK to accept the - changes. - - Now we start adding objects to our glabels document as shown. - - -
- Adding objects - - - - - - -
- - - In this example we have a single text object. This text object contains - all of our merge fields organized on multiple lines as a mailing address. - Notice that fields ${4} and ${5} (corresponding to ADDR1 and ADDR2) are each - located with no other text on their own lines. When - glabels encounters a field as the only text on - a line, it will not expand the line if the field is empty. - - Now we can print our address labels by selecting the - File - Print menu item. This will display - print dialog as shown below. - - -
- Printing address labels - - - - - - -
- - - Just to make sure our labels are going to look okay, we select the - Print outlines option and click - Print Preview. This will display a print preview dialog - as shown below. - - -
- Address labels preview - - - - - - -
- - - Everything looks good, so we can now load up our printer with - the appropriate label stock, print our address labels and start mailing - our party invitations. - - - - - - - - - - - Manually Creating New Templates - - Predefined templates are defined by XML files located in - ${prefix}/share/glabels/, - where ${prefix} is usually something like - /usr/local or /usr depending - on the configuration option prefix. gLabels will - use all files of the form *-templates.xml - or *.template, that it finds in - ${prefix}/share/glabels/ and - ${HOME}/.glabels/. - Additional templates can be added by creating additional - *.template files in either of these directories. - - - The format for these files is defined in the DTD: - glabels-2.2.dtd. (This DTD also describes other - XML formats used by glabels.) - - - Assumptions/caveats - - - A sheet contains only one size of label or card (if a sheet - contains more than one size of item, it can be split into - multiple templates for multiple pass printing) - - - Distances can be expressed in units of pt, - in, mm, - cm, or pc. For example: - "1.0in" or "2.54cm". If no - units are specified, computer points (pt) will - be assumed (1 pt = - 1/72 in = 0.352778 mm). - - - - - - - Template Files - - -<?xml version="1.0"?> -<Glabels-templates> - - ...templates... - -</Glabels-templates> - - - - - - Example Template - - <Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels"> - <Label-rectangle id="0" width="189pt" height="72pt" round="5pt"> - <Markup-margin size="5pt"/> - <Layout nx="3" ny="10" x0="11.25pt" y0="36pt" dx="200pt" dy="72pt"/> - </Label-rectangle> - <Alias brand="Avery" part="5160"/> - <Alias brand="Avery" part="6233"/> - </Template> - - - - - Template Node - - A Template node describes a single stationary - product. It must contain one instance of any type of Label node - (Label-rectangle, - Label-round, or Label-cd). - This node can be followed by zero or more - Alias nodes. - - - - - - - - - Property - - - Description - - - - - - brand - - Brand or manufacturer of stationary product. - E.g. "Avery" - - - - part - - Part number or name of stationary product. - E.g. "8160" - - - - size - - Size of sheet. E.g., "US-Letter," "A4", ... - - - - description - - Description of stationary product. E.g, - "Mailing Labels." - - - - _description - - Translatable description of stationary product. - E.g, "Mailing Labels." (Only useful for predefined - templates) - - - - width - - Page width. Only valid if size="Other" - - - - height - - Page height. Only valid if size="Other" - - - - - - - - - - Label-rectangle Node - - A Label-rectangle node describes the - dimensions of a single label or business card that is rectangular - in shape (may have rounded edges). - - - - - - - - - Property - - - Description - - - - - - id - - Reserved for future use. Should always be 0. - - - - width - Width of label/card - - - height - Height of label/card - - - round - - Radius of corners. For items with square edges - (business cards), the radius should be 0. - - - - x_waste - - Amount of horizontal waste (over-print) to allow. This is useful - for minimizing alignment problems when using non-white - backgrounds (e.g. images). - - - - y_waste - - Amount of vertical waste (over-print) to allow. This is useful - for minimizing alignment problems when using non-white - backgrounds (e.g. images). - - - - - - - -
- Label-rectangle Parameters - - - - - - -
- - - - - - Label-round Node - - A Label-round node describes the dimensions - of a simple round label (not a CD). - - - - - - - - - Property - - - Description - - - - - - id - - Reserved for future use. Should always be 0. - - - - radius - Radius (1/2 diameter) of label - - - waste - - Amount of waste (over-print) to allow. This is useful - for minimizing alignment problems when using non-white - backgrounds (e.g. images). - - - - - - - - - - Label-cd Node - - A Label-cd node describes the dimensions - of a CD, DVD, or business card CD. - - - - - - - - - Property - - - Description - - - - - - id - - Reserved for future use. Should always be 0. - - - - radius - Outer radius of label - - - hole - Radius of concentric hole - - - width - - If present, the label is clipped to the given width. - (Useful for "business card CDs"). - - - - height - - If present, the label is clipped to the given height. - (Useful for "business card CDs"). - - - - waste - - Amount of waste (over-print) to allow. This is useful - for minimizing alignment problems when using non-white - backgrounds (e.g. images). - - - - - - - -
- CD Label Parameters - - - - - - -
- - - - - - Markup-margin Node - - A Markup-margin describes a margin along - all edges of a label. - - - - - - - - - Property - - - Description - - - - - - size - - Size of the margin. I.e. the distance of the margin - line from the edge of the card/label. - - - - - - - - - - Markup-line Node - - A Markup-line describes a markup line. - - - - - - - - - Property - - - Description - - - - - - x1 - - x coordinate of 1st endpoint of the line segment. - - - - y1 - - y coordinate of 1st endpoint of the line segment. - - - - x2 - - x coordinate of 2nd endpoint of the line segment. - - - - y2 - - y coordinate of 2nd endpoint of the line segment. - - - - - - - - - - Markup-circle Node - - A Markup-circle describes a markup circle. - - - - - - - - - - Property - - - Description - - - - - - x0 - - x coordinate of circle origin (center). - - - - y0 - - y coordinate of circle origin (center). - - - - radius - Radius of circle. - - - - - - - - - Markup-rect Node - - A Markup-rect describes a markup rectangle. - - - - - - - - - - Property - - - Description - - - - - - x1 - - x coordinate of upper left corner of rectangle. - - - - y1 - - y coordinate of upper left corner of rectangle. - - - - w - - Width of rectangle. - - - - h - - Height of rectangle. - - - - r - Radius of rounded corners of rectangle. - - - - - - - - - Layout Node - - A label node may contain multiple Layout - children. If labels are arranged in a simple grid pattern, only - one layout is needed. However, if labels are arranged in multiple - grids, such as a running bond pattern, multiple - layout tags can be used. Note: a single label - can always be treated as a grid of one. - - - - - - - - - Property - - - Description - - - - - - nx - - Number of labels/cards across in the grid - (horizontal) - - - - ny - - Number of labels/cards up and down in the grid - (vertical) - - - - x0 - - Distance from left edge of sheet to the left edge of - the left column of cards/labels in the layout. - - - - y0 - - Distance from the top edge of sheet to the top edge of - the top row of labels/cards in the layout. - - - - dx - Horizontal pitch of grid. - - - dy - Vertical pitch of grid. - - - - - - -
- Layout Parameters - - - - - - -
- - - - - - Alias Node - - An Alias node provides the name of a - product with the same size and layout characteristics as the - parent template. - - - - - - - - - Property - - - Description - - - - - - brand - - The brand or manufacturer of the equivalent product. - - - - part - - The part number or name of the equivalent product. - - - - - - - - - - - - - - - - - - - - - - - About &app; - &app; was written by Jim Evins - (evins@snaught.com). To find more information about - &app;, please visit the - gLabels Web - page. - - To report a bug or make a suggestion regarding this application or - this manual, follow the directions at the - gLabels Contact Page. - - - This program is distributed under the terms of the GNU - General Public license as published by the Free Software - Foundation; either version 2 of the License, or (at your option) - any later version. A copy of this license can be found at this - link, or in the file - COPYING included with the source code of this program. - - - - - - - -
diff --git a/help/Makefile.am b/help/Makefile.am index 561c402f..106ec0e6 100644 --- a/help/Makefile.am +++ b/help/Makefile.am @@ -2,7 +2,7 @@ include $(top_srcdir)/gnome-doc-utils.make dist-hook: doc-dist-hook -DOC_MODULE = glabels +DOC_MODULE = $(GLABELS_BRANCH) DOC_ENTITIES = legal.xml DOC_INCLUDES = DOC_FIGURES = figures/glabels-template-cd.png \ diff --git a/help/glabels-3.0.omf.in b/help/glabels-3.0.omf.in new file mode 100644 index 00000000..ccbdae2d --- /dev/null +++ b/help/glabels-3.0.omf.in @@ -0,0 +1,12 @@ + + + + + + manual + + + + + diff --git a/help/glabels.omf.in b/help/glabels.omf.in deleted file mode 100644 index ccbdae2d..00000000 --- a/help/glabels.omf.in +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - manual - - - - - diff --git a/po/POTFILES.in b/po/POTFILES.in index 272379e4..0a80e84e 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -217,10 +217,9 @@ libglabels/xml-template.h [type: gettext/glade]data/builder/template-designer.builder [type: gettext/glade]data/builder/print-op-dialog-custom-widget.builder -[type: gettext/ini]data/desktop/glabels.desktop.in +[type: gettext/ini]data/desktop/glabels-3.0.desktop.in -[type: gettext/keys]data/mime/glabels.keys.in -[type: gettext/xml]data/mime/glabels.xml.in +[type: gettext/xml]data/mime/glabels-3.0.xml.in [type: gettext/xml]templates/paper-sizes.xml [type: gettext/xml]templates/categories.xml diff --git a/src/ui-commands.c b/src/ui-commands.c index f31f87cc..89203b91 100644 --- a/src/ui-commands.c +++ b/src/ui-commands.c @@ -1102,7 +1102,7 @@ gl_ui_cmd_help_contents (GtkAction *action, g_return_if_fail (window && GL_IS_WINDOW(window)); gtk_show_uri (gtk_widget_get_screen (GTK_WIDGET (window)), - "ghelp:glabels", + "ghelp:glabels-3.0", GDK_CURRENT_TIME, &error);