README.txt

Path: README.txt
Last Update: Mon Sep 08 12:47:28 -0700 2008
dot/f_0.png

PdfLabels

DESCRIPTION:

Welcome to the PDF-Labels project. Our aim is to make creating labels programmatically easy in Ruby. This Library builds on top of "PDF::Writer":ruby-pdf.rubyforge.org/ and uses the templates from "gLabels":glabels.sourceforge.org. What this means is easy, clean Ruby code to create many common label types without measuring the labels yourself! All of this in pure Ruby (we use the XML templates from gLabels, we do NOT have a dependancy on gLabels, nor on Gnome)

FEATURES/PROBLEMS:

  • Works with all gLabels supported templates for rectangular labels
  • Does not yet work for CD labels (circles)

SYNOPSIS:

    p = PDFLabelPage.new("Avery  8160") # label is 2 x 10
    #Some examples of adding labels
    p.add_label() # should add to col 1, row 1
    p.add_label(:position => 1) # should add col 1, row 2
    p.add_label(:text => "Positoin 15", :position => 15) # should add col 2, row 1
    p.add_label(:text => 'No Margin', :position => 5, :use_margin => false) #this doesn't use a margin
    p.add_label(:position => 9, :text => "X Offset = 4, Y Offset = -6", :offset_x => 4, :offset_y => -6)
    p.add_label(:text => "Centered", :position => 26, :justification => :center) # should add col 2, row 15
    p.add_label(:text => "[Right justified]", :justification => :right, :position => 28)# col 2, row 14, right justified.
    p.add_label(:position => 29) # should add col 2, row 15
    p.add_label(:position => 8, :text => "This was added last and has a BIG font", :font_size => 18)

    #If you want to see the boxes around each label (good for printing alignment samples)
    p.draw_boxes(false, true)

    #Save your PDF when your done
    p.save_as("../label_output.pdf")

REQUIREMENTS:

Currently there are no external dependencies, though a version of xml-mapping and pdf-writer (and its dependencies) are provided in vendor

INSTALL:

sudo gem install pdf-labels

LICENSE:

(The MIT License)

Copyright (c) 2007 Rob Kaufman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[Validate]