/ 
PDF-Boxer-0.001
River stage one • 1 direct dependent • 1 total dependent
/ PDF::Boxer

NAME

PDF::Boxer - Create PDFs from a simple box markup language.

VERSION

version 0.001

SYNOPSIS

$pdfml = <<'__EOP__';
<column max_width="595" max_height="842">
  <column border_color="blue" border="2">
    <row>
      <image src="t/lecstor.gif" align="center" valign="center" padding="10" scale="60" />
      <column grow="1" padding="10 10 10 0">
        <text padding="3" align="right" size="20">
          Lecstor Pty Ltd
        </text>
        <text padding="3" align="right" size="14">
          123 Example St, Somewhere, Qld 4879
        </text>
      </column>
    </row>
    <row padding="15 0">
      <text padding="20" size="14">
        Mr G Client
        Shop 2 Some Centre, Retail Rd
        Somewhere, NSW 2000
      </text>
      <column padding="20" border_color="red" grow="1">
        <text size="16" align="right" font="Helvetica-Bold">
          Tax Invoice No. 123
        </text>
        <text size="14" align="right">
          Issued 01/01/2011
        </text>
        <text size="14" align="right" font="Helvetica-Bold">
          Due 14/01/2011
        </text>
      </column>
    </row>
  </column>
  <grid padding="10">
    <row font="Helvetica-Bold" padding="0">
      <text align="center" padding="0 10">Name</text>
      <text grow="1" align="center" padding="0 10">Description</text>
      <text padding="0 10" align="center">GST Amount</text>
      <text padding="0 10" align="center">Payable Amount</text>
    </row>
    <row margin="10 0 0 0">
      <text padding="0 5">Web Services</text>
      <text name="ItemText2" grow="1" padding="0 5">
        a long description which needs to be wrapped to fit in the box
      </text>
      <text padding="0 5" align="right">$9999.99</text>
      <text padding="0 5" align="right">$99999.99</text>
    </row>
  </grid>
</column>
__EOP__

$parser = PDF::Boxer::SpecParser->new;
$spec = $parser->parse($pdfml);

$boxer = PDF::Boxer->new( doc => { file => 'test_invoice.pdf' } );

$boxer->add_to_pdf($spec);
$boxer->finish;

DESCRIPTION

Use my version of a "box model" layout to create PDFs. Use PDF::Boxer::SpecParser to parse a template written in the not so patented PDFML. Suggestion: Use Template to dynamically create your PDFML template.

METHODS

add_to_pdf

$boxer->add_to_pdf($spec);

Coverts markup to PDF.

finish

Writes the generated PDF to the file specified in the call to new.

NAME

PDF::Boxer

MARKUP

There should always be a single parent element which would commonly be a column allowing other elements to be stacked vertically on the page.

column

a column stacks elements vertically. Each element will be as wide as the column's content space. If one or more children have the "grow" attribute set then they will be stretched vertically to fill the column.

row

a row places it's children horizontally. If one or more children have the "grow" attribute set then they will be stretched horizontally to fill the row.

grid

a grid is a column with rows for children. The width of the rows' child elements are locked vertically (like an html table).

text

the text element contains.. text! Text is wrapped to fith the width of it's container if necessary.

image

the image element places an image in the PDF.. whoda thunkit, eh? the image can be scaled to a percentage of it's original size.

SEE ALSO

AUTHOR

Jason Galea <lecstor@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Jason Galea.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 175:

'=item' outside of any '=over'

Around line 202:

You forgot a '=back' before '=head1'