Provided by: libpdf-builder-perl_3.023-2_all 
NAME
PDF::Builder::Docs - additional documentation for Builder module
SOME SPECIAL NOTES
Software Development Kit
There are four levels of involvement with PDF::Builder. Depending on what you want to do,
different kinds of installs are recommended.
1. Simply installing PDF::Builder as a prerequisite for running some other package. All
you need to do is install the CPAN package for PDF::Builder, and it will load the .pm
files into your Perl library. If the other package prereqs PDF::Builder, its installer may
download and install PDF::Builder automatically.
2. You want to write a Perl program that uses PDF::Builder functions. In addition to
installing PDF::Builder from CPAN, you will want documentation on it. Obtain a copy of the
product from GitHub (https://github.com/PhilterPaper/Perl-PDF-Builder) or as a gzipped tar
file from CPAN. This includes a utility to build (from POD) a library of HTML documents,
as well as examples (examples/ directory) and contributed sample programs (contrib/
directory).
3. You want to modify PDF::Builder files. In addition to the CPAN and GitHub
distributions, you may choose to keep a local Git repository for tracking your changes.
Depending on whether or not your PDF::Builder copy is being used for production purposes,
you may want to do your editing and testing in the Perl library installation (live) or in
a different place. The "t" tests (t/ directory) and examples provide good regression tests
to ensure that you haven't broken anything. If you do your editing on the live code, don't
forget when done to copy the changes back into the master version you keep!
4. You want to contribute to the development of PDF::Builder. You will need a local Git
repository (and a GitHub account), so that when you've got it all done, you can issue a
"Pull Request" to bring it to our attention. We can't guarantee that your work will be
incorporated into the project, but at least we will look at it. From time to time, a new
CPAN version will be issued.
If you want to make substantial changes for public use, and can't come to a meeting of
minds with us, you can even start your own GitHub project and register a new CPAN project
(that's what we did, forking PDF::API2). Please don't just assume that we don't want your
changes -- at least propose what you want to do in writing, so we can consider it. We're
always looking for people to help out and expand PDF::Builder.
Optional Libraries
PDF::Builder can make use of some optional libraries, which are not required for a
successful installation. If you want improved speed and capabilities for certain
functions, you may want to install and use these libraries:
* Graphics::TIFF -- PDF::Builder inherited a rather slow, buggy, and limited TIFF image
library from PDF::API2. If Graphics::TIFF (available on CPAN, uses libtiff.a) is
installed, PDF::Builder will use that instead, unless you specify that it is to use the
old, pure Perl library. The only time you might want to consider this is when you need to
pass an open filehandle to "image_tiff" instead of a file name. See resolved bug reports
RT 84665 and RT 118047, as well as "image_tiff", for more information.
* Image::PNG::Libpng -- PDF::Builder inherited a rather slow and buggy pure Perl PNG image
library from PDF::API2. If Image::PNG::Libpng (available on CPAN, uses libpng.a) is
installed, PDF::Builder will use that instead, unless you specify that it is to use the
old, pure Perl library. Using the new library will give you improved speed, the ability to
use 16 bit samples, and the ability to read interlaced PNG files. See resolved bug report
RT 124349, as well as "image_png", for more information.
* HarfBuzz::Shaper -- This library enables PDF::Builder to handle complex scripts (Arabic,
Devanagari, etc.) as well as non-LTR writing systems. It is also useful for Latin and
other simple scripts, for ligatures and improved kerning. HarfBuzz::Shaper is based on a
set of HarfBuzz libraries, which it will attempt to build if they are not found. See
"textHS" for more information.
Note that the installation process will attempt to install these libraries automatically.
If you don't wish to use one or more of them, you are free to uninstall the optional
librarie(s). If one or more failed to install, no need to panic -- you simply won't be
able to use some advanced features, unless you are able to manually install the modules
(e.g., with "cpan install").
Strings (Character Text)
Perl, and hence PDF::Builder, use strings that support the full range of Unicode
characters. When importing strings into a Perl program, for example by reading text from a
file, you must be aware of what their character encoding is. Single-byte encodings
(default is 'latin1'), represented as bytes of value 0x00 through 0xFF (0..255), will
produce different results if you do something that depends on the encoding, such as
sorting, searching, or comparing any two non-ASCII characters. This also applies to any
characters (text) hard coded into the Perl program.
You can always decode the text from external encoding (ASCII, UTF-8, Latin-3, etc.) into
the Perl (internal) UTF-8 multibyte encoding. This uses one to four bytes to represent
each character. See pragma "utf8" and module "Encode" for details about decoding text.
Note that only TrueType fonts ("ttfont") can make direct use of UTF-8-encoded text. Other
font types (core, T1, etc.) can only use single-byte encoded text. If your text is ASCII,
Latin-1, or CP-1252, you can just leave the Perl strings as the default single-byte
encoding.
Then, there is the matter of encoding the output to match up with available font character
sets. You're not actually translating the text on output, but are telling the output
system (and Reader) what encoding the output byte stream represents, and what character
glyphs they should generate.
If you confine your text to plain ASCII (0x00 .. 0x7F byte values) or even Latin-1 or
CP-1252 (0x00 .. 0xFF byte values), you can use default (non-UTF-8) Perl strings and use
the default output encoding (WinAnsiEncoding), which is more-or-less Windows CP-1252 (a
superset in turn, of ISO-8859-1 Latin-1). If your text uses any other characters, you will
need to be aware of what encoding your text strings are (in the Perl string and for
declaring output glyph generation). See "Core Fonts", "PS Fonts" and "TrueType Fonts" in
"FONT METHODS" for additional information.
Some Internal Details
Some of the following may be a bit scary or confusing to beginners, so don't be afraid to
skip over it until you're ready for it...
Perl (and PDF::Builder) internally use strings which are either single-byte
(ISO-8859-1/Latin-1) or multibyte UTF-8 encoded (there is an internal flag marking the
string as UTF-8 or not). If you work strictly in ASCII or Latin-1 or CP-1252 (each a
superset of the previous), you should be OK in not doing anything special about your
string encoding. You can just use the default Perl single byte strings (internally marked
as not UTF-8) and the default output encoding (WinAnsiEncoding).
If you intend to use input from a variety of sources, you should consider decoding
(converting) your text to UTF-8, which will provide an internally consistent
representation (and your Perl code itself should be saved in UTF-8, in case you want to
use any hard coded non-ASCII characters). In any string, non-ASCII characters (0x80 or
higher) would be converted to the Perl UTF-8 internal representation, via "$string =
Encode::decode(MY_ENCODING, $input);". "MY_ENCODING" would be a string like 'latin1',
'cp-1252', 'utf8', etc. Similar capabilities are available for declaring a file to be in a
certain encoding.
Be aware that if you use UTF-8 encoding for your text, that only TrueType font output
("ttfont") can handle it directly. Corefont and Type1 output will require that the text
will have to be converted back into a single-byte encoding (using "Encode::encode"), which
may need to be declared with "-encode" (for "corefont" or "psfont"). If you have any
characters not found in the selected single-byte encoding (but are found in the font
itself), you will need to use "automap" to break up the font glyphs into 256 character
planes, map such characters to 0x00 .. 0xFF in the appropriate plane, and switch between
font planes as necessary.
Core and Type1 fonts (output) use the byte values in the string (single-byte encoding
only!) and provide a byte-to-glyph mapping record for each plane. TrueType outputs a
group of four hexadecimal digits representing the "CId" (character ID) of each character.
The CId does not correspond to either the single-byte or UTF-8 internal representations of
the characters.
The bottom line is that you need to know what the internal representation of your text is,
so that the output routines can tell the PDF reader about it (via the PDF file). The text
will not be translated upon output, but the PDF reader needs to know what the encoding in
use is, so it knows what glyph to associate with each byte (or byte sequence).
Note that some operating systems and Perl flavors are reputed to be strict about encoding
names. For example, latin1 (an alias) may be rejected as invalid, while iso-8859-1 (a
canonical value) will work.
By the way, it is recommended that you be using at least Perl 5.10 if you are going to be
using any non-ASCII characters. Perl 5.8 may be a little unpredictable in handling such
text.
Rendering Order
For better or worse, for compatibility purposes, PDF::Builder continues the same rendering
model as used by PDF::API2 (and possibly its predecessors). That is, all graphics for one
graphics object are put into one record, and all text output for one text object goes into
another record. Which one is output first, is whichever is declared first. This can lead
to unexpected results, where items are rendered in (apparently) the wrong order. That is,
text and graphics items are not necessarily output (rendered) in the same order as they
were created in code. Two items in the same object (e.g., $text) will be rendered in the
same order as they were coded, but items from different objects may not be rendered in the
expected order. The following example (source code and annotated PDF excerpts) will
hopefully illustrate the issue:
use strict;
use warnings;
use PDF::Builder;
# demonstrate text and graphics object order
#
my $fname = "objorder";
my $paper_size = "Letter";
# see the text and graphics stream contents
my $pdf = PDF::Builder->new(-compress => 'none');
$pdf->mediabox($paper_size);
my $page = $pdf->page();
# adjust path for your operating system
my $fontTR = $pdf->ttfont('C:\\Windows\\Fonts\\timesbd.ttf');
For the first group, you might expect the "under" line to be output, then the filled
circle (disc) partly covering it, then the "over" line covering the disc, and finally a
filled rectangle (bar) over both lines. What actually happened is that the $grfx graphics
object was declared first, so everything in that object (the disc and bar) is output
first, and the text object $text (both lines) comes afterwards. The result is that the
text lines are on top of the graphics drawings.
# ----------------------------
# 1. text, orange ball over, text over, bar over
my $grfx1 = $page->gfx();
my $text1 = $page->text();
$text1->font($fontTR, 20); # 20 pt Times Roman bold
$text1->fillcolor('black');
$grfx1->strokecolor('blue');
$grfx1->fillcolor('orange');
$text1->translate(50,700);
$text1->text_left("This text should be under everything.");
$grfx1->circle(100,690, 30);
$grfx1->fillstroke();
$text1->translate(50,670);
$text1->text_left("This text should be over the ball and under the bar.");
$grfx1->rect(160,660, 20,70);
$grfx1->fillstroke();
% ---------------- group 1: define graphics object first, then text
11 0 obj << /Length 690 >> stream % obj 11 is graphics for (1)
0 0 1 RG % stroke blue
1 0.647059 0 rg % fill orange
130 690 m ... c h B % draw and fill circle
160 660 20 70 re B % draw and fill bar
endstream endobj
12 0 obj << /Length 438 >> stream % obj 12 is text for (1)
BT
/TiCBA 20 Tf % Times Roman Bold 20pt
0 0 0 rg % fill black
1 0 0 1 50 700 Tm % position text
<0037 ... 0011> Tj % "under" line
1 0 0 1 50 670 Tm % position text
<0037 ... 0011> Tj % "over" line
ET
endstream endobj
The second group is the same as the first, with the only difference being that the text
object was declared first, and then the graphics object. The result is that the two text
lines are rendered first, and then the disc and bar are drawn over them.
# ----------------------------
# 2. (1) again, with graphics and text order reversed
my $text2 = $page->text();
my $grfx2 = $page->gfx();
$text2->font($fontTR, 20); # 20 pt Times Roman bold
$text2->fillcolor('black');
$grfx2->strokecolor('blue');
$grfx2->fillcolor('orange');
$text2->translate(50,600);
$text2->text_left("This text should be under everything.");
$grfx2->circle(100,590, 30);
$grfx2->fillstroke();
$text2->translate(50,570);
$text2->text_left("This text should be over the ball and under the bar.");
$grfx2->rect(160,560, 20,70);
$grfx2->fillstroke();
% ---------------- group 2: define text object first, then graphics
13 0 obj << /Length 438 >> stream % obj 13 is text for (2)
BT
/TiCBA 20 Tf % Times Roman Bold 20pt
0 0 0 rg % fill black
1 0 0 1 50 600 Tm % position text
<0037 ... 0011> Tj % "under" line
1 0 0 1 50 570 Tm % position text
<0037 ... 0011> Tj % "over" line
ET
endstream endobj
14 0 obj << /Length 690 >> stream % obj 14 is graphics for (2)
0 0 1 RG % stroke blue
1 0.647059 0 rg % fill orange
130 590 m ... h B % draw and fill circle
160 560 20 70 re B % draw and fill bar
endstream endobj
The third group defines two text and two graphics objects, in the order that they are
expected in. The "under" text line is output first, then the orange disc graphics is
output, partly covering the text. The "over" text line is now output -- it's actually over
the disc, but is orange because the previous object stream (first graphics object) left
the fill color (also used for text) as orange, because we didn't explicitly set the fill
color before outputting the second text line. This is not "inheritance" so much as it is
whatever the graphics (drawing) state (used for both "graphics" and "text") is left in at
the end of one object, it's the state at the beginning of the next object. If you wish to
control this, consider surrounding the graphics or text calls with "save()" and
"restore()" calls to save and restore (push and pop) the graphics state to what it was at
the "save()". Finally, the bar is drawn over everything.
# ----------------------------
# 3. (2) again, with two graphics and two text objects
my $text3 = $page->text();
my $grfx3 = $page->gfx();
$text3->font($fontTR, 20); # 20 pt Times Roman bold
my $text4 = $page->text();
my $grfx4 = $page->gfx();
$text4->font($fontTR, 20); # 20 pt Times Roman bold
$text3->fillcolor('black');
$grfx3->strokecolor('blue');
$grfx3->fillcolor('orange');
# $text4->fillcolor('yellow');
# $grfx4->strokecolor('red');
# $grfx4->fillcolor('purple');
$text3->translate(50,500);
$text3->text_left("This text should be under everything.");
$grfx3->circle(100,490, 30);
$grfx3->fillstroke();
$text4->translate(50,470);
$text4->text_left("This text should be over the ball and under the bar.");
$grfx4->rect(160,460, 20,70);
$grfx4->fillstroke();
% ---------------- group 3: define text1, graphics1, text2, graphics2
15 0 obj << /Length 206 >> stream % obj 15 is text1 for (3)
BT
/TiCBA 20 Tf % Times Roman Bold 20pt
0 0 0 rg % fill black
1 0 0 1 50 500 Tm % position text
<0037 ... 0011> Tj % "under" line
ET
endstream endobj
16 0 obj << /Length 671 >> stream % obj 16 is graphics1 for (3) circle
0 0 1 RG % stroke blue
1 0.647059 0 rg % fill orange
130 490 m ... h B % draw and fill circle
endstream endobj
17 0 obj << /Length 257 >> stream % obj 17 is text2 for (3)
BT
/TiCBA 20 Tf % Times Roman Bold 20pt
1 0 0 1 50 470 Tm % position text
<0037 ... 0011> Tj % "over" line
ET
endstream endobj
18 0 obj << /Length 20 >> stream % obj 18 is graphics for (3) bar
160 460 20 70 re B % draw and fill bar
endstream endobj
The fourth group is the same as the third, except that we define the fill color for the
text in the second line. This makes it clear that the "over" line (in yellow) was written
after the orange disc, and still before the bar.
# ----------------------------
# 4. (3) again, a new set of colors for second group
my $text3 = $page->text();
my $grfx3 = $page->gfx();
$text3->font($fontTR, 20); # 20 pt Times Roman bold
my $text4 = $page->text();
my $grfx4 = $page->gfx();
$text4->font($fontTR, 20); # 20 pt Times Roman bold
$text3->fillcolor('black');
$grfx3->strokecolor('blue');
$grfx3->fillcolor('orange');
$text4->fillcolor('yellow');
$grfx4->strokecolor('red');
$grfx4->fillcolor('purple');
$text3->translate(50,400);
$text3->text_left("This text should be under everything.");
$grfx3->circle(100,390, 30);
$grfx3->fillstroke();
$text4->translate(50,370);
$text4->text_left("This text should be over the ball and under the bar.");
$grfx4->rect(160,360, 20,70);
$grfx4->fillstroke();
% ---------------- group 4: define text1, graphics1, text2, graphics2 with colors for 2
19 0 obj << /Length 206 >> stream % obj 19 is text1 for (4)
BT
/TiCBA 20 Tf % Times Roman Bold 20pt
0 0 0 rg % fill black
1 0 0 1 50 400 Tm % position text
<0037 ... 0011> Tj % "under" line
ET
endstream endobj
20 0 obj << /Length 671 >> stream % obj 20 is graphics1 for (4) circle
0 0 1 RG % stroke blue
1 0.647059 0 rg % fill orange
130 390 m ... h B % draw and fill circle
endstream endobj
21 0 obj << /Length 266 >> stream % obj 21 is text2 for (4)
BT
/TiCBA 20 Tf % Times Roman Bold 20pt
1 1 0 rg % fill yellow
1 0 0 1 50 370 Tm % position text
<0037 ... 0011> Tj % "over" line
ET
endstream endobj
22 0 obj << /Length 52 >> stream % obj 22 is graphics for (4) bar
1 0 0 RG % stroke red
0.498039 0 0.498039 rg % fill purple
160 360 20 70 re B % draw and fill rectangle (bar)
endstream endobj
# ----------------------------
$pdf->saveas("$fname.pdf");
The separation of text and graphics means that only some text methods are available in a
graphics object, and only some graphics methods are available in a text object. There is
much overlap, but they differ. There's really no reason the code couldn't have been
written (in PDF::API2, or earlier) as outputting to a single object, which would keep
everything in the same order as the method calls. An advantage would be less object and
stream overhead in the PDF file. The only drawback might be that an object might more
easily overflow and require splitting into multiple objects, but that should be rare.
You should always be able to manually split an object by simply ending output to the first
object, and picking up with output to the second object, so long as it was created
immediately after the first object. The graphics state at the end of the first object
should be the initial state at the beginning of the second object. However, use caution
when dealing with text objects -- the PDF specification states that the Text matrices are
not carried over from one object to the next (BT resets them), so you may need to reset
some settings.
$grfx1 = $page->gfx();
$grfx2 = $page->gfx();
# write a huge amount of stuff to $grfx1
# write a huge amount of stuff to $grfx2, picking up where $grfx1 left off
In any case, now that you understand the rendering order and how the order of object
declarations affects it, how text and graphics are drawn can now be completely controlled
as desired. There is really no need to add another "both" type object that will handle all
graphics and text objects, as that would probably be a major code bloat for very little
benefit. However, it could be considered in the future if there is a demonstrated need for
it, such as serious PDF file size bloat due to the extra object overhead when interleaving
text and graphics output.
PDF Versions Supported
When creating a PDF file using the functions in PDF::Builder, the output is marked as PDF
1.4. This does not mean that all PDF functionality up through 1.4 is supported! There are
almost surely features missing as far back as the PDF 1.0 standard.
The big problem is when a PDF of version 1.5 or higher is imported or opened in
PDF::Builder. If it contains content that is actually unsupported by this software, there
is a chance that something will break. This does not guarantee that a PDF marked as "1.7"
will go down in flames when read by PDF::Builder, or that a PDF written back out will
break in a Reader, but the possibility is there. Much PDF writer software simply marks its
output as the highest version of PDF at the time (usually 1.7), even if there is no
content beyond, say, 1.2. There is some handling of PDF 1.5 items in PDF::Builder, such
as cross reference streams, but support beyond 1.4 is very limited. All we can say is to
be careful when handling PDFs whose version is above 1.4, and test thoroughly, as they may
break at some point.
PDF::Builder includes a simple version control mechanism, where the initial PDF version to
be output (default 1.4) can be set by the programmer. Input PDFs greater than 1.4 (current
output level) will receive a warning (can be suppressed) that the output level will be
raised to that level. The use of PDF features greater than the current output level will
likewise trigger a warning that the output level is to be raised to the necessary level.
If this is not desired, you should avoid using those PDF features which are higher than
the desired PDF output level.
History
PDF::API2 was originally written by Alfred Reibenschuh, derived from Martin Hosken's
Text::PDF via the Text::PDF::API wrapper. In 2009, Otto Hirr started the PDF::API3 fork,
but it never went anywhere. In 2011, PDF::API2 maintenance was taken over by Steve Simms.
In 2017, PDF::Builder was forked by Phil M. Perry, who desired a more aggressive schedule
of new features and bug fixes than Simms was providing.
At Simms's request, the name of the new offering was changed from PDF::API4 to
PDF::Builder, to reduce the chance of confusion due to parallel development. Perry's
intent is to keep all internal methods as upwardly compatible with PDF::API2 as possible,
although it is likely that there will be some drift (incompatibilities) over time. At
least initially, any program written based on PDF::API2 should be convertible to
PDF::Builder simply by changing "API2" anywhere it occurs to "Builder". See the
INFO/KNOWN_INCOMP known incompatibilities file for further information.
Thanks...
Many users have helped out by reporting bugs and requesting enhancements. A special shout
out goes to those who have contributed code and tests, or coordinated their package
development with the needs of PDF::Builder: Ben Bullock, Cary Gravel, Gregor Herrmann,
Petr Pisar, Jeffrey Ratcliffe, Steve Simms (via PDF::API2 fixes), and Johan Vromans. Drop
me a line if I've overlooked your contribution!
DETAILED NOTES ON METHODS
After saving a file...
Note that a PDF object such as $pdf cannot continue to be used after saving an output PDF
file or string with $pdf->"save()", "saveas()", or "stringify()". There is some cleanup
and other operations done internally which make the object unusable for further
operations. You will likely receive an error message about can't call method new_obj on an
undefined value if you try to keep using a PDF object.
IntegrityCheck
The PDF::Builder methods that open an existing PDF file, pass it by the integrity checker
method, "$self->IntegrityCheck(level, content)". This method servers two purposes: 1) to
find any "/Version" settings that override the PDF version found in the PDF heading, and
2) perform some basic validations on the contents of the PDF.
The "level" parameter accepts the following values:
0 = Do not output any diagnostic messages; just return any version override.
1 = Output error-level (serious) diagnostic messages, as well as returning any version
override.
Errors include, in no place was the /Root object specified, or if it was, the
indicated object was not found. An object claims another object as its child (/Kids
list), but another object has already claimed that child. An object claims a child,
but that child does not list a Parent, or the child lists a different Parent.
2 = Output error- (serious) and warning- (less serious) level diagnostic messages, as well
as returning any version override. This is the default.
3 = Output error- (serious), warning- (less serious), and note- (informational) level
diagnostic messages, as well as returning any version override.
Notes include, in no place was the (optional) /Info object specified, or if it was,
the indicated object was not found. An object was referenced, but no entry for it was
found among the objects. (This may be OK if the object is not defined, or is on the
free list, as the reference will then be ignored.) An object is defined, but it
appears that no other object is referencing it.
4 = Output error-, warning-, and note-level diagnostic messages, as well as returning any
version override. Also dump the diagnostic data structure.
5 = Output error-, warning-, and note-level diagnostic messages, as well as returning any
version override. Also dump the diagnostic data structure and the $self data structure
(generally useful only if you have already read in the PDF file).
The version is a string (e.g., '1.5') if found, otherwise "undef" (undefined value) is
returned.
For controlling the "automatic" call to IntegrityCheck (via opens), the level may be given
with the option (flag) "-diaglevel => n", where "n" is between 0 and 5.
Preferences - set user display preferences
$pdf->preferences(%options)
Controls viewing preferences for the PDF.
Page Mode Options
-fullscreen
Full-screen mode, with no menu bar, window controls, or any other window visible.
-thumbs
Thumbnail images visible.
-outlines
Document outline visible.
Page Layout Options
-singlepage
Display one page at a time.
-onecolumn
Display the pages in one column.
-twocolumnleft
Display the pages in two columns, with oddnumbered pages on the left.
-twocolumnright
Display the pages in two columns, with oddnumbered pages on the right.
Viewer Options
-hidetoolbar
Specifying whether to hide tool bars.
-hidemenubar
Specifying whether to hide menu bars.
-hidewindowui
Specifying whether to hide user interface elements.
-fitwindow
Specifying whether to resize the document's window to the size of the displayed
page.
-centerwindow
Specifying whether to position the document's window in the center of the screen.
-displaytitle
Specifying whether the window's title bar should display the document title taken
from the Title entry of the document information dictionary.
-afterfullscreenthumbs
Thumbnail images visible after Full-screen mode.
-afterfullscreenoutlines
Document outline visible after Full-screen mode.
-printscalingnone
Set the default print setting for page scaling to none.
-simplex
Print single-sided by default.
-duplexflipshortedge
Print duplex by default and flip on the short edge of the sheet.
-duplexfliplongedge
Print duplex by default and flip on the long edge of the sheet.
Initial Page Options
-firstpage => [ $page, %options ]
Specifying the page (either a page number or a page object) to be displayed, plus one
of the following options:
-fit => 1
Display the page designated by page, with its contents magnified just enough to
fit the entire page within the window both horizontally and vertically. If the
required horizontal and vertical magnification factors are different, use the
smaller of the two, centering the page within the window in the other dimension.
-fith => $top
Display the page designated by page, with the vertical coordinate top positioned
at the top edge of the window and the contents of the page magnified just enough
to fit the entire width of the page within the window.
-fitv => $left
Display the page designated by page, with the horizontal coordinate left
positioned at the left edge of the window and the contents of the page magnified
just enough to fit the entire height of the page within the window.
-fitr => [ $left, $bottom, $right, $top ]
Display the page designated by page, with its contents magnified just enough to
fit the rectangle specified by the coordinates left, bottom, right, and top
entirely within the window both horizontally and vertically. If the required
horizontal and vertical magnification factors are different, use the smaller of
the two, centering the rectangle within the window in the other dimension.
-fitb => 1
Display the page designated by page, with its contents magnified just enough to
fit its bounding box entirely within the window both horizontally and vertically.
If the required horizontal and vertical magnification factors are different, use
the smaller of the two, centering the bounding box within the window in the other
dimension.
-fitbh => $top
Display the page designated by page, with the vertical coordinate top positioned
at the top edge of the window and the contents of the page magnified just enough
to fit the entire width of its bounding box within the window.
-fitbv => $left
Display the page designated by page, with the horizontal coordinate left
positioned at the left edge of the window and the contents of the page magnified
just enough to fit the entire height of its bounding box within the window.
-xyz => [ $left, $top, $zoom ]
Display the page designated by page, with the coordinates (left, top) positioned
at the top-left corner of the window and the contents of the page magnified by the
factor zoom. A zero (0) value for any of the parameters left, top, or zoom
specifies that the current value of that parameter is to be retained unchanged.
Example
$pdf->preferences(
-fullscreen => 1,
-onecolumn => 1,
-afterfullscreenoutlines => 1,
-firstpage => [$page, -fit => 1],
);
info Example
%h = $pdf->info(
'Author' => "Alfred Reibenschuh",
'CreationDate' => "D:20020911000000+01'00'",
'ModDate' => "D:YYYYMMDDhhmmssOHH'mm'",
'Creator' => "fredos-script.pl",
'Producer' => "PDF::Builder",
'Title' => "some Publication",
'Subject' => "perl ?",
'Keywords' => "all good things are pdf"
);
print "Author: $h{'Author'}\n";
XMP XML example
$xml = $pdf->xmpMetadata();
print "PDFs Metadata reads: $xml\n";
$xml=<<EOT;
<?xpacket begin='' id='W5M0MpCehiHzreSzNTczkc9d'?>
<?adobe-xap-filters esc="CRLF"?>
<x:xmpmeta
xmlns:x='adobe:ns:meta/'
x:xmptk='XMP toolkit 2.9.1-14, framework 1.6'>
<rdf:RDF
xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'
xmlns:iX='http://ns.adobe.com/iX/1.0/'>
<rdf:Description
rdf:about='uuid:b8659d3a-369e-11d9-b951-000393c97fd8'
xmlns:pdf='http://ns.adobe.com/pdf/1.3/'
pdf:Producer='Acrobat Distiller 6.0.1 for Macintosh'></rdf:Description>
<rdf:Description
rdf:about='uuid:b8659d3a-369e-11d9-b951-000393c97fd8'
xmlns:xap='http://ns.adobe.com/xap/1.0/'
xap:CreateDate='2004-11-14T08:41:16Z'
xap:ModifyDate='2004-11-14T16:38:50-08:00'
xap:CreatorTool='FrameMaker 7.0'
xap:MetadataDate='2004-11-14T16:38:50-08:00'></rdf:Description>
<rdf:Description
rdf:about='uuid:b8659d3a-369e-11d9-b951-000393c97fd8'
xmlns:xapMM='http://ns.adobe.com/xap/1.0/mm/'
xapMM:DocumentID='uuid:919b9378-369c-11d9-a2b5-000393c97fd8'/></rdf:Description>
<rdf:Description
rdf:about='uuid:b8659d3a-369e-11d9-b951-000393c97fd8'
xmlns:dc='http://purl.org/dc/elements/1.1/'
dc:format='application/pdf'>
<dc:description>
<rdf:Alt>
<rdf:li xml:lang='x-default'>Adobe Portable Document Format (PDF)</rdf:li>
</rdf:Alt>
</dc:description>
<dc:creator>
<rdf:Seq>
<rdf:li>Adobe Systems Incorporated</rdf:li>
</rdf:Seq>
</dc:creator>
<dc:title>
<rdf:Alt>
<rdf:li xml:lang='x-default'>PDF Reference, version 1.6</rdf:li>
</rdf:Alt>
</dc:title>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
<?xpacket end='w'?>
EOT
$xml = $pdf->xmpMetadata($xml);
print "PDF metadata now reads: $xml\n";
"BOX" METHODS
A general note: Use care if specifying a different Media Box (or other "box") for a page,
than the global "box" setting, to define the whole "chain" of boxes on the page, to avoid
surprises. For example, to define a global Media Box (paper size) and a global Crop Box,
and then define a new page-level Media Box without defining a new page-level Crop Box, may
give odd results in the resultant cropping. Such combinations are not well defined.
All dimensions in boxes default to the default User Unit, which is points (1/72 inch).
Note that the PDF specification limits sizes and coordinates to 14400 User Units (200
inches, for the default User Unit of one point), and Adobe products (so far) follow this
limit for Acrobat and Distiller. It is worth noting that other PDF writers and readers may
choose to ignore the 14400 unit limit, with or without the use of a specified User Unit.
Therefore, PDF::Builder does not enforce any limits on coordinates -- it's your
responsibility to consider what readers and other PDF tools may be used with a PDF you
produce! Also note that earlier Acrobat readers had coordinate limits as small as 3240
User Units (45 inches), and minimum media size of 72 or 3 User Units.
User Units
$pdf->userunit($number)
The default User Unit in the PDF coordinate system is one point (1/72 inch). You can
think of it as a scale factor to enable larger (or even, smaller) documents. This
method may be used (for PDF 1.6 and higher) to set the User Unit to some number of
points. For example, "userunit(72)" will set the scale multiplier to 72.0 points per
User Unit, or 1 inch to the User Unit. Any number greater than zero is acceptable,
although some readers and tools may not handle User Units of less than 1.0 very well.
Not all readers respect the User Unit, if you give one, or handle it in exactly the
same way. Adobe Distiller, for one, does not use it. How User Units are handled may
vary from reader to reader. Adobe Acrobat, at this writing, respects User Unit in
version 7.0 and up, but limits it to 75000 (giving a maximum document size of 15
million inches or 236.7 miles or 381 km). Other readers and PDF tools may allow a
larger (or smaller) limit.
Your Mileage May Vary: Some readers ignore a global User Unit setting and do not have
pages inherit it (PDF::Builder duplicates it on each page to simulate inheritance).
Some readers may give spurious warnings about truncated content when a Media Box is
changed while User Units are being used. Some readers do strange things with Crop
Boxes when a User Unit is in effect.
Depending on the reader used, the effect of a larger User Unit (greater than 1) may
mean lower resolution (chunkier or coarser appearance) in the rendered document. If
you're printing something the size of a highway billboard, this may not matter to you,
but you should be aware of the possibility (even with fractional coordinates).
Conversely, a User Unit of less than 1.0 (if permitted) reduces the allowable size of
your document, but may result in greater resolution.
A global (PDF level) User Unit setting is inherited by each page (an action by
PDF::Builder, not necessarily automatically done by the reader), or can be overridden
by calling userunit in the page. Do not give more than one global userunit setting, as
only the last one will be used. Setting a page's User Unit (if "$page->" instead) is
permitted (overriding the global setting for this page). However, many sources
recommend against doing this, as results may not be as expected (once again, depending
on the quirks of the reader).
Remember to call "userunit" before calling anything having to do with page or box
sizes, or coordinates. Especially when setting 'named' box sizes, the methods need to
know the current User Unit so that named page sizes (in points) may be scaled down to
the current User Unit.
Media Box
$pdf->mediabox($name)
$pdf->mediabox($name, -orient => 'orientation' )
$pdf->mediabox($w,$h)
$pdf->mediabox($llx,$lly, $urx,$ury)
($llx,$lly, $urx,$ury) = $pdf->mediabox()
Sets the global Media Box (or page's Media Box, if "$page->" instead). This defines
the width and height (or by corner coordinates, or by standard name) of the output
page itself, such as the physical paper size. This is normally the largest of the
"boxes". If any subsidiary box (within it) exceeds the media box, the portion of the
material or boxes outside of the Media Box will be ignored. That is, the Media Box is
the One Box to Rule Them All, and is the overall limit for other boxes (some
documentation refers to the Media Box as "clipping" other boxes). In addition, the
Media Box defines the overall coordinate system for text and graphics operations.
If no arguments are given, the current Media Box (global or page) coordinates are
returned instead. The former "get_mediabox" (page only) function is deprecated and
will likely be removed some time in the future. In addition, when setting the Media
Box, the resulting coordinates are returned. This permits you to specify the page size
by a name (alias) and get the dimensions back, all in one call.
Note that many printers can not print all the way to the physical edge of the paper,
so you should plan to leave some blank margin, even outside of any crop marks and
bleeds. Printers and on-screen readers are free to discard any content found outside
the Media Box, and printers may discard some material just inside the Media Box.
A global Media Box is required by the PDF spec; if not explicitly given, PDF::Builder
will set the global Media Box to US Letter size (8.5in x 11in). This is the media
size that will be used for all pages if you do not specify a "mediabox" call on a
page. That is, a global (PDF level) mediabox setting is inherited by each page, or can
be overridden by setting mediabox in the page. Do not give more than one global
mediabox setting, as only the last one will be used.
If you give a single string name (e.g., 'A4'), you may optionally add an orientation
to turn the page 90 degrees into Landscape mode: "-orient => 'L'" or "-orient => 'l'".
"-orient" is the only option recognized, and a string beginning with an 'L' or 'l'
(for Landscape) is the only value of interest (anything else is treated as Portrait
mode). The y axis still runs from 0 at the bottom of the page to what used to be the
page width (now, height) at the top, and likewise for the x axis: 0 at left to
(former) height at the right. That is, the coordinate system is the same as before,
except that the height and width are different.
The lower left corner does not have to be 0,0. It can be any values you want,
including negative values (so long as the resulting media's sides are at least one
point long). "mediabox" sets the coordinate system (including the origin) of the
graphics and text that will be drawn, as well as for subsequent "boxes". It's even
possible to give any two opposite corners (such as upper left and lower right). The
coordinate system will be rearranged (by the Reader) to still be the conventional
minimum "x" and "y" in the lower left (i.e., you can't make "y" increase from top to
bottom!).
Example:
$pdf = PDF::Builder->new();
$pdf->mediabox('A4'); # A4 size (595 Pt wide by 842 Pt high)
...
$pdf->saveas('our/new.pdf');
$pdf = PDF::Builder->new();
$pdf->mediabox(595, 842); # A4 size, with implicit 0,0 LL corner
...
$pdf->saveas('our/new.pdf');
$pdf = PDF::Builder->new;
$pdf->mediabox(0, 0, 595, 842); # A4 size, with explicit 0,0 LL corner
...
$pdf->saveas('our/new.pdf');
See the PDF::Builder::Resource::PaperSizes source code for the full list of supported
names (aliases) and their dimensions in points. You are free to add additional paper
sizes to this file, if you wish. You might want to do this if you frequently use a
standard page size in rotated (Landscape) mode. See also the "getPaperSizes" call in
PDF::Builder::Util. These names (aliases) are also usable in other "box" calls,
although useful only if the "box" is the same size as the full media (Media Box), and
you don't mind their starting at 0,0.
Crop Box
$pdf->cropbox($name)
$pdf->cropbox($name, -orient => 'orientation')
$pdf->cropbox($w,$h)
$pdf->cropbox($llx,$lly, $urx,$ury)
($llx,$lly, $urx,$ury) = $pdf->cropbox()
Sets the global Crop Box (or page's Crop Box, if "$page->" instead). This will define
the media size to which the output will later be clipped. Note that this does not
itself output any crop marks to guide cutting of the paper! PDF Readers should
consider this to be the visible portion of the page, and anything found outside it may
be clipped (invisible). By default, it is equal to the Media Box, but may be defined
to be smaller, in the coordinate system set by the Media Box. A global setting will be
inherited by each page, but can be overridden on a per-page basis.
A Reader or Printer may choose to discard any clipped (invisible) part of the page,
and show only the area within the Crop Box. For example, if your page Media Box is A4
(0,0 to 595,842 Points), and your Crop Box is (100,100 to 495,742), a reader such as
Adobe Acrobat Reader may show you a page 395 by 642 Points in size (i.e., just the
visible area of your page). Other Readers may show you the full media size (Media Box)
and a 100 Point wide blank area (in this example) around the visible content.
If no arguments are given, the current Crop Box (global or page) coordinates are
returned instead. The former "get_cropbox" (page only) function is deprecated and will
likely be removed some time in the future. If a Crop Box has not been defined, the
Media Box coordinates (which always exist) will be returned instead. In addition, when
setting the Crop Box, the resulting coordinates are returned. This permits you to
specify the crop box by a name (alias) and get the dimensions back, all in one call.
Do not confuse the Crop Box with the "Trim Box", which shows where printed paper is
expected to actually be cut. Some PDF Readers may reduce the visible "paper"
background to the size of the crop box; others may simply omit any content outside it.
Either way, you would lose any trim or crop marks, printer instructions, color
alignment dots, or other content outside the Crop Box. A good use of the Crop Box
would be limit printing to the area where a printer can reliably put down ink, and
leave white the edge areas where paper-handling mechanisms prevent ink or toner from
being applied. This would keep you from accidentally putting valuable content in an
area where a printer will refuse to print, yet permit you to include a bleed area and
space for printer's marks and instructions. Needless to say, if your printer cannot
print to the very edge of the paper, you will need to trim (cut) the printed sheets to
get true bleeds.
A global (PDF level) cropbox setting is inherited by each page, or can be overridden
by setting cropbox in the page. As with "mediabox", only one crop box may be set at
this (PDF) level. As with "mediabox", a named media size may have an orientation (l
or L) for Landscape mode. Note that the PDF level global Crop Box will be used even
if the page gets its own Media Box. That is, the page's Crop Box inherits the global
Crop Box, not the page Media Box, even if the page has its own media size! If you set
the page's own Media Box, you should consider also explicitly setting the page Crop
Box (and other boxes).
Bleed Box
$pdf->bleedbox($name)
$pdf->bleedbox($name, -orient => 'orientation')
$pdf->bleedbox($w,$h)
$pdf->bleedbox($llx,$lly, $urx,$ury)
($llx,$lly, $urx,$ury) = $pdf->bleedbox()
Sets the global Bleed Box (or page's Bleed Box, if "$page->" instead). This is
typically used in printing on paper, where you want ink or color (such as thumb tabs)
to be printed a bit beyond the final paper size, to ensure that the cut paper bleeds
(the cut goes through the ink), rather than accidentally leaving some white paper
visible outside. Allow enough "bleed" over the expected trim line to account for
minor variations in paper handling, folding, and cutting; to avoid showing white paper
at the edge. The Bleed Box is where printing could actually extend to; the Trim Box
is normally within it, where the paper would actually be cut. The default value is
equal to the Crop Box, but is often a bit smaller. The space between the Bleed Box and
the Crop Box is available for printer instructions, color alignment dots, etc., while
crop marks (trim guides) are at least partly within the bleed area (and should be
printed after content is printed).
If no arguments are given, the current Bleed Box (global or page) coordinates are
returned instead. The former "get_bleedbox" (page only) function is deprecated and
will likely be removed some time in the future. If a Bleed Box has not been defined,
the Crop Box coordinates (if defined) will be returned, otherwise the Media Box
coordinates (which always exist) will be returned. In addition, when setting the
Bleed Box, the resulting coordinates are returned. This permits you to specify the
bleed box by a name (alias) and get the dimensions back, all in one call.
A global (PDF level) bleedbox setting is inherited by each page, or can be overridden
by setting bleedbox in the page. As with "mediabox", only one bleed box may be set at
this (PDF) level. As with "mediabox", a named media size may have an orientation (l
or L) for Landscape mode. Note that the PDF level global Bleed Box will be used even
if the page gets its own Crop Box. That is, the page's Bleed Box inherits the global
Bleed Box, not the page Crop Box, even if the page has its own media size! If you set
the page's own Media Box or Crop Box, you should consider also explicitly setting the
page Bleed Box (and other boxes).
Trim Box
$pdf->trimbox($name)
$pdf->trimbox($name, -orient => 'orientation')
$pdf->trimbox($w,$h)
$pdf->trimbox($llx,$lly, $urx,$ury)
($llx,$lly, $urx,$ury) = $pdf->trimbox()
Sets the global Trim Box (or page's Trim Box, if "$page->" instead). This is supposed
to be the actual dimensions of the finished page (after trimming of the paper). In
some production environments, it is useful to have printer's instructions, cut marks,
and so on outside of the trim box. The default value is equal to Crop Box, but is
often a bit smaller than any Bleed Box, to allow the desired "bleed" effect.
If no arguments are given, the current Trim Box (global or page) coordinates are
returned instead. The former "get_trimbox" (page only) function is deprecated and will
likely be removed some time in the future. If a Trim Box has not been defined, the
Crop Box coordinates (if defined) will be returned, otherwise the Media Box
coordinates (which always exist) will be returned. In addition, when setting the Trim
Box, the resulting coordinates are returned. This permits you to specify the trim box
by a name (alias) and get the dimensions back, all in one call.
A global (PDF level) trimbox setting is inherited by each page, or can be overridden
by setting trimbox in the page. As with "mediabox", only one trim box may be set at
this (PDF) level. As with "mediabox", a named media size may have an orientation (l
or L) for Landscape mode. Note that the PDF level global Trim Box will be used even
if the page gets its own Crop Box. That is, the page's Trim Box inherits the global
Trim Box, not the page Crop Box, even if the page has its own media size! If you set
the page's own Media Box or Crop Box, you should consider also explicitly setting the
page Trim Box (and other boxes).
Art Box
$pdf->artbox($name)
$pdf->artbox($name, -orient => 'orientation')
$pdf->artbox($w,$h)
$pdf->artbox($llx,$lly, $urx,$ury)
($llx,$lly, $urx,$ury) = $pdf->artbox()
Sets the global Art Box (or page's Art Box, if "$page->" instead). This is supposed
to define "the extent of the page's meaningful content (including [margins])". It
might exclude some content, such as Headlines or headings. Any binding or punched-
holes margin would typically be outside of the Art Box, as would be page numbers and
running headers and footers. The default value is equal to the Crop Box, although
normally it would be no larger than any Trim Box. The Art Box may often be used for
defining "important" content (e.g., excluding advertisements) that may or may not be
brought over to another page (e.g., N-up printing).
If no arguments are given, the current Art Box (global or page) coordinates are
returned instead. The former "get_artbox" (page only) function is deprecated and will
likely be removed some time in the future. If an Art Box has not been defined, the
Crop Box coordinates (if defined) will be returned, otherwise the Media Box
coordinates (which always exist) will be returned. In addition, when setting the Art
Box, the resulting coordinates are returned. This permits you to specify the art box
by a name (alias) and get the dimensions back, all in one call.
A global (PDF level) artbox setting is inherited by each page, or can be overridden by
setting artbox in the page. As with "mediabox", only one art box may be set at this
(PDF) level. As with "mediabox", a named media size may have an orientation (l or L)
for Landscape mode. Note that the PDF level global Art Box will be used even if the
page gets its own Crop Box. That is, the page's Art Box inherits the global Art Box,
not the page Crop Box, even if the page has its own media size! If you set the page's
own Media Box or Crop Box, you should consider also explicitly setting the page Art
Box (and other boxes).
Suggested Box Usage
See "examples/Boxes.pl" for an example of using boxes.
How you define your boxes (or let them default) is up to you, depending on whether you're
duplex printing US Letter or A4 on your laser printer, to be spiral bound on the bind
margin, or engaging a professional printer. In the latter case, discuss in advance with
the print firm what capabilities (and limitations) they have and what information they
need from a PDF file. For instance, they may not want a Crop Box defined, and may call for
very specific box sizes. For large press runs, they may print multiple pages (N-up)
duplexed on large web roll "signatures", which are then intricately folded and guillotined
(trimmed) and bound together into books or magazines. You would usually just supply a PDF
with all the pages; they would take care of the signature layout (which includes offsets
and 180 degree rotations).
(As an aside, don't count on a printer having any particular font available, so be sure to
ask. Usually they will want you to embed all fonts used, but ask first, and double-check
before handing over the print job! TTF/OTF fonts ("ttfont()") are embedded by default, but
other fonts (core, ps, bdf, cjk) are not! A printer may have a core font collection, but
they are free to substitute a "workalike" font for any given core font, and the results
may not match what you saw on your PC!)
On the assumption that you're using a single sheet (US Letter or A4) laser or inkjet
printer, are you planning to trim each sheet down to a smaller final size? If so, you can
do true bleeds by defining a Trim Box and a slightly larger Bleed Box. You would print
bleeds (all the way to the finished edge) out to the Bleed Box, but nothing is enforced
about the Bleed Box. At the other end of the spectrum, you would define the Media Box to
be the physical paper size being printed on. Most printers reserve a little space on the
sides (and possibly top and bottom) for paper handling, so it is often good to define your
Crop Box as the printable area. Remember that the Media Box sets the coordinate system
used, so you still need to avoid going outside the Crop Box with content (most readers and
printers will not show any ink outside of the Crop Box). Whether or not you define a Crop
Box, you're going to almost always end up with white paper on at least the sides.
For small in-house jobs, you probably won't need color alignment dots and other such
professional instructions and information between the Bleed Box and the Crop Box, but crop
marks for trimming (if used) should go just outside the Trim Box (partly or wholly within
the Bleed Box), and be drawn after all content. If you're not trimming the paper, don't
try to do any bleed effects (including solid background color pages/covers), as you will
usually have a white edge around the sheet anyway. Don't count on a PDF document never
being physically printed, and not just displayed (where you can do things like bleed all
the way to the media edge). Finally, for single sheet printing, an Art Box is probably
unnecessary, but if you're combining pages into N-up prints, or doing other manipulations,
it may be useful.
Box Inheritance
What Media, Crop, Bleed, Trim, and Art Boxes a page gets can be a little complicated. Note
that usually, only the Media and Crop Boxes will have a clear visual effect. The visual
effect of the other boxes (if any) may be very subtle.
First, everything is set at the global (PDF) level. The Media Box is always defined, and
defaults to US Letter (8.5 inches wide by 11 inches high). The global Crop Box inherits
the Media Box, unless explicitly defined. The Bleed, Trim, and Art Boxes inherit the Crop
Box, unless explicitly defined. A global box should only be defined once, as the last one
defined is the one that will be written to the PDF!
Second, a page inherits the global boxes, for its initial settings. You may call any of
the box set methods ("cropbox", "trimbox", etc.) to explicitly set (override) any box for
this page. Note that setting a new Media Box for the page does not reset the page's Crop
Box -- it still uses whatever it inherited from the global Crop Box. You would need to
explicitly set the page's Crop Box if you want a different setting. Likewise, the page's
Bleed, Trim, and Art Boxes will not be reset by a new page Crop Box -- they will still
inherit from the global (PDF) settings.
Third, the page Media Box (the one actually used for output pages), clips or limits all
the other boxes to extend no larger than its size. For example, if the Media Box is US
Letter, and you set a Crop Box of A4 size, the smaller of the two heights (11 inches)
would be effective, and the smaller of the two widths (8.26 inches, 595 Points) would be
effective. The given dimensions of a box are returned on query (get), not the effective
dimensions clipped by the Media Box.
FONT METHODS
Core Fonts
Core fonts are limited to single byte encodings. You cannot use UTF-8 or other multibyte
encodings with core fonts. The default encoding for the core fonts is WinAnsiEncoding
(roughly the CP-1252 superset of ISO-8859-1). See the "-encode" option below to change
this encoding. See "font automap" in PDF::Builder::Resource::Font method for information
on accessing more than 256 glyphs in a font, using planes, although there is no guarantee
that future changes to font files will permit consistent results.
Note that core fonts use fixed lists of expected glyphs, along with metrics such as their
widths. This may not exactly match up with whatever local font file is used by the PDF
reader. It's usually pretty close, but many cases have been found where the list of glyphs
is different between the core fonts and various local font files, so be aware of this.
To allow UTF-8 text and extended glyph counts, you should consider replacing your use of
core fonts with TrueType (.ttf) and OpenType (.otf) fonts. There are tools, such as
FontForge, which can do a fairly good (though, not perfect) job of converting a Type1 font
library to OTF.
Examples:
$font1 = $pdf->corefont('Times-Roman', -encode => 'latin2');
$font2 = $pdf->corefont('Times-Bold');
$font3 = $pdf->corefont('Helvetica');
$font4 = $pdf->corefont('ZapfDingbats');
Valid %options are:
-encode
Changes the encoding of the font from its default. Notice that the encoding (not the
entire font's glyph list) is shown in a PDF object (record), listing 256 glyphs
associated with this encoding (and that are available in this font).
-dokern
Enables kerning if data is available.
Notes:
Even though these are called "core" fonts, they are not shipped with PDF::Builder, but are
expected to be found on the machine with the PDF reader. Most core fonts are installed
with a PDF reader, and thus are not coordinated with PDF::Builder. PDF::Builder does ship
with core font metrics files (width, glyph names, etc.), but these cannot be guaranteed to
be in sync with what the PDF reader has installed!
There are some 14 core fonts (regular, italic, bold, and bold-italic for Times [serif],
Helvetica [sans serif], Courier [fixed pitch]; plus two symbol fonts) that are supposed to
be available on any PDF reader, although other fonts with very similar metrics are often
substituted. You should not count on any of the 15 Windows core fonts (Bank Gothic,
Georgia, Trebuchet, Verdana, and two more symbol fonts) being present, especially on
Linux, Mac, or other non-Windows platforms. Be aware if you are producing PDFs to be read
on a variety of different systems!
If you want to ensure the widest portability for a PDF document you produce, you should
consider using TTF fonts (instead of core fonts) and embedding them in the document. This
ensures that there will be no substitutions, that all metrics are known and match the
glyphs, UTF-8 encoding can be used, and that the glyphs will be available on the reader's
machine. At least on Windows platforms, most of the fonts are TTF anyway, which are used
behind the scenes for "core" fonts, while missing most of the capabilities of TTF (now or
possibly later in PDF::Builder) such as embedding, ligatures, UTF-8, etc. The downside
is, obviously, that the resulting PDF file will be larger because it includes the font(s).
There might also be copyright or licensing issues with the redistribution of font files in
this manner (you might want to check, before widely distributing a PDF document with
embedded fonts, although many do permit the part of the font used, to be embedded.).
See also PDF::Builder::Resource::Font::CoreFont.
PS Fonts
PS (T1) fonts are limited to single byte encodings. You cannot use UTF-8 or other
multibyte encodings with T1 fonts. The default encoding for the T1 fonts is
WinAnsiEncoding (roughly the CP-1252 superset of ISO-8859-1). See the "-encode" option
below to change this encoding. See "font automap" in PDF::Builder::Resource::Font method
for information on accessing more than 256 glyphs in a font, using planes, although there
is no guarantee that future changes to font files will permit consistent results. Note:
many Type1 fonts are limited to 256 glyphs, but some are available with more than 256
glyphs. Still, a maximum of 256 at a time are usable.
"psfont" accepts both ASCII (.pfa) and binary (.pfb) Type1 glyph files. Font metrics can
be supplied in either ASCII (.afm) or binary (.pfm) format, as can be seen in the examples
given below. It is possible to use .pfa with .pfm and .pfb with .afm if that's what's
available. The ASCII and binary files have the same content, just in different formats.
To allow UTF-8 text and extended glyph counts in one font, you should consider replacing
your use of Type1 fonts with TrueType (.ttf) and OpenType (.otf) fonts. There are tools,
such as FontForge, which can do a fairly good (though, not perfect) job of converting your
font library to OTF.
Examples:
$font1 = $pdf->psfont('Times-Book.pfa', -afmfile => 'Times-Book.afm');
$font2 = $pdf->psfont('/fonts/Synest-FB.pfb', -pfmfile => '/fonts/Synest-FB.pfm');
Valid %options are:
-encode
Changes the encoding of the font from its default. Notice that the encoding (not the
entire font's glyph list) is shown in a PDF object (record), listing 256 glyphs
associated with this encoding (and that are available in this font).
-afmfile
Specifies the location of the ASCII font metrics file (.afm). It may be used with
either an ASCII (.pfa) or binary (.pfb) glyph file.
-pfmfile
Specifies the location of the binary font metrics file (.pfm). It may be used with
either an ASCII (.pfa) or binary (.pfb) glyph file.
-dokern
Enables kerning if data is available.
Note: these T1 (Type1) fonts are not shipped with PDF::Builder, but are expected to be
found on the machine with the PDF reader. Most PDF readers do not install T1 fonts, and it
is up to the user of the PDF reader to install the needed fonts. Unlike TrueType fonts, PS
(T1) fonts are not embedded in the PDF, and must be supplied on the Reader end.
See also PDF::Builder::Resource::Font::Postscript.
TrueType Fonts
Warning: BaseEncoding is not set by default for TrueType fonts, so text in the PDF isn't
searchable (by the PDF reader) unless a ToUnicode CMap is included. A ToUnicode CMap is
included by default (-unicodemap set to 1) by PDF::Builder, but allows it to be disabled
(for performance and file size reasons) by setting -unicodemap to 0. This will produce
non-searchable text, which, besides being annoying to users, may prevent screen readers
and other aids to disabled users from working correctly!
Examples:
$font1 = $pdf->ttfont('Times.ttf');
$font2 = $pdf->ttfont('Georgia.otf');
Valid %options are:
-encode
Changes the encoding of the font from its default (WinAnsiEncoding).
Note that for a single byte encoding (e.g., 'latin1'), you are limited to 256
characters defined for that encoding. 'automap' does not work with TrueType. If you
want more characters than that, use 'utf8' encoding with a UTF-8 encoded text string.
-isocmap
Use the ISO Unicode Map instead of the default MS Unicode Map.
-unicodemap
If 1 (default), output ToUnicode CMap to permit text searches and screen readers. Set
to 0 to save space by not including the ToUnicode CMap, but text searching and screen
reading will not be possible.
-dokern
Enables kerning if data is available.
-noembed
Disables embedding of the font file. Note that this is potentially hazardous, as the
glyphs provided on the PDF reader machine may not match what was used on the PDF
writer machine (the one running PDF::Builder)! If you know for sure that all PDF
readers will be using the same TTF or OTF file you're using with PDF::Builder; not
embedding the font may be acceptable, in return for a smaller PDF file size. Note that
the Reader needs to know where to find the font file -- it can't be in any random
place, but typically needs to be listed in a path that the Reader follows. Otherwise,
it will be unable to render the text!
The only value for the "-noembed" flag currently checked for is 1, which means to not
embed the font file in the PDF. Any other value currently results in the font file
being embedded (by default), although in the future, other values might be given
significance (such as checking permission bits).
Some additional comments on embedding font file(s) into the PDF: besides substantially
increasing the size of the PDF (even if the font is subsetted, by default),
PDF::Builder does not check the font file for any flags indicating font licensing
issues and limitations on use. A font foundry may not permit embedding at all, may
permit a subset of the font to be embedded, may permit a full font to be embedded, and
may specify what can be done with an embedded font (e.g., may or may not be extracted
for further use beyond displaying this one PDF). When you choose to use (and embed) a
font, you should be aware of any such licensing issues.
-nosubset
Disables subsetting of a TTF/OTF font, when embedded. By default, only the glyphs used
by a document are included in the file, and not the entire font. This can result in a
tremendous savings in PDF file size. If you intend to allow the PDF to be edited by
users, not having the entire font glyph set available may cause problems, so be aware
of that (and consider using "-nosubset => 1". Setting this flag to any value results
in the entire font glyph set being embedded in the file. It might be a good idea to
use only the value 1, in case other values are assigned roles in the future.
-debug
If set to 1 (default is 0), diagnostic information is output about the CMap
processing.
-usecmf
If set to 1 (default is 0), the first priority is to make use of one of the four
".cmap" files for CJK fonts. This is the old way of processing TTF files. If, after
all is said and done, a working internal CMap hasn't been found (for -usecmf=>0),
"ttfont()" will fall back to using a ".cmap" file if possible.
-cmaps
This flag may be set to a string listing the Platform/Encoding pairs to look for of
any internal CMaps in the font file, in the desired order (highest priority first). If
one list (comma and/or space-separated pairs) is given, it is used for both Windows
and non-Windows platforms (on which PDF::Builder is running, not the PDF reader's).
Two lists, separated by a semicolon ; may be given, with the first being used for a
Windows platform and the second for non-Windows. The default list is "0/6 3/10 0/4 3/1
0/3; 0/6 0/4 3/10 0/3 3/1". Finally, instead of a P/E list, a string "find_ms" may be
given to tell it to simply call the Font::TTF "find_ms()" method to find a (preferably
Windows) internal CMap. "-cmaps" set to 'find_ms' would emulate the old way of looking
for CMaps. Symbol fonts (3/0) always use find_ms(), and the new default lookup is (if
".cmap" isn't used, see "-usecmf") to try to get a match with the default list for the
appropriate OS. If none can be found, find_ms() is tried, and as last resort use the
".cmap" (if available), even if "-usecmf" is not 1.
CJK Fonts
Examples:
$font = $pdf->cjkfont('korean');
$font = $pdf->cjkfont('traditional');
Valid %options are:
-encode
Changes the encoding of the font from its default.
Warning: Unlike "ttfont", the font file is not embedded in the output PDF file. This is
evidently behavior left over from the early days of CJK fonts, where the "Cmap" and "Data"
were always external files, rather than internal tables. If you need a CJK-using PDF file
to embed the font, for portability, you can create a PDF using "cjkfont", and then use an
external utility (e.g., "pdfcairo") to embed the font in the PDF. It may also be possible
to use "ttfont" instead, to produce the PDF, provided you can deduce the correct font file
name from examining the PDF file (e.g., on my Windows system, the "Ming" font would be
"$font = $pdf->ttfont("C:/Program Files (x86)/Adobe/Acrobat Reader
DC/Resource/CIDFont/AdobeMingStd-Light.otf")". Of course, the font file used would have
to be ".ttf" or ".otf". It may act a little differently than "cjkfont" (due a a different
Cmap), but you should be able to embed the font file into the PDF.
See also PDF::Builder::Resource::CIDFont::CJKFont
Synthetic Fonts
Warning: BaseEncoding is not set by default for these fonts, so text in the PDF isn't
searchable (by the PDF reader) unless a ToUnicode CMap is included. A ToUnicode CMap is
included by default (-unicodemap set to 1) by PDF::Builder, but allows it to be disabled
(for performance and file size reasons) by setting -unicodemap to 0. This will produce
non-searchable text, which, besides being annoying to users, may prevent screen readers
and other aids to disabled users from working correctly!
Examples:
$cf = $pdf->corefont('Times-Roman', -encode => 'latin1');
$sf = $pdf->synfont($cf, -condense => 0.85); # compressed 85%
$sfb = $pdf->synfont($cf, -bold => 1); # embolden by 10em
$sfi = $pdf->synfont($cf, -oblique => -12); # italic at -12 degrees
Valid %options are:
-condense
Character width condense/expand factor (0.1-0.9 = condense, 1 = normal/default, 1.1+ =
expand). It is the multiplier to apply to the width of each character.
-oblique
Italic angle (+/- degrees, default 0), sets skew of character box.
-bold
Emboldening factor (0.1+, bold = 1, heavy = 2, ...), additional thickness to draw
outline of character (with a heavier line width) before filling.
-space
Additional character spacing in milliems (0-1000)
-caps
0 for normal text, 1 for small caps. Implemented by asking the font what the
uppercased translation (single character) is for a given character, and outputting it
at 80% height and 88% width (heavier vertical stems are better looking than a straight
80% scale).
Note that only lower case letters which appear in the "standard" font (plane 0 for
core fonts and PS fonts) will be small-capped. This may include eszett (German sharp
s), which becomes SS, and dotless i and j which become I and J respectively. There are
many other accented Latin alphabet letters which may show up in planes 1 and higher.
Ligatures (e.g., ij and ffl) do not have uppercase equivalents, nor does a long s. If
you have text which includes such characters, you may want to consider preprocessing
it to replace them with Latin character expansions (e.g., i+j and f+f+l) before small-
capping.
Note that CJK fonts (created with the "cjkfont" method) do not work properly with
"synfont". This is due to a different internal structure of the CJK fonts, as compared to
corefont, ttfont, and psfont base fonts. If you require a synthesized (modified) CJK
font, you might try finding the TTF or OTF original, use "ttfont" to create the base font,
and running "synfont" against that, in the manner described for embedding "CJK Fonts".
See also PDF::Builder::Resource::Font::SynFont
IMAGE METHODS
This is additional information on enhanced libraries available for TIFF and PNG images.
See specific information listings for GD, GIF, JPEG, and PNM image formats. In addition,
see "examples/Content.pl" for an example of placing an image on a page, as well as using
in a "Form".
Why is my image flipped or rotated?
Something not uncommonly seen when using JPEG photos in a PDF is that the images will be
rotated and/or mirrored (flipped). This may happen when using TIFF images too. What
happens is that the camera stores an image just as it comes off the CCD sensor, regardless
of the camera orientation, and does not rotate it to the correct orientation! It does
store a separate "orientation" flag to suggest how the image might be corrected, but not
all image processing obeys this flag (PDF::Builder does not.). For example, if you take a
"portrait" (tall) photo of a tree (with the phone held vertically), and then use it in a
PDF, the tree may appear to have been cut down! (appears in landscape mode)
I have found some code that should allow the "image_jpeg" or "image" routine to auto-
rotate to (supposedly) the correct orientation, by looking for the Exif metadata
"Orientation" tag in the file. However, three problems arise: 1) if a photo has been
edited, and rotated or flipped in the process, there is no guarantee that the Orientation
tag has been corrected. 2) more than one Orientation tag may exist (e.g., in the binary
APP1/Exif header, and in XML data), and they may not agree with each other -- which should
be used? 3) the code would need to uncompress the raster data, swap and/or transpose rows
and/or columns, and recompress the raster data for inclusion into the PDF. This is costly
and error-prone. In any case, the user would need to be able to override any auto-rotate
function.
For the time being, PDF::Builder will simply leave it up to the user of the library to
take care of rotating and/or flipping an image which displays incorrectly. It is possible
that we will consider adding some sort of query or warning that the image appears to not
be "normally" oriented (Orientation value 1 or "Top-left"), according to the Orientation
flag. You can consider either (re-)saving the photo in an editor such as PhotoShop or
GIMP, or using PDF::Builder code similar to the following (for images rotated 180
degrees):
$pW = 612; $pH = 792; # page dimensions (US Letter)
my $img = $pdf->image_jpeg("AliceLake.jpeg");
# raw size WxH 4032x3024, scaled down to 504x378
$sW = 4032/8; $sH = 3024/8;
# intent is to center on US Letter sized page (LL at 54,207)
# Orientation flag on this image is 3 (rotated 180 degrees).
# if naively displayed (just $gfx->image call), it will be upside down
$gfx->save();
## method 0: simple display, is rotated 180 degrees!
#$gfx->image($img, ($pW-$sW)/2,($pH-$sH)/2, $sW,$sH);
## method 1: translate, then rotate
#$gfx->translate($pW,$pH); # to new origin (media UR corner)
#$gfx->rotate(180); # rotate around new origin
#$gfx->image($img, ($pW-$sW)/2,($pH-$sH)/2, $sW,$sH);
# image's UR corner, not LL
# method 2: rotate, then translate
$gfx->rotate(180); # rotate around current origin
$gfx->translate(-$sW,-$sH); # translate in rotated coordinates
$gfx->image($img, -($pW-$sW)/2,-($pH-$sH)/2, $sW,$sH);
# image's UR corner, not LL
## method 3: flip (mirror) twice
#$scale = 1; # not rescaling here
#$size_page = $pH/$scale;
#$invScale = 1.0/$scale;
#$gfx->add("-$invScale 0 0 -$invScale 0 $size_page cm");
#$gfx->image($img, -($pW-$sW)/2-$sW,($pH-$sH)/2, $sW,$sH);
$gfx->restore();
If your image is also mirrored (flipped about an axis), simple rotation will not suffice.
You could do something with a reversal of the coordinate system, as in "method 3" above
(see "Advanced Methods" in PDF::Builder::Content). To mirror only left/right, the second
$invScale would be positive; to mirror only top/bottom, the first would be positive. If
all else fails, you could save a mirrored copy in a photo editor. 90 or 270 degree
rotations will require a "rotate" call, possibly with "cm" usage to reverse mirroring.
Incidentally, do not confuse this issue with the coordinate flipping performed by some
Chrome browsers when printing a page to PDF.
Note that TIFF images may have the same rotation/mirroring problems as JPEG, which is not
surprising, as the Exif format was lifted from TIFF for use in JPEG. The cure will be
similar to JPEG's.
TIFF Images
Note that the Graphics::TIFF support library does not currently permit a filehandle for
$file.
PDF::Builder will use the Graphics::TIFF support library for TIFF functions, if it is
available, unless explicitly told not to. Your code can test whether Graphics::TIFF is
available by examining "$tiff->usesLib()" or "$pdf->LA_GT()".
= -1
Graphics::TIFF is installed, but your code has specified "-nouseGT", to not use it.
The old, pure Perl, code (buggy!) will be used instead, as if Graphics::TIFF was not
installed.
= 0 Graphics::TIFF is not installed. Not all systems are able to successfully install this
package, as it requires libtiff.a.
= 1 Graphics::TIFF is installed and is being used.
Options:
-nouseGT => 1
Do not use the Graphics::TIFF library, even if it's available. Normally you would want
to use this library, but there may be cases where you don't, such as when you want to
use a file handle instead of a name.
-silent => 1
Do not give the message that Graphics::TIFF is not installed. This message will be
given only once, but you may want to suppress it, such as during t-tests.
PNG Images
PDF::Builder will use the Image::PNG::Libpng support library for PNG functions, if it is
available, unless explicitly told not to. Your code can test whether Image::PNG::Libpng is
available by examining "$png->usesLib()" or "$pdf->LA_IPL()".
= -1
Image::PNG::Libpng is installed, but your code has specified "-nouseIPL", to not use
it. The old, pure Perl, code (slower and less capable) will be used instead, as if
Image::PNG::Libpng was not installed.
= 0 Image::PNG::Libpng is not installed. Not all systems are able to successfully install
this package, as it requires libpng.a.
= 1 Image::PNG::Libpng is installed and is being used.
Options:
-nouseIPL => 1
Do not use the Image::PNG::Libpng library, even if it's available. Normally you would
want to use this library, when available, but there may be cases where you don't.
-silent => 1
Do not give the message that Image::PNG::Libpng is not installed. This message will be
given only once, but you may want to suppress it, such as during t-tests.
-notrans => 1
No transparency -- ignore tRNS chunk if provided, ignore Alpha channel if provided.
USING SHAPER (HarfBuzz::Shaper library)
# if HarfBuzz::Shaper is not installed, either bail out, or try to
# use regular TTF calls instead
my $rc;
$rc = eval {
require HarfBuzz::Shaper;
1;
};
if (!defined $rc) { $rc = 0; }
if ($rc == 0) {
# bail out in some manner
} else {
# can use Shaper
}
my $fontfile = '/WINDOWS/Fonts/times.ttf'; # used by both Shaper and textHS
my $fontsize = 15; # used by both Shaper and textHS
my $font = $pdf->ttfont($fontfile);
$text->font($font, $fontsize);
my $hb = HarfBuzz::Shaper->new(); # only need to set up once
my %settings; # for textHS(), not Shaper
$settings{'dump'} = 1; # see the diagnostics
$settings{'script'} = 'Latn';
$settings('dir'} = 'L'; # LTR
$settings{'features'} = (); # required
# -- set language (override automatic setting)
#$settings{'language'} = 'en';
#$hb->set_language( 'en_US' );
# -- turn OFF ligatures
#push @{ $settings{'features'} }, '-liga';
#$hb->add_features( '-liga' );
# -- turn OFF kerning
#push @{ $settings{'features'} }, '-kern';
#$hb->add_features( '-kern' );
$hb->set_font($fontfile);
$hb->set_size($fontsize);
$hb->set_text("Let's eat waffles in the field for brunch.");
# expect ffl and fi ligatures, and perhaps some kerning
my $info = $hb->shaper();
$text->textHS($info, \%settings); # -strikethru, -underline allowed
The package HarfBuzz::Shaper may be optionally installed in order to use the text-shaping
capabilities of the HarfBuzz library. These include kerning and ligatures in Western
scripts (such as the Latin alphabet). More complex scripts can be handled, such as Arabic
family and Indic scripts, where multiple forms of a character may be automatically
selected, characters may be reordered, and other modifications made. The
examples/HarfBuzz.pl script gives some examples of what may be done.
Keep in mind that HarfBuzz works only with TrueType (.ttf) and OpenType (.otf) font files.
It will not work with PostScript (Type1), core, bitmapped, or CJK fonts. Not all .ttf
fonts have the instructions necessary to guide HarfBuzz, but most proper .otf fonts do. In
other words, there are no guarantees that a particular font file will work with Shaper!
The basic idea is to break up text into "chunks" which are of the same script (alphabet),
language, direction, font face, font size, and variant (italic, bold, etc.). These could
range from a single character to paragraph-length strings of text. These are fed to
HarfBuzz::Shaper, along with flags, the font file to be used, and other supporting
information, to create an array of output glyphs. Each element is a hash describing the
glyph to be output, including its name (if available), its glyph ID (number) in the
selected font, its x and y displacement (usually 0), and its "advance" x and y values, all
in points. For horizontal languages (LTR and RTL), the y advance is normally 0 and the x
advance is the font's character width, less any kerning amount.
Shaper will attempt to figure out the script used and the text direction, based on the
Unicode range; and a reasonable guess at the language used. The language can be
overridden, but currently the script and text direction cannot be overridden.
An important note: the number of glyphs (array elements) may not be equal to the number of
Unicode points (characters) given in the chunk's text string! Sometimes a character will
be decomposed into several pieces (multiple glyphs); sometimes multiple characters may be
combined into a single ligature glyph; and characters may be reordered (especially in
Indic and Southeast Asian languages). As well, for Right-to-Left (bidirectional) scripts
such as Hebrew and Arabic families, the text is output in Left-to-Right order (reversed
from the input).
With due care, a Shaper array can be manipulated in code. The elements are more or less
independent of each other, so elements can be modified, rearranged, inserted, or deleted.
You might adjust the position of a glyph with 'dx' and 'dy' hash elements. The 'ax' value
should be left alone, so that the wrong kerning isn't calculated, but you might need to
adjust the "advance x" value by means of one of the following:
axs is a value to be substituted for 'ax' (points)
axsp is a substituted value (percentage) of the original 'ax'
axr reduces 'ax' by the value (points). If negative, increase 'ax'
axrp reduces 'ax' by the given percentage. Again, negative increases 'ax'
Caution: a given character's glyph ID is not necessarily going to be the same between any
two fonts! For example, an ASCII space (U+0020) might be "<0001>" in one font, and
"<0003>" in another font (even one closely related!). A U+00A0 required blank (non-
breaking space) may be output as a regular ASCII space U+0020. Take care if you need to
find a particular glyph in the array, especially if the number of elements don't match.
Consider making a text string of "marker" characters (space, nbsp, hyphen, soft hyphen,
etc.) and processing it through HarfBuzz::Shaper to get the corresponding glyph numbers.
You may have to count spaces, say, to see where you could break a glyph array to fit a
line.
The "advancewidthHS()" method uses the same inputs as does "textHS()". Like
"advancewidth()", it returns the chunk length in points. Unlike "advancewidth()", you
cannot override the glyph array's font, font size, etc.
Once you have your (possibly modified) array of glyphs, you feed it to the "textHS()"
method to render it to the page. Remember that this method handles only a single line of
text; it does not do line splitting or fitting -- that you currently need to do manually.
For Western scripts (e.g., Latin), that might not be too difficult, but for other scripts
that involve extensive modification of the raw characters, it may be quite difficult to
split words, but you still may be able to split at inter-word spaces.
A useful, but not exhaustive, set of functions are allowed by "textHS()" use. Support
includes direction setting (top-to-bottom and bottom-to-top directions, e.g., for Far
Eastern languages in traditional orientation), and explicit script names and language
(depending on what support HarfBuzz itself gives). Not yet supported are features such as
discretionary ligatures and manual selection of glyphs (e.g., swashes and alternate
forms).
Currently, "textHS()" can only handle a single text string. We are looking at how fitting
to a line length (splitting up an array) could be done, as well as how words might be
split on hard and soft hyphens. At some point, full paragraph and page shaping could be
possible.