NAME

TeX::AutoTeX::StampPDF - watermark PDF files

VERSION

This documentation refers to TeX::AutoTeX::StampPDF version 1.9.2.5

SYNOPSIS

use TeX::AutoTeX::StampPDF qw(stamp_pdf);

stamp_pdf($pdffile, $array_ref);

DESCRIPTION

This module modifies a given PDF file. It prints an arbitrary text string (within certain length limits) onto the left edge of the 1st page of a well formed PDF file.

This is intended to be used to put the arXiv stamp onto PDF-only and pdflatex submissions, but any type of "watermark" text string is possible.

Non adjustable settings are:

Font: Times-Roman

FontSize: 20

X-Y offsets

SUBROUTINES/METHODS

The single subroutine exported by this package is stamp_pdf.

stamp_pdf

stamp_pdf takes 2 arguments, the name of a PDF file, which must be apt to be opened r/w, and a reference to an array, which contains a text string in its [0]th element. A backup file of the original PDF is created temporarily, thus the current working directory has to be writeable by euid.

The reason for the second argument to be a reference to an array is that we intend to add an associated hyperlink to the stamp, which will be paired with the [0] element. Current limitations of CAM::PDF make this difficult.

DIAGNOSTICS

throw a TeX::AutoTeX::FatalException

CONFIGURATION AND ENVIRONMENT

none

DEPENDENCIES

CAM::PDF

INCOMPATIBILITIES

none

BUGS AND LIMITATIONS

The placement of the stamp is tuned to US letter size paper and dimensions are hard-coded. This is easily adaptable to other paper sizes if necessary.

Please report bugs to www-admin

AUTHOR

Thorsten Schwander <schwande@cs.cornell.edu>

LICENSE AND COPYRIGHT

Copyright (c) 2007 - 2011 arxiv.org http://arxiv.org/help/contact

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.