Difference between revisions of "XSLT Module"
Line 70: | Line 70: | ||
| '''Summary''' | | '''Summary''' | ||
|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|xslt:transform]].<br /> | |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|xslt:transform]].<br /> | ||
+ | |- | ||
+ | | '''Error''' | ||
+ | |{{Error|error|#Errors}} an error occurred during the transformation process. | ||
+ | |} | ||
+ | |||
+ | ==xslt:transform-report== | ||
+ | |||
+ | {{Mark|Introduced with Version 10.0:}} | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''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}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Transforms the document specified by {{Code|$input}}, using the XSLT template specified by {{Code|$stylesheet}}, and returns the result a map with the following keys: | ||
+ | * {{Code|result}}: The transformation result: A document node or an item of type {{Code|xs:untypedAtomic}}. | ||
+ | * {{Code|error}} (optional): An error string. | ||
+ | * {{Code|messages}}: Info output generated with the {{Code|xsl:message}} element: A sequence of arrays, containing the messages as XML elements or items of type {{Code|xs:untypedAtomic}}. | ||
+ | The semantics of {{Code|$params}} and {{Code|$options}} is the same as for [[#xslt:transform|xslt:transform]].<br /> | ||
|- | |- | ||
| '''Error''' | | '''Error''' | ||
Line 81: | Line 101: | ||
'''Query:''' | '''Query:''' | ||
<syntaxhighlight lang="xquery"> | <syntaxhighlight lang="xquery"> | ||
− | xslt:transform- | + | xslt:transform-report(<dummy/>, 'basic.xslt') |
</syntaxhighlight> | </syntaxhighlight> | ||
Line 169: | Line 189: | ||
<v>1</v> | <v>1</v> | ||
<v>1</v> | <v>1</v> | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | '''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> | </syntaxhighlight> | ||
Line 182: | Line 226: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 10.0 | ||
+ | * Added: [[#xslt:transform-report|xslt:transform-report]] | ||
;Version 9.2 | ;Version 9.2 |
Revision as of 10:49, 15 December 2021
This XQuery Module contains functions and variables to perform XSL transformations.
By default, this module uses Java’s XSLT 1.0 Xalan implementation to transform documents. XSLT 3.0 will be enabled if Version 9 or 10 of the Saxon XSLT Processor is found in the class path (see Distributions for more details). A custom transformer can be specified by assigning a class to the system property javax.xml.transform.TransformerFactory
, e.g. directly in Java:
<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(); </syntaxhighlight>
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/xslt
namespace, which is statically bound to the xslt
prefix.
Functions
xslt:processor
Signatures | xslt:processor() as xs:string |
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"). |
xslt:version
Signatures | xslt:version() as xs:string |
Summary | Returns the supported XSLT version (currently: "1.0" or "3.0"). "Unknown" is returned if a custom implementation was chosen. |
xslt:transform
Signatures | xslt:transform($input as item(), $stylesheet as item()) as node() xslt:transform($input as item(), $stylesheet as item(), $params as map(*)?) as node() xslt:transform($input as item(), $stylesheet as item(), $args as map(*)?, $options as map(*)?) as node()
|
Summary | Transforms the document specified by $input , using the XSLT template specified by $stylesheet , and returns the result as node. $input and $stylesheet can be specified as
XML Catalog files will be considered when resolving URIs. Variables can be bound to a stylesheet via
|
Error | error : an error occurred during the transformation process.
|
xslt:transform-text
Signatures | xslt:transform-text($input as item(), $stylesheet as item()) as xs:string xslt:transform-text($input as item(), $stylesheet as item(), $params as map(*)?) as xs:string xslt:transform-text($input as item(), $stylesheet as item(), $params as map(*)?, $options as map(*)?) as xs:string
|
Summary | Transforms the document specified by $input , using the XSLT template specified by $stylesheet , and returns the result as string. The semantics of $params and $options is the same as for xslt:transform. |
Error | error : an error occurred during the transformation process.
|
xslt:transform-report
Signatures | xslt:transform-report($input as item(), $stylesheet as item()) as xs:string xslt:transform-report($input as item(), $stylesheet as item(), $params as map(*)?) as xs:string xslt:transform-report($input as item(), $stylesheet as item(), $params as map(*)?, $options as map(*)?) as xs:string
|
Summary | Transforms the document specified by $input , using the XSLT template specified by $stylesheet , and returns the result a map with the following keys:
The semantics of |
Error | error : an error occurred during the transformation process.
|
Examples
Example 1: Basic XSL transformation with dummy document and without parameters
Query: <syntaxhighlight lang="xquery"> xslt:transform-report(<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 2: XSLT transformation of an input document
Query: <syntaxhighlight lang="xquery"> (: Outputs the result as html. :) declare option output:method 'html'; (: Turn whitespace chopping off. :) declare option db:chop 'no';
let $in :=
<books> <book> <title>XSLT Programmer’s Reference</title> <author>Michael H. Kay</author> </book> <book> <title>XSLT</title> <author>Doug Tidwell</author> <author>Simon St. Laurent</author> <author>Robert Romano</author> </book> </books>
let $style :=
<xsl:stylesheet version='3.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform'> <xsl:output method='xml'/> <xsl:template match="/">
<html>
<body>
<xsl:for-each select='books/book'> • <xsl:apply-templates select='title'/>: <xsl:value-of select='author'/>
</xsl:for-each>
</body>
</html>
</xsl:template> </xsl:stylesheet>
return xslt:transform($in, $style)</syntaxhighlight> Result: <syntaxhighlight lang="xml"> <html>
<body>
• XSLT Programmer’s Reference: Michael H. Kay
• XSLT: Doug Tidwell
</body>
</html> </syntaxhighlight>
Example 3: Assigning a variable to an XSLT stylesheet
Query: <syntaxhighlight lang="xquery"> let $in := <dummy/> let $style := doc('variable.xsl') return xslt:transform($in, $style, map { "v": 1 }) </syntaxhighlight>
variable.xsl <syntaxhighlight lang="xslt"> <xsl:stylesheet version='1.0'
xmlns:xsl='http://www.w3.org/1999/XSL/Transform'> <xsl:param name='v'/> <xsl:template match='/'> <v><xsl:value-of select='$v'/></v> </xsl:template>
</xsl:stylesheet> </syntaxhighlight>
Result: <syntaxhighlight lang="xml"> <v>1</v> <v>1</v> </syntaxhighlight>
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
Code | Description |
---|---|
error
|
An error occurred during the transformation process. |
Changelog
- Version 10.0
- Added: xslt:transform-report
- Version 9.2
- Updated: Support for XML Catalog files added.
- Version 9.0
- Updated: xslt:transform, xslt:transform-text:
$options
argument added. - Updated: error codes updated; errors now use the module namespace
- Version 7.6
- Added: xslt:transform-text
- Updated: xslt:transform returned error code
- Version 7.3
- Updated: $xslt:processor → xslt:processor, $xslt:version → xslt:version