x-dimension (integer(0:MAX))

x-dimension (integer(0:MAX))
Indicates the size of the media in hundredths of a millimeter along the bottom edge of the media. See section regarding the coordinate system. This is equivalent to 1/2540th of an inch resolution.
y-dimension (integer(0:MAX))
Indicates the size of the media in hundredths of a millimeter along the bottom edge of the media. See section regarding the coordinate system. This is equivalent to 1/2540th of an inch resolution.
media-size-supported (1setOf collection)
Indicates the sizes supported by the Printer. The "media-size-supported " collection member attributes are:
Attribute name
|
attribute syntax
|
request
|
Printer Support
|
x-dimension
|
integer (0:MAX)
|
MUST
|
MUST
|
y-dimension
|
integer (0:MAX)
|
MUST
|
MUST
|
x-dimension (integer(0:MAX) | rangeOfInteger (0:MAX))
Indicates the size of the media in hundredths of a millimeter along the bottom edge of the media. The rangeOfInteger attribute syntax accommodated variable size implementations, including web printers. See section regarding the coordinate system. This is equivalent to 1/2540th of an inch resolution.
y-dimension (integer(0:MAX) | rangeOfInteger (0:MAX))
Indicates the size of the media in hundredths of a millimeter along the bottom edge of the media. The rangeOfInteger attribute syntax accommodated variable size implementations, including web printers. See section regarding the coordinate system. This is equivalent to 1/2540th of an inch resolution.
media-weight (integer(0:MAX))
The "media-weight" attribute indicates the weight of the desired media rounded to the nearest whole number. The units of measure for the "media-weight" attribute are specified using the "media-weight-units" member attribute.
The "media-weight" member attribute is an optional. However, if the client supplies the "media-weight" member attribute, then the client MUST also supply the "media-weight-units" member. If a client supplies the "media-weight" attribute without also supplying the "media-weight-units" member attribute, then the printer MUST reject the job and return the "client-error-bad-request" status code. Similarly, if the Printer supports the "media-weight" member attribute, it MUST also support the "media-weight-units" member attribute.
media-weight-units (type3 keyword)
The "weight-units" attribute indicates the units of measure used for the "weight" attribute.
Standard keyword values for "weight-units" are:
'pounds'
|
Can be used to describe media using the conventional practices, e.g. "20 pound", "24 pound", "60 pound", etc.
|
'grams-per-meter-squared'
|
Can be used to specify the exact weight per unit area, e.g. "75 gm/m2", etc.
|
media-front-coating (type3 keyword | name(MAX)) and media-back-coating (type3 keyword | name(MAX))
The "media-front-coating" and "media-back-coating" member attributes indicate what pre-process coating has been applied to the front and back of the desired media, respectively.
Standard keyword values for "media-front-coating" and "media-back-coating" are:
'any'
|
Indicates that the media MUST be coated, but the specific coating type is not important.
|
'glossy'
|
Indicates that the media MUST have a "glossy" coating.
|
'high-gloss'
|
Indicates that the media MUST have a "high-gloss" coating.
|
'semi-gloss'
|
Indicates that the media MUST have a "semi-gloss" coating.
|
'satin'
|
Indicates that the media MUST have a "satin" coating.
|
'matte'
|
Indicates that the media MUST have a "matte" coating.
|
media-supported (1setOf (type3 keyword | name(MAX) | any-collection))
When the 'collection' attribute syntax of the "media" attribute is supported, then the "media-supported" attribute MUST have an attribute syntax of '1setOf type3 keyword | name(MAX) | any-collection'. The out-of-band 'any-collection' value indicates that any collection value is possible with any combination of supported member attributes indicated by the corresponding "xxx-supported" Printer attributes.
page-delivery (type2 keyword)
This attribute indicates whether print-stream pages of the job are to be delivered to the output bin or finisher in the same page order as the original document, or, in reverse of that order, and, whether the print-stream pages are delivered face up or face down. The "page-delivery" attribute specifies the intent based on the "original document" page order. See section for a complete discussion on the ordering of print-stream pages.
Standard keyword values for page delivery are:
'same-order-face-up'
|
The media sheets that represent the printed document MUST be delivered to the output bin or finishing device in the same order as defined by the "page-order-received" attribute. Further, side one of each sheet MUST be delivered face up to the output bin or finishing device.
|
'same-order-face-down'
|
The media sheets that represent the printed document MUST be delivered to the output bin or finishing device in the same order as defined by the "page-order-received" attribute. Further, side one of each sheet MUST be delivered face down to the output bin or finishing device.
|
'reverse-order-face-up'
|
The media sheets that represent the printed document MUST be delivered to the output bin or finishing device in the reverse order by the "page-order-received" attribute. Further, side one of each sheet MUST be delivered face up to the output bin or finishing device.
|
'reverse-order-face-down'
|
The media sheets that represent the printed document MUST be delivered to the output bin or finishing device in the reverse order by the "page-order-received" attribute. Further, side one of each sheet MUST be delivered face down to the output bin or finishing device
|
The "page-delivery" attribute is often used in conjunction with on-line and off-line finishing devices. The intent is to be able to deliver the media sheets in either the order of the page-stream pages as defined in the "original document" or in the reverse of that order.
Interaction with the "page-order-received" attribute
The "page-order-delivery" attribute is dependent on the value of the "page-order-received" attribute (defined in section below):
"page-order-received"
|
"page-delivery"
|
Description of behavior
|
'1-to-n-order'
|
'same-order-face-up'
|
The first print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing up.
|
'1-to-n-order'
|
'same-face-order-down'
|
The first print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing down.
|
'1-to-n-order'
|
'reverse-order-face-up'
|
The last print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second to last "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing up.
|
'1-to-n-order'
|
'reverse-order-face-down'
|
The last print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second to last "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing down.
|
'n-to-1-order'
|
'same-order-face-up'
|
The first print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing up.
|
'n-to-1-order'
|
'same-order-face-down'
|
The first print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing down.
|
'n-to-1-order'
|
'reverse-order-face-up'
|
The last print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second to last "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing up.
|
'n-to-1-order'
|
'reverse-order-face-down'
|
The last print-stream page in the "document data" MUST be the first print-stream page delivered, followed by the second to last "print-stream" page, and so on. Further, each media sheet MUST be delivered with side one of the sheet facing down.
|
page-order-received (type2 keyword)
This attribute specifies the page order of the print-stream pages defined in the document data. The "page-order-received" attribute does not provide any direct processing instructions, it only provides information about the page order so that other Job Template attributes can process pages in a consistent manner. See section for a complete discussion of print-stream page order.
[explain why this is needed to do page programming].
Standard keyword values for "page-order-received" are:
'1-to-n-order'
|
The print-stream pages defined in the document data are in the same order as the original document.
|
'n-to-1-order'
|
The print-stream pages defined in the document data are in the reverse order of the original document.
|
The "page-order-received" attribute applies to all documents in a Job Creation or Document Creation request. If a job consists of multiple documents, and all of the documents are not in the same page order, either '1-to-n-order' or 'reverse,' then inconsistent processing of other Job Template attributes that depend on "page-order-received" may occur.
If the "page-order-received" attribute is not present in a Job Creation or Document Creation request, then the printer SHOULD assume a value of '1-to-n-order.'
separator-sheets (type3 keyword | collection)
This attribute specifies which separator sheets MUST be printed with the job. Separator sheets are used to separate individual copies of a multiple copy job (i.e., when the "copies" attribute is greater than 1). The "separator-sheets" attribute is dependent both on the value of "multiple-document-handling" and on the value of "sheet-collate" (see section for a detailed description of what constitutes a "set.")
Separator sheets may either be non-imaged sheets, or may contain Printer generated information.
Standard keyword values for separator sheets are:
'none'
|
No separator sheets are to be delivered with the printed output.
|
'slip-sheets'
|
A separator sheet MUST be printed between "sets" of the job.
|
'start-sheet'
|
A separator sheet MUST be printed to indicate the start of each "set" of the job.
|
'end-sheet'
|
A separator sheet MUST be printed to indicate the end of each "set" of the job.
|
'wrap-sheets'
|
Separator sheets MUST be printed to indicate both the start and end of each "set" of the job.
|
Example: A job is created consisting of a single document, with the job template attribute "copies" equal to '10' and "separator-sheets" equal to "slip-sheets." If each of the 10 "sets" is denoted by (J1), (J2) ... (J10), and a separator sheet is denoted by S, then the delivered output would be: (J1) S (J2) S ... S (J9) S (J10).
The 'collection' attribute syntax allows a client to specify media for job separator sheets that is different than the current media being used for the print-stream page impressions. The collection consists of:
Attribute name
|
attribute syntax
|
request
|
Printer Support
|
media
|
type3 keyword | name(MAX) | collection
|
MUST
|
MUST
|
separator-sheets
|
type3 keyword | name(MAX)
|
MUST
|
MUST
|
media (type3 keyword | name(MAX) | collection)
The "media" member attribute is used to indicate the media that MUST be used for the job separator sheet (see section ).
separator-sheets (type3 keyword | name(MAX))
The "separator-sheets" member attribute specifies which separator sheets to print on the specified media. The values for this member attribute are identical to the keyword and name values for the "separator-sheets" attribute itself, and convey the same semantics.
sheet-collate (boolean)
This attribute specifies whether or not the media sheets of each copy of each printed document in a job are to be in sequence, when multiple copies of the document are specified by the 'copies' attribute. When "sheet-collate" is 'true', each copy of each document is printed with the print-stream sheets in sequence. When 'sheet-collate' is 'false', each print-stream sheet is printed a number of times equal to the value of the 'copies' attribute in succession. For example, suppose a document which produces two media sheets as output, and "copies" is equal to '6', in this case six copies of the first media sheet are printed followed by six copies of the second media sheet.
Whether the effect of sheet collation is achieved by placing copies of a document in multiple output bins or in the same output bin with implementation defined document separation is implementation dependent. Also whether it is achieved by making multiple passes over the job or by using an output sorter is implementation dependent.
This attribute is affected by "multiple-document-handling." The "multiple-document-handling" attribute describes the collation of documents, and the "sheet-collate" attribute describes the semantics of collating individual pages within a document. To better explain the interaction between these two attributes the term "set" is introduced. A "set" is a logical boundary between the delivered media sheets of a printed job. For-example, in the case of a ten page single document with collated pages and a request for ten copies, each of the ten printed copies of the document constitutes a "set." In the above example if the pages were uncollated, then ten copies of each of the individual pages within the document would represent each "set".
The following table describes the interaction of "sheet-collate" with multiple document handling.
"sheet-collate"
|
"multiple-document-handling"
|
Semantics
|
'true'
|
'single-document'
|
Each copy of the concatenated documents, with their pages in sequence, represents a "set."
|
'true'
|
'single-document-new-sheet'
|
Each copy of the concatenated documents, with their pages in sequence, represents a "set."
|
'true'
|
'separate-documents-collated-copies'
|
Each copy of each separate document, with its pages in sequence, represents a "set."
|
'true'
|
'separate-documents-uncollated-copies
|
Each copy of each separate document, with its pages in sequence, represents a "set."
|
'false'
|
'single-document'
|
Each media sheet of the document is printed a number of times equal to the "copies" attribute; which constitutes a "set."
|
'false'
|
'single-document-new-sheet'
|
Each media sheet of the concatenated documents is printed a number of times equal to the "copies" attribute; which constitutes a "set."
|
'false'
|
'separate-documents-collated-copies'
|
This is a degenerate case, and the printer object MUST reject the job and return the status, "client-error-conflicting-attributes."
|
'false'
|
'separate-documents-uncollated-copies
|
This is a degenerate case, and the printer object MUST reject the job and return the status "client-error-conflicting-attributes."
|
From the above table it is obvious that the implicit value of the "sheet-collate" attribute in a printer that does not support the "sheet-collate" attribute, is 'true.' The semantics of "multiple-document-handling" are otherwise nonsensical in the case of separate documents.
Whether the effect of page collation is achieved by placing copies of a document in multiple output bins or in the same output bin with implementation defined document separation is implementation dependent. Also whether it is achieved by making multiple passes over the job or by using an output sorter is implementation dependent.
sheet-collate-supported (1setOf boolean)
This attribute specifies the values of "sheet-collate" supported by the Printer.
Note: IPP/1.0 [RFC2566] and IPP/1.1 [ipp-mod] is silent on whether or not sheets within documents are collated. The "sheet-collate-supported" attribute permits a Printer object to indicate whether or not it collates sheets with each document and whether it allows the client to control sheet collation. An implementation is able to indicate that it supports uncollated sheets, collated sheets, or both, using 'false', 'true', or both 'false' and 'true' values, respectively, for this attribute.
ISSUE 01 - Should we change the name from "collate-sheets" to "uncollated-sheets", since the absence of the attribute (and non-support of this attribute) is more likely to indicate collated sheets and so should be the 'false' value of the attribute, rather than the 'true' value?
x-image-auto-center (boolean)
This attribute causes the page images to be centered along the x-axis on the media to which they are applied.
If the "x-image-shift," "x-side1-image-shift" or "x-side2-image-shift" attributes are specified, then the printer MUST apply the "x-image-auto-center" attribute first, followed by the "x-image-shift" attribute, and finally the "x-side1-image-shift" and "x-side2-image-shift" attributes.
For example, if the print-stream image normally is placed on the media sheet as follows:
with "x-image-auto-center" = 'true' (1), the result would be:
x-image-shift (integer (MIN:MAX))
This attribute causes the page images on both sides of each sheet, to be shifted in position with respect to the media on which the page images are to be rendered. The direction of shift MUST be along the x-axis of the Coordinate System (see section ). The sign of the value indicates the direction of the shift.
If the client supplies the "x-image-auto-center," "x-side1-image-shift" or "x-side2-image-shift" attributes, then the Printer MUST apply the "x-image-auto-center" attribute first, followed by the "x-image-shift" attribute, and finally the "x-side1-image-shift" and "x-side2-image-shift" attributes.
The unit of measure for this attribute is hundredths of a millimeter. This is equivalent to 1/2540th of an inch resolution.
|