XML Reference Manual

• Element (max. one)
• ProcessingInstruction
• Comment
• DocumentType

• ProcessingInstruction
• Comment
• Text
• CDATASection
• EntityReference

• ProcessingInstruction
• Comment
• Text
• CDATASection
• EntityReference

• Text
• Comment
• ProcessingInstruction
• CDATASection
• EntityReference

• Text
• EntityReference

• ProcessingInstruction
• Comment
• Text
• CDATASection
• EntityReference

Returns the object associated with the key on the node.

The object must be set to this node first, by calling setUserData with the same key.

The normalize() method removes empty text nodes and connects adjacent text nodes.

Normalizes all text nodes under the element (including attributes), where only structure (such as elements, comments, processing instructions, CDATA sections, and entity references) separates text nodes.

That is, there are no adjacent text nodes, nor empty text nodes.

If the attribute value is set in the document, return true;

If the attribute value is the default value in DTD/Schema, return false.

Specify the type of request, URL, whether the request should be processed asynchronously, and other optional properties of the request.

• method: Request type: GET or POST
• url: The location of the file on the server
• async: true (asynchronous) or false (synchronous)

Send the request to the server.

string: Used only for POST requests

Save the state of XMLHttpRequest. Changes from 0 to 4:

• 0: The request has not been initialized
• 1: The server connection has been established
• 2: The request has been received
• 3: The request is being processed
• 4: The request has been completed, and the response is ready

• fn:base-uri()
• fn:base-uri(node)

• fn:error()
• fn:error(error)
• fn:error(error,description)
• fn:error(error,description,error-object)

Example: error(fn:QName('http://example.com/test', 'err:toohigh'), 'Error: Price is too high')

Result: Returns http://example.com/test#toohigh to the external processing environment as well as the string "Error: Price is too high".

Returns the numeric value of the argument. The argument can be a boolean value, a string, or a node set.

Example: number('100')

Result: 100

Returns the absolute value of the parameter.

Example: abs(3.14)

Result: 3.14

Example: abs(-3.14)

Result: 3.14

Returns the smallest integer greater than the num parameter.

Example: ceiling(3.14)

Result: 4

Returns the largest integer that is not greater than the num parameter.

Example: floor(3.14)

Result: 3

Rounds the num parameter to the nearest integer.

Example: round(3.14)

Result: 3

Example: round-half-to-even(0.5)

Result: 0

Example: round-half-to-even(1.5)

Result: 2

Example: round-half-to-even(2.5)

Result: 2

Returns the string value of the argument. The argument can be a number, a logical value, or a node set.

Example: string(314)

Result: "314"

Returns a string from a sequence of code points.

Example: codepoints-to-string(84, 104, 233, 114, 232, 115, 101)

Result: 'Thérèse'

Returns a sequence of code points from a string.

Example: string-to-codepoints("Thérèse")

Result: 84, 104, 233, 114, 232, 115, 101

• fn:compare(comp1,comp2)
• fn:compare(comp1,comp2,collation)

If comp1 is less than comp2, return -1. If comp1 is equal to comp2, return 0. If comp1 is greater than comp2, return 1. (According to the used collation rules).

Example: compare('ghi', 'ghi')

Result: 0

Returns the concatenation of strings.

Example: concat('XPath ','is ','FUN!')

Result: 'XPath is FUN!'

Uses the sep parameter as a separator to return the concatenated string of the string parameter.

Example: string-join(('We', 'are', 'having', 'fun!'), ' ')

Result: ' We are having fun! '

Example: string-join(('We', 'are', 'having', 'fun!'))

Result: 'Wearehavingfun!'

Example: string-join((), 'sep')

Result: ''

• fn:substring(string,start,len)
• fn:substring(string,start)

Returns a substring of the specified length starting from the start position. The index of the first character is 1. If the len parameter is omitted, it returns the substring from position start to the end of the string.

Example: substring('Beatles',1,4)

Result: 'Beat'

Example: substring('Beatles',2)

Result: 'eatles'

• fn:string-length(string)
• fn:string-length()

Returns the length of the specified string. If no string parameter is provided, it returns the length of the string value of the current node.

Example: string-length('Beatles')

Result: 7

• fn:normalize-space(string)
• fn:normalize-space()

Removes leading and trailing whitespace from the specified string, replaces all internal sequences of whitespace with a single space, and then returns the result. If no string parameter is provided, it processes the current node.

Example: normalize-space(' The　　　XML ')

Result: 'The XML'

Converts the string parameter to uppercase.

Example: upper-case('The XML')

Result: 'THE XML'

Converts the string parameter to lowercase.

Example: lower-case('The XML')

Result: 'the xml'

Replaces string2 in string1 with string3.

Example: translate('12:30','30','45')

Result: '12:45'

Example: translate('12:30','03','54')

Result: '12:45'

Example: translate('12:30','0123','abcd')

Result: 'bc:da'

Example: escape-uri("http://example.com/test#car", true())

Result: "http%3A%2F%2Fexample.com%2Ftest#car"

Example: escape-uri("http://example.com/test#car", false())

Result: "http://example.com/test#car"

Example: escape-uri ("http://example.com/~bébé", false())

Result: "http://example.com/~b%C3%A9b%C3%A9"

If string1 contains string2, returns true, otherwise returns false.

Example: contains('XML','XM')

Result: true

If string1 starts with string2, returns true, otherwise returns false.

Example: starts-with('XML','X')

Result: true

If string1 ends with string2, returns true, otherwise returns false.

Example: ends-with('XML','X')

Result: false

Returns the substring before the occurrence of string2 in string1.

Example: substring-before('12/10','/')

Result: '12'

Returns the substring after the occurrence of string2 in string1.

Example: substring-after('12/10','/')

Result: '10'

Returns true if the string parameter matches the specified pattern, otherwise returns false.

Example: matches("Merano", "ran")

Result: true

Replaces the specified pattern with the replace parameter and returns the result.

Example: replace("Bella Italia", "l", "*")

Result: 'Be**a Ita*ia'

Example: replace("Bella Italia", "l", "")

Result: 'Bea Itaia'

Example: tokenize("XPath is fun", "\s+")

Result: ("XPath", "is", "fun")

First, restore the parameter to a boolean value using the boolean() function.

Returns true if the boolean value is false, otherwise returns true.

Example: not(true())

Result: false

Returns the boolean value true.

Example: true()

Result: true

Returns the boolean value false.

Example: false()

Result: false

Returns the integer representing the year part of the local value of the parameter.

Example: year-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 2005

Returns the integer representing the month part of the local value of the parameter.

Example: month-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 01

Returns the integer representing the day part of the local value of the parameter.

Example: day-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 10

Returns the integer representing the hours part of the local value of the parameter.

Example: hours-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 12

Returns the integer representing the minutes part of the local value of the parameter.

Example: minutes-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 30

Returns the decimal number representing the seconds part of the local value of the parameter.

Example: seconds-from-dateTime(xs:dateTime("2005-01-10T12:30:00-04:10"))

Result: 0

Returns the local value of the parameter as an integer representing the year.

Example: year-from-date(xs:date("2005-04-23"))

Result: 2005

Returns the integer representing the month of the local value of the parameter.

Example: month-from-date(xs:date("2005-04-23"))

Result: 4

Returns the integer representing the day of the local value of the parameter.

Example: day-from-date(xs:date("2005-04-23"))

Result: 23

Returns the integer representing the hours part of the local value of the parameter.

Example: hours-from-time(xs:time("10:22:00"))

Result: 10

Returns the integer representing the minutes part of the local value of the parameter.

Example: minutes-from-time(xs:time("10:22:00"))

Result: 22

Returns the integer representing the seconds part of the local value of the parameter.

Example: seconds-from-time(xs:time("10:22:00"))

Result: 0

If the timezone parameter is empty, return the dateTime without the time zone.

Otherwise, return the dateTime with the time zone.

If the timezone parameter is empty, return the date without the time zone.

Otherwise, return the date with the time zone.

If the timezone parameter is empty, return the time without the time zone.

Otherwise, return the time with the time zone.

• fn:name()
• fn:name(nodeset)

• fn:local-name()
• fn:local-name(nodeset)

• fn:namespace-uri()
• fn:namespace-uri(nodeset)

If the language of the current node matches the specified language, it returns true.

Example: Lang("en") is true for <p xml:lang="en">...</p>

Example: Lang("de") is false for <p xml:lang="en">...</p>

• fn:root()
• fn:root(node)

Returns the position in the item sequence that is equal to the searchitem parameter.

Example: index-of ((15, 40, 25, 40, 10), 40)

Result: (2, 4)

Example: index-of (("a", "dog", "and", "a", "duck"), "a")

Result (1, 4)

Example: index-of ((15, 40, 25, 40, 10), 18)

Result: ()

Returns a new sequence constructed by the item parameter - while deleting the item at the specified position.

Example: remove(("ab", "cd", "ef"), 0)

Result: ("ab", "cd", "ef")

Example: remove(("ab", "cd", "ef"), 1)

Result: ("cd", "ef")

Example: remove(("ab", "cd", "ef"), 4)

Result: ("ab", "cd", "ef")

If the parameter value is an empty sequence, it returns true, otherwise it returns false.

Example: empty(remove(("ab", "cd"), 1))

Result: false

Returns true if the parameter value is not an empty sequence, otherwise returns false.

Example: exists(remove(("ab"), 1))

Result: false

Returns unique different values.

Example: distinct-values((1, 2, 3, 1, 2))

Result: (1, 2, 3)

Returns a new sequence constructed by the item parameter - inserting the value of the inserts parameter at the position specified by the pos parameter.

Example: insert-before(("ab", "cd"), 0, "gh")

Result: ("gh", "ab", "cd")

Example: insert-before(("ab", "cd"), 1, "gh")

Result: ("gh", "ab", "cd")

Example: insert-before(("ab", "cd"), 2, "gh")

Result: ("ab", "gh", "cd")

Example: insert-before(("ab", "cd"), 5, "gh")

Result: ("ab", "cd", "gh")

Returns the reversed order of the specified items.

Example: reverse(("ab", "cd", "ef"))

Result: ("ef", "cd", "ab")

Example: reverse(("ab"))

Result: ("ab")

Returns the item sequence starting from the position specified by the start parameter, with a length specified by the len parameter.

The position of the first item is 1.

Example: subsequence(($item1, $item2, $item3,...), 3)

Result: ($item3, ...)

Example: subsequence(($item1, $item2, $item3, ...), 2, 2)

Result: ($item2, $item3)

Returns the average of the values of the arguments.

Example: avg((1,2,3))

Result: 2

Returns the argument that is greater than the other arguments.

Example: max((1,2,3))

Result: 3

Example: max(('a', 'k'))

Result: 'k'

Returns the argument that is less than the other arguments.

Example: min((1,2,3))

Result: 1

Example: min(('a', 'k'))

Result: 'a'

• fn:collection()
• fn:collection(string)

Returns the index position of the current node being processed.

Example: //book[position()<=3]

Result: Select the first three 'book' elements

Returns the number of items in the list of nodes being processed.

Example: //book[last()]

Result: Select the last book element