Changes

This [[Module Library|XQuery Module]] contains functions and variables to perform XSLT XSL transformations.  By default, this module uses Java’s XSLT 1.0 Xalan implementation to transform documents. XSLT 23.0 is used instead will be enabled if Version 9.x or 10 of the [httphttps://www.saxonica.com/ Saxon XSLT Processor] ({{Code|saxon9he.jar}}, {{Code|saxon9pe.jar}}, {{Code|saxon9ee.jar}}) is found in the classpathclass path (see [[Startup#Distributions|Distributions]] for more details). A custom transformer can be specified by overwriting assigning a class to the system property {{Code|javax.xml.transform.TransformerFactory}}, as shown e.g. directly in the following Java example: <syntaxhighlight lang="java">System.setProperty( "javax.xml.transform.TransformerFactory", "org.custom.xslt.TransformerFactoryImpl");

</presyntaxhighlight>

|-valign="top"

|-valign="top"

|-valign="top"

|-valign="top"

|Returns the supported XSLT version (currently: "1.0" or "23.0"). "Unknown" is returned if a custom implementation was chosen.<br />

|-valign="top"

|{{Func|xslt:transform|$input as item(), $stylesheet as item()|node()}}<br />{{Func|xslt:transform|$input as item(), $stylesheet as item(), $params as map(*)?|node()}}<br />{{Func|xslt:transform|$input as item(), $stylesheet as item(), $params args as map(*)?, $options as map(*)?|node()}}|-valign="top"

The [[Catalog Resolver|XML Catalog files]] will be considered when resolving URIs. Variables can be bound to a stylesheet via {{Code|$paramsargs}} argument can be used to bind variables to a stylesheet. Only (only strings are supported when using Saxon (XSLT 23.0and Saxon). The following {{Code|$options}} are available:* {{Code|cache}}: cache XSLT transformer (speeds up repeated transformations, but may increase increases memory consumption)|-valign="top"

|-valign="top"

|{{Func|xslt:transform-text|$input as item(), $stylesheet as item()|xs:string}}<br />{{Func|xslt:transform-text|$input as item(), $stylesheet as item(), $params as map(*)?|xs:string}}<br />{{Func|xslt:transform-text|$input as item(), $stylesheet as item(), $params as map(*)?, $options as map(*)?|xs:string}}|-valign="top"

|Transforms the document specified by {{Code|$input}}, using the XSLT template specified by {{Code|$stylesheet}}, and returns the result as string. The semantics of {{Code|$params}} and {{Code|$options}} is the same as for [[#xslt:transform{{Function||xslt:transform]]}}.<br />|-valign="top"

==Examplesxslt:transform-report==

{| width='100%'|- valign="top"| width='Example 1120' | '''Signatures'''|{{Func|xslt:transform-report|$input as item(), $stylesheet as item()|xs:string}}<br />{{Func|xslt:transform-report|$input as item(), $stylesheet as item(), $params as map(*)?|xs:string}}<br />{{Func|xslt:transform-report|$input as item(), $stylesheet as item(), $params as map(*)?, $options as map(*)?|xs:string}}|- valign="top"| '''Summary'''|Transforms the document specified by {{Code|$input}}, using the XSLT template specified by {{Code|$stylesheet}}, and returns a map with the following keys: Basic XSL * {{Code|result}}: The transformation with dummy result: One or more document nodes, or (if the result cannot be converted to XML) an item of type {{Code|xs:untypedAtomic}}.* {{Code|messages}}: Informational output generated by {{Code|xsl:message}} elements: A sequence of arrays. The arrays consist of XML elements, or (for those messages that cannot be converted to XML) items of type {{Code|xs:untypedAtomic}}.The semantics of {{Code|$params}} and without parameters'''{{Code|$options}} is the same as for {{Function||xslt:transform}}.<br />For the moment, messages can only be returned with recent versions of Saxon.* {{Code|error}} (optional): An error string, which would be raised as an error by the other functions of this module.|}

'''Query:'''<pre class="brush:xquery">xslt:transform-text(<dummy/>, 'basic.xslt')</pre> '''basic.xslt'''<pre class="brush:xml"><xsl:stylesheet versionExamples='1.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform'> <xsl:template match="/">123</xsl:template></xsl:stylesheet></pre>

'''Result:'''<pre class="brush:xml">123</pre> '''Example 21: XSLT XSL transformation of an input document, with XML and XSL supplied as nodes'''

<pre classsyntaxhighlight lang="brush:xquery">

<xsl:stylesheet version='23.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform'>

return xslt:transform($in, $style)</presyntaxhighlight>

<pre classsyntaxhighlight lang="brush:xml">

</presyntaxhighlight> '''Example 2: Textual XSL transformation'''

'''Query:'''<syntaxhighlight lang="xquery">xslt:transform-text(<dummy/>, 'basic.xslt')</syntaxhighlight> '''basic.xslt'''<syntaxhighlight lang="xml"><xsl:stylesheet version='1.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform'> <xsl:template match="/">123</xsl:template></xsl:stylesheet></syntaxhighlight> '''Result:'''<syntaxhighlight lang="xml">123</syntaxhighlight> '''Example 3: Assigning a XSL transformation with variable to an XSLT stylesheetassignment'''

<pre classsyntaxhighlight lang="brush:xquery">

</presyntaxhighlight>

<pre classsyntaxhighlight lang="brush:xslt">

</presyntaxhighlight>

<pre classsyntaxhighlight lang="brush:xml">

</presyntaxhighlight> '''Example 4: XSL transformation, yielding a result and info messages''' '''Query:'''<syntaxhighlight lang="xquery">xslt:transform-report( <_/>, <xsl:transform version='2.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform'> <xsl:template match='/'> <xsl:message><msg>START...</msg></xsl:message> <xml>123</xml> <xsl:message select='4, 5, "...END"'/> </xsl:template> </xsl:transform>)</syntaxhighlight> '''Result:'''<syntaxhighlight lang="xquery">map { "messages": ([<msg>START...</msg>], ["4 5 ...END"]), "result": <xml>123</xml>}</syntaxhighlight>

|-valign="top"

* Updated: [[#xslt:transform{{Function||xslt:transform]]}}, [[#xslt:transform-text{{Function||xslt:transform-text]]}}: {{Code|$options}} argument added.

* Added: [[#xslt:transform-text{{Function||xslt:transform-text]]}}* Updated: [[#xslt:transform{{Function||xslt:transform]] }} returned error code

* Updated: $xslt:processor → [[#xslt:processor{{Function||xslt:processor]]}}, $xslt:version → [[#xslt:version{{Function||xslt:version]]}}