diff --git a/docs/PRODUCT-TEMPLATES.md b/docs/PRODUCT-TEMPLATES.md index b56fe07..fadf9d0 100644 --- a/docs/PRODUCT-TEMPLATES.md +++ b/docs/PRODUCT-TEMPLATES.md @@ -114,460 +114,152 @@ Property | Description ![Label-rectangle properties](images/glabels-template-rect-label.png) - - - -
- *Label-ellipse* Node +*Label-ellipse* Node +-------------------- -

A *Label-ellipse* node describes the - dimensions of a single label or business card that is elliptic - in shape.

+A *Label-ellipse* node describes the dimensions of a single label or business card that is elliptical +in shape. - - - - - - - - - - - - - - - - - - - - - - - -

Property

Description

*id*

Reserved for future use. Should always be 0.

*width*

Width of the ellipse

*height*

Height of the ellipse

*waste*

Amount of waste (over-print) to allow. This is useful - for minimizing alignment problems when using non-white - backgrounds (e.g. images).

+Property | Description +--------------|------------ +*id* | Reserved for future use. Should always be 0. +*width* | Width of label or card. E.g. `width="29mm"` +*height* | Height of label or card. E.g. `height="100mm"` +*waste* | Amount of waste (over-print) to allow. This is useful for minimizing alignment problems when using non-white backgrounds (e.g. images). - -
- Label-ellipse parameters - -

*Label-ellipse* parameters

-
-
- - -
- - - +![Label-ellipse properties](images/glabels-template-ellipse-label.png) - - - -
- *Label-round* Node +*Label-round* Node +------------------ -

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

+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).

+Property | Description +--------------|------------ +*id* | Reserved for future use. Should always be 0. +*radius* | Radius (1/2 diameter) of label or card. E.g. `radius="14.5mm"` +*waste* | Amount of waste (over-print) to allow. This is useful for minimizing alignment problems when using non-white backgrounds (e.g. images). - -
- *Label-ellipse* parameters - -

*Label-ellipse* parameters

-
-
- - -
- - - +![Label-round properties](images/glabels-template-round-label.png) - - - -
- *Label-cd* Node +*Label-cd* Node +--------------- -

A *Label-cd* node describes the dimensions - of a CD, DVD, or business card CD.

+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).

+Property | Description +--------------|------------ +*id* | Reserved for future use. Should always be 0. +*radius* | Outer radius (1/2 diameter) of label. E.g. `radius="58.5mm"` +*hole* | Radius (1/2 diameter) of concentric hole. E.g. `hole="18mm"` +*width* | If present, the label is clipped to the given Width. (For use with business card CDs.) +*height* | If present, the label is clipped to the given height. (For use with 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). - -
- *Label-cd* parameters - -

CD label parameters

-
-
- - -
- - - +![Label-cd properties](images/glabels-template-cd-label.png) - - - -
- *Markup* Nodes +*Markup* Nodes +-------------- -

Templates may contain optional markup nodes. These nodes are used to describe - a simple set of markup lines that are visible in the glabels drawing canvas, but - not visible when printed. These lines can represent margins, fold lines, center lines, - special areas, or other helpful hints to the user of a template.

+Templates may contain optional markup nodes. These nodes are used to describe +a simple set of markup lines that are visible in the *glabels* drawing canvas, but +not visible when printed. These lines can represent margins, fold lines, center lines, +special areas, or other helpful hints to the user of a template. - - - -
- *Markup-margin* Node +### *Markup-margin* Node -

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

+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.

-
- - - +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 +### *Markup-line* Node -

A *Markup-line* node describes a markup line.

+A *Markup-line* node 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.

-
- - - +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 +### *Markup-circle* Node -

A *Markup-circle* describes a markup circle.

+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.

-
- - - +Property | Description +--------------|------------ +*x0* | X coordinate of circle origin (center). +*y0* | Y coordinate of circle origin (center). +*radius* | Radius of circle. - - - -
- *Markup-rect* Node +### *Markup-rect* Node -

A *Markup-rect* describes a markup rectangle.

+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.

-
- - - +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. - - - -
- *Markup-ellipse* Node +### *Markup-ellipse* Node -

A *Markup-ellipse* describes a markup ellipse.

+A *Markup-ellipse* describes a markup ellipse. - - - - - - - - - - - - - - - - - - - - - - - -

Property

Description

*x1*

x coordinate of upper left corner of ellipse.

*y1*

y coordinate of upper left corner of ellipse.

*w*

Width of ellipse.

*h*

Height of ellipse.

-
- - - - -
- - - +Property | Description +--------------|------------ +*x1* | X coordinate of upper left corner of ellipse bounding box. +*y1* | Y coordinate of upper left corner of ellipse bounding box. +*w* | Width of ellipse. +*h* | Height of ellipse. - - - -
- *Layout* Node +*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.

-

A common example for multiple layouts is a sheet with three - CD labels:

- - -
- CD label sheet - -

CD label sheet

-
-
- - -

The two labels on the left edge can be assigned to a grid, assuming we - can define the coordinates for the top left label and the distance to - the second label properly. The distance to the left edge is common to - these labels. The third one on the right edge has no common distance - values with the other ones, that's why we have to define a second layout, - with unique coordinates for the top left corner of that label.

- - -

You can define multiple layouts only if the labels on the sheet - have the same shape. If your sheet contains different shapes, you have - to define each shape in another template separately. Future versions - of gLabels will probably be able to concatenate such sheets - with different shapes within a single template.

-
- - -

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 across 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 - -

Layout Parameters

-
-
- - -
- - - - - - +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. +A common example for multiple layouts is a sheet with three CD labels: +![CD Label layout example](images/layouts-cdlabel.png) +The two labels on the left edge can be assigned to a grid, assuming we +can define the coordinates for the top left label and the distance to +the second label properly. The distance to the left edge is common to +these labels. The third one on the right edge has no common distance +values with the other ones, that's why we have to define a second layout, +with unique coordinates for the top left corner of that label. +> You can define multiple layouts only if the labels on the sheet +> have the same shape. If your sheet contains different shapes, you have +> to define each shape in another template separately. Future versions +> of gLabels will probably be able to concatenate such sheets +> with different shapes within a single template.

+> A single label can always be treated as a grid of one. +Property | Description +--------------|------------ +*nx* | Number of labels/cards in the grid in the X direction (horizontal). +*ny* | Number of labels/cards in the grid in the Y direction (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 example](images/glabels-template-layout.png) diff --git a/docs/images/glabels-template-cd-label.png b/docs/images/glabels-template-cd-label.png new file mode 100644 index 0000000..2c50586 Binary files /dev/null and b/docs/images/glabels-template-cd-label.png differ diff --git a/docs/images/glabels-template-circle-label.png b/docs/images/glabels-template-circle-label.png new file mode 100644 index 0000000..337caae Binary files /dev/null and b/docs/images/glabels-template-circle-label.png differ diff --git a/docs/images/glabels-template-ellipse-label.png b/docs/images/glabels-template-ellipse-label.png new file mode 100644 index 0000000..b3b3013 Binary files /dev/null and b/docs/images/glabels-template-ellipse-label.png differ diff --git a/docs/images/glabels-template-layout.png b/docs/images/glabels-template-layout.png new file mode 100644 index 0000000..17db6bc Binary files /dev/null and b/docs/images/glabels-template-layout.png differ diff --git a/docs/images/layouts-cdlabel.png b/docs/images/layouts-cdlabel.png new file mode 100644 index 0000000..a28ab60 Binary files /dev/null and b/docs/images/layouts-cdlabel.png differ