GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PDF::FROMHTML (3)

.ds Aq ’

NAME

PDF::FromHTML - Convert HTML documents to PDF

CONTENTS

SYNOPSIS



    my $pdf = PDF::FromHTML->new( encoding => utf-8 );

    # Loading from a file:
    $pdf->load_file(source.html);

    # Or from a scalar reference:
    # $pdf->load_file(\$input);

    # Perform the actual conversion:
    $pdf->convert(
        # With PDF::API2, font names such as traditional also works
        Font        => font.ttf,
        LineHeight  => 10,
        Landscape   => 1,
    );

    # Write to a file:
    $pdf->write_file(target.pdf);

    # Or to a scalar reference:
    # $pdf->write_file(\$output);



DESCRIPTION

This module transforms HTML into PDF, using an assortment of XML transformations implemented in PDF::FromHTML::Twig.

There is also a command-line utility, html2pdf.pl, that comes with this distribution.

PUBLIC METHODS

    convert(%params)

Convert the loaded file to PDF. Valid parameters are:



    PageWidth         640
    PageResolution    540
    FontBold          HelveticaBold
    FontOblique       HelveticaOblique
    FontBoldOblique   HelveticaBoldOblique
    LineHeight        12
    FontUnicode       Helvetica
    Font              (same as FontUnicode)
    PageSize          A4
    Landscape         0



HINTS & TIPS

    <img> tags

Add the height and width attributes if you are creating the source HTML, it keeps PDF::FromHTML from having to open and read the source image file to get the real size. Less file I/O means faster processing.

CAVEATS

Although <B>PDF::FromHTMLB> will work with both HTML and XHTML formats, it is not designed to utilise CSS.

This means any HTML using external or inline CSS for design and layout, including but not limited to: images, backgrounds, colours, fonts etc... will not be converted into the PDF.

To get an idea of the likely resulting PDF, you may wish to use an non-CSS capable browser for testing first.

There is currently no plan to adapt this module to utilise CSS. (Patches welcome, though!)

SEE ALSO

html2pdf.pl is a simple command-line interface to this module.

PDF::FromHTML::Twig, PDF::Template, XML::Twig.

CONTRIBUTORS

Charleston Software Associates <info@charletonsw.com>

AUTHORS

XX <cpan@audreyt.org>

CC0 1.0 Universal

To the extent possible under law, XX has waived all copyright and related or neighboring rights to PDF-FromHTML.

This work is published from Taiwan.

<http://creativecommons.org/publicdomain/zero/1.0>

POD ERRORS

Hey! <B>The above document had some coding errors, which are explained below:B>
Around line 251: Non-ASCII character seen before =encoding in ’XX’. Assuming UTF-8
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PDF::FROMHTML (3) 2010-01-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.