 |
The FOSI and XSL-FO print engines are on sustained support and do not receive enhancements or maintenance fixes. PTC APP is the recommended engine for print output.
|
|
|
The FOSI and XSL-FO print engines are on sustained support and do not receive enhancements or maintenance fixes. PTC APP is the recommended engine for print output.
|
|
Parameter
|
Explanation
|
||
|
app-config-file=pathname
|
Specifies the name of the PDF configuration file when using the PTC APP print engine to convert documents to PDF or Script only. If it’s not specified, the default configuration file for the document type is used. This parameter is ignored for other output types or if the PTC APP print engine is not being used.
|
||
|
app-snapshot=yes|no
|
Specifies whether to generate an PTC APP snapshot zip archive when using the PTC APP print engine to convert documents to PDF or Script. Set to yes to produce the snapshot. As a result, the transaction will also be archived on the Arbortext PE server (ignoring archive-transaction). For more information on using the snapshot zip for troubleshooting, refer to Troubleshooting PTC APP Publishing.
If app-snapshot is not specified, then the behavior defaults to the value of the ACL set appsnapshot option. Specifying app-snapshot on a request overrides the value of the set appsnapshot option.
This parameter is ignored if the PTC APP print engine is not being used.
|
||
|
archive-transaction=yes|no
|
Specify whether to archive the transaction produced by the request. If set to yes, the transaction will be archived if com.arbortext.e3.transactionArchive.enable is set to true in the e3config.xml configuration file. If app-snapshot is set to yes, this parameter is ignored.
|
||
|
change-tracking=original|changes|latest
|
If the document contains change tracking markup, this parameter specifies which document version should be published.
• original publishes the original document with no changes.
• changes publishes the document showing proposed changes.
• latest publishes the document with all changes applied (the default and is assumed if the parameter is omitted)
This parameter is ignored if output type is xml, sgml, or subset=toc. This parameter has no effect on documents without change tracking.
|
||
|
cropmarks=yes|no
|
Determines whether crop marks appear in PDF output. This parameter is ignored for other output types or if the PTC APP print engine is not being used. The default is no.
|
||
|
encoding=specification
|
Specifies the character encoding to use for EPUB, HTML, and Web publishing output. If omitted, the publishing operation uses the document type default. Consult the online help topic Character sets and encoding for encoding specification values.
|
||
|
export-stylesheet=pathname
|
Specifies the absolute path to a stylesheet to be used in producing RTF output. When producing RTF output, if export-stylesheet is not specified, stylesheet will be used instead if stylesheet specifies a .style file.
Note that you can specify both a stylesheet parameter to transform an XML document to another XML document, and an export-stylesheet to produce RTF on the same request.
If not specified, the default stylesheet for the document type is used.
|
||
|
failure-mode=linkcheck|localgraphics
|
Specifies method to use to check graphics for the input document.
The linkcheck method verifies graphic and file entity references of the input file.
The localgraphics setting collects graphic entity references specified by a URL and copies the graphic entities to a local temporary http cache subdirectory.
The actions performed by localgraphics include the actions for linkcheck.
By default, neither method is applied.
|
||
|
file=pathname
|
This parameter is deprecated and not supported.
Any file parameter specified in a POST request is ignored. The request body is used as file for conversion.
|
||
|
file-type=type
|
Specifies the format of the data in the input file. Refer to Loading a Document for Conversion for supported values.
file-type is optional. If omitted, Arbortext Publishing Engine will try to determine the input file type from the HTTP content-type header for a POST request.
|
||
|
flatten-entities=yes|no
|
Specifies whether all entities and XML inclusion references should be resolved when producing an XML or SGML document. The default is no.
|
||
|
frameset=directorypath
|
Specifies the absolute path to a directory containing a frameset to apply to web publishing output. If omitted, the publishing operation uses the document type default.
|
||
|
graphic-transform=specification
|
Specifies rules for transforming graphics when converting a document to the specified output format. specification consists of one or more rules separated by vertical bars: rule1|rule2|ruleN. A rule consists of a list of input types separated by commas, followed a colon, and then an output type.
For example:
svg,cgm:png|bmp:gif
specifies two rules, the first converts SVG and CGM graphics to PNG, and the second converts BMP to GIF.
For example:
tif,drw,eps,iso,idr:svg
specifies a single rule that converts TIF, DRW, EPS, ISO and IDR graphics to SVG.
The supported graphic input and output types depend on the type of output format. For all HTML output formats, the types are the same as those specified by set graphicwebtransform preference. For RTF output, the types are the same as those in the set graphicrtftransform preference. For print or PDF output using PTC APP, the types are the same as those in the set graphicapptransform preference. If this parameter is not specified, the values of these preferences is used instead for the associated output types.
This parameter is ignored if there are no graphics of the type specified, or if the output format is postscript, sgml, xml, or subset=toc.
|
||
|
graphic-web=yes|no
|
This parameter is deprecated. Use the graphic-transform parameter instead.
Specifies whether to convert embedded intelligent (such as 3D and ISO) graphics to web-friendly graphics (GIF, JPEG, or PNG) when producing HTML or Web output. The default is no.
|
||
|
import-inline-map-comments= yes|no
|
Specifies whether to include Import MapTemplate comments in the imported XML file. Setting import-inline-map-comments to yes includes the comments. The default is no.
|
||
|
import-map=path
|
Specifies the absolute path to the MapTemplate file used when importing a Microsoft Word, Adobe FrameMaker, HTML, PDF, RTF, text, or XML.
There is no default; this parameter is required if the input document is in any of the supported formats.
|
||
|
input-entry=filename
|
Specifies the file name of the entry in a zip archive to be used as the input document.
There is no default; this parameter is required if the input file is a zip archive.
|
||
|
input-entry-type=type
|
Specifies the format of the data in the zip archive entry specified by input-entry=filename.
type can be any supported input file type other than zip.
input-entry-type is optional and if omitted, Arbortext Publishing Engine will examine the file extension of the file name input-entry parameter value.
|
||
|
locale=none|coountry code
|
Valid when publishing to web via HTTP request
Specifies the locale for the publish action, setting the UI language and displaying the correct content.
Enter none to use the default (current) locale.
|
||
|
pdf-config-file=pathname
|
Specifies the absolute path to a PDF configuration file (.pdfcf), which controls PDF output using FOSI engine.
pdf-config-file is optional and if omitted, Arbortext Publishing Engine will use the default configuration file for the document type of the document being converted (usually standard.pdfcf).
For information about PDF configuration files, please refer to Print and PDF Configuration Files in Arbortext Editor Help.
|
||
|
print-engine-override=app|fosi|xslfo
|
Specifies whether to use PTC APP, FOSI, or XSL-FO engine for PDF or PostScript output.
The Arbortext PE sub-process saves the current value of printengineoverride and then applies this setting before performing the requested document conversion. After the conversion is complete, the Arbortext PE sub-process restores the saved value for printengineoverride.
This parameter is ignored for any other output type or if PTC APP is not being used on the Arbortext PE server.
|
||
|
print-options=option-list
|
Specifies a list of options that are used in producing PostScript output. This parameter is ignored when producing PDF output direct from XML.
Refer to Producing PostScript Output for supported values.
print-options is optional and if omitted, no options are passed to the print command.
This parameter is ignored for any other output type or if PTC APP is being used.
|
||
|
profile=specification
|
Specifies how to apply profiling to the input file before converting it to the output format.
Refer to Applying a Profile for a description of profiling expressions. By default, no profiling is performed.
|
||
|
regmarks=yes|no
|
Determines whether registration marks appear in PDF output. This parameter is ignored for other output types or if the PTC APP print engine is not being used. The default is no.
|
||
|
return-composer-errors=no|error|warning
|
Specifies whether to return the event log in place of the output document.
This option applies to producing PostScript, HTML, and PDF.
The default value is no, meaning publishing errors are ignored and the output document is returned (if one is generated).
|
||
|
return-formatter-errors=yes|no
|
Specifies whether, if formatting errors are detected, the errors should be returned in an XML document instead of the formatted output document.
The default value no returns the output document if one is generated. The value yes returns the event log instead of the output document if the log contains error messages.
|
||
|
return-parser-errors=yes|no
|
Specifies whether, if parser errors occur when opening an XML or SGML document, the errors should be returned in an XML document instead of the formatted output document.
The default value is no, meaning parser errors are ignored.
|
||
|
rule-file=rulefileUniqueID
|
Specifies the unique ID of the publishing rule file containing the publishing rule set or publishing rule to execute. The Unique ID is assigned when the rule file is created.
If rulefileUniqueID does not specify a valid rule file on the Arbortext PE server, an error is returned.
This parameter must be specified along with the rule=rulename parameter or an error is returned.
There is no default value.
|
||
|
rule=rulename
|
Specifies the name of the publishing rule set or publishing rule to be used for publishing the document.
If rulename does not specify a valid rule or rule set in the rule file specified by rule-file=rulefileUniqueID, an error is returned.
This parameter must be specified along with the rule-file=rulefileUniqueID parameter or an error is returned.
There is no default value.
|
||
|
use-ruleset-parameters=yes|no
|
Specifies whether a parameter value specified in the rule set definition in a rule file will be used or ignored.
Ordinarily, the rule set output process specifies its own values for parameters such as absoluteManifestPaths, generateManifest, generateRuleLogs, outputMode, outputModePattern, ruleTargetOverride, and ruleTargetPattern rule set parameters.
If use-ruleset-parameters is set to yes, a parameter value specified in the rule set definition in a rule file will be used. For any parameter not specified in the rule file, the default value is used. (Publishing rule set parameters and their defaults are documented in Customizer's Guide.)
If this parameter is specified,rule-file=rulefileUniqueID and rule=rulename must also be specified, or an error is returned.
The default is no and may be omitted.
|
||
|
stylesheet=pathname
|
Specifies the absolute path, URL, or logical ID of the stylesheet to apply during document conversion. (a .style, .fos.xsl or .3f file).
For Web, specify an .xsl stylesheet or a .style file that supports XSL.
For EPUB, specify a .style stylesheet.
This parameter is optional; the default is the default stylesheet for the document type.
|
||
|
subset=toc
|
Specifies whether to extract a subset of a loaded, profiled document when publishing HTML output.
If this parameter is omitted, the entire document is returned. If subset=toc is specified, only the table of contents is returned.
|
||
|
type=target
|
Specifies the format of the output document. This parameter is required, except when specifying a publishing rule or rule set (which produces an error).
Refer to Conversion Processing for a list of output types.
If zip-output=yes is specified, the output document will be placed in a zip archive and the zip archive will be returned.
|
||
|
xml-char-ent=same|char|entref|numref
|
Specifies how non-ASCII characters are handled in XML output.
• same keeps the characters the same as the source
• char converts to characters in the target encoding
• entref converts to character entity references
• numref (the default) converts to numeric character references
This parameter is supported only for the output typexml, otherwise it is ignored.
|
||
|
xml-header=yes|no
|
Specifies whether to include the XML header when producing XML output.
The default is no.
|
||
|
zip-graph-dir=directory
|
Specifies the name of a directory that will contain graphic files produced by the conversion process when zip-output=yes is specified.
Refer to Generating a Zip Archive for a description of the default used if this parameter is omitted.
|
||
|
zip-include-composerlog=yes|no
|
Specifies whether to return a zip archive containing a manifest file, the result of the publishing operation, XML and HTML versions of the event log, and an error page if one was generated. The default is no.
.This parameter is ignored unless zip-output=yes is specified or the output type=target specifies web (implying zip-output=yes). Refer to Generating a Zip Archive.
|
||
|
zip-output=yes|no
|
Specifies whether the conversion output should be placed in a zip archive, and the zip archive returned instead of the output file.
The default is no. Refer to Generating a Zip Archive.
|
||
|
zip-root=filename
|
Specifies the name for the published output file if zip-output=yes is specified.
Refer to Generating a Zip Archive for a description of the default used if this parameter is omitted.
|