AppendPDF Readme, Version 5.1
© 2010 Appligent, Inc.
| Product Version: | 5.1 |
| Release Date: | 3/1/2010 |
| User Guide Version: | 5.0 |
| Publication Date: | 3/1/2010 |
Introduction
AppendPDF is a command-line-driven application that appends pages of one or many PDF documents to create one new document. AppendPDF is designed to run in tandem with other processes in an unattended environment and to handle high-volume and on-demand production needs.
These release notes contain last-minute product information and updates. Please refer to the documentation for additional information:
http://www.appligent.com/docs-appendpdfpro
Installation
For All Unix Platforms, Setting Environmental Variables
In this release, there are 2 additional environmental variables that need to be set for AppendPDF on all UNIX platforms. If you run AppendPDF from the appendpdf script created during installation, these environmental variables will be set by the script. If you run appendpdfapp directly, you will need to set these environmental variables to run AppendPDF. Once AppendPDF is installed, you can view the variables needed by looking at the appendpdf script created by the installer.
For All Unix Platforms, Setting the Appligent Home Directory
The environmental variable that stores the location of the Appligent home directory is APPLIGENT_HOME. The default location for the Appligent home directory is /usr/local/appligent. The Appligent home directory contains the library files and resources needed to run AppendPDF. It also contains license information for AppendPDF.
Example:
export APPLIGENT_HOME=/usr/local/appligent
For Unix Platforms Only (not including AIX, see below), Setting the APDFL Library Path
The APDFL library path must be added to the LD_LIBRARY_PATH variable. The APDFL library path is located in a subdirectory of the APPLIGENT_HOME directory.
The path should be set to ${APPLIGENT_HOME}/APDFL9.0.1/Libs
Example:
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${APPLIGENT_HOME}/APDFL9.0.1/Libs
For AIX Only, Setting the APDFL Library Path
The APDFL library path for AIX must be added to the LIBPATH variable. The APDFL library path is located in a subdirectory of the APPLIGENT_HOME directory.
The path should be set to ${APPLIGENT_HOME}/APDFL9.0.1/Libs.
Example:
export LIBPATH=${LIBPATH}:${APPLIGENT_HOME}/APDFL9.0.1/Libs
Registration numbers for AppendPDF
In previous versions of AppendPDF, the AppendPDF registration number was required as a command line option with the -r flag each time appendpdfapp was run. A appendpdf script was provided that automatically added -r and the registration number to the appendapp command line when the script was run.
In the current release, in addition to getting the registration number from the command line, AppendPDF can get the registration number from a license file in the appligent home directory. License files are created by the installation script and stored in the ${APPLIGENT_HOME}/license directory. With a valid license file, the -r is no longer required on the command line. The -r option can still be used as in previous versions, and will override the value in the license file.
New Features 5.1
-cmds <filename>
To process multiple commands quickly and efficiently, use the -cmds <filename> option. The file specified by -cmds, the commands file, should contain one or more single line commands. Each command is just like an ordinary StampPDF Batch command-line without the executable name. The commands file does not support wildcards in filenames.
When you use the -cmds option, many of the StampPDF Batch options should be set in the -cmds file instead of on the command line. The following options are supported on the command line when using the -cmds option:
-r
-l
-n
-p
If the same option is set on the command line and in the a record of the -cmds file, the option value from the -cmds file record will be used.
New Features
AppendPDF 5.0
For document optimization, use -optimize. This flag reduces file-size in most instances, and performs a variety of functions.
-
encode any non-encoded streams using Flate compression
-
remove ASCII85 filters from all streams
-
replace LZW encoded streams with Flate encoding
-
merge identical XObjects and images
-
optimize common sequences in page content
-
merge identical font descriptors and encodings
To maximize compression, use -comp. This flag will apply object level compression, typically reducing file size by 2%.
NOTE: PDF files support the simultaneous use of multiple types of compression. Object level compression was developed by Adobe Systems to reduce the size of PDF files, with a typical reduction of 2%. The object level compression mechanism is not always understood by older versions of Acrobat or third party PDF software, and limits compatibility to Acrobat 6 or higher.
To not use object level compression, use, -nocomp. This flag will not add object level compression and will remove object level compression, if found; resulting in a document that is compatible with all versions of Acrobat.
To create an ISO 32000 compliant PDF, use -iso32000. This flag sets the output file version for ISO 32000 compliance (Adobe PDF version 1.7).
• -b on command line: All bookmarks from the original files are copied into the appended document. NEW behavior for version 5.0: If an input file does not have ANY bookmarks, a top level bookmark is created. The name of the bookmark will be the "Title" of the PDF. If there is no "Title" set, then the name of the PDF will be the name used for the bookmark. JavaScript bookmarks are now also supported. Top level bookmarks are always expanded.
• -extra:This flag will copy any named destination bookmarks/links, and article threads into the appended document. If this flag is on the command line AND a page range is specified for an input file, no extra bookmarks or article threads will be copied over into the appended document
AppendPDF Pro 4.3
• New XML Parameters: Additional functionality has been added to the XML which provide more control over the appearance of the output PDF document.
• <extras>: This new element specifies additional attributes you may want to define for the output file.
• <opentopage>: The page number at which to open the document.
• <openmode>: Specifies what is displayed when the document opens in Acrobat. Options for openmode are:
<showbookmarks>: The document opens with the bookmarks navigation panel showing.
<showthumbnails>: The document opens with the thumbnails navigation panel showing.
<shownone>: The document opens with no navigation panels showing.
<fullscreen>: The document will open in the fullscreen mode.
• <viewmode>: Specifies the zoom level when the document opens. Options for viewmode are:
<bookmarkmode>: Specifies the initial state of the document's bookmarks in the navigation pane. This does not affect the visibility of the bookmark pane.
<openbookmarks>: Expands the bookmark list to show all bookmarks in the navigation pane when the document is opened.
<closebookmarks>: Collapses the bookmark list to show only the top level bookmarks in the navigation pane when the document is opened.
<openlevel>: Expands the bookmark list through level n. For example, n=3, all bookmarks up to and including the third level are shown. The fourth and higher level bookmarks are collapsed.
• <layoutmode>: Specifies the display page layout when the document opens.
<single>: Displays one page at a time.
<onecolumn>: Arranges the pages in a continuous vertical column.
<twocolleft>: Arranges two pages side by side, the first page on the left.
<twocolright>: Arranges two pages side by side, the first page on the right.
• <displaymode>: Specifies the window display mode when the document opens. You can specify more than one option.
<hidetoolbar>: Specifies that the tool bar will not be displayed when the document opens.
<hidemenubar>: Specifies that the menu bar will not be displayed when the document opens.
<hidewinui>: Specifies that window controls will not be displayed when the document opens.
<fitwin>: Resizes the document window to fit the first page when the document opens.
<centerwin>: Centers the document window on the screen when the document opens.
<showtitle>: Displays the document title, rather than the filename, on the title bar and the Windows menu.
Fixed in This Release
• -n - Do not write anything to screen. The option to not write anything to the screen (or STDOUT) now works.
• Links with named destinations, Articles and threads can be copied into the appended document by including the –extra flag on the command line.
• The -eb flag to include embedded files is not working in this version.
Known Issues
• Stamping and Setting Doc Info: Occasional problem with setting and stamping doc info (title, author, subject) on document.
Verification of correctly formed XML files
• Occasionally, AppendPDF will not verify a correctly formed XML file when the DTD is included in the XML file. AppendPDF returns the error message "Error in parameter file." To run a file that gives this error with AppendPDF, remove the DTD from the XML file.
Form fields
• Form fields are incompatible with AppendPDF. If your document has form fields, AppendPDF will not rebuild the form tree within the PDF document following the append operation. Thus, form fields will not function properly after being appended.
Linking Problems
• When portions of documents are appended, links in the appended section will work only if they link to a page within that section. If multiple sections of the same document are appended, links between those sections will not work.
Bookmarks
• If your file contains Named Destination bookmarks, you need to include the –extra flag on the command line for the bookmarks to be copied into the appended document. NOTE: If this flag is on the command line AND a page range is specified for an input file, no extra bookmarks or article threads will be copied over into the appended document
To Get Help:
Documentation for AppendPDF can be found here.
Contact technical support by:
emailing support@appligent.com, or calling 610-284-4006
Please provide the following:
Product name and version number
Operating system
Your name, company name, email address, and phone number
Description of your question or problem
Responses are typically emailed within one business day.