Saxon configuration annotations
Defines which Saxon edition is to be used.
Defines the location of the Saxon license file, as a URI relative to
the base URI of the configuration file. When made absolute, it must use the "file"
URI
scheme.
A label to identify this configuration or otherwise transmit textual
information into the execution.
Defines properties of the global configuration.
True if reflexive calls to external Java functions are allowed.
True if
saxon:threads attribute on xsl:for-each causes multi-threading
under Saxon-EE; false to disable multi-threading. Default is true (but
multi-threading only happens if explicitly requested using
saxon:threads).
True if reflexive calls to external Java functions are allowed to use the "liberal"
syntax (for example "http://my.com/extensions/ java.util.Date"). The default is to
allow only the "strict" form of URI such as "java:java.util.Date".
Enables use of (experimental and non-conformant) extensions to XPath syntax.
Defines the protocols (for example "file" and "http") that may be used in URIs resolved
by Saxon.
User-supplied class used to interpret collation URIs.
User-supplied class used for retrieving the
net.sf.saxon.lib.ResourceCollection to resolve the URI supplied to the
collection()
function.
Generates trace code in the expression tree, allowing a
net.sf.saxon.lib.TraceListener to be used at run-time.
Obsolete and ignored from Saxon 12.0.
Obsolete and ignored from Saxon 12.0.
(Requires Saxon-PE.) The collation URI to be used when no explicit collation is
requested.
The collection URI to be used when no argument is passed to the
collection()
function.
Determines which regular expression engine should be used for evaluating regular expressions.
Obsolete and ignored from Saxon 12.0.
Controls whether DTD validation is applied to input files.
Controls whether DTD validation errors are recoverable or fatal.
Forces Saxon to do eager evaluation of expressions in contexts where normally it would
do lazy evaluation,
for example when evaluating variables and function results. This can make for easier
debugging.
The class used whenever Saxon creates an XMLReader for parsing source
documents.
Defines the environment variable resolver for all queries and transforms using this
configuration. This affects the result of the XPath functions
available-environment-variables() and
environment-variable().
Defines the default ErrorListener for reporting both compile-time and
run-time errors.
Controls whether attribute default values found in a DTD or schema are expanded or
not.
Obsolete and ignored from Saxon 12.0.
Set to true to ignore the XMLReader supplied as a SAXSource
as input to an XSLT transformation, to use one specified by the parser
option instead.
Obsolete and ignored from Saxon 9.8.
Controls whether line and column number information is maintained for input
files.
Indicates that Saxon should retain the fact that attributes are derived
from defaults defined in a schema or DTD where this information is available from
the XML parser.
Obsolete and ignored from Saxon 12.0.
Obsolete and ignored from Saxon 12.0.
Defines the level of code optimization to be applied.
XML parser used for source documents.
If true, allows calls on
doc()
with a literal argument to be evaluated early, at compile time.
If true, query parameters such
as validation=strict will be recognized on URIs supplied to the
doc() or
document()
functions.
Sets a limit on the amount of backtracking performed during regular expression evaluation.
User-supplied class used to perform URI resolution. This resolver
is used at Configuration level, and may be supplemented by local
resolvers defined at task level, for example on an XsltCompiler,
XQueryCompiler, XsltTransformer, or XQueryEvaluator.
Indicates that the location information held in the run-time expression tree should
retain links to nodes in the
original stylesheet tree.
Controls whether schema validation is applied to input files.
Allows the serialization pipeline to be customized, for example to handle
user-defined serialization parameters.
Name of a user-supplied class that resolves unknown implementations of the JAXP
Source class into a known implementation.
Indicates that collections read using the fn:collection() function are
to be stable, that is, repeated calls with the same collection URI return identical
results.
Indicates that unparsed text files read using functions such as
fn:unparsed-text(), function are to be stable, that is,
repeated calls with the same URI return identical results.
Redirects output which would otherwise go to the stardard error output stream
System.err, to this file.
Determines the test applied to see if constructs are streamable (if streaming is
requested).
If true, then constructs for which streaming is requested will be exectued in
non-streaming mode if the code is not actually streamable.
Controls what whitespace is removed from input documents (all inter-element
whitespace, no inter-element whitespace, or all inter-element whitespace in elements
having element-only content models).
XML parser used for stylesheets and schema documents.
Suppresses the warning issued to indicate that an evaluation license in use is due
to
expire.
Suppresses all warnings issued by the XPath and XQuery parsers.
Suppresses the warning when there is no commonality between the namespaces used in
stylesheet match patterns and the namespaces used in the source document.
Defines a limit on the size of user-defined functions that will be inlined.
Obsolete and ignored from Saxon 12.0.
Outputs progress messages to System.err. Equivalent to the
-t option on the command line.
Provides diagnostics when external functions are dynamically loaded.
User-defined class to be used for handling run-time trace output.
Supplies a file as destination for trace listener output.
Causes tracing of decisions made by the optimizer.
Determines the tree model implementation used for input files: TinyTree, LinkedTree,
or TinyTree(condensed).
The class name of the UnparsedTextURIResolver to be used for deferencing
URIs used in calls on fn:unparsed-text() and related functions.
The URIResolver to be used for deferencing URIs used in
xsl:include,
xsl:import,
doc(), and
document().
When sending output to a user-defined content handler, indicates whether JAXP-defined
processing instructions are used to signal the start and end of text in which output
escaping is disabled.
If true, typed values of element and attribute nodes are cached in the TinyTree. Uses
extra memory, may make execution faster.
For result trees subjected to schema validation, indicates whether validation
failures should be treated as warnings rather than fatal errors.
Determines whether XML 1.0 or XML 1.1 rules are used.
Controls whether XInclude processing is applied to input files.
Defines what version of the XPath language may be used in XML Schema 1.1 assertions
and type alternatives.
Defines what version of the XPath language may be used in XSLT 3.0 stylesheets.
A regular expression used to decide whether a collection URI is to
be treated as representing a ZIP file. The default pattern is
"^jar:|\.jar$|\.zip$\.docx$\.xlsx$" which matches a URI that starts with "jar:"
or that ends with ".jar", ".zip", ".docx", or ".xlsx".
Defines configuration properties specific to XSLT processing.
If set, the use of the xsl:evaluate instruction in XSLT 3.0
is disabled.
Indicates whether assertions (XSLT 3.0 xsl:assert instructions) are enabled.
The name of a mode within a stylesheet in which execution should begin.
The name of a named template within a stylesheet where execution should begin.
From Saxon 11.1, this option has no effect.
Handles documents written using
xsl:result-document.
Previously used to indicate how XSLT recoverable errors were handled, but since the
XSLT 3.0 specification has eliminated these, the property is deprecated from Saxon
10.0.
Indicates the maximum number of threads to be used for processing
xsl:result-document instructions in parallel.
Indicates whether stylesheet should be compiled to be able to handle schema-typed
input, even if they contain no
xsl:import-schema declaration.
Receives reports of compile-time errors in a stylesheet.
User-defined class for dereferencing URIs on
xsl:include or
xsl:import.
Causes the XSLT processor to verify that constructs that are declared streamable are
in fact "guaranteed streamable" according to the W3C rules.
XML parser used for stylesheets and schema documents.
XSLT language version to be supported by the processor.
False suppresses the warning produced when the XSLT processor version is not the same
as the version in the xsl:stylesheet element. From Saxon 9.8, the
warning is no longer output, so this attribute is ignored.
Describes a user-supplied library of XSLT extension instructions.
The Java class that implements the extension instructions.
The namespace URI of the extension instructions implemented by this
extension library.
Defines configuration properties specific to XSLT processing with packages.
Defines an XSLT 3.0 package, or version of a package.
The package name. Must match the value in the name attribute of the xsl:package element,
unless the base attribute is present. When xsl:use-package searches for an appropriate package to use,
it is this name that will be matched.
The package version. Required. The numeric part of the version number must match the
value in the package-version
attribute of the xsl:package element; the NamePart (if any) can differ. When xsl:use-package
searches for an appropriate package to use, it is the version number in the configuration
file that is used, not the version
in the XSLT source.
The original package name. Required only if the package name defined in the name attribute differs from the
package name in the XSLT source. If present, the value must match the package name
defined in the XSLT source. Using this
attribute allows packages to be renamed. This is useful when a package has static
parameters whose values are bound in child
withParam elements: it allows two instances of a package to be made available (under different
names) with different
bindings for the static parameters.
The location (relative to the configuration file) of a representation of this package
in SEF (stylesheet export format) form.
If this attribute is present then the SEF form will always be used in preference to
the source form; the sourceLocation is then ignored,
and it is an error if any withParam children are present (because static parameters will have been bound when the SEF
was created).
It is entirely a user responsibility to keep the SEF form up-to-date with changes
to the source.
Used when there are several versions of a package available and the client does not
specify which version to use. The value
must be an integer. Versions
with higher priority are preferred over versions with lower priority or unspecified
priority; if the priorities are equal (or unspecified)
then the highest available version is used. The rules for ordering of version numbers
are given in section ยง3.5.1 of the
W3C specification.
Any convenient short name for the package name/version combination. This can be used
for convenience
as the value of the -xsl option on the Transform command line. (We suggest using a value that
is unlikely to be confused with a filename, for example * if the same stylesheet package is used all the time.)
The location (relative to the configuration file) of the source XSLT code of the top-level
module of the package.
Supplies values of static stylesheet parameters used during package
compilation.
The parameter name.
An XPath expression that is evaluated to give the value of the parameter (so a boolean
parameter might be written
select="true()", while a string parameter would be expressed as select="'London'").
Defines configuration properties specific to XQuery processing.
Indicates whether XQuery Update syntax is accepted.
Default value for construction mode in the static context.
Default namespace for elements and types.
Default namespace for functions.
True if the empty sequence comes first in sort order.
Default value for "inherit namespaces" in the static context.
Used for locating query modules referenced by "import module".
If set to true, the XQuery processor attempts to fetch an XQuery module appearing
in
an import module directive, whether or not a module with that module
URI has already been loaded, unless the location URI of the existing module is the
same as that of the requested module.
Policy for preserving boundary space within direct element content.
Default value for "preserve namespaces" in the static context.
The required type for the context item.
True if the query makes use of schema information.
Receives notification of static errors occurring in a Query.
Indicates the version of XQuery syntax that is accepted.
Defines configuration properties specific to XML Schema processing.
Indicates that the presence of an unresolved component reference in a schema
document does not automatically make the schema document invalid.
If true, allows a schema document to reference components in a different target namespace
without an explicit
xs:import declaration, provided the referenced components are already known.
If set to true, the schema processor attempts to fetch a schema document appearing
in
an xs:import directive, whether or not a schema for that namespace has
already been loaded.
Controls the limits applied to minOccurs and maxOccurs
values in XSD content models.
Controls the handling of URIs in xs:include, xs:import etc.
declarations, and also in xsi:schemaLocation.
Obsolete and ignored from Saxon 12.0.
Indicates whether the schema processor takes account of
xsi:schemaLocation and xsi:noNamespaceSchemaLocation
attributes appearing in the instance document.
Indicates whether XSD 1.1 syntax is accepted.
Defines defaults for serialization properties.
Used only for JSON output. Determines whether duplicate keys with the
same string value are allowed in a JSON map; if not an error is raised.
Indicates whether serialized output should include a byte order mark.
A list of element names whose content is to be serialized using CDATA sections.
The public identifier to be used in the DOCTYPE declaration.
The system identifier (URI) to be used in the DOCTYPE declaration.
The output encoding, for example utf-8 or us-ascii.
Used only for JSON output. Determines whether or not the solidus character ("/") is
escaped with a backslash (as "\/").
Defines whether URI-valued attributes in HTML/XHTML (for example href)
are to be %HH-encoded.
When the output method is HTML or XHTML, then if this attribute takes
decimal value 5.0, then the output produced is HTML 5.0 or XHTML 5.0 respectively.
Defines whether a <meta> element should be added to the
HTML <head> element to identify the media type of the output.
Defines whether indentation is to be added to the output.
Defines separator to be used between items in serialized output.
Used only for JSON output. Defines the serialization method for nodes,
for example 'xml' or 'html' or 'text'.
Defines the media type (MIME type) of the output.
Defines the serialization method, for example 'xml' or 'html' or 'text'.
Defines whether Unicode normalization should be applied during serialization,
and if so, which Unicode normalization form should be used.
Defines whether the XML declaration should be omitted from XML output.
Defines whether the XML declaration in XML output should have a 'standalone' attribute.
Defines a list of element names whose content should not be indented
even when indent='yes' is specified.
Defines whether namespaces present on a parent element but not on
its children should be undeclared using XML Namespaces 1.1 syntax.
Defines a list of the names of character maps which will be
applied to transform individual characters during serialization.
Defines the version of XML or HTML to be used for the output.
Defines additional classes available for integration purposes.
Defines an external object model (tree representation). The content is the
name of a Java class that implements net.sf.saxon.lib.ExternalObjectModel.
Defines an external function, implemented in Java, that can be called from
within an XPath expression. The content is the name of a Java class that implements
net.sf.saxon.lib.ExtensionFunctionDefinition.
Defines a mapping from file extensions to media types.
A file extension, for example "xq".
A media type corresponding to the file extension, for example
"text/plain". The media types that are recognised by default are: application/xml,
text/xml, application/html, text/html, application/atom, application/xml+xslt, and
application/xml+xsd (which return an XML node); text/plain, and application/java (which
return a string); application/binary (returns base64Binary); and application/json
(returns the result of parsing the JSON, typically a map or array).
Provides the location of a schema document that will be preloaded into the
configuration and made available to all queries and stylesheets.
Provides the location of a schema in Saxon's SCM format that will be
preloaded into the configuration and made available to all queries and stylesheets.
Defines collation URIs for use in queries and stylesheets.
Defines a collation URI for use in queries and stylesheets.
The collation URI as used in queries and stylesheets.
Indicates whether a sequence of digits within a string is to be treated
as a number, so that AB100 sorts after AB99.
Indicates whether lower-case letters sort before or after upper-case.
The name of a Java class that performs the string comparison.
Indicates whether composite (accented) Unicode characters should be
decomposed before sorting.
Indicates whether differences of case are to be ignored during
comparisons.
Indicates whether modifiers (such as accents and diacritical marks) are
to be ignored during comparisons.
Indicates whether punctuation symbols are to be ignored during
comparisons (.NET only).
Indicates whether width differences between characters are to be
ignored during comparisons.
Indicates the natural language of the text, for example 'en' for
English or 'de' for German.
Provides detailed sorting rules in the format of the Java
RuleBasedCollator class.
The strength of the collation: primary, secondary, or tertiary. These
terms are described in the Unicode Collation Algorithm.
Defines localization of the output of format-date(), format-number(), and
xsl:number. Note this relates to Saxon's native localization and has no effect when
ICU
localization is used.
The default country code for format-date() and similar functions. For
example 'FR' for France.
The default language code for format-date() and similar functions. For
example 'en-GB' for British English.
Defines localization of the output of format-date(), format-number(), and
xsl:number for a specific language.
The language to which this localization applies, for example 'fr-CA'
for Canadian French.
The Java class used to perform the localization.