XProc 3.0: paged media steps
Editor's Draft
- This Version:
- https://ndw.github.io/steps/master/head/paged-media/
- Latest Version:
- http://spec.xproc.org/master/head/paged-media/
- Editors:
- Norman Walsh
- Achim Berndzen
- Gerrit Imsieke
- Erik Siegel
- Repository:
- This specification on GitHub
- Report an issue
- Changes:
- Commits for this specification
This document is also available in these non-normative formats: XML.
Copyright © 2018 @@FIXME:
Abstract
This specification describes the p:css-formatter
and p:xsl-formatter
steps for
XProc 3.0: An XML Pipeline Language.
Status of this Document
This document is an editor's draft that has no official standing.
This section describes the status of this document at the time of its publication. Other documents may supersede this document.
This document is derived from XProc: An XML Pipeline Language published by the W3C.
Table of Contents
1 Introduction
This specification describes the
p:css-formatter and
p:xsl-formatter XProc steps.
A machine-readable description of
these steps may be found in
steps.xpl.
Familarity with the general nature of [XProc 3.0] steps is assumed; for background details, see [XProc 3.0 Steps].
2 p:css-formatter
T.B.D.
<p:declare-step type="p:css-formatter">
<p:input port="source" content-types="application/xml text/xml */*+xml"/>
<p:output port="result" content-types="*/*"/>
<p:option name="parameters" as="map(xs:QName,item()*)?"/>
<p:option name="content-type" as="xs:string?"/> </p:declare-step>
T.B.D.
Document properties
No document properties are preserved.
3 p:xsl-formatter
The p:xsl-formatter step receives an [XSL 1.1] document and renders the content. The result of
rendering is stored to the URI provided via the href
option. A reference to that result is produced on the output
port.
<p:declare-step type="p:xsl-formatter">
<p:input port="source" content-types="application/xml text/xml */*+xml"/>
<p:output port="result" content-types="*/*"/>
<p:option name="parameters" as="map(xs:QName,item()*)?"/>
<p:option name="content-type" as="xs:string?"/> </p:declare-step>
The content-type of the output is controlled by the
content-type option. This option specifies a media
type as defined by [IANA Media Types]. The option may
include media type parameters as well (e.g.
"application/someformat; charset=UTF-8"). The use of media type
parameters on the content-type option is
implementation-defined.
If the content-type option is not specified,
the output type is implementation-defined. The default should be
PDF.
A formatter may take any number of optional rendering
parameters via the step's parameters; such parameters
are defined by the XSL implementation used and are
implementation-defined.
The output of this step is a document containing the result of processing. This is often, but not necessarily, a PDF document.
Document properties
No document properties are preserved.
4 Step Errors
This step can raise dynamic errors.
[Definition: A dynamic error is one which occurs while a pipeline is being evaluated.] Examples of dynamic errors include references to URIs that cannot be resolved, steps which fail, and pipelines that exhaust the capacity of an implementation (such as memory or disk space). For a more complete discussion of dynamic errors, see Dynamic Errors in XProc 3.0: An XML Pipeline Language.
If a step fails due to a dynamic error, failure propagates
upwards until either a p:try is encountered or the entire
pipeline fails. In other words, outside of a p:try, step
failure causes the entire pipeline to fail.
The following errors can be raised by this step:
A Conformance
Conformant processors must implement all of the features described in this specification except those that are explicitly identified as optional.
Some aspects of processor behavior are not completely specified; those features are either implementation-dependent or implementation-defined.
[Definition: An implementation-dependent feature is one where the implementation has discretion in how it is performed. Implementations are not required to document or explain how implementation-dependent features are performed.]
[Definition: An implementation-defined feature is one where the implementation has discretion in how it is performed. Conformant implementations must document how implementation-defined features are performed.]
A.1 Implementation-defined features
The following features are implementation-defined:
- The use of media type parameters on the content-type option is implementation-defined. See Section 3, “p:xsl-formatter”.
- If the content-type option is not specified, the output type is implementation-defined. See Section 3, “p:xsl-formatter”.
- A formatter may take any number of optional rendering parameters via the step's parameters; such parameters are defined by the XSL implementation used and are implementation-defined. See Section 3, “p:xsl-formatter”.
A.2 Implementation-dependent features
The following features are implementation-dependent:
B References
[XProc 3.0] XProc 3.0: An XML Pipeline Language. Norman Walsh, Achim Berndzen, Gerrit Imsieke and Erik Siegel, editors.
[XProc 3.0 Steps] XProc 3.0 Steps: An Introduction. Norman Walsh, Achim Berndzen, Gerrit Imsieke and Erik Siegel, editors.
[XSL 1.1] Extensible Stylesheet Language (XSL) Version 1.1. Anders Berglund, editor. W3C Recommendation. 5 December 2006.
[IANA Media Types] IANA MIME Media Types. Internet Engineering Task Force.
C Glossary
- dynamic error
A dynamic error is one which occurs while a pipeline is being evaluated.
- implementation-defined
An implementation-defined feature is one where the implementation has discretion in how it is performed. Conformant implementations must document how implementation-defined features are performed.
- implementation-dependent
An implementation-dependent feature is one where the implementation has discretion in how it is performed. Implementations are not required to document or explain how implementation-dependent features are performed.
D Ancillary files
This specification includes by reference a number of ancillary files.
- steps.xpl
-
An XProc step library for the declared steps.