Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
<pre class="brush:java">
System.setProperty("javax.xml.transform.TransformerFactory", "org.custom.xslt.TransformerFactoryImpl");
The {{Code[[Catalog Resolver|$params}} argument XML Catalog files]] will be considered when resolving URIs. Variables can be used to bind variables bound to a stylesheet, which can either be specified<br />* as children of an via {{Code|<xslt:parameters/>$args}} element; e.g.:<pre class="brush:xml"><xslt:parameters> <xslt:key1 value='value1'/> ...</xslt:parameters></pre>* or as map, which contains all key/value pairs:<pre class="brush:xquery">map { "key1" := "value1", ... }</pre>Note that (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"
{{Mark|Introduced with Version 7.6}}
'''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'''
(: Turn whitespace chopping off. :)
declare option db:chop 'no';
* Updated: $xslt:processor → [[#xslt:processor|xslt:processor]], $xslt:version → [[#xslt:version|xslt:version]]
[[Category* Updated:XQuery]]$xslt:processor → {{Function||xslt:processor}}, $xslt:version → {{Function||xslt:version}}
no edit summary
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");
Context ctx = new Context();
String result = new XQuery("xslt:transform('...', '...')").execute(ctx);
...
ctx.close();
</presyntaxhighlight>
=Conventions=
All functions and errors in this module are assigned to the {{Code|<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|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
{| width='100%'
|-valign="top"| width='90120' | '''Signatures'''
|{{Code|'''xslt:processor'''() as xs:string}}<br />
|-valign="top"
| '''Summary'''
|Returns the name of the applied XSLT processor, or the path to a custom implementation (currently: "Java", "Saxon EE", "Saxon PE", or "Saxon HE").<br />
{| width='100%'
|-valign="top"| width='90120' | '''Signatures'''
|{{Code|'''xslt:version'''() as xs:string}}<br />
|-valign="top"
| '''Summary'''
|Returns the supported XSLT version (currently: "1.0" or "23.0"). "Unknown" is returned if a custom implementation was chosen.<br />
|}
==xslt:transform==
{| width='100%'
|-valign="top"| width='90120' | '''Signatures'''|{{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(), $args as map(*)?, $options as map(*)?|node()}}|-valign="top"
| '''Summary'''
|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,
* {{Code|xs:string}}, containing the document in its string representation, or
* {{Code|node()}}, containing the document itself.
| '''Error'''
|{{Error|BXSL0001error|#Errors}} an error occurred during the transformation process.
|}
==xslt:transform-text==
{| width='100%'
|-valign="top"| width='90120' | '''Signatures'''|{{Func|xslt:transform-text|$input as item(), $stylesheet as item()|nodexs: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 itemmap(*)|node?, $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 the result as string. The parameters have semantics of {{Code|$params}} and {{Code|$options}} is the same meaning as described for [[#xslt:transform{{Function||xslt:transform]]}}.<br />|-valign="top"
| '''Error'''
|{{Error|BXSL0001error|#Errors}} an error occurred during the transformation process.
|}
==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 classsyntaxhighlight lang="brush:xquery">
(: Outputs the result as html. :)
declare option output:method 'html';
let $in :=
</books>
let $style :=
<xsl:stylesheet version='23.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform'>
<xsl:output method='xml'/>
<xsl:template match="/">
</xsl:stylesheet>
return xslt:transform($in, $style)</presyntaxhighlight>
'''Result:'''
<pre classsyntaxhighlight lang="brush:xml">
<html>
<body>
</body>
</html>
</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'''
'''Query:'''
<pre classsyntaxhighlight lang="brush:xquery">
let $in := <dummy/>
let $style := doc('variable.xsl')
return ( xslt:transform($in, $style, <xslt:parameters><xslt:v>1</xslt:v></xslt:parameters>), xslt:transform($in, $style, map { "v" := 1 }))</presyntaxhighlight>
'''variable.xsltxsl'''<pre classsyntaxhighlight lang="brush:xslt">
<xsl:stylesheet version='1.0'
xmlns:xsl='http://www.w3.org/1999/XSL/Transform'>
</xsl:template>
</xsl:stylesheet>
</presyntaxhighlight>
'''Result:'''
<pre classsyntaxhighlight lang="brush:xml">
<v>1</v>
<v>1</v>
</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>
=Errors=
{| width='100%' class="wikitable" width="100%"! width="5%110"|Code! width="95%"|Description|-valign="top"|{{Code|BXSL0001error}}
| An error occurred during the transformation process.
|}
=Changelog=
;Version 9.7
* Added: {{Function||xslt:transform-report}}
;Version 9.2
* Updated: Support for XML Catalog files added.
;Version 9.0
* Updated: {{Function||xslt:transform}}, {{Function||xslt:transform-text}}: {{Code|$options}} argument added.
* Updated: error codes updated; errors now use the module namespace
;Version 7.6
* Added: [[#xslt:transform-text{{Function||xslt:transform-text]]}}* Updated: [[#xslt:transform{{Function||xslt:transform]] }} returned error code
;Version 7.3
