--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="topic"
+ id="about">
+
+ <info>
+ <link type="seealso" xref="index"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Information about <app>gLabels</app>.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>About <app>gLabels</app></title>
+
+ <p> <app>gLabels</app> was written by <credit><name>Jim Evins
+ (<email>evins@snaught.com</email>)</name></credit>. To find more information about
+ <app>gLabels</app>, please visit the
+ <link href="http://glabels.org" type="http">gLabels Web
+ page</link>. </p>
+ <p>
+ To report a bug or make a suggestion regarding this application or
+ this manual, follow the directions at the
+ <link href="http://glabels.org/contact/" type="http"><app>gLabels</app> Contact Page</link>.
+ </p>
+
+ <p> 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 href="ghelp:gpl" type="help">link</link>, or in the file
+ COPYING included with the source code of this program. </p>
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="basicusage">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Handling files and quit the application.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Basic usage</title>
+
+ <section>
+ <title>To open a file</title>
+
+ <p>To open a file, choose
+ <guiseq><gui>File</gui><gui>Open</gui>
+ </guiseq> to display the <gui>Open File</gui> dialog.
+ Select the file that you want to open, then click
+ <gui>OK</gui>. The file is displayed in the display area
+ of the <app>gLabels</app> window. </p>
+
+ <p>You can also open multiple files in
+ <app>gLabels</app>. The application creates a separate
+ application window for each open file.</p>
+
+ <p>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 <guiseq><gui>File</gui><gui>Recent Files</gui>
+ </guiseq> menu.</p>
+ </section>
+
+ <section id="closefile">
+ <title>To close a file</title>
+
+ <p>To close the current document, choose
+ <guiseq><gui>File</gui>
+ <gui>Close</gui></guiseq> 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>gLabels</app> will exit.</p>
+ </section>
+
+ <section>
+ <title>To save a file</title>
+
+ <p>You can save files in the following ways:</p>
+
+ <list><item>
+
+ <p>To save changes to an existing file, choose
+ <guiseq><gui>File</gui>
+ <gui>Save</gui></guiseq>. </p>
+
+ </item>
+ <item>
+
+ <p>To save a new file or to save an existing file under a new
+ filename, choose <guiseq><gui>File</gui>
+ <gui>Save As</gui></guiseq>. Enter a name
+ for the file in the <gui>Save As</gui> dialog box,
+ then click <gui>OK</gui>.</p>
+
+ </item>
+ </list>
+ </section>
+
+ <section>
+ <title>To quit <app>gLabels</app></title>
+
+ <p>To quit <app>gLabels</app>, choose <guiseq><gui>File</gui>
+ <gui>Quit</gui></guiseq>. This is equivalent to closing all open windows.
+ See <link xref="basicusage#closefile"/>.</p>
+ </section>
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="createnew">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create new objects within your document.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To create new objects</title>
+
+ <p>Objects are created by choosing the appropriate selection under
+ the <guiseq><gui>Objects</gui><gui>Create Object</gui></guiseq> submenu
+ or the <gui>Drawing Toolbar</gui>. 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
+ <guiseq><gui>Objects</gui><gui>Select Mode</gui></guiseq>. This will
+ return the display area's cursor to the default selection arrow.</p>
+
+ <p>The following describes the object creation mode for each object
+ type:</p>
+
+ <section>
+ <title>Text</title>
+ <p>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
+ <xref linkend="glabels-object-properties"/>.</p>
+ </section>
+
+ <section>
+ <title>Box</title>
+ <p>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
+ <xref linkend="glabels-object-properties"/>.</p>
+ </section>
+
+ <section>
+ <title>Line</title>
+ <p>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
+ <link xref="glabels-object-properties"/>.</p>
+ </section>
+
+ <section>
+ <title>Ellipse</title>
+ <p>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
+ <link xref="glabels-object-properties"/>.</p>
+ </section>
+
+ <section>
+ <title>Image</title>
+ <p>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
+ <link xref="glabels-object-properties"/>.</p>
+ </section>
+
+ <section>
+ <title>Barcode</title>
+ <p>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
+ <xref linkend="glabels-object-properties"/>.</p>
+ </section>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="customize">
+
+ <info>
+ <link type="guide" xref="index#advanced"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>Customize <app>gLabels</app> to match your needs.</desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <!-- ============= Customization ============================= -->
+ <!-- Use this section to describe how to customize the application. -->
+ <title>Settings</title>
+ <p>To configure <app>gLabels</app>, choose
+ <guiseq>
+ <gui>Settings</gui>
+ <gui>Preferences</gui>
+ </guiseq>. The
+ <gui>Preferences</gui> dialog contains the following tabbed
+ sections:</p>
+
+ <section id="prefs-locale" style="2column">
+ <title>Locale</title>
+ <section>
+ <title>Units</title>
+ <p>Use this radio button group to specify your preferred units.
+ Select one of the following options:</p>
+ <list>
+ <item>
+ <p><gui>Points</gui></p>
+ <p>Use points (1 point = 1/72 in = 0.352778 mm).</p>
+ </item>
+ <item>
+ <p><gui>Inches</gui></p>
+ <p>Use Inches.</p>
+ </item>
+ <item>
+ <p><gui>Millimeters</gui></p>
+ <p>Use Millimeters.</p>
+ </item>
+ </list>
+ <p>Default: <gui>Inches</gui>.</p>
+ </section>
+
+ <section>
+ <title>Default page size</title>
+ <p>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.</p>
+ <list>
+ <item>
+ <p><gui>US Letter</gui></p>
+ <p>Most of your media will be of the US Letter page size (8.5 x 11 inches).</p>
+ </item>
+ <item>
+ <p><gui>ISO A4</gui></p>
+ <p>Most of your media will be of the ISO A4 page size (210 x 297 mm).</p>
+ </item>
+ </list>
+ <p>Default: <gui>US Letter</gui>.</p>
+ </section>
+ </section>
+
+ <section id="prefs-defaults" style="2column">
+ <title>Object Defaults</title>
+
+ <section>
+ <title>Text</title>
+ <p>Use these controls to set the default properties of new text objects.
+ These properties are:</p>
+ <list>
+ <item>
+ <p><gui>Font</gui></p>
+ <p>These controls are used to select font family and font size, and
+ whether the font should bold or in italics.</p>
+ </item>
+ <item>
+ <p><gui>Color</gui></p>
+ <p>This control selects the default text color.</p>
+ </item>
+ <item>
+ <p><gui>Alignment</gui></p>
+ <p>These controls are used to select the default text alignment (left, center or right).</p>
+ </item>
+ </list>
+ </section>
+
+ <section>
+ <title>Line</title>
+ <p>Use these controls to set the default properties of lines and outlines of
+ new objects. These properties are:</p>
+ <list>
+ <item>
+ <p><gui>Width</gui></p>
+ <p>These controls are selects the default line width.</p>
+ </item>
+ <item>
+ <p><gui>Color</gui></p>
+ <p>This control selects the default line color.</p>
+ </item>
+ </list>
+ </section>
+
+ <section>
+ <title>Fill</title>
+ <p>Use these controls to set the default fill properties of
+ new objects. These properties are:</p>
+ <list>
+ <item>
+ <p><gui>Color</gui></p>
+ <p>These controls are selects the default fill color.</p>
+ </item>
+ </list>
+ </section>
+ </section>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="customtemplate">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create your own templates for stationery products.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To create a custom template</title>
+
+ <p>To create a new custom template, choose
+ <guiseq><gui>File</gui>
+ <gui>Template Designer ...</gui></guiseq>
+ to display the <gui>Template Designer</gui> dialog.
+ This dialog will assist you in creating a custom template for
+ most types of label or card stationery that you may encounter.</p>
+
+ <p>If you prefer, you can create your templates manually.
+ For this option see <link xref="mancreate"/>
+ </p>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="editprop">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Change the properties of objects.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To edit object properties</title>
+
+ <section id="glabels-object-properties">
+
+ <p>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
+ <link xref="select" />.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/object-editor-sidebar.png" mime="image/png" style="right">
+ <p>Print Copy Controls</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>The object editor will contain a subset of the following
+ tabbed sections, depending on object type:</p>
+
+ <section id="object-editor-text">
+ <title>Text Tabbed Section (Text objects)</title>
+
+ <p>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.</p>
+
+ </section>
+
+ <section id="object-editor-image">
+ <title>Image Tabbed Section (Image objecs)</title>
+
+ <p>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.</p>
+
+ </section>
+
+ <section id="object-editor-data">
+ <title>Data Tabbed Section (Barcode objecs)</title>
+
+ <p>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.</p>
+
+ </section>
+
+ <section id="object-editor-style">
+ <title>Style Tabbed Section (Text objects)</title>
+
+ <p>This section contains controls to select text properties,
+ including font family, font size, font weight, color, and
+ text justification.</p>
+
+ </section>
+
+ <section id="object-editor-barcode">
+ <title>Style Tabbed Section (Barcode objecs)</title>
+
+ <p>This section contains controls to select barcode properties,
+ including barcode style, color, whether to print text, and whether
+ to include a checksum digit.</p>
+
+ </section>
+
+ <section id="object-editor-line">
+ <title>Line Tabbed Section</title>
+
+ <p>This section contains controls to select properties of lines
+ and outlines. These properties include line width and color.</p>
+
+ </section>
+
+ <section id="object-editor-fill">
+ <title>Fill Tabbed Section</title>
+
+ <p>This section contains controls to select fill properties of box
+ and ellipse objects. Currently the only fill property is fill
+ color.</p>
+
+ </section>
+
+ <section id="object-editor-size">
+ <title>Size Tabbed Section (All except line objects)</title>
+
+ <p>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).</p>
+
+ </section>
+
+ <section id="object-editor-size-line">
+ <title>Size Tabbed Section (Line objects)</title>
+
+ <p>This section contains controls to select the length and angle
+ of a line object.</p>
+
+ </section>
+
+ <section id="object-editor-position">
+ <title>Position Tabbed Section</title>
+
+ <p>This section contains controls to change the position of an
+ object.</p>
+
+ </section>
+
+
+ <section id="object-editor-shadow">
+ <title>Shadow Tabbed Section (All except image and barcode objects)</title>
+
+ <p>This section contains controls to add a shadow to an object.</p>
+
+ </section>
+
+
+ </section>
+
+<!-- ============= Other Manipulations of Objects ========= -->
+ <section id="glabels-object-manipulation">
+ <title>Other Manipulations of Objects</title>
+
+ <p>Objects can also be manipulated in the following ways.</p>
+
+ <section id="other-moving-resizing">
+ <title>Moving and Resizing Objects</title>
+
+ <p>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 <link xref="select" />.</p>
+
+ <p>A selected object can be resized by clicking one of its resize
+ handle and dragging it to obtain the new size.</p>
+
+ </section>
+
+ <section id="other-stacking-order">
+ <title>Changing Stacking Order</title>
+
+ <p>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 <guiseq> <gui>Objects</gui>
+ <gui>Order</gui>
+ <gui>Bring to Front</gui> </guiseq>
+ to raise the selection to the top of the stacking
+ order, or choose <guiseq> <gui>Objects</gui>
+ <gui>Order</gui>
+ <gui>Send to Back</gui> </guiseq>
+ 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.</p>
+
+ </section>
+
+ <section id="other-rotating-flipping">
+ <title>Rotating and Flipping Objects</title>
+
+ <p>Objects can be rotated 90 degrees in either direction, or flipped
+ horizontally or vertically, by choosing the appropriate menuitem
+ in the <guiseq> <gui>Objects</gui>
+ <gui>Rotate/Flip</gui> </guiseq> sub-menu. These
+ menuitems are also available by right-clicking
+ the display area when there is a non-empty selection.</p>
+
+ </section>
+
+ <section id="other-alignment">
+ <title>Aligning Objects</title>
+
+ <p>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 <guiseq>
+ <gui>Objects</gui>
+ <gui>Align Horizontal</gui>
+ </guiseq> or <guiseq> <gui>Objects</gui>
+ <gui>Align Horizontal</gui> </guiseq> sub-menus.
+ These menuitems are also available by right-clicking
+ the display area when there is a non-empty selection.</p>
+
+ </section>
+
+ <section id="other-property-bar">
+ <title>Using the Property Bar</title>
+
+ <p>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.
+ </p>
+
+ </section>
+
+
+
+ </section>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="index">
+
+ <info>
+ <title type="link">gLabels label and business card designer</title>
+ <title type="text">gLabels label and business card designer</title>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>
+ <media type="image" mime="image/png" src="figures/glabels-logo.png">gLabels logo</media>
+ gLabels label and business card designer
+ </title>
+
+ <section id="intro" style="2column">
+ <title>Introduction</title>
+ <p>
+ The <app>gLabels</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.
+ </p>
+ </section>
+
+ <section id="usage" style="2column">
+ <title>Usage</title>
+ </section>
+
+ <section id="merging" style="2column">
+ <title>Document Merging</title>
+ </section>
+
+ <section id="advanced" style="2column">
+ <title>Advanced usage</title>
+ </section>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="labelprop">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ How to change the properties of a label or business card.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To change label properties</title>
+
+ <p>To change the media type and/or orientation of a label, choose
+ <guiseq><gui>File</gui>
+ <gui>Properties</gui></guiseq> to display the
+ <gui>Label properties</gui> dialog. Select the
+ new media type and orientation for the document, then click
+ <gui>OK</gui>.</p>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ type="topic"
+ id="license">
+
+ <info>
+ <link type="seealso" xref="index"/>
+ <revision pkgversion="2.30" version="0.1" date="2009-12-28" status="draft"/>
+ <desc>Legal information.</desc>
+ </info>
+
+ <title>License</title>
+ <p>
+ <!--
+ Translators: try to use the same translation as the one provided by the CreativeCommons website.
+ If there is no translation for your language, consider providing one to CreativeCommons.
+ -->
+ This work is distributed under a CreativeCommons Attribution-Share Alike
+ 3.0 Unported license.
+ </p>
+ <p>
+ You are free:
+ </p>
+ <terms>
+ <item>
+ <title><em>To share</em></title>
+ <p>To copy, distribute and transmit the work.</p>
+ </item>
+ <item>
+ <title><em>To remix</em></title>
+ <p>To adapt the work.</p>
+ </item>
+ </terms>
+ <p>
+ Under the following conditions:
+ </p>
+ <terms>
+ <item>
+ <title><em>Attribution</em></title>
+ <p>
+ You must attribute the work in the manner specified by the author or
+ licensor (but not in any way that suggests that they endorse you or
+ your use of the work).
+ </p>
+ </item>
+ <item>
+ <title><em>Share Alike</em></title>
+ <p>
+ If you alter, transform, or build upon this work, you may distribute the
+ resulting work only under the same, similar or a compatible license.
+ </p>
+ </item>
+ </terms>
+ <p>
+ <!-- Translators: there are no official localized versions of the legal code, only the deed is localized. -->
+ For the full text of the license, see the
+ <link href="http://creativecommons.org/licenses/by-sa/3.0/legalcode">CreativeCommons website</link>,
+ or read the full <link href="http://creativecommons.org/licenses/by-sa/3.0/">Commons Deed</link>.
+ </p>
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="mancreate">
+
+ <info>
+ <link type="guide" xref="index#advanced"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create your templates manually.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Manually creating new templates</title>
+
+ <p>Predefined templates are defined by XML files located in
+ <file>${prefix}/share/glabels/</file>,
+ where <file>${prefix}</file> is usually something like
+ <file>/usr/local</file> or <file>/usr</file> depending
+ on the configuration option <file>prefix</file>. gLabels will
+ use all files of the form <file>*-templates.xml</file>
+ or <file>*.template</file>, that it finds in
+ <file>${prefix}/share/glabels/</file> and
+ <file>${HOME}/.glabels/</file>.
+ Additional templates can be added by creating additional
+ <file>*.template</file> files in either of these directories.
+ </p>
+
+ <p>The format for these files is defined in the DTD:
+ <link href="http://glabels.sourceforge.net/doc/glabels-2.0.dtd.txt">glabels-2.2.dtd</link>.
+ (This DTD also describes other XML formats used by glabels.)</p>
+
+ <section id="template-assumptions">
+ <title>Assumptions/caveats</title>
+ <list>
+ <item>
+ <p>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)</p>
+ </item>
+ <item>
+ <p>Distances can be expressed in units of <em>pt</em>,
+ <em>in</em>, <em>mm</em>,
+ <em>cm</em>, or <em>pc</em>. For example:
+ "<literal>1.0in</literal>" or "<literal>2.54cm</literal>". If no
+ units are specified, computer points (<em>pt</em>) will
+ be assumed (1 <em>pt</em> =
+ 1/72 <em>in</em> = 0.352778 <em>mm</em>).
+ </p>
+ </item>
+ </list>
+ </section>
+
+ <section id="template-file">
+ <title>Template Files</title>
+
+ <code>
+<?xml version="1.0"?>
+<Glabels-templates>
+
+ <replaceable>...templates...</replaceable>
+
+</Glabels-templates>
+ </code>
+ </section>
+
+
+ <section id="template-example">
+ <title>Example Template</title>
+ <code>
+ <Template brand="Avery" part="8160" size="US-Letter" description="Mailing Labels">
+ <Meta category="label"/>
+ <Meta category="mail"/>
+ <Meta product_url="http://www.avery.com/avery/en_us/"/>
+ <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>
+ </code>
+ </section>
+
+ <section id="template-template-node">
+ <title>Template Node</title>
+
+ <p>A <em>Template</em> node describes a single stationary
+ product. It must contain one instance of any type of Label node
+ (<em>Label-rectangle</em>,
+ <em>Label-round</em>, or <em>Label-cd</em>).
+ This node can be followed by zero or more
+ <em>Alias</em> nodes.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>brand</p></td> <td><p>Brand or manufacturer of stationary product. E.g. "Avery"</p></td>
+ </tr>
+ <tr>
+ <td><p>part</p></td> <td><p>Part number or name of stationary product. E.g. "8160"</p></td>
+ </tr>
+ <tr>
+ <td><p>size</p></td> <td><p>Size of sheet. E.g., "US-Letter," "A4", ...</p></td>
+ </tr>
+ <tr>
+ <td><p>description</p></td> <td><p>Description of stationary product. E.g, "Mailing Labels."</p></td>
+ </tr>
+ <tr>
+ <td><p>_description</p></td> <td><p>Translatable description of stationary product. E.g, "Mailing Labels." (Only useful for predefined templates)</p></td>
+ </tr>
+ <tr>
+ <td><p>width</p></td> <td><p>Page width. Only valid if size="Other"</p></td>
+ </tr>
+ <tr>
+ <td><p>height</p></td> <td><p>Page height. Only valid if size="Other"</p></td>
+ </tr>
+</table>
+
+</section>
+
+ <section id="template-template-node">
+ <title>Meta Node</title>
+
+ <p>A <em>Meta</em> node contains some additional properties of that product.
+ This node may appear more than once, with a subnode each.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Subnode</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>category</p></td> <td><p>The category which this product is assigned to. The value
+ of this category is used by the <app>gLabels'</app> template chooser to filter the
+ view to display only mailing labels, or labels in common and suppress any other products
+ which the user don't want to find. One product can be assigned to several categories.</p></td>
+ </tr>
+ <tr>
+ <td><p>product_url</p></td> <td><p>This address points to the vendor's website. Ideally,
+ the link shows the URL of that certain product, if available.</p></td>
+ </tr>
+</table>
+
+</section>
+
+ <section id="template-label-rectangle-node">
+ <title>Label-rectangle Node</title>
+
+ <p>A <em>Label-rectangle</em> node describes the
+ dimensions of a single label or business card that is rectangular
+ in shape (may have rounded edges).</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>id</p></td> <td><p>Reserved for future use. Should always be 0.</p></td>
+ </tr>
+ <tr>
+ <td><p>width</p></td> <td><p>Width of label/card</p></td>
+ </tr>
+ <tr>
+ <td><p>height</p></td> <td><p>Heigth of label/card</p></td>
+ </tr>
+ <tr>
+ <td><p>round</p></td> <td><p>Radius of corners. For items with square edges (business cards), the radius should be 0.</p></td>
+ </tr>
+ <tr>
+ <td><p>x_waste</p></td> <td><p>Amount of horizontal waste (over-print) to allow. This is useful
+ for minimizing alignment problems when using non-white
+ backgrounds (e.g. images).</p></td>
+ </tr>
+ <tr>
+ <td><p>y_waste</p></td> <td><p>Amount of vertical waste (over-print) to allow. This is useful
+ for minimizing alignment problems when using non-white
+ backgrounds (e.g. images).</p></td>
+ </tr>
+</table>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/glabels-template-label.png" mime="image/png" style="right">
+ <p>Label-rectangle parameters</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+ </section>
+
+ <section id="template-label-rectangle-node">
+ <title>Label-ellipse Node</title>
+
+ <p>A <em>Label-ellipse</em> node describes the
+ dimensions of a single label or business card that is elliptic
+ in shape.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>id</p></td> <td><p>Reserved for future use. Should always be 0.</p></td>
+ </tr>
+ <tr>
+ <td><p>width</p></td> <td><p>Width of the ellipse</p></td>
+ </tr>
+ <tr>
+ <td><p>height</p></td> <td><p>Heigth of the ellipse</p></td>
+ </tr>
+ <tr>
+ <td><p>waste</p></td> <td><p>Amount of waste (over-print) to allow. This is useful
+ for minimizing alignment problems when using non-white
+ backgrounds (e.g. images).</p></td>
+ </tr>
+</table>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/glabels-template-ellipse.png" mime="image/png" style="right">
+ <p>Label-ellipse parameters</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+ </section>
+
+ <section id="template-label-round-node">
+ <title>Label-round Node</title>
+
+ <p>A <em>Label-round</em> node describes the dimensions
+ of a simple round label (not a CD).</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>id</p></td> <td><p>Reserved for future use. Should always be 0.</p></td>
+ </tr>
+ <tr>
+ <td><p>radius</p></td> <td><p>Radius (1/2 diameter) of label</p></td>
+ </tr>
+ <tr>
+ <td><p>waste</p></td> <td><p>Amount of waste (over-print) to allow. This is useful
+ for minimizing alignment problems when using non-white
+ backgrounds (e.g. images).</p></td>
+ </tr>
+</table>
+ </section>
+
+ <section id="template-label-cd-node">
+ <title>Label-cd Node</title>
+
+ <p>A <em>Label-round</em> node describes the dimensions
+ of a CD, DVD, or business card CD.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>id</p></td> <td><p>Reserved for future use. Should always be 0.</p></td>
+ </tr>
+ <tr>
+ <td><p>radius</p></td> <td><p>Outer radius of label</p></td>
+ </tr>
+ <tr>
+ <td><p>hole</p></td> <td><p>Radius of concentric hole</p></td>
+ </tr>
+ <tr>
+ <td><p>width</p></td> <td><p>If present, the label is clipped to the given width.
+ (Useful for "business card CDs").</p></td>
+ </tr> <tr>
+ <td><p>heigth</p></td> <td><p>If present, the label is clipped to the given height.
+ (Useful for "business card CDs").</p></td>
+ </tr> <tr>
+ <td><p>waste</p></td> <td><p>Amount of waste (over-print) to allow. This is useful
+ for minimizing alignment problems when using non-white
+ backgrounds (e.g. images).</p></td>
+ </tr>
+</table>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/glabels-template-cd.png" mime="image/png" style="right">
+ <p>CD label parameters</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+ </section>
+
+ <section id="template-markup-margin-node">
+ <title>Markup-margin Node</title>
+
+ <p>A <em>Markup-margin</em> describes a margin along
+ all edges of a label.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>size</p></td> <td><p>Size of the margin. I.e. the distance of the margin
+ line from the edge of the card/label.</p></td>
+ </tr>
+</table>
+ </section>
+
+ <section id="template-markup-line-node">
+ <title>Markup-line Node</title>
+
+ <p>A <em>Markup-line</em> describes a markup line.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>x1</p></td> <td><p>x coordinate of 1st endpoint of the line segment.</p></td>
+ </tr>
+ <tr>
+ <td><p>y1</p></td> <td><p>y coordinate of 1st endpoint of the line segment.</p></td>
+ </tr>
+ <tr>
+ <td><p>x2</p></td> <td><p>x coordinate of 2st endpoint of the line segment.</p></td>
+ </tr>
+ <tr>
+ <td><p>y2</p></td> <td><p>y coordinate of 2st endpoint of the line segment.</p></td>
+ </tr>
+</table>
+ </section>
+
+ <section id="template-markup-circle-node">
+ <title>Markup-circle Node</title>
+
+ <p>A <em>Markup-circle</em> describes a markup circle.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>x0</p></td> <td><p>x coordinate of circle origin (center).</p></td>
+ </tr>
+ <tr>
+ <td><p>y0</p></td> <td><p>y coordinate of circle origin (center).</p></td>
+ </tr>
+ <tr>
+ <td><p>radius</p></td> <td><p>Radius of circle.</p></td>
+ </tr>
+</table>
+ </section>
+
+ <section id="template-markup-rect-node">
+ <title>Markup-rect Node</title>
+
+ <p>A <em>Markup-rect</em> describes a markup rectangle.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>x1</p></td> <td><p>x coordinate of upper left corner of rectangle.</p></td>
+ </tr>
+ <tr>
+ <td><p>y1</p></td> <td><p>y coordinate of upper left corner of rectangle.</p></td>
+ </tr>
+ <tr>
+ <td><p>w</p></td> <td><p>Width of rectangle.</p></td>
+ </tr>
+ <tr>
+ <td><p>h</p></td> <td><p>Height of rectangle.</p></td>
+ </tr>
+ <tr>
+ <td><p>r</p></td> <td><p>Radius of rounded corners of rectangle.</p></td>
+ </tr>
+</table>
+ </section>
+
+ <section id="template-layout-node">
+ <title>Layout Node</title>
+
+ <p>A label node may contain multiple <em>Layout</em>
+ 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
+ <em>layout</em> tags can be used. Note: a single label
+ can always be treated as a grid of one.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>nx</p></td> <td><p>Number of labels/cards across in the grid (horizontal)</p></td>
+ </tr>
+ <tr>
+ <td><p>ny</p></td> <td><p>Number of labels/cards across in the grid (vertical)</p></td>
+ </tr>
+ <tr>
+ <td><p>x0</p></td> <td><p>Distance from left edge of sheet to the left edge of
+ the left column of cards/labels in the layout.</p></td>
+ </tr>
+ <tr>
+ <td><p>y0</p></td> <td><p>Distance from the top edge of sheet to the top edge of
+ the top row of labels/cards in the layout.</p></td>
+ </tr>
+ <tr>
+ <td><p>dx</p></td> <td><p>Horizontal pitch of grid.</p></td>
+ </tr>
+ <tr>
+ <td><p>dy</p></td> <td><p>Vertical pitch of grid.</p></td>
+ </tr>
+</table>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/glabels-template-layout.png" mime="image/png" style="right">
+ <p>Layout Parameters</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+ </section>
+
+ <section id="template-alias-node">
+ <title>Alias Node</title>
+
+ <p>An <em>Alias</em> node provides the name of a
+ product with the same size and layout characteristics as the
+ parent template.</p>
+
+<table frame="all" rules="rows">
+ <tr>
+ <td><p>Property</p></td> <td><p>Description</p></td>
+ </tr>
+ <tr>
+ <td><p></p></td> <td><p></p></td>
+ </tr>
+ <tr>
+ <td><p>brand</p></td> <td><p>The brand or manufacturer of the equivalent product.</p></td>
+ </tr>
+ <tr>
+ <td><p>part</p></td> <td><p>The part number of the equivalent product.</p></td>
+ </tr>
+</table>
+
+ </section>
+
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="merge-ex1">
+
+ <info>
+ <link type="guide" xref="merge#merge-ex"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create name tags from a CSV file.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Example 1: Name Tags</title>
+
+ <p>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 <app>gnumeric</app> 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.</p>
+
+ <code>
+Name,Department,SN
+"Jim Kirk",Management,"SC937-0176 CEC"
+"Mr. Spock",Sciences,S179-276SP
+"Leonard McCoy",Medicine,unknown
+"Montgomery Scott",Engineering,SE-197-54T
+ </code>
+
+ <p>In <app>gLabels</app> we have created a new glabels
+ document using the Avery 5395 "Name Badge Labels" template. Next we use the
+ <guiseq> <gui>Objects</gui>
+ <gui>Merge Properties</gui> </guiseq> menu item to display
+ the <gui>merge properties</gui> dialog. We use this dialog to
+ select the source type (in our case CSV) and the merge source (filename) as
+ shown.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex1-1.png" mime="image/png" style="right">
+ <p>Merge properties dialog</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>Before applying the merge source, we uncheck the first record since it is only
+ column headers from our original <app>gnumeric</app> 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.</p>
+
+ <p>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 <gui>OK</gui> to accept the
+ changes.</p>
+
+ <p>Now we start adding objects to our glabels document as shown.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex1-2.png" mime="image/png" style="right">
+ <p>Adding objects</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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.</p>
+
+ <p>Now we can print our name tags by selecting the
+ <guiseq> <gui>File</gui>
+ <gui>Print</gui> </guiseq> menu item. This will display
+ print dialog as shown below.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex1-3.png" mime="image/png" style="right">
+ <p>Printing name tags</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>Just to make sure our labels are going to look okay, we select the
+ <gui>Print outlines</gui> option and click
+ <gui>Print Preview</gui>. This will display a print preview dialog
+ as shown below.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex1-4.png" mime="image/png" style="right">
+ <p>Name tags preview</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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.</p>
+
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="merge-ex2">
+
+ <info>
+ <link type="guide" xref="merge#merge-ex"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create address labels from a CSV file.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Example 2: Address labels</title>
+
+ <p>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 <app>gnumeric</app> and exported as the
+ following CSV file. It should be noted that not everyone has a middle initial or
+ a two line address.</p>
+
+ <code>
+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
+ </code>
+
+ <p>In <app>glabels</app> we have created a new glabels
+ document using the Avery 5512 "Address Labels" template. Next we use the
+ <guiseq> <gui>Objects</gui>
+ <gui>Merge Properties</gui> </guiseq> menu item to display
+ the <gui>merge properties</gui> dialog. We use this dialog to
+ select the source type (in our case CSV) and the merge source (filename) as
+ shown.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex2-1.png" mime="image/png" style="right">
+ <p>Merge properties dialog</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>Before applying the merge source, we uncheck the first record since it is only
+ column headers from our original <app>gnumeric</app> 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.</p>
+
+ <p>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 <gui>OK</gui> to accept the
+ changes.</p>
+
+ <p>Now we start adding objects to our glabels document as shown.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex2-2.png" mime="image/png" style="right">
+ <p>Adding objects</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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
+ <app>glabels</app> encounters a field as the only text on
+ a line, it will not expand the line if the field is empty.</p>
+
+ <p>Now we can print our address labels by selecting the
+ <guiseq> <gui>File</gui>
+ <gui>Print</gui> </guiseq> menu item. This will display
+ print dialog as shown below.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex2-3.png" mime="image/png" style="right">
+ <p>Printing address labels</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>Just to make sure our labels are going to look okay, we select the
+ <gui>Print outlines</gui> option and click
+ <gui>Print Preview</gui>. This will display a print preview dialog
+ as shown below.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex2-4.png" mime="image/png" style="right">
+ <p>Address labels preview</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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.</p>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="merge-ex3">
+
+ <info>
+ <link type="guide" xref="merge#merge-ex"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create address labels from the <app>Evolution</app> address book entries.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Example 3: Address Labels Using the <app>Evolution</app> Addressbook</title>
+
+ <p>Our last party was a great success, and now we need to print mailing
+ address labels for the invitations to a new one. To simplify this, we can use
+ the <app>Evolution</app> addressbook, because the address
+ data of all our friends is stored there.</p>
+
+ <note>
+ <p>Depending on how your copy of <app>gLabels</app> was packaged, this option could be unavailable.
+ Support for the <app>Evolution</app> addressbook will only be available
+ if the <app>evolution-data-server</app> and its development files
+ were present when <app>gLabels</app> was built. Please keep this in mind if you build <app>gLabels</app>
+ directly from source.</p>
+
+ <p>If the <app>gLabels</app> package from your distribution lacks this support,
+ you may wish to contact the package maintainer or file a bug against the package
+ to request it.</p>
+ </note>
+
+ <p>In <app>glabels</app> we have created a new <app>gLabels</app>
+ document using the Avery 5512 "Address Labels" template. Next we use the
+ <guiseq> <gui>Objects</gui>
+ <gui>Merge Properties</gui></guiseq> menu item to display
+ the <gui>Merge properties</gui> dialog. We use this dialog to
+ select the source type (in our case <gui>Data from default Evolution
+ addressbook</gui>) as shown.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex3-1.png" mime="image/png" style="right">
+ <p>Merge properties dialog</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>Once we have chosen <gui>Data from default Evolution addressbook
+ </gui> as our merge source, we will get a full list of its content. Initially,
+ all entries are checked. Assuming we were planning a really big party, we could
+ leave this selection untouched (but let's keep our budget in mind). We will now select or
+ unselect certain entries by clicking on the appropriate checkboxes, or we could use
+ the <gui>Select all</gui> and <gui>Unselect all
+ </gui> buttons to activate or deactivate all entries in the address book.</p>
+
+ <p>We can also view each entry 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 will click the <gui>OK</gui> button to
+ accept the changes.</p>
+
+ <p>Now we start adding objects to our glabels document as shown.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex3-2.png" mime="image/png" style="right">
+ <p>Adding objects</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>In this example we have a single text object again. This text object contains
+ all of our merge fields organized on multiple lines as a mailing address.</p>
+
+ <p>Now we can print our address labels by selecting the
+ <guiseq> <gui>File</gui>
+ <gui>Print</gui> </guiseq> menu item. This will display
+ the print dialog as shown below.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex2-3.png" mime="image/png" style="right">
+ <p>Printing address labels</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>Just to make sure our labels are going to look okay, we select the
+ <gui>Print outlines</gui> option and click
+ <gui>Print Preview</gui>. This will display a print preview dialog
+ as shown below.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/merge-ex3-4.png" mime="image/png" style="right">
+ <p>Addess labels preview</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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.</p>
+
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="merge-ex4">
+
+ <info>
+ <link type="guide" xref="merge#merge-ex"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create address labels from a vCard file.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Example 4: Address Labels Using a vCard file</title>
+
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="merge">
+
+ <info>
+ <link type="guide" xref="index#merging"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Merge a data source to create multiple documents.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Document merge tutorial</title>
+
+ <p>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 <app>glabels</app>. The following examples
+ will step through a couple of common tasks using the document merge
+ feature.</p>
+
+ <section id="merge-ex" style="2column">
+ </section>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="mergefeatures">
+
+ <info>
+ <link type="guide" xref="index#merging"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ What you may expect from a document merge.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Performing a document merge</title>
+
+ <p>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.</p>
+
+ <p>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.</p>
+
+ <p>A label must then be configured to "point at" this data file.
+ To configure the merge properties of a document, choose
+ <guiseq><gui>Objects</gui>
+ <gui>Merge Properties</gui></guiseq> menu item
+ to display the <gui>merge properties</gui> dialog. This
+ dialog is used to select the exact data file format and file
+ name (location) of the merge data.</p>
+
+ <p>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 <link xref="editprop" /> for more information
+ on using merge data for these object types.</p>
+
+ <p>Now that your label is configured, <app>gLabels</app> 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.</p>
+
+ <p>See <link xref="merge" /> for a detailed
+ tutorial on the document merge feature.</p>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="multifile">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ How to open multiple files at once by using the command line..
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To open multiple files from the command line</title>
+
+ <p>You can run <app>gLabels</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
+ <key>Return</key>:</p>
+
+ <p><cmd>glabels
+ <replaceable>file1.glabels file2.glabels file3.glabels</replaceable>
+ </cmd></p>
+
+ <p>When the application starts, the files that you specify are
+ displayed in separate <app>gLabels</app> windows.</p>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="newlabel">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ Create a new label or card in <app>gLabels</app>.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To create a new label or card</title>
+
+ <p>To create a new label or business card, choose
+ <guiseq><gui>File</gui><gui>New</gui></guiseq>
+ to display the <gui>New Label or Card</gui> dialog. Select
+ the media type and orientation for the new document,
+ then click <gui>OK</gui>. A new document is
+ displayed in the display area of the <app>gLabels</app>
+ window. </p>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="printfile">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ How to print your labels and cards.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To print labels and cards</title>
+
+ <p>To print labels or cards, choose
+ <guiseq><gui>File</gui><gui>Print</gui>
+ </guiseq> to display the <gui>Print</gui> dialog.
+ Once print options have been selected, click <gui>Print</gui>
+ to print the labels or cards. To simply preview the results,
+ click <gui>Print Preview</gui> instead.</p>
+
+ <p>The <gui>Print</gui> dialog allows you to specify the
+ following print options:</p>
+
+ <section>
+ <title>The Labels Tab of the Print Dialog</title>
+
+ <section>
+ <title>Print control (Simple)</title>
+
+ <p>For simple labels or cards (no document merge), the job
+ tabbed section contains the following copy controls.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/print-copies.png" mime="image/png" style="right">
+ <p>Print Copy Controls</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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.</p>
+
+ <p>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.</p>
+
+ </section>
+
+ <section>
+ <title>Print control (Merge)</title>
+
+ <p>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.</p>
+
+ <!-- ==== Figure ==== -->
+ <media type="image" src="figures/print-merge.png" mime="image/png" style="right">
+ <p>Print Document Merge Controls</p>
+ </media>
+ <!-- ==== End of Figure ==== -->
+
+ <p>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).</p>
+
+ <p>Printing can begin on any label on the first sheet.
+ This can be selected with the <gui>Start on
+ label</gui> spinbutton.</p>
+
+ <p>The mini-preview can also be used to graphically select
+ this first label, by clicking on the desired label in the
+ mini-preview.</p>
+
+ </section>
+
+ <section>
+ <title>Options</title>
+ <p>The following options can also be selected.</p>
+ <list>
+ <item>
+ <p><gui>print outlines</gui></p>
+ <p>Print outlines of labels. This option is useful for
+ dry-runs, to test printer alignment.</p>
+ </item>
+ <item>
+ <p><gui>print in reverse</gui></p>
+ <p>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).</p>
+ </item>
+ <item>
+ <p><gui>print crop marks</gui></p>
+ <p>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.</p>
+ </item>
+ </list>
+ </section>
+ </section>
+
+</page>
--- /dev/null
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:e="http://projectmallard.org/experimental/"
+ type="guide"
+ id="select">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-05-04" status="incomplete"/>
+ <desc>
+ How to select objects.
+ </desc>
+ <credit type="author">
+ <name>Jim Evins</name>
+ <email>evins@snaught.com</email>
+ </credit>
+ <credit type="author">
+ <name>Mario Blättermann</name>
+ <email>mariobl@gnome.org</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>To select objects</title>
+
+ <p>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
+ <guiseq><gui>Objects</gui>
+ <gui>Select Mode</gui></guiseq> menu item,
+ or the corresponding command on the <gui>Drawing
+ Toolbar</gui>.</p>
+
+ <section>
+ <title>Selecting a single object</title>
+ <p>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.</p>
+ </section>
+
+ <section>
+ <title>Aggregate object selections</title>
+ <p>Multiple objects can be selected by first selecting the first
+ object as above and then by holding the <key>Ctrl</key>
+ key while selecting additional objects.
+ Individual objects can be added to an existing selection
+ at any time by holding the <key>Ctrl</key> key while
+ selecting the desired objects. All objects can also be
+ selected by using the <guiseq><gui>Edit</gui>
+ <gui>Select All</gui></guiseq>
+ menu item. All objects in an aggregate object selection will be
+ highlighted.</p>
+ </section>
+
+ <section>
+ <title>Area selections</title>
+
+ <p>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 <key>Ctrl</key> key while
+ performing the selection.</p>
+
+ </section>
+
+ <section>
+ <title>Unselecting objects</title>
+
+ <p>Individual objects can be removed from an existing
+ selection by holding the <key>Ctrl</key> key while
+ clicking on a previously selected object. An entire selection
+ can be dismissed by using the <guiseq>
+ <gui>Edit</gui> <gui>Un-select All</gui>
+ </guiseq> menu item
+ or by simply clicking any empty space in the display area.
+ Once an object is unselected its highlight is removed.</p>
+
+ </section>
+
+ <section id="clipboard">
+ <title>Clipboard Commands</title>
+
+ <p>Object selections can be manipulated using the standard clipboard
+ operations <gui>Cut</gui>,
+ <gui>Copy</gui>, <gui>Paste</gui>,
+ and <gui>Delete</gui>.</p>
+
+ <section>
+ <title><gui>Cut</gui> (<keyseq><key>Ctrl</key><key>X</key></keyseq>)</title>
+
+ <p>Moves selected objects to the clipboard. The objects are
+ then available for pasting back into the current document or
+ another document.</p>
+
+ </section>
+
+ <section>
+ <title><gui>Copy</gui> (<keyseq><key>Ctrl</key><key>C</key></keyseq>)</title>
+
+ <p>Copies selected objects to the clipboard without deleting
+ them. The objects are then available for pasting back into
+ the current document or another document.</p>
+
+ </section>
+
+ <section>
+ <title><gui>Paste</gui> (<keyseq><key>Ctrl</key><key>V</key></keyseq>)</title>
+
+ <p>Pastes objects from the clipboard into the current document.
+ <app>gLabels</app> can only paste objects from
+ another <app>gLabels</app> document.</p>
+
+ </section>
+
+ <section>
+ <title><gui>Delete</gui> (<key>Del</key>)</title>
+
+ <p>Deletes selected objects without placing them on the
+ clipboard.</p>
+
+ </section>
+ </section>
+
+</page>
projects / glabels / commitdiff