Mapping Table Elements Reference¶
This chapter provides complete details of all mapping table directives and their attributes.
Call-event-list¶
Inserts the named event-list at this point in the mapping table. This directive is identical to a macro call.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Name |
String |
Required. The name of a event list (as in |
Call-proc-list¶
Inserts the named proc-list at this point in the mapping table. This directive is identical to a macro call.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Name |
String |
Required. The name of a variable processing list (see |
Comment¶
Allows documentation or notes to be included in the mapping table. This directive does no processing.
DTD content rule
<TEXT>
Conditional-delimiter¶
Emits the contained text if this proc-var
is not the first one to be accepted and processed after the start of an event or the first one to be processed after a conditional-prefix
control element.
DTD content rule
<TEXT>
Attributes
Name |
Type |
Description |
Emit-newline-before |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-newline-after |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-after |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-before |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Conditional-prefix¶
Caches and emits the contained text if any proc-var
is accepted to be processed before the end of the current event or before the next Conditional-suffix
control element.
DTD content rule
<TEXT>
Attributes
Name |
Type |
Description |
Emit-newline-after |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-newline-before |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-after |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-before |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Conditional-suffix¶
Emits the contained text if the preceding Conditional-prefix
within the current event was emitted.
DTD content rule
<TEXT>
Attributes
Name |
Type |
Description |
Emit-newline-after |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-newline-before |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-after |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-before |
Choice |
Required. Since XML strips the first and last space in each element and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Define-event-list¶
Event-lists and proc-lists, like macros, allow the user to define a series of processing directives that can be used in multiple locations within the SaveAs mapping table.
Event-lists govern the selection and processing of elements in the layout, metadata, logical structure, or stylesheet trees. Proc-lists govern the processing of attributes or properties associated with a given event or structural element. For more information, see Define-proc-list.
DTD content rule
( Comment | Event | Call-event-list)+
Attributes
Name |
Type |
Description |
Name |
String |
Required. The name to be applied to the event processing list being defined by this element. This is referenced in the |
Define-proc-list¶
Proc-lists and event-lists, like macros, allow the user to define a series of processing directives that can be used in multiple locations within the SaveAs mapping table.
Proc-lists govern the processing of attributes and properties associated with a given event or structural element. Event-lists govern the selection and processing of elements in the layout, metadata, logical structure, or stylesheet trees. (See Define-event-list.)
DTD content rule
(Comment | Proc-var | Walk-proplist | Call-proc-list)+
Attributes
Name |
Type |
Description |
Name |
String |
Required. The name to be applied to the variable processing list being defined by this element. This is referenced in the |
Element-name¶
Outputs the Element-name, which is used in the XML output filter to generate the user-supplied element tag.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Node-type |
Choice |
Required. Specifies whether to get the structural element name to emit directly from the
|
Emit-all-metadata¶
Copies the full set of XAP metadata to the output file.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Emit-newline-after |
Choice |
Required. XML strips the first and last space and most newlines from the parsed result, so it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-newline-before |
Choice |
Required. XML strips the first and last space in each element and most newlines from the parsed result, so it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-after |
Choice |
Required. XML strips the first and last space in each element and most newlines from the parsed result, so it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-before |
Choice |
Required. XML strips the first and last space in each element and most newlines from the parsed result, so it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-string¶
Emits the text contained in this mapping table element.
DTD content rule
<TEXT>
Attributes
Name |
Type |
Description |
Emit-newline-after |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-newline-before |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-after |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Emit-space-before |
Choice |
Required. Since XML strips the first and last space and most newlines from the parsed result, it is necessary to have this set of flags to control explicit insertion of these control codes. One of:
|
Evaluate-var¶
Does the same processing as Proc-var
, except it does not make the data value available to the other contained processing directives. For more information, see Proc-var.
DTD content rule
(Comment | Conditional-delimeter | Emit-string | Conditional-prefix |
Element-name | Proc-string | Proc-integer | Proc-fixed | Proc-length |
Proc-pixels | Proc-enum | Proc-var | Walk-proplist | Call-proc-list |
Proc-graphic-content | Proc-image-content | Proc-doc-text | Walk-children |
Walk-metadata | Emit-all-metadata | Walk-cached-property-sets |
Walk-structure | Walk-layout | Conditional-suffix )+
Attributes
Name |
Type |
Description |
Compare |
String |
Optional. The value used to determine |
Condition |
Choice |
Required. Indicates whether the directives that are children of the
|
Default |
String |
Optional. The value to be used if the property is not found on this element (or through inheritance). This should be the same type (Fixed, Int32, Atom, String) as the property. |
Inherit |
Choice |
Optional. Whether the property value can be inherited from a parent. One of:
|
Owner |
Choice |
Required. The owner of the property dictionary. One of:
|
Pdf-var |
String |
Required. The name of a property in a given property dictionary (see |
Type |
Choice |
Required. The primary PDF datatype of the property (see
|
Event¶
Governs the processing of a node in the layout, logical-structure, metadata, or stylesheet trees. Specifies the processing that is to be performed on entering or exiting the named node.
DTD content rule
(Comment | Emit-string | Conditional-prefix | Element-name | Proc-var |
Walk-proplist | Call-proc-list | Conditional-suffix | Proc-graphic-content |
Proc-image-content | Proc-doc-text | Walk-children | Walk-metadata |
Emit-all-metadata | Walk-cached-property-sets | Walk-structure | Walk-layout |
Evaluate-var)+
Attributes
Name |
Type |
Description |
Event-class |
Choice |
Required. Identifies which transition into or out of the node is to be processed using this event description. One of:
|
Node-content |
Choice |
Required. One of:
|
Node-name |
String |
Required. Name of the element or role to match, in order to select this event descriptor for processing. |
Node-type |
Choice |
Required. The
|
Proc-doc-text¶
Emits the text contained in the current structural element.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
do-br-substitution |
Choice |
Required. One of:
|
Proc-enum¶
If the data cached by the containing Proc-var
directive is a string or an atom, searches for a match among the proc-enum
choice elements that are children of this control element. If a match is found, issues the Value-out
value of the matching Proc-enum-choice
directive as a string.
DTD content rule
Proc-enum-choice+
Proc-enum-choice¶
Specifies the choice and output values for a Proc-enum
directive.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Value-in |
String |
Required. This value is compared to the value cached by the containing |
Value-out |
String |
Required. This value is emitted as a string if a match against |
Proc-fixed¶
If the data cached by the containing Proc-var
directive is a FixedPoint number, emits the text representation of the value. This value is scaled using the attributes of this directive as follows:
The original value is multiplied by the value of the
Mul
attribute.The value of the
Add
attribute is added to the result of step 1.The result of step 2 is divided by
Div
.The result of step 3 is converted to a string.
Frac-len
controls the number of digits to the right of the decimal point.Frac-dlm
is the fraction-radix character to be issued ifFrac-len
is greater than 0.
Proc-fixed
, Proc-length
, and Proc-pixels
vary only in the default values for Mul
, Div
, and Add
.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Add |
String |
Optional. Default is 0. |
Div |
String |
Optional. Default is 1. |
Frac-dlm |
String |
Optional. Default is “.” |
Frac-len |
String |
Optional. Default is 2. |
Mul |
String |
Optional. Default is 1. |
Proc-graphic-content¶
Processes the content of the current structural element as a vector graphic.
DTD content rule
Void?
Proc-hex¶
If the data cached by the containing Proc-var
directive is an Int32, an Uns32, or a Fixed, emits the text representation of the integer portion of the value, after the scaling algorithm is applied. This value is scaled using the attributes of this directive as follows:
The original value is multiplied by the value of the
Mul
attribute.The value of the
Add
attribute is added to the result of step 1.The result of step 2 is divided by
Div
and the fraction is discarded.The result of step 3 is converted to a string.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Add |
String |
Optional. Default is 0. |
Div |
String |
Optional. Default is 1. |
Mul |
String |
Optional. Default is 1. |
Num-digits |
String |
Optional. Default is 2. |
Proc-image-content¶
Processes the content of the current structural element as a bitmapped graphic.
DTD content rule
Void?
Proc-integer¶
If the data cached by the containing Proc-var
directive is an Int32 or an Uns32, emits the text representation of the value. This value is scaled using the attributes of this directive as follows:
The original value is multiplied by the value of the
Mul
attribute.The value of the
Add
attribute is added to the result of step 1.The result of step 2 is divided by
Div
and the fraction is discarded.The result of step 3 is converted to a string.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Add |
String |
Optional. Default is 0. |
Div |
String |
Optional. Default is 1. |
Mul |
String |
Optional. Default is 1. |
Proc-length¶
If the data cached by the containing Proc-var
directive is a FixedPoint number, emits the text representation of the value. This value is scaled using the attributes of this directive as follows:
The original value is multiplied by the value of the
Mul
attribute.The value of the
Add
attribute is added to the result of step 1.The result of step 2 is divided by
Div
.The result of step 3 is converted to a string.
Frac-len
controls the number of digits to the right of the decimal point.Frac-dlm
is the fraction-radix character to be issued ifFrac-len
is greater than 0.
Proc-fixed
, Proc-length
, and Proc-pixels
vary only in the default values for Mul
, Div
, and Add
.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Add |
String |
Optional. Default is 0. |
Div |
String |
Optional. Default is 72. |
Frac-dlm |
String |
Optional. Default is “.” (decimal point). |
Frac-len |
String |
Optional. Default is 2. |
Mul |
String |
Optional. Default is 72. |
Proc-pixels¶
If the data cached by the containing Proc-var
directive is a FixedPoint number, emits the text representation of the value. This value is scaled using the attributes of this directive:
The original value is multiplied by the value of the
Mul
attribute.The value of the
Add
attribute is added to the result of step 1.The result of step 2 is divided by
Div
.The result of step 3 is converted to a string.
Frac-len
controls the number of digits to the right of the decimal point.Frac-dlm
is the fraction-radix character to be issued ifFrac-len
is greater than 0.
Proc-fixed
, Proc-length
, and Proc-pixels
vary only in the default values for Mul
, Div
, and Add
.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Add |
String |
Optional. Default is 36. |
Div |
String |
Optional. Default is 72. |
Frac-dlm |
String |
Optional. Default is “.” (decimal point). |
Frac-len |
String |
Optional. Default is 0. |
Mul |
String |
Optional. Default is 96. |
Proc-property¶
Processes an arbitrary property. This is similar to proc-var
, except that it does not select or filter which properties are processed, but simply takes each property owned by the current owner in turn.
DTD content rule
(Comment | Conditional-delimeter | Emit-string | Property-name | Property-type)+
Proc-string¶
If the data cached by the containing Proc-var
directive is a string or an atom, emits the text content of the string or a text representation of the atom’s name.
DTD content rule
Void?
Proc-var¶
Specifies the formatting and conversion of the named attribute or property (PDF-variable).
This directive also caches the data value and type of the value specified for use by various processing directives within this element.
DTD content rule
(Comment | Conditional-delimeter |Emit-string | Conditional-prefix |
Element-name | Proc-string | Proc-integer | Proc-fixed | Proc-length |
Proc-pixels | Proc-enum | Proc-doc-text | Proc-graphic-content |
Proc-image-content | Conditional-suffix )+
Attributes
Name |
Type |
Description |
Compare |
String |
Optional. The value used to determine |
Condition |
Choice |
Required. Indicates whether the directives that are children of the
|
Default |
String |
Optional. The value to be used if the property is not found on this element (or through inheritance). This should be the same type (Fixed, Int32, Atom, String) as the property. |
Inherit |
Choice |
Optional. Whether the property value can be inherited from a parent. One of:
|
Owner |
Choice |
Required. The owner of the property dictionary. One of:
|
Pdf-var |
String |
Required. The name of a property in a given property dictionary (see Owner) to be processed or evaluated. |
Type |
Choice |
Required. The primary PDF datatype of the property (see
|
Property-type¶
Processes the data portion of an arbitrary property.
DTD content rule
(Comment | Conditional-delimeter | Emit-string | Proc-string | Proc-integer |
Proc-fixed | Proc-length | Proc-pixels | Proc-enum | Proc-doc-text |
Proc-graphic-content | Proc-image-content)+
Attributes
Name |
Type |
Description |
Type |
Choice |
Required—The primary PDF datatype of the property. One of:
|
Root¶
The root node of a mapping table. Its attributes specify the name of the filter to appear in the menu and information necessary to properly generate the output file name and type information.
DTD content rule
(Comment | Emit-string | Define-event-list | Define-proc-list |
Walk-metadata | Emit-all-metadata | Walk-cached-property-sets |
Walk-structure | Walk-layout)+
Attributes
Name |
Type |
Description |
Encode-out |
Choice |
Required. The encoding of the output file. One of:
|
File-format |
Choice |
Required. Internal unique name that describes the format of the output file. The following formats are provided:
|
Mac-creator |
String |
Required. The file creator field for a Mac OS file. |
Mac-type |
String |
Required. The file type field for a Mac OS file. |
Menu-name |
String or | Identifier
|
Required. The text string describing the file format that appears in the Save As dialog box’s pulldown menu. The following predefined identifiers, which provide localized menu name strings, can be used in place of a string:
|
Win-suffix |
String |
Required. The three-letter file type suffix for the Windows environment. Also used on Mac OS files. |
Void¶
This node is used to avoid the <empty/>
syntax of XML and force the <name></name>
syntax of SGML, which allows editing on any SGML editor as well as any XML editor.
Many elements have the content rule “Void?”. However, the Void element should never be specified, thereby leaving the containing node empty.
DTD content rule
<EMPTY>
Walk-cached-property-sets¶
Directs the SaveAs processor to construct a stylesheet cache and walk the stylesheet data.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Use-event-list |
String |
Required. The name of an event processing list (as in |
Walk-children¶
Directs the SaveAs processor to walk the kids list of the current structural element.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Use-event-list |
String |
Required. The name of an event processing list (see |
Walk-layout¶
This directive is not supported in this version of SaveAsXML.
Walk-metadata¶
Directs the SaveAsXML processor to walk the DocInfo
metadata portion of the PDF document.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Use-proc-list |
String |
Required. The name of an event processing list (as in |
Walk-proplist¶
Directs the SaveAs processor to walk the specified generic property list (property lists owned by XML, HTML-3.20, and HTML-4.01). This is used to process arbitrary, user-supplied attributes of the current structural element.
DTD content rule
(Comment | Conditional-delimeter | Emit-string | Proc-property)+
Attributes
Name |
Type |
Description |
Owner |
Choice |
Required. Selects the attribute list owner. One of:
|
Walk-structure¶
Directs the SaveAsXML processor to walk the logical structure tree and associated content of the PDF document.
DTD content rule
Void?
Attributes
Name |
Type |
Description |
Use-event-list |
String |
Required. The name of an event processing list (as in |