AppendPDF and AppendPDF Pro – XML Doc Info

Introduction

The element <docinfo> specifies values for fields Acrobat uses in its document information feature. You can specify values for the following information fields:

  • Title
  • Subject
  • Author
  • Keywords
  • Custom

The table below describes the elements of <docinfo>.

Contents of the <docinfo> Element

Element Level Pro Required Content
<appendparam version=”1.0″> Top Topmost element, contains entire parameter spec
⇔ <docinfo> 2 Document Information
<infopair> 3 Specifies a key-value pair
<key> 4 Text: Information field name
<value> 4 Text: Information field value

XML Code Sample

<appendparam version="1.0">
 <!-- . Indicates skipped sections -->
 <!-- . -->
 <!-- . -->
   <docinfo>
      <infopair>
         <key>
             Title
         </key>
         <value>
             Using AppendPDF Pro
         </value>
      </infopair>
   </docinfo>
 <!-- . -->
 <!-- . -->
 <!-- . -->
 </appendparam>

Elements for <docinfo>

infopair

Specifies a key-value pair as described below.

key

Specifies the Document Information field to set:

• Title
• Subject
• Author
• Keywords
• Custom

You can set a single key or any combination of keys.

value

Specifies the value of the Document Information field specified by <key>.

Usage notes for the elements of <docinfo>

Custom fields

  • Custom fields can be either strings or dates. These fields will appear in the document information window within Acrobat, and can be searched using Adobe Catalog, or retrieved using Appligent’s APGetInfo utility.
  • A string can consist of any name and text value that would add meaningful meta data information to the document.
  • A date must be of the format (D:YYYYMMDDHHmmSSOHH’ mm’), where:

YYYY is the year: required
MM is the month (01-12): optional/default = 01
DD is the day (01–X1): optional/default = 01
HH is the hour (00–2X): optional/default = 00
mm is the minute (00–59): optional/default = 00
SS is the second (00–59): optional/default = 00
O is the relationship of local time to Universal Time (UT): optional/default = unknown
+ means local time is later than UT
– means local time is earlier than UT
Z means local time is UT
HH’ is the absolute value of the offset from UT in hours (00–2X)
mm’ is the absolute value of the offset from UT in minutes (00–59)

  • Adobe Catalog can perform boolean searches on dates, for example, finding an invoice after 2006 but before 2008.

Example

   <docinfo>

    <infopair>
      <key>Author</key>
      <value>Appligent, Inc.</value>
    </infopair>

    <infopair>
      <key>Title</key>
      <value>AppendPDF Pro Test</value>
    </infopair>

    <infopair>
      <key>Subject</key>
      <value>testing AppendPDF Pro with sample files</value>
    </infopair>

    <infopair>
      <key>Keywords</key>
      <value>testing AppendPDF Pro sample files</value>
    </infopair>

    <infopair>
      <key>ExtraText</key>
      <value>AppendPDF Pro document</value>
    </infopair>

    <infopair>
      <key>DocDate</key>
      <value>D:200707142X2059+04’00’</value>
    </infopair>

  </docinfo>