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 if Version 9.x of the [httphttps://www.saxonica.com/ Saxon XSLT Processor] is found in the class path ({{Code|saxon9hee.g.jar}}, {{Codeby placing the library files in the [[Startup#Full Distributions|saxon9pe.jar}}, {{Code|saxon9ee.jarlib/custom}}directory]]) is found in the classpath. A custom specific transformer can be specified by overwriting assigning a classpath to the system property {{Code|javax.xml.transform.TransformerFactory}}with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on the command line, as shown or directly in the following Java example: <pre lang="java">System.setProperty( "javax.xml.transform.TransformerFactory", "org.custom.xslt.TransformerFactoryImpl");

All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/xslt</nowiki></code> namespace, which is statically bound to the {{Code|xslt}} prefix.<br/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Code|'''xslt:processor'''() as xs:string}}<br />|-valign="top"

|Returns the name of the applied XSLT processor, or the path to a custom implementation (currently: "Java", "Saxon EE", "Saxon PE", or "Saxon HE"). If a system property was assigned that points to an existing implementation other than Saxon, the classpath is returned instead.<br />

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Code|'''xslt:version'''() as xs:string}}<br />|-valign="top"

|Returns the supported XSLT version (currently: "1.0" or , "23.0"). "Unknown" An empty string is returned if a custom classpath in the system property points to an existing implementation was chosenother than Saxon.<br />

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>xslt:transform|( $input as item(), $stylesheet as item()|node()}}<br />{{Func|xslt:transform|$input as item(), $stylesheet arguments as itemmap(*)? := map { }, $params options as map(xs*)? :string, xs:string= map { })|as node()}}</pre>|-valign="top"

|Transforms the document specified by {{Code|$input}}, using the XSLT template specified by {{Code|$stylesheet}}, and returns the result as node. {{Code|$input}} and {{Code|$stylesheet}} can be specified as<br />* {{Code|xs:string}}, containing the path to the documentstylesheet URI,

The [[Catalog Resolver|XML Catalog files]] will be considered when resolving URIs. Variables can be bound to a stylesheet via {{Code|$paramsarguments}} 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 increases memory consumption)|-valign="top"

|{{Error|BXSL0001error|#Errors}} an error occurred during the transformation process.

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>xslt:transform-text|( $input as item(), $stylesheet as item()|xs:string}}<br />{{Func|xslt:transform-text|$input as item(), $stylesheet arguments as itemmap(*)? := map { }, $params options as map(xs*)? :string, xs:string= map { })|as xs:string}}</pre>|-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"

|{{Error|BXSL0001error|#Errors}} an error occurred during the transformation process.

==Examplesxslt:transform-report==

{| width='100%'|- valign="top"| width='Example 1120' | '''Signature'''|<pre>xslt:transform-report( $input as item(), $stylesheet as item(), $arguments as map(*)? := map { }, $options as map(*)? := map { }) as xs:string</pre>|- 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 classlang="brush:'xquery"'>

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

<pre classlang="brush:xml">

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

<pre classlang="brush:'xquery"'>

<pre classlang="brush:xslt">

<pre classlang="brush:xml">

|-valign="top"|{{Code|BXSL0001error}}

 * 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]]}}