AppendPDF Pro Readme
AppendPDF Pro 6.4
New stamp file parameters:
New options for StartPage and EndPage
-1 represents the last page of the PDF file to be stamped. You can now use -2 for the second to the last page to be stamped, -3 for the third to the last page to be stamped and so on.
BarText – This parameter allows you to show or hide the text for barcode stamps. The default is to Show text. Options for this parameter are Show or Hide.
New command line options:
-vardelimiter – Delimiter character for variables in the stamp file (default is %)
AppendPDF Pro 6.0
Command line options:
–vars: List of variables to be substituted in the stamp file (“name,value,name,value”)
AppendPDF Pro now has the ability to dynamically replace variables found within the stamp file, and thus substitute the text that is stamped based on parameters set on the command line.
–portfolio – PDF Portfolio combines multiple files into one, regardless of file type. PDF Portfolio allows you to insert documents without altering the content of the original files.
Please see the AppendPDF Pro Options for the full documentation of the new features.
AppendPDF Pro 5.5
-listfonts – display a list of the fonts available to AppendPDF Pro
-u <string> – Remove old stamps set with an UndoLabel
*If a stamp does not have an UndoLabel specified in the stamp file, you will not be able to remove it later. The parameter should be set in the stamp item as shown below:
Example of command line to remove stamps:
appendpro –u remove param.txt
When removing stamps, you must also run AppendPDF Pro with a parameter file.
Support for CJK on TOC page – CJK characters are now supported for TOC entries. You need to specify a CJK font in the TOC section of the parameter file.
Font Support for stamping
Base14, OpenType, TrueType, Type 1 and Unicode fonts are all supported in AppendPDF Pro for stamping. In previous version, Type 1 fonts were used in AppendPDF Pro by including the FontFile parameter in the stamp file. In AppendPDF Pro 5.5, you should only specify the font name.
In order to use a non-Base 14 font, the font must be stored in one of the Appligent font directories. You can run the command:
$ appendpro –listfonts
to see a list of all the font names available for stamping. The font name should be used exactly as it is shown in the font list.
NOTE: Some of the classic Base 14 fonts are no longer included with the application resources. In particular Times and Helvetica. Both of these fonts are automatically substituted; but, may not appear identical to the classic fonts. If the new font appearance are not acceptable, simply use the versions of Times and Helvetica available on your system. This can be done by setting the Font Directories; please see below.
There are two font directories.
The default font directory is found under the AppligentHome directory in APDFL10.1.0a/Resource/Font. On Windows, the AppligentHome directory is in the AllUsers Application data directory:
Windows XP: C:\Documents and Settings\AllUsers\Application Data\Appligent
Windows Vista and later: C:\ProgramData\Appligent
You can also specify an additional font directory, the AP font directory. The path to the AP font directory is saved in an environment variable called AP_FONT_DIR. You will be prompted to enter a font directory during installation.
On Windows: Environment variables can be set on Windows under the System Properties. To display System Properties, right click on “My Computer” and select properties. On the bottom of the Advanced tab, click the button labeled “Environment Variables”. Under system variables, you will see an entry for AP_FONT_DIR. Select this entry and click edit. You can then change the variable’s value to the path of the current font directory. If the AP_FONT_DIR variable is not there, you will need to add it.
On Unix: As the other environment variables for AppendPDF Pro, AP_FONT_DIR is set in the appendpro script. The directory set in an environment variable in the script, or be set for the shell.
Encoding (required for Unicode fonts)
Unicode fonts require an encoding parameter when stamping. The encoding parameter should be set to the following values depending on the type of text used:
The possible values for encoding are:
Non-CJK text UTF-8
Japanese text UniJIS-UTF16-H
Korean text UniKS-UTF16-H
Simplified Chinese text UniGB-UTF16-H
Traditional Chinese text UniCNS-UTF16-H
Change in behavior version 5.5
Options set in Advanced Tab of first input PDF file are copied over into the output appended document. In previous versions of AppendPDF, if for example Language was set in the first input PDF, it was not copied into the appended document.
Document property information was not getting overwritten in the output file if the first input PDF already contained data in the fields (Title, Author, Subject). In version 5.5, document property fields are now properly updated with information set in the parameter file.
AppendPDF Pro 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 AppendPDF Pro command line without the executable name. The commands file does not support wildcards in filenames.
When you use the -cmds option, many of the AppendPDF Pro 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 -cmds file, the option value from the -cmds file will be used.
For more information on the -cmds option, see Command Collections.
AppendPDF Pro 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).
• -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.
• -n — Do not write anything to screen: The option to not write anything to the screen (or STDOUT) now works.
• Stamping of JPEG images: Images now stamp correctly on rotated pages.
• Links with named destinations: Articles and threads can be copied into the appended document by including the -extra flag on the command line.
• If running with a TOC page, you must be sure to include -b to get TOC bookmarks
• %P variable: If %P is used to stamp the full pathname to a file AppendPDF Pro stamps the temp directory along with a temp name.
• If a TOC entry contains an xml entity, the output file is not always correct. The TOC page at times will be blank or not include all files and the bookmark name will be the title of the PDF instead of what is set for the TOC entry.
• Stamping and Setting Doc Info: There is an occasional problem with setting and stamping document information (title, author, subject) on documents.
Color Space Parameter
The parameter ColorSpace is deprecated in stamp files. The color values you use determine the color space. Any value entered for ColorSpace is ignored. If you combine color values (for example, specify Color and Red, Green, Blue, the last value specified is the one used.
For example, in older builds the following would be gray:
ColorSpace (DeviceGray) Color (90) Red (0) Green (0) Blue (0)
Now it would be black.
The ColorSpace parameter is still used in the parameter files for the TOC entry. See the chapters TOC Color Space – XML and The Table of Contents Block – Text for information about the use of the ColorSpace parameter in those files.
• Multi-line stamps may be slightly off position.
• Automatic word wrapping is not available for Unicode characters. You must manually insert line breaks and set the MultiLine parameter to Yes.
• Angled text is not supported. This includes the Position parameters Diag-TopLeft, Diag-TopRight, and Angle.
• Variables (%x) are not supported in a Unicode stamp.
Verification of Correctly Formed XML Files
Occasionally, AppendPDF Pro will not verify a correctly formed XML file when the DTD is included in the XML file. AppendPDF Pro returns the error message “Error in parameter file.” To run a file that gives this error with AppendPDF Pro, remove the DTD from the XML file. Since references to “DTD” have been removed in the Guide, do you want to remove this little section?
Form fields are incompatible with AppendPDF Pro. If your document has form fields, AppendPDF Pro will not rebuild the form tree within the PDF document following the append operation. Thus, form fields will not function properly after being appended.
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.
Table of Contents
• The linespace parameter available in the TOC (Table of Contents) block does not account for multi-line TOC entries. The new option of appendblanklines allows you to control the space between TOC entries, or space between page numbers. This parameter adds blank lines after the last line of the TOC entry, using the value of LineSpace. Without appendblanklines set, AppendPDF Pro counts line spaces from the first line of the TOC entry.
• Active links created on the Table of Contents page take up three vertical lines instead of one. Consider keeping linespace greater than one to avoid links overlapping.
Page numbers in stamp files
Page numbers specified in stamp files (i.e., StartPage) need to be Acrobat page numbers and not the page numbers as defined by AppendPDF Pro. Acrobat page numbers are the page numbers as they appear in your Adobe Acrobat window (i.e., 3 of 20). If -f is used page counting will begin on the cover page and AppendPDF Pro numbers will be the same as Acrobat numbers. If -f is not used, page number counting is reset to 1 at the start of the body of the appended document (this will not correspond to the 3 of 20 in your Acrobat window). Therefore, be sure to refer to the page numbers as they appear in Acrobat when specifying pages in stamp files.
• The Symbol and Zapf Dingbats fonts do not work reliably in either Table of Contents (TOC) entries or other stamp files.
• Base 14 fonts are listed in the documentation with the following names: Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic, Symbol and ZapfDingbats. While it is imperative that the font name is spelled correctly in order to be used within the software, there is some leeway with spaces and hyphenation. For example: Courier-Bold can also be given as Courier Bold or CourierBold. The way they are listed in the documentation is how they are defined in the Adobe Type Manager®.
• If you are using Adobe PostScript Type 1 fonts in stamp files, be sure that you do not have a TrueType version of the same font on your system. This will cause AppendPDF Pro to work improperly. No error will be raised when AppendPDF Pro runs, but the processing will not have worked properly and will be visible on the completed output. (This behavior will also occur if a document created with a Type 1 font is imported to a system that has installed the TrueType version of that font.)
Do not use bookmarks in the files that you provide for the Cover and Table of Contents pages. AppendPDF Pro will supply them on its own.
To Get Help
Documentation for AppendPDF Pro can be found at /appendpdf-pro/.
Contact technical support by:
emailing email@example.com, or calling 610-284-4006
Please provide the following:
Product name and version number
Your name, company name, email address, and phone number
Description of your question or problem
Responses are typically emailed within one business day.