PDF Document Management Software, Services & Support
| Server | Desktop | Services | Support | Why Us? | About Us |
docs-appendpdfpro-sourcepdfs
Specifying the source files <sourcepdfs>
The element <sourcepdfs> specifies the input files, page ranges, and Table of Contents entry text for the appended document. You can specify more than one input file. To specify multiple page ranges from one file, specify an inputpdf, using the same file, for each page range.
The table below describes the Elements specifying <sourcepdfs>.
Contents of the <sourcepdfs> element
| Element | Level | Pro | R | C | Content |
|---|---|---|---|---|---|
| <appendparam> version="1.0" | Top | — | X | — | Topmost element, contains entire parameter spec |
| <sourcepdfs> | 2 | — | X | — | Input files to be appended |
| <inputpdf> | 3 | — | X | + | Input PDF file |
| <file> | 4 | — | X | — | Text: Name and path of input file |
| <startpage> | 4 | — | — | * | Text: Start page of range to extract |
| <endpage> | 4 | — | — | * | Text: End page of range to extract |
| <TOCEntry> | 4 | X | — | * | Text: Table of Contents entry (AppendPDF Pro only) |
| + <inputpdf> | 3 | — | — | + | Additional PDF Files |
DTD Elements
<!ELEMENT sourcepdfs (inputpdf+)>
<!ELEMENT inputpdf (file, (startpage | endpage | TOCEntry)*>
<!ELEMENT file (#PCDATA)>
<!ELEMENT startpage (#PCDATA)>
<!ELEMENT endpage (#PCDATA)>
<!ELEMENT TOCEntry (#PCDATA) >
XML Code Sample
Specifying an input file.
Elements for <sourcepdfs>
Inputpdf
Specifies the details of an input file.
File
Specifies the path and filename of an input PDF file.
Startpage, Endpage
Specifies the start page and end page of a range of pages to extract and append to the output document. The example above will extract pages X through 10 of the input document.
TOCEntry — AppendPDF Pro only
Specifies the text to use in the Table of Contents to identify this range of pages. The TOCEntry is only used if you include a TOC page, see Specifying the Table of Contents <TOC> (AppendPDF Pro only). If you want to append an inputpdf without an entry in the Table of Contents, use an empty TOCEntry tag as shown below:
<TOCEntry/>
Note: If you are using a TOC page and do not include a <TOCEntry> element for an inputpdf, the Title in the Document Properties of the input file will be used as the TOCEntry. If the file does not have a Title set, the filename of the inputpdf will be used.
Usage notes for the elements of <sourcepdfs>
Specifying input files
You can specify more than one file by including multiple sets of <inputpdf> tags.
Specifying page ranges
The following notes apply to specifying page ranges:
- If you do not specify a page range, the entire file will be appended.
- You can specify multiple page ranges by specifying the same file in multiple instances of <inputpdf>. For each instance, specify one of the required ranges in a <startpage> and <endpage> set.
- To specify one page, make the value of <startpage> and <endpage> the same.
- To specify from a particular page to the end, use only the <startpage> tag.
- You can specify the last page of a document using “-1”. This is especially helpful if the number of pages in a document may change.
Examples
For clarity, the following examples may not use full path names. We recommend that you use full path names for all files. The following examples are from the sample files included with AppendPDF Pro.
Including the entire file
To include the entire file, do not specify a page range:
To explicitly specify all pages in a file and a TOC entry
Other options
The following options are not in the sample files, they are shown as further examples.
Including one page of a file
To include only page 7 of a file:
Including a range to the end of the file
To include from page 7 to the end of the file:
Including the last page only
To specify the last page when you are not sure what number it will be:
