Defining new gLabels templates for gLabels 2.0.x

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.

Assumptions/caveats

*-templates.xml and *.template files

<?xml version="1.0"?> <Glabels-templates> ...templates... </Glabels-templates>

Example Template

<Template name="Avery 8160" size="US-Letter" description="Mailing Labels"> <Label-rectangle id="0" width="189" height="72" round="5"> <Markup-margin size="5"/> <Layout nx="3" ny="10" x0="11.25" y0="36" dx="200" dy="72"/> </Label-rectangle> <Alias name="Avery 5160"/> <Alias name="Avery 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.

Properties

name Name or part # of stationary product. E.g. "Avery 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).

Properties

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 illustration

Label-round Node

A Label-round node describes the dimensions of a simple round label (not a CD).

Properties

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.

Properties

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 illustration

Markup-margin Node

A Markup-margin describes a margin along all edges of a label.

Properties

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.

Properties

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.

Properties

x0 x coordinate of circle origin (center).
y0 y coordinate of circle origin (center).
radius Radius of circle.

Layout Node

A label node may contain multiple Layout children. If labels are layed out in a simple grid pattern, only one layout is needed. However, if labels are layed out 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.

Properties

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 illustration

Alias Node

Properties

name The name or part # of a product with the same size and layout characteristics.