This topic is not current. For the most current information, see the Print Schema Specification.

Describes the collating characteristics of the output. All pages in each individual document are collated. DocumentCollate and JobCollateAlldocuments are mutually exclusive. The behavior and implementation of whether both or only one of these keywords is implemented is left to the driver.

The following are the rules which should be followed for Collate implementation

Element Definition and Rules

You must first follow the rules for JobCollateAllDocument, and then apply rules for DocumentCollate for the scenarios to work. Note that in a PrintTicket to Devmode conversion setting, where JobCollateAllDocuments is not supported by the driver, it is up to the driver to choose the appropriate behavior to take (JobCollateAllDocuments = ON or OFF). Also, the choice can be changed depending on other PrintTicket settings.


ON: Print (DocumentCopiesAllPages) copies of each document, repeat JobCopiesAllDocuments times.

OFF: For each document, print (JobCopiesAllDocuments x DocumentCopiesAllPages) copies together.


ON: For all copies (JobCopiesAllDocuments x DocumentCopiesAllPages) of a document printed contiguously, collate sheets in that document.

OFF: For all copies (JobCopiesAllDocuments x DocumentCopiesAllPages) printed contiguously, print all copies (JobCopiesAllDocuments x DocumentCopiesAllPages) of each sheet together.

Element Information

Name Value
Element Type
Scoping Prefix

Structural Content

The XML structure of this element is:

<psf:Feature name="psk:DocumentCollate">
  <psf:Property name="psf:SelectionType">
    <psf:Value xsi:type="xs:string">psk:PickOne</psf:Value>
  <psf:Option name="psk:_OptionName_">
    <psf:Property name="psf:IdentityOption">
      <psf:Value xsi:type="xs:string">_IdentityOptionValue_</psf:Value>

Structure Variables

The following table outlines the characteristics of the variables defined in the XML structure.

Name Data type Unit Supported values Summary
Valid fully qualified name as defined by Namespaces in XML. If no namespace is specified, default namespace is assumed.
The name of the option.
True, False.
Defines an Option which when selected would disable this feature.

Extensible Markup Language (XML) Content

The public Print Schema keywords are defined in the namespace. The public Extensible Markup Language (XML) content for this keyword is defined below:

<psf:Feature name="psk:DocumentCollate">
  <psf:Property name="psf:SelectionType">
    <psf:Value xsi:type="xs:string">psk:PickOne</psf:Value>
  <!-- Specifies collating.  -->
  <psf:Option name="psk:Collated" />
  <!-- Specifies no collating. -->
  <psf:Option name="psk:Uncollated" />

Print Schema Specification