2 XSLT Modules

2.1.1 Named template: xtlc:compare-documents as element(xtlc:message)*

Compares two XML documents with each other:

• Comments and processing instructions are ignored

• Text nodes are normalized before comparison

• Empty text nodes (after normalization) are ignored

• The comparison stops after the first difference is encountered.

• The result is either:

  • An empty set, when no differences found

  • One or more xtlc:message elements, status="error" when differences were found (you can only get more than one message on attribute differences)

2.2.1 Function: xtlc:day-in-year-number() as xs:integer

Computes the day number in the year: January 1 is 1, December 31 is 365 (or 366 in leap years).

2.2.2 Function: xtlc:days-in-month() as xs:integer

Computes the number of days in a particular month. If values are out of range it returns 0.

2.2.3 Function: xtlc:format-date-as-text() as xs:string

Formats a date as a string with the month name in full.

2.2.4 Function: xtlc:format-date-as-text-short() as xs:string

Formats a date as a string with the month name in short.

2.2.5 Function: xtlc:is-leap-year() as xs:boolean

Returns true when a given year is a leap year

2.2.6 Function: xtlc:month-name() as xs:string

Returns the name of a month.

2.2.7 Function: xtlc:month-name-short() as xs:string

Returns the name of a month in short (abbreviated to 3 characters).

2.2.8 Function: xtlc:to-date() as xs:date

Creates a date from its components.

2.2.9 Function: xtlc:unix-epoch() as xs:decimal

Computes the UNIX "epoch" code (number of seconds since 1-1-1970) for a given date/time.

2.2.10 Function: xtlc:week-number() as xs:integer

Computes the ISO week number for a given date.

2.2.11 Function: xtlc:weekday-name() as xs:string

Returns the name of a month.

2.2.12 Function: xtlc:weekday-number() as xs:integer

The number of the weekday (1=Monday, 7=Sunday).

2.3.1 Function: xtlc:duration2str() as xs:string

Turns a day/time duration into a more readable string, e.g. 1d3h40m12s

2.3.2 Function: xtlc:format-amount() as xs:string

Formats an amount by adding a € sign and always use double digits.

For the Dutch language, . and , are swapped.

2.3.3 Function: xtlc:format-double() as xs:string

Formats a double as a string with a given amount of digits.

For the Dutch language, . and , are swapped.

2.3.4 Function: xtlc:size2str() as xs:string

Turns an integer (e.g. a file size) into a (rounded) number using a Kb/Mb/Gb suffix.

2.4.1 Named template: xtlc:raise-error

Stops any processing by raising an error.

2.4.2 Function: xtlc:att2str() as xs:string

Turns an attribute into a string representation, suitable for display (e.g. name="value").

2.4.3 Function: xtlc:capitalize() as xs:string

Capitalizes a string (makes the first character uppercase).

2.4.4 Function: xtlc:char-repeat() as xs:string

Returns a string with a single character repeated a given number of times.

2.4.5 Function: xtlc:count-leading-whitespace() as xs:integer

Counts the number of whitespace characters at the beginning of a string

2.4.6 Function: xtlc:elm2str() as xs:string

Turns an element into a descriptive string (the element with all its attributes, excluding schema references).

2.4.7 Function: xtlc:item2element() as element()?

Tries to find the element belonging to a given item.

• When the item is of type xs:string or xs:anyURI, it is assumed to be a document reference. The root element of this is returned.

• When the item is of type document-node(), the root element of this document is returned

• When the item is of type element(), this is returned

You can choose whether to produce an error message or () when the item cannot be resolved.

2.4.8 Function: xtlc:items2str() as xs:string

Creates a string from a sequence of items.

Useful for easy creation of messages consisting of multiple parts and pieces.

2.4.9 Function: xtlc:prefix-to-length() as xs:string

Prefixes a string with a given character so it will get at least a given length.

2.4.10 Function: xtlc:q() as xs:string

Returns the input string quoted ("$in")

2.4.11 Function: xtlc:str2bln() as xs:boolean

Safe conversion of a string into a boolean.

When $in is empty or not convertible into a boolean, $default is returned.

2.4.12 Function: xtlc:str2filename-safe() as xs:string

Replaces all characters in a string that are not allowed in filenames with another character.

2.4.13 Function: xtlc:str2filename-safe() as xs:string

Replaces all characters in a string that are not allowed in filenames with an underscore.

2.4.14 Function: xtlc:str2id() as xs:string

Turns a string into a valid identifier, adding a prefix.

All characters that are not allowed in an identifier are converted into underscores.

When the result does not start with a letter or underscore, the prefix id- is added.

2.4.15 Function: xtlc:str2id() as xs:string

Turns a string into a valid identifier.

All characters that are not allowed in an identifier are converted into underscores.

When the result does not start with a letter or underscore, the prefix id- is added.

2.4.16 Function: xtlc:str2int() as xs:integer

Safe conversion of a string to an integer.

When $in is empty or not convertible to an integer, $default is returned.

2.4.17 Function: xtlc:str2regexp() as xs:string

Turns a string into a regular expression that matches the input exactly. Optionally anchors the regular expression so the match will be on this string only (result starts with ^ and ends with $).

2.4.18 Function: xtlc:str2regexp() as xs:string

Turns a string into a regular expression that matches the input exactly.

2.4.19 Function: xtlc:str2seq() as xs:string*

Converts a string with a list of words into a sequence of words.

2.4.20 Function: xtlc:text2lines() as xs:string*

Converts text into separate lines.

Uses the LF as separator; CRs are removed.

2.5.1 Function: xtlc:href-add-encoding() as xs:string

Percent encodes all "strange" characters (%xx). Any existing percentage encodings will be kept as is.

2.5.2 Function: xtlc:href-canonical() as xs:string

Makes an href canonical (remove any .. and . directory specifiers).

Examples:

• href-canonical('a/b/../c') ==> 'a/c'

2.5.3 Function: xtlc:href-concat() as xs:string

Performs a safe concatenation of href components:

• Translates all backslashes into slashes

• Makes sure that all components are separated with a single slash

• If somewhere in the list is an absolute path, the concatenation stops.

Examples:

• xtlc:href-concat(('a', 'b', 'c')) ==> 'a/b/c'

• xtlc:href-concat(('a', '/b', 'c')) ==> '/b/c'

2.5.4 Function: xtlc:href-decode-uri() as xs:string

Reverse function of encode-fo-uri(). Translates percent encodings (%xx) into their actual characters.

2.5.5 Function: xtlc:href-ext() as xs:string

Returns the extension part of an href.

Examples:

• xtlc:href-ext('a/b/c.xml') ==> 'xml'

• xtlc:href-ext('a/b/c') ==> ''

2.5.6 Function: xtlc:href-is-absolute() as xs:boolean

Returns true if the href is considered absolute.

An href is considered absolute when it starts with a / or \, contains a protocol specifier (e.g. file://) or starts with a Windows drive letter (e.g. C:).

2.5.7 Function: xtlc:href-name() as xs:string

Returns the (file)name part of an href.

Examples:

• xtlc:href-name('a/b/c') ==> 'c'

• xtlc:href-name('c') ==> 'c'

2.5.8 Function: xtlc:href-name-noext() as xs:string

Returns the (file)name part of an href without its extension.

Examples:

• xtlc:href-name-noext('a/b/c.xml') ==> 'c'

• xtlc:href-name-noext('a/b/c') ==> 'c'

2.5.9 Function: xtlc:href-noext() as xs:string

Returns the complete href path without its extension.

Examples:

• xtlc:href-noext('a/b/c.xml') ==> 'a/b/c'

• xtlc:href-noext('a/b/c') ==> 'a/b/c'

2.5.10 Function: xtlc:href-path() as xs:string

Returns the path part of an href.

Examples:

• xtlc:href-path('a/b/c') ==> 'a/b'

• xtlc:href-path('c') ==> ''

2.5.11 Function: xtlc:href-protocol() as xs:string

Returns the protocol part of an href (without the ://).

Examples:

• xtlc:href-protocol('http://…') ==> 'http'

2.5.12 Function: xtlc:href-protocol() as xs:string

Returns the protocol part of an href (without the ://) or a default value when none present.

Examples:

• xtlc:href-protocol('http://…', 'file') ==> 'http'

• xtlc:href-protocol('/a/b/c', 'file') ==> 'file'

2.5.13 Function: xtlc:href-protocol-add() as xs:string

Adds a protocol specifier (written without the trailing ://, e.g. http) to an href.

2.5.14 Function: xtlc:href-protocol-present() as xs:boolean

Returns true when an href has a protocol specifier (e.g. file:// or http://).

2.5.15 Function: xtlc:href-protocol-remove() as xs:string

Removes the protocol part from an href.

Examples:

• xtlc:protocol-remove('file:///a/b/c') ==> '/a/b/c'

Weird exceptions:

• xtlc:protocol-remove('file:/a/b/c') ==> '/a/b/c'

• xtlc:protocol-remove('file:/C:/a/b/c') ==> 'C:/a/b/c'

2.5.16 Function: xtlc:href-relative() as xs:string

Computes a relative href from one document to another.

Examples:

• href-relative('a/b/c/from.xml', 'a/b/to.xml') ==> '../to.xml'

• href-relative('a/b/c/from.xml', 'a/b/d/to.xml') ==> '../d/to.xml'

2.5.17 Function: xtlc:href-relative-from-path() as xs:string

Computes a relative href from a directory path to a document.

Examples:

• href-relative-from-path('a/b/c', 'a/b/to.xml') ==> '../to.xml'

• href-relative-from-path('a/b/c', 'a/b/d/to.xml') ==> '../d/to.xml'

2.5.18 Function: xtlc:href-result-doc() as xs:string

Transforms an href into something xsl:result-document/@href can use.

xsl:result-document/@href needs a file:// in front and has some strict rules about the formatting. The input to this function must be an absolute href!

2.6.1 Named template: xtlc:expand-macro-definitions

Expands macro definitions in text nodes and/or attribute values.

The template checks for <:macrodefs> elements that are the first child of any element. If so, any <:macrodef> children are used to define (or override) macro definitions. These elements can be in any namespace.

See also xsdmod/macrodefs.mod.xsd.

You can customize its functionality by using the template parameters.

2.6.2 Named template: xtlc:macrodefs-as-comment

Outputs a simple comment showing the contents of $macrodef-map.

2.6.3 Function: xtlc:expand-macrodefs() as xs:string

Expands macro definition references in a string against the macro definitions in $macrodef-map. Checks for circular references.

2.6.4 Function: xtlc:get-standard-macrodef-map() as map(xs:string, xs:string)

Returns a map with standard macro definitions. See the $xtlc:macrodef-standard-* global variable definitions.

2.6.5 Function: xtlc:merge-macrodefs() as map(xs:string, xs:string)

Merges multiple macro definition maps, taking care that newer definitions override existing ones. Will return an empty map if the input is the empty sequence.

2.7.1 Named template: xtlc:msg-create as element(xtlc:message)

Generates a standard xtlc:message element.

2.8.1 Function: xtlc:ext2mimetype() as xs:string

Turns an href extension (e.g. xml') into the correct MIME type ('text/xml').

When it cannot find an appropriate MIME type it returns the empty string.

2.8.2 Function: xtlc:mimetype2ext() as xs:string

Turns a MIME type (e.g. 'text/xml') into a corresponding href extension ('xml').

When it doesn't recognize the MIME type it returns the empty string.

2.9.1 Function: xtlc:expand-text-against-parameters() as xs:string

Expands parameter references in $text (either {$...} or ${...}) against the parameters in $parameter-map. If a parameter has multiple values, only the first one is used.

2.9.2 Function: xtlc:parameters-get() as map(xs:string, xs:string*)

Tries to locate a <parameters> element (in any namespace) underneath $root-item and processes the child <parameter> and <group> elements in here into a parameter map.

The <value> elements are filtered according to the entries in $filters.

Parameter references in values (either {$...} or ${...}). are expanded. If a parameter has multiple values, only the first one is used.

2.10.1 Function: xtlc:expand-simple-macros() as xs:string

Expands simple macro's in a string with values. All macros to expand must start with $xtlc:simple-macro-start-character ($), for instance: $DATE.

The substitution values are in a map. The keys must be the macro strings. For instance: map{'DATE': '2023-04-04', 'TIME': '16:04:35'}

2.10.2 Function: xtlc:expand-simple-macros() as xs:string

Expands simple macro's in a string with values. See xtlc:expand-simple-macros#3

2.11.1 Function: xtlc:get-uuid() as xs:string

Returns a random unique UUID (by calling an underlying Java function)

2.11.2 Function: xtlc:is-real-uuid() as xs:boolean

Checks whether a string contains a "real" UUID (conforms to the UUID formatting rules).

Example: 5EAE5C68-7394-48d7-A50B-1669E8D3A6C9 (upper/lower-case both admitted)