fn:transform

Invokes a transformation using a dynamically-loaded XSLT stylesheet.

transform($options as map(*)) ➔ map(*)

Namespace

http://www.w3.org/2005/xpath-functions

Links to W3C specifications

XPath 3.1 Functions and Operators

XPath 4.0 Functions and Operators

Saxon availability

Available in XPath 3.1, XSLT 3.0, XQuery 3.1, and later versions. From Saxon 9.8, available in all editions. Implemented in Saxon-PE and Saxon-EE since Saxon 9.7. Available for all platforms.

Notes on the Saxon implementation

Available since Saxon 9.7. The input options available are listed in the specification, with the additions and caveats noted below.

The following options are available:

• source-location. Since 9.8.0.8.

  The top-level option source-location has the same effect as source-node except that it supplies the location of a source (lexical XML) document rather than a parsed XDM tree. This option is useful if the target transformation is streamed; it has been added as an extension to the spec because there is no other way of executing a stylesheet that expects a streamed input document.

• vendor-options/saxon:configuration. Since 9.8.0.8

  .

  The vendor-options parameter allows an entry of the form "vendor-options": map {QName('http://saxon.sf.net/', 'configuration'): $config} where $config is the root node of a configuration file expressed as an XML tree. If this option is present, the target transformation is run in a different configuration from the calling application, so that settings in the configuration file do not affect the environment of the caller. The calling and called configurations share the same NamePool and document number pool, so that XDM nodes can be safely passed from one environment to the other; however they do not share the same schema components, so typed (schema-validated) documents cannot be passed.

  Options that can usefully be set in the target configuration file include the URIs and locations of schema documents and of XSLT library packages.

• vendor-options/saxon:schema-validation

  Validation of source documents may be requested either (a) by supplying a configuration file in which the option <global schemaValidation="strict"/> has been set, or (b) by setting the option "vendor-options": map {QName('http://saxon.sf.net/', 'schema-validation'): 'strict'}. (The value 'lax' can also be used.) Either option affects documents supplied using the source-node, source-location, or global-context-item options. Setting the option in the configuration file also affects documents read using the doc() or document() functions. Neither option affects documents supplied in the initial-match-selection option, or in any of the xxx-params options (such as stylesheet-params).

• vendor-options/saxon:write-result-documents. Since 13.0.

  The vendor option map {QName('http://saxon.sf.net/', 'write-result-documents'): true()} may be set to cause xsl:result-document instructions to write output directly to filestore, rather than returning them in the fn:transform result map. More specifically, if fn:transform is called from XSLT, then result documents produced by the target stylesheet are handled using the result document handler registered for the primary transformation; if it is invoked from XQuery, they are output using the default result document handler, which writes to filestore.

  Note that the default value of base-output-uri for the target transformation is taken from the current output base URI of the invoking transformation, assuming the invocation is from XSLT.

To enable use of XSLT 4.0 features in the called stylesheet, it is not enough simply to set xsl:stylesheet/@version="4.0" in the called stylesheet module. Instead, you need to do two things:

1. Ensure that 4.0 is enabled in the calling stylesheet (or query)

2. Use the option xslt-version="4.0" in the options passed to the fn:transform call.