diff --git a/.gitignore b/.gitignore index c6a7ecc9..59ec847b 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ .DS_Store *.swp *.tmp +*~ # Project files that should not be in the repo .* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c44edcb0..062af59c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,16 +7,9 @@ Feel free to fork and improve/enhance Ace any way you want. If you feel that the There are two versions of the agreement: -1. [The Individual CLA](https://github.com/ajaxorg/ace/raw/master/doc/Contributor_License_Agreement-v2.pdf): use this version if you're working on an ajax.org in your spare time, or can clearly claim ownership of copyright in what you'll be submitting. -2. [The Corporate CLA](https://github.com/ajaxorg/ace/raw/master/doc/Corporate_Contributor_License_Agreement-v2.pdf): have your corporate lawyer review and submit this if your company is going to be contributing to ajax.org projects +1. [The Individual CLA](https://docs.google.com/a/c9.io/forms/d/1MfmfrxqD_PNlNsuK0lC2KSelRLxGLGfh_wEcG0ijVvo/viewform): use this version if you're working on the Cloud9 SDK or open source projects in your spare time, or can clearly claim ownership of copyright in what you'll be submitting. +2. [The Corporate CLA](https://docs.google.com/a/c9.io/forms/d/1vFejn4111GdnCNuQ6BfnJDaxdsUEMD4KCo1ayovAfu0/viewform): have your corporate lawyer review and submit this if your company is going to be contributing to the Cloud9 SDK and/or open source projects. -If you want to contribute to an ajax.org project please print the CLA and fill it out and sign it. Then either send it by snail mail or fax to us or send it back scanned (or as a photo) by email. +If you want to contribute to the Cloud9 SDK and/or open source projects please go to the online form, fill it out and submit it. -Email: ace+cla@c9.io - -Fax: +31 (0) 206388953 - -Address: Ajax.org B.V. - Keizersgracht 241 - 1016 EA, Amsterdam - the Netherlands \ No newline at end of file +Happy coding, Cloud9 diff --git a/ChangeLog.txt b/ChangeLog.txt index 8e1d8524..3077d171 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -1,3 +1,28 @@ +Version 1.2.0-pre + +* New Features + - Indented soft wrap (danyaPostfactum) + +* API Changes + - unified delta types `{start, end, action, lines}` (Alden Daniels https://github.com/ajaxorg/ace/pull/1745) + - "change" event listeners on session and editor get delta objects directly + +2015.04.03 Version 1.1.9 + + - Small Enhancements and Bugfixes + +2014.11.08 Version 1.1.8 + +* API Changes + - `editor.commands.commandKeyBinding` now contains direct map from keys to commands instead of grouping them by hashid + +* New Features + - Improved autoindent for html and php modes (Adam Jimenez) + - Find All from searchbox (Colton Voege) + +* new language modes + - Elixir, Elm + 2014.09.21 Version 1.1.7 * Bugfixes diff --git a/Makefile.dryice.js b/Makefile.dryice.js index a6082558..0ce7c657 100755 --- a/Makefile.dryice.js +++ b/Makefile.dryice.js @@ -120,6 +120,7 @@ function demo() { function changeComments(data) { return (data + .replace("doc/site/images/ace-logo.png", "demo/kitchen-sink/ace-logo.png") .replace(//g, "") .replace(/PACKAGE\-\->|

Creates a new Editor object.

-

Arguments

rendererVirtualRenderer

Required. Associated VirtualRenderer that draws everything

-
sessionEditSession

Required. The EditSession to refer to

+

Arguments

rendererVirtualRenderer

Required. Associated VirtualRenderer that draws everything

+
sessionEditSession

Required. The EditSession to refer to

@@ -444,7 +444,7 @@

Emitted whenever the document is changed.

-

Arguments

eObject

Required. Contains a single property, data, which has the delta of changes

+

Arguments

eObject

Required. Contains a single property, data, which has the delta of changes

@@ -471,7 +471,7 @@

Emitted when the selection style changes, via Editor.setSelectionStyle().

-

Arguments

dataObject

Required. Contains one property, data, which indicates the new selection style

+

Arguments

dataObject

Required. Contains one property, data, which indicates the new selection style

@@ -498,7 +498,7 @@

Emitted whenever the EditSession changes.

-

Arguments

eObject

Required. An object with two properties, oldSession and session, that represent the old and new EditSessions.

+

Arguments

eObject

Required. An object with two properties, oldSession and session, that represent the old and new EditSessions.

@@ -525,7 +525,7 @@

Emitted when text is copied.

-

Arguments

textString

Required. The copied text

+

Arguments

textString

Required. The copied text

@@ -564,7 +564,7 @@
    • -
    • Editor.on("paste", function(String text))
      • +
    • Editor.on("paste", function(Object e))
    @@ -577,7 +577,7 @@

    Emitted when text is pasted.

    -

    Arguments

    textString

    Required. The pasted text

    +

    Arguments

    eObject

    Required. An object which contains one property, text, that represents the text to be pasted. Editing this property will alter the text that is pasted.

    @@ -610,7 +610,7 @@

    Adds the selection and cursor.

    -

    Arguments

    orientedRangeRange

    Required. A range containing a cursor

    +

    Arguments

    orientedRangeRange

    Required. A range containing a cursor

    @@ -920,9 +920,9 @@

    Attempts to find needle within the document. For more information on options, see Search.

    -

    Arguments

    needleString

    Required. The text to search for (optional)

    -
    optionsObject

    Required. An object defining various search properties

    -
    animateBoolean

    Required. If true animate scrolling

    +

    Arguments

    needleString

    Required. The text to search for (optional)

    +
    optionsObject

    Required. An object defining various search properties

    +
    animateBoolean

    Required. If true animate scrolling

    @@ -954,9 +954,9 @@

    Finds and selects all the occurences of needle.

    -

    Arguments

    TheString

    Required. text to find

    -
    TheObject

    Required. search options

    -
    keepsBoolean

    Required.

    +

    Arguments

    TheString

    Required. text to find

    +
    TheObject

    Required. search options

    +
    keepsBoolean

    Required.

    @@ -983,8 +983,8 @@

    Performs another search for needle in the document. For more information on options, see Search.

    -

    Arguments

    optionsObject

    Required. search options

    -
    animateBoolean

    Required. If true animate scrolling

    +

    Arguments

    optionsObject

    Required. search options

    +
    animateBoolean

    Required. If true animate scrolling

    @@ -1011,8 +1011,8 @@

    Performs a search for needle backwards. For more information on options, see Search.

    -

    Arguments

    optionsObject

    Required. search options

    -
    animateBoolean

    Required. If true animate scrolling

    +

    Arguments

    optionsObject

    Required. search options

    +
    animateBoolean

    Required. If true animate scrolling

    @@ -1064,8 +1064,8 @@

    Executes a command for each selection range.

    -

    Arguments

    cmdString

    Required. The command to execute

    -
    argsString

    Required. Any arguments for the command

    +

    Arguments

    cmdString

    Required. The command to execute

    +
    argsString

    Required. Any arguments for the command

    @@ -1523,8 +1523,8 @@

    Works like EditSession.getTokenAt(), except it returns a number.

    -

    Arguments

    rowObject

    Required.

    -
    columnObject

    Required.

    +

    Arguments

    rowObject

    Required.

    +
    columnObject

    Required.

    @@ -1966,9 +1966,9 @@

    Moves the cursor to the specified line number, and also into the indiciated column.

    -

    Arguments

    lineNumberNumber

    Required. The line number to go to

    -
    columnNumber

    Required. A column number to go to

    -
    animateBoolean

    Required. If true animates scolling

    +

    Arguments

    lineNumberNumber

    Required. The line number to go to

    +
    columnNumber

    Required. A column number to go to

    +
    animateBoolean

    Required. If true animates scolling

    @@ -2070,7 +2070,7 @@

    Inserts text into wherever the cursor is pointing.

    -

    Arguments

    textString

    Required. The new text to add

    +

    Arguments

    textString

    Required. The new text to add

    @@ -2132,7 +2132,7 @@

    Indicates if the entire row is currently visible on the screen.

    -

    Arguments

    rowNumber

    Required. The row to check

    +

    Arguments

    rowNumber

    Required. The row to check

    @@ -2164,7 +2164,7 @@

    Indicates if the row is currently visible on the screen.

    -

    Arguments

    rowNumber

    Required. The row to check

    +

    Arguments

    rowNumber

    Required. The row to check

    @@ -2191,7 +2191,7 @@

    Moves the cursor's row and column to the next matching bracket.

    -

    Arguments

    selectObject

    Required.

    +

    Arguments

    selectObject

    Required.

    @@ -2218,7 +2218,7 @@

    If the character before the cursor is a number, this functions changes its value by amount.

    -

    Arguments

    amountNumber

    Required. The value to change the numeral by (can be negative to decrease value)

    +

    Arguments

    amountNumber

    Required. The value to change the numeral by (can be negative to decrease value)

    @@ -2245,8 +2245,8 @@

    Moves the cursor to the specified row and column. Note that this does not de-select the current selection.

    -

    Arguments

    rowNumber

    Required. The new row number

    -
    columnNumber

    Required. The new column number

    +

    Arguments

    rowNumber

    Required. The new row number

    +
    columnNumber

    Required. The new column number

    @@ -2273,7 +2273,7 @@

    Moves the cursor to the position indicated by pos.row and pos.column.

    -

    Arguments

    posObject

    Required. An object with two properties, row and column

    +

    Arguments

    posObject

    Required. An object with two properties, row and column

    @@ -2384,7 +2384,7 @@

    Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.

    -

    Arguments

    timesNumber

    Required. The number of times to change navigation

    +

    Arguments

    timesNumber

    Required. The number of times to change navigation

    @@ -2461,7 +2461,7 @@

    Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.

    -

    Arguments

    timesNumber

    Required. The number of times to change navigation

    +

    Arguments

    timesNumber

    Required. The number of times to change navigation

    @@ -2538,7 +2538,7 @@

    Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.

    -

    Arguments

    timesNumber

    Required. The number of times to change navigation

    +

    Arguments

    timesNumber

    Required. The number of times to change navigation

    @@ -2565,8 +2565,8 @@

    Moves the cursor to the specified row and column. Note that this does de-select the current selection.

    -

    Arguments

    rowNumber

    Required. The new row number

    -
    columnNumber

    Required. The new column number

    +

    Arguments

    rowNumber

    Required. The new row number

    +
    columnNumber

    Required. The new column number

    @@ -2593,7 +2593,7 @@

    Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.

    -

    Arguments

    timesNumber

    Required. The number of times to change navigation

    +

    Arguments

    timesNumber

    Required. The number of times to change navigation

    @@ -3105,7 +3105,7 @@

    Called whenever a text "paste" happens.

    -

    Arguments

    textString

    Required. The pasted text

    +

    Arguments

    textString

    Required. The pasted text

    @@ -3277,7 +3277,7 @@

    Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.

    -

    Arguments

    dirString

    Required. The direction of the deletion to occur, either "left" or "right"

    +

    Arguments

    dirString

    Required. The direction of the deletion to occur, either "left" or "right"

    @@ -3329,7 +3329,7 @@

    Removes the selection marker.

    -

    Arguments

    TheRange

    Required. selection range added with addSelectionMarker().

    +

    Arguments

    TheRange

    Required. selection range added with addSelectionMarker().

    @@ -3456,8 +3456,8 @@

    Replaces the first occurance of options.needle with the value in replacement.

    -

    Arguments

    replacementString

    Required. The text to replace with

    -
    optionsObject

    Required. The Search options to use

    +

    Arguments

    replacementString

    Required. The text to replace with

    +
    optionsObject

    Required. The Search options to use

    @@ -3484,8 +3484,8 @@

    Replaces all occurances of options.needle with the value in replacement.

    -

    Arguments

    replacementString

    Required. The text to replace with

    -
    optionsObject

    Required. The Search options to use

    +

    Arguments

    replacementString

    Required. The text to replace with

    +
    optionsObject

    Required. The Search options to use

    @@ -3512,7 +3512,7 @@

    Triggers a resize of the editor.

    -

    Arguments

    forceBoolean

    Required. If true, recomputes the size, even if the height and width haven't changed

    +

    Arguments

    forceBoolean

    Required. If true, recomputes the size, even if the height and width haven't changed

    @@ -3613,10 +3613,10 @@

    Scrolls to a line. If center is true, it puts the line in middle of screen (or attempts to).

    -

    Arguments

    lineNumber

    Required. The line to scroll to

    -
    centerBoolean

    Required. If true

    -
    animateBoolean

    Required. If true animates scrolling

    -
    callbackFunction

    Required. Function to be called when the animation has finished

    +

    Arguments

    lineNumber

    Required. The line to scroll to

    +
    centerBoolean

    Required. If true

    +
    animateBoolean

    Required. If true animates scrolling

    +
    callbackFunction

    Required. Function to be called when the animation has finished

    @@ -3643,7 +3643,7 @@

    Moves the editor to the specified row.

    -

    Arguments

    rowObject

    Required.

    +

    Arguments

    rowObject

    Required.

    @@ -3695,8 +3695,8 @@

    Finds the next occurence of text in an active selection and adds it to the selections.

    -

    Arguments

    dirNumber

    Required. The direction of lines to select: -1 for up, 1 for down

    -
    skipBoolean

    Required. If true, removes the active selection range

    +

    Arguments

    dirNumber

    Required. The direction of lines to select: -1 for up, 1 for down

    +
    skipBoolean

    Required. If true, removes the active selection range

    @@ -3723,8 +3723,8 @@

    Adds a cursor above or below the active cursor.

    -

    Arguments

    dirNumber

    Required. The direction of lines to select: -1 for up, 1 for down

    -
    skipBoolean

    Required. If true, removes the active selection range

    +

    Arguments

    dirNumber

    Required. The direction of lines to select: -1 for up, 1 for down

    +
    skipBoolean

    Required. If true, removes the active selection range

    @@ -3825,7 +3825,7 @@

    Specifies whether to use behaviors or not. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.

    -

    Arguments

    enabledBoolean

    Required. Enables or disables behaviors

    +

    Arguments

    enabledBoolean

    Required. Enables or disables behaviors

    @@ -3876,7 +3876,7 @@

    Sets the delay (in milliseconds) of the mouse drag.

    -

    Arguments

    dragDelayNumber

    Required. A value indicating the new delay

    +

    Arguments

    dragDelayNumber

    Required. A value indicating the new delay

    @@ -3927,7 +3927,7 @@

    Set a new font size (in pixels) for the editor text.

    -

    Arguments

    sizeNumber

    Required. A font size

    +

    Arguments

    sizeNumber

    Required. A font size

    @@ -3954,7 +3954,7 @@

    Determines whether or not the current line should be highlighted.

    -

    Arguments

    shouldHighlightBoolean

    Required. Set to true to highlight the current line

    +

    Arguments

    shouldHighlightBoolean

    Required. Set to true to highlight the current line

    @@ -4005,7 +4005,7 @@

    Determines if the currently selected word should be highlighted.

    -

    Arguments

    shouldHighlightBoolean

    Required. Set to true to highlight the currently selected word

    +

    Arguments

    shouldHighlightBoolean

    Required. Set to true to highlight the currently selected word

    @@ -4032,7 +4032,7 @@

    Sets a new key handler, such as "vim" or "windows".

    -

    Arguments

    keyboardHandlerString

    Required. The new key handler

    +

    Arguments

    keyboardHandlerString

    Required. The new key handler

    @@ -4059,7 +4059,7 @@

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

    -

    Arguments

    overwriteBoolean

    Required. Defines wheter or not to set overwrites

    +

    Arguments

    overwriteBoolean

    Required. Defines wheter or not to set overwrites

    @@ -4086,7 +4086,7 @@

    Sets the column defining where the print margin should be.

    -

    Arguments

    showPrintMarginNumber

    Required. Specifies the new print margin

    +

    Arguments

    showPrintMarginNumber

    Required. Specifies the new print margin

    @@ -4113,7 +4113,7 @@

    If readOnly is true, then the editor is set to read-only mode, and none of the content can change.

    -

    Arguments

    readOnlyBoolean

    Required. Specifies whether the editor can be modified or not

    +

    Arguments

    readOnlyBoolean

    Required. Specifies whether the editor can be modified or not

    @@ -4140,7 +4140,7 @@

    Sets how fast the mouse scrolling should do.

    -

    Arguments

    speedNumber

    Required. A value indicating the new speed (in milliseconds)

    +

    Arguments

    speedNumber

    Required. A value indicating the new speed (in milliseconds)

    @@ -4170,7 +4170,7 @@ although this code change in the future.

    This function also emits the 'changeSelectionStyle' event.

    -

    Arguments

    styleString

    Required. The new selection style

    +

    Arguments

    styleString

    Required. The new selection style

    @@ -4197,7 +4197,7 @@ although this code change in the future.

    Sets a new editsession to use. This method also emits the 'changeSession' event.

    -

    Arguments

    sessionEditSession

    Required. The new session to use

    +

    Arguments

    sessionEditSession

    Required. The new session to use

    @@ -4224,7 +4224,7 @@ although this code change in the future.

    Indicates whether the fold widgets are shown or not.

    -

    Arguments

    showBoolean

    Required. Specifies whether the fold widgets are shown

    +

    Arguments

    showBoolean

    Required. Specifies whether the fold widgets are shown

    @@ -4251,7 +4251,7 @@ although this code change in the future.

    If showInvisibles is set to true, invisible characters—like spaces or new lines—are show in the editor.

    -

    Arguments

    showInvisiblesBoolean

    Required. Specifies whether or not to show invisible characters

    +

    Arguments

    showInvisiblesBoolean

    Required. Specifies whether or not to show invisible characters

    @@ -4278,7 +4278,7 @@ although this code change in the future.

    If showPrintMargin is set to true, the print margin is shown in the editor.

    -

    Arguments

    showPrintMarginBoolean

    Required. Specifies whether or not to show the print margin

    +

    Arguments

    showPrintMarginBoolean

    Required. Specifies whether or not to show the print margin

    @@ -4305,7 +4305,7 @@ although this code change in the future.

    Adds a new class, style, to the editor.

    -

    Arguments

    styleString

    Required. A class name

    +

    Arguments

    styleString

    Required. A class name

    @@ -4332,7 +4332,7 @@ although this code change in the future.

    Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.

    -

    Arguments

    themeString

    Required. The path to a theme

    +

    Arguments

    themeString

    Required. The path to a theme

    @@ -4364,8 +4364,8 @@ although this code change in the future.

    Sets the current document to val.

    -

    Arguments

    valString

    Required. The new value to set for the document

    -
    cursorPosNumber

    Required. Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end

    +

    Arguments

    valString

    Required. The new value to set for the document

    +
    cursorPosNumber

    Required. Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end

    @@ -4394,7 +4394,7 @@ when such a character is typed in.

    Specifies whether to use wrapping behaviors or not, i.e. automatically wrapping the selection with characters such as brackets when such a character is typed in.

    -

    Arguments

    enabledBoolean

    Required. Enables or disables wrapping behaviors

    +

    Arguments

    enabledBoolean

    Required. Enables or disables wrapping behaviors

    @@ -4595,7 +4595,7 @@ when such a character is typed in.

    Transposes the selected ranges.

    -

    Arguments

    dirNumber

    Required. The direction to rotate selections

    +

    Arguments

    dirNumber

    Required. The direction to rotate selections

    @@ -4647,7 +4647,7 @@ when such a character is typed in.

    Removes the class style from the editor.

    -

    Arguments

    styleObject

    Required.

    +

    Arguments

    styleObject

    Required.

    diff --git a/build b/build index 17c02716..a4e495d8 160000 --- a/build +++ b/build @@ -1 +1 @@ -Subproject commit 17c02716b7f116c7920f8ef07c8c2b0e20d77ec0 +Subproject commit a4e495d8901876c6bafe3870a35cb8e32c827e97 diff --git a/build_support/mini_require.js b/build_support/mini_require.js index 88937f35..1ecbb78b 100644 --- a/build_support/mini_require.js +++ b/build_support/mini_require.js @@ -38,69 +38,62 @@ var ACE_NAMESPACE = ""; -var global = (function() { - return this; -})(); +var global = (function() { return this; })(); +if (!global && typeof window != "undefined") global = window; // strict mode if (!ACE_NAMESPACE && typeof requirejs !== "undefined") return; -var _define = function(module, deps, payload) { - if (typeof module !== 'string') { - if (_define.original) - _define.original.apply(window, arguments); +var define = function(module, deps, payload) { + if (typeof module !== "string") { + if (define.original) + define.original.apply(this, arguments); else { - console.error('dropping module because define wasn\'t a string.'); + console.error("dropping module because define wasn\'t a string."); console.trace(); } return; } - if (arguments.length == 2) payload = deps; - - if (!_define.modules) { - _define.modules = {}; - _define.payloads = {}; + if (!define.modules[module]) { + define.payloads[module] = payload; + define.modules[module] = null; } - - _define.payloads[module] = payload; - _define.modules[module] = null; }; +define.modules = {}; +define.payloads = {}; + /** * Get at functionality define()ed using the function above */ var _require = function(parentId, module, callback) { - if (Object.prototype.toString.call(module) === "[object Array]") { + if (typeof module === "string") { + var payload = lookup(parentId, module); + if (payload != undefined) { + callback && callback(); + return payload; + } + } else if (Object.prototype.toString.call(module) === "[object Array]") { var params = []; for (var i = 0, l = module.length; i < l; ++i) { var dep = lookup(parentId, module[i]); - if (!dep && _require.original) - return _require.original.apply(window, arguments); + if (dep == undefined && require.original) + return; params.push(dep); } - if (callback) { - callback.apply(null, params); - } + return callback && callback.apply(null, params) || true; } - else if (typeof module === 'string') { - var payload = lookup(parentId, module); - if (!payload && _require.original) - return _require.original.apply(window, arguments); +}; - if (callback) { - callback(); - } - - return payload; - } - else { - if (_require.original) - return _require.original.apply(window, arguments); - } +var require = function(module, callback) { + var packagedModule = _require("", module, callback); + if (packagedModule == undefined && require.original) + return require.original.apply(this, arguments); + return packagedModule; }; var normalizeModule = function(parentId, moduleName) { @@ -119,7 +112,6 @@ var normalizeModule = function(parentId, moduleName) { moduleName = moduleName.replace(/\/\.\//, "/").replace(/[^\/]+\/\.\.\//, ""); } } - return moduleName; }; @@ -128,12 +120,11 @@ var normalizeModule = function(parentId, moduleName) { * definition function if needed. */ var lookup = function(parentId, moduleName) { - moduleName = normalizeModule(parentId, moduleName); - var module = _define.modules[moduleName]; + var module = define.modules[moduleName]; if (!module) { - module = _define.payloads[moduleName]; + module = define.payloads[moduleName]; if (typeof module === 'function') { var exports = {}; var mod = { @@ -149,19 +140,15 @@ var lookup = function(parentId, moduleName) { var returnValue = module(req, exports, mod); exports = returnValue || mod.exports; - _define.modules[moduleName] = exports; - delete _define.payloads[moduleName]; + define.modules[moduleName] = exports; + delete define.payloads[moduleName]; } - module = _define.modules[moduleName] = exports || module; + module = define.modules[moduleName] = exports || module; } return module; }; function exportAce(ns) { - var require = function(module, callback) { - return _require("", module, callback); - }; - var root = global; if (ns) { if (!global[ns]) @@ -170,13 +157,13 @@ function exportAce(ns) { } if (!root.define || !root.define.packaged) { - _define.original = root.define; - root.define = _define; + define.original = root.define; + root.define = define; root.define.packaged = true; } if (!root.require || !root.require.packaged) { - _require.original = root.require; + require.original = root.require; root.require = require; root.require.packaged = true; } diff --git a/demo/autoresize.html b/demo/autoresize.html index 73a87599..b0464ecd 100644 --- a/demo/autoresize.html +++ b/demo/autoresize.html @@ -7,14 +7,13 @@ @@ -24,6 +23,8 @@ 
    minHeight = 2 lines
    +
    
+
    
 
    
 
 
@@ -46,6 +47,13 @@ require(["ace/ace"], function(ace) {
     editor2.setOption("maxLines", 30);
     editor2.setOption("minLines", 2);
 
+    var editor = ace.edit("editor3");
+    editor.setOptions({
+        autoScrollEditorIntoView: true,
+        maxLines: 8
+    });
+    editor.renderer.setScrollMargin(10, 10, 10, 10);
+    
     var editor = ace.edit("editor");
     editor.setTheme("ace/theme/tomorrow");
     editor.session.setMode("ace/mode/html");
diff --git a/demo/emmet.html b/demo/emmet.html
index 122085d9..bd0d4abe 100644
--- a/demo/emmet.html
+++ b/demo/emmet.html
@@ -23,7 +23,7 @@
 
    
 
 
-
+
 
 
 
 
+        
+    
+    
+        
    
+
+        
    
+        
+    
+
\ No newline at end of file
diff --git a/index.html b/index.html
index a82cf8a7..e2440eb1 100644
--- a/index.html
+++ b/index.html
@@ -196,8 +196,7 @@ console.log(addResult);
                             
    > See all themes
    
                             
    Setting the Programming Language Mode
    
                             
    By default, the editor supports plain text mode. All other language modes are available as separate modules, loaded on demand like this:
    
-                            
    editor.getSession().setMode("ace/mode/javascript");
-                            
    
+                            
    editor.getSession().setMode("ace/mode/javascript");
    
                              1);
+};
+var testRanges = function(str) {
+    assert.equal(editor.selection.getAllRanges() + "", str + "");
+};
+
+module.exports = {
+    "test: cstyle": function() {
+        function testValue(line) {
+            assert.equal(editor.getValue(), Array(4).join(line + "\n"));
+        }
+        function testSelection(line, col, inc) {
+            editor.selection.rangeList.ranges.forEach(function(r) {
+                assert.range(r, line, col, line, col);
+                line += (inc || 1);
+            });
+        }
+        var doc = new EditSession([
+            "",
+            "",
+            "",
+            ""
+        ], new JavaScriptMode());
+        editor = new Editor(new MockRenderer(), doc);
+        editor.setOption("behavioursEnabled", true);
+
+        editor.navigateFileStart();
+        exec("addCursorBelow", 2);
+
+        exec("insertstring", 1, "if ");
+        
+        // pairing ( 
+        exec("insertstring", 1, "(");
+        testValue("if ()");
+        testSelection(0, 4);
+        exec("insertstring", 1, ")");
+        testValue("if ()");
+        testSelection(0, 5);
+        
+        // pairing [ 
+        exec("gotoleft", 1);
+        exec("insertstring", 1, "[");
+        testValue("if ([])");
+        testSelection(0, 5);
+        
+        exec("insertstring", 1, "]");
+        testValue("if ([])");
+        testSelection(0, 6);
+        
+        // test deletion
+        exec("gotoleft", 1);
+        exec("backspace", 1);
+        testValue("if ()");
+        testSelection(0, 4);
+
+        exec("gotolineend", 1);
+        exec("insertstring", 1, "{");
+        testValue("if (){}");
+        testSelection(0, 6);
+        
+        exec("insertstring", 1, "}");
+        testValue("if (){}");
+        testSelection(0, 7);
+        
+        exec("gotolinestart", 1);
+        exec("insertstring", 1, "(");
+        testValue("(if (){}");
+        exec("backspace", 1);
+        
+        editor.setValue("");
+        exec("insertstring", 1, "{");
+        assert.equal(editor.getValue(), "{");
+        exec("insertstring", 1, "\n");
+        assert.equal(editor.getValue(), "{\n    \n}");
+        
+        editor.setValue("");
+        exec("insertstring", 1, "(");
+        exec("insertstring", 1, '"');
+        exec("insertstring", 1, '"');
+        assert.equal(editor.getValue(), '("")');
+        exec("backspace", 1);
+        exec("insertstring", 1, '"');
+        assert.equal(editor.getValue(), '("")');
+        
+        editor.setValue("('foo')", 1);
+        exec("gotoleft", 1);
+        exec("selectleft", 1);
+        exec("selectMoreBefore", 1);
+        exec("insertstring", 1, "'");
+        assert.equal(editor.getValue(), "('foo')");
+        exec("selectleft", 1);
+        exec("insertstring", 1, '"');
+        assert.equal(editor.getValue(), '("foo")');
+        exec("selectleft", 1);
+        exec("insertstring", 1, '"');
+        assert.equal(editor.getValue(), '("foo")');
+        
+        editor.setValue("", 1);
+        exec("selectleft", 1);
+        exec("insertstring", 1, '"');
+        assert.equal(editor.getValue(), '""');
+        exec("insertstring", 1, '\\');
+        exec("insertstring", 1, 'n');
+        exec("insertstring", 1, '"');
+        assert.equal(editor.getValue(), '"\\n"');
+        
+    },
+    "test: xml": function() {
+        editor = new Editor(new MockRenderer());
+        editor.setValue(["",
+            "    "
+        ].join("\n"));
+        editor.session.setMode(new XMLMode);
+        exec("gotolinedown", 1);
+        exec("gotolineend", 1);
+        exec("insertstring", 1, '\n');
+        assert.equal(editor.session.getLine(2), "    ");
+        exec("gotolineup", 1);
+        exec("gotolineend", 1);
+        exec("insertstring", 1, '\n');
+        assert.equal(editor.session.getLine(2), "    ");
+    }
+};
+
+});
+
+if (typeof module !== "undefined" && module === require.main) {
+    require("asyncjs").test.testcase(module.exports).exec();
+}
diff --git a/lib/ace/mode/behaviour/cstyle.js b/lib/ace/mode/behaviour/cstyle.js
index 2709168e..dd1b0d14 100644
--- a/lib/ace/mode/behaviour/cstyle.js
+++ b/lib/ace/mode/behaviour/cstyle.js
@@ -42,11 +42,11 @@ var SAFE_INSERT_BEFORE_TOKENS =
     ["text", "paren.rparen", "punctuation.operator", "comment"];
 
 var context;
-var contextCache = {}
+var contextCache = {};
 var initContext = function(editor) {
     var id = -1;
     if (editor.multiSelect) {
-        id = editor.selection.id;
+        id = editor.selection.index;
         if (contextCache.rangeCount != editor.multiSelect.rangeCount)
             contextCache = {rangeCount: editor.multiSelect.rangeCount};
     }
@@ -63,6 +63,19 @@ var initContext = function(editor) {
     };
 };
 
+var getWrapped = function(selection, selected, opening, closing) {
+    var rowDiff = selection.end.row - selection.start.row;
+    return {
+        text: opening + selected + closing,
+        selection: [
+                0,
+                selection.start.column + 1,
+                rowDiff,
+                selection.end.column + (rowDiff ? 0 : 1)
+            ]
+    };
+};
+
 var CstyleBehaviour = function() {
     this.add("braces", "insertion", function(state, action, editor, session, text) {
         var cursor = editor.getCursorPosition();
@@ -72,10 +85,7 @@ var CstyleBehaviour = function() {
             var selection = editor.getSelectionRange();
             var selected = session.doc.getTextRange(selection);
             if (selected !== "" && selected !== "{" && editor.getWrapBehavioursEnabled()) {
-                return {
-                    text: '{' + selected + '}',
-                    selection: false
-                };
+                return getWrapped(selection, selected, '{', '}');
             } else if (CstyleBehaviour.isSaneInsertion(editor, session)) {
                 if (/[\]\}\)]/.test(line[cursor.column]) || editor.inMultiSelectMode) {
                     CstyleBehaviour.recordAutoInsert(editor, session, "}");
@@ -155,10 +165,7 @@ var CstyleBehaviour = function() {
             var selection = editor.getSelectionRange();
             var selected = session.doc.getTextRange(selection);
             if (selected !== "" && editor.getWrapBehavioursEnabled()) {
-                return {
-                    text: '(' + selected + ')',
-                    selection: false
-                };
+                return getWrapped(selection, selected, '(', ')');
             } else if (CstyleBehaviour.isSaneInsertion(editor, session)) {
                 CstyleBehaviour.recordAutoInsert(editor, session, ")");
                 return {
@@ -203,10 +210,7 @@ var CstyleBehaviour = function() {
             var selection = editor.getSelectionRange();
             var selected = session.doc.getTextRange(selection);
             if (selected !== "" && editor.getWrapBehavioursEnabled()) {
-                return {
-                    text: '[' + selected + ']',
-                    selection: false
-                };
+                return getWrapped(selection, selected, '[', ']');
             } else if (CstyleBehaviour.isSaneInsertion(editor, session)) {
                 CstyleBehaviour.recordAutoInsert(editor, session, "]");
                 return {
@@ -252,56 +256,45 @@ var CstyleBehaviour = function() {
             var selection = editor.getSelectionRange();
             var selected = session.doc.getTextRange(selection);
             if (selected !== "" && selected !== "'" && selected != '"' && editor.getWrapBehavioursEnabled()) {
-                return {
-                    text: quote + selected + quote,
-                    selection: false
-                };
-            } else {
+                return getWrapped(selection, selected, quote, quote);
+            } else if (!selected) {
                 var cursor = editor.getCursorPosition();
                 var line = session.doc.getLine(cursor.row);
                 var leftChar = line.substring(cursor.column-1, cursor.column);
-
+                var rightChar = line.substring(cursor.column, cursor.column + 1);
+                
+                var token = session.getTokenAt(cursor.row, cursor.column);
+                var rightToken = session.getTokenAt(cursor.row, cursor.column + 1);
                 // We're escaped.
-                if (leftChar == '\\') {
+                if (leftChar == "\\" && token && /escape/.test(token.type))
                     return null;
+                
+                var stringBefore = token && /string|escape/.test(token.type);
+                var stringAfter = !rightToken || /string|escape/.test(rightToken.type);
+                
+                var pair;
+                if (rightChar == quote) {
+                    pair = stringBefore !== stringAfter;
+                } else {
+                    if (stringBefore && !stringAfter)
+                        return null; // wrap string with different quote
+                    if (stringBefore && stringAfter)
+                        return null; // do not pair quotes inside strings
+                    var wordRe = session.$mode.tokenRe;
+                    wordRe.lastIndex = 0;
+                    var isWordBefore = wordRe.test(leftChar);
+                    wordRe.lastIndex = 0;
+                    var isWordAfter = wordRe.test(leftChar);
+                    if (isWordBefore || isWordAfter)
+                        return null; // before or after alphanumeric
+                    if (rightChar && !/[\s;,.})\]\\]/.test(rightChar))
+                        return null; // there is rightChar and it isn't closing
+                    pair = true;
                 }
-
-                // Find what token we're inside.
-                var tokens = session.getTokens(selection.start.row);
-                var col = 0, token;
-                var quotepos = -1; // Track whether we're inside an open quote.
-
-                for (var x = 0; x < tokens.length; x++) {
-                    token = tokens[x];
-                    if (token.type == "string") {
-                      quotepos = -1;
-                    } else if (quotepos < 0) {
-                      quotepos = token.value.indexOf(quote);
-                    }
-                    if ((token.value.length + col) > selection.start.column) {
-                        break;
-                    }
-                    col += tokens[x].value.length;
-                }
-
-                // Try and be smart about when we auto insert.
-                if (!token || (quotepos < 0 && token.type !== "comment" && (token.type !== "string" || ((selection.start.column !== token.value.length+col-1) && token.value.lastIndexOf(quote) === token.value.length-1)))) {
-                    if (!CstyleBehaviour.isSaneInsertion(editor, session))
-                        return;
-                    return {
-                        text: quote + quote,
-                        selection: [1,1]
-                    };
-                } else if (token && token.type === "string") {
-                    // Ignore input and move right one if we're typing over the closing quote.
-                    var rightChar = line.substring(cursor.column, cursor.column + 1);
-                    if (rightChar == quote) {
-                        return {
-                            text: '',
-                            selection: [1, 1]
-                        };
-                    }
-                }
+                return {
+                    text: pair ? quote + quote : "",
+                    selection: [1,1]
+                };
             }
         }
     });
diff --git a/lib/ace/mode/behaviour/xml.js b/lib/ace/mode/behaviour/xml.js
index bd0574c6..068fdb31 100644
--- a/lib/ace/mode/behaviour/xml.js
+++ b/lib/ace/mode/behaviour/xml.js
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2010, Ajax.org B.V.
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *     * Redistributions of source code must retain the above copyright
@@ -14,7 +14,7 @@
  *     * Neither the name of Ajax.org B.V. nor the
  *       names of its contributors may be used to endorse or promote products
  *       derived from this software without specific prior written permission.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -34,6 +34,7 @@ define(function(require, exports, module) {
 var oop = require("../../lib/oop");
 var Behaviour = require("../behaviour").Behaviour;
 var TokenIterator = require("../../token_iterator").TokenIterator;
+var lang = require("../../lib/lang");
 
 function is(token, type) {
     return token.type.lastIndexOf(type + ".xml") > -1;
@@ -140,29 +141,61 @@ var XmlBehaviour = function () {
                  return;
 
             return {
-               text: '>' + '',
+               text: ">" + "",
                selection: [1, 1]
             };
         }
     });
 
-    this.add('autoindent', 'insertion', function (state, action, editor, session, text) {
+    this.add("autoindent", "insertion", function (state, action, editor, session, text) {
         if (text == "\n") {
             var cursor = editor.getCursorPosition();
             var line = session.getLine(cursor.row);
-            var rightChars = line.substring(cursor.column, cursor.column + 2);
-            if (rightChars == '")
+                    return;
+                //get tag name
+                while (token && token.type.indexOf("tag-name") === -1) {
+                    token = iterator.stepBackward();
+                }
+
+                if (!token) {
+                    return;
+                }
+
+                var tag = token.value;
+                var row = iterator.getCurrentTokenRow();
+
+                //don't indent after closing tag
+                token = iterator.stepBackward();
+                if (!token || token.type.indexOf("end-tag") !== -1) {
+                    return;
+                }
+
+                if (this.voidElements && !this.voidElements[tag]) {
+                    var nextToken = session.getTokenAt(cursor.row, cursor.column+1);
+                    var line = session.getLine(row);
+                    var nextIndent = this.$getIndent(line);
+                    var indent = nextIndent + session.getTabString();
+
+                    if (nextToken && nextToken.value === "]|%\/(?:0[xX][\da-fA-F](?:_*[\da-fA-F])*|0[cC][0-7](?:_*[0-7])*|0[bB][01](?:_*[01])*|\d(?:_*\d)*)\/)+?/;
+
     this.$rules = {
         "start": [{
-                token : "comment.line.double-dash",
-                regex : /--.*$/
-            }, {
-                token : "string.quoted.double",
-                regex : /"(?:%"|[^%])*?"/
-            }, {
-                token : "string.quoted.other", // "[ ]" aligned verbatim string
+                token : "string.quoted.other", // Aligned-verbatim-strings (verbatim option not supported)
                 regex : /"\[/,
                 next: "aligned_verbatim_string"
             }, {
-                token : "string.quoted.other", // "{ }" non-aligned verbatim string
+                token : "string.quoted.other", // Non-aligned-verbatim-strings (verbatim option not supported)
                 regex : /"\{/,
                 next: "non-aligned_verbatim_string"
+            }, {
+                token : "string.quoted.double",
+                regex : /"(?:[^%\b\f\n\r\v]|%[A-DFHLNQR-V%'"()<>]|%\/(?:0[xX][\da-fA-F](?:_*[\da-fA-F])*|0[cC][0-7](?:_*[0-7])*|0[bB][01](?:_*[01])*|\d(?:_*\d)*)\/)*?"/
+            }, {
+                token : "comment.line.double-dash",
+                regex : /--.*/
             }, {
                 token : "constant.character",
-                regex : /'(?:%%|%T|%R|%N|%F|%'|[^%])'/
+                regex : /'(?:[^%\b\f\n\r\t\v]|%[A-DFHLNQR-V%'"()<>]|%\/(?:0[xX][\da-fA-F](?:_*[\da-fA-F])*|0[cC][0-7](?:_*[0-7])*|0[bB][01](?:_*[01])*|\d(?:_*\d)*)\/)'/
             }, {
-                token : "constant.numeric", // real
-                regex : /(?:\d(?:_?\d)*\.|\.\d)(?:\d*[eE][+-]?\d+)?\b/
+                token : "constant.numeric", // hexa | octal | bin
+                regex : /\b0(?:[xX][\da-fA-F](?:_*[\da-fA-F])*|[cC][0-7](?:_*[0-7])*|[bB][01](?:_*[01])*)\b/
             }, {
-                token : "constant.numeric", // integer
-                regex : /\d(?:_?\d)*\b/
+                token : "constant.numeric",
+                regex : /(?:\d(?:_*\d)*)?\.(?:(?:\d(?:_*\d)*)?[eE][+-]?)?\d(?:_*\d)*|\d(?:_*\d)*\.?/
             }, {
-                token : "constant.numeric", // hex
-                regex : /0[xX][a-fA-F\d](?:_?[a-fA-F\d])*\b/
+                token : "paren.lparen",
+                regex : /[\[({]|<<|\|\(/
             }, {
-                token : "constant.numeric", // octal
-                regex : /0[cC][0-7](?:_?[0-7])*\b/
-            },{
-                token : "constant.numeric", // bin
-                regex : /0[bB][01](?:_?[01])*\b/
-            }, {
-                token : "keyword.operator",
-                regex : /\+|\-|\*|\/|\\\\|\/\/|\^|~|\/~|<|>|<=|>=|\/=|=|:=|\|\.\.\||\.\./
+                token : "paren.rparen",
+                regex : /[\])}]|>>|\|\)/
             }, {
                 token : "keyword.operator", // punctuation
-                regex : /\.|:|,|;\b/
+                regex : /:=|->|\.(?=\w)|[;,:?]/
+            }, {
+                token : "keyword.operator",
+                regex : /\\\\|\|\.\.\||\.\.|\/[~\/]?|[><\/]=?|[-+*^=~]/
             }, {
                 token : function (v) {
                     var result = keywordMapper (v);
@@ -106,33 +105,27 @@ var EiffelHighlightRules = function() {
                     return result;
                 },
                 regex : /[a-zA-Z][a-zA-Z\d_]*\b/
-            }, {
-                token : "paren.lparen",
-                regex : /[\[({]/
-            }, {
-                token : "paren.rparen",
-                regex : /[\])}]/
             }, {
                 token : "text",
                 regex : /\s+/
             }
         ],
         "aligned_verbatim_string" : [{
-                token : "string", // closing multi-line comment
+                token : "string",
                 regex : /]"/,
                 next : "start"
             }, {
-                token : "string", // comment spanning whole line
-                regex : /[^(?:\]")]+/
+                token : "string",
+                regex : simpleString
             }
         ],
         "non-aligned_verbatim_string" : [{
-                token : "string.quoted.other", // closing multi-line comment
+                token : "string.quoted.other",
                 regex : /}"/,
                 next : "start"
             }, {
-                token : "string.quoted.other", // comment spanning whole line
-                regex : /[^(?:\}")]+/
+                token : "string.quoted.other",
+                regex : simpleString
             }
         ]};
 };
diff --git a/lib/ace/mode/elixir.js b/lib/ace/mode/elixir.js
new file mode 100644
index 00000000..c55ea366
--- /dev/null
+++ b/lib/ace/mode/elixir.js
@@ -0,0 +1,58 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2012, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+/*
+  THIS FILE WAS AUTOGENERATED BY mode.tmpl.js
+*/
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var TextMode = require("./text").Mode;
+var ElixirHighlightRules = require("./elixir_highlight_rules").ElixirHighlightRules;
+// TODO: pick appropriate fold mode
+var FoldMode = require("./folding/coffee").FoldMode;
+
+var Mode = function() {
+    this.HighlightRules = ElixirHighlightRules;
+    this.foldingRules = new FoldMode();
+};
+oop.inherits(Mode, TextMode);
+
+(function() {
+    this.lineCommentStart = "#";
+    // this.blockComment = {start: ""/*"", end: ""*/""};
+    // Extra logic goes here.
+    this.$id = "ace/mode/elixir"
+}).call(Mode.prototype);
+
+exports.Mode = Mode;
+});
\ No newline at end of file
diff --git a/lib/ace/mode/elixir_highlight_rules.js b/lib/ace/mode/elixir_highlight_rules.js
new file mode 100644
index 00000000..a13492be
--- /dev/null
+++ b/lib/ace/mode/elixir_highlight_rules.js
@@ -0,0 +1,433 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2012, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+/* This file was autogenerated from https://raw.githubusercontent.com/elixir-lang/elixir-tmbundle/master/Syntaxes/Elixir.tmLanguage (uuid: ) */
+/****************************************************************************************
+ * IT MIGHT NOT BE PERFECT ...But it's a good start from an existing *.tmlanguage file. *
+ * fileTypes                                                                            *
+ ****************************************************************************************/
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var TextHighlightRules = require("./text_highlight_rules").TextHighlightRules;
+
+var ElixirHighlightRules = function() {
+    // regexp must not have capturing parentheses. Use (?:) instead.
+    // regexps are ordered -> the first match is used
+
+    this.$rules = { start: 
+       [ { token: 
+            [ 'meta.module.elixir',
+              'keyword.control.module.elixir',
+              'meta.module.elixir',
+              'entity.name.type.module.elixir' ],
+           regex: '^(\\s*)(defmodule)(\\s+)((?:[A-Z]\\w*\\s*\\.\\s*)*[A-Z]\\w*)' },
+         { token: 'comment.documentation.heredoc',
+           regex: '@(?:module|type)?doc (?:~[a-z])?"""',
+           push: 
+            [ { token: 'comment.documentation.heredoc',
+                regex: '\\s*"""',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'comment.documentation.heredoc' } ],
+           comment: '@doc with heredocs is treated as documentation' },
+         { token: 'comment.documentation.heredoc',
+           regex: '@(?:module|type)?doc ~[A-Z]"""',
+           push: 
+            [ { token: 'comment.documentation.heredoc',
+                regex: '\\s*"""',
+                next: 'pop' },
+              { defaultToken: 'comment.documentation.heredoc' } ],
+           comment: '@doc with heredocs is treated as documentation' },
+         { token: 'comment.documentation.heredoc',
+           regex: '@(?:module|type)?doc (?:~[a-z])?\'\'\'',
+           push: 
+            [ { token: 'comment.documentation.heredoc',
+                regex: '\\s*\'\'\'',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'comment.documentation.heredoc' } ],
+           comment: '@doc with heredocs is treated as documentation' },
+         { token: 'comment.documentation.heredoc',
+           regex: '@(?:module|type)?doc ~[A-Z]\'\'\'',
+           push: 
+            [ { token: 'comment.documentation.heredoc',
+                regex: '\\s*\'\'\'',
+                next: 'pop' },
+              { defaultToken: 'comment.documentation.heredoc' } ],
+           comment: '@doc with heredocs is treated as documentation' },
+         { token: 'comment.documentation.false',
+           regex: '@(?:module|type)?doc false',
+           comment: '@doc false is treated as documentation' },
+         { token: 'comment.documentation.string',
+           regex: '@(?:module|type)?doc "',
+           push: 
+            [ { token: 'comment.documentation.string',
+                regex: '"',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'comment.documentation.string' } ],
+           comment: '@doc with string is treated as documentation' },
+         { token: 'keyword.control.elixir',
+           regex: '\\b(?:do|end|case|bc|lc|for|if|cond|unless|try|receive|fn|defmodule|defp?|defprotocol|defimpl|defrecord|defstruct|defmacrop?|defdelegate|defcallback|defmacrocallback|defexception|defoverridable|exit|after|rescue|catch|else|raise|throw|import|require|alias|use|quote|unquote|super)\\b(?![?!])',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '(?_?\\h)*|\\d(?>_?\\d)*(\\.(?![^[:space:][:digit:]])(?>_?\\d)*)?([eE][-+]?\\d(?>_?\\d)*)?|0b[01]+|0o[0-7]+)\\b' },
+         { token: 'punctuation.definition.constant.elixir',
+           regex: ':\'',
+           push: 
+            [ { token: 'punctuation.definition.constant.elixir',
+                regex: '\'',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'constant.other.symbol.single-quoted.elixir' } ] },
+         { token: 'punctuation.definition.constant.elixir',
+           regex: ':"',
+           push: 
+            [ { token: 'punctuation.definition.constant.elixir',
+                regex: '"',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'constant.other.symbol.double-quoted.elixir' } ] },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '(?:\'\'\')',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '(?>\'\'\')',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '^\\s*\'\'\'',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'support.function.variable.quoted.single.heredoc.elixir' } ],
+           comment: 'Single-quoted heredocs' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '\'',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\'',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'support.function.variable.quoted.single.elixir' } ],
+           comment: 'single quoted string (allows for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '(?:""")',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '(?>""")',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '^\\s*"""',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.quoted.double.heredoc.elixir' } ],
+           comment: 'Double-quoted heredocs' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '"',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '"',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.quoted.double.elixir' } ],
+           comment: 'double quoted string (allows for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[a-z](?:""")',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '~[a-z](?>""")',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '^\\s*"""',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.quoted.double.heredoc.elixir' } ],
+           comment: 'Double-quoted heredocs sigils' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[a-z]\\{',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\}[a-z]*',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.interpolated.elixir' } ],
+           comment: 'sigil (allow for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[a-z]\\[',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\][a-z]*',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.interpolated.elixir' } ],
+           comment: 'sigil (allow for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[a-z]\\<',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\>[a-z]*',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.interpolated.elixir' } ],
+           comment: 'sigil (allow for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[a-z]\\(',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\)[a-z]*',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.interpolated.elixir' } ],
+           comment: 'sigil (allow for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[a-z][^\\w]',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '[^\\w][a-z]*',
+                next: 'pop' },
+              { include: '#interpolated_elixir' },
+              { include: '#escaped_char' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.interpolated.elixir' } ],
+           comment: 'sigil (allow for interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[A-Z](?:""")',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '~[A-Z](?>""")',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '^\\s*"""',
+                next: 'pop' },
+              { defaultToken: 'string.quoted.other.literal.upper.elixir' } ],
+           comment: 'Double-quoted heredocs sigils' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[A-Z]\\{',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\}[a-z]*',
+                next: 'pop' },
+              { defaultToken: 'string.quoted.other.literal.upper.elixir' } ],
+           comment: 'sigil (without interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[A-Z]\\[',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\][a-z]*',
+                next: 'pop' },
+              { defaultToken: 'string.quoted.other.literal.upper.elixir' } ],
+           comment: 'sigil (without interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[A-Z]\\<',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\>[a-z]*',
+                next: 'pop' },
+              { defaultToken: 'string.quoted.other.literal.upper.elixir' } ],
+           comment: 'sigil (without interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[A-Z]\\(',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '\\)[a-z]*',
+                next: 'pop' },
+              { defaultToken: 'string.quoted.other.literal.upper.elixir' } ],
+           comment: 'sigil (without interpolation)' },
+         { token: 'punctuation.definition.string.begin.elixir',
+           regex: '~[A-Z][^\\w]',
+           push: 
+            [ { token: 'punctuation.definition.string.end.elixir',
+                regex: '[^\\w][a-z]*',
+                next: 'pop' },
+              { defaultToken: 'string.quoted.other.literal.upper.elixir' } ],
+           comment: 'sigil (without interpolation)' },
+         { token: ['punctuation.definition.constant.elixir', 'constant.other.symbol.elixir'],
+           regex: '(:)([a-zA-Z_][\\w@]*(?:[?!]|=(?![>=]))?|\\<\\>|===?|!==?|<<>>|<<<|>>>|~~~|::|<\\-|\\|>|=>|~|~=|=|/|\\\\\\\\|\\*\\*?|\\.\\.?\\.?|>=?|<=?|&&?&?|\\+\\+?|\\-\\-?|\\|\\|?\\|?|\\!|@|\\%?\\{\\}|%|\\[\\]|\\^(?:\\^\\^)?)',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '(?[a-zA-Z_][\\w@]*(?>[?!]|=(?![>=]))?|\\<\\>|===?|!==?|<<>>|<<<|>>>|~~~|::|<\\-|\\|>|=>|~|~=|=|/|\\\\\\\\|\\*\\*?|\\.\\.?\\.?|>=?|<=?|&&?&?|\\+\\+?|\\-\\-?|\\|\\|?\\|?|\\!|@|\\%?\\{\\}|%|\\[\\]|\\^(\\^\\^)?)',
+           comment: 'symbols' },
+         { token: 'punctuation.definition.constant.elixir',
+           regex: '(?:[a-zA-Z_][\\w@]*(?:[?!])?):(?!:)',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '(?>[a-zA-Z_][\\w@]*(?>[?!])?)(:)(?!:)',
+           comment: 'symbols' },
+         { token: 
+            [ 'punctuation.definition.comment.elixir',
+              'comment.line.number-sign.elixir' ],
+           regex: '(#)(.*)' },
+         { token: 'constant.numeric.elixir',
+           regex: '\\?(?:\\\\(?:x[\\da-fA-F]{1,2}(?![\\da-fA-F])\\b|[^xMC])|[^\\s\\\\])',
+           TODO: 'FIXME: regexp doesn\'t have js equivalent',
+           originalRegex: '(?=?' },
+         { token: 'keyword.operator.bitwise.elixir',
+           regex: '\\|{3}|&{3}|\\^{3}|<{3}|>{3}|~{3}' },
+         { token: 'keyword.operator.logical.elixir',
+           regex: '!+|\\bnot\\b|&&|\\band\\b|\\|\\||\\bor\\b|\\bxor\\b',
+           originalRegex: '(?<=[ \\t])!+|\\bnot\\b|&&|\\band\\b|\\|\\||\\bor\\b|\\bxor\\b' },
+         { token: 'keyword.operator.arithmetic.elixir',
+           regex: '\\*|\\+|\\-|/' },
+         { token: 'keyword.operator.other.elixir',
+           regex: '\\||\\+\\+|\\-\\-|\\*\\*|\\\\\\\\|\\<\\-|\\<\\>|\\<\\<|\\>\\>|\\:\\:|\\.\\.|\\|>|~|=>' },
+         { token: 'keyword.operator.assignment.elixir', regex: '=' },
+         { token: 'punctuation.separator.other.elixir', regex: ':' },
+         { token: 'punctuation.separator.statement.elixir',
+           regex: '\\;' },
+         { token: 'punctuation.separator.object.elixir', regex: ',' },
+         { token: 'punctuation.separator.method.elixir', regex: '\\.' },
+         { token: 'punctuation.section.scope.elixir', regex: '\\{|\\}' },
+         { token: 'punctuation.section.array.elixir', regex: '\\[|\\]' },
+         { token: 'punctuation.section.function.elixir',
+           regex: '\\(|\\)' } ],
+      '#escaped_char': 
+       [ { token: 'constant.character.escape.elixir',
+           regex: '\\\\(?:x[\\da-fA-F]{1,2}|.)' } ],
+      '#interpolated_elixir': 
+       [ { token: 
+            [ 'source.elixir.embedded.source',
+              'source.elixir.embedded.source.empty' ],
+           regex: '(#\\{)(\\})' },
+         { todo: 
+            { token: 'punctuation.section.embedded.elixir',
+              regex: '#\\{',
+              push: 
+               [ { token: 'punctuation.section.embedded.elixir',
+                   regex: '\\}',
+                   next: 'pop' },
+                 { include: '#nest_curly_and_self' },
+                 { include: '$self' },
+                 { defaultToken: 'source.elixir.embedded.source' } ] } } ],
+      '#nest_curly_and_self': 
+       [ { token: 'punctuation.section.scope.elixir',
+           regex: '\\{',
+           push: 
+            [ { token: 'punctuation.section.scope.elixir',
+                regex: '\\}',
+                next: 'pop' },
+              { include: '#nest_curly_and_self' } ] },
+         { include: '$self' } ],
+      '#regex_sub': 
+       [ { include: '#interpolated_elixir' },
+         { include: '#escaped_char' },
+         { token: 
+            [ 'punctuation.definition.arbitrary-repitition.elixir',
+              'string.regexp.arbitrary-repitition.elixir',
+              'string.regexp.arbitrary-repitition.elixir',
+              'punctuation.definition.arbitrary-repitition.elixir' ],
+           regex: '(\\{)(\\d+)((?:,\\d+)?)(\\})' },
+         { token: 'punctuation.definition.character-class.elixir',
+           regex: '\\[(?:\\^?\\])?',
+           push: 
+            [ { token: 'punctuation.definition.character-class.elixir',
+                regex: '\\]',
+                next: 'pop' },
+              { include: '#escaped_char' },
+              { defaultToken: 'string.regexp.character-class.elixir' } ] },
+         { token: 'punctuation.definition.group.elixir',
+           regex: '\\(',
+           push: 
+            [ { token: 'punctuation.definition.group.elixir',
+                regex: '\\)',
+                next: 'pop' },
+              { include: '#regex_sub' },
+              { defaultToken: 'string.regexp.group.elixir' } ] },
+         { token: 
+            [ 'punctuation.definition.comment.elixir',
+              'comment.line.number-sign.elixir' ],
+           regex: '(?:^|\\s)(#)(\\s[[a-zA-Z0-9,. \\t?!-][^\\x00-\\x7F]]*$)',
+           originalRegex: '(?<=^|\\s)(#)\\s[[a-zA-Z0-9,. \\t?!-][^\\x{00}-\\x{7F}]]*$',
+           comment: 'We are restrictive in what we allow to go after the comment character to avoid false positives, since the availability of comments depend on regexp flags.' } ] }
+    
+    this.normalizeRules();
+};
+
+ElixirHighlightRules.metaData = { comment: 'Textmate bundle for Elixir Programming Language.',
+      fileTypes: [ 'ex', 'exs' ],
+      firstLineMatch: '^#!/.*\\belixir',
+      foldingStartMarker: '(after|else|catch|rescue|\\-\\>|\\{|\\[|do)\\s*$',
+      foldingStopMarker: '^\\s*((\\}|\\]|after|else|catch|rescue)\\s*$|end\\b)',
+      keyEquivalent: '^~E',
+      name: 'Elixir',
+      scopeName: 'source.elixir' }
+
+
+oop.inherits(ElixirHighlightRules, TextHighlightRules);
+
+exports.ElixirHighlightRules = ElixirHighlightRules;
+});
\ No newline at end of file
diff --git a/lib/ace/mode/folding/csharp.js b/lib/ace/mode/folding/csharp.js
index c4507534..ec9a2f48 100644
--- a/lib/ace/mode/folding/csharp.js
+++ b/lib/ace/mode/folding/csharp.js
@@ -110,8 +110,8 @@ oop.inherits(FoldMode, CFoldMode);
         var maxRow = session.getLength();
         var startRow = row;
         
-        var re = /^\s*#(end)?region\b/
-        var depth = 1
+        var re = /^\s*#(end)?region\b/;
+        var depth = 1;
         while (++row < maxRow) {
             line = session.getLine(row);
             var m = re.exec(line);
@@ -128,8 +128,7 @@ oop.inherits(FoldMode, CFoldMode);
 
         var endRow = row;
         if (endRow > startRow) {
-            var endColumn = line.search(/\S/);
-            return new Range(startRow, startColumn, endRow, endColumn);
+            return new Range(startRow, startColumn, endRow, line.length);
         }
     };
 
diff --git a/lib/ace/mode/folding/cstyle.js b/lib/ace/mode/folding/cstyle.js
index dd151e24..6a6abca7 100644
--- a/lib/ace/mode/folding/cstyle.js
+++ b/lib/ace/mode/folding/cstyle.js
@@ -48,12 +48,53 @@ var FoldMode = exports.FoldMode = function(commentRegex) {
 oop.inherits(FoldMode, BaseFoldMode);
 
 (function() {
-
+    
     this.foldingStartMarker = /(\{|\[)[^\}\]]*$|^\s*(\/\*)/;
     this.foldingStopMarker = /^[^\[\{]*(\}|\])|^[\s\*]*(\*\/)/;
+    this.singleLineBlockCommentRe= /^\s*(\/\*).*\*\/\s*$/;
+    this.tripleStarBlockCommentRe = /^\s*(\/\*\*\*).*\*\/\s*$/;
+    this.startRegionRe = /^\s*(\/\*|\/\/)#?region\b/;
+    
+    //prevent naming conflict with any modes that inherit from cstyle and override this (like csharp)
+    this._getFoldWidgetBase = this.getFoldWidget;
+    
+    /**
+     * Gets fold widget with some non-standard extras:
+     *
+     * @example lineCommentRegionStart
+     *      //#region [optional description]
+     *
+     * @example blockCommentRegionStart
+     *      /*#region [optional description] *[/]
+     *
+     * @example tripleStarFoldingSection
+     *      /*** this folds even though 1 line because it has 3 stars ***[/]
+     * 
+     * @note the pound symbol for region tags is optional
+     */
+    this.getFoldWidget = function(session, foldStyle, row) {
+        var line = session.getLine(row);
+    
+        if (this.singleLineBlockCommentRe.test(line)) {
+            // No widget for single line block comment unless region or triple star
+            if (!this.startRegionRe.test(line) && !this.tripleStarBlockCommentRe.test(line))
+                return "";
+        }
+    
+        var fw = this._getFoldWidgetBase(session, foldStyle, row);
+    
+        if (!fw && this.startRegionRe.test(line))
+            return "start"; // lineCommentRegionStart
+    
+        return fw;
+    };
 
     this.getFoldWidgetRange = function(session, foldStyle, row, forceMultiline) {
         var line = session.getLine(row);
+        
+        if (this.startRegionRe.test(line))
+            return this.getCommentRegionBlock(session, line, row);
+        
         var match = line.match(this.foldingStartMarker);
         if (match) {
             var i = match.index;
@@ -118,6 +159,33 @@ oop.inherits(FoldMode, BaseFoldMode);
         
         return new Range(startRow, startColumn, endRow, session.getLine(endRow).length);
     };
+    
+    /**
+     * gets comment region block with end region assumed to be start of comment in any cstyle mode or SQL mode (--) which inherits from this.
+     * There may optionally be a pound symbol before the region/endregion statement
+     */
+    this.getCommentRegionBlock = function(session, line, row) {
+        var startColumn = line.search(/\s*$/);
+        var maxRow = session.getLength();
+        var startRow = row;
+        
+        var re = /^\s*(?:\/\*|\/\/|--)#?(end)?region\b/;
+        var depth = 1;
+        while (++row < maxRow) {
+            line = session.getLine(row);
+            var m = re.exec(line);
+            if (!m) continue;
+            if (m[1]) depth--;
+            else depth++;
+
+            if (!depth) break;
+        }
+
+        var endRow = row;
+        if (endRow > startRow) {
+            return new Range(startRow, startColumn, endRow, line.length);
+        }
+    };
 
 }).call(FoldMode.prototype);
 
diff --git a/lib/ace/mode/folding/html_test.js b/lib/ace/mode/folding/html_test.js
index 2698d936..8291eae1 100644
--- a/lib/ace/mode/folding/html_test.js
+++ b/lib/ace/mode/folding/html_test.js
@@ -59,8 +59,8 @@ module.exports = {
         assert.equal(session.getFoldWidget(3), "end");
         assert.equal(session.getFoldWidget(4), "end");
         
-        assert.range(session.getFoldWidgetRange(0), 0, 8, 4, 0);
-        assert.range(session.getFoldWidgetRange(4), 0, 8, 4, 0);
+        assert.range(session.getFoldWidgetRange(0), 0, 31, 4, 0);
+        assert.range(session.getFoldWidgetRange(4), 0, 31, 4, 0);
         
         assert.range(session.getFoldWidgetRange(1), 1, 16, 3, 0);
         assert.range(session.getFoldWidgetRange(3), 1, 16, 3, 0);
@@ -85,8 +85,8 @@ module.exports = {
         assert.equal(session.getFoldWidget(3), "end");
         assert.equal(session.getFoldWidget(4), "end");
         
-        assert.range(session.getFoldWidgetRange(0), 0, 7, 4, 0);
-        assert.range(session.getFoldWidgetRange(4), 0, 7, 4, 0);
+        assert.range(session.getFoldWidgetRange(0), 0, 23, 4, 0);
+        assert.range(session.getFoldWidgetRange(4), 0, 23, 4, 0);
         
         assert.range(session.getFoldWidgetRange(1), 1, 17, 3, 4);
         assert.range(session.getFoldWidgetRange(3), 1, 17, 3, 4);
@@ -153,6 +153,30 @@ module.exports = {
         
         assert.range(session.getFoldWidgetRange(0), 0, 5, 5, 0);
         assert.range(session.getFoldWidgetRange(5), 0, 5, 5, 0);
+    },
+    
+    "test: fold multiple nested optional elements": function() {
+        var session = new EditSession([
+            '
    ',
+            '
  • ',
+            '
    juhu',
+            '
    ',
+            'kinners',
+            '
    • '
+        ]);
+        
+        var mode = new HtmlMode();
+        session.setMode(mode);
+        session.setFoldStyle("markbeginend");
+        
+        assert.equal(session.getFoldWidget(0), "start");
+        assert.equal(session.getFoldWidget(1), "start");
+        assert.equal(session.getFoldWidget(2), "start");
+        assert.equal(session.getFoldWidget(3), "start");
+        assert.equal(session.getFoldWidget(4), "");
+        assert.equal(session.getFoldWidget(5), "end");
+        
+        assert.range(session.getFoldWidgetRange(1), 1, 4, 5, 0);
     }
 };
 
diff --git a/lib/ace/mode/folding/sqlserver.js b/lib/ace/mode/folding/sqlserver.js
new file mode 100644
index 00000000..b3fd4e93
--- /dev/null
+++ b/lib/ace/mode/folding/sqlserver.js
@@ -0,0 +1,111 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../../lib/oop");
+var Range = require("../../range").Range;
+var BaseFoldMode = require("./cstyle").FoldMode;
+
+var FoldMode = exports.FoldMode = function() {};
+
+oop.inherits(FoldMode, BaseFoldMode);
+
+(function() {
+    /** 
+     * Inheriting cstyle folding because it handles the region comment folding 
+     * and special block comment folding appropriately.
+     * 
+     * Cstyle's getCommentRegionBlock() contains the sql comment characters '--' for end region block.
+     */
+    
+    this.foldingStartMarker = /(\bCASE\b|\bBEGIN\b)|^\s*(\/\*)/i;
+    // this.foldingStopMarker = /(\bEND\b)|^[\s\*]*(\*\/)/i;
+    this.startRegionRe = /^\s*(\/\*|--)#?region\b/;
+    
+    this.getFoldWidgetRange = function(session, foldStyle, row, forceMultiline) {
+        var line = session.getLine(row);
+    
+        if (this.startRegionRe.test(line)) return this.getCommentRegionBlock(session, line, row);
+    
+        var match = line.match(this.foldingStartMarker);
+        if (match) {
+            var i = match.index;
+            if (match[1]) return this.getBeginEndBlock(session, row, i, match[1]);
+    
+            var range = session.getCommentFoldRange(row, i + match[0].length, 1);
+            if (range && !range.isMultiLine()) {
+                if (forceMultiline) {
+                    range = this.getSectionRange(session, row);
+                }
+                else if (foldStyle != "all") range = null;
+            }
+    
+            return range;
+        }
+    
+        if (foldStyle === "markbegin") return;
+        //TODO: add support for end folding markers
+        return;
+    };
+    
+    /**
+     * @returns {range} folding block for sequence that starts with 'CASE' or 'BEGIN' and ends with 'END'
+     * @param {string} matchSequence - the sequence of charaters that started the fold widget, which should remain visible when the fold widget is folded
+     */
+    this.getBeginEndBlock = function(session, row, column, matchSequence) {
+        var start = {
+            row: row,
+            column: column + matchSequence.length
+        };
+        var maxRow = session.getLength();
+        var line;
+    
+        var depth = 1;
+        var re = /(\bCASE\b|\bBEGIN\b)|(\bEND\b)/i;
+        while (++row < maxRow) {
+            line = session.getLine(row);
+            var m = re.exec(line);
+            if (!m) continue;
+            if (m[1]) depth++;
+            else depth--;
+    
+            if (!depth) break;
+        }
+        var endRow = row;
+        if (endRow > start.row) {
+            return new Range(start.row, start.column, endRow, line.length);
+        }
+    };
+
+}).call(FoldMode.prototype);
+
+});
diff --git a/lib/ace/mode/folding/xml.js b/lib/ace/mode/folding/xml.js
index 3a353eba..7565bf15 100644
--- a/lib/ace/mode/folding/xml.js
+++ b/lib/ace/mode/folding/xml.js
@@ -192,9 +192,6 @@ function is(token, type) {
             if (!tag || top.tagName == tag.tagName) {
                 return stack.pop();
             }
-            else if (this.optionalEndTags.hasOwnProperty(tag.tagName)) {
-                return;
-            }
             else if (this.optionalEndTags.hasOwnProperty(top.tagName)) {
                 stack.pop();
                 continue;
@@ -220,6 +217,8 @@ function is(token, type) {
                 row: row,
                 column: firstTag.start.column + firstTag.tagName.length + 2
             };
+            if (firstTag.start.row == firstTag.end.row)
+                start.column = firstTag.end.column;
             while (tag = this._readTagForward(iterator)) {
                 if (tag.selfClosing) {
                     if (!stack.length) {
@@ -261,6 +260,8 @@ function is(token, type) {
                     this._pop(stack, tag);
                     if (stack.length == 0) {
                         tag.start.column += tag.tagName.length + 2;
+                        if (tag.start.row == tag.end.row && tag.start.column < tag.end.column)
+                            tag.start.column = tag.end.column;
                         return Range.fromPoints(tag.start, end);
                     }
                 }
diff --git a/lib/ace/mode/gherkin_highlight_rules.js b/lib/ace/mode/gherkin_highlight_rules.js
index d54db204..04ce877c 100644
--- a/lib/ace/mode/gherkin_highlight_rules.js
+++ b/lib/ace/mode/gherkin_highlight_rules.js
@@ -36,18 +36,18 @@ var stringEscape =  "\\\\(x[0-9A-Fa-f]{2}|[0-7]{3}|[\\\\abfnrtv'\"]|U[0-9A-Fa-f]
 
 var GherkinHighlightRules = function() {
 
-	// need to include constant ints
+    // need to include constant ints
     this.$rules = {
-    	start : [{
+        start : [{
             token: 'constant.numeric',
             regex: "(?:(?:[1-9]\\d*)|(?:0))"
- 		}, {
-    		token : "comment",
-    		regex : "#.*$"
-    	}, {
-    		token : "keyword",
-    		regex : "Feature:|Background:|Scenario:|Scenario\ Outline:|Examples:|Given|When|Then|And|But|\\*",
-    	}, {
+        }, {
+            token : "comment",
+            regex : "#.*$"
+        }, {
+            token : "keyword",
+            regex : "Feature:|Background:|Scenario:|Scenario\ Outline:|Examples:|Given|When|Then|And|But|\\*",
+        }, {
             token : "string",           // multi line """ string start
             regex : '"{3}',
             next : "qqstring3"
@@ -56,22 +56,22 @@ var GherkinHighlightRules = function() {
             regex : '"',
             next : "qqstring"
         }, {
-        	token : "comment",
-        	regex : "@[A-Za-z0-9]+",
-        	next : "start"
+            token : "comment",
+            regex : "@[A-Za-z0-9]+",
+            next : "start"
         }, {
-        	token : "comment",
-        	regex : "<.+>"
+            token : "comment",
+            regex : "<.+>"
         }, {
-        	token : "comment",
-        	regex : "\\| ",
-        	next : "table-item"
+            token : "comment",
+            regex : "\\|(?=.)",
+            next : "table-item"
         }, {
-        	token : "comment",
-        	regex : "\\|$",
-        	next : "start"
+            token : "comment",
+            regex : "\\|$",
+            next : "start"
         }],
-    	"qqstring3" : [ {
+        "qqstring3" : [ {
             token : "constant.language.escape",
             regex : stringEscape
         }, {
@@ -81,7 +81,7 @@ var GherkinHighlightRules = function() {
         }, {
             defaultToken : "string"
         }],
-    	"qqstring" : [{
+        "qqstring" : [{
             token : "constant.language.escape",
             regex : stringEscape
         }, {
@@ -96,15 +96,19 @@ var GherkinHighlightRules = function() {
             defaultToken: "string"
         }],
         "table-item" : [{
+            token : "comment",
+            regex : /$/,
+            next : "start"
+        }, {
+            token : "comment",
+            regex : /\|/
+        }, {
             token : "string",
-            regex : "[A-Za-z0-9 ]*",
-            next  : "start"
-        }],
+            regex : /\\./
+        }, {
+            defaultToken : "string"
+        }]
     };
-    
-    
-    //new TextHighlightRules().getRules();
-    
 }
 
 oop.inherits(GherkinHighlightRules, TextHighlightRules);
diff --git a/lib/ace/mode/handlebars.js b/lib/ace/mode/handlebars.js
index 38af7e5c..164ad43f 100644
--- a/lib/ace/mode/handlebars.js
+++ b/lib/ace/mode/handlebars.js
@@ -13,7 +13,6 @@ var Mode = function() {
     HtmlMode.call(this);
     this.HighlightRules = HandlebarsHighlightRules;
     this.$behaviour = new HtmlBehaviour();
-
     
     this.foldingRules = new HtmlFoldMode();
 };
@@ -21,7 +20,7 @@ var Mode = function() {
 oop.inherits(Mode, HtmlMode);
 
 (function() {
-    
+    this.blockComment = {start: "{{!--", end: "--}}"};
     this.$id = "ace/mode/handlebars";
 }).call(Mode.prototype);
 
diff --git a/lib/ace/mode/handlebars_highlight_rules.js b/lib/ace/mode/handlebars_highlight_rules.js
index c264afc1..f91a48ec 100644
--- a/lib/ace/mode/handlebars_highlight_rules.js
+++ b/lib/ace/mode/handlebars_highlight_rules.js
@@ -15,7 +15,7 @@ var HandlebarsHighlightRules = function() {
     var hbs = {
         regex : "(?={{)",
         push : "handlebars"
-    }
+    };
     for (var key in this.$rules) {
         this.$rules[key].unshift(hbs);
     }
@@ -40,22 +40,22 @@ var HandlebarsHighlightRules = function() {
             defaultToken : "comment"
         }]
     }, {
-        token : "storage.type.start", // begin section
-        regex : "{{[#\\^/&]?",
+        token : "support.function", // unescaped variable
+        regex : "{{{",
         push : [{
-            token : "storage.type.end",
-            regex : "}}",
+            token : "support.function",
+            regex : "}}}",
             next : pop2
         }, {
             token : "variable.parameter",
             regex : "[a-zA-Z_$][a-zA-Z0-9_$]*"
         }]
     }, {
-        token : "support.function", // unescaped variable
-        regex : "{{{",
+        token : "storage.type.start", // begin section
+        regex : "{{[#\\^/&]?",
         push : [{
-            token : "support.function",
-            regex : "}}}",
+            token : "storage.type.end",
+            regex : "}}",
             next : pop2
         }, {
             token : "variable.parameter",
diff --git a/lib/ace/mode/haskell_highlight_rules.js b/lib/ace/mode/haskell_highlight_rules.js
index fdfaa53e..04343ae9 100644
--- a/lib/ace/mode/haskell_highlight_rules.js
+++ b/lib/ace/mode/haskell_highlight_rules.js
@@ -55,9 +55,9 @@ var HaskellHighlightRules = function() {
          { token: 'constant.language.empty-list.haskell',
            regex: '\\[\\]' },
          { token: 'keyword.other.haskell',
-           regex: 'module',
+           regex: '\\bmodule\\b',
            push: 
-            [ { token: 'keyword.other.haskell', regex: 'where', next: 'pop' },
+            [ { token: 'keyword.other.haskell', regex: '\\bwhere\\b', next: 'pop' },
               { include: '#module_name' },
               { include: '#module_exports' },
               { token: 'invalid', regex: '[a-z]+' },
diff --git a/lib/ace/mode/html_highlight_rules.js b/lib/ace/mode/html_highlight_rules.js
index 9c9cc36f..4effa2aa 100644
--- a/lib/ace/mode/html_highlight_rules.js
+++ b/lib/ace/mode/html_highlight_rules.js
@@ -65,7 +65,7 @@ var HtmlHighlightRules = function() {
             include : "tag_whitespace"
         }, {
             token : "entity.other.attribute-name.xml",
-            regex : "[-_a-zA-Z0-9:]+"
+            regex : "[-_a-zA-Z0-9:.]+"
         }, {
             token : "keyword.operator.attribute-equals.xml",
             regex : "=",
@@ -89,7 +89,7 @@ var HtmlHighlightRules = function() {
                 return ["meta.tag.punctuation." + (start == "<" ? "" : "end-") + "tag-open.xml",
                     "meta.tag" + (group ? "." + group : "") + ".tag-name.xml"];
             },
-            regex : "(= 0 && length <= MAX_ARRAY_INDEX;
+  };
 
   // Collection Functions
   // --------------------
 
   // The cornerstone, an `each` implementation, aka `forEach`.
-  // Handles objects with the built-in `forEach`, arrays, and raw objects.
-  // Delegates to **ECMAScript 5**'s native `forEach` if available.
-  var each = _.each = _.forEach = function(obj, iterator, context) {
-    if (obj == null) return obj;
-    if (nativeForEach && obj.forEach === nativeForEach) {
-      obj.forEach(iterator, context);
-    } else if (obj.length === +obj.length) {
-      for (var i = 0, length = obj.length; i < length; i++) {
-        if (iterator.call(context, obj[i], i, obj) === breaker) return;
+  // Handles raw objects in addition to array-likes. Treats all
+  // sparse array-likes as if they were dense.
+  _.each = _.forEach = function(obj, iteratee, context) {
+    iteratee = optimizeCb(iteratee, context);
+    var i, length;
+    if (isArrayLike(obj)) {
+      for (i = 0, length = obj.length; i < length; i++) {
+        iteratee(obj[i], i, obj);
       }
     } else {
       var keys = _.keys(obj);
-      for (var i = 0, length = keys.length; i < length; i++) {
-        if (iterator.call(context, obj[keys[i]], keys[i], obj) === breaker) return;
+      for (i = 0, length = keys.length; i < length; i++) {
+        iteratee(obj[keys[i]], keys[i], obj);
       }
     }
     return obj;
   };
 
-  // Return the results of applying the iterator to each element.
-  // Delegates to **ECMAScript 5**'s native `map` if available.
-  _.map = _.collect = function(obj, iterator, context) {
-    var results = [];
-    if (obj == null) return results;
-    if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
-    each(obj, function(value, index, list) {
-      results.push(iterator.call(context, value, index, list));
-    });
+  // Return the results of applying the iteratee to each element.
+  _.map = _.collect = function(obj, iteratee, context) {
+    iteratee = cb(iteratee, context);
+    var keys = !isArrayLike(obj) && _.keys(obj),
+        length = (keys || obj).length,
+        results = Array(length);
+    for (var index = 0; index < length; index++) {
+      var currentKey = keys ? keys[index] : index;
+      results[index] = iteratee(obj[currentKey], currentKey, obj);
+    }
     return results;
   };
 
-  var reduceError = 'Reduce of empty array with no initial value';
+  // Create a reducing function iterating left or right.
+  function createReduce(dir) {
+    // Optimized iterator function as using arguments.length
+    // in the main function will deoptimize the, see #1991.
+    function iterator(obj, iteratee, memo, keys, index, length) {
+      for (; index >= 0 && index < length; index += dir) {
+        var currentKey = keys ? keys[index] : index;
+        memo = iteratee(memo, obj[currentKey], currentKey, obj);
+      }
+      return memo;
+    }
+
+    return function(obj, iteratee, memo, context) {
+      iteratee = optimizeCb(iteratee, context, 4);
+      var keys = !isArrayLike(obj) && _.keys(obj),
+          length = (keys || obj).length,
+          index = dir > 0 ? 0 : length - 1;
+      // Determine the initial value if none is provided.
+      if (arguments.length < 3) {
+        memo = obj[keys ? keys[index] : index];
+        index += dir;
+      }
+      return iterator(obj, iteratee, memo, keys, index, length);
+    };
+  }
 
   // **Reduce** builds up a single result from a list of values, aka `inject`,
-  // or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
-  _.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
-    var initial = arguments.length > 2;
-    if (obj == null) obj = [];
-    if (nativeReduce && obj.reduce === nativeReduce) {
-      if (context) iterator = _.bind(iterator, context);
-      return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
-    }
-    each(obj, function(value, index, list) {
-      if (!initial) {
-        memo = value;
-        initial = true;
-      } else {
-        memo = iterator.call(context, memo, value, index, list);
-      }
-    });
-    if (!initial) throw new TypeError(reduceError);
-    return memo;
-  };
+  // or `foldl`.
+  _.reduce = _.foldl = _.inject = createReduce(1);
 
   // The right-associative version of reduce, also known as `foldr`.
-  // Delegates to **ECMAScript 5**'s native `reduceRight` if available.
-  _.reduceRight = _.foldr = function(obj, iterator, memo, context) {
-    var initial = arguments.length > 2;
-    if (obj == null) obj = [];
-    if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
-      if (context) iterator = _.bind(iterator, context);
-      return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
-    }
-    var length = obj.length;
-    if (length !== +length) {
-      var keys = _.keys(obj);
-      length = keys.length;
-    }
-    each(obj, function(value, index, list) {
-      index = keys ? keys[--length] : --length;
-      if (!initial) {
-        memo = obj[index];
-        initial = true;
-      } else {
-        memo = iterator.call(context, memo, obj[index], index, list);
-      }
-    });
-    if (!initial) throw new TypeError(reduceError);
-    return memo;
-  };
+  _.reduceRight = _.foldr = createReduce(-1);
 
   // Return the first value which passes a truth test. Aliased as `detect`.
   _.find = _.detect = function(obj, predicate, context) {
-    var result;
-    any(obj, function(value, index, list) {
-      if (predicate.call(context, value, index, list)) {
-        result = value;
-        return true;
-      }
-    });
-    return result;
+    var key;
+    if (isArrayLike(obj)) {
+      key = _.findIndex(obj, predicate, context);
+    } else {
+      key = _.findKey(obj, predicate, context);
+    }
+    if (key !== void 0 && key !== -1) return obj[key];
   };
 
   // Return all the elements that pass a truth test.
-  // Delegates to **ECMAScript 5**'s native `filter` if available.
   // Aliased as `select`.
   _.filter = _.select = function(obj, predicate, context) {
     var results = [];
-    if (obj == null) return results;
-    if (nativeFilter && obj.filter === nativeFilter) return obj.filter(predicate, context);
-    each(obj, function(value, index, list) {
-      if (predicate.call(context, value, index, list)) results.push(value);
+    predicate = cb(predicate, context);
+    _.each(obj, function(value, index, list) {
+      if (predicate(value, index, list)) results.push(value);
     });
     return results;
   };
 
   // Return all the elements for which a truth test fails.
   _.reject = function(obj, predicate, context) {
-    return _.filter(obj, function(value, index, list) {
-      return !predicate.call(context, value, index, list);
-    }, context);
+    return _.filter(obj, _.negate(cb(predicate)), context);
   };
 
   // Determine whether all of the elements match a truth test.
-  // Delegates to **ECMAScript 5**'s native `every` if available.
   // Aliased as `all`.
   _.every = _.all = function(obj, predicate, context) {
-    predicate || (predicate = _.identity);
-    var result = true;
-    if (obj == null) return result;
-    if (nativeEvery && obj.every === nativeEvery) return obj.every(predicate, context);
-    each(obj, function(value, index, list) {
-      if (!(result = result && predicate.call(context, value, index, list))) return breaker;
-    });
-    return !!result;
+    predicate = cb(predicate, context);
+    var keys = !isArrayLike(obj) && _.keys(obj),
+        length = (keys || obj).length;
+    for (var index = 0; index < length; index++) {
+      var currentKey = keys ? keys[index] : index;
+      if (!predicate(obj[currentKey], currentKey, obj)) return false;
+    }
+    return true;
   };
 
   // Determine if at least one element in the object matches a truth test.
-  // Delegates to **ECMAScript 5**'s native `some` if available.
   // Aliased as `any`.
-  var any = _.some = _.any = function(obj, predicate, context) {
-    predicate || (predicate = _.identity);
-    var result = false;
-    if (obj == null) return result;
-    if (nativeSome && obj.some === nativeSome) return obj.some(predicate, context);
-    each(obj, function(value, index, list) {
-      if (result || (result = predicate.call(context, value, index, list))) return breaker;
-    });
-    return !!result;
+  _.some = _.any = function(obj, predicate, context) {
+    predicate = cb(predicate, context);
+    var keys = !isArrayLike(obj) && _.keys(obj),
+        length = (keys || obj).length;
+    for (var index = 0; index < length; index++) {
+      var currentKey = keys ? keys[index] : index;
+      if (predicate(obj[currentKey], currentKey, obj)) return true;
+    }
+    return false;
   };
 
   // Determine if the array or object contains a given value (using `===`).
-  // Aliased as `include`.
-  _.contains = _.include = function(obj, target) {
-    if (obj == null) return false;
-    if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
-    return any(obj, function(value) {
-      return value === target;
-    });
+  // Aliased as `includes` and `include`.
+  _.contains = _.includes = _.include = function(obj, target, fromIndex) {
+    if (!isArrayLike(obj)) obj = _.values(obj);
+    return _.indexOf(obj, target, typeof fromIndex == 'number' && fromIndex) >= 0;
   };
 
   // Invoke a method (with arguments) on every item in a collection.
@@ -256,7 +293,8 @@ module.exports = {
     var args = slice.call(arguments, 2);
     var isFunc = _.isFunction(method);
     return _.map(obj, function(value) {
-      return (isFunc ? method : value[method]).apply(value, args);
+      var func = isFunc ? method : value[method];
+      return func == null ? func : func.apply(value, args);
     });
   };
 
@@ -268,60 +306,76 @@ module.exports = {
   // Convenience version of a common use case of `filter`: selecting only objects
   // containing specific `key:value` pairs.
   _.where = function(obj, attrs) {
-    return _.filter(obj, _.matches(attrs));
+    return _.filter(obj, _.matcher(attrs));
   };
 
   // Convenience version of a common use case of `find`: getting the first object
   // containing specific `key:value` pairs.
   _.findWhere = function(obj, attrs) {
-    return _.find(obj, _.matches(attrs));
+    return _.find(obj, _.matcher(attrs));
   };
 
-  // Return the maximum element or (element-based computation).
-  // Can't optimize arrays of integers longer than 65,535 elements.
-  // See [WebKit Bug 80797](https://bugs.webkit.org/show_bug.cgi?id=80797)
-  _.max = function(obj, iterator, context) {
-    if (!iterator && _.isArray(obj) && obj[0] === +obj[0] && obj.length < 65535) {
-      return Math.max.apply(Math, obj);
-    }
-    var result = -Infinity, lastComputed = -Infinity;
-    each(obj, function(value, index, list) {
-      var computed = iterator ? iterator.call(context, value, index, list) : value;
-      if (computed > lastComputed) {
-        result = value;
-        lastComputed = computed;
+  // Return the maximum element (or element-based computation).
+  _.max = function(obj, iteratee, context) {
+    var result = -Infinity, lastComputed = -Infinity,
+        value, computed;
+    if (iteratee == null && obj != null) {
+      obj = isArrayLike(obj) ? obj : _.values(obj);
+      for (var i = 0, length = obj.length; i < length; i++) {
+        value = obj[i];
+        if (value > result) {
+          result = value;
+        }
       }
-    });
+    } else {
+      iteratee = cb(iteratee, context);
+      _.each(obj, function(value, index, list) {
+        computed = iteratee(value, index, list);
+        if (computed > lastComputed || computed === -Infinity && result === -Infinity) {
+          result = value;
+          lastComputed = computed;
+        }
+      });
+    }
     return result;
   };
 
   // Return the minimum element (or element-based computation).
-  _.min = function(obj, iterator, context) {
-    if (!iterator && _.isArray(obj) && obj[0] === +obj[0] && obj.length < 65535) {
-      return Math.min.apply(Math, obj);
-    }
-    var result = Infinity, lastComputed = Infinity;
-    each(obj, function(value, index, list) {
-      var computed = iterator ? iterator.call(context, value, index, list) : value;
-      if (computed < lastComputed) {
-        result = value;
-        lastComputed = computed;
+  _.min = function(obj, iteratee, context) {
+    var result = Infinity, lastComputed = Infinity,
+        value, computed;
+    if (iteratee == null && obj != null) {
+      obj = isArrayLike(obj) ? obj : _.values(obj);
+      for (var i = 0, length = obj.length; i < length; i++) {
+        value = obj[i];
+        if (value < result) {
+          result = value;
+        }
       }
-    });
+    } else {
+      iteratee = cb(iteratee, context);
+      _.each(obj, function(value, index, list) {
+        computed = iteratee(value, index, list);
+        if (computed < lastComputed || computed === Infinity && result === Infinity) {
+          result = value;
+          lastComputed = computed;
+        }
+      });
+    }
     return result;
   };
 
-  // Shuffle an array, using the modern version of the
+  // Shuffle a collection, using the modern version of the
   // [Fisher-Yates shuffle](http://en.wikipedia.org/wiki/Fisher–Yates_shuffle).
   _.shuffle = function(obj) {
-    var rand;
-    var index = 0;
-    var shuffled = [];
-    each(obj, function(value) {
-      rand = _.random(index++);
-      shuffled[index - 1] = shuffled[rand];
-      shuffled[rand] = value;
-    });
+    var set = isArrayLike(obj) ? obj : _.values(obj);
+    var length = set.length;
+    var shuffled = Array(length);
+    for (var index = 0, rand; index < length; index++) {
+      rand = _.random(0, index);
+      if (rand !== index) shuffled[index] = shuffled[rand];
+      shuffled[rand] = set[index];
+    }
     return shuffled;
   };
 
@@ -330,27 +384,20 @@ module.exports = {
   // The internal `guard` argument allows it to work with `map`.
   _.sample = function(obj, n, guard) {
     if (n == null || guard) {
-      if (obj.length !== +obj.length) obj = _.values(obj);
+      if (!isArrayLike(obj)) obj = _.values(obj);
       return obj[_.random(obj.length - 1)];
     }
     return _.shuffle(obj).slice(0, Math.max(0, n));
   };
 
-  // An internal function to generate lookup iterators.
-  var lookupIterator = function(value) {
-    if (value == null) return _.identity;
-    if (_.isFunction(value)) return value;
-    return _.property(value);
-  };
-
-  // Sort the object's values by a criterion produced by an iterator.
-  _.sortBy = function(obj, iterator, context) {
-    iterator = lookupIterator(iterator);
+  // Sort the object's values by a criterion produced by an iteratee.
+  _.sortBy = function(obj, iteratee, context) {
+    iteratee = cb(iteratee, context);
     return _.pluck(_.map(obj, function(value, index, list) {
       return {
         value: value,
         index: index,
-        criteria: iterator.call(context, value, index, list)
+        criteria: iteratee(value, index, list)
       };
     }).sort(function(left, right) {
       var a = left.criteria;
@@ -365,12 +412,12 @@ module.exports = {
 
   // An internal function used for aggregate "group by" operations.
   var group = function(behavior) {
-    return function(obj, iterator, context) {
+    return function(obj, iteratee, context) {
       var result = {};
-      iterator = lookupIterator(iterator);
-      each(obj, function(value, index) {
-        var key = iterator.call(context, value, index, obj);
-        behavior(result, key, value);
+      iteratee = cb(iteratee, context);
+      _.each(obj, function(value, index) {
+        var key = iteratee(value, index, obj);
+        behavior(result, value, key);
       });
       return result;
     };
@@ -378,48 +425,46 @@ module.exports = {
 
   // Groups the object's values by a criterion. Pass either a string attribute
   // to group by, or a function that returns the criterion.
-  _.groupBy = group(function(result, key, value) {
-    _.has(result, key) ? result[key].push(value) : result[key] = [value];
+  _.groupBy = group(function(result, value, key) {
+    if (_.has(result, key)) result[key].push(value); else result[key] = [value];
   });
 
   // Indexes the object's values by a criterion, similar to `groupBy`, but for
   // when you know that your index values will be unique.
-  _.indexBy = group(function(result, key, value) {
+  _.indexBy = group(function(result, value, key) {
     result[key] = value;
   });
 
   // Counts instances of an object that group by a certain criterion. Pass
   // either a string attribute to count by, or a function that returns the
   // criterion.
-  _.countBy = group(function(result, key) {
-    _.has(result, key) ? result[key]++ : result[key] = 1;
+  _.countBy = group(function(result, value, key) {
+    if (_.has(result, key)) result[key]++; else result[key] = 1;
   });
 
-  // Use a comparator function to figure out the smallest index at which
-  // an object should be inserted so as to maintain order. Uses binary search.
-  _.sortedIndex = function(array, obj, iterator, context) {
-    iterator = lookupIterator(iterator);
-    var value = iterator.call(context, obj);
-    var low = 0, high = array.length;
-    while (low < high) {
-      var mid = (low + high) >>> 1;
-      iterator.call(context, array[mid]) < value ? low = mid + 1 : high = mid;
-    }
-    return low;
-  };
-
   // Safely create a real, live array from anything iterable.
   _.toArray = function(obj) {
     if (!obj) return [];
     if (_.isArray(obj)) return slice.call(obj);
-    if (obj.length === +obj.length) return _.map(obj, _.identity);
+    if (isArrayLike(obj)) return _.map(obj, _.identity);
     return _.values(obj);
   };
 
   // Return the number of elements in an object.
   _.size = function(obj) {
     if (obj == null) return 0;
-    return (obj.length === +obj.length) ? obj.length : _.keys(obj).length;
+    return isArrayLike(obj) ? obj.length : _.keys(obj).length;
+  };
+
+  // Split a collection into two arrays: one whose elements all satisfy the given
+  // predicate, and one whose elements all do not satisfy the predicate.
+  _.partition = function(obj, predicate, context) {
+    predicate = cb(predicate, context);
+    var pass = [], fail = [];
+    _.each(obj, function(value, key, obj) {
+      (predicate(value, key, obj) ? pass : fail).push(value);
+    });
+    return [pass, fail];
   };
 
   // Array Functions
@@ -430,33 +475,30 @@ module.exports = {
   // allows it to work with `_.map`.
   _.first = _.head = _.take = function(array, n, guard) {
     if (array == null) return void 0;
-    if ((n == null) || guard) return array[0];
-    if (n < 0) return [];
-    return slice.call(array, 0, n);
+    if (n == null || guard) return array[0];
+    return _.initial(array, array.length - n);
   };
 
   // Returns everything but the last entry of the array. Especially useful on
   // the arguments object. Passing **n** will return all the values in
-  // the array, excluding the last N. The **guard** check allows it to work with
-  // `_.map`.
+  // the array, excluding the last N.
   _.initial = function(array, n, guard) {
-    return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
+    return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n)));
   };
 
   // Get the last element of an array. Passing **n** will return the last N
-  // values in the array. The **guard** check allows it to work with `_.map`.
+  // values in the array.
   _.last = function(array, n, guard) {
     if (array == null) return void 0;
-    if ((n == null) || guard) return array[array.length - 1];
-    return slice.call(array, Math.max(array.length - n, 0));
+    if (n == null || guard) return array[array.length - 1];
+    return _.rest(array, Math.max(0, array.length - n));
   };
 
   // Returns everything but the first entry of the array. Aliased as `tail` and `drop`.
   // Especially useful on the arguments object. Passing an **n** will return
-  // the rest N values in the array. The **guard**
-  // check allows it to work with `_.map`.
+  // the rest N values in the array.
   _.rest = _.tail = _.drop = function(array, n, guard) {
-    return slice.call(array, (n == null) || guard ? 1 : n);
+    return slice.call(array, n == null || guard ? 1 : n);
   };
 
   // Trim out all falsy values from an array.
@@ -465,23 +507,28 @@ module.exports = {
   };
 
   // Internal implementation of a recursive `flatten` function.
-  var flatten = function(input, shallow, output) {
-    if (shallow && _.every(input, _.isArray)) {
-      return concat.apply(output, input);
-    }
-    each(input, function(value) {
-      if (_.isArray(value) || _.isArguments(value)) {
-        shallow ? push.apply(output, value) : flatten(value, shallow, output);
-      } else {
-        output.push(value);
+  var flatten = function(input, shallow, strict, startIndex) {
+    var output = [], idx = 0;
+    for (var i = startIndex || 0, length = input && input.length; i < length; i++) {
+      var value = input[i];
+      if (isArrayLike(value) && (_.isArray(value) || _.isArguments(value))) {
+        //flatten current level of array or arguments object
+        if (!shallow) value = flatten(value, shallow, strict);
+        var j = 0, len = value.length;
+        output.length += len;
+        while (j < len) {
+          output[idx++] = value[j++];
+        }
+      } else if (!strict) {
+        output[idx++] = value;
       }
-    });
+    }
     return output;
   };
 
   // Flatten out an array, either recursively (by default), or just one level.
   _.flatten = function(array, shallow) {
-    return flatten(array, shallow, []);
+    return flatten(array, shallow, false);
   };
 
   // Return a version of the array that does not contain the specified value(s).
@@ -489,79 +536,93 @@ module.exports = {
     return _.difference(array, slice.call(arguments, 1));
   };
 
-  // Split an array into two arrays: one whose elements all satisfy the given
-  // predicate, and one whose elements all do not satisfy the predicate.
-  _.partition = function(array, predicate) {
-    var pass = [], fail = [];
-    each(array, function(elem) {
-      (predicate(elem) ? pass : fail).push(elem);
-    });
-    return [pass, fail];
-  };
-
   // Produce a duplicate-free version of the array. If the array has already
   // been sorted, you have the option of using a faster algorithm.
   // Aliased as `unique`.
-  _.uniq = _.unique = function(array, isSorted, iterator, context) {
-    if (_.isFunction(isSorted)) {
-      context = iterator;
-      iterator = isSorted;
+  _.uniq = _.unique = function(array, isSorted, iteratee, context) {
+    if (array == null) return [];
+    if (!_.isBoolean(isSorted)) {
+      context = iteratee;
+      iteratee = isSorted;
       isSorted = false;
     }
-    var initial = iterator ? _.map(array, iterator, context) : array;
-    var results = [];
+    if (iteratee != null) iteratee = cb(iteratee, context);
+    var result = [];
     var seen = [];
-    each(initial, function(value, index) {
-      if (isSorted ? (!index || seen[seen.length - 1] !== value) : !_.contains(seen, value)) {
-        seen.push(value);
-        results.push(array[index]);
+    for (var i = 0, length = array.length; i < length; i++) {
+      var value = array[i],
+          computed = iteratee ? iteratee(value, i, array) : value;
+      if (isSorted) {
+        if (!i || seen !== computed) result.push(value);
+        seen = computed;
+      } else if (iteratee) {
+        if (!_.contains(seen, computed)) {
+          seen.push(computed);
+          result.push(value);
+        }
+      } else if (!_.contains(result, value)) {
+        result.push(value);
       }
-    });
-    return results;
+    }
+    return result;
   };
 
   // Produce an array that contains the union: each distinct element from all of
   // the passed-in arrays.
   _.union = function() {
-    return _.uniq(_.flatten(arguments, true));
+    return _.uniq(flatten(arguments, true, true));
   };
 
   // Produce an array that contains every item shared between all the
   // passed-in arrays.
   _.intersection = function(array) {
-    var rest = slice.call(arguments, 1);
-    return _.filter(_.uniq(array), function(item) {
-      return _.every(rest, function(other) {
-        return _.contains(other, item);
-      });
-    });
+    if (array == null) return [];
+    var result = [];
+    var argsLength = arguments.length;
+    for (var i = 0, length = array.length; i < length; i++) {
+      var item = array[i];
+      if (_.contains(result, item)) continue;
+      for (var j = 1; j < argsLength; j++) {
+        if (!_.contains(arguments[j], item)) break;
+      }
+      if (j === argsLength) result.push(item);
+    }
+    return result;
   };
 
   // Take the difference between one array and a number of other arrays.
   // Only the elements present in just the first array will remain.
   _.difference = function(array) {
-    var rest = concat.apply(ArrayProto, slice.call(arguments, 1));
-    return _.filter(array, function(value){ return !_.contains(rest, value); });
+    var rest = flatten(arguments, true, true, 1);
+    return _.filter(array, function(value){
+      return !_.contains(rest, value);
+    });
   };
 
   // Zip together multiple lists into a single array -- elements that share
   // an index go together.
   _.zip = function() {
-    var length = _.max(_.pluck(arguments, 'length').concat(0));
-    var results = new Array(length);
-    for (var i = 0; i < length; i++) {
-      results[i] = _.pluck(arguments, '' + i);
+    return _.unzip(arguments);
+  };
+
+  // Complement of _.zip. Unzip accepts an array of arrays and groups
+  // each array's elements on shared indices
+  _.unzip = function(array) {
+    var length = array && _.max(array, 'length').length || 0;
+    var result = Array(length);
+
+    for (var index = 0; index < length; index++) {
+      result[index] = _.pluck(array, index);
     }
-    return results;
+    return result;
   };
 
   // Converts lists into objects. Pass either a single array of `[key, value]`
   // pairs, or two parallel arrays of the same length -- one of keys, and one of
   // the corresponding values.
   _.object = function(list, values) {
-    if (list == null) return {};
     var result = {};
-    for (var i = 0, length = list.length; i < length; i++) {
+    for (var i = 0, length = list && list.length; i < length; i++) {
       if (values) {
         result[list[i]] = values[i];
       } else {
@@ -571,40 +632,68 @@ module.exports = {
     return result;
   };
 
-  // If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
-  // we need this function. Return the position of the first occurrence of an
-  // item in an array, or -1 if the item is not included in the array.
-  // Delegates to **ECMAScript 5**'s native `indexOf` if available.
+  // Return the position of the first occurrence of an item in an array,
+  // or -1 if the item is not included in the array.
   // If the array is large and already in sort order, pass `true`
   // for **isSorted** to use binary search.
   _.indexOf = function(array, item, isSorted) {
-    if (array == null) return -1;
-    var i = 0, length = array.length;
-    if (isSorted) {
-      if (typeof isSorted == 'number') {
-        i = (isSorted < 0 ? Math.max(0, length + isSorted) : isSorted);
-      } else {
-        i = _.sortedIndex(array, item);
-        return array[i] === item ? i : -1;
-      }
+    var i = 0, length = array && array.length;
+    if (typeof isSorted == 'number') {
+      i = isSorted < 0 ? Math.max(0, length + isSorted) : isSorted;
+    } else if (isSorted && length) {
+      i = _.sortedIndex(array, item);
+      return array[i] === item ? i : -1;
+    }
+    if (item !== item) {
+      return _.findIndex(slice.call(array, i), _.isNaN);
     }
-    if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item, isSorted);
     for (; i < length; i++) if (array[i] === item) return i;
     return -1;
   };
 
-  // Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
   _.lastIndexOf = function(array, item, from) {
-    if (array == null) return -1;
-    var hasIndex = from != null;
-    if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) {
-      return hasIndex ? array.lastIndexOf(item, from) : array.lastIndexOf(item);
+    var idx = array ? array.length : 0;
+    if (typeof from == 'number') {
+      idx = from < 0 ? idx + from + 1 : Math.min(idx, from + 1);
     }
-    var i = (hasIndex ? from : array.length);
-    while (i--) if (array[i] === item) return i;
+    if (item !== item) {
+      return _.findLastIndex(slice.call(array, 0, idx), _.isNaN);
+    }
+    while (--idx >= 0) if (array[idx] === item) return idx;
     return -1;
   };
 
+  // Generator function to create the findIndex and findLastIndex functions
+  function createIndexFinder(dir) {
+    return function(array, predicate, context) {
+      predicate = cb(predicate, context);
+      var length = array != null && array.length;
+      var index = dir > 0 ? 0 : length - 1;
+      for (; index >= 0 && index < length; index += dir) {
+        if (predicate(array[index], index, array)) return index;
+      }
+      return -1;
+    };
+  }
+
+  // Returns the first index on an array-like that passes a predicate test
+  _.findIndex = createIndexFinder(1);
+
+  _.findLastIndex = createIndexFinder(-1);
+
+  // Use a comparator function to figure out the smallest index at which
+  // an object should be inserted so as to maintain order. Uses binary search.
+  _.sortedIndex = function(array, obj, iteratee, context) {
+    iteratee = cb(iteratee, context, 1);
+    var value = iteratee(obj);
+    var low = 0, high = array.length;
+    while (low < high) {
+      var mid = Math.floor((low + high) / 2);
+      if (iteratee(array[mid]) < value) low = mid + 1; else high = mid;
+    }
+    return low;
+  };
+
   // Generate an integer Array containing an arithmetic progression. A port of
   // the native Python `range()` function. See
   // [the Python documentation](http://docs.python.org/library/functions.html#range).
@@ -613,15 +702,13 @@ module.exports = {
       stop = start || 0;
       start = 0;
     }
-    step = arguments[2] || 1;
+    step = step || 1;
 
     var length = Math.max(Math.ceil((stop - start) / step), 0);
-    var idx = 0;
-    var range = new Array(length);
+    var range = Array(length);
 
-    while(idx < length) {
-      range[idx++] = start;
-      start += step;
+    for (var idx = 0; idx < length; idx++, start += step) {
+      range[idx] = start;
     }
 
     return range;
@@ -630,26 +717,27 @@ module.exports = {
   // Function (ahem) Functions
   // ------------------
 
-  // Reusable constructor function for prototype setting.
-  var ctor = function(){};
+  // Determines whether to execute a function as a constructor
+  // or a normal function with the provided arguments
+  var executeBound = function(sourceFunc, boundFunc, context, callingContext, args) {
+    if (!(callingContext instanceof boundFunc)) return sourceFunc.apply(context, args);
+    var self = baseCreate(sourceFunc.prototype);
+    var result = sourceFunc.apply(self, args);
+    if (_.isObject(result)) return result;
+    return self;
+  };
 
   // Create a function bound to a given object (assigning `this`, and arguments,
   // optionally). Delegates to **ECMAScript 5**'s native `Function.bind` if
   // available.
   _.bind = function(func, context) {
-    var args, bound;
     if (nativeBind && func.bind === nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
-    if (!_.isFunction(func)) throw new TypeError;
-    args = slice.call(arguments, 2);
-    return bound = function() {
-      if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
-      ctor.prototype = func.prototype;
-      var self = new ctor;
-      ctor.prototype = null;
-      var result = func.apply(self, args.concat(slice.call(arguments)));
-      if (Object(result) === result) return result;
-      return self;
+    if (!_.isFunction(func)) throw new TypeError('Bind must be called on a function');
+    var args = slice.call(arguments, 2);
+    var bound = function() {
+      return executeBound(func, bound, context, this, args.concat(slice.call(arguments)));
     };
+    return bound;
   };
 
   // Partially apply a function by creating a version that has had some of its
@@ -657,49 +745,55 @@ module.exports = {
   // as a placeholder, allowing any combination of arguments to be pre-filled.
   _.partial = function(func) {
     var boundArgs = slice.call(arguments, 1);
-    return function() {
-      var position = 0;
-      var args = boundArgs.slice();
-      for (var i = 0, length = args.length; i < length; i++) {
-        if (args[i] === _) args[i] = arguments[position++];
+    var bound = function() {
+      var position = 0, length = boundArgs.length;
+      var args = Array(length);
+      for (var i = 0; i < length; i++) {
+        args[i] = boundArgs[i] === _ ? arguments[position++] : boundArgs[i];
       }
       while (position < arguments.length) args.push(arguments[position++]);
-      return func.apply(this, args);
+      return executeBound(func, bound, this, this, args);
     };
+    return bound;
   };
 
   // Bind a number of an object's methods to that object. Remaining arguments
   // are the method names to be bound. Useful for ensuring that all callbacks
   // defined on an object belong to it.
   _.bindAll = function(obj) {
-    var funcs = slice.call(arguments, 1);
-    if (funcs.length === 0) throw new Error('bindAll must be passed function names');
-    each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
+    var i, length = arguments.length, key;
+    if (length <= 1) throw new Error('bindAll must be passed function names');
+    for (i = 1; i < length; i++) {
+      key = arguments[i];
+      obj[key] = _.bind(obj[key], obj);
+    }
     return obj;
   };
 
   // Memoize an expensive function by storing its results.
   _.memoize = function(func, hasher) {
-    var memo = {};
-    hasher || (hasher = _.identity);
-    return function() {
-      var key = hasher.apply(this, arguments);
-      return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
+    var memoize = function(key) {
+      var cache = memoize.cache;
+      var address = '' + (hasher ? hasher.apply(this, arguments) : key);
+      if (!_.has(cache, address)) cache[address] = func.apply(this, arguments);
+      return cache[address];
     };
+    memoize.cache = {};
+    return memoize;
   };
 
   // Delays a function for the given number of milliseconds, and then calls
   // it with the arguments supplied.
   _.delay = function(func, wait) {
     var args = slice.call(arguments, 2);
-    return setTimeout(function(){ return func.apply(null, args); }, wait);
+    return setTimeout(function(){
+      return func.apply(null, args);
+    }, wait);
   };
 
   // Defers a function, scheduling it to run after the current call stack has
   // cleared.
-  _.defer = function(func) {
-    return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
-  };
+  _.defer = _.partial(_.delay, _, 1);
 
   // Returns a function, that, when invoked, will only be triggered at most once
   // during a given window of time. Normally, the throttled function will run
@@ -710,12 +804,12 @@ module.exports = {
     var context, args, result;
     var timeout = null;
     var previous = 0;
-    options || (options = {});
+    if (!options) options = {};
     var later = function() {
       previous = options.leading === false ? 0 : _.now();
       timeout = null;
       result = func.apply(context, args);
-      context = args = null;
+      if (!timeout) context = args = null;
     };
     return function() {
       var now = _.now();
@@ -723,12 +817,14 @@ module.exports = {
       var remaining = wait - (now - previous);
       context = this;
       args = arguments;
-      if (remaining <= 0) {
-        clearTimeout(timeout);
-        timeout = null;
+      if (remaining <= 0 || remaining > wait) {
+        if (timeout) {
+          clearTimeout(timeout);
+          timeout = null;
+        }
         previous = now;
         result = func.apply(context, args);
-        context = args = null;
+        if (!timeout) context = args = null;
       } else if (!timeout && options.trailing !== false) {
         timeout = setTimeout(later, remaining);
       }
@@ -745,13 +841,14 @@ module.exports = {
 
     var later = function() {
       var last = _.now() - timestamp;
-      if (last < wait) {
+
+      if (last < wait && last >= 0) {
         timeout = setTimeout(later, wait - last);
       } else {
         timeout = null;
         if (!immediate) {
           result = func.apply(context, args);
-          context = args = null;
+          if (!timeout) context = args = null;
         }
       }
     };
@@ -761,9 +858,7 @@ module.exports = {
       args = arguments;
       timestamp = _.now();
       var callNow = immediate && !timeout;
-      if (!timeout) {
-        timeout = setTimeout(later, wait);
-      }
+      if (!timeout) timeout = setTimeout(later, wait);
       if (callNow) {
         result = func.apply(context, args);
         context = args = null;
@@ -773,19 +868,6 @@ module.exports = {
     };
   };
 
-  // Returns a function that will be executed at most one time, no matter how
-  // often you call it. Useful for lazy initialization.
-  _.once = function(func) {
-    var ran = false, memo;
-    return function() {
-      if (ran) return memo;
-      ran = true;
-      memo = func.apply(this, arguments);
-      func = null;
-      return memo;
-    };
-  };
-
   // Returns the first function passed as an argument to the second,
   // allowing you to adjust arguments, run code before and after, and
   // conditionally execute the original function.
@@ -793,20 +875,27 @@ module.exports = {
     return _.partial(wrapper, func);
   };
 
-  // Returns a function that is the composition of a list of functions, each
-  // consuming the return value of the function that follows.
-  _.compose = function() {
-    var funcs = arguments;
+  // Returns a negated version of the passed-in predicate.
+  _.negate = function(predicate) {
     return function() {
-      var args = arguments;
-      for (var i = funcs.length - 1; i >= 0; i--) {
-        args = [funcs[i].apply(this, args)];
-      }
-      return args[0];
+      return !predicate.apply(this, arguments);
     };
   };
 
-  // Returns a function that will only be executed after being called N times.
+  // Returns a function that is the composition of a list of functions, each
+  // consuming the return value of the function that follows.
+  _.compose = function() {
+    var args = arguments;
+    var start = args.length - 1;
+    return function() {
+      var i = start;
+      var result = args[start].apply(this, arguments);
+      while (i--) result = args[i].call(this, result);
+      return result;
+    };
+  };
+
+  // Returns a function that will only be executed on and after the Nth call.
   _.after = function(times, func) {
     return function() {
       if (--times < 1) {
@@ -815,16 +904,66 @@ module.exports = {
     };
   };
 
+  // Returns a function that will only be executed up to (but not including) the Nth call.
+  _.before = function(times, func) {
+    var memo;
+    return function() {
+      if (--times > 0) {
+        memo = func.apply(this, arguments);
+      }
+      if (times <= 1) func = null;
+      return memo;
+    };
+  };
+
+  // Returns a function that will be executed at most one time, no matter how
+  // often you call it. Useful for lazy initialization.
+  _.once = _.partial(_.before, 2);
+
   // Object Functions
   // ----------------
 
-  // Retrieve the names of an object's properties.
+  // Keys in IE < 9 that won't be iterated by `for key in ...` and thus missed.
+  var hasEnumBug = !{toString: null}.propertyIsEnumerable('toString');
+  var nonEnumerableProps = ['valueOf', 'isPrototypeOf', 'toString',
+                      'propertyIsEnumerable', 'hasOwnProperty', 'toLocaleString'];
+
+  function collectNonEnumProps(obj, keys) {
+    var nonEnumIdx = nonEnumerableProps.length;
+    var constructor = obj.constructor;
+    var proto = (_.isFunction(constructor) && constructor.prototype) || ObjProto;
+
+    // Constructor is a special case.
+    var prop = 'constructor';
+    if (_.has(obj, prop) && !_.contains(keys, prop)) keys.push(prop);
+
+    while (nonEnumIdx--) {
+      prop = nonEnumerableProps[nonEnumIdx];
+      if (prop in obj && obj[prop] !== proto[prop] && !_.contains(keys, prop)) {
+        keys.push(prop);
+      }
+    }
+  }
+
+  // Retrieve the names of an object's own properties.
   // Delegates to **ECMAScript 5**'s native `Object.keys`
   _.keys = function(obj) {
     if (!_.isObject(obj)) return [];
     if (nativeKeys) return nativeKeys(obj);
     var keys = [];
     for (var key in obj) if (_.has(obj, key)) keys.push(key);
+    // Ahem, IE < 9.
+    if (hasEnumBug) collectNonEnumProps(obj, keys);
+    return keys;
+  };
+
+  // Retrieve all the property names of an object.
+  _.allKeys = function(obj) {
+    if (!_.isObject(obj)) return [];
+    var keys = [];
+    for (var key in obj) keys.push(key);
+    // Ahem, IE < 9.
+    if (hasEnumBug) collectNonEnumProps(obj, keys);
     return keys;
   };
 
@@ -832,18 +971,33 @@ module.exports = {
   _.values = function(obj) {
     var keys = _.keys(obj);
     var length = keys.length;
-    var values = new Array(length);
+    var values = Array(length);
     for (var i = 0; i < length; i++) {
       values[i] = obj[keys[i]];
     }
     return values;
   };
 
+  // Returns the results of applying the iteratee to each element of the object
+  // In contrast to _.map it returns an object
+  _.mapObject = function(obj, iteratee, context) {
+    iteratee = cb(iteratee, context);
+    var keys =  _.keys(obj),
+          length = keys.length,
+          results = {},
+          currentKey;
+      for (var index = 0; index < length; index++) {
+        currentKey = keys[index];
+        results[currentKey] = iteratee(obj[currentKey], currentKey, obj);
+      }
+      return results;
+  };
+
   // Convert an object into a list of `[key, value]` pairs.
   _.pairs = function(obj) {
     var keys = _.keys(obj);
     var length = keys.length;
-    var pairs = new Array(length);
+    var pairs = Array(length);
     for (var i = 0; i < length; i++) {
       pairs[i] = [keys[i], obj[keys[i]]];
     }
@@ -871,48 +1025,57 @@ module.exports = {
   };
 
   // Extend a given object with all the properties in passed-in object(s).
-  _.extend = function(obj) {
-    each(slice.call(arguments, 1), function(source) {
-      if (source) {
-        for (var prop in source) {
-          obj[prop] = source[prop];
-        }
-      }
-    });
-    return obj;
+  _.extend = createAssigner(_.allKeys);
+
+  // Assigns a given object with all the own properties in the passed-in object(s)
+  // (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
+  _.extendOwn = _.assign = createAssigner(_.keys);
+
+  // Returns the first key on an object that passes a predicate test
+  _.findKey = function(obj, predicate, context) {
+    predicate = cb(predicate, context);
+    var keys = _.keys(obj), key;
+    for (var i = 0, length = keys.length; i < length; i++) {
+      key = keys[i];
+      if (predicate(obj[key], key, obj)) return key;
+    }
   };
 
   // Return a copy of the object only containing the whitelisted properties.
-  _.pick = function(obj) {
-    var copy = {};
-    var keys = concat.apply(ArrayProto, slice.call(arguments, 1));
-    each(keys, function(key) {
-      if (key in obj) copy[key] = obj[key];
-    });
-    return copy;
+  _.pick = function(object, oiteratee, context) {
+    var result = {}, obj = object, iteratee, keys;
+    if (obj == null) return result;
+    if (_.isFunction(oiteratee)) {
+      keys = _.allKeys(obj);
+      iteratee = optimizeCb(oiteratee, context);
+    } else {
+      keys = flatten(arguments, false, false, 1);
+      iteratee = function(value, key, obj) { return key in obj; };
+      obj = Object(obj);
+    }
+    for (var i = 0, length = keys.length; i < length; i++) {
+      var key = keys[i];
+      var value = obj[key];
+      if (iteratee(value, key, obj)) result[key] = value;
+    }
+    return result;
   };
 
    // Return a copy of the object without the blacklisted properties.
-  _.omit = function(obj) {
-    var copy = {};
-    var keys = concat.apply(ArrayProto, slice.call(arguments, 1));
-    for (var key in obj) {
-      if (!_.contains(keys, key)) copy[key] = obj[key];
+  _.omit = function(obj, iteratee, context) {
+    if (_.isFunction(iteratee)) {
+      iteratee = _.negate(iteratee);
+    } else {
+      var keys = _.map(flatten(arguments, false, false, 1), String);
+      iteratee = function(value, key) {
+        return !_.contains(keys, key);
+      };
     }
-    return copy;
+    return _.pick(obj, iteratee, context);
   };
 
   // Fill in a given object with default properties.
-  _.defaults = function(obj) {
-    each(slice.call(arguments, 1), function(source) {
-      if (source) {
-        for (var prop in source) {
-          if (obj[prop] === void 0) obj[prop] = source[prop];
-        }
-      }
-    });
-    return obj;
-  };
+  _.defaults = createAssigner(_.allKeys, true);
 
   // Create a (shallow-cloned) duplicate of an object.
   _.clone = function(obj) {
@@ -928,11 +1091,24 @@ module.exports = {
     return obj;
   };
 
+  // Returns whether an object has a given set of `key:value` pairs.
+  _.isMatch = function(object, attrs) {
+    var keys = _.keys(attrs), length = keys.length;
+    if (object == null) return !length;
+    var obj = Object(object);
+    for (var i = 0; i < length; i++) {
+      var key = keys[i];
+      if (attrs[key] !== obj[key] || !(key in obj)) return false;
+    }
+    return true;
+  };
+
+
   // Internal recursive comparison function for `isEqual`.
   var eq = function(a, b, aStack, bStack) {
     // Identical objects are equal. `0 === -0`, but they aren't identical.
     // See the [Harmony `egal` proposal](http://wiki.ecmascript.org/doku.php?id=harmony:egal).
-    if (a === b) return a !== 0 || 1 / a == 1 / b;
+    if (a === b) return a !== 0 || 1 / a === 1 / b;
     // A strict comparison is necessary because `null == undefined`.
     if (a == null || b == null) return a === b;
     // Unwrap any wrapped objects.
@@ -940,98 +1116,98 @@ module.exports = {
     if (b instanceof _) b = b._wrapped;
     // Compare `[[Class]]` names.
     var className = toString.call(a);
-    if (className != toString.call(b)) return false;
+    if (className !== toString.call(b)) return false;
     switch (className) {
-      // Strings, numbers, dates, and booleans are compared by value.
+      // Strings, numbers, regular expressions, dates, and booleans are compared by value.
+      case '[object RegExp]':
+      // RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i')
       case '[object String]':
         // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
         // equivalent to `new String("5")`.
-        return a == String(b);
+        return '' + a === '' + b;
       case '[object Number]':
-        // `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
-        // other numeric values.
-        return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
+        // `NaN`s are equivalent, but non-reflexive.
+        // Object(NaN) is equivalent to NaN
+        if (+a !== +a) return +b !== +b;
+        // An `egal` comparison is performed for other numeric values.
+        return +a === 0 ? 1 / +a === 1 / b : +a === +b;
       case '[object Date]':
       case '[object Boolean]':
         // Coerce dates and booleans to numeric primitive values. Dates are compared by their
         // millisecond representations. Note that invalid dates with millisecond representations
         // of `NaN` are not equivalent.
-        return +a == +b;
-      // RegExps are compared by their source patterns and flags.
-      case '[object RegExp]':
-        return a.source == b.source &&
-               a.global == b.global &&
-               a.multiline == b.multiline &&
-               a.ignoreCase == b.ignoreCase;
+        return +a === +b;
+    }
+
+    var areArrays = className === '[object Array]';
+    if (!areArrays) {
+      if (typeof a != 'object' || typeof b != 'object') return false;
+
+      // Objects with different constructors are not equivalent, but `Object`s or `Array`s
+      // from different frames are.
+      var aCtor = a.constructor, bCtor = b.constructor;
+      if (aCtor !== bCtor && !(_.isFunction(aCtor) && aCtor instanceof aCtor &&
+                               _.isFunction(bCtor) && bCtor instanceof bCtor)
+                          && ('constructor' in a && 'constructor' in b)) {
+        return false;
+      }
     }
-    if (typeof a != 'object' || typeof b != 'object') return false;
     // Assume equality for cyclic structures. The algorithm for detecting cyclic
     // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
+    
+    // Initializing stack of traversed objects.
+    // It's done here since we only need them for objects and arrays comparison.
+    aStack = aStack || [];
+    bStack = bStack || [];
     var length = aStack.length;
     while (length--) {
       // Linear search. Performance is inversely proportional to the number of
       // unique nested structures.
-      if (aStack[length] == a) return bStack[length] == b;
-    }
-    // Objects with different constructors are not equivalent, but `Object`s
-    // from different frames are.
-    var aCtor = a.constructor, bCtor = b.constructor;
-    if (aCtor !== bCtor && !(_.isFunction(aCtor) && (aCtor instanceof aCtor) &&
-                             _.isFunction(bCtor) && (bCtor instanceof bCtor))
-                        && ('constructor' in a && 'constructor' in b)) {
-      return false;
+      if (aStack[length] === a) return bStack[length] === b;
     }
+
     // Add the first object to the stack of traversed objects.
     aStack.push(a);
     bStack.push(b);
-    var size = 0, result = true;
+
     // Recursively compare objects and arrays.
-    if (className == '[object Array]') {
+    if (areArrays) {
       // Compare array lengths to determine if a deep comparison is necessary.
-      size = a.length;
-      result = size == b.length;
-      if (result) {
-        // Deep compare the contents, ignoring non-numeric properties.
-        while (size--) {
-          if (!(result = eq(a[size], b[size], aStack, bStack))) break;
-        }
+      length = a.length;
+      if (length !== b.length) return false;
+      // Deep compare the contents, ignoring non-numeric properties.
+      while (length--) {
+        if (!eq(a[length], b[length], aStack, bStack)) return false;
       }
     } else {
       // Deep compare objects.
-      for (var key in a) {
-        if (_.has(a, key)) {
-          // Count the expected number of properties.
-          size++;
-          // Deep compare each member.
-          if (!(result = _.has(b, key) && eq(a[key], b[key], aStack, bStack))) break;
-        }
-      }
-      // Ensure that both objects contain the same number of properties.
-      if (result) {
-        for (key in b) {
-          if (_.has(b, key) && !(size--)) break;
-        }
-        result = !size;
+      var keys = _.keys(a), key;
+      length = keys.length;
+      // Ensure that both objects contain the same number of properties before comparing deep equality.
+      if (_.keys(b).length !== length) return false;
+      while (length--) {
+        // Deep compare each member
+        key = keys[length];
+        if (!(_.has(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
       }
     }
     // Remove the first object from the stack of traversed objects.
     aStack.pop();
     bStack.pop();
-    return result;
+    return true;
   };
 
   // Perform a deep comparison to check if two objects are equal.
   _.isEqual = function(a, b) {
-    return eq(a, b, [], []);
+    return eq(a, b);
   };
 
   // Is a given array, string, or object empty?
   // An "empty" object has no enumerable own-properties.
   _.isEmpty = function(obj) {
     if (obj == null) return true;
-    if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
-    for (var key in obj) if (_.has(obj, key)) return false;
-    return true;
+    if (isArrayLike(obj) && (_.isArray(obj) || _.isString(obj) || _.isArguments(obj))) return obj.length === 0;
+    return _.keys(obj).length === 0;
   };
 
   // Is a given value a DOM element?
@@ -1042,33 +1218,35 @@ module.exports = {
   // Is a given value an array?
   // Delegates to ECMA5's native Array.isArray
   _.isArray = nativeIsArray || function(obj) {
-    return toString.call(obj) == '[object Array]';
+    return toString.call(obj) === '[object Array]';
   };
 
   // Is a given variable an object?
   _.isObject = function(obj) {
-    return obj === Object(obj);
+    var type = typeof obj;
+    return type === 'function' || type === 'object' && !!obj;
   };
 
-  // Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp.
-  each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp'], function(name) {
+  // Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp, isError.
+  _.each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp', 'Error'], function(name) {
     _['is' + name] = function(obj) {
-      return toString.call(obj) == '[object ' + name + ']';
+      return toString.call(obj) === '[object ' + name + ']';
     };
   });
 
-  // Define a fallback version of the method in browsers (ahem, IE), where
+  // Define a fallback version of the method in browsers (ahem, IE < 9), where
   // there isn't any inspectable "Arguments" type.
   if (!_.isArguments(arguments)) {
     _.isArguments = function(obj) {
-      return !!(obj && _.has(obj, 'callee'));
+      return _.has(obj, 'callee');
     };
   }
 
-  // Optimize `isFunction` if appropriate.
-  if (typeof (/./) !== 'function') {
+  // Optimize `isFunction` if appropriate. Work around some typeof bugs in old v8,
+  // IE 11 (#1621), and in Safari 8 (#1929).
+  if (typeof /./ != 'function' && typeof Int8Array != 'object') {
     _.isFunction = function(obj) {
-      return typeof obj === 'function';
+      return typeof obj == 'function' || false;
     };
   }
 
@@ -1079,12 +1257,12 @@ module.exports = {
 
   // Is the given value `NaN`? (NaN is the only number which does not equal itself).
   _.isNaN = function(obj) {
-    return _.isNumber(obj) && obj != +obj;
+    return _.isNumber(obj) && obj !== +obj;
   };
 
   // Is a given value a boolean?
   _.isBoolean = function(obj) {
-    return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
+    return obj === true || obj === false || toString.call(obj) === '[object Boolean]';
   };
 
   // Is a given value equal to null?
@@ -1100,7 +1278,7 @@ module.exports = {
   // Shortcut function for checking if an object has a given property directly
   // on itself (in other words, not on a prototype).
   _.has = function(obj, key) {
-    return hasOwnProperty.call(obj, key);
+    return obj != null && hasOwnProperty.call(obj, key);
   };
 
   // Utility Functions
@@ -1113,39 +1291,47 @@ module.exports = {
     return this;
   };
 
-  // Keep the identity function around for default iterators.
+  // Keep the identity function around for default iteratees.
   _.identity = function(value) {
     return value;
   };
 
+  // Predicate-generating functions. Often useful outside of Underscore.
   _.constant = function(value) {
-    return function () {
+    return function() {
       return value;
     };
   };
 
+  _.noop = function(){};
+
   _.property = function(key) {
     return function(obj) {
+      return obj == null ? void 0 : obj[key];
+    };
+  };
+
+  // Generates a function for a given object that returns a given property.
+  _.propertyOf = function(obj) {
+    return obj == null ? function(){} : function(key) {
       return obj[key];
     };
   };
 
-  // Returns a predicate for checking whether an object has a given set of `key:value` pairs.
-  _.matches = function(attrs) {
+  // Returns a predicate for checking whether an object has a given set of 
+  // `key:value` pairs.
+  _.matcher = _.matches = function(attrs) {
+    attrs = _.extendOwn({}, attrs);
     return function(obj) {
-      if (obj === attrs) return true; //avoid comparing an object to itself.
-      for (var key in attrs) {
-        if (attrs[key] !== obj[key])
-          return false;
-      }
-      return true;
-    }
+      return _.isMatch(obj, attrs);
+    };
   };
 
   // Run a function **n** times.
-  _.times = function(n, iterator, context) {
+  _.times = function(n, iteratee, context) {
     var accum = Array(Math.max(0, n));
-    for (var i = 0; i < n; i++) accum[i] = iterator.call(context, i);
+    iteratee = optimizeCb(iteratee, context, 1);
+    for (var i = 0; i < n; i++) accum[i] = iteratee(i);
     return accum;
   };
 
@@ -1159,56 +1345,48 @@ module.exports = {
   };
 
   // A (possibly faster) way to get the current timestamp as an integer.
-  _.now = Date.now || function() { return new Date().getTime(); };
-
-  // List of HTML entities for escaping.
-  var entityMap = {
-    escape: {
-      '&': '&',
-      '<': '<',
-      '>': '>',
-      '"': '"',
-      "'": '''
-    }
+  _.now = Date.now || function() {
+    return new Date().getTime();
   };
-  entityMap.unescape = _.invert(entityMap.escape);
 
-  // Regexes containing the keys and values listed immediately above.
-  var entityRegexes = {
-    escape:   new RegExp('[' + _.keys(entityMap.escape).join('') + ']', 'g'),
-    unescape: new RegExp('(' + _.keys(entityMap.unescape).join('|') + ')', 'g')
+   // List of HTML entities for escaping.
+  var escapeMap = {
+    '&': '&',
+    '<': '<',
+    '>': '>',
+    '"': '"',
+    "'": ''',
+    '`': '`'
   };
+  var unescapeMap = _.invert(escapeMap);
 
   // Functions for escaping and unescaping strings to/from HTML interpolation.
-  _.each(['escape', 'unescape'], function(method) {
-    _[method] = function(string) {
-      if (string == null) return '';
-      return ('' + string).replace(entityRegexes[method], function(match) {
-        return entityMap[method][match];
-      });
+  var createEscaper = function(map) {
+    var escaper = function(match) {
+      return map[match];
     };
-  });
+    // Regexes for identifying a key that needs to be escaped
+    var source = '(?:' + _.keys(map).join('|') + ')';
+    var testRegexp = RegExp(source);
+    var replaceRegexp = RegExp(source, 'g');
+    return function(string) {
+      string = string == null ? '' : '' + string;
+      return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string;
+    };
+  };
+  _.escape = createEscaper(escapeMap);
+  _.unescape = createEscaper(unescapeMap);
 
   // If the value of the named `property` is a function then invoke it with the
   // `object` as context; otherwise, return it.
-  _.result = function(object, property) {
-    if (object == null) return void 0;
-    var value = object[property];
+  _.result = function(object, property, fallback) {
+    var value = object == null ? void 0 : object[property];
+    if (value === void 0) {
+      value = fallback;
+    }
     return _.isFunction(value) ? value.call(object) : value;
   };
 
-  // Add your own custom functions to the Underscore object.
-  _.mixin = function(obj) {
-    each(_.functions(obj), function(name) {
-      var func = _[name] = obj[name];
-      _.prototype[name] = function() {
-        var args = [this._wrapped];
-        push.apply(args, arguments);
-        return result.call(this, func.apply(_, args));
-      };
-    });
-  };
-
   // Generate a unique integer id (unique within the entire client session).
   // Useful for temporary DOM ids.
   var idCounter = 0;
@@ -1237,22 +1415,26 @@ module.exports = {
     '\\':     '\\',
     '\r':     'r',
     '\n':     'n',
-    '\t':     't',
     '\u2028': 'u2028',
     '\u2029': 'u2029'
   };
 
-  var escaper = /\\|'|\r|\n|\t|\u2028|\u2029/g;
+  var escaper = /\\|'|\r|\n|\u2028|\u2029/g;
+
+  var escapeChar = function(match) {
+    return '\\' + escapes[match];
+  };
 
   // JavaScript micro-templating, similar to John Resig's implementation.
   // Underscore templating handles arbitrary delimiters, preserves whitespace,
   // and correctly escapes quotes within interpolated code.
-  _.template = function(text, data, settings) {
-    var render;
+  // NB: `oldSettings` only exists for backwards compatibility.
+  _.template = function(text, settings, oldSettings) {
+    if (!settings && oldSettings) settings = oldSettings;
     settings = _.defaults({}, settings, _.templateSettings);
 
     // Combine delimiters into one regular expression via alternation.
-    var matcher = new RegExp([
+    var matcher = RegExp([
       (settings.escape || noMatch).source,
       (settings.interpolate || noMatch).source,
       (settings.evaluate || noMatch).source
@@ -1262,19 +1444,18 @@ module.exports = {
     var index = 0;
     var source = "__p+='";
     text.replace(matcher, function(match, escape, interpolate, evaluate, offset) {
-      source += text.slice(index, offset)
-        .replace(escaper, function(match) { return '\\' + escapes[match]; });
+      source += text.slice(index, offset).replace(escaper, escapeChar);
+      index = offset + match.length;
 
       if (escape) {
         source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'";
-      }
-      if (interpolate) {
+      } else if (interpolate) {
         source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'";
-      }
-      if (evaluate) {
+      } else if (evaluate) {
         source += "';\n" + evaluate + "\n__p+='";
       }
-      index = offset + match.length;
+
+      // Adobe VMs need the match returned to produce the correct offest.
       return match;
     });
     source += "';\n";
@@ -1284,29 +1465,31 @@ module.exports = {
 
     source = "var __t,__p='',__j=Array.prototype.join," +
       "print=function(){__p+=__j.call(arguments,'');};\n" +
-      source + "return __p;\n";
+      source + 'return __p;\n';
 
     try {
-      render = new Function(settings.variable || 'obj', '_', source);
+      var render = new Function(settings.variable || 'obj', '_', source);
     } catch (e) {
       e.source = source;
       throw e;
     }
 
-    if (data) return render(data, _);
     var template = function(data) {
       return render.call(this, data, _);
     };
 
-    // Provide the compiled function source as a convenience for precompilation.
-    template.source = 'function(' + (settings.variable || 'obj') + '){\n' + source + '}';
+    // Provide the compiled source as a convenience for precompilation.
+    var argument = settings.variable || 'obj';
+    template.source = 'function(' + argument + '){\n' + source + '}';
 
     return template;
   };
 
-  // Add a "chain" function, which will delegate to the wrapper.
+  // Add a "chain" function. Start chaining a wrapped Underscore object.
   _.chain = function(obj) {
-    return _(obj).chain();
+    var instance = _(obj);
+    instance._chain = true;
+    return instance;
   };
 
   // OOP
@@ -1316,46 +1499,56 @@ module.exports = {
   // underscore functions. Wrapped objects may be chained.
 
   // Helper function to continue chaining intermediate results.
-  var result = function(obj) {
-    return this._chain ? _(obj).chain() : obj;
+  var result = function(instance, obj) {
+    return instance._chain ? _(obj).chain() : obj;
+  };
+
+  // Add your own custom functions to the Underscore object.
+  _.mixin = function(obj) {
+    _.each(_.functions(obj), function(name) {
+      var func = _[name] = obj[name];
+      _.prototype[name] = function() {
+        var args = [this._wrapped];
+        push.apply(args, arguments);
+        return result(this, func.apply(_, args));
+      };
+    });
   };
 
   // Add all of the Underscore functions to the wrapper object.
   _.mixin(_);
 
   // Add all mutator Array functions to the wrapper.
-  each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
+  _.each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
     var method = ArrayProto[name];
     _.prototype[name] = function() {
       var obj = this._wrapped;
       method.apply(obj, arguments);
-      if ((name == 'shift' || name == 'splice') && obj.length === 0) delete obj[0];
-      return result.call(this, obj);
+      if ((name === 'shift' || name === 'splice') && obj.length === 0) delete obj[0];
+      return result(this, obj);
     };
   });
 
   // Add all accessor Array functions to the wrapper.
-  each(['concat', 'join', 'slice'], function(name) {
+  _.each(['concat', 'join', 'slice'], function(name) {
     var method = ArrayProto[name];
     _.prototype[name] = function() {
-      return result.call(this, method.apply(this._wrapped, arguments));
+      return result(this, method.apply(this._wrapped, arguments));
     };
   });
 
-  _.extend(_.prototype, {
+  // Extracts the result from a wrapped and chained object.
+  _.prototype.value = function() {
+    return this._wrapped;
+  };
 
-    // Start chaining a wrapped Underscore object.
-    chain: function() {
-      this._chain = true;
-      return this;
-    },
-
-    // Extracts the result from a wrapped and chained object.
-    value: function() {
-      return this._wrapped;
-    }
-
-  });
+  // Provide unwrapping proxy for some methods used in engine operations
+  // such as arithmetic and JSON stringification.
+  _.prototype.valueOf = _.prototype.toJSON = _.prototype.value;
+  
+  _.prototype.toString = function() {
+    return '' + this._wrapped;
+  };
 
   // AMD registration happens at the end for compatibility with AMD loaders
   // that may not enforce next-turn semantics on modules. Even though general
@@ -1369,7 +1562,7 @@ module.exports = {
       return _;
     });
   }
-}).call(this);
+}.call(this));
 
 },
 {}],
@@ -1416,16 +1609,16 @@ var Lexer    = _dereq_("./lex.js").Lexer;
 var reg      = _dereq_("./reg.js");
 var state    = _dereq_("./state.js").state;
 var style    = _dereq_("./style.js");
+var options  = _dereq_("./options.js");
 
 // We build the application inside a function so that we produce only a singleton
 // variable. That function will be invoked immediately, and its return value is
 // the JSHINT function itself.
 
-var JSHINT = (function () {
+var JSHINT = (function() {
   "use strict";
 
-  var anonname, // The guessed name for anonymous functions.
-    api, // Extension API
+  var api, // Extension API
 
     // These are operators that should not be used with the ! operator.
     bang = {
@@ -1444,153 +1637,6 @@ var JSHINT = (function () {
       "%"  : true
     },
 
-    // These are the JSHint boolean options.
-    boolOptions = {
-      asi         : true, // if automatic semicolon insertion should be tolerated
-      bitwise     : true, // if bitwise operators should not be allowed
-      boss        : true, // if advanced usage of assignments should be allowed
-      browser     : true, // if the standard browser globals should be predefined
-      camelcase   : true, // if identifiers should be required in camel case
-      couch       : true, // if CouchDB globals should be predefined
-      curly       : true, // if curly braces around all blocks should be required
-      debug       : true, // if debugger statements should be allowed
-      devel       : true, // if logging globals should be predefined (console, alert, etc.)
-      dojo        : true, // if Dojo Toolkit globals should be predefined
-      eqeqeq      : true, // if === should be required
-      eqnull      : true, // if == null comparisons should be tolerated
-      notypeof    : true, // if should report typos in typeof comparisons
-      es3         : true, // if ES3 syntax should be allowed
-      es5         : true, // if ES5 syntax should be allowed (is now set per default)
-      esnext      : true, // if es.next specific syntax should be allowed
-      moz         : true, // if mozilla specific syntax should be allowed
-      evil        : true, // if eval should be allowed
-      expr        : true, // if ExpressionStatement should be allowed as Programs
-      forin       : true, // if for in statements must filter
-      funcscope   : true, // if only function scope should be used for scope tests
-      globalstrict: true, // if global "use strict"; should be allowed (also enables 'strict')
-      immed       : true, // if immediate invocations must be wrapped in parens
-      iterator    : true, // if the `__iterator__` property should be allowed
-      jasmine     : true, // Jasmine functions should be predefined
-      jquery      : true, // if jQuery globals should be predefined
-      lastsemic   : true, // if semicolons may be ommitted for the trailing
-                          // statements inside of a one-line blocks.
-      laxbreak    : true, // if line breaks should not be checked
-      laxcomma    : true, // if line breaks should not be checked around commas
-      loopfunc    : true, // if functions should be allowed to be defined within
-                          // loops
-      mootools    : true, // if MooTools globals should be predefined
-      multistr    : true, // allow multiline strings
-      freeze      : true, // if modifying native object prototypes should be disallowed
-      newcap      : true, // if constructor names must be capitalized
-      noarg       : true, // if arguments.caller and arguments.callee should be
-                          // disallowed
-      node        : true, // if the Node.js environment globals should be
-                          // predefined
-      noempty     : true, // if empty blocks should be disallowed
-      nonbsp      : true, // if non-breaking spaces should be disallowed
-      nonew       : true, // if using `new` for side-effects should be disallowed
-      nonstandard : true, // if non-standard (but widely adopted) globals should
-                          // be predefined
-      phantom     : true, // if PhantomJS symbols should be allowed
-      plusplus    : true, // if increment/decrement should not be allowed
-      proto       : true, // if the `__proto__` property should be allowed
-      prototypejs : true, // if Prototype and Scriptaculous globals should be
-                          // predefined
-      qunit       : true, // if the QUnit environment globals should be predefined
-      rhino       : true, // if the Rhino environment globals should be predefined
-      shelljs     : true, // if ShellJS globals should be predefined
-      typed       : true, // if typed array globals should be predefined
-      undef       : true, // if variables should be declared before used
-      scripturl   : true, // if script-targeted URLs should be tolerated
-      strict      : true, // require the "use strict"; pragma
-      sub         : true, // if all forms of subscript notation are tolerated
-      supernew    : true, // if `new function () { ... };` and `new Object;`
-                          // should be tolerated
-      validthis   : true, // if 'this' inside a non-constructor function is valid.
-                          // This is a function scoped option only.
-      withstmt    : true, // if with statements should be allowed
-      worker      : true, // if Web Worker script symbols should be allowed
-      wsh         : true, // if the Windows Scripting Host environment globals
-                          // should be predefined
-      yui         : true, // YUI variables should be predefined
-      mocha       : true, // Mocha functions should be predefined
-      noyield     : true, // allow generators without a yield
-
-      // Obsolete options
-      onecase     : true, // if one case switch statements should be allowed
-      regexp      : true, // if the . should not be allowed in regexp literals
-      regexdash   : true  // if unescaped first/last dash (-) inside brackets
-                          // should be tolerated
-    },
-
-    // These are the JSHint options that can take any value
-    // (we use this object to detect invalid options)
-    valOptions = {
-      maxlen       : false,
-      indent       : false,
-      maxerr       : false,
-      predef       : false, // predef is deprecated and being replaced by globals
-      globals      : false,
-      quotmark     : false, // 'single'|'double'|true
-      scope        : false,
-      maxstatements: false, // {int} max statements per function
-      maxdepth     : false, // {int} max nested block depth per function
-      maxparams    : false, // {int} max params per function
-      maxcomplexity: false, // {int} max cyclomatic complexity per function
-      shadow       : false, // if variable shadowing should be tolerated
-                            //   "inner"  - check for variables defined in the same scope only
-                            //   "outer"  - check for variables defined in outer scopes as well
-                            //   false    - same as inner
-                            //   true     - allow variable shadowing
-      unused       : true,  // warn if variables are unused. Available options:
-                            //   false    - don't check for unused variables
-                            //   true     - "vars" + check last function param
-                            //   "vars"   - skip checking unused function params
-                            //   "strict" - "vars" + check all function params
-      latedef      : false, // warn if the variable is used before its definition
-                            //   false    - don't emit any warnings
-                            //   true     - warn if any variable is used before its definition
-                            //   "nofunc" - warn for any variable but function declarations
-      ignore       : false  // start/end ignoring lines of code, bypassing the lexer
-                            //   start    - start ignoring lines, including the current line
-                            //   end      - stop ignoring lines, starting on the next line
-                            //   line     - ignore warnings / errors for just a single line
-                            //              (this option does not bypass the lexer)
-    },
-
-    // These are JSHint boolean options which are shared with JSLint
-    // where the definition in JSHint is opposite JSLint
-    invertedOptions = {
-      bitwise : true,
-      forin   : true,
-      newcap  : true,
-      plusplus: true,
-      regexp  : true,
-      undef   : true,
-
-      // Inverted and renamed, use JSHint name here
-      eqeqeq  : true,
-      strict  : true
-    },
-
-    // These are JSHint boolean options which are shared with JSLint
-    // where the name has been changed but the effect is unchanged
-    renamedOptions = {
-      eqeq   : "eqeqeq",
-      windows: "wsh",
-      sloppy : "strict"
-    },
-
-    removedOptions = {
-      nomen: true,
-      onevar: true,
-      passfail: true,
-      white: true,
-      gcl: true,
-      smarttabs: true,
-      trailing: true
-    },
-
     declared, // Globals that were declared using /*global ... */ syntax.
     exported, // Variables that are used outside of the current file.
 
@@ -1610,7 +1656,6 @@ var JSHINT = (function () {
     lex,
     member,
     membersOnly,
-    noreach,
     predefined,    // Global variables defined by option
 
     scope,  // The current scope
@@ -1628,8 +1673,8 @@ var JSHINT = (function () {
       return true;
     }
 
-    if (valOptions[name] === undefined && boolOptions[name] === undefined) {
-      if (t.type !== "jslint" && !removedOptions[name]) {
+    if (options.validNames.indexOf(name) === -1) {
+      if (t.type !== "jslint" && !_.has(options.removed, name)) {
         error("E001", t, name);
         return false;
       }
@@ -1681,22 +1726,43 @@ var JSHINT = (function () {
   }
 
   function supplant(str, data) {
-    return str.replace(/\{([^{}]*)\}/g, function (a, b) {
+    return str.replace(/\{([^{}]*)\}/g, function(a, b) {
       var r = data[b];
       return typeof r === "string" || typeof r === "number" ? r : a;
     });
   }
 
   function combine(dest, src) {
-    Object.keys(src).forEach(function (name) {
+    Object.keys(src).forEach(function(name) {
       if (_.has(JSHINT.blacklist, name)) return;
       dest[name] = src[name];
     });
   }
 
+  function processenforceall() {
+    if (state.option.enforceall) {
+      for (var enforceopt in options.bool.enforcing) {
+        if (state.option[enforceopt] === undefined) {
+          state.option[enforceopt] = true;
+        }
+      }
+      for (var relaxopt in options.bool.relaxing) {
+        if (state.option[relaxopt] === undefined) {
+          state.option[relaxopt] = false;
+        }
+      }
+    }
+  }
+
   function assume() {
+    processenforceall();
+
+    if (!state.option.es3) {
+      combine(predefined, vars.ecmaIdentifiers[5]);
+    }
+
     if (state.option.esnext) {
-      combine(predefined, vars.newEcmaIdentifiers);
+      combine(predefined, vars.ecmaIdentifiers[6]);
     }
 
     if (state.option.couch) {
@@ -1745,6 +1811,12 @@ var JSHINT = (function () {
       combine(predefined, vars.typed);
     }
 
+    if (state.option.browserify) {
+      combine(predefined, vars.browser);
+      combine(predefined, vars.typed);
+      combine(predefined, vars.browserify);
+    }
+
     if (state.option.nonstandard) {
       combine(predefined, vars.nonstandard);
     }
@@ -1783,19 +1855,19 @@ var JSHINT = (function () {
 
     // Let's assume that chronologically ES3 < ES5 < ES6/ESNext < Moz
 
-    state.option.inMoz = function (strict) {
+    state.option.inMoz = function(strict) {
       return state.option.moz;
     };
 
-    state.option.inESNext = function (strict) {
+    state.option.inESNext = function(strict) {
       return state.option.moz || state.option.esnext;
     };
 
-    state.option.inES5 = function (/* strict */) {
+    state.option.inES5 = function(/* strict */) {
       return !state.option.es3;
     };
 
-    state.option.inES3 = function (strict) {
+    state.option.inES3 = function(strict) {
       if (strict) {
         return !state.option.moz && !state.option.esnext && state.option.es3;
       }
@@ -1819,14 +1891,16 @@ var JSHINT = (function () {
   }
 
   function isundef(scope, code, token, a) {
-    return JSHINT.undefs.push([scope, code, token, a]);
+    if (!state.ignored[code] && state.option.undef !== false) {
+      JSHINT.undefs.push([scope, code, token, a]);
+    }
   }
 
   function removeIgnoredMessages() {
     var ignored = state.ignoredLines;
 
     if (_.isEmpty(ignored)) return;
-    JSHINT.errors = _.reject(JSHINT.errors, function (err) { return ignored[err.line] });
+    JSHINT.errors = _.reject(JSHINT.errors, function(err) { return ignored[err.line] });
   }
 
   function warning(code, t, a, b, c, d) {
@@ -1949,6 +2023,9 @@ var JSHINT = (function () {
     // if the identifier is from a let, adds it only to the current blockscope
     if (islet) {
       funct["(blockscope)"].current.add(name, type, state.tokens.curr);
+      if (funct["(blockscope)"].atTop() && exported[name]) {
+        state.tokens.curr.exported = true;
+      }
     } else {
       funct["(blockscope)"].shadow(name);
       funct[name] = type;
@@ -1983,7 +2060,7 @@ var JSHINT = (function () {
     var predef = {};
 
     if (nt.type === "globals") {
-      body.forEach(function (g) {
+      body.forEach(function(g) {
         g = g.split(":");
         var key = (g[0] || "").trim();
         var val = (g[1] || "").trim();
@@ -2009,7 +2086,7 @@ var JSHINT = (function () {
     }
 
     if (nt.type === "exported") {
-      body.forEach(function (e) {
+      body.forEach(function(e) {
         exported[e] = true;
       });
     }
@@ -2017,7 +2094,7 @@ var JSHINT = (function () {
     if (nt.type === "members") {
       membersOnly = membersOnly || {};
 
-      body.forEach(function (m) {
+      body.forEach(function(m) {
         var ch1 = m.charAt(0);
         var ch2 = m.charAt(m.length - 1);
 
@@ -2042,7 +2119,7 @@ var JSHINT = (function () {
     ];
 
     if (nt.type === "jshint" || nt.type === "jslint") {
-      body.forEach(function (g) {
+      body.forEach(function(g) {
         g = g.split(":");
         var key = (g[0] || "").trim();
         var val = (g[1] || "").trim();
@@ -2179,10 +2256,10 @@ var JSHINT = (function () {
         var tn;
         if (val === "true" || val === "false") {
           if (nt.type === "jslint") {
-            tn = renamedOptions[key] || key;
+            tn = options.renamed[key] || key;
             state.option[tn] = (val === "true");
 
-            if (invertedOptions[tn] !== undefined) {
+            if (options.inverted[tn] !== undefined) {
               state.option[tn] = !state.option[tn];
             }
           } else {
@@ -2221,9 +2298,19 @@ var JSHINT = (function () {
     return t;
   }
 
+  function peekIgnoreEOL() {
+    var i = 0;
+    var t;
+    do {
+      t = peek(i++);
+    } while (t.id === "(endline)");
+    return t;
+  }
+
   // Produce the next token. It looks for programming errors.
 
   function advance(id, t) {
+
     switch (state.tokens.curr.id) {
     case "(number)":
       if (state.tokens.next.id === ".") {
@@ -2242,10 +2329,6 @@ var JSHINT = (function () {
       break;
     }
 
-    if (state.tokens.curr.type === "(string)" || state.tokens.curr.identifier) {
-      anonname = state.tokens.curr.value;
-    }
-
     if (id && state.tokens.next.id !== id) {
       if (t) {
         if (state.tokens.next.id === "(end)") {
@@ -2286,7 +2369,7 @@ var JSHINT = (function () {
   }
 
   function isInfix(token) {
-    return token.infix || (!token.identifier && !!token.led);
+    return token.infix || (!token.identifier && !token.template && !!token.led);
   }
 
   function isEndOfExpr() {
@@ -2296,11 +2379,15 @@ var JSHINT = (function () {
       return true;
     }
     if (isInfix(next) === isInfix(curr) || (curr.id === "yield" && state.option.inMoz(true))) {
-      return curr.line !== next.line;
+      return curr.line !== startLine(next);
     }
     return false;
   }
 
+  function isBeginOfExpr(prev) {
+    return !prev.left && prev.arity !== "unary";
+  }
+
   // This is the heart of JSHINT, the Pratt parser. In addition to parsing, it
   // is looking for ad hoc lint patterns. We add .fud to Pratt's model, which is
   // like .nud except that it is only used on the first token of a statement.
@@ -2318,6 +2405,8 @@ var JSHINT = (function () {
   function expression(rbp, initial) {
     var left, isArray = false, isObject = false, isLetExpr = false;
 
+    state.nameStack.push();
+
     // if current expression is a let expression
     if (!initial && state.tokens.next.value === "let" && peek(0).value === "(") {
       if (!state.option.inMoz(true)) {
@@ -2328,7 +2417,7 @@ var JSHINT = (function () {
       funct["(blockscope)"].stack();
       advance("let");
       advance("(");
-      state.syntax["let"].fud.call(state.syntax["let"].fud, false);
+      state.tokens.prev.fud();
       advance(")");
     }
 
@@ -2337,7 +2426,7 @@ var JSHINT = (function () {
 
     var isDangerous =
       state.option.asi &&
-      state.tokens.prev.line < state.tokens.curr.line &&
+      state.tokens.prev.line !== startLine(state.tokens.curr) &&
       _.contains(["]", ")"], state.tokens.prev.id) &&
       _.contains(["[", "("], state.tokens.curr.id);
 
@@ -2347,8 +2436,8 @@ var JSHINT = (function () {
     advance();
 
     if (initial) {
-      anonname = "anonymous";
       funct["(verb)"] = state.tokens.curr.value;
+      state.tokens.curr.beginsStmt = true;
     }
 
     if (initial === true && state.tokens.curr.fud) {
@@ -2360,7 +2449,9 @@ var JSHINT = (function () {
         error("E030", state.tokens.curr, state.tokens.curr.id);
       }
 
-      while (rbp < state.tokens.next.lbp && !isEndOfExpr()) {
+      // TODO: use pratt mechanics rather than special casing template tokens
+      while ((rbp < state.tokens.next.lbp || state.tokens.next.type === "(template)") &&
+              !isEndOfExpr()) {
         isArray = state.tokens.curr.value === "Array";
         isObject = state.tokens.curr.value === "Object";
 
@@ -2402,29 +2493,36 @@ var JSHINT = (function () {
     if (isLetExpr) {
       funct["(blockscope)"].unstack();
     }
+
+    state.nameStack.pop();
+
     return left;
   }
 
 
   // Functions for conformance of style.
 
+  function startLine(token) {
+    return token.startLine || token.line;
+  }
+
   function nobreaknonadjacent(left, right) {
     left = left || state.tokens.curr;
     right = right || state.tokens.next;
-    if (!state.option.laxbreak && left.line !== right.line) {
+    if (!state.option.laxbreak && left.line !== startLine(right)) {
       warning("W014", right, right.value);
     }
   }
 
   function nolinebreak(t) {
     t = t || state.tokens.curr;
-    if (t.line !== state.tokens.next.line) {
+    if (t.line !== startLine(state.tokens.next)) {
       warning("E022", t, t.value);
     }
   }
 
   function nobreakcomma(left, right) {
-    if (left.line !== right.line) {
+    if (left.line !== startLine(right)) {
       if (!state.option.laxcomma) {
         if (comma.first) {
           warning("I001");
@@ -2507,7 +2605,9 @@ var JSHINT = (function () {
   }
 
   function delim(s) {
-    return symbol(s, 0);
+    var x = symbol(s, 0);
+    x.delim = true;
+    return x;
   }
 
   function stmt(s, f) {
@@ -2535,9 +2635,9 @@ var JSHINT = (function () {
     var x = symbol(s, 150);
     reserveName(x);
 
-    x.nud = (typeof f === "function") ? f : function () {
-      this.right = expression(150);
+    x.nud = (typeof f === "function") ? f : function() {
       this.arity = "unary";
+      this.right = expression(150);
 
       if (this.id === "++" || this.id === "--") {
         if (state.option.plusplus) {
@@ -2569,7 +2669,7 @@ var JSHINT = (function () {
   }
 
   function FutureReservedWord(name, meta) {
-    var x = type(name, (meta && meta.nud) || function () {
+    var x = type(name, (meta && meta.nud) || function() {
       return this;
     });
 
@@ -2585,7 +2685,7 @@ var JSHINT = (function () {
   }
 
   function reservevar(s, v) {
-    return reserve(s, function () {
+    return reserve(s, function() {
       if (typeof v === "function") {
         v(this);
       }
@@ -2597,7 +2697,7 @@ var JSHINT = (function () {
     var x = symbol(s, p);
     reserveName(x);
     x.infix = true;
-    x.led = function (left) {
+    x.led = function(left) {
       if (!w) {
         nobreaknonadjacent(state.tokens.prev, state.tokens.curr);
       }
@@ -2619,15 +2719,11 @@ var JSHINT = (function () {
   function application(s) {
     var x = symbol(s, 42);
 
-    x.led = function (left) {
-      if (!state.option.inESNext()) {
-        warning("W104", state.tokens.curr, "arrow function syntax (=>)");
-      }
-
+    x.led = function(left) {
       nobreaknonadjacent(state.tokens.prev, state.tokens.curr);
 
       this.left = left;
-      this.right = doFunction(undefined, undefined, false, left);
+      this.right = doFunction({ type: "arrow", loneArg: left });
       return this;
     };
     return x;
@@ -2636,7 +2732,7 @@ var JSHINT = (function () {
   function relation(s, f) {
     var x = symbol(s, 100);
 
-    x.led = function (left) {
+    x.led = function(left) {
       nobreaknonadjacent(state.tokens.prev, state.tokens.curr);
       var right = expression(100);
 
@@ -2688,7 +2784,7 @@ var JSHINT = (function () {
 
     var values = [
       "undefined", "object", "boolean", "number",
-      "string", "function", "xml", "object", "unknown"
+      "string", "function", "xml", "object", "unknown", "symbol"
     ];
 
     if (right.type === "(identifier)" && right.value === "typeof" && left.type === "(string)")
@@ -2697,6 +2793,27 @@ var JSHINT = (function () {
     return false;
   }
 
+  function isGlobalEval(left, state, funct) {
+    var isGlobal = false;
+
+    // permit methods to refer to an "eval" key in their own context
+    if (left.type === "this" && funct["(context)"] === null) {
+      isGlobal = true;
+    }
+    // permit use of "eval" members of objects
+    else if (left.type === "(identifier)") {
+      if (state.option.node && left.value === "global") {
+        isGlobal = true;
+      }
+
+      else if (state.option.browser && (left.value === "window" || left.value === "document")) {
+        isGlobal = true;
+      }
+    }
+
+    return isGlobal;
+  }
+
   function findNativePrototype(left) {
     var natives = [
       "Array", "ArrayBuffer", "Boolean", "Collator", "DataView", "Date",
@@ -2726,7 +2843,7 @@ var JSHINT = (function () {
   }
 
   function assignop(s, f, p) {
-    var x = infix(s, typeof f === "function" ? f : function (left, that) {
+    var x = infix(s, typeof f === "function" ? f : function(left, that) {
       that.left = left;
 
       if (left) {
@@ -2754,11 +2871,12 @@ var JSHINT = (function () {
             warning("E031", that);
           }
 
+          state.nameStack.set(state.tokens.prev);
           that.right = expression(10);
           return that;
         } else if (left.id === "[") {
           if (state.tokens.curr.left.first) {
-            state.tokens.curr.left.first.forEach(function (t) {
+            state.tokens.curr.left.first.forEach(function(t) {
               if (t && funct[t.value] === "const") {
                 error("E013", t, t.value);
               }
@@ -2768,12 +2886,16 @@ var JSHINT = (function () {
           } else if (left.left.value === "arguments" && !state.directive["use strict"]) {
             warning("E031", that);
           }
+
+          state.nameStack.set(left.right);
+
           that.right = expression(10);
           return that;
         } else if (left.identifier && !isReserved(left)) {
           if (funct[left.value] === "exception") {
             warning("W022", left);
           }
+          state.nameStack.set(left);
           that.right = expression(10);
           return that;
         }
@@ -2795,7 +2917,7 @@ var JSHINT = (function () {
   function bitwise(s, f, p) {
     var x = symbol(s, p);
     reserveName(x);
-    x.led = (typeof f === "function") ? f : function (left) {
+    x.led = (typeof f === "function") ? f : function(left) {
       if (state.option.bitwise) {
         warning("W016", this, this.id);
       }
@@ -2808,7 +2930,7 @@ var JSHINT = (function () {
 
 
   function bitwiseassignop(s) {
-    return assignop(s, function (left, that) {
+    return assignop(s, function(left, that) {
       if (state.option.bitwise) {
         warning("W016", that, that.id);
       }
@@ -2832,7 +2954,7 @@ var JSHINT = (function () {
   function suffix(s) {
     var x = symbol(s, 150);
 
-    x.led = function (left) {
+    x.led = function(left) {
       if (state.option.plusplus) {
         warning("W016", this, this.id);
       } else if ((!left.identifier || isReserved(left)) && left.id !== "." && left.id !== "[") {
@@ -2849,12 +2971,14 @@ var JSHINT = (function () {
   // argument (see identifier())
   // prop means that this identifier is that of an object property
 
-  function optionalidentifier(fnparam, prop) {
+  function optionalidentifier(fnparam, prop, preserve) {
     if (!state.tokens.next.identifier) {
       return;
     }
 
-    advance();
+    if (!preserve) {
+      advance();
+    }
 
     var curr = state.tokens.curr;
     var val  = state.tokens.curr.value;
@@ -2881,21 +3005,48 @@ var JSHINT = (function () {
   // argument
   // prop means that this identifier is that of an object property
   function identifier(fnparam, prop) {
-    var i = optionalidentifier(fnparam, prop);
+    var i = optionalidentifier(fnparam, prop, false);
     if (i) {
       return i;
     }
-    if (state.tokens.curr.id === "function" && state.tokens.next.id === "(") {
-      warning("W025");
+
+    // parameter destructuring with rest operator
+    if (state.tokens.next.value === "...") {
+      if (!state.option.esnext) {
+        warning("W119", state.tokens.next, "spread/rest operator");
+      }
+      advance();
+
+      if (checkPunctuators(state.tokens.next, ["..."])) {
+        warning("E024", state.tokens.next, "...");
+        while (checkPunctuators(state.tokens.next, ["..."])) {
+          advance();
+        }
+      }
+
+      if (!state.tokens.next.identifier) {
+        warning("E024", state.tokens.curr, "...");
+        return;
+      }
+
+      return identifier(fnparam, prop);
     } else {
       error("E030", state.tokens.next, state.tokens.next.value);
+
+      // The token should be consumed after a warning is issued so the parser
+      // can continue as though an identifier were found. The semicolon token
+      // should not be consumed in this way so that the parser interprets it as
+      // a statement delimeter;
+      if (state.tokens.next.id !== ";") {
+        advance();
+      }
     }
   }
 
 
-  function reachable(s) {
+  function reachable(controlToken) {
     var i = 0, t;
-    if (state.tokens.next.id !== ";" || noreach) {
+    if (state.tokens.next.id !== ";" || controlToken.inBracelessBlock) {
       return;
     }
     for (;;) {
@@ -2915,7 +3066,7 @@ var JSHINT = (function () {
           break;
         }
 
-        warning("W027", t, t.value, s);
+        warning("W027", t, t.value, controlToken.value);
         break;
       }
     }
@@ -2923,12 +3074,14 @@ var JSHINT = (function () {
 
   function parseFinalSemicolon() {
     if (state.tokens.next.id !== ";") {
+      // don't complain about unclosed templates / strings
+      if (state.tokens.next.isUnclosed) return advance();
       if (!state.option.asi) {
         // If this is the last statement in a block that ends on
         // the same line *and* option lastsemic is on, ignore the warning.
         // Otherwise, complain about missing semicolon.
         if (!state.option.lastsemic || state.tokens.next.id !== "}" ||
-          state.tokens.next.line !== state.tokens.curr.line) {
+          startLine(state.tokens.next) !== state.tokens.curr.line) {
           warningAt("W033", state.tokens.curr.line, state.tokens.curr.character);
         }
       }
@@ -2938,7 +3091,6 @@ var JSHINT = (function () {
   }
 
   function statement() {
-    var values;
     var i = indent, r, s = scope, t = state.tokens.next;
 
     if (t.id === ";") {
@@ -2975,22 +3127,6 @@ var JSHINT = (function () {
       }
     }
 
-    // detect a destructuring assignment
-    if (_.has(["[", "{"], t.value)) {
-      if (lookupBlockType().isDestAssign) {
-        if (!state.option.inESNext()) {
-          warning("W104", state.tokens.curr, "destructuring expression");
-        }
-        values = destructuringExpression();
-        values.forEach(function (tok) {
-          isundef(funct, "W117", tok.token, tok.id);
-        });
-        advance("=");
-        destructuringExpressionMatch(values, expression(10, true));
-        advance(";");
-        return;
-      }
-    }
     if (t.identifier && !res && peek().id === ":") {
       advance();
       advance(":");
@@ -3052,7 +3188,7 @@ var JSHINT = (function () {
   }
 
 
-  function statements(startLine) {
+  function statements() {
     var a = [], p;
 
     while (!state.tokens.next.reach && state.tokens.next.id !== "(end)") {
@@ -3065,7 +3201,7 @@ var JSHINT = (function () {
 
         advance(";");
       } else {
-        a.push(statement(startLine === state.tokens.next.line));
+        a.push(statement());
       }
     }
     return a;
@@ -3080,53 +3216,46 @@ var JSHINT = (function () {
   function directives() {
     var i, p, pn;
 
-    for (;;) {
-      if (state.tokens.next.id === "(string)") {
-        p = peek(0);
-        if (p.id === "(endline)") {
-          i = 1;
-          do {
-            pn = peek(i);
-            i = i + 1;
-          } while (pn.id === "(endline)");
-
-          if (pn.id !== ";") {
-            if (pn.id !== "(string)" && pn.id !== "(number)" &&
-              pn.id !== "(regexp)" && pn.identifier !== true &&
-              pn.id !== "}") {
-              break;
-            }
-            warning("W033", state.tokens.next);
-          } else {
-            p = pn;
-          }
-        } else if (p.id === "}") {
-          // Directive with no other statements, warn about missing semicolon
-          warning("W033", p);
-        } else if (p.id !== ";") {
-          break;
+    while (state.tokens.next.id === "(string)") {
+      p = peek(0);
+      if (p.id === "(endline)") {
+        i = 1;
+        do {
+          pn = peek(i++);
+        } while (pn.id === "(endline)");
+        if (pn.id === ";") {
+          p = pn;
+        } else if (pn.value === "[" || pn.value === ".") {
+          // string -> [ | . is a valid production
+          return;
+        } else if (!state.option.asi || pn.value === "(") {
+          // string -> ( is not a valid production
+          warning("W033", state.tokens.next);
         }
-
-        advance();
-        if (state.directive[state.tokens.curr.value]) {
-          warning("W034", state.tokens.curr, state.tokens.curr.value);
-        }
-
-        if (state.tokens.curr.value === "use strict") {
-          if (!state.option["(explicitNewcap)"])
-            state.option.newcap = true;
-          state.option.undef = true;
-        }
-
-        // there's no directive negation, so always set to true
-        state.directive[state.tokens.curr.value] = true;
-
-        if (p.id === ";") {
-          advance(";");
-        }
-        continue;
+      } else if (p.id === "." || p.id === "[") {
+        return;
+      } else if (p.id !== ";") {
+        warning("W033", p);
+      }
+
+      advance();
+      if (state.directive[state.tokens.curr.value]) {
+        warning("W034", state.tokens.curr, state.tokens.curr.value);
+      }
+
+      if (state.tokens.curr.value === "use strict") {
+        if (!state.option["(explicitNewcap)"]) {
+          state.option.newcap = true;
+        }
+        state.option.undef = true;
+      }
+
+      // there's no directive negation, so always set to true
+      state.directive[state.tokens.curr.value] = true;
+
+      if (p.id === ";") {
+        advance(";");
       }
-      break;
     }
   }
 
@@ -3191,7 +3320,7 @@ var JSHINT = (function () {
           }
         }
 
-        a = statements(line);
+        a = statements();
 
         metrics.statementCount += a.length;
 
@@ -3240,12 +3369,11 @@ var JSHINT = (function () {
         warning("W116", state.tokens.next, "{", state.tokens.next.value);
       }
 
-      noreach = true;
+      state.tokens.next.inBracelessBlock = true;
       indent += state.option.indent;
       // test indentation only if statement is in new line
       a = [statement()];
       indent -= state.option.indent;
-      noreach = false;
 
       delete funct["(nolet)"];
     }
@@ -3268,7 +3396,7 @@ var JSHINT = (function () {
     if (!ordinary || !state.option.funcscope) scope = s;
     inblock = b;
     if (ordinary && state.option.noempty && (!a || a.length === 0)) {
-      warning("W035");
+      warning("W035", state.tokens.prev);
     }
     metrics.nestedBlockDepth -= 1;
     return a;
@@ -3300,15 +3428,11 @@ var JSHINT = (function () {
 
   // Build the syntax table by declaring the syntactic elements of the language.
 
-  type("(number)", function () {
+  type("(number)", function() {
     return this;
   });
 
-  type("(string)", function () {
-    return this;
-  });
-
-  type("(template)", function () {
+  type("(string)", function() {
     return this;
   });
 
@@ -3317,12 +3441,24 @@ var JSHINT = (function () {
     lbp: 0,
     identifier: true,
 
-    nud: function () {
+    nud: function() {
       var v = this.value;
       var s = scope[v];
       var f;
       var block;
 
+      // If this identifier is the lone parameter to a shorthand "fat arrow"
+      // function definition, i.e.
+      //
+      //     x => x;
+      //
+      // ...it should not be considered as a variable in the current scope. It
+      // will be added to the scope of the new function when the next token is
+      // parsed, so it can be safely ignored for now.
+      if (state.tokens.next.id === "=>") {
+        return this;
+      }
+
       if (typeof s === "function") {
         // Protection against accidental inheritance.
         s = undefined;
@@ -3360,33 +3496,6 @@ var JSHINT = (function () {
           warning("W037", state.tokens.curr, v);
           break;
         }
-      } else if (funct["(global)"]) {
-        // The name is not defined in the function.  If we are in the global
-        // scope, then we have an undefined variable.
-        //
-        // Operators typeof and delete do not raise runtime errors even if
-        // the base object of a reference is null so no need to display warning
-        // if we're inside of typeof or delete.
-
-        if (typeof predefined[v] !== "boolean") {
-          // Attempting to subscript a null reference will throw an
-          // error, even within the typeof and delete operators
-          if (!(anonname === "typeof" || anonname === "delete") ||
-            (state.tokens.next && (state.tokens.next.value === "." ||
-              state.tokens.next.value === "["))) {
-
-            // if we're in a list comprehension, variables are declared
-            // locally and used before being defined. So we check
-            // the presence of the given variable in the comp array
-            // before declaring it undefined.
-
-            if (!funct["(comparray)"].check(v)) {
-              isundef(funct, "W117", state.tokens.curr, v);
-            }
-          }
-        }
-
-        note_implied(state.tokens.curr);
       } else {
         // If the name is already defined in the current
         // function, but not as outer, then there is a scope error.
@@ -3413,19 +3522,20 @@ var JSHINT = (function () {
             warning("W039", state.tokens.curr, v);
             note_implied(state.tokens.curr);
           } else if (typeof s !== "object") {
-            // Operators typeof and delete do not raise runtime errors even
-            // if the base object of a reference is null so no need to
-            //
-            // display warning if we're inside of typeof or delete.
-            // Attempting to subscript a null reference will throw an
-            // error, even within the typeof and delete operators
-            if (!(anonname === "typeof" || anonname === "delete") ||
-              (state.tokens.next &&
-                (state.tokens.next.value === "." || state.tokens.next.value === "["))) {
+            // if we're in a list comprehension, variables are declared
+            // locally and used before being defined. So we check
+            // the presence of the given variable in the comp array
+            // before declaring it undefined.
 
+            if (!funct["(comparray)"].check(v)) {
               isundef(funct, "W117", state.tokens.curr, v);
             }
-            funct[v] = true;
+
+            // Explicitly mark the variable as used within function scopes
+            if (!funct["(global)"]) {
+              funct[v] = true;
+            }
+
             note_implied(state.tokens.curr);
           } else {
             switch (s[v]) {
@@ -3455,12 +3565,44 @@ var JSHINT = (function () {
       return this;
     },
 
-    led: function () {
+    led: function() {
       error("E033", state.tokens.next, state.tokens.next.value);
     }
   };
 
-  type("(regexp)", function () {
+  var baseTemplateSyntax = {
+    lbp: 0,
+    identifier: false,
+    template: true,
+  };
+  state.syntax["(template)"] = _.extend({
+    type: "(template)",
+    nud: doTemplateLiteral,
+    led: doTemplateLiteral,
+    noSubst: false
+  }, baseTemplateSyntax);
+
+  state.syntax["(template middle)"] = _.extend({
+    type: "(template middle)",
+    middle: true,
+    noSubst: false
+  }, baseTemplateSyntax);
+
+  state.syntax["(template tail)"] = _.extend({
+    type: "(template tail)",
+    tail: true,
+    noSubst: false
+  }, baseTemplateSyntax);
+
+  state.syntax["(no subst template)"] = _.extend({
+    type: "(template)",
+    nud: doTemplateLiteral,
+    led: doTemplateLiteral,
+    noSubst: true,
+    tail: true // mark as tail, since it's always the last component
+  }, baseTemplateSyntax);
+
+  type("(regexp)", function() {
     return this;
   });
 
@@ -3484,7 +3626,7 @@ var JSHINT = (function () {
   reserve("catch");
   reserve("default").reach = true;
   reserve("finally");
-  reservevar("arguments", function (x) {
+  reservevar("arguments", function(x) {
     if (state.directive["use strict"] && funct["(global)"]) {
       warning("E008", x);
     }
@@ -3493,8 +3635,9 @@ var JSHINT = (function () {
   reservevar("false");
   reservevar("Infinity");
   reservevar("null");
-  reservevar("this", function (x) {
-    if (state.directive["use strict"] && !state.option.validthis && ((funct["(statement)"] &&
+  reservevar("this", function(x) {
+    if (state.directive["use strict"] && !isMethod() &&
+        !state.option.validthis && ((funct["(statement)"] &&
         funct["(name)"].charAt(0) > "Z") || funct["(global)"])) {
       warning("W040", x);
     }
@@ -3506,25 +3649,30 @@ var JSHINT = (function () {
   assignop("+=", "assignadd", 20);
   assignop("-=", "assignsub", 20);
   assignop("*=", "assignmult", 20);
-  assignop("/=", "assigndiv", 20).nud = function () {
+  assignop("/=", "assigndiv", 20).nud = function() {
     error("E014");
   };
   assignop("%=", "assignmod", 20);
 
-  bitwiseassignop("&=", "assignbitand", 20);
-  bitwiseassignop("|=", "assignbitor", 20);
-  bitwiseassignop("^=", "assignbitxor", 20);
-  bitwiseassignop("<<=", "assignshiftleft", 20);
-  bitwiseassignop(">>=", "assignshiftright", 20);
-  bitwiseassignop(">>>=", "assignshiftrightunsigned", 20);
-  infix(",", function (left, that) {
+  bitwiseassignop("&=");
+  bitwiseassignop("|=");
+  bitwiseassignop("^=");
+  bitwiseassignop("<<=");
+  bitwiseassignop(">>=");
+  bitwiseassignop(">>>=");
+  infix(",", function(left, that) {
     var expr;
     that.exprs = [left];
-    if (!comma({peek: true})) {
+
+    if (state.option.nocomma) {
+      warning("W127");
+    }
+
+    if (!comma({ peek: true })) {
       return that;
     }
     while (true) {
-      if (!(expr = expression(10)))  {
+      if (!(expr = expression(10))) {
         break;
       }
       that.exprs.push(expr);
@@ -3535,7 +3683,7 @@ var JSHINT = (function () {
     return that;
   }, 10, true);
 
-  infix("?", function (left, that) {
+  infix("?", function(left, that) {
     increaseComplexityCount();
     that.left = left;
     that.right = expression(10);
@@ -3545,7 +3693,7 @@ var JSHINT = (function () {
   }, 30);
 
   var orPrecendence = 40;
-  infix("||", function (left, that) {
+  infix("||", function(left, that) {
     increaseComplexityCount();
     that.left = left;
     that.right = expression(orPrecendence);
@@ -3555,7 +3703,7 @@ var JSHINT = (function () {
   bitwise("|", "bitor", 70);
   bitwise("^", "bitxor", 80);
   bitwise("&", "bitand", 90);
-  relation("==", function (left, right) {
+  relation("==", function(left, right) {
     var eqnull = state.option.eqnull && (left.value === "null" || right.value === "null");
 
     switch (true) {
@@ -3579,7 +3727,7 @@ var JSHINT = (function () {
 
     return this;
   });
-  relation("===", function (left, right) {
+  relation("===", function(left, right) {
     if (isTypoTypeof(right, left)) {
       warning("W122", this, right.value);
     } else if (isTypoTypeof(left, right)) {
@@ -3587,7 +3735,7 @@ var JSHINT = (function () {
     }
     return this;
   });
-  relation("!=", function (left, right) {
+  relation("!=", function(left, right) {
     var eqnull = state.option.eqnull &&
         (left.value === "null" || right.value === "null");
 
@@ -3605,7 +3753,7 @@ var JSHINT = (function () {
     }
     return this;
   });
-  relation("!==", function (left, right) {
+  relation("!==", function(left, right) {
     if (isTypoTypeof(right, left)) {
       warning("W122", this, right.value);
     } else if (isTypoTypeof(left, right)) {
@@ -3622,8 +3770,11 @@ var JSHINT = (function () {
   bitwise(">>>", "shiftrightunsigned", 120);
   infix("in", "in", 120);
   infix("instanceof", "instanceof", 120);
-  infix("+", function (left, that) {
-    var right = expression(130);
+  infix("+", function(left, that) {
+    var right;
+    that.left = left;
+    that.right = right = expression(130);
+
     if (left && right && left.id === "(string)" && right.id === "(string)") {
       left.value += right.value;
       left.character = right.character;
@@ -3632,18 +3783,17 @@ var JSHINT = (function () {
       }
       return left;
     }
-    that.left = left;
-    that.right = right;
+
     return that;
   }, 130);
   prefix("+", "num");
-  prefix("+++", function () {
+  prefix("+++", function() {
     warning("W007");
-    this.right = expression(150);
     this.arity = "unary";
+    this.right = expression(150);
     return this;
   });
-  infix("+++", function (left) {
+  infix("+++", function(left) {
     warning("W007");
     this.left = left;
     this.right = expression(130);
@@ -3651,13 +3801,13 @@ var JSHINT = (function () {
   }, 130);
   infix("-", "sub", 130);
   prefix("-", "neg");
-  prefix("---", function () {
+  prefix("---", function() {
     warning("W006");
-    this.right = expression(150);
     this.arity = "unary";
+    this.right = expression(150);
     return this;
   });
-  infix("---", function (left) {
+  infix("---", function(left) {
     warning("W006");
     this.left = left;
     this.right = expression(130);
@@ -3667,44 +3817,90 @@ var JSHINT = (function () {
   infix("/", "div", 140);
   infix("%", "mod", 140);
 
-  suffix("++", "postinc");
+  suffix("++");
   prefix("++", "preinc");
   state.syntax["++"].exps = true;
 
-  suffix("--", "postdec");
+  suffix("--");
   prefix("--", "predec");
   state.syntax["--"].exps = true;
-  prefix("delete", function () {
+  prefix("delete", function() {
     var p = expression(10);
-    if (!p || (p.id !== "." && p.id !== "[")) {
+    if (!p) {
+      return this;
+    }
+
+    if (p.id !== "." && p.id !== "[") {
       warning("W051");
     }
     this.first = p;
+
+    // The `delete` operator accepts unresolvable references when not in strict
+    // mode, so the operand may be undefined.
+    if (p.identifier && !state.directive["use strict"]) {
+      p.forgiveUndef = true;
+    }
     return this;
   }).exps = true;
 
-  prefix("~", function () {
+  prefix("~", function() {
     if (state.option.bitwise) {
-      warning("W052", this, "~");
+      warning("W016", this, "~");
     }
+    this.arity = "unary";
     expression(150);
     return this;
   });
 
-  prefix("...", function () {
-    if (!state.option.inESNext()) {
-      warning("W104", this, "spread/rest operator");
+  prefix("...", function() {
+    if (!state.option.esnext) {
+      warning("W119", this, "spread/rest operator");
     }
-    if (!state.tokens.next.identifier) {
+
+    // TODO: Allow all AssignmentExpression
+    // once parsing permits.
+    //
+    // How to handle eg. number, boolean when the built-in
+    // prototype of may have an @@iterator definition?
+    //
+    // Number.prototype[Symbol.iterator] = function * () {
+    //   yield this.valueOf();
+    // };
+    //
+    // var a = [ ...1 ];
+    // console.log(a); // [1];
+    //
+    // for (let n of [...10]) {
+    //    console.log(n);
+    // }
+    // // 10
+    //
+    //
+    // Boolean.prototype[Symbol.iterator] = function * () {
+    //   yield this.valueOf();
+    // };
+    //
+    // var a = [ ...true ];
+    // console.log(a); // [true];
+    //
+    // for (let n of [...false]) {
+    //    console.log(n);
+    // }
+    // // false
+    //
+    if (!state.tokens.next.identifier &&
+        state.tokens.next.type !== "(string)" &&
+          !checkPunctuators(state.tokens.next, ["[", "("])) {
+
       error("E030", state.tokens.next, state.tokens.next.value);
     }
     expression(150);
     return this;
   });
 
-  prefix("!", function () {
-    this.right = expression(150);
+  prefix("!", function() {
     this.arity = "unary";
+    this.right = expression(150);
 
     if (!this.right) { // '!' followed by nothing? Give up.
       quit("E041", this.line || 0);
@@ -3716,8 +3912,18 @@ var JSHINT = (function () {
     return this;
   });
 
-  prefix("typeof", "typeof");
-  prefix("new", function () {
+  prefix("typeof", (function() {
+    var p = expression(150);
+    this.first = p;
+
+    // The `typeof` operator accepts unresolvable references, so the operand
+    // may be undefined.
+    if (p.identifier) {
+      p.forgiveUndef = true;
+    }
+    return this;
+  }));
+  prefix("new", function() {
     var c = expression(155), i;
     if (c && c.id !== "function") {
       if (c.identifier) {
@@ -3730,6 +3936,11 @@ var JSHINT = (function () {
         case "JSON":
           warning("W053", state.tokens.prev, c.value);
           break;
+        case "Symbol":
+          if (state.option.esnext) {
+            warning("W053", state.tokens.prev, c.value);
+          }
+          break;
         case "Function":
           if (!state.option.evil) {
             warning("W054");
@@ -3766,7 +3977,7 @@ var JSHINT = (function () {
 
   prefix("void").exps = true;
 
-  infix(".", function (left, that) {
+  infix(".", function(left, that) {
     var m = identifier(false, true);
 
     if (typeof m === "string") {
@@ -3791,13 +4002,15 @@ var JSHINT = (function () {
     }
 
     if (!state.option.evil && (m === "eval" || m === "execScript")) {
-      warning("W061");
+      if (isGlobalEval(left, state, funct)) {
+        warning("W061");
+      }
     }
 
     return that;
   }, 160, true);
 
-  infix("(", function (left, that) {
+  infix("(", function(left, that) {
     if (state.option.immed && left && !left.immed && left.id === "function") {
       warning("W062");
     }
@@ -3808,7 +4021,7 @@ var JSHINT = (function () {
     if (left) {
       if (left.type === "(identifier)") {
         if (left.value.match(/^[A-Z]([A-Z0-9_$]*[a-z][A-Za-z0-9_$]*)?$/)) {
-          if ("Number String Boolean Date Object Error".indexOf(left.value) === -1) {
+          if ("Number String Boolean Date Object Error Symbol".indexOf(left.value) === -1) {
             if (left.value === "Math") {
               warning("W063", left);
             } else if (state.option.newcap) {
@@ -3862,8 +4075,8 @@ var JSHINT = (function () {
       }
       if (!left.identifier && left.id !== "." && left.id !== "[" &&
           left.id !== "(" && left.id !== "&&" && left.id !== "||" &&
-          left.id !== "?") {
-        warning("W067", left);
+          left.id !== "?" && !(state.option.esnext && left["(name)"])) {
+        warning("W067", that);
       }
     }
 
@@ -3871,15 +4084,15 @@ var JSHINT = (function () {
     return that;
   }, 155, true).exps = true;
 
-  prefix("(", function () {
-    var bracket, brackets = [];
-    var pn, pn1, i = 0;
-    var ret;
+  prefix("(", function() {
+    var pn = state.tokens.next, pn1, i = -1;
+    var ret, triggerFnExpr, first, last;
     var parens = 1;
+    var opening = state.tokens.curr;
+    var preceeding = state.tokens.prev;
+    var isNecessary = !state.option.singleGroups;
 
     do {
-      pn = peek(i);
-
       if (pn.value === "(") {
         parens += 1;
       } else if (pn.value === ")") {
@@ -3887,31 +4100,35 @@ var JSHINT = (function () {
       }
 
       i += 1;
-      pn1 = peek(i);
-    } while (!(parens === 0 && pn.value === ")") &&
-             pn1.value !== "=>" && pn1.value !== ";" && pn1.type !== "(end)");
+      pn1 = pn;
+      pn = peek(i);
+    } while (!(parens === 0 && pn1.value === ")") && pn.value !== ";" && pn.type !== "(end)");
 
     if (state.tokens.next.id === "function") {
-      state.tokens.next.immed = true;
+      triggerFnExpr = state.tokens.next.immed = true;
+    }
+
+    // If the balanced grouping operator is followed by a "fat arrow", the
+    // current token marks the beginning of a "fat arrow" function and parsing
+    // should proceed accordingly.
+    if (pn.value === "=>") {
+      return doFunction({ type: "arrow", parsedOpening: true });
     }
 
     var exprs = [];
 
     if (state.tokens.next.id !== ")") {
       for (;;) {
-        if (pn1.value === "=>" && _.contains(["{", "["], state.tokens.next.value)) {
-          bracket = state.tokens.next;
-          bracket.left = destructuringExpression();
-          brackets.push(bracket);
-          for (var t in bracket.left) {
-            exprs.push(bracket.left[t].token);
-          }
-        } else {
-          exprs.push(expression(10));
-        }
+        exprs.push(expression(10));
+
         if (state.tokens.next.id !== ",") {
           break;
         }
+
+        if (state.option.nocomma) {
+          warning("W127");
+        }
+
         comma();
       }
     }
@@ -3919,36 +4136,69 @@ var JSHINT = (function () {
     advance(")", this);
     if (state.option.immed && exprs[0] && exprs[0].id === "function") {
       if (state.tokens.next.id !== "(" &&
-        (state.tokens.next.id !== "." || (peek().value !== "call" && peek().value !== "apply"))) {
+        state.tokens.next.id !== "." && state.tokens.next.id !== "[") {
         warning("W068", this);
       }
     }
 
-    if (state.tokens.next.value === "=>") {
-      return exprs;
-    }
     if (!exprs.length) {
       return;
     }
     if (exprs.length > 1) {
       ret = Object.create(state.syntax[","]);
       ret.exprs = exprs;
+
+      first = exprs[0];
+      last = exprs[exprs.length - 1];
+
+      if (!isNecessary) {
+        isNecessary = preceeding.assign || preceeding.delim;
+      }
     } else {
-      ret = exprs[0];
+      ret = first = last = exprs[0];
+
+      if (!isNecessary) {
+        isNecessary =
+          // Used to distinguish from an ExpressionStatement which may not
+          // begin with the `{` and `function` tokens
+          (opening.beginsStmt && (ret.id === "{" || triggerFnExpr || isFunctor(ret))) ||
+          // Used as the return value of a single-statement arrow function
+          (ret.id === "{" && preceeding.id === "=>") ||
+          // Used to prevent left-to-right application of adjacent addition
+          // operators (the order of which effect type)
+          (first.id === "+" && preceeding.id === "+");
+      }
     }
+
     if (ret) {
+      // The operator may be necessary to override the default binding power of
+      // neighboring operators (whenever there is an operator in use within the
+      // first expression *or* the current group contains multiple expressions)
+      if (!isNecessary && (first.left || ret.exprs)) {
+        isNecessary =
+          (!isBeginOfExpr(preceeding) && first.lbp < preceeding.lbp) ||
+          (!isEndOfExpr() && last.lbp < state.tokens.next.lbp);
+      }
+
+      if (!isNecessary) {
+        warning("W126", opening);
+      }
+
       ret.paren = true;
     }
+
     return ret;
   });
 
   application("=>");
 
-  infix("[", function (left, that) {
+  infix("[", function(left, that) {
     var e = expression(10), s;
     if (e && e.type === "(string)") {
       if (!state.option.evil && (e.value === "eval" || e.value === "execScript")) {
-        warning("W061", that);
+        if (isGlobalEval(left, state, funct)) {
+          warning("W061");
+        }
       }
 
       countMember(e.value);
@@ -4023,8 +4273,8 @@ var JSHINT = (function () {
     return res;
   }
 
-  prefix("[", function () {
-    var blocktype = lookupBlockType(true);
+  prefix("[", function() {
+    var blocktype = lookupBlockType();
     if (blocktype.isCompArray) {
       if (!state.option.inESNext()) {
         warning("W119", state.tokens.curr, "array comprehension");
@@ -4033,7 +4283,7 @@ var JSHINT = (function () {
     } else if (blocktype.isDestAssign && !state.option.inESNext()) {
       warning("W104", state.tokens.curr, "destructuring assignment");
     }
-    var b = state.tokens.curr.line !== state.tokens.next.line;
+    var b = state.tokens.curr.line !== startLine(state.tokens.next);
     this.first = [];
     if (b) {
       indent += state.option.indent;
@@ -4043,8 +4293,19 @@ var JSHINT = (function () {
     }
     while (state.tokens.next.id !== "(end)") {
       while (state.tokens.next.id === ",") {
-        if (!state.option.inES5())
-          warning("W070");
+        if (!state.option.elision) {
+          if (!state.option.inES5()) {
+            // Maintain compat with old options --- ES5 mode without
+            // elision=true will warn once per comma
+            warning("W070");
+          } else {
+            warning("W128");
+            do {
+              advance(",");
+            } while (state.tokens.next.id === ",");
+            continue;
+          }
+        }
         advance(",");
       }
 
@@ -4068,20 +4329,45 @@ var JSHINT = (function () {
     }
     advance("]", this);
     return this;
-  }, 160);
+  });
 
 
-  function property_name() {
-    var id = optionalidentifier(false, true);
+  function isMethod() {
+    return funct["(statement)"] && funct["(statement)"].type === "class" ||
+           funct["(context)"] && funct["(context)"]["(verb)"] === "class";
+  }
+
+
+  function isPropertyName(token) {
+    return token.identifier || token.id === "(string)" || token.id === "(number)";
+  }
+
+
+  function propertyName(preserveOrToken) {
+    var id;
+    var preserve = true;
+    if (typeof preserveOrToken === "object") {
+      id = preserveOrToken;
+    } else {
+      preserve = preserveOrToken;
+      id = optionalidentifier(false, true, preserve);
+    }
 
     if (!id) {
       if (state.tokens.next.id === "(string)") {
         id = state.tokens.next.value;
-        advance();
+        if (!preserve) {
+          advance();
+        }
       } else if (state.tokens.next.id === "(number)") {
         id = state.tokens.next.value.toString();
-        advance();
+        if (!preserve) {
+          advance();
+        }
       }
+    } else if (typeof id === "object") {
+      if (id.id === "(string)" || id.id === "(identifier)") id = id.value;
+      else if (id.id === "(number)") id = id.value.toString();
     }
 
     if (id === "hasOwnProperty") {
@@ -4091,40 +4377,34 @@ var JSHINT = (function () {
     return id;
   }
 
-  function functionparams(parsed) {
-    var curr, next;
+  /**
+   * @param {Object} [options]
+   * @param {token} [options.loneArg] The argument to the function in cases
+   *                                  where it was defined using the
+   *                                  single-argument shorthand.
+   * @param {bool} [options.parsedOpening] Whether the opening parenthesis has
+   *                                       already been parsed.
+   */
+  function functionparams(options) {
+    var next;
     var params = [];
     var ident;
     var tokens = [];
     var t;
     var pastDefault = false;
+    var pastRest = false;
+    var loneArg = options && options.loneArg;
 
-    if (parsed) {
-      if (Array.isArray(parsed)) {
-        for (var i in parsed) {
-          curr = parsed[i];
-          if (curr.value === "...") {
-            if (!state.option.inESNext()) {
-              warning("W104", curr, "spread/rest operator");
-            }
-            continue;
-          } else if (curr.value !== ",") {
-            params.push(curr.value);
-            addlabel(curr.value, { type: "unused", token: curr });
-          }
-        }
-        return params;
-      } else {
-        if (parsed.identifier === true) {
-          addlabel(parsed.value, { type: "unused", token: parsed });
-          return [parsed];
-        }
-      }
+    if (loneArg && loneArg.identifier === true) {
+      addlabel(loneArg.value, { type: "unused", token: loneArg });
+      return [loneArg];
     }
 
     next = state.tokens.next;
 
-    advance("(");
+    if (!options || !options.parsedOpening) {
+      advance("(");
+    }
 
     if (state.tokens.next.id === ")") {
       advance(")");
@@ -4141,18 +4421,16 @@ var JSHINT = (function () {
             addlabel(t.id, { type: "unused", token: t.token });
           }
         }
-      } else if (state.tokens.next.value === "...") {
-        if (!state.option.inESNext()) {
-          warning("W104", state.tokens.next, "spread/rest operator");
-        }
-        advance("...");
-        ident = identifier(true);
-        params.push(ident);
-        addlabel(ident, { type: "unused", token: state.tokens.curr });
       } else {
+        if (checkPunctuators(state.tokens.next, ["..."])) pastRest = true;
         ident = identifier(true);
-        params.push(ident);
-        addlabel(ident, { type: "unused", token: state.tokens.curr });
+        if (ident) {
+          params.push(ident);
+          addlabel(ident, { type: "unused", token: state.tokens.curr });
+        } else {
+          // Skip invalid parameter.
+          while (!checkPunctuators(state.tokens.next, [",", ")"])) advance();
+        }
       }
 
       // it is a syntax error to have a regular argument after a default argument
@@ -4170,6 +4448,9 @@ var JSHINT = (function () {
         expression(10);
       }
       if (state.tokens.next.id === ",") {
+        if (pastRest) {
+          warning("W131", state.tokens.next);
+        }
         comma();
       } else {
         advance(")", next);
@@ -4234,20 +4515,84 @@ var JSHINT = (function () {
     return funct;
   }
 
-  function doFunction(name, statement, generator, fatarrowparams) {
-    var f;
+  function isFunctor(token) {
+    return "(scope)" in token;
+  }
+
+  function doTemplateLiteral(left) {
+    // ASSERT: this.type === "(template)"
+    // jshint validthis: true
+    var ctx = this.context;
+    var noSubst = this.noSubst;
+    var depth = this.depth;
+
+    if (!noSubst) {
+      while (!end() && state.tokens.next.id !== "(end)") {
+        if (!state.tokens.next.template || state.tokens.next.depth > depth) {
+          expression(0); // should probably have different rbp?
+        } else {
+          // skip template start / middle
+          advance();
+        }
+      }
+    }
+
+    return {
+      id: "(template)",
+      type: "(template)",
+      tag: left
+    };
+
+    function end() {
+      if (state.tokens.curr.template && state.tokens.curr.tail &&
+          state.tokens.curr.context === ctx) return true;
+      var complete = (state.tokens.next.template && state.tokens.next.tail &&
+                      state.tokens.next.context === ctx);
+      if (complete) advance();
+      return complete || state.tokens.next.isUnclosed;
+    }
+  }
+
+  /**
+   * @param {Object} [options]
+   * @param {token} [options.name] The identifier belonging to the function (if
+   *                               any)
+   * @param {boolean} [options.statement] The statement that triggered creation
+   *                                      of the current function.
+   * @param {string} [options.type] If specified, either "generator" or "arrow"
+   * @param {token} [options.loneArg] The argument to the function in cases
+   *                                  where it was defined using the
+   *                                  single-argument shorthand
+   * @param {bool} [options.parsedOpening] Whether the opening parenthesis has
+   *                                       already been parsed
+   * @param {token} [options.classExprBinding] Define a function with this
+   *                                           identifier in the new function's
+   *                                           scope, mimicking the bahavior of
+   *                                           class expression names within
+   *                                           the body of member functions.
+   */
+  function doFunction(options) {
+    var f, name, statement, classExprBinding, isGenerator, isArrow;
     var oldOption = state.option;
     var oldIgnored = state.ignored;
     var oldScope  = scope;
 
+    if (options) {
+      name = options.name;
+      statement = options.statement;
+      classExprBinding = options.classExprBinding;
+      isGenerator = options.type === "generator";
+      isArrow = options.type === "arrow";
+    }
+
     state.option = Object.create(state.option);
     state.ignored = Object.create(state.ignored);
     scope = Object.create(scope);
 
-    funct = functor(name || "\"" + anonname + "\"", state.tokens.next, scope, {
+    funct = functor(name || state.nameStack.infer(), state.tokens.next, scope, {
       "(statement)": statement,
       "(context)":   funct,
-      "(generator)": generator ? true : null
+      "(generator)": isGenerator
     });
 
     f = funct;
@@ -4259,21 +4604,27 @@ var JSHINT = (function () {
       addlabel(name, { type: "function" });
     }
 
-    funct["(params)"] = functionparams(fatarrowparams);
+    if (classExprBinding) {
+      addlabel(classExprBinding, { type: "function" });
+    }
+
+    funct["(params)"] = functionparams(options);
     funct["(metrics)"].verifyMaxParametersPerFunction(funct["(params)"]);
 
-    // So we parse fat-arrow functions after we encounter =>. So basically
-    // doFunction is called with the left side of => as its last argument.
-    // This means that the parser, at that point, had already added its
-    // arguments to the undefs array and here we undo that.
+    if (isArrow) {
+      if (!state.option.esnext) {
+        warning("W119", state.tokens.curr, "arrow function syntax (=>)");
+      }
 
-    JSHINT.undefs = _.filter(JSHINT.undefs, function (item) {
-      return !_.contains(_.union(fatarrowparams), item[2]);
-    });
+      if (!options.loneArg) {
+        advance("=>");
+      }
+    }
 
-    block(false, true, true, fatarrowparams ? true : false);
+    block(false, true, true, isArrow);
 
-    if (!state.option.noyield && generator && funct["(generator)"] !== "yielded") {
+    if (!state.option.noyield && isGenerator &&
+        funct["(generator)"] !== "yielded") {
       warning("W124", state.tokens.curr);
     }
 
@@ -4287,7 +4638,7 @@ var JSHINT = (function () {
     funct["(last)"] = state.tokens.curr.line;
     funct["(lastcharacter)"] = state.tokens.curr.character;
 
-    _.map(Object.keys(funct), function (key) {
+    _.map(Object.keys(funct), function(key) {
       if (key[0] === "(") return;
       funct["(blockscope)"].unshadow(key);
     });
@@ -4303,14 +4654,14 @@ var JSHINT = (function () {
       nestedBlockDepth: -1,
       ComplexityCount: 1,
 
-      verifyMaxStatementsPerFunction: function () {
+      verifyMaxStatementsPerFunction: function() {
         if (state.option.maxstatements &&
           this.statementCount > state.option.maxstatements) {
           warning("W071", functionStartToken, this.statementCount);
         }
       },
 
-      verifyMaxParametersPerFunction: function (params) {
+      verifyMaxParametersPerFunction: function(params) {
         params = params || [];
 
         if (state.option.maxparams && params.length > state.option.maxparams) {
@@ -4318,7 +4669,7 @@ var JSHINT = (function () {
         }
       },
 
-      verifyMaxNestedBlockDepthPerFunction: function () {
+      verifyMaxNestedBlockDepthPerFunction: function() {
         if (state.option.maxdepth &&
           this.nestedBlockDepth > 0 &&
           this.nestedBlockDepth === state.option.maxdepth + 1) {
@@ -4326,7 +4677,7 @@ var JSHINT = (function () {
         }
       },
 
-      verifyMaxComplexityPerFunction: function () {
+      verifyMaxComplexityPerFunction: function() {
         var max = state.option.maxcomplexity;
         var cc = this.ComplexityCount;
         if (max && cc > max) {
@@ -4369,48 +4720,27 @@ var JSHINT = (function () {
     }
   }
 
+  /**
+   * @param {object} props Collection of property descriptors for a given
+   *                       object.
+   */
+  function checkProperties(props) {
+    // Check for lonely setters if in the ES5 mode.
+    if (state.option.inES5()) {
+      for (var name in props) {
+        if (_.has(props, name) && props[name].setterToken && !props[name].getterToken) {
+          warning("W078", props[name].setterToken);
+        }
+      }
+    }
+  }
 
-  (function (x) {
-    x.nud = function (isclassdef) {
-      var b, f, i, p, t, g;
+  (function(x) {
+    x.nud = function() {
+      var b, f, i, p, t, g, nextVal;
       var props = {}; // All properties, including accessors
-      var tag = "";
 
-      function saveProperty(name, tkn) {
-        if (props[name] && _.has(props, name))
-          warning("W075", state.tokens.next, i);
-        else
-          props[name] = {};
-
-        props[name].basic = true;
-        props[name].basictkn = tkn;
-      }
-
-      function saveSetter(name, tkn) {
-        if (props[name] && _.has(props, name)) {
-          if (props[name].basic || props[name].setter)
-            warning("W075", state.tokens.next, i);
-        } else {
-          props[name] = {};
-        }
-
-        props[name].setter = true;
-        props[name].setterToken = tkn;
-      }
-
-      function saveGetter(name) {
-        if (props[name] && _.has(props, name)) {
-          if (props[name].basic || props[name].getter)
-            warning("W075", state.tokens.next, i);
-        } else {
-          props[name] = {};
-        }
-
-        props[name].getter = true;
-        props[name].getterToken = state.tokens.curr;
-      }
-
-      b = state.tokens.curr.line !== state.tokens.next.line;
+      b = state.tokens.curr.line !== startLine(state.tokens.next);
       if (b) {
         indent += state.option.indent;
         if (state.tokens.next.from === indent + state.option.indent) {
@@ -4423,19 +4753,15 @@ var JSHINT = (function () {
           break;
         }
 
-        if (isclassdef && state.tokens.next.value === "static") {
-          advance("static");
-          tag = "static ";
-        }
+        nextVal = state.tokens.next.value;
+        if (peek().id !== ":" && (nextVal === "get" || nextVal === "set")) {
+          advance(nextVal);
 
-        if (state.tokens.next.value === "get" && peek().id !== ":") {
-          advance("get");
-
-          if (!state.option.inES5(!isclassdef)) {
+          if (!state.option.inES5()) {
             error("E034");
           }
 
-          i = property_name();
+          i = propertyName();
 
           // ES6 allows for get() {...} and set() {...} method
           // definition shorthand syntax, so we don't produce an error
@@ -4444,16 +4770,10 @@ var JSHINT = (function () {
             error("E035");
           }
 
-          // It is a Syntax Error if PropName of MethodDefinition is
-          // "constructor" and SpecialMethod of MethodDefinition is true.
-          if (isclassdef && i === "constructor") {
-            error("E049", state.tokens.next, "class getter method", i);
-          }
-
           // We don't want to save this getter unless it's an actual getter
           // and not an ES6 concise method
           if (i) {
-            saveGetter(tag + i);
+            saveAccessor(nextVal, props, i, state.tokens.curr);
           }
 
           t = state.tokens.next;
@@ -4461,47 +4781,12 @@ var JSHINT = (function () {
           p = f["(params)"];
 
           // Don't warn about getter/setter pairs if this is an ES6 concise method
-          if (i && p) {
+          if (nextVal === "get" && i && p) {
             warning("W076", t, p[0], i);
-          }
-        } else if (state.tokens.next.value === "set" && peek().id !== ":") {
-          advance("set");
-
-          if (!state.option.inES5(!isclassdef)) {
-            error("E034");
-          }
-
-          i = property_name();
-
-          // ES6 allows for get() {...} and set() {...} method
-          // definition shorthand syntax, so we don't produce an error
-          // if the esnext option is enabled.
-          if (!i && !state.option.inESNext()) {
-            error("E035");
-          }
-
-          // It is a Syntax Error if PropName of MethodDefinition is
-          // "constructor" and SpecialMethod of MethodDefinition is true.
-          if (isclassdef && i === "constructor") {
-            error("E049", state.tokens.next, "class setter method", i);
-          }
-
-          // We don't want to save this getter unless it's an actual getter
-          // and not an ES6 concise method
-          if (i) {
-            saveSetter(tag + i, state.tokens.next);
-          }
-
-          t = state.tokens.next;
-          f = doFunction();
-          p = f["(params)"];
-
-          // Don't warn about getter/setter pairs if this is an ES6 concise method
-          if (i && (!p || p.length !== 1)) {
+          } else if (nextVal === "set" && i && (!p || p.length !== 1)) {
             warning("W077", t, i);
           }
         } else {
-          g = false;
           if (state.tokens.next.value === "*" && state.tokens.next.type === "(punctuator)") {
             if (!state.option.inESNext()) {
               warning("W104", state.tokens.next, "generator functions");
@@ -4509,33 +4794,43 @@ var JSHINT = (function () {
             advance("*");
             g = true;
           }
-          i = property_name();
-          saveProperty(tag + i, state.tokens.next);
-
-          if (typeof i !== "string") {
-            break;
-          }
-
-          if (state.tokens.next.value === "(") {
+          if (state.tokens.next.identifier &&
+              (peekIgnoreEOL().id === "," || peekIgnoreEOL().id === "}")) {
             if (!state.option.inESNext()) {
-              warning("W104", state.tokens.curr, "concise methods");
+              warning("W104", state.tokens.next, "object short notation");
             }
-            doFunction(i, undefined, g);
-          } else if (!isclassdef) {
-            advance(":");
+            i = propertyName(true);
+            saveProperty(props, i, state.tokens.next);
+
             expression(10);
+          } else {
+            if (state.tokens.next.id === "[") {
+              i = computedPropertyName();
+              state.nameStack.set(i);
+            } else {
+              state.nameStack.set(state.tokens.next);
+              i = propertyName();
+              saveProperty(props, i, state.tokens.next);
+
+              if (typeof i !== "string") {
+                break;
+              }
+            }
+
+            if (state.tokens.next.value === "(") {
+              if (!state.option.inESNext()) {
+                warning("W104", state.tokens.curr, "concise methods");
+              }
+              doFunction({ type: g ? "generator" : null });
+            } else {
+              advance(":");
+              expression(10);
+            }
           }
         }
-        // It is a Syntax Error if PropName of MethodDefinition is "prototype".
-        if (isclassdef && i === "prototype") {
-          error("E049", state.tokens.next, "class method", i);
-        }
 
         countMember(i);
-        if (isclassdef) {
-          tag = "";
-          continue;
-        }
+
         if (state.tokens.next.id === ",") {
           comma({ allowTrailing: true, property: true });
           if (state.tokens.next.id === ",") {
@@ -4552,17 +4847,11 @@ var JSHINT = (function () {
       }
       advance("}", this);
 
-      // Check for lonely setters if in the ES5 mode.
-      if (state.option.inES5()) {
-        for (var name in props) {
-          if (_.has(props, name) && props[name].setter && !props[name].getter) {
-            warning("W078", props[name].setterToken);
-          }
-        }
-      }
+      checkProperties(props);
+
       return this;
     };
-    x.fud = function () {
+    x.fud = function() {
       error("E036", state.tokens.curr);
     };
   }(delim("{")));
@@ -4573,47 +4862,68 @@ var JSHINT = (function () {
     if (!state.option.inESNext()) {
       warning("W104", state.tokens.curr, "destructuring expression");
     }
-    var nextInnerDE = function () {
+    var nextInnerDE = function() {
       var ident;
-      if (_.contains(["[", "{"], state.tokens.next.value)) {
+      if (checkPunctuators(state.tokens.next, ["[", "{"])) {
         ids = destructuringExpression();
         for (var id in ids) {
           id = ids[id];
           identifiers.push({ id: id.id, token: id.token });
         }
-      } else if (state.tokens.next.value === ",") {
+      } else if (checkPunctuators(state.tokens.next, [","])) {
         identifiers.push({ id: null, token: state.tokens.curr });
-      } else if (state.tokens.next.value === "(") {
+      } else if (checkPunctuators(state.tokens.next, ["("])) {
         advance("(");
         nextInnerDE();
         advance(")");
       } else {
+        var is_rest = checkPunctuators(state.tokens.next, ["..."]);
         ident = identifier();
         if (ident)
           identifiers.push({ id: ident, token: state.tokens.curr });
+        return is_rest;
       }
+      return false;
     };
-    if (state.tokens.next.value === "[") {
+    if (checkPunctuators(state.tokens.next, ["["])) {
       advance("[");
-      nextInnerDE();
-      while (state.tokens.next.value !== "]") {
+      var element_after_rest = false;
+      if (nextInnerDE() && checkPunctuators(state.tokens.next, [","]) &&
+          !element_after_rest) {
+        warning("W130", state.tokens.next);
+        element_after_rest = true;
+      }
+      while (!checkPunctuators(state.tokens.next, ["]"])) {
         advance(",");
-        nextInnerDE();
+        if (checkPunctuators(state.tokens.next, ["]"])) {
+          // Trailing comma
+          break;
+        }
+        if (nextInnerDE() && checkPunctuators(state.tokens.next, [","]) &&
+            !element_after_rest) {
+          warning("W130", state.tokens.next);
+          element_after_rest = true;
+        }
       }
       advance("]");
-    } else if (state.tokens.next.value === "{") {
+    } else if (checkPunctuators(state.tokens.next, ["{"])) {
       advance("{");
       id = identifier();
-      if (state.tokens.next.value === ":") {
+      if (checkPunctuators(state.tokens.next, [":"])) {
         advance(":");
         nextInnerDE();
       } else {
         identifiers.push({ id: id, token: state.tokens.curr });
       }
-      while (state.tokens.next.value !== "}") {
+      while (!checkPunctuators(state.tokens.next, ["}"])) {
         advance(",");
+        if (checkPunctuators(state.tokens.next, ["}"])) {
+          // Trailing comma
+          // ObjectBindingPattern: { BindingPropertyList , }
+          break;
+        }
         id = identifier();
-        if (state.tokens.next.value === ":") {
+        if (checkPunctuators(state.tokens.next, [":"])) {
           advance(":");
           nextInnerDE();
         } else {
@@ -4631,7 +4941,7 @@ var JSHINT = (function () {
     if (!first)
       return;
 
-    _.zip(tokens, Array.isArray(first) ? first : [ first ]).forEach(function (val) {
+    _.zip(tokens, Array.isArray(first) ? first : [ first ]).forEach(function(val) {
       var token = val[0];
       var value = val[1];
 
@@ -4642,7 +4952,9 @@ var JSHINT = (function () {
     });
   }
 
-  var conststatement = stmt("const", function (prefix) {
+  var conststatement = stmt("const", function(context) {
+    var prefix = context && context.prefix;
+    var inexport = context && context.inexport;
     var tokens;
     var value;
     var lone; // State variable to know if it is a lone identifier, or a destructuring statement.
@@ -4659,6 +4971,10 @@ var JSHINT = (function () {
       } else {
         tokens = [ { id: identifier(), token: state.tokens.curr } ];
         lone = true;
+        if (inexport) {
+          exported[state.tokens.curr.value] = true;
+          state.tokens.curr.exported = true;
+        }
       }
       for (var t in tokens) {
         if (tokens.hasOwnProperty(t)) {
@@ -4710,9 +5026,11 @@ var JSHINT = (function () {
   });
 
   conststatement.exps = true;
-  var varstatement = stmt("var", function (prefix) {
+  var varstatement = stmt("var", function(context) {
     // JavaScript does not have block scope. It only has function scope. So,
     // declaring a variable in a block can have unexpected consequences.
+    var prefix = context && context.prefix;
+    var inexport = context && context.inexport;
     var tokens, lone, value;
 
     this.first = [];
@@ -4724,6 +5042,10 @@ var JSHINT = (function () {
       } else {
         tokens = [ { id: identifier(), token: state.tokens.curr } ];
         lone = true;
+        if (inexport) {
+          exported[state.tokens.curr.value] = true;
+          state.tokens.curr.exported = true;
+        }
       }
       for (var t in tokens) {
         if (tokens.hasOwnProperty(t)) {
@@ -4731,8 +5053,15 @@ var JSHINT = (function () {
           if (state.option.inESNext() && funct[t.id] === "const") {
             warning("E011", null, t.id);
           }
-          if (funct["(global)"] && predefined[t.id] === false) {
-            warning("W079", t.token, t.id);
+          if (funct["(global)"]) {
+            if (predefined[t.id] === false) {
+              warning("W079", t.token, t.id);
+            } else if (state.option.futurehostile === false) {
+              if ((!state.option.inES5() && vars.ecmaIdentifiers[5][t.id] === false) ||
+                (!state.option.inESNext() && vars.ecmaIdentifiers[6][t.id] === false)) {
+                warning("W129", t.token, t.id);
+              }
+            }
           }
           if (t.id) {
             addlabel(t.id, { type: "unused", token: t.token });
@@ -4747,12 +5076,15 @@ var JSHINT = (function () {
       this.first = this.first.concat(names);
 
       if (state.tokens.next.id === "=") {
+        state.nameStack.set(state.tokens.curr);
         advance("=");
         if (state.tokens.next.id === "undefined") {
           warning("W080", state.tokens.prev, state.tokens.prev.value);
         }
         if (peek(0).id === "=" && state.tokens.next.identifier) {
-          warning("W120", state.tokens.next, state.tokens.next.value);
+          if (!funct["(params)"] || funct["(params)"].indexOf(state.tokens.next.value) === -1) {
+            warning("W120", state.tokens.next, state.tokens.next.value);
+          }
         }
         value = expression(10);
         if (lone) {
@@ -4771,7 +5103,9 @@ var JSHINT = (function () {
   });
   varstatement.exps = true;
 
-  var letstatement = stmt("let", function (prefix) {
+  var letstatement = stmt("let", function(context) {
+    var prefix = context && context.prefix;
+    var inexport = context && context.inexport;
     var tokens, lone, value, letblock;
 
     if (!state.option.inESNext()) {
@@ -4798,6 +5132,10 @@ var JSHINT = (function () {
       } else {
         tokens = [ { id: identifier(), token: state.tokens.curr.value } ];
         lone = true;
+        if (inexport) {
+          exported[state.tokens.curr.value] = true;
+          state.tokens.curr.exported = true;
+        }
       }
       for (var t in tokens) {
         if (tokens.hasOwnProperty(t)) {
@@ -4852,22 +5190,26 @@ var JSHINT = (function () {
   });
   letstatement.exps = true;
 
-  blockstmt("class", function () {
+  blockstmt("class", function() {
     return classdef.call(this, true);
   });
 
-  function classdef(stmt) {
+  function classdef(isStatement) {
+
     /*jshint validthis:true */
     if (!state.option.inESNext()) {
       warning("W104", state.tokens.curr, "class");
     }
-    if (stmt) {
+    if (isStatement) {
       // BindingIdentifier
       this.name = identifier();
       addlabel(this.name, { type: "unused", token: state.tokens.curr });
     } else if (state.tokens.next.identifier && state.tokens.next.value !== "extends") {
       // BindingIdentifier(opt)
       this.name = identifier();
+      this.namedExpr = true;
+    } else {
+      this.name = state.nameStack.infer();
     }
     classtail(this);
     return this;
@@ -4886,11 +5228,113 @@ var JSHINT = (function () {
     state.directive["use strict"] = true;
     advance("{");
     // ClassBody(opt)
-    c.body = state.syntax["{"].nud(true);
+    c.body = classbody(c);
+    advance("}");
     state.directive["use strict"] = strictness;
   }
 
-  blockstmt("function", function () {
+  function classbody(c) {
+    var name;
+    var isStatic;
+    var isGenerator;
+    var getset;
+    var props = {};
+    var staticProps = {};
+    var computed;
+    for (var i = 0; state.tokens.next.id !== "}"; ++i) {
+      name = state.tokens.next;
+      isStatic = false;
+      isGenerator = false;
+      getset = null;
+      if (name.id === "*") {
+        isGenerator = true;
+        advance("*");
+        name = state.tokens.next;
+      }
+      if (name.id === "[") {
+        name = computedPropertyName();
+      } else if (isPropertyName(name)) {
+        // Non-Computed PropertyName
+        advance();
+        computed = false;
+        if (name.identifier && name.value === "static") {
+          if (checkPunctuators(state.tokens.next, ["*"])) {
+            isGenerator = true;
+            advance("*");
+          }
+          if (isPropertyName(state.tokens.next) || state.tokens.next.id === "[") {
+            computed = state.tokens.next.id === "[";
+            isStatic = true;
+            name = state.tokens.next;
+            if (state.tokens.next.id === "[") {
+              name = computedPropertyName();
+            } else advance();
+          }
+        }
+
+        if (name.identifier && (name.value === "get" || name.value === "set")) {
+          if (isPropertyName(state.tokens.next) || state.tokens.next.id === "[") {
+            computed = state.tokens.next.id === "[";
+            getset = name;
+            name = state.tokens.next;
+            if (state.tokens.next.id === "[") {
+              name = computedPropertyName();
+            } else advance();
+          }
+        }
+      } else {
+        warning("W052", state.tokens.next, state.tokens.next.value || state.tokens.next.type);
+        advance();
+        continue;
+      }
+
+      if (!checkPunctuators(state.tokens.next, ["("])) {
+        // error --- class properties must be methods
+        error("E054", state.tokens.next, state.tokens.next.value);
+        while (state.tokens.next.id !== "}" &&
+               !checkPunctuators(state.tokens.next, ["("])) {
+          advance();
+        }
+        if (state.tokens.next.value !== "(") {
+          doFunction({ statement: c });
+        }
+      }
+
+      if (!computed) {
+        // We don't know how to determine if we have duplicate computed property names :(
+        if (getset) {
+          saveAccessor(
+            getset.value, isStatic ? staticProps : props, name.value, name, true, isStatic);
+        } else {
+          if (name.value === "constructor") {
+            state.nameStack.set(c);
+          } else {
+            state.nameStack.set(name);
+          }
+          saveProperty(isStatic ? staticProps : props, name.value, name, true, isStatic);
+        }
+      }
+
+      if (getset && name.value === "constructor") {
+        var propDesc = getset.value === "get" ? "class getter method" : "class setter method";
+        error("E049", name, propDesc, "constructor");
+      } else if (name.value === "prototype") {
+        error("E049", name, "class method", "prototype");
+      }
+
+      propertyName(name);
+
+      doFunction({
+        statement: c,
+        type: isGenerator ? "generator" : null,
+        classExprBinding: c.namedExpr ? c.name : null
+      });
+    }
+
+    checkProperties(props);
+  }
+
+  blockstmt("function", function() {
     var generator = false;
     if (state.tokens.next.value === "*") {
       advance("*");
@@ -4904,21 +5348,31 @@ var JSHINT = (function () {
       warning("W082", state.tokens.curr);
 
     }
-    var i = identifier();
+    var i = optionalidentifier();
+
+    if (i === undefined) {
+      warning("W025");
+    }
+
     if (funct[i] === "const") {
       warning("E011", null, i);
     }
     addlabel(i, { type: "unction", token: state.tokens.curr });
 
-    doFunction(i, { statement: true }, generator);
+    doFunction({
+      name: i,
+      statement: this,
+      type: generator ? "generator" : null
+    });
     if (state.tokens.next.id === "(" && state.tokens.next.line === state.tokens.curr.line) {
       error("E039");
     }
     return this;
   });
 
-  prefix("function", function () {
+  prefix("function", function() {
     var generator = false;
+
     if (state.tokens.next.value === "*") {
       if (!state.option.inESNext()) {
         warning("W119", state.tokens.curr, "function*");
@@ -4926,27 +5380,61 @@ var JSHINT = (function () {
       advance("*");
       generator = true;
     }
+
     var i = optionalidentifier();
-    doFunction(i, undefined, generator);
+    var fn = doFunction({ name: i, type: generator ? "generator" : null });
+
+    function isVariable(name) { return name[0] !== "("; }
+    function isLocal(name) { return fn[name] === "var"; }
+
     if (!state.option.loopfunc && funct["(loopage)"]) {
-      warning("W083");
+      // If the function we just parsed accesses any non-local variables
+      // trigger a warning. Otherwise, the function is safe even within
+      // a loop.
+      if (_.some(fn, function(val, name) { return isVariable(name) && !isLocal(name); })) {
+        warning("W083");
+      }
     }
     return this;
   });
 
-  blockstmt("if", function () {
+  blockstmt("if", function() {
     var t = state.tokens.next;
     increaseComplexityCount();
     state.condition = true;
     advance("(");
-    checkCondAssignment(expression(0));
+    var expr = expression(0);
+    checkCondAssignment(expr);
+
+    // When the if is within a for-in loop, check if the condition
+    // starts with a negation operator
+    var forinifcheck = null;
+    if (state.option.forin && state.forinifcheckneeded) {
+      state.forinifcheckneeded = false; // We only need to analyze the first if inside the loop
+      forinifcheck = state.forinifchecks[state.forinifchecks.length - 1];
+      if (expr.type === "(punctuator)" && expr.value === "!") {
+        forinifcheck.type = "(negative)";
+      } else {
+        forinifcheck.type = "(positive)";
+      }
+    }
+
     advance(")", t);
     state.condition = false;
-    block(true, true);
+    var s = block(true, true);
+
+    // When the if is within a for-in loop and the condition has a negative form,
+    // check if the body contains nothing but a continue statement
+    if (forinifcheck && forinifcheck.type === "(negative)") {
+      if (s && s.length === 1 && s[0].type === "(identifier)" && s[0].value === "continue") {
+        forinifcheck.type = "(negative-with-continue)";
+      }
+    }
+
     if (state.tokens.next.id === "else") {
       advance("else");
       if (state.tokens.next.id === "if" || state.tokens.next.id === "switch") {
-        statement(true);
+        statement();
       } else {
         block(true, true);
       }
@@ -4954,7 +5442,7 @@ var JSHINT = (function () {
     return this;
   });
 
-  blockstmt("try", function () {
+  blockstmt("try", function() {
     var b;
 
     function doCatch() {
@@ -5032,7 +5520,7 @@ var JSHINT = (function () {
     return this;
   });
 
-  blockstmt("while", function () {
+  blockstmt("while", function() {
     var t = state.tokens.next;
     funct["(breakage)"] += 1;
     funct["(loopage)"] += 1;
@@ -5046,7 +5534,7 @@ var JSHINT = (function () {
     return this;
   }).labelled = true;
 
-  blockstmt("with", function () {
+  blockstmt("with", function() {
     var t = state.tokens.next;
     if (state.directive["use strict"]) {
       error("E010", state.tokens.curr);
@@ -5062,7 +5550,7 @@ var JSHINT = (function () {
     return this;
   });
 
-  blockstmt("switch", function () {
+  blockstmt("switch", function() {
     var t = state.tokens.next;
     var g = false;
     var noindent = false;
@@ -5173,15 +5661,15 @@ var JSHINT = (function () {
     }
   }).labelled = true;
 
-  stmt("debugger", function () {
+  stmt("debugger", function() {
     if (!state.option.debug) {
       warning("W087", this);
     }
     return this;
   }).exps = true;
 
-  (function () {
-    var x = stmt("do", function () {
+  (function() {
+    var x = stmt("do", function() {
       funct["(breakage)"] += 1;
       funct["(loopage)"] += 1;
       increaseComplexityCount();
@@ -5200,7 +5688,7 @@ var JSHINT = (function () {
     x.exps = true;
   }());
 
-  blockstmt("for", function () {
+  blockstmt("for", function() {
     var s, t = state.tokens.next;
     var letscope = false;
     var foreachtok = null;
@@ -5225,8 +5713,7 @@ var JSHINT = (function () {
     do {
       nextop = peek(i);
       ++i;
-    } while (!_.contains(inof, nextop.value) && nextop.value !== ";" &&
-          nextop.type !== "(end)");
+    } while (!_.contains(inof, nextop.value) && nextop.value !== ";" && nextop.type !== "(end)");
 
     // if we're in a for (… in|of …) statement
     if (_.contains(inof, nextop.value)) {
@@ -5236,13 +5723,13 @@ var JSHINT = (function () {
 
       if (state.tokens.next.id === "var") {
         advance("var");
-        state.syntax["var"].fud.call(state.syntax["var"].fud, true);
+        state.tokens.curr.fud({ prefix: true });
       } else if (state.tokens.next.id === "let") {
         advance("let");
         // create a new block scope
         letscope = true;
         funct["(blockscope)"].stack();
-        state.syntax["let"].fud.call(state.syntax["let"].fud, true);
+        state.tokens.curr.fud({ prefix: true });
       } else if (!state.tokens.next.identifier) {
         error("E030", state.tokens.next, state.tokens.next.type);
         advance();
@@ -5254,19 +5741,52 @@ var JSHINT = (function () {
         case "var":
           break;
         default:
-          if (!funct["(blockscope)"].getlabel(state.tokens.next.value))
+          var ident = state.tokens.next.value;
+          if (!funct["(blockscope)"].getlabel(ident) &&
+              !(scope[ident] || {})[ident]) {
             warning("W088", state.tokens.next, state.tokens.next.value);
+          }
         }
         advance();
       }
       advance(nextop.value);
       expression(20);
       advance(")", t);
-      s = block(true, true);
-      if (state.option.forin && s && (s.length > 1 || typeof s[0] !== "object" ||
-          s[0].value !== "if")) {
-        warning("W089", this);
+
+      if (nextop.value === "in" && state.option.forin) {
+        state.forinifcheckneeded = true;
+
+        if (state.forinifchecks === undefined) {
+          state.forinifchecks = [];
+        }
+
+        // Push a new for-in-if check onto the stack. The type will be modified
+        // when the loop's body is parsed and a suitable if statement exists.
+        state.forinifchecks.push({
+          type: "(none)"
+        });
       }
+
+      s = block(true, true);
+
+      if (nextop.value === "in" && state.option.forin) {
+        if (state.forinifchecks && state.forinifchecks.length > 0) {
+          var check = state.forinifchecks.pop();
+
+          if (// No if statement or not the first statement in loop body
+              s && s.length > 0 && (typeof s[0] !== "object" || s[0].value !== "if") ||
+              // Positive if statement is not the only one in loop body
+              check.type === "(positive)" && s.length > 1 ||
+              // Negative if statement but no continue
+              check.type === "(negative)") {
+            warning("W089", this);
+          }
+        }
+
+        // Reset the flag in case no if statement was contained in the loop body
+        state.forinifcheckneeded = false;
+      }
+
       funct["(breakage)"] -= 1;
       funct["(loopage)"] -= 1;
     } else {
@@ -5276,13 +5796,13 @@ var JSHINT = (function () {
       if (state.tokens.next.id !== ";") {
         if (state.tokens.next.id === "var") {
           advance("var");
-          state.syntax["var"].fud.call(state.syntax["var"].fud);
+          state.tokens.curr.fud();
         } else if (state.tokens.next.id === "let") {
           advance("let");
           // create a new block scope
           letscope = true;
           funct["(blockscope)"].stack();
-          state.syntax["let"].fud.call(state.syntax["let"].fud);
+          state.tokens.curr.fud();
         } else {
           for (;;) {
             expression(0, "for");
@@ -5326,7 +5846,7 @@ var JSHINT = (function () {
   }).labelled = true;
 
 
-  stmt("break", function () {
+  stmt("break", function() {
     var v = state.tokens.next.value;
 
     if (funct["(breakage)"] === 0)
@@ -5336,7 +5856,7 @@ var JSHINT = (function () {
       nolinebreak(this);
 
     if (state.tokens.next.id !== ";" && !state.tokens.next.reach) {
-      if (state.tokens.curr.line === state.tokens.next.line) {
+      if (state.tokens.curr.line === startLine(state.tokens.next)) {
         if (funct[v] !== "label") {
           warning("W090", state.tokens.next, v);
         } else if (scope[v] !== funct) {
@@ -5346,12 +5866,14 @@ var JSHINT = (function () {
         advance();
       }
     }
-    reachable("break");
+
+    reachable(this);
+
     return this;
   }).exps = true;
 
 
-  stmt("continue", function () {
+  stmt("continue", function() {
     var v = state.tokens.next.value;
 
     if (funct["(breakage)"] === 0)
@@ -5361,7 +5883,7 @@ var JSHINT = (function () {
       nolinebreak(this);
 
     if (state.tokens.next.id !== ";" && !state.tokens.next.reach) {
-      if (state.tokens.curr.line === state.tokens.next.line) {
+      if (state.tokens.curr.line === startLine(state.tokens.next)) {
         if (funct[v] !== "label") {
           warning("W090", state.tokens.next, v);
         } else if (scope[v] !== funct) {
@@ -5373,13 +5895,15 @@ var JSHINT = (function () {
     } else if (!funct["(loopage)"]) {
       warning("W052", state.tokens.next, this.value);
     }
-    reachable("continue");
+
+    reachable(this);
+
     return this;
   }).exps = true;
 
 
-  stmt("return", function () {
-    if (this.line === state.tokens.next.line) {
+  stmt("return", function() {
+    if (this.line === startLine(state.tokens.next)) {
       if (state.tokens.next.id !== ";" && !state.tokens.next.reach) {
         this.first = expression(0);
 
@@ -5395,14 +5919,16 @@ var JSHINT = (function () {
         nolinebreak(this); // always warn (Line breaking error)
       }
     }
-    reachable("return");
+
+    reachable(this);
+
     return this;
   }).exps = true;
 
-  (function (x) {
+  (function(x) {
     x.exps = true;
     x.lbp = 25;
-  }(prefix("yield", function () {
+  }(prefix("yield", function() {
     var prev = state.tokens.prev;
     if (state.option.inESNext(true) && !funct["(generator)"]) {
       // If it's a yield within a catch clause inside a generator then that's ok
@@ -5413,8 +5939,17 @@ var JSHINT = (function () {
       warning("W104", state.tokens.curr, "yield");
     }
     funct["(generator)"] = "yielded";
-    if (this.line === state.tokens.next.line || !state.option.inMoz(true)) {
-      if (state.tokens.next.id !== ";" && !state.tokens.next.reach && state.tokens.next.nud) {
+    var delegatingYield = false;
+
+    if (state.tokens.next.value === "*") {
+      delegatingYield = true;
+      advance("*");
+    }
+
+    if (this.line === startLine(state.tokens.next) || !state.option.inMoz(true)) {
+      if (delegatingYield ||
+          (state.tokens.next.id !== ";" && !state.tokens.next.reach && state.tokens.next.nud)) {
+
         nobreaknonadjacent(state.tokens.curr, state.tokens.next);
         this.first = expression(10);
 
@@ -5435,26 +5970,55 @@ var JSHINT = (function () {
   })));
 
 
-  stmt("throw", function () {
+  stmt("throw", function() {
     nolinebreak(this);
     this.first = expression(20);
-    reachable("throw");
+
+    reachable(this);
+
     return this;
   }).exps = true;
 
-  stmt("import", function () {
+  stmt("import", function() {
     if (!state.option.inESNext()) {
       warning("W119", state.tokens.curr, "import");
     }
 
     if (state.tokens.next.type === "(string)") {
+      // ModuleSpecifier :: StringLiteral
       advance("(string)");
       return this;
     }
+
     if (state.tokens.next.identifier) {
+      // ImportClause :: ImportedDefaultBinding
       this.name = identifier();
       addlabel(this.name, { type: "unused", token: state.tokens.curr });
+      if (state.tokens.next.value === ",") {
+        // ImportClause :: ImportedDefaultBinding , NameSpaceImport
+        // ImportClause :: ImportedDefaultBinding , NamedImports
+        advance(",");
+        // At this point, we intentionally fall through to continue matching
+        // either NameSpaceImport or NamedImports.
+        // Discussion:
+        // https://github.com/jshint/jshint/pull/2144#discussion_r23978406
+      } else {
+        advance("from");
+        advance("(string)");
+        return this;
+      }
+    }
+
+    if (state.tokens.next.id === "*") {
+      // ImportClause :: NameSpaceImport
+      advance("*");
+      advance("as");
+      if (state.tokens.next.identifier) {
+        this.name = identifier();
+        addlabel(this.name, { type: "unused", token: state.tokens.curr });
+      }
     } else {
+      // ImportClause :: NamedImports
       advance("{");
       for (;;) {
         if (state.tokens.next.value === "}") {
@@ -5486,30 +6050,81 @@ var JSHINT = (function () {
       }
     }
 
+    // FromClause
     advance("from");
     advance("(string)");
     return this;
   }).exps = true;
 
-  stmt("export", function () {
+  stmt("export", function() {
+    var ok = true;
+    var token;
+    var identifier;
+
     if (!state.option.inESNext()) {
       warning("W119", state.tokens.curr, "export");
+      ok = false;
+    }
+
+    if (!funct["(global)"] || !funct["(blockscope)"].atTop()) {
+      error("E053", state.tokens.curr);
+      ok = false;
+    }
+
+    if (state.tokens.next.value === "*") {
+      // ExportDeclaration :: export * FromClause
+      advance("*");
+      advance("from");
+      advance("(string)");
+      return this;
     }
 
     if (state.tokens.next.type === "default") {
+      // ExportDeclaration :: export default HoistableDeclaration
+      // ExportDeclaration :: export default ClassDeclaration
+      state.nameStack.set(state.tokens.next);
       advance("default");
       if (state.tokens.next.id === "function" || state.tokens.next.id === "class") {
         this.block = true;
       }
-      this.exportee = expression(10);
+
+      token = peek();
+
+      expression(10);
+
+      if (state.tokens.next.id === "class") {
+        identifier = token.name;
+      } else {
+        identifier = token.value;
+      }
+
+      addlabel(identifier, {
+        type: "function", token: token
+      });
 
       return this;
     }
 
     if (state.tokens.next.value === "{") {
+      // ExportDeclaration :: export ExportClause
       advance("{");
+      var exportedTokens = [];
       for (;;) {
-        exported[identifier()] = true;
+        if (!state.tokens.next.identifier) {
+          error("E030", state.tokens.next, state.tokens.next.value);
+        }
+        advance();
+
+        state.tokens.curr.exported = ok;
+        exportedTokens.push(state.tokens.curr);
+
+        if (state.tokens.next.value === "as") {
+          advance("as");
+          if (!state.tokens.next.identifier) {
+            error("E030", state.tokens.next, state.tokens.next.value);
+          }
+          advance();
+        }
 
         if (state.tokens.next.value === ",") {
           advance(",");
@@ -5521,30 +6136,47 @@ var JSHINT = (function () {
           break;
         }
       }
+      if (state.tokens.next.value === "from") {
+        // ExportDeclaration :: export ExportClause FromClause
+        advance("from");
+        advance("(string)");
+      } else if (ok) {
+        exportedTokens.forEach(function(token) {
+          if (!funct[token.value]) {
+            isundef(funct, "W117", token, token.value);
+          }
+          exported[token.value] = true;
+          funct["(blockscope)"].setExported(token.value);
+        });
+      }
       return this;
     }
 
     if (state.tokens.next.id === "var") {
+      // ExportDeclaration :: export VariableStatement
       advance("var");
-      exported[state.tokens.next.value] = true;
-      state.syntax["var"].fud.call(state.syntax["var"].fud);
+      state.tokens.curr.fud({ inexport:true });
     } else if (state.tokens.next.id === "let") {
+      // ExportDeclaration :: export VariableStatement
       advance("let");
-      exported[state.tokens.next.value] = true;
-      state.syntax["let"].fud.call(state.syntax["let"].fud);
+      state.tokens.curr.fud({ inexport:true });
     } else if (state.tokens.next.id === "const") {
+      // ExportDeclaration :: export VariableStatement
       advance("const");
-      exported[state.tokens.next.value] = true;
-      state.syntax["const"].fud.call(state.syntax["const"].fud);
+      state.tokens.curr.fud({ inexport:true });
     } else if (state.tokens.next.id === "function") {
+      // ExportDeclaration :: export Declaration
       this.block = true;
       advance("function");
-      exported[state.tokens.next.value] = true;
+      exported[state.tokens.next.value] = ok;
+      state.tokens.next.exported = true;
       state.syntax["function"].fud();
     } else if (state.tokens.next.id === "class") {
+      // ExportDeclaration :: export Declaration
       this.block = true;
       advance("class");
-      exported[state.tokens.next.value] = true;
+      exported[state.tokens.next.value] = ok;
+      state.tokens.next.exported = true;
       state.syntax["class"].fud();
     } else {
       error("E024", state.tokens.next, state.tokens.next.value);
@@ -5584,23 +6216,23 @@ var JSHINT = (function () {
   FutureReservedWord("transient");
   FutureReservedWord("volatile");
 
-  // this function is used to determine wether a squarebracket or a curlybracket
+  // this function is used to determine whether a squarebracket or a curlybracket
   // expression is a comprehension array, destructuring assignment or a json value.
 
-  var lookupBlockType = function () {
+  var lookupBlockType = function() {
     var pn, pn1;
     var i = -1;
     var bracketStack = 0;
     var ret = {};
-    if (_.contains(["[", "{"], state.tokens.curr.value))
+    if (checkPunctuators(state.tokens.curr, ["[", "{"]))
       bracketStack += 1;
     do {
       pn = (i === -1) ? state.tokens.next : peek(i);
       pn1 = peek(i + 1);
       i = i + 1;
-      if (_.contains(["[", "{"], pn.value)) {
+      if (checkPunctuators(pn, ["[", "{"])) {
         bracketStack += 1;
-      } else if (_.contains(["]", "}"], pn.value)) {
+      } else if (checkPunctuators(pn, ["]", "}"])) {
         bracketStack -= 1;
       }
       if (pn.identifier && pn.value === "for" && bracketStack === 1) {
@@ -5608,19 +6240,92 @@ var JSHINT = (function () {
         ret.notJson = true;
         break;
       }
-      if (_.contains(["}", "]"], pn.value) && pn1.value === "=" && bracketStack === 0) {
-        ret.isDestAssign = true;
-        ret.notJson = true;
-        break;
+      if (checkPunctuators(pn, ["}", "]"]) && bracketStack === 0) {
+        if (pn1.value === "=") {
+          ret.isDestAssign = true;
+          ret.notJson = true;
+          break;
+        } else if (pn1.value === ".") {
+          ret.notJson = true;
+          break;
+        }
       }
       if (pn.value === ";") {
         ret.isBlock = true;
         ret.notJson = true;
       }
-    } while (bracketStack > 0 && pn.id !== "(end)" && i < 15);
+    } while (bracketStack > 0 && pn.id !== "(end)");
     return ret;
   };
 
+  function saveProperty(props, name, tkn, isClass, isStatic) {
+    var msg = ["key", "class method", "static class method"];
+    msg = msg[(isClass || false) + (isStatic || false)];
+    if (tkn.identifier) {
+      name = tkn.value;
+    }
+
+    if (props[name] && _.has(props, name)) {
+      warning("W075", state.tokens.next, msg, name);
+    } else {
+      props[name] = {};
+    }
+
+    props[name].basic = true;
+    props[name].basictkn = tkn;
+  }
+
+  /**
+   * @param {string} accessorType - Either "get" or "set"
+   * @param {object} props - a collection of all properties of the object to
+   *                         which the current accessor is being assigned
+   * @param {object} tkn - the identifier token representing the accessor name
+   * @param {boolean} isClass - whether the accessor is part of an ES6 Class
+   *                            definition
+   * @param {boolean} isStatic - whether the accessor is a static method
+   */
+  function saveAccessor(accessorType, props, name, tkn, isClass, isStatic) {
+    var flagName = accessorType === "get" ? "getterToken" : "setterToken";
+    var msg = "";
+
+    if (isClass) {
+      if (isStatic) {
+        msg += "static ";
+      }
+      msg += accessorType + "ter method";
+    } else {
+      msg = "key";
+    }
+
+    state.tokens.curr.accessorType = accessorType;
+    state.nameStack.set(tkn);
+
+    if (props[name] && _.has(props, name)) {
+      if (props[name].basic || props[name][flagName]) {
+        warning("W075", state.tokens.next, msg, name);
+      }
+    } else {
+      props[name] = {};
+    }
+
+    props[name][flagName] = tkn;
+  }
+
+  function computedPropertyName() {
+    advance("[");
+    if (!state.option.esnext) {
+      warning("W119", state.tokens.curr, "computed property names");
+    }
+    var value = expression(10);
+    advance("]");
+    return value;
+  }
+
+  // Test whether a given token is a punctuator matching one of the specified values
+  function checkPunctuators(token, values) {
+    return token.type === "(punctuator)" && _.contains(values, token.value);
+  }
+
   // Check whether this function has been reached for a destructuring assign with undeclared values
   function destructuringAssignOrJsonValue() {
     // lookup for the assignment (esnext only)
@@ -5649,15 +6354,15 @@ var JSHINT = (function () {
   //  * "define" which will define the variables local to the list comprehension
   //  * "filter" which will help filter out values
 
-  var arrayComprehension = function () {
-    var CompArray = function () {
+  var arrayComprehension = function() {
+    var CompArray = function() {
       this.mode = "use";
       this.variables = [];
     };
     var _carrays = [];
     var _current;
     function declare(v) {
-      var l = _current.variables.filter(function (elt) {
+      var l = _current.variables.filter(function(elt) {
         // if it has, change its undef state
         if (elt.value === v) {
           elt.undef = false;
@@ -5667,7 +6372,7 @@ var JSHINT = (function () {
       return l !== 0;
     }
     function use(v) {
-      var l = _current.variables.filter(function (elt) {
+      var l = _current.variables.filter(function(elt) {
         // and if it has been defined
         if (elt.value === v && !elt.undef) {
           if (elt.unused === true) {
@@ -5679,25 +6384,25 @@ var JSHINT = (function () {
       // otherwise we warn about it
       return (l === 0);
     }
-    return {stack: function () {
+    return { stack: function() {
           _current = new CompArray();
           _carrays.push(_current);
         },
-        unstack: function () {
-          _current.variables.filter(function (v) {
+        unstack: function() {
+          _current.variables.filter(function(v) {
             if (v.unused)
-              warning("W098", v.token, v.value);
+              warning("W098", v.token, v.raw_text || v.value);
             if (v.undef)
               isundef(v.funct, "W117", v.token, v.value);
           });
           _carrays.splice(-1, 1);
           _current = _carrays[_carrays.length - 1];
         },
-        setState: function (s) {
+        setState: function(s) {
           if (_.contains(["use", "define", "generate", "filter"], s))
             _current.mode = s;
         },
-        check: function (v) {
+        check: function(v) {
           if (!_current) {
             return;
           }
@@ -5764,7 +6469,7 @@ var JSHINT = (function () {
             warning("W095", state.tokens.next, state.tokens.next.value);
           }
           if (o[state.tokens.next.value] === true) {
-            warning("W075", state.tokens.next, state.tokens.next.value);
+            warning("W075", state.tokens.next, "key", state.tokens.next.value);
           } else if ((state.tokens.next.value === "__proto__" &&
             !state.option.proto) || (state.tokens.next.value === "__iterator__" &&
             !state.option.iterator)) {
@@ -5830,7 +6535,7 @@ var JSHINT = (function () {
     }
   }
 
-  var blockScope = function () {
+  var blockScope = function() {
     var _current = {};
     var _variables = [_current];
 
@@ -5839,6 +6544,10 @@ var JSHINT = (function () {
         if (_current[t]["(type)"] === "unused") {
           if (state.option.unused) {
             var tkn = _current[t]["(token)"];
+            // Don't report exported labels as unused
+            if (tkn.exported) {
+              continue;
+            }
             var line = tkn.line;
             var chr  = tkn.character;
             warningAt("W098", line, chr, t);
@@ -5848,18 +6557,18 @@ var JSHINT = (function () {
     }
 
     return {
-      stack: function () {
+      stack: function() {
         _current = {};
         _variables.push(_current);
       },
 
-      unstack: function () {
+      unstack: function() {
         _checkBlockLabels();
         _variables.splice(_variables.length - 1, 1);
         _current = _.last(_variables);
       },
 
-      getlabel: function (l) {
+      getlabel: function(l) {
         for (var i = _variables.length - 1 ; i >= 0; --i) {
           if (_.has(_variables[i], l) && !_variables[i][l]["(shadowed)"]) {
             return _variables[i];
@@ -5867,7 +6576,7 @@ var JSHINT = (function () {
         }
       },
 
-      shadow: function (name) {
+      shadow: function(name) {
         for (var i = _variables.length - 1; i >= 0; i--) {
           if (_.has(_variables[i], name)) {
             _variables[i][name]["(shadowed)"] = true;
@@ -5875,7 +6584,7 @@ var JSHINT = (function () {
         }
       },
 
-      unshadow: function (name) {
+      unshadow: function(name) {
         for (var i = _variables.length - 1; i >= 0; i--) {
           if (_.has(_variables[i], name)) {
             _variables[i][name]["(shadowed)"] = false;
@@ -5883,21 +6592,38 @@ var JSHINT = (function () {
         }
       },
 
+      atTop: function() {
+        return _variables.length === 1;
+      },
+
+      setExported: function(id) {
+        if (funct["(blockscope)"].atTop()) {
+          var item = _current[id];
+          if (item && item["(token)"]) {
+            item["(token)"].exported = true;
+          }
+        }
+      },
+
       current: {
-        has: function (t) {
+        has: function(t) {
           return _.has(_current, t);
         },
 
-        add: function (t, type, tok) {
+        add: function(t, type, tok) {
           _current[t] = { "(type)" : type, "(token)": tok, "(shadowed)": false };
         }
       }
     };
   };
 
+  var escapeRegex = function(str) {
+    return str.replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
+  };
+
   // The actual JSHINT function itself.
-  var itself = function (s, o, g) {
-    var i, k, x;
+  var itself = function(s, o, g) {
+    var i, k, x, reIgnoreStr, reIgnore;
     var optionKeys;
     var newOptionObj = {};
     var newIgnoredObj = {};
@@ -5916,7 +6642,7 @@ var JSHINT = (function () {
     }
 
     predefined = Object.create(null);
-    combine(predefined, vars.ecmaIdentifiers);
+    combine(predefined, vars.ecmaIdentifiers[3]);
     combine(predefined, vars.reservedVars);
 
     combine(predefined, g || {});
@@ -5935,19 +6661,21 @@ var JSHINT = (function () {
     }
 
     if (o) {
-      each(o.predef || null, function (item) {
+      each(o.predef || null, function(item) {
         var slice, prop;
 
         if (item[0] === "-") {
           slice = item.slice(1);
           JSHINT.blacklist[slice] = slice;
+          // remove from predefined if there
+          delete predefined[slice];
         } else {
           prop = Object.getOwnPropertyDescriptor(o.predef, item);
           predefined[item] = prop ? prop.value : false;
         }
       });
 
-      each(o.exported || null, function (item) {
+      each(o.exported || null, function(item) {
         exported[item] = true;
       });
 
@@ -6004,59 +6732,81 @@ var JSHINT = (function () {
         return state.jsonMode;
       },
 
-      getOption: function (name) {
+      getOption: function(name) {
         return state.option[name] || null;
       },
 
-      getCache: function (name) {
+      getCache: function(name) {
         return state.cache[name];
       },
 
-      setCache: function (name, value) {
+      setCache: function(name, value) {
         state.cache[name] = value;
       },
 
-      warn: function (code, data) {
+      warn: function(code, data) {
         warningAt.apply(null, [ code, data.line, data.char ].concat(data.data));
       },
 
-      on: function (names, listener) {
-        names.split(" ").forEach(function (name) {
+      on: function(names, listener) {
+        names.split(" ").forEach(function(name) {
           emitter.on(name, listener);
         }.bind(this));
       }
     };
 
     emitter.removeAllListeners();
-    (extraModules || []).forEach(function (func) {
+    (extraModules || []).forEach(function(func) {
       func(api);
     });
 
     state.tokens.prev = state.tokens.curr = state.tokens.next = state.syntax["(begin)"];
 
+    if (o && o.ignoreDelimiters) {
+
+      if (!Array.isArray(o.ignoreDelimiters)) {
+        o.ignoreDelimiters = [o.ignoreDelimiters];
+      }
+
+      o.ignoreDelimiters.forEach(function(delimiterPair) {
+        if (!delimiterPair.start || !delimiterPair.end)
+            return;
+
+        reIgnoreStr = escapeRegex(delimiterPair.start) +
+                      "[\\s\\S]*?" +
+                      escapeRegex(delimiterPair.end);
+
+        reIgnore = new RegExp(reIgnoreStr, "ig");
+
+        s = s.replace(reIgnore, function(match) {
+          return match.replace(/./g, " ");
+        });
+      });
+    }
+
     lex = new Lexer(s);
 
-    lex.on("warning", function (ev) {
+    lex.on("warning", function(ev) {
       warningAt.apply(null, [ ev.code, ev.line, ev.character].concat(ev.data));
     });
 
-    lex.on("error", function (ev) {
+    lex.on("error", function(ev) {
       errorAt.apply(null, [ ev.code, ev.line, ev.character ].concat(ev.data));
     });
 
-    lex.on("fatal", function (ev) {
+    lex.on("fatal", function(ev) {
       quit("E041", ev.line, ev.from);
     });
 
-    lex.on("Identifier", function (ev) {
+    lex.on("Identifier", function(ev) {
       emitter.emit("Identifier", ev);
     });
 
-    lex.on("String", function (ev) {
+    lex.on("String", function(ev) {
       emitter.emit("String", ev);
     });
 
-    lex.on("Number", function (ev) {
+    lex.on("Number", function(ev) {
       emitter.emit("Number", ev);
     });
 
@@ -6088,8 +6838,10 @@ var JSHINT = (function () {
         directives();
 
         if (state.directive["use strict"]) {
-          if (!state.option.globalstrict && !(state.option.node || state.option.phantom)) {
-            warning("W097", state.tokens.prev);
+          if (!state.option.globalstrict) {
+            if (!(state.option.node || state.option.phantom || state.option.browserify)) {
+              warning("W097", state.tokens.prev);
+            }
           }
         }
 
@@ -6098,7 +6850,7 @@ var JSHINT = (function () {
       advance((state.tokens.next && state.tokens.next.value !== ".")  ? "(end)" : undefined);
       funct["(blockscope)"].unstack();
 
-      var markDefined = function (name, context) {
+      var markDefined = function(name, context) {
         do {
           if (typeof context[name] === "string") {
             // JSHINT marks unused variables as 'unused' and
@@ -6121,7 +6873,7 @@ var JSHINT = (function () {
         return false;
       };
 
-      var clearImplied = function (name, line) {
+      var clearImplied = function(name, line) {
         if (!implied[name])
           return;
 
@@ -6137,9 +6889,10 @@ var JSHINT = (function () {
           implied[name] = newImplied;
       };
 
-      var warnUnused = function (name, tkn, type, unused_opt) {
+      var warnUnused = function(name, tkn, type, unused_opt) {
         var line = tkn.line;
-        var chr  = tkn.character;
+        var chr  = tkn.from;
+        var raw_name = tkn.raw_text || name;
 
         if (unused_opt === undefined) {
           unused_opt = state.option.unused;
@@ -6157,7 +6910,9 @@ var JSHINT = (function () {
 
         if (unused_opt) {
           if (warnable_types[unused_opt] && warnable_types[unused_opt].indexOf(type) !== -1) {
-            warningAt("W098", line, chr, name);
+            if (!tkn.exported) {
+              warningAt("W098", line, chr, raw_name);
+            }
           }
         }
 
@@ -6168,7 +6923,7 @@ var JSHINT = (function () {
         });
       };
 
-      var checkUnused = function (func, key) {
+      var checkUnused = function(func, key) {
         var type = func[key];
         var tkn = func["(tokens)"][key];
 
@@ -6197,14 +6952,14 @@ var JSHINT = (function () {
       for (i = 0; i < JSHINT.undefs.length; i += 1) {
         k = JSHINT.undefs[i].slice(0);
 
-        if (markDefined(k[2].value, k[0])) {
+        if (markDefined(k[2].value, k[0]) || k[2].forgiveUndef) {
           clearImplied(k[2].value, k[2].line);
         } else if (state.option.undef) {
           warning.apply(warning, k.slice(1));
         }
       }
 
-      functions.forEach(function (func) {
+      functions.forEach(function(func) {
         if (func["(unusedOption)"] === false) {
           return;
         }
@@ -6227,7 +6982,7 @@ var JSHINT = (function () {
           unused_opt = func["(unusedOption)"] || state.option.unused;
           unused_opt = unused_opt === true ? "last-param" : unused_opt;
 
-          // 'undefined' is a special case for (function (window, undefined) { ... })();
+          // 'undefined' is a special case for (function(window, undefined) { ... })();
           // patterns.
 
           if (param === "undefined")
@@ -6281,14 +7036,14 @@ var JSHINT = (function () {
   };
 
   // Modules.
-  itself.addModule = function (func) {
+  itself.addModule = function(func) {
     extraModules.push(func);
   };
 
   itself.addModule(style.register);
 
   // Data summary.
-  itself.data = function () {
+  itself.data = function() {
     var data = {
       functions: [],
       options: state.option
@@ -6384,7 +7139,7 @@ if (typeof exports === "object" && exports) {
 }
 
 },
-{"./lex.js":4,"./messages.js":5,"./reg.js":6,"./state.js":7,"./style.js":8,"./vars.js":9,"events":10,"underscore":2}],
+{"./lex.js":4,"./messages.js":5,"./options.js":7,"./reg.js":8,"./state.js":9,"./style.js":10,"./vars.js":11,"events":12,"underscore":2}],
 4:[function(_dereq_,module,exports){
 /*
  * Lexical analysis and token construction.
@@ -6415,7 +7170,15 @@ var Token = {
   NullLiteral: 7,
   BooleanLiteral: 8,
   RegExp: 9,
-  TemplateLiteral: 10
+  TemplateHead: 10,
+  TemplateMiddle: 11,
+  TemplateTail: 12,
+  NoSubstTemplate: 13
+};
+
+var Context = {
+  Block: 1,
+  Template: 2
 };
 
 // Object that handles postponed lexing verifications that checks the parsed
@@ -6425,11 +7188,11 @@ function asyncTrigger() {
   var _checks = [];
 
   return {
-    push: function (fn) {
+    push: function(fn) {
       _checks.push(fn);
     },
 
-    check: function () {
+    check: function() {
       for (var check = 0; check < _checks.length; ++check) {
         _checks[check]();
       }
@@ -6454,7 +7217,7 @@ function asyncTrigger() {
  * to token() method returning the next token, the Lexer object also
  * emits events.
  *
- *   lex.on("Identifier", function (data) {
+ *   lex.on("Identifier", function(data) {
  *     if (data.name.indexOf("_") >= 0) {
  *       // Produce a warning.
  *     }
@@ -6495,6 +7258,8 @@ function Lexer(source) {
   this.from = 1;
   this.input = "";
   this.inComment = false;
+  this.context = [];
+  this.templateStarts = [];
 
   for (var i = 0; i < state.option.indent; i += 1) {
     state.tab += " ";
@@ -6504,12 +7269,32 @@ function Lexer(source) {
 Lexer.prototype = {
   _lines: [],
 
-  getLines: function () {
+  inContext: function(ctxType) {
+    return this.context.length > 0 && this.context[this.context.length - 1].type === ctxType;
+  },
+
+  pushContext: function(ctxType) {
+    this.context.push({ type: ctxType });
+  },
+
+  popContext: function() {
+    return this.context.pop();
+  },
+
+  isContext: function(context) {
+    return this.context.length > 0 && this.context[this.context.length - 1] === context;
+  },
+
+  currentContext: function() {
+    return this.context.length > 0 && this.context[this.context.length - 1];
+  },
+
+  getLines: function() {
     this._lines = state.lines;
     return this._lines;
   },
 
-  setLines: function (val) {
+  setLines: function(val) {
     this._lines = val;
     state.lines = this._lines;
   },
@@ -6518,14 +7303,14 @@ Lexer.prototype = {
    * Return the next i character without actually moving the
    * char pointer.
    */
-  peek: function (i) {
+  peek: function(i) {
     return this.input.charAt(i || 0);
   },
 
   /*
    * Move the char pointer forward i times.
    */
-  skip: function (i) {
+  skip: function(i) {
     i = i || 1;
     this.char += i;
     this.input = this.input.slice(i);
@@ -6536,12 +7321,12 @@ Lexer.prototype = {
    * Underscore.js i.e. you can subscribe to multiple events with
    * one call:
    *
-   *   lex.on("Identifier Number", function (data) {
+   *   lex.on("Identifier Number", function(data) {
    *     // ...
    *   });
    */
-  on: function (names, listener) {
-    names.split(" ").forEach(function (name) {
+  on: function(names, listener) {
+    names.split(" ").forEach(function(name) {
       this.emitter.on(name, listener);
     }.bind(this));
   },
@@ -6550,7 +7335,7 @@ Lexer.prototype = {
    * Trigger a token event. All arguments will be passed to each
    * listener.
    */
-  trigger: function () {
+  trigger: function() {
     this.emitter.emit.apply(this.emitter, Array.prototype.slice.call(arguments));
   },
 
@@ -6561,8 +7346,8 @@ Lexer.prototype = {
    * by the parser. This avoids parser's peek() to give the lexer
    * a false context.
    */
-  triggerAsync: function (type, args, checks, fn) {
-    checks.push(function () {
+  triggerAsync: function(type, args, checks, fn) {
+    checks.push(function() {
       if (fn()) {
         this.trigger(type, args);
       }
@@ -6576,7 +7361,7 @@ Lexer.prototype = {
    * This method's implementation was heavily influenced by the
    * scanPunctuator function in the Esprima parser's source code.
    */
-  scanPunctuator: function () {
+  scanPunctuator: function() {
     var ch1 = this.peek();
     var ch2, ch3, ch4;
 
@@ -6597,8 +7382,6 @@ Lexer.prototype = {
     case ")":
     case ";":
     case ",":
-    case "{":
-    case "}":
     case "[":
     case "]":
     case ":":
@@ -6609,6 +7392,24 @@ Lexer.prototype = {
         value: ch1
       };
 
+    // A block/object opener
+    case "{":
+      this.pushContext(Context.Block);
+      return {
+        type: Token.Punctuator,
+        value: ch1
+      };
+
+    // A block/object closer
+    case "}":
+      if (this.inContext(Context.Block)) {
+        this.popContext();
+      }
+      return {
+        type: Token.Punctuator,
+        value: ch1
+      };
+
     // A pound sign (for Node shebangs)
     case "#":
       return {
@@ -6704,13 +7505,10 @@ Lexer.prototype = {
       };
     }
 
-    // Special case: /=. We need to make sure that this is an
-    // operator and not a regular expression.
+    // Special case: /=.
 
     if (ch1 === "/") {
-      if (ch2 === "=" && /\/=(?!(\S*\/[gim]?))/.test(this.input)) {
-        // /= is not a part of a regular expression, return it as a
-        // punctuator.
+      if (ch2 === "=") {
         return {
           type: Token.Punctuator,
           value: "/="
@@ -6736,7 +7534,7 @@ Lexer.prototype = {
    * also recognizes JSHint- and JSLint-specific comments such as
    * /*jshint, /*jslint, /*globals and so on.
    */
-  scanComments: function () {
+  scanComments: function() {
     var ch1 = this.peek();
     var ch2 = this.peek(1);
     var rest = this.input.substr(2);
@@ -6758,7 +7556,9 @@ Lexer.prototype = {
         value += "*/";
       }
 
-      special.forEach(function (str) {
+      body = body.replace(/\n/g, " ");
+
+      special.forEach(function(str) {
         if (isSpecial) {
           return;
         }
@@ -6769,13 +7569,14 @@ Lexer.prototype = {
           return;
         }
 
-        if (body.substr(0, str.length) === str) {
+        if (body.charAt(str.length) === " " && body.substr(0, str.length) === str) {
           isSpecial = true;
           label = label + str;
           body = body.substr(str.length);
         }
 
-        if (!isSpecial && body.charAt(0) === " " && body.substr(1, str.length) === str) {
+        if (!isSpecial && body.charAt(0) === " " && body.charAt(str.length + 1) === " " &&
+          body.substr(1, str.length) === str) {
           isSpecial = true;
           label = label + " " + str;
           body = body.substr(str.length + 1);
@@ -6873,7 +7674,7 @@ Lexer.prototype = {
    * Extract a keyword out of the next sequence of characters or
    * return 'null' if its not possible.
    */
-  scanKeyword: function () {
+  scanKeyword: function() {
     var result = /^[a-zA-Z_$][a-zA-Z0-9_$]*/.exec(this.input);
     var keywords = [
       "if", "in", "do", "var", "for", "new",
@@ -6902,7 +7703,7 @@ Lexer.prototype = {
    * to Identifier this method can also produce BooleanLiteral
    * (true/false) and NullLiteral (null).
    */
-  scanIdentifier: function () {
+  scanIdentifier: function() {
     var id = "";
     var index = 0;
     var type, char;
@@ -6919,7 +7720,7 @@ Lexer.prototype = {
       return (/^[0-9a-fA-F]$/).test(str);
     }
 
-    var readUnicodeEscapeSequence = function () {
+    var readUnicodeEscapeSequence = function() {
       /*jshint validthis:true */
       index += 1;
 
@@ -6947,7 +7748,7 @@ Lexer.prototype = {
       return null;
     }.bind(this);
 
-    var getIdentifierStart = function () {
+    var getIdentifierStart = function() {
       /*jshint validthis:true */
       var chr = this.peek(index);
       var code = chr.charCodeAt(0);
@@ -6973,7 +7774,7 @@ Lexer.prototype = {
       return null;
     }.bind(this);
 
-    var getIdentifierPart = function () {
+    var getIdentifierPart = function() {
       /*jshint validthis:true */
       var chr = this.peek(index);
       var code = chr.charCodeAt(0);
@@ -6999,6 +7800,12 @@ Lexer.prototype = {
       return null;
     }.bind(this);
 
+    function removeEscapeSequences(id) {
+      return id.replace(/\\u([0-9a-fA-F]{4})/g, function(m0, codepoint) {
+        return String.fromCharCode(parseInt(codepoint, 16));
+      });
+    }
+
     char = getIdentifierStart();
     if (char === null) {
       return null;
@@ -7029,7 +7836,9 @@ Lexer.prototype = {
 
     return {
       type: type,
-      value: id
+      value: removeEscapeSequences(id),
+      text: id,
+      tokenLength: id.length
     };
   },
 
@@ -7042,12 +7851,15 @@ Lexer.prototype = {
    * This method's implementation was heavily influenced by the
    * scanNumericLiteral function in the Esprima parser's source code.
    */
-  scanNumericLiteral: function () {
+  scanNumericLiteral: function() {
     var index = 0;
     var value = "";
     var length = this.input.length;
     var char = this.peek(index);
     var bad;
+    var isAllowedDigit = isDecimalDigit;
+    var base = 10;
+    var isLegacy = false;
 
     function isDecimalDigit(str) {
       return (/^[0-9]$/).test(str);
@@ -7057,6 +7869,10 @@ Lexer.prototype = {
       return (/^[0-7]$/).test(str);
     }
 
+    function isBinaryDigit(str) {
+      return (/^[01]$/).test(str);
+    }
+
     function isHexDigit(str) {
       return (/^[0-9a-fA-F]$/).test(str);
     }
@@ -7080,81 +7896,64 @@ Lexer.prototype = {
       if (value === "0") {
         // Base-16 numbers.
         if (char === "x" || char === "X") {
+          isAllowedDigit = isHexDigit;
+          base = 16;
+
           index += 1;
           value += char;
-
-          while (index < length) {
-            char = this.peek(index);
-            if (!isHexDigit(char)) {
-              break;
-            }
-            value += char;
-            index += 1;
-          }
-
-          if (value.length <= 2) { // 0x
-            return {
-              type: Token.NumericLiteral,
-              value: value,
-              isMalformed: true
-            };
-          }
-
-          if (index < length) {
-            char = this.peek(index);
-            if (isIdentifierStart(char)) {
-              return null;
-            }
-          }
-
-          return {
-            type: Token.NumericLiteral,
-            value: value,
-            base: 16,
-            isMalformed: false
-          };
         }
 
         // Base-8 numbers.
-        if (isOctalDigit(char)) {
+        if (char === "o" || char === "O") {
+          isAllowedDigit = isOctalDigit;
+          base = 8;
+
+          if (!state.option.esnext) {
+            this.trigger("warning", {
+              code: "W119",
+              line: this.line,
+              character: this.char,
+              data: [ "Octal integer literal" ]
+            });
+          }
+
           index += 1;
           value += char;
+        }
+
+        // Base-2 numbers.
+        if (char === "b" || char === "B") {
+          isAllowedDigit = isBinaryDigit;
+          base = 2;
+
+          if (!state.option.esnext) {
+            this.trigger("warning", {
+              code: "W119",
+              line: this.line,
+              character: this.char,
+              data: [ "Binary integer literal" ]
+            });
+          }
+
+          index += 1;
+          value += char;
+        }
+
+        // Legacy base-8 numbers.
+        if (isOctalDigit(char)) {
+          isAllowedDigit = isOctalDigit;
+          base = 8;
+          isLegacy = true;
           bad = false;
 
-          while (index < length) {
-            char = this.peek(index);
-
-            // Numbers like '019' (note the 9) are not valid octals
-            // but we still parse them and mark as malformed.
-
-            if (isDecimalDigit(char)) {
-              bad = true;
-            } else if (!isOctalDigit(char)) {
-              break;
-            }
-            value += char;
-            index += 1;
-          }
-
-          if (index < length) {
-            char = this.peek(index);
-            if (isIdentifierStart(char)) {
-              return null;
-            }
-          }
-
-          return {
-            type: Token.NumericLiteral,
-            value: value,
-            base: 8,
-            isMalformed: false
-          };
+          index += 1;
+          value += char;
         }
 
         // Decimal numbers that start with '0' such as '09' are illegal
         // but we still parse them and return as malformed.
 
-        if (isDecimalDigit(char)) {
+        if (!isOctalDigit(char) && isDecimalDigit(char)) {
           index += 1;
           value += char;
         }
@@ -7162,12 +7961,42 @@ Lexer.prototype = {
 
       while (index < length) {
         char = this.peek(index);
-        if (!isDecimalDigit(char)) {
+
+        if (isLegacy && isDecimalDigit(char)) {
+          // Numbers like '019' (note the 9) are not valid octals
+          // but we still parse them and mark as malformed.
+          bad = true;
+        } else if (!isAllowedDigit(char)) {
           break;
         }
         value += char;
         index += 1;
       }
+
+      if (isAllowedDigit !== isDecimalDigit) {
+        if (!isLegacy && value.length <= 2) { // 0x
+          return {
+            type: Token.NumericLiteral,
+            value: value,
+            isMalformed: true
+          };
+        }
+
+        if (index < length) {
+          char = this.peek(index);
+          if (isIdentifierStart(char)) {
+            return null;
+          }
+        }
+
+        return {
+          type: Token.NumericLiteral,
+          value: value,
+          base: base,
+          isLegacy: isLegacy,
+          isMalformed: false
+        };
+      }
     }
 
     // Decimal digits.
@@ -7226,64 +8055,201 @@ Lexer.prototype = {
     return {
       type: Token.NumericLiteral,
       value: value,
-      base: 10,
+      base: base,
       isMalformed: !isFinite(value)
     };
   },
 
+
+  // Assumes previously parsed character was \ (=== '\\') and was not skipped.
+  scanEscapeSequence: function(checks) {
+    var allowNewLine = false;
+    var jump = 1;
+    this.skip();
+    var char = this.peek();
+
+    switch (char) {
+    case "'":
+      this.triggerAsync("warning", {
+        code: "W114",
+        line: this.line,
+        character: this.char,
+        data: [ "\\'" ]
+      }, checks, function() {return state.jsonMode; });
+      break;
+    case "b":
+      char = "\\b";
+      break;
+    case "f":
+      char = "\\f";
+      break;
+    case "n":
+      char = "\\n";
+      break;
+    case "r":
+      char = "\\r";
+      break;
+    case "t":
+      char = "\\t";
+      break;
+    case "0":
+      char = "\\0";
+
+      // Octal literals fail in strict mode.
+      // Check if the number is between 00 and 07.
+      var n = parseInt(this.peek(1), 10);
+      this.triggerAsync("warning", {
+        code: "W115",
+        line: this.line,
+        character: this.char
+      }, checks,
+      function() { return n >= 0 && n <= 7 && state.directive["use strict"]; });
+      break;
+    case "u":
+      var hexCode = this.input.substr(1, 4);
+      var code = parseInt(hexCode, 16);
+      if (isNaN(code)) {
+        this.trigger("warning", {
+          code: "W052",
+          line: this.line,
+          character: this.char,
+          data: [ "u" + hexCode ]
+        });
+      }
+      char = String.fromCharCode(code);
+      jump = 5;
+      break;
+    case "v":
+      this.triggerAsync("warning", {
+        code: "W114",
+        line: this.line,
+        character: this.char,
+        data: [ "\\v" ]
+      }, checks, function() { return state.jsonMode; });
+
+      char = "\v";
+      break;
+    case "x":
+      var  x = parseInt(this.input.substr(1, 2), 16);
+
+      this.triggerAsync("warning", {
+        code: "W114",
+        line: this.line,
+        character: this.char,
+        data: [ "\\x-" ]
+      }, checks, function() { return state.jsonMode; });
+
+      char = String.fromCharCode(x);
+      jump = 3;
+      break;
+    case "\\":
+      char = "\\\\";
+      break;
+    case "\"":
+      char = "\\\"";
+      break;
+    case "/":
+      break;
+    case "":
+      allowNewLine = true;
+      char = "";
+      break;
+    }
+
+    return { char: char, jump: jump, allowNewLine: allowNewLine };
+  },
+
   /*
    * Extract a template literal out of the next sequence of characters
    * and/or lines or return 'null' if its not possible. Since template
    * literals can span across multiple lines, this method has to move
    * the char pointer.
    */
-  scanTemplateLiteral: function () {
-    // String must start with a backtick.
-    if (!state.option.esnext || this.peek() !== "`") {
+  scanTemplateLiteral: function(checks) {
+    var tokenType;
+    var value = "";
+    var ch;
+    var startLine = this.line;
+    var startChar = this.char;
+    var depth = this.templateStarts.length;
+
+    if (!state.option.esnext) {
+      // Only lex template strings in ESNext mode.
+      return null;
+    } else if (this.peek() === "`") {
+      // Template must start with a backtick.
+      tokenType = Token.TemplateHead;
+      this.templateStarts.push({ line: this.line, char: this.char });
+      depth = this.templateStarts.length;
+      this.skip(1);
+      this.pushContext(Context.Template);
+    } else if (this.inContext(Context.Template) && this.peek() === "}") {
+      // If we're in a template context, and we have a '}', lex a TemplateMiddle.
+      tokenType = Token.TemplateMiddle;
+    } else {
+      // Go lex something else.
       return null;
     }
 
-    var startLine = this.line;
-    var startChar = this.char;
-    var jump = 1;
-    var value = "";
-
-    // For now, do not perform any linting of the content of the template
-    // string. Just skip until the next backtick is found.
-    this.skip();
-
     while (this.peek() !== "`") {
-      while (this.peek() === "") {
-        // End of line --- For template literals in ES6, no backslash is
-        // required to precede newlines.
+      while ((ch = this.peek()) === "") {
+        value += "\n";
         if (!this.nextLine()) {
+          // Unclosed template literal --- point to the starting "`"
+          var startPos = this.templateStarts.pop();
           this.trigger("error", {
             code: "E052",
-            line: startLine,
-            character: startChar
+            line: startPos.line,
+            character: startPos.char
           });
-
           return {
-            type: Token.TemplateLiteral,
+            type: tokenType,
             value: value,
-            isUnclosed: true
+            startLine: startLine,
+            startChar: startChar,
+            isUnclosed: true,
+            depth: depth,
+            context: this.popContext()
           };
         }
-        value += "\n";
       }
 
-      // TODO: do more interesting linting here, similar to string literal
-      // linting.
-      var char = this.peek();
-      this.skip(jump);
-      value += char;
+      if (ch === '$' && this.peek(1) === '{') {
+        value += '${';
+        this.skip(2);
+        return {
+          type: tokenType,
+          value: value,
+          startLine: startLine,
+          startChar: startChar,
+          isUnclosed: false,
+          depth: depth,
+          context: this.currentContext()
+        };
+      } else if (ch === '\\') {
+        var escape = this.scanEscapeSequence(checks);
+        value += escape.char;
+        this.skip(escape.jump);
+      } else if (ch !== '`') {
+        // Otherwise, append the value and continue.
+        value += ch;
+        this.skip(1);
+      }
     }
 
-    this.skip();
+    // Final value is either NoSubstTemplate or TemplateTail
+    tokenType = tokenType === Token.TemplateHead ? Token.NoSubstTemplate : Token.TemplateTail;
+    this.skip(1);
+    this.templateStarts.pop();
+
     return {
-      type: Token.TemplateLiteral,
+      type: tokenType,
       value: value,
-      isUnclosed: false
+      startLine: startLine,
+      startChar: startChar,
+      isUnclosed: false,
+      depth: depth,
+      context: this.popContext()
     };
   },
 
@@ -7298,7 +8264,7 @@ Lexer.prototype = {
    *   var str = "hello\
    *   world";
    */
-  scanStringLiteral: function (checks) {
+  scanStringLiteral: function(checks) {
     /*jshint loopfunc:true */
     var quote = this.peek();
 
@@ -7312,7 +8278,7 @@ Lexer.prototype = {
       code: "W108",
       line: this.line,
       character: this.char // +1?
-    }, checks, function () { return state.jsonMode && quote !== "\""; });
+    }, checks, function() { return state.jsonMode && quote !== "\""; });
 
     var value = "";
     var startLine = this.line;
@@ -7347,13 +8313,13 @@ Lexer.prototype = {
             code: "W043",
             line: this.line,
             character: this.char
-          }, checks, function () { return !state.option.multistr; });
+          }, checks, function() { return !state.option.multistr; });
 
           this.triggerAsync("warning", {
             code: "W042",
             line: this.line,
             character: this.char
-          }, checks, function () { return state.jsonMode && state.option.multistr; });
+          }, checks, function() { return state.jsonMode && state.option.multistr; });
         }
 
         // If we get an EOF inside of an unclosed string, show an
@@ -7369,6 +8335,8 @@ Lexer.prototype = {
           return {
             type: Token.StringLiteral,
             value: value,
+            startLine: startLine,
+            startChar: startChar,
             isUnclosed: true,
             quote: quote
           };
@@ -7394,101 +8362,11 @@ Lexer.prototype = {
       }
 
       // Special treatment for some escaped characters.
-
       if (char === "\\") {
-        this.skip();
-        char = this.peek();
-
-        switch (char) {
-        case "'":
-          this.triggerAsync("warning", {
-            code: "W114",
-            line: this.line,
-            character: this.char,
-            data: [ "\\'" ]
-          }, checks, function () {return state.jsonMode; });
-          break;
-        case "b":
-          char = "\\b";
-          break;
-        case "f":
-          char = "\\f";
-          break;
-        case "n":
-          char = "\\n";
-          break;
-        case "r":
-          char = "\\r";
-          break;
-        case "t":
-          char = "\\t";
-          break;
-        case "0":
-          char = "\\0";
-
-          // Octal literals fail in strict mode.
-          // Check if the number is between 00 and 07.
-          var n = parseInt(this.peek(1), 10);
-          this.triggerAsync("warning", {
-            code: "W115",
-            line: this.line,
-            character: this.char
-          }, checks,
-          function () { return n >= 0 && n <= 7 && state.directive["use strict"]; });
-          break;
-        case "u":
-          char = String.fromCharCode(parseInt(this.input.substr(1, 4), 16));
-          jump = 5;
-          break;
-        case "v":
-          this.triggerAsync("warning", {
-            code: "W114",
-            line: this.line,
-            character: this.char,
-            data: [ "\\v" ]
-          }, checks, function () { return state.jsonMode; });
-
-          char = "\v";
-          break;
-        case "x":
-          var  x = parseInt(this.input.substr(1, 2), 16);
-
-          this.triggerAsync("warning", {
-            code: "W114",
-            line: this.line,
-            character: this.char,
-            data: [ "\\x-" ]
-          }, checks, function () { return state.jsonMode; });
-
-          char = String.fromCharCode(x);
-          jump = 3;
-          break;
-        case "\\":
-          char = "\\\\";
-          break;
-        case "\"":
-          char = "\\\"";
-          break;
-        case "/":
-          break;
-        case "":
-          allowNewLine = true;
-          char = "";
-          break;
-        case "!":
-          if (value.slice(value.length - 2) === "<") {
-            break;
-          }
-
-          /*falls through */
-        default:
-          // Weird escaping.
-          this.trigger("warning", {
-            code: "W044",
-            line: this.line,
-            character: this.char
-          });
-        }
+        var parsed = this.scanEscapeSequence(checks);
+        char = parsed.char;
+        jump = parsed.jump;
+        allowNewLine = parsed.allowNewLine;
       }
 
       value += char;
@@ -7499,6 +8377,8 @@ Lexer.prototype = {
     return {
       type: Token.StringLiteral,
       value: value,
+      startLine: startLine,
+      startChar: startChar,
       isUnclosed: false,
       quote: quote
     };
@@ -7514,7 +8394,7 @@ Lexer.prototype = {
    * rare edge cases where one JavaScript engine complains about
    * your regular expression while others don't.
    */
-  scanRegExp: function () {
+  scanRegExp: function() {
     var index = 0;
     var length = this.input.length;
     var char = this.peek();
@@ -7525,7 +8405,7 @@ Lexer.prototype = {
     var isCharSet = false;
     var terminated;
 
-    var scanUnexpectedChars = function () {
+    var scanUnexpectedChars = function() {
       // Unexpected control character
       if (char < " ") {
         malformed = true;
@@ -7672,11 +8552,11 @@ Lexer.prototype = {
   },
 
   /*
-   * Scan for any occurence of non-breaking spaces. Non-breaking spaces
+   * Scan for any occurrence of non-breaking spaces. Non-breaking spaces
    * can be mistakenly typed on OS X with option-space. Non UTF-8 web
    * pages with non-breaking pages produce syntax errors.
    */
-  scanNonBreakingSpaces: function () {
+  scanNonBreakingSpaces: function() {
     return state.option.nonbsp ?
       this.input.search(/(\u00A0)/) : -1;
   },
@@ -7684,7 +8564,7 @@ Lexer.prototype = {
   /*
    * Scan for characters that get silently deleted by one or more browsers.
    */
-  scanUnsafeChars: function () {
+  scanUnsafeChars: function() {
     return this.input.search(reg.unsafeChars);
   },
 
@@ -7692,7 +8572,7 @@ Lexer.prototype = {
    * Produce the next raw token or return 'null' if no tokens can be matched.
    * This method skips over all space characters.
    */
-  next: function (checks) {
+  next: function(checks) {
     this.from = this.char;
 
     // Move to the next non-space character.
@@ -7711,7 +8591,7 @@ Lexer.prototype = {
 
     var match = this.scanComments() ||
       this.scanStringLiteral(checks) ||
-      this.scanTemplateLiteral();
+      this.scanTemplateLiteral(checks);
 
     if (match) {
       return match;
@@ -7727,7 +8607,7 @@ Lexer.prototype = {
       this.scanNumericLiteral();
 
     if (match) {
-      this.skip(match.value.length);
+      this.skip(match.tokenLength || match.value.length);
       return match;
     }
 
@@ -7740,7 +8620,7 @@ Lexer.prototype = {
    * Switch to the next line and reset all char pointers. Once
    * switched, this method also checks for other minor warnings.
    */
-  nextLine: function () {
+  nextLine: function() {
     var char;
 
     if (this.line >= this.getLines().length) {
@@ -7754,14 +8634,14 @@ Lexer.prototype = {
 
     var inputTrimmed = this.input.trim();
 
-    var startsWith = function () {
-      return _.some(arguments, function (prefix) {
+    var startsWith = function() {
+      return _.some(arguments, function(prefix) {
         return inputTrimmed.indexOf(prefix) === 0;
       });
     };
 
-    var endsWith = function () {
-      return _.some(arguments, function (suffix) {
+    var endsWith = function() {
+      return _.some(arguments, function(suffix) {
         return inputTrimmed.indexOf(suffix, inputTrimmed.length - suffix.length) !== -1;
       });
     };
@@ -7769,7 +8649,7 @@ Lexer.prototype = {
     // If we are ignoring linter errors, replace the input with empty string
     // if it doesn't already at least start or end a multi-line comment
     if (state.ignoreLinterErrors === true) {
-      if (!startsWith("/*", "//") && !endsWith("*/")) {
+      if (!startsWith("/*", "//") && !(this.inComment && endsWith("*/"))) {
         this.input = "";
       }
     }
@@ -7808,15 +8688,15 @@ Lexer.prototype = {
    * This is simply a synonym for nextLine() method with a friendlier
    * public name.
    */
-  start: function () {
+  start: function() {
     this.nextLine();
   },
 
   /*
    * Produce the next token. This function is called by advance() to get
-   * the next token. It retuns a token in a JSLint-compatible format.
+   * the next token. It returns a token in a JSLint-compatible format.
    */
-  token: function () {
+  token: function() {
     /*jshint loopfunc:true */
     var checks = asyncTrigger();
     var token;
@@ -7851,7 +8731,7 @@ Lexer.prototype = {
     }
 
     // Produce a token object.
-    var create = function (type, value, isProperty) {
+    var create = function(type, value, isProperty, token) {
       /*jshint validthis:true */
       var obj;
 
@@ -7866,6 +8746,8 @@ Lexer.prototype = {
         case "~":
         case "#":
         case "]":
+        case "++":
+        case "--":
           this.prereg = false;
           break;
         default:
@@ -7900,6 +8782,22 @@ Lexer.prototype = {
       obj.line = this.line;
       obj.character = this.char;
       obj.from = this.from;
+      if (obj.identifier && token) obj.raw_text = token.text || token.value;
+      if (token && token.startLine && token.startLine !== this.line) {
+        obj.startLine = token.startLine;
+      }
+      if (token && token.context) {
+        // Context of current token
+        obj.context = token.context;
+      }
+      if (token && token.depth) {
+        // Nested template depth
+        obj.depth = token.depth;
+      }
+      if (token && token.isUnclosed) {
+        // Mark token as unclosed string / template literal
+        obj.isUnclosed = token.isUnclosed;
+      }
 
       if (isProperty && obj.identifier) {
         obj.isProperty = isProperty;
@@ -7939,20 +8837,57 @@ Lexer.prototype = {
           line: this.line,
           char: this.char,
           from: this.from,
+          startLine: token.startLine,
+          startChar: token.startChar,
           value: token.value,
           quote: token.quote
-        }, checks, function () { return true; });
+        }, checks, function() { return true; });
 
-        return create("(string)", token.value);
+        return create("(string)", token.value, null, token);
 
-      case Token.TemplateLiteral:
-        this.trigger("Template", {
+      case Token.TemplateHead:
+        this.trigger("TemplateHead", {
           line: this.line,
           char: this.char,
           from: this.from,
+          startLine: token.startLine,
+          startChar: token.startChar,
           value: token.value
         });
-        return create("(template)", token.value);
+        return create("(template)", token.value, null, token);
+
+      case Token.TemplateMiddle:
+        this.trigger("TemplateMiddle", {
+          line: this.line,
+          char: this.char,
+          from: this.from,
+          startLine: token.startLine,
+          startChar: token.startChar,
+          value: token.value
+        });
+        return create("(template middle)", token.value, null, token);
+
+      case Token.TemplateTail:
+        this.trigger("TemplateTail", {
+          line: this.line,
+          char: this.char,
+          from: this.from,
+          startLine: token.startLine,
+          startChar: token.startChar,
+          value: token.value
+        });
+        return create("(template tail)", token.value, null, token);
+
+      case Token.NoSubstTemplate:
+        this.trigger("NoSubstTemplate", {
+          line: this.line,
+          char: this.char,
+          from: this.from,
+          startLine: token.startLine,
+          startChar: token.startChar,
+          value: token.value
+        });
+        return create("(no subst template)", token.value, null, token);
 
       case Token.Identifier:
         this.trigger("Identifier", {
@@ -7960,6 +8895,7 @@ Lexer.prototype = {
           char: this.char,
           from: this.form,
           name: token.value,
+          raw_name: token.text,
           isProperty: state.tokens.curr.id === "."
         });
 
@@ -7967,7 +8903,7 @@ Lexer.prototype = {
       case Token.Keyword:
       case Token.NullLiteral:
       case Token.BooleanLiteral:
-        return create("(identifier)", token.value, state.tokens.curr.id === ".");
+        return create("(identifier)", token.value, state.tokens.curr.id === ".", token);
 
       case Token.NumericLiteral:
         if (token.isMalformed) {
@@ -7984,14 +8920,14 @@ Lexer.prototype = {
           line: this.line,
           character: this.char,
           data: [ "0x-" ]
-        }, checks, function () { return token.base === 16 && state.jsonMode; });
+        }, checks, function() { return token.base === 16 && state.jsonMode; });
 
         this.triggerAsync("warning", {
           code: "W115",
           line: this.line,
           character: this.char
-        }, checks, function () {
-          return state.directive["use strict"] && token.base === 8;
+        }, checks, function() {
+          return state.directive["use strict"] && token.base === 8 && token.isLegacy;
         });
 
         this.trigger("Number", {
@@ -8037,9 +8973,10 @@ Lexer.prototype = {
 };
 
 exports.Lexer = Lexer;
+exports.Context = Context;
 
 },
-{"../data/ascii-identifier-data.js":1,"./reg.js":6,"./state.js":7,"events":10,"underscore":2}],
+{"../data/ascii-identifier-data.js":1,"./reg.js":8,"./state.js":9,"events":12,"underscore":2}],
 5:[function(_dereq_,module,exports){
 "use strict";
 
@@ -8110,7 +9047,9 @@ var errors = {
   E049: "A {a} cannot be named '{b}'.",
   E050: "Mozilla requires the yield expression to be parenthesized here.",
   E051: "Regular parameters cannot come after default parameters.",
-  E052: "Unclosed template literal."
+  E052: "Unclosed template literal.",
+  E053: "Export declaration must be in global scope.",
+  E054: "Class properties must be methods. Expected '(' but instead saw '{a}'."
 };
 
 var warnings = {
@@ -8156,7 +9095,7 @@ var warnings = {
   W041: "Use '{a}' to compare with '{b}'.",
   W042: "Avoid EOL escaping.",
   W043: "Bad escaping of EOL. Use option multistr if needed.",
-  W044: "Bad or unnecessary escaping.",
+  W044: "Bad or unnecessary escaping.", /* TODO(caitp): remove W044 */
   W045: "Bad number '{a}'.",
   W046: "Don't use extra leading zeros '{a}'.",
   W047: "A trailing decimal point can be confused with a dot: '{a}'.",
@@ -8189,7 +9128,7 @@ var warnings = {
   W072: "This function has too many parameters. ({a})",
   W073: "Blocks are nested too deeply. ({a})",
   W074: "This function's cyclomatic complexity is too high. ({a})",
-  W075: "Duplicate key '{a}'.",
+  W075: "Duplicate {a} '{b}'.",
   W076: "Unexpected parameter '{a}' in get {b} function.",
   W077: "Expected a single parameter in set {a} function.",
   W078: "Setter is defined without getter.",
@@ -8240,7 +9179,14 @@ var warnings = {
   W122: "Invalid typeof value '{a}'",
   W123: "'{a}' is already defined in outer scope.",
   W124: "A generator function shall contain a yield statement.",
-  W125: "This line contains non-breaking spaces: http://jshint.com/doc/options/#nonbsp"
+  W125: "This line contains non-breaking spaces: http://jshint.com/doc/options/#nonbsp",
+  W126: "Unnecessary grouping operator.",
+  W127: "Unexpected use of a comma operator.",
+  W128: "Empty array elements require elision=true.",
+  W129: "'{a}' is defined in a future version of JavaScript. Use a " +
+    "different variable name to avoid migration issues.",
+  W130: "Invalid element after rest element.",
+  W131: "Invalid parameter after rest parameter."
 };
 
 var info = {
@@ -8253,28 +9199,1057 @@ exports.errors = {};
 exports.warnings = {};
 exports.info = {};
 
-_.each(errors, function (desc, code) {
+_.each(errors, function(desc, code) {
   exports.errors[code] = { code: code, desc: desc };
 });
 
-_.each(warnings, function (desc, code) {
+_.each(warnings, function(desc, code) {
   exports.warnings[code] = { code: code, desc: desc };
 });
 
-_.each(info, function (desc, code) {
+_.each(info, function(desc, code) {
   exports.info[code] = { code: code, desc: desc };
 });
 
 },
 {"underscore":2}],
 6:[function(_dereq_,module,exports){
+"use strict";
+
+function NameStack() {
+  this._stack = [];
+}
+
+Object.defineProperty(NameStack.prototype, "length", {
+  get: function() {
+    return this._stack.length;
+  }
+});
+
+/**
+ * Create a new entry in the stack. Useful for tracking names across
+ * expressions.
+ */
+NameStack.prototype.push = function() {
+  this._stack.push(null);
+};
+
+/**
+ * Discard the most recently-created name on the stack.
+ */
+NameStack.prototype.pop = function() {
+  this._stack.pop();
+};
+
+/**
+ * Update the most recent name on the top of the stack.
+ *
+ * @param {object} token The token to consider as the source for the most
+ *                       recent name.
+ */
+NameStack.prototype.set = function(token) {
+  this._stack[this.length - 1] = token;
+};
+
+/**
+ * Generate a string representation of the most recent name.
+ *
+ * @returns {string}
+ */
+NameStack.prototype.infer = function() {
+  var nameToken = this._stack[this.length - 1];
+  var prefix = "";
+  var type;
+
+  // During expected operation, the topmost entry on the stack will only
+  // reflect the current function's name when the function is declared without
+  // the `function` keyword (i.e. for in-line accessor methods). In other
+  // cases, the `function` expression itself will introduce an empty entry on
+  // the top of the stack, and this should be ignored.
+  if (!nameToken || nameToken.type === "class") {
+    nameToken = this._stack[this.length - 2];
+  }
+
+  if (!nameToken) {
+    return "(empty)";
+  }
+
+  type = nameToken.type;
+
+  if (type !== "(string)" && type !== "(number)" && type !== "(identifier)" && type !== "default") {
+    return "(expression)";
+  }
+
+  if (nameToken.accessorType) {
+    prefix = nameToken.accessorType + " ";
+  }
+
+  return prefix + nameToken.value;
+};
+
+module.exports = NameStack;
+
+},
+{}],
+7:[function(_dereq_,module,exports){
+"use strict";
+
+// These are the JSHint boolean options.
+exports.bool = {
+  enforcing: {
+
+    /**
+     * This option prohibits the use of bitwise operators such as `^` (XOR),
+     * `|` (OR) and others. Bitwise operators are very rare in JavaScript
+     * programs and quite often `&` is simply a mistyped `&&`.
+     */
+    bitwise     : true,
+
+    /**
+     *
+     * This options prohibits overwriting prototypes of native objects such as
+     * `Array`, `Date` and so on.
+     *
+     *     // jshint freeze:true
+     *     Array.prototype.count = function (value) { return 4; };
+     *     // -> Warning: Extending prototype of native object: 'Array'.
+     */
+    freeze      : true,
+
+    /**
+     * This option allows you to force all variable names to use either
+     * camelCase style or UPPER_CASE with underscores.
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    camelcase   : true,
+
+    /**
+     * This option requires you to always put curly braces around blocks in
+     * loops and conditionals. JavaScript allows you to omit curly braces when
+     * the block consists of only one statement, for example:
+     *
+     *     while (day)
+     *       shuffle();
+     *
+     * However, in some circumstances, it can lead to bugs (you'd think that
+     * `sleep()` is a part of the loop while in reality it is not):
+     *
+     *     while (day)
+     *       shuffle();
+     *       sleep();
+     */
+    curly       : true,
+
+    /**
+     * This options prohibits the use of `==` and `!=` in favor of `===` and
+     * `!==`. The former try to coerce values before comparing them which can
+     * lead to some unexpected results. The latter don't do any coercion so
+     * they are generally safer. If you would like to learn more about type
+     * coercion in JavaScript, we recommend [Truth, Equality and
+     * JavaScript](http://javascriptweblog.wordpress.com/2011/02/07/truth-equality-and-javascript/)
+     * by Angus Croll.
+     */
+    eqeqeq      : true,
+
+    /**
+     * This option enables warnings about the use of identifiers which are
+     * defined in future versions of JavaScript. Although overwriting them has
+     * no effect in contexts where they are not implemented, this practice can
+     * cause issues when migrating codebases to newer versions of the language.
+     */
+    futurehostile: true,
+
+    /**
+     * This option suppresses warnings about invalid `typeof` operator values.
+     * This operator has only [a limited set of possible return
+     * values](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof).
+     * By default, JSHint warns when you compare its result with an invalid
+     * value which often can be a typo.
+     *
+     *     // 'fuction' instead of 'function'
+     *     if (typeof a == "fuction") { // Invalid typeof value 'fuction'
+     *       // ...
+     *     }
+     *
+     * Do not use this option unless you're absolutely sure you don't want
+     * these checks.
+     */
+    notypeof    : true,
+
+    /**
+     * This option tells JSHint that your code needs to adhere to ECMAScript 3
+     * specification. Use this option if you need your program to be executable
+     * in older browsers—such as Internet Explorer 6/7/8/9—and other legacy
+     * JavaScript environments.
+     */
+    es3         : true,
+
+    /**
+     * This option enables syntax first defined in [the ECMAScript 5.1
+     * specification](http://es5.github.io/). This includes allowing reserved
+     * keywords as object properties.
+     */
+    es5         : true,
+
+    /**
+     * This option requires all `for in` loops to filter object's items. The
+     * for in statement allows for looping through the names of all of the
+     * properties of an object including those inherited through the prototype
+     * chain. This behavior can lead to unexpected items in your object so it
+     * is generally safer to always filter inherited properties out as shown in
+     * the example:
+     *
+     *     for (key in obj) {
+     *       if (obj.hasOwnProperty(key)) {
+     *         // We are sure that obj[key] belongs to the object and was not inherited.
+     *       }
+     *     }
+     *
+     * For more in-depth understanding of `for in` loops in JavaScript, read
+     * [Exploring JavaScript for-in
+     * loops](http://javascriptweblog.wordpress.com/2011/01/04/exploring-javascript-for-in-loops/)
+     * by Angus Croll.
+     */
+    forin       : true,
+
+    /**
+     * This option suppresses warnings about declaring variables inside of
+     * control
+     * structures while accessing them later from the outside. Even though
+     * JavaScript has only two real scopes—global and function—such practice
+     * leads to confusion among people new to the language and hard-to-debug
+     * bugs. This is why, by default, JSHint warns about variables that are
+     * used outside of their intended scope.
+     *
+     *     function test() {
+     *       if (true) {
+     *         var x = 0;
+     *       }
+     *
+     *       x += 1; // Default: 'x' used out of scope.
+     *                 // No warning when funcscope:true
+     *     }
+     */
+    funcscope   : true,
+
+    /**
+     * This option suppresses warnings about the use of global strict mode.
+     * Global strict mode can break third-party widgets so it is not
+     * recommended.
+     *
+     * For more info about strict mode see the `strict` option.
+     */
+    globalstrict: true,
+
+    /**
+     * This option prohibits the use of immediate function invocations without
+     * wrapping them in parentheses. Wrapping parentheses assists readers of
+     * your code in understanding that the expression is the result of a
+     * function, and not the function itself.
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    immed       : true,
+
+    /**
+     * This option suppresses warnings about the `__iterator__` property. This
+     * property is not supported by all browsers so use it carefully.
+     */
+    iterator    : true,
+
+    /**
+     * This option requires you to capitalize names of constructor functions.
+     * Capitalizing functions that are intended to be used with `new` operator
+     * is just a convention that helps programmers to visually distinguish
+     * constructor functions from other types of functions to help spot
+     * mistakes when using `this`.
+     *
+     * Not doing so won't break your code in any browsers or environments but
+     * it will be a bit harder to figure out—by reading the code—if the
+     * function was supposed to be used with or without new. And this is
+     * important because when the function that was intended to be used with
+     * `new` is used without it, `this` will point to the global object instead
+     * of a new object.
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    newcap      : true,
+
+    /**
+     * This option prohibits the use of `arguments.caller` and
+     * `arguments.callee`.  Both `.caller` and `.callee` make quite a few
+     * optimizations impossible so they were deprecated in future versions of
+     * JavaScript. In fact, ECMAScript 5 forbids the use of `arguments.callee`
+     * in strict mode.
+     */
+    noarg       : true,
+
+    /**
+     * This option prohibits the use of the comma operator. When misused, the
+     * comma operator can obscure the value of a statement and promote
+     * incorrect code.
+     */
+    nocomma     : true,
+
+    /**
+     * This option warns when you have an empty block in your code. JSLint was
+     * originally warning for all empty blocks and we simply made it optional.
+     * There were no studies reporting that empty blocks in JavaScript break
+     * your code in any way.
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    noempty     : true,
+
+    /**
+     * This option warns about "non-breaking whitespace" characters. These
+     * characters can be entered with option-space on Mac computers and have a
+     * potential of breaking non-UTF8 web pages.
+     */
+    nonbsp      : true,
+
+    /**
+     * This option prohibits the use of constructor functions for side-effects.
+     * Some people like to call constructor functions without assigning its
+     * result to any variable:
+     *
+     *     new MyConstructor();
+     *
+     * There is no advantage in this approach over simply calling
+     * `MyConstructor` since the object that the operator `new` creates isn't
+     * used anywhere so you should generally avoid constructors like this one.
+     */
+    nonew       : true,
+
+    /**
+     * This option prohibits the use of explicitly undeclared variables. This
+     * option is very useful for spotting leaking and mistyped variables.
+     *
+     *     // jshint undef:true
+     *
+     *     function test() {
+     *       var myVar = 'Hello, World';
+     *       console.log(myvar); // Oops, typoed here. JSHint with undef will complain
+     *     }
+     *
+     * If your variable is defined in another file, you can use the `global`
+     * directive to tell JSHint about it.
+     */
+    undef       : true,
+
+    /**
+     * This option prohibits the use of the grouping operator when it is not
+     * strictly required. Such usage commonly reflects a misunderstanding of
+     * unary operators, for example:
+     *
+     *     // jshint singleGroups: true
+     *
+     *     delete(obj.attr); // Warning: Unnecessary grouping operator.
+     */
+    singleGroups: false,
+
+    /**
+     * This option is a short hand for the most strict JSHint configuration. It
+     * enables all enforcing options and disables all relaxing options.
+     *
+     * @deprecated The option automatically opts users in to new features which
+     *             can lead to unexpected warnings/errors in when upgrading
+     *             between minor versions of JSHint.
+     */
+    enforceall : false
+  },
+  relaxing: {
+
+    /**
+     * This option suppresses warnings about missing semicolons. There is a lot
+     * of FUD about semicolon spread by quite a few people in the community.
+     * The common myths are that semicolons are required all the time (they are
+     * not) and that they are unreliable. JavaScript has rules about semicolons
+     * which are followed by *all* browsers so it is up to you to decide
+     * whether you should or should not use semicolons in your code.
+     *
+     * For more information about semicolons in JavaScript read [An Open Letter
+     * to JavaScript Leaders Regarding
+     * Semicolons](http://blog.izs.me/post/2353458699/an-open-letter-to-javascript-leaders-regarding)
+     * by Isaac Schlueter and [JavaScript Semicolon
+     * Insertion](http://inimino.org/~inimino/blog/javascript_semicolons).
+     */
+    asi         : true,
+
+    /**
+     * This option suppresses warnings about multi-line strings. Multi-line
+     * strings can be dangerous in JavaScript because all hell breaks loose if
+     * you accidentally put a whitespace in between the escape character (`\`)
+     * and a new line.
+     *
+     * Note that even though this option allows correct multi-line strings, it
+     * still warns about multi-line strings without escape characters or with
+     * anything in between the escape character and a whitespace.
+     *
+     *     // jshint multistr:true
+     *
+     *     var text = "Hello\
+     *     World"; // All good.
+     *
+     *     text = "Hello
+     *     World"; // Warning, no escape character.
+     *
+     *     text = "Hello\
+     *     World"; // Warning, there is a space after \
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    multistr    : true,
+
+    /**
+     * This option suppresses warnings about the `debugger` statements in your
+     * code.
+     */
+    debug       : true,
+
+    /**
+     * This option suppresses warnings about the use of assignments in cases
+     * where comparisons are expected. More often than not, code like `if (a =
+     * 10) {}` is a typo. However, it can be useful in cases like this one:
+     *
+     *     for (var i = 0, person; person = people[i]; i++) {}
+     *
+     * You can silence this error on a per-use basis by surrounding the assignment
+     * with parenthesis, such as:
+     *
+     *     for (var i = 0, person; (person = people[i]); i++) {}
+     */
+    boss        : true,
+
+    /**
+     * This option defines globals available when your core is running inside
+     * of the PhantomJS runtime environment. [PhantomJS](http://phantomjs.org/)
+     * is a headless WebKit scriptable with a JavaScript API. It has fast and
+     * native support for various web standards: DOM handling, CSS selector,
+     * JSON, Canvas, and SVG.
+     */
+    phantom     : true,
+
+    /**
+     * This option suppresses warnings about the use of `eval`. The use of
+     * `eval` is discouraged because it can make your code vulnerable to
+     * various injection attacks and it makes it hard for JavaScript
+     * interpreter to do certain optimizations.
+    */
+    evil        : true,
+
+    /**
+     * This option prohibits the use of unary increment and decrement
+     * operators.  Some people think that `++` and `--` reduces the quality of
+     * their coding styles and there are programming languages—such as
+     * Python—that go completely without these operators.
+     */
+    plusplus    : true,
+
+    /**
+     * This option suppresses warnings about the `__proto__` property.
+     */
+    proto       : true,
+
+    /**
+     * This option suppresses warnings about the use of script-targeted
+     * URLs—such as `javascript:...`.
+     */
+    scripturl   : true,
+
+    /**
+     * This option requires all functions to run in ECMAScript 5's strict mode.
+     * [Strict mode](https://developer.mozilla.org/en/JavaScript/Strict_mode)
+     * is a way to opt in to a restricted variant of JavaScript. Strict mode
+     * eliminates some JavaScript pitfalls that didn't cause errors by changing
+     * them to produce errors.  It also fixes mistakes that made it difficult
+     * for the JavaScript engines to perform certain optimizations.
+     *
+     * *Note:* This option enables strict mode for function scope only. It
+     * *prohibits* the global scoped strict mode because it might break
+     * third-party widgets on your page. If you really want to use global
+     * strict mode, see the *globalstrict* option.
+     */
+    strict      : true,
+
+    /**
+     * This option suppresses warnings about using `[]` notation when it can be
+     * expressed in dot notation: `person['name']` vs. `person.name`.
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    sub         : true,
+
+    /**
+     * This option suppresses warnings about "weird" constructions like
+     * `new function () { ... }` and `new Object;`. Such constructions are
+     * sometimes used to produce singletons in JavaScript:
+     *
+     *     var singleton = new function() {
+     *       var privateVar;
+     *
+     *       this.publicMethod  = function () {}
+     *       this.publicMethod2 = function () {}
+     *     };
+     */
+    supernew    : true,
+
+    /**
+     * This option suppresses most of the warnings about possibly unsafe line
+     * breakings in your code. It doesn't suppress warnings about comma-first
+     * coding style. To suppress those you have to use `laxcomma` (see below).
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    laxbreak    : true,
+
+    /**
+     * This option suppresses warnings about comma-first coding style:
+     *
+     *     var obj = {
+     *         name: 'Anton'
+     *       , handle: 'valueof'
+     *       , role: 'SW Engineer'
+     *     };
+     *
+     * @deprecated JSHint is limiting its scope to issues of code correctness.
+     *             If you would like to enforce rules relating to code style,
+     *             check out [the JSCS
+     *             project](https://github.com/jscs-dev/node-jscs).
+     */
+    laxcomma    : true,
+
+    /**
+     * This option suppresses warnings about possible strict violations when
+     * the code is running in strict mode and you use `this` in a
+     * non-constructor function. You should use this option—in a function scope
+     * only—when you are positive that your use of `this` is valid in the
+     * strict mode (for example, if you call your function using
+     * `Function.call`).
+     *
+     * **Note:** This option can be used only inside of a function scope.
+     * JSHint will fail with an error if you will try to set this option
+     * globally.
+     */
+    validthis   : true,
+
+    /**
+     * This option suppresses warnings about the use of the `with` statement.
+     * The semantics of the `with` statement can cause confusion among
+     * developers and accidental definition of global variables.
+     *
+     * More info:
+     *
+     * * [with Statement Considered
+     *   Harmful](http://yuiblog.com/blog/2006/04/11/with-statement-considered-harmful/)
+     */
+    withstmt    : true,
+
+    /**
+     * This options tells JSHint that your code uses Mozilla JavaScript
+     * extensions. Unless you develop specifically for the Firefox web browser
+     * you don't need this option.
+     *
+     * More info:
+     *
+     * * [New in JavaScript
+     *   1.7](https://developer.mozilla.org/en-US/docs/JavaScript/New_in_JavaScript/1.7)
+     */
+    moz         : true,
+
+    /**
+     * This option suppresses warnings about generator functions with no
+     * `yield` statement in them.
+     */
+    noyield     : true,
+
+    /**
+     * This option suppresses warnings about `== null` comparisons. Such
+     * comparisons are often useful when you want to check if a variable is
+     * `null` or `undefined`.
+     */
+    eqnull      : true,
+
+    /**
+     * This option suppresses warnings about missing semicolons, but only when
+     * the semicolon is omitted for the last statement in a one-line block:
+     *
+     *     var name = (function() { return 'Anton' }());
+     *
+     * This is a very niche use case that is useful only when you use automatic
+     * JavaScript code generators.
+     */
+    lastsemic   : true,
+
+    /**
+     * This option suppresses warnings about functions inside of loops.
+     * Defining functions inside of loops can lead to bugs such as this one:
+     *
+     *     var nums = [];
+     *
+     *     for (var i = 0; i < 10; i++) {
+     *       nums[i] = function (j) {
+     *         return i + j;
+     *       };
+     *     }
+     *
+     *     nums[0](2); // Prints 12 instead of 2
+     *
+     * To fix the code above you need to copy the value of `i`:
+     *
+     *     var nums = [];
+     *
+     *     for (var i = 0; i < 10; i++) {
+     *       (function (i) {
+     *         nums[i] = function (j) {
+     *             return i + j;
+     *         };
+     *       }(i));
+     *     }
+     */
+    loopfunc    : true,
+
+    /**
+     * This option suppresses warnings about the use of expressions where
+     * normally you would expect to see assignments or function calls. Most of
+     * the time, such code is a typo. However, it is not forbidden by the spec
+     * and that's why this warning is optional.
+     */
+    expr        : true,
+
+    /**
+     * This option tells JSHint that your code uses ECMAScript 6 specific
+     * syntax. Note that these features are not finalized yet and not all
+     * browsers implement them.
+     *
+     * More info:
+     *
+     * * [Draft Specification for ES.next (ECMA-262 Ed.
+     *   6)](http://wiki.ecmascript.org/doku.php?id=harmony:specification_drafts)
+     */
+    esnext      : true,
+
+    /**
+     * This option tells JSHint that your code uses ES3 array elision elements,
+     * or empty elements (for example, `[1, , , 4, , , 7]`).
+     */
+    elision     : true,
+  },
+
+  // Third party globals
+  environments: {
+
+    /**
+     * This option defines globals exposed by the
+     * [MooTools](http://mootools.net/) JavaScript framework.
+     */
+    mootools    : true,
+
+    /**
+     * This option defines globals exposed by
+     * [CouchDB](http://couchdb.apache.org/). CouchDB is a document-oriented
+     * database that can be queried and indexed in a MapReduce fashion using
+     * JavaScript.
+     */
+    couch       : true,
+
+    /**
+     * This option defines globals exposed by [the Jasmine unit testing
+     * framework](https://jasmine.github.io/).
+     */
+    jasmine     : true,
+
+    /**
+     * This option defines globals exposed by the [jQuery](http://jquery.com/)
+     * JavaScript library.
+     */
+    jquery      : true,
+
+    /**
+     * This option defines globals available when your code is running inside
+     * of the Node runtime environment. [Node.js](http://nodejs.org/) is a
+     * server-side JavaScript environment that uses an asynchronous
+     * event-driven model. This option also skips some warnings that make sense
+     * in the browser environments but don't make sense in Node such as
+     * file-level `use strict` pragmas and `console.log` statements.
+     */
+    node        : true,
+
+    /**
+     * This option defines globals exposed by [the QUnit unit testing
+     * framework](http://qunitjs.com/).
+     */
+    qunit       : true,
+
+    /**
+     * This option defines globals available when your code is running inside
+     * of the Rhino runtime environment. [Rhino](http://www.mozilla.org/rhino/)
+     * is an open-source implementation of JavaScript written entirely in Java.
+     */
+    rhino       : true,
+
+    /**
+     * This option defines globals exposed by [the ShellJS
+     * library](http://documentup.com/arturadib/shelljs).
+     */
+    shelljs     : true,
+
+    /**
+     * This option defines globals exposed by the
+     * [Prototype](http://www.prototypejs.org/) JavaScript framework.
+     */
+    prototypejs : true,
+
+    /**
+     * This option defines globals exposed by the [YUI](http://yuilibrary.com/)
+     * JavaScript framework.
+     */
+    yui         : true,
+
+    /**
+     * This option defines globals exposed by the "BDD" and "TDD" UIs of the
+     * [Mocha unit testing framework](http://mochajs.org/).
+     */
+    mocha       : true,
+
+    /**
+     * This option defines globals available when your code is running as a
+     * script for the [Windows Script
+     * Host](http://en.wikipedia.org/wiki/Windows_Script_Host).
+     */
+    wsh         : true,
+
+    /**
+     * This option defines globals available when your code is running inside
+     * of a Web Worker. [Web
+     * Workers](https://developer.mozilla.org/en/Using_web_workers) provide a
+     * simple means for web content to run scripts in background threads.
+     */
+    worker      : true,
+
+    /**
+     * This option defines non-standard but widely adopted globals such as
+     * `escape` and `unescape`.
+     */
+    nonstandard : true,
+
+    /**
+     * This option defines globals exposed by modern browsers: all the way from
+     * good old `document` and `navigator` to the HTML5 `FileReader` and other
+     * new developments in the browser world.
+     *
+     * **Note:** This option doesn't expose variables like `alert` or
+     * `console`. See option `devel` for more information.
+     */
+    browser     : true,
+
+    /**
+     * This option defines globals available when using [the Browserify
+     * tool](http://browserify.org/) to build a project.
+     */
+    browserify  : true,
+
+    /**
+     * This option defines globals that are usually used for logging poor-man's
+     * debugging: `console`, `alert`, etc. It is usually a good idea to not
+     * ship them in production because, for example, `console.log` breaks in
+     * legacy versions of Internet Explorer.
+     */
+    devel       : true,
+
+    /**
+     * This option defines globals exposed by the [Dojo
+     * Toolkit](http://dojotoolkit.org/).
+     */
+    dojo        : true,
+
+    /**
+     * This option defines globals for typed array constructors.
+     *
+     * More info:
+     *
+     * * [JavaScript typed
+     *   arrays](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays)
+     */
+    typed       : true
+  },
+
+  // Obsolete options
+  obsolete: {
+    onecase     : true, // if one case switch statements should be allowed
+    regexp      : true, // if the . should not be allowed in regexp literals
+    regexdash   : true  // if unescaped first/last dash (-) inside brackets
+                        // should be tolerated
+  }
+};
+
+// These are the JSHint options that can take any value
+// (we use this object to detect invalid options)
+exports.val = {
+
+  /**
+   * This option lets you set the maximum length of a line.
+   *
+   * @deprecated JSHint is limiting its scope to issues of code correctness. If
+   *             you would like to enforce rules relating to code style, check
+   *             out [the JSCS project](https://github.com/jscs-dev/node-jscs).
+   */
+  maxlen       : false,
+
+  /**
+   * This option sets a specific tab width for your code.
+   *
+   * @deprecated JSHint is limiting its scope to issues of code correctness. If
+   *             you would like to enforce rules relating to code style, check
+   *             out [the JSCS project](https://github.com/jscs-dev/node-jscs).
+   */
+  indent       : false,
+
+  /**
+   * This options allows you to set the maximum amount of warnings JSHint will
+   * produce before giving up. Default is 50.
+   */
+  maxerr       : false,
+
+  predef       : false, // predef is deprecated and being replaced by globals
+
+  /**
+   * This option can be used to specify a white list of global variables that
+   * are not formally defined in the source code. This is most useful when
+   * combined with the `undef` option in order to suppress warnings for
+   * project-specific global variables.
+   *
+   * Setting an entry to `true` enables reading and writing to that variable.
+   * Setting it to `false` will trigger JSHint to consider that variable
+   * read-only.
+   *
+   * See also the "environment" options: a set of options to be used as short
+   * hand for enabling global variables defined in common JavaScript
+   * environments.
+   */
+  globals      : false,
+
+  /**
+   * This option enforces the consistency of quotation marks used throughout
+   * your code. It accepts three values: `true` if you don't want to enforce
+   * one particular style but want some consistency, `"single"` if you want to
+   * allow only single quotes and `"double"` if you want to allow only double
+   * quotes.
+   *
+   * @deprecated JSHint is limiting its scope to issues of code correctness. If
+   *             you would like to enforce rules relating to code style, check
+   *             out [the JSCS project](https://github.com/jscs-dev/node-jscs).
+   */
+  quotmark     : false,
+
+  scope        : false,
+
+  /**
+   * This option lets you set the max number of statements allowed per function:
+   *
+   *     // jshint maxstatements:4
+   *
+   *     function main() {
+   *       var i = 0;
+   *       var j = 0;
+   *
+   *       // Function declarations count as one statement. Their bodies
+   *       // don't get taken into account for the outer function.
+   *       function inner() {
+   *         var i2 = 1;
+   *         var j2 = 1;
+   *
+   *         return i2 + j2;
+   *       }
+   *
+   *       j = i + j;
+   *       return j; // JSHint: Too many statements per function. (5)
+   *     }
+   */
+  maxstatements: false,
+
+  /**
+   * This option lets you control how nested do you want your blocks to be:
+   *
+   *     // jshint maxdepth:2
+   *
+   *     function main(meaning) {
+   *       var day = true;
+   *
+   *       if (meaning === 42) {
+   *         while (day) {
+   *           shuffle();
+   *
+   *           if (tired) { // JSHint: Blocks are nested too deeply (3).
+   *               sleep();
+   *           }
+   *         }
+   *       }
+   *     }
+   */
+  maxdepth     : false,
+
+  /**
+   * This option lets you set the max number of formal parameters allowed per
+   * function:
+   *
+   *     // jshint maxparams:3
+   *
+   *     function login(request, onSuccess) {
+   *       // ...
+   *     }
+   *
+   *     // JSHint: Too many parameters per function (4).
+   *     function logout(request, isManual, whereAmI, onSuccess) {
+   *       // ...
+   *     }
+   */
+  maxparams    : false,
+
+  /**
+   * This option lets you control cyclomatic complexity throughout your code.
+   * Cyclomatic complexity measures the number of linearly independent paths
+   * through a program's source code. Read more about [cyclomatic complexity on
+   * Wikipedia](http://en.wikipedia.org/wiki/Cyclomatic_complexity).
+   */
+  maxcomplexity: false,
+
+  /**
+   * This option suppresses warnings about variable shadowing i.e. declaring a
+   * variable that had been already declared somewhere in the outer scope.
+   *
+   * - "inner"  - check for variables defined in the same scope only
+   * - "outer"  - check for variables defined in outer scopes as well
+   * - false    - same as inner
+   * - true     - allow variable shadowing
+   */
+  shadow       : false,
+
+  /**
+   * This option warns when you define and never use your variables. It is very
+   * useful for general code cleanup, especially when used in addition to
+   * `undef`.
+   *
+   *     // jshint unused:true
+   *
+   *     function test(a, b) {
+   *       var c, d = 2;
+   *
+   *       return a + d;
+   *     }
+   *
+   *     test(1, 2);
+   *
+   *     // Line 3: 'b' was defined but never used.
+   *     // Line 4: 'c' was defined but never used.
+   *
+   * In addition to that, this option will warn you about unused global
+   * variables declared via the `global` directive.
+   *
+   * This can be set to `vars` to only check for variables, not function
+   * parameters, or `strict` to check all variables and parameters.  The
+   * default (true) behavior is to allow unused parameters that are followed by
+   * a used parameter.
+   */
+  unused       : true,
+
+  /**
+   * This option prohibits the use of a variable before it was defined.
+   * JavaScript has function scope only and, in addition to that, all variables
+   * are always moved—or hoisted— to the top of the function. This behavior can
+   * lead to some very nasty bugs and that's why it is safer to always use
+   * variable only after they have been explicitly defined.
+   *
+   * Setting this option to "nofunc" will allow function declarations to be
+   * ignored.
+   *
+   * For more in-depth understanding of scoping and hoisting in JavaScript,
+   * read [JavaScript Scoping and
+   * Hoisting](http://www.adequatelygood.com/2010/2/JavaScript-Scoping-and-Hoisting)
+   * by Ben Cherry.
+   */
+  latedef      : false,
+
+  ignore       : false, // start/end ignoring lines of code, bypassing the lexer
+                        //   start    - start ignoring lines, including the current line
+                        //   end      - stop ignoring lines, starting on the next line
+                        //   line     - ignore warnings / errors for just a single line
+                        //              (this option does not bypass the lexer)
+  ignoreDelimiters: false // array of start/end delimiters used to ignore
+                          // certain chunks from code
+};
+
+// These are JSHint boolean options which are shared with JSLint
+// where the definition in JSHint is opposite JSLint
+exports.inverted = {
+  bitwise : true,
+  forin   : true,
+  newcap  : true,
+  plusplus: true,
+  regexp  : true,
+  undef   : true,
+
+  // Inverted and renamed, use JSHint name here
+  eqeqeq  : true,
+  strict  : true
+};
+
+exports.validNames = Object.keys(exports.val)
+  .concat(Object.keys(exports.bool.relaxing))
+  .concat(Object.keys(exports.bool.enforcing))
+  .concat(Object.keys(exports.bool.obsolete))
+  .concat(Object.keys(exports.bool.environments));
+
+// These are JSHint boolean options which are shared with JSLint
+// where the name has been changed but the effect is unchanged
+exports.renamed = {
+  eqeq   : "eqeqeq",
+  windows: "wsh",
+  sloppy : "strict"
+};
+
+exports.removed = {
+  nomen: true,
+  onevar: true,
+  passfail: true,
+  white: true,
+  gcl: true,
+  smarttabs: true,
+  trailing: true
+};
+
+},
+{}],
+8:[function(_dereq_,module,exports){
 /*
  * Regular expressions. Some of these are stupidly long.
  */
 
 /*jshint maxlen:1000 */
 
-"use string";
+"use strict";
 
 // Unsafe comment or string (ax)
 exports.unsafeString =
@@ -8309,13 +10284,14 @@ exports.maxlenException = /^(?:(?:\/\/|\/\*|\*) ?)?[^ ]+$/;
 
 },
 {}],
-7:[function(_dereq_,module,exports){
+9:[function(_dereq_,module,exports){
 "use strict";
+var NameStack = _dereq_("./name-stack.js");
 
 var state = {
   syntax: {},
 
-  reset: function () {
+  reset: function() {
     this.tokens = {
       prev: null,
       next: null,
@@ -8331,6 +10307,8 @@ var state = {
     this.tab = "";
     this.cache = {}; // Node.JS doesn't have Map. Sniff.
     this.ignoredLines = {};
+    this.forinifcheckneeded = false;
+    this.nameStack = new NameStack();
 
     // Blank out non-multi-line-commented lines when ignoring linter errors
     this.ignoreLinterErrors = false;
@@ -8340,11 +10318,11 @@ var state = {
 exports.state = state;
 
 },
-{}],
-8:[function(_dereq_,module,exports){
+{"./name-stack.js":6}],
+10:[function(_dereq_,module,exports){
 "use strict";
 
-exports.register = function (linter) {
+exports.register = function(linter) {
   // Check for properties named __proto__. This special property was
   // deprecated and then re-introduced for ES6.
 
@@ -8488,7 +10466,7 @@ exports.register = function (linter) {
 
 },
 {}],
-9:[function(_dereq_,module,exports){
+11:[function(_dereq_,module,exports){
 // jshint -W001
 
 "use strict";
@@ -8501,42 +10479,47 @@ exports.reservedVars = {
 };
 
 exports.ecmaIdentifiers = {
-  Array              : false,
-  Boolean            : false,
-  Date               : false,
-  decodeURI          : false,
-  decodeURIComponent : false,
-  encodeURI          : false,
-  encodeURIComponent : false,
-  Error              : false,
-  "eval"             : false,
-  EvalError          : false,
-  Function           : false,
-  hasOwnProperty     : false,
-  isFinite           : false,
-  isNaN              : false,
-  JSON               : false,
-  Math               : false,
-  Number             : false,
-  Object             : false,
-  parseInt           : false,
-  parseFloat         : false,
-  RangeError         : false,
-  ReferenceError     : false,
-  RegExp             : false,
-  String             : false,
-  SyntaxError        : false,
-  TypeError          : false,
-  URIError           : false,
-};
-
-exports.newEcmaIdentifiers = {
-  Set     : false,
-  Map     : false,
-  WeakMap : false,
-  WeakSet : false,
-  Proxy   : false,
-  Promise : false
+  3: {
+    Array              : false,
+    Boolean            : false,
+    Date               : false,
+    decodeURI          : false,
+    decodeURIComponent : false,
+    encodeURI          : false,
+    encodeURIComponent : false,
+    Error              : false,
+    "eval"             : false,
+    EvalError          : false,
+    Function           : false,
+    hasOwnProperty     : false,
+    isFinite           : false,
+    isNaN              : false,
+    Math               : false,
+    Number             : false,
+    Object             : false,
+    parseInt           : false,
+    parseFloat         : false,
+    RangeError         : false,
+    ReferenceError     : false,
+    RegExp             : false,
+    String             : false,
+    SyntaxError        : false,
+    TypeError          : false,
+    URIError           : false
+  },
+  5: {
+    JSON               : false
+  },
+  6: {
+    Map                : false,
+    Promise            : false,
+    Proxy              : false,
+    Reflect            : false,
+    Set                : false,
+    Symbol             : false,
+    WeakMap            : false,
+    WeakSet            : false
+  }
 };
 
 // Global variables commonly provided by a web browser environment.
@@ -8549,19 +10532,25 @@ exports.browser = {
   atob                 : false,
   blur                 : false,
   btoa                 : false,
+  cancelAnimationFrame : false,
   CanvasGradient       : false,
   CanvasPattern        : false,
   CanvasRenderingContext2D: false,
+  CSS                  : false,
   clearInterval        : false,
   clearTimeout         : false,
   close                : false,
   closed               : false,
+  Comment              : false,
   CustomEvent          : false,
   DOMParser            : false,
   defaultStatus        : false,
+  Document             : false,
   document             : false,
+  DocumentFragment     : false,
   Element              : false,
   ElementTimeControl   : false,
+  Event                : false,
   event                : false,
   FileReader           : false,
   FormData             : false,
@@ -8618,12 +10607,14 @@ exports.browser = {
   HTMLTableElement     : false,
   HTMLTableRowElement  : false,
   HTMLTableSectionElement: false,
+  HTMLTemplateElement  : false,
   HTMLTextAreaElement  : false,
   HTMLTitleElement     : false,
   HTMLUListElement     : false,
   HTMLVideoElement     : false,
   history              : false,
   Image                : false,
+  Intl                 : false,
   length               : false,
   localStorage         : false,
   location             : false,
@@ -8639,6 +10630,7 @@ exports.browser = {
   Node                 : false,
   NodeFilter           : false,
   NodeList             : false,
+  Notification         : false,
   navigator            : false,
   onbeforeunload       : true,
   onblur               : true,
@@ -8653,6 +10645,8 @@ exports.browser = {
   Option               : false,
   parent               : false,
   print                : false,
+  Range                : false,
+  requestAnimationFrame : false,
   removeEventListener  : false,
   resizeBy             : false,
   resizeTo             : false,
@@ -8820,12 +10814,27 @@ exports.browser = {
   SVGViewElement       : false,
   SVGViewSpec          : false,
   SVGZoomAndPan        : false,
+  Text                 : false,
+  TextDecoder          : false,
+  TextEncoder          : false,
   TimeEvent            : false,
   top                  : false,
   URL                  : false,
+  WebGLActiveInfo      : false,
+  WebGLBuffer          : false,
+  WebGLContextEvent    : false,
+  WebGLFramebuffer     : false,
+  WebGLProgram         : false,
+  WebGLRenderbuffer    : false,
+  WebGLRenderingContext: false,
+  WebGLShader          : false,
+  WebGLShaderPrecisionFormat: false,
+  WebGLTexture         : false,
+  WebGLUniformLocation : false,
   WebSocket            : false,
   window               : false,
   Worker               : false,
+  XDomainRequest       : false,
   XMLHttpRequest       : false,
   XMLSerializer        : false,
   XPathEvaluator       : false,
@@ -8846,9 +10855,10 @@ exports.devel = {
 };
 
 exports.worker = {
-  importScripts: true,
-  postMessage  : true,
-  self         : true
+  importScripts  : true,
+  postMessage    : true,
+  self           : true,
+  FileReaderSync : true
 };
 
 // Widely adopted global names that are not part of ECMAScript standard
@@ -8896,6 +10906,17 @@ exports.node = {
   clearImmediate: true  // v0.9.1+
 };
 
+exports.browserify = {
+  __filename    : false,
+  __dirname     : false,
+  global        : false,
+  module        : false,
+  require       : false,
+  Buffer        : true,
+  exports       : true,
+  process       : true
+};
+
 exports.phantom = {
   phantom      : true,
   require      : true,
@@ -9119,16 +11140,22 @@ exports.yui = {
 exports.mocha = {
   // BDD
   describe    : false,
+  xdescribe   : false,
   it          : false,
+  xit         : false,
+  context     : false,
+  xcontext    : false,
   before      : false,
   after       : false,
   beforeEach  : false,
   afterEach   : false,
   // TDD
-  suite       : false,
-  test        : false,
-  setup       : false,
-  teardown    : false
+  suite         : false,
+  test          : false,
+  setup         : false,
+  teardown      : false,
+  suiteSetup    : false,
+  suiteTeardown : false
 };
 
 exports.jasmine = {
@@ -9145,12 +11172,18 @@ exports.jasmine = {
   // Jasmine 1.3
   runs        : false,
   waitsFor    : false,
-  waits       : false
+  waits       : false,
+  // Jasmine 2.1
+  beforeAll   : false,
+  afterAll    : false,
+  fail        : false,
+  fdescribe   : false,
+  fit         : false
 };
 
 },
 {}],
-10:[function(_dereq_,module,exports){
+12:[function(_dereq_,module,exports){
 // Copyright Joyent, Inc. and other Node contributors.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -9298,7 +11331,10 @@ EventEmitter.prototype.addListener = function(type, listener) {
                     'leak detected. %d listeners added. ' +
                     'Use emitter.setMaxListeners() to increase limit.',
                     this._events[type].length);
-      console.trace();
+      if (typeof console.trace === 'function') {
+        // not supported in IE 10
+        console.trace();
+      }
     }
   }
 
diff --git a/lib/ace/mode/javascript_highlight_rules.js b/lib/ace/mode/javascript_highlight_rules.js
index 767b8fa1..5bdcce12 100644
--- a/lib/ace/mode/javascript_highlight_rules.js
+++ b/lib/ace/mode/javascript_highlight_rules.js
@@ -172,7 +172,7 @@ var JavaScriptHighlightRules = function(options) {
                 regex : /(\.)(s(?:h(?:ift|ow(?:Mod(?:elessDialog|alDialog)|Help))|croll(?:X|By(?:Pages|Lines)?|Y|To)?|t(?:op|rike)|i(?:n|zeToContent|debar|gnText)|ort|u(?:p|b(?:str(?:ing)?)?)|pli(?:ce|t)|e(?:nd|t(?:Re(?:sizable|questHeader)|M(?:i(?:nutes|lliseconds)|onth)|Seconds|Ho(?:tKeys|urs)|Year|Cursor|Time(?:out)?|Interval|ZOptions|Date|UTC(?:M(?:i(?:nutes|lliseconds)|onth)|Seconds|Hours|Date|FullYear)|FullYear|Active)|arch)|qrt|lice|avePreferences|mall)|h(?:ome|andleEvent)|navigate|c(?:har(?:CodeAt|At)|o(?:s|n(?:cat|textual|firm)|mpile)|eil|lear(?:Timeout|Interval)?|a(?:ptureEvents|ll)|reate(?:StyleSheet|Popup|EventObject))|t(?:o(?:GMTString|S(?:tring|ource)|U(?:TCString|pperCase)|Lo(?:caleString|werCase))|est|a(?:n|int(?:Enabled)?))|i(?:s(?:NaN|Finite)|ndexOf|talics)|d(?:isableExternalCapture|ump|etachEvent)|u(?:n(?:shift|taint|escape|watch)|pdateCommands)|j(?:oin|avaEnabled)|p(?:o(?:p|w)|ush|lugins.refresh|a(?:ddings|rse(?:Int|Float)?)|r(?:int|ompt|eference))|e(?:scape|nableExternalCapture|val|lementFromPoint|x(?:p|ec(?:Script|Command)?))|valueOf|UTC|queryCommand(?:State|Indeterm|Enabled|Value)|f(?:i(?:nd|le(?:ModifiedDate|Size|CreatedDate|UpdatedDate)|xed)|o(?:nt(?:size|color)|rward)|loor|romCharCode)|watch|l(?:ink|o(?:ad|g)|astIndexOf)|a(?:sin|nchor|cos|t(?:tachEvent|ob|an(?:2)?)|pply|lert|b(?:s|ort))|r(?:ou(?:nd|teEvents)|e(?:size(?:By|To)|calc|turnValue|place|verse|l(?:oad|ease(?:Capture|Events)))|andom)|g(?:o|et(?:ResponseHeader|M(?:i(?:nutes|lliseconds)|onth)|Se(?:conds|lection)|Hours|Year|Time(?:zoneOffset)?|Da(?:y|te)|UTC(?:M(?:i(?:nutes|lliseconds)|onth)|Seconds|Hours|Da(?:y|te)|FullYear)|FullYear|A(?:ttention|llResponseHeaders)))|m(?:in|ove(?:B(?:y|elow)|To(?:Absolute)?|Above)|ergeAttributes|a(?:tch|rgins|x))|b(?:toa|ig|o(?:ld|rderWidths)|link|ack))\b(?=\()/
             }, {
                 token : ["punctuation.operator", "support.function.dom"],
-                regex : /(\.)(s(?:ub(?:stringData|mit)|plitText|e(?:t(?:NamedItem|Attribute(?:Node)?)|lect))|has(?:ChildNodes|Feature)|namedItem|c(?:l(?:ick|o(?:se|neNode))|reate(?:C(?:omment|DATASection|aption)|T(?:Head|extNode|Foot)|DocumentFragment|ProcessingInstruction|E(?:ntityReference|lement)|Attribute))|tabIndex|i(?:nsert(?:Row|Before|Cell|Data)|tem)|open|delete(?:Row|C(?:ell|aption)|T(?:Head|Foot)|Data)|focus|write(?:ln)?|a(?:dd|ppend(?:Child|Data))|re(?:set|place(?:Child|Data)|move(?:NamedItem|Child|Attribute(?:Node)?)?)|get(?:NamedItem|Element(?:sBy(?:Name|TagName)|ById)|Attribute(?:Node)?)|blur)\b(?=\()/
+                regex : /(\.)(s(?:ub(?:stringData|mit)|plitText|e(?:t(?:NamedItem|Attribute(?:Node)?)|lect))|has(?:ChildNodes|Feature)|namedItem|c(?:l(?:ick|o(?:se|neNode))|reate(?:C(?:omment|DATASection|aption)|T(?:Head|extNode|Foot)|DocumentFragment|ProcessingInstruction|E(?:ntityReference|lement)|Attribute))|tabIndex|i(?:nsert(?:Row|Before|Cell|Data)|tem)|open|delete(?:Row|C(?:ell|aption)|T(?:Head|Foot)|Data)|focus|write(?:ln)?|a(?:dd|ppend(?:Child|Data))|re(?:set|place(?:Child|Data)|move(?:NamedItem|Child|Attribute(?:Node)?)?)|get(?:NamedItem|Element(?:sBy(?:Name|TagName|ClassName)|ById)|Attribute(?:Node)?)|blur)\b(?=\()/
             }, {
                 token : ["punctuation.operator", "support.constant"],
                 regex : /(\.)(s(?:ystemLanguage|cr(?:ipts|ollbars|een(?:X|Y|Top|Left))|t(?:yle(?:Sheets)?|atus(?:Text|bar)?)|ibling(?:Below|Above)|ource|uffixes|e(?:curity(?:Policy)?|l(?:ection|f)))|h(?:istory|ost(?:name)?|as(?:h|Focus))|y|X(?:MLDocument|SLDocument)|n(?:ext|ame(?:space(?:s|URI)|Prop))|M(?:IN_VALUE|AX_VALUE)|c(?:haracterSet|o(?:n(?:structor|trollers)|okieEnabled|lorDepth|mp(?:onents|lete))|urrent|puClass|l(?:i(?:p(?:boardData)?|entInformation)|osed|asses)|alle(?:e|r)|rypto)|t(?:o(?:olbar|p)|ext(?:Transform|Indent|Decoration|Align)|ags)|SQRT(?:1_2|2)|i(?:n(?:ner(?:Height|Width)|put)|ds|gnoreCase)|zIndex|o(?:scpu|n(?:readystatechange|Line)|uter(?:Height|Width)|p(?:sProfile|ener)|ffscreenBuffering)|NEGATIVE_INFINITY|d(?:i(?:splay|alog(?:Height|Top|Width|Left|Arguments)|rectories)|e(?:scription|fault(?:Status|Ch(?:ecked|arset)|View)))|u(?:ser(?:Profile|Language|Agent)|n(?:iqueID|defined)|pdateInterval)|_content|p(?:ixelDepth|ort|ersonalbar|kcs11|l(?:ugins|atform)|a(?:thname|dding(?:Right|Bottom|Top|Left)|rent(?:Window|Layer)?|ge(?:X(?:Offset)?|Y(?:Offset)?))|r(?:o(?:to(?:col|type)|duct(?:Sub)?|mpter)|e(?:vious|fix)))|e(?:n(?:coding|abledPlugin)|x(?:ternal|pando)|mbeds)|v(?:isibility|endor(?:Sub)?|Linkcolor)|URLUnencoded|P(?:I|OSITIVE_INFINITY)|f(?:ilename|o(?:nt(?:Size|Family|Weight)|rmName)|rame(?:s|Element)|gColor)|E|whiteSpace|l(?:i(?:stStyleType|n(?:eHeight|kColor))|o(?:ca(?:tion(?:bar)?|lName)|wsrc)|e(?:ngth|ft(?:Context)?)|a(?:st(?:M(?:odified|atch)|Index|Paren)|yer(?:s|X)|nguage))|a(?:pp(?:MinorVersion|Name|Co(?:deName|re)|Version)|vail(?:Height|Top|Width|Left)|ll|r(?:ity|guments)|Linkcolor|bove)|r(?:ight(?:Context)?|e(?:sponse(?:XML|Text)|adyState))|global|x|m(?:imeTypes|ultiline|enubar|argin(?:Right|Bottom|Top|Left))|L(?:N(?:10|2)|OG(?:10E|2E))|b(?:o(?:ttom|rder(?:Width|RightWidth|BottomWidth|Style|Color|TopWidth|LeftWidth))|ufferDepth|elow|ackground(?:Color|Image)))\b/
diff --git a/lib/ace/mode/javascript_worker.js b/lib/ace/mode/javascript_worker.js
index e6503efc..fd5788e7 100644
--- a/lib/ace/mode/javascript_worker.js
+++ b/lib/ace/mode/javascript_worker.js
@@ -116,12 +116,10 @@ oop.inherits(JavaScriptWorker, Mirror);
     this.onUpdate = function() {
         var value = this.doc.getValue();
         value = value.replace(/^#!.*\n/, "\n");
-        if (!value) {
-            this.sender.emit("jslint", []);
-            return;
-        }
-        var errors = [];
+        if (!value)
+            return this.sender.emit("annotate", []);
 
+        var errors = [];
         // jshint reports many false errors
         // report them as error only if code is actually invalid
         var maxErrorLevel = this.isValidJS(value) ? "warning" : "error";
@@ -179,7 +177,7 @@ oop.inherits(JavaScriptWorker, Mirror);
         }
         // console.log("lint time: " + (new Date() - start));
 
-        this.sender.emit("jslint", errors);
+        this.sender.emit("annotate", errors);
     };
 
 }).call(JavaScriptWorker.prototype);
diff --git a/lib/ace/mode/json.js b/lib/ace/mode/json.js
index 24a43d0f..cfb00dab 100644
--- a/lib/ace/mode/json.js
+++ b/lib/ace/mode/json.js
@@ -74,11 +74,11 @@ oop.inherits(Mode, TextMode);
         var worker = new WorkerClient(["ace"], "ace/mode/json_worker", "JsonWorker");
         worker.attachToDocument(session.getDocument());
 
-        worker.on("error", function(e) {
-            session.setAnnotations([e.data]);
+        worker.on("annotate", function(e) {
+            session.setAnnotations(e.data);
         });
 
-        worker.on("ok", function() {
+        worker.on("terminate", function() {
             session.clearAnnotations();
         });
 
diff --git a/lib/ace/mode/json_worker.js b/lib/ace/mode/json_worker.js
index 9c233d77..168278ba 100644
--- a/lib/ace/mode/json_worker.js
+++ b/lib/ace/mode/json_worker.js
@@ -46,20 +46,20 @@ oop.inherits(JsonWorker, Mirror);
 
     this.onUpdate = function() {
         var value = this.doc.getValue();
-
+        var errors = [];
         try {
-            var result = parse(value);
+            if (value)
+                parse(value);
         } catch (e) {
             var pos = this.doc.indexToPosition(e.at-1);
-            this.sender.emit("error", {
+            errors.push({
                 row: pos.row,
                 column: pos.column,
                 text: e.message,
                 type: "error"
             });
-            return;
         }
-        this.sender.emit("ok");
+        this.sender.emit("annotate", errors);
     };
 
 }).call(JsonWorker.prototype);
diff --git a/lib/ace/mode/json_worker_test.js b/lib/ace/mode/json_worker_test.js
index b4a8610d..7113342d 100644
--- a/lib/ace/mode/json_worker_test.js
+++ b/lib/ace/mode/json_worker_test.js
@@ -58,7 +58,7 @@ module.exports = {
         worker.setValue("{}");
         worker.deferredUpdate.call();
 
-        assert.equal(this.sender.events[0][0], "ok");
+        assert.equal(this.sender.events[0][1].length, 0);
     },
 
     "test check for syntax error": function() {
@@ -71,11 +71,12 @@ module.exports = {
         worker.deferredUpdate.call();
 
         var event = this.sender.events[0];
-        assert.equal(event[0], "error");
-        assert.equal(event[1].type, "error");
-        assert.equal(event[1].text, "Bad string");
-        assert.equal(event[1].row, 1);
-        assert.equal(event[1].column, 0);
+        assert.equal(event[0], "annotate");
+        assert.equal(event[1].length, 1);
+        assert.equal(event[1][0].type, "error");
+        assert.equal(event[1][0].text, "Bad string");
+        assert.equal(event[1][0].row, 1);
+        assert.equal(event[1][0].column, 0);
 
     },
 
@@ -85,11 +86,11 @@ module.exports = {
         worker.deferredUpdate.call();
 
         var event = this.sender.events[0];
-        assert.equal(event[0], "error");
-        assert.equal(event[1].type, "error");
-        assert.equal(event[1].text, "Unexpected 'x'");
-        assert.equal(event[1].row, 0);
-        assert.equal(event[1].column, 0);
+        assert.equal(event[0], "annotate");
+        assert.equal(event[1][0].type, "error");
+        assert.equal(event[1][0].text, "Unexpected 'x'");
+        assert.equal(event[1][0].row, 0);
+        assert.equal(event[1][0].column, 0);
     }
 
 };
diff --git a/lib/ace/mode/jsoniq.js b/lib/ace/mode/jsoniq.js
index 6f10d2d3..64dc9541 100644
--- a/lib/ace/mode/jsoniq.js
+++ b/lib/ace/mode/jsoniq.js
@@ -39,7 +39,6 @@ var Range = require("../range").Range;
 var XQueryBehaviour = require("./behaviour/xquery").XQueryBehaviour;
 var CStyleFoldMode = require("./folding/cstyle").FoldMode;
 var Anchor = require("../anchor").Anchor;
-var LanguageTools = require("../ext/language_tools");
 
 var Mode = function() {
     this.$tokenizer   = new JSONiqLexer();
@@ -52,14 +51,16 @@ oop.inherits(Mode, TextMode);
 
 (function() {
 
-    LanguageTools.addCompleter({
+    this.completer = {
         getCompletions: function(editor, session, pos, prefix, callback) {
+            if (!session.$worker)
+                return callback();
             session.$worker.emit("complete", { data: { pos: pos, prefix: prefix } });
             session.$worker.on("complete", function(e){
                 callback(null, e.data);
             });
         }
-    });
+    };
 
     this.getNextLineIndent = function(state, line, tab) {
         var indent = this.$getIndent(line);
diff --git a/lib/ace/mode/latex_highlight_rules.js b/lib/ace/mode/latex_highlight_rules.js
index f3238bfb..bf9b9f3b 100644
--- a/lib/ace/mode/latex_highlight_rules.js
+++ b/lib/ace/mode/latex_highlight_rules.js
@@ -19,7 +19,7 @@ var LatexHighlightRules = function() {
         }, {
             // A label
             token : ["keyword","lparen", "variable.parameter", "rparen"],
-            regex : "(\\\\label)(?:({)([^}]*)(}))?"
+            regex : "(\\\\(?:label|v?ref|cite(?:[^{]*)))(?:({)([^}]*)(}))?"
         }, {
             // A block
             token : ["storage.type", "lparen", "variable.parameter", "rparen"],
diff --git a/lib/ace/mode/lean.js b/lib/ace/mode/lean.js
new file mode 100644
index 00000000..e421f2b5
--- /dev/null
+++ b/lib/ace/mode/lean.js
@@ -0,0 +1,101 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var TextMode = require("./text").Mode;
+var leanHighlightRules = require("./lean_highlight_rules").leanHighlightRules;
+var MatchingBraceOutdent = require("./matching_brace_outdent").MatchingBraceOutdent;
+var Range = require("../range").Range;
+// TODO(soonhok): figure out behavior and foldmode
+// var CstyleBehaviour = require("./behaviour/cstyle").CstyleBehaviour;
+// var CStyleFoldMode = require("./folding/cstyle").FoldMode;
+
+var Mode = function() {
+    this.HighlightRules = leanHighlightRules;
+
+    this.$outdent = new MatchingBraceOutdent();
+    // this.$behaviour = new CstyleBehaviour();
+    // this.foldingRules = new CStyleFoldMode();
+};
+oop.inherits(Mode, TextMode);
+
+(function() {
+
+    this.lineCommentStart = "--";
+    this.blockComment = {start: "/-", end: "-/"};
+
+    this.getNextLineIndent = function(state, line, tab) {
+        var indent = this.$getIndent(line);
+
+        var tokenizedLine = this.getTokenizer().getLineTokens(line, state);
+        var tokens = tokenizedLine.tokens;
+        var endState = tokenizedLine.state;
+
+        if (tokens.length && tokens[tokens.length-1].type == "comment") {
+            return indent;
+        }
+
+        if (state == "start") {
+            var match = line.match(/^.*[\{\(\[]\s*$/);
+            if (match) {
+                indent += tab;
+            }
+        } else if (state == "doc-start") {
+            if (endState == "start") {
+                return "";
+            }
+            var match = line.match(/^\s*(\/?)\*/);
+            if (match) {
+                if (match[1]) {
+                    indent += " ";
+                }
+                indent += "- ";
+            }
+        }
+
+        return indent;
+    };
+
+    this.checkOutdent = function(state, line, input) {
+        return this.$outdent.checkOutdent(line, input);
+    };
+
+    this.autoOutdent = function(state, doc, row) {
+        this.$outdent.autoOutdent(doc, row);
+    };
+
+    this.$id = "ace/mode/lean";
+}).call(Mode.prototype);
+
+exports.Mode = Mode;
+});
diff --git a/lib/ace/mode/lean_highlight_rules.js b/lib/ace/mode/lean_highlight_rules.js
new file mode 100644
index 00000000..d4a37d20
--- /dev/null
+++ b/lib/ace/mode/lean_highlight_rules.js
@@ -0,0 +1,156 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var DocCommentHighlightRules = require("./doc_comment_highlight_rules").DocCommentHighlightRules;
+var TextHighlightRules = require("./text_highlight_rules").TextHighlightRules;
+
+var leanHighlightRules = function() {
+
+    var keywordControls = (
+        [ "add_rewrite", "alias", "as", "assume", "attribute",
+          "begin", "by", "calc", "calc_refl", "calc_subst", "calc_trans", "check",
+          "classes", "coercions", "conjecture", "constants", "context",
+          "corollary", "else", "end", "environment", "eval", "example",
+          "exists", "exit", "export", "exposing", "extends", "fields", "find_decl",
+          "forall", "from", "fun", "have", "help", "hiding", "if",
+          "import", "in", "infix", "infixl", "infixr", "instances",
+          "let", "local", "match", "namespace", "notation", "obtain", "obtains",
+          "omit", "opaque", "open", "options", "parameter", "parameters", "postfix",
+          "precedence", "prefix", "premise", "premises", "print", "private", "proof",
+          "protected", "qed", "raw", "renaming", "section", "set_option",
+          "show", "tactic_hint", "take", "then", "universe",
+          "universes", "using", "variable", "variables", "with"].join("|")
+    );
+
+    var nameProviders = (
+        ["inductive", "structure", "record", "theorem", "axiom",
+         "axioms", "lemma", "hypothesis", "definition", "constant"].join("|")
+    );
+
+    var storageType = (
+        ["Prop", "Type", "Type'", "Type₊", "Type₁", "Type₂", "Type₃"].join("|")
+    );
+
+    var storageModifiers = (
+        "\\[(" +
+            ["abbreviations", "all-transparent", "begin-end-hints", "class", "classes", "coercion",
+             "coercions", "declarations", "decls", "instance", "irreducible",
+             "multiple-instances", "notation", "notations", "parsing-only", "persistent",
+             "reduce-hints", "reducible", "tactic-hints", "visible", "wf", "whnf"
+            ].join("|") +
+            ")\\]"
+    );
+
+    var keywordOperators = (
+        [].join("|")
+    );
+
+    var keywordMapper = this.$keywords = this.createKeywordMapper({
+        "keyword.control" : keywordControls,
+        "storage.type" : storageType,
+        "keyword.operator" : keywordOperators,
+        "variable.language": "sorry",
+    }, "identifier");
+
+    var identifierRe = "[A-Za-z_\u03b1-\u03ba\u03bc-\u03fb\u1f00-\u1ffe\u2100-\u214f][A-Za-z0-9_'\u03b1-\u03ba\u03bc-\u03fb\u1f00-\u1ffe\u2070-\u2079\u207f-\u2089\u2090-\u209c\u2100-\u214f]*";
+    var operatorRe = new RegExp(["#", "@", "->", "∼", "↔", "/", "==", "=", ":=", "<->",
+                                 "/\\", "\\/", "∧", "∨", "≠", "<", ">", "≤", "≥", "¬",
+                                 "<=", ">=", "⁻¹", "⬝", "▸", "\\+", "\\*", "-", "/",
+                                 "λ", "→", "∃", "∀", ":="].join("|"));
+    // regexp must not have capturing parentheses. Use (?:) instead.
+    // regexps are ordered -> the first match is used
+
+    this.$rules = {
+        "start" : [
+            {
+                token : "comment", // single line comment "--"
+                regex : "--.*$"
+            },
+            DocCommentHighlightRules.getStartRule("doc-start"),
+            {
+                token : "comment", // multi line comment "/-"
+                regex : "\\/-",
+                next : "comment"
+            }, {
+                stateName: "qqstring",
+                token : "string.start", regex : '"', next : [
+                    {token : "string.end", regex : '"', next : "start"},
+                    {token : "constant.language.escape", regex : /\\[n"\\]/},
+                    {defaultToken: "string"}
+                ]
+            }, {
+                token : "keyword.control", regex : nameProviders, next : [
+                    {token : "variable.language", regex : identifierRe, next : "start"} ]
+            }, {
+                token : "constant.numeric", // hex
+                regex : "0[xX][0-9a-fA-F]+(L|l|UL|ul|u|U|F|f|ll|LL|ull|ULL)?\\b"
+            }, {
+                token : "constant.numeric", // float
+                regex : "[+-]?\\d+(?:(?:\\.\\d*)?(?:[eE][+-]?\\d+)?)?(L|l|UL|ul|u|U|F|f|ll|LL|ull|ULL)?\\b"
+            }, {
+                token : "storage.modifier",
+                regex : storageModifiers
+            }, {
+                token : keywordMapper,
+                regex : identifierRe
+            }, {
+                token : "operator",
+                regex : operatorRe
+            }, {
+              token : "punctuation.operator",
+              regex : "\\?|\\:|\\,|\\;|\\."
+            }, {
+                token : "paren.lparen",
+                regex : "[[({]"
+            }, {
+                token : "paren.rparen",
+                regex : "[\\])}]"
+            }, {
+                token : "text",
+                regex : "\\s+"
+            }
+        ],
+        "comment" : [ {token: "comment", regex: "-/", next: "start"},
+                      {defaultToken: "comment"} ]
+    };
+
+    this.embedRules(DocCommentHighlightRules, "doc-",
+        [ DocCommentHighlightRules.getEndRule("start") ]);
+    this.normalizeRules();
+};
+
+oop.inherits(leanHighlightRules, TextHighlightRules);
+
+exports.leanHighlightRules = leanHighlightRules;
+});
diff --git a/lib/ace/mode/less_highlight_rules.js b/lib/ace/mode/less_highlight_rules.js
index d39bdeae..a0162765 100644
--- a/lib/ace/mode/less_highlight_rules.js
+++ b/lib/ace/mode/less_highlight_rules.js
@@ -231,7 +231,7 @@ var LessHighlightRules = function() {
                 regex: "\\.[a-z0-9-_]+"
             }, {
                 token: "variable.language",
-                regex: ":[a-z0-9-_]+"
+                regex: ":[a-z_][a-z0-9-_]*"
             }, {
                 token: "constant",
                 regex: "[a-z0-9-_]+"
diff --git a/lib/ace/mode/livescript.js b/lib/ace/mode/livescript.js
index d692a6d3..d8330791 100644
--- a/lib/ace/mode/livescript.js
+++ b/lib/ace/mode/livescript.js
@@ -52,8 +52,7 @@ define(function(require, exports, module){
   }(require('../mode/text').Mode));
   keywordend = '(?![$\\w]|-[A-Za-z]|\\s*:(?![:=]))';
   stringfill = {
-    token: 'string',
-    regex: '.+'
+    defaultToken: 'string'
   };
   LiveScriptMode.Rules = {
     start: [
@@ -146,7 +145,7 @@ define(function(require, exports, module){
         next: 'key'
       }, {
         token: 'keyword.operator',
-        regex: '\\S+'
+        regex: '[\\^!|&%+\\-]+'
       }, {
         token: 'text',
         regex: '\\s+'
@@ -164,8 +163,7 @@ define(function(require, exports, module){
         token: 'comment.regex',
         regex: '\\s+(?:#.*)?'
       }, {
-        token: 'string.regex',
-        regex: '\\S+'
+        defaultToken: 'string.regex'
       }
     ],
     key: [
@@ -178,7 +176,7 @@ define(function(require, exports, module){
         next: 'start'
       }, {
         token: 'text',
-        regex: '.',
+        regex: '',
         next: 'start'
       }
     ],
@@ -188,8 +186,7 @@ define(function(require, exports, module){
         regex: '.*?\\*/',
         next: 'start'
       }, {
-        token: 'comment.doc',
-        regex: '.+'
+        defaultToken: 'comment.doc'
       }
     ],
     qdoc: [
diff --git a/lib/ace/mode/lua.js b/lib/ace/mode/lua.js
index a8d1f08b..75e91982 100644
--- a/lib/ace/mode/lua.js
+++ b/lib/ace/mode/lua.js
@@ -148,11 +148,11 @@ oop.inherits(Mode, TextMode);
         var worker = new WorkerClient(["ace"], "ace/mode/lua_worker", "Worker");
         worker.attachToDocument(session.getDocument());
         
-        worker.on("error", function(e) {
-            session.setAnnotations([e.data]);
+        worker.on("annotate", function(e) {
+            session.setAnnotations(e.data);
         });
         
-        worker.on("ok", function(e) {
+        worker.on("terminate", function() {
             session.clearAnnotations();
         });
         
diff --git a/lib/ace/mode/lua_worker.js b/lib/ace/mode/lua_worker.js
index 9c08f614..dcff9514 100644
--- a/lib/ace/mode/lua_worker.js
+++ b/lib/ace/mode/lua_worker.js
@@ -46,24 +46,23 @@ oop.inherits(Worker, Mirror);
 
     this.onUpdate = function() {
         var value = this.doc.getValue();
-
-		// var t=Date.now()
+        var errors = [];
+        
+        // var t=Date.now()
         try {
             luaparse.parse(value);
         } catch(e) {
             if (e instanceof SyntaxError) {
-                this.sender.emit("error", {
-					row: e.line - 1,
-					column: e.column,
-					text: e.message,
-					type: "error"
-				});
+                errors.push({
+                    row: e.line - 1,
+                    column: e.column,
+                    text: e.message,
+                    type: "error"
+                });
             }
-			// console.log( t-Date.now())
-            return;
         }
-		// console.log( t-Date.now())
-        this.sender.emit("ok");
+        // console.log( t-Date.now())
+        this.sender.emit("annotate", errors);
     };
 
 }).call(Worker.prototype);
diff --git a/lib/ace/mode/mask.js b/lib/ace/mode/mask.js
new file mode 100644
index 00000000..ee94c82f
--- /dev/null
+++ b/lib/ace/mode/mask.js
@@ -0,0 +1,84 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2014, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var TextMode = require("./text").Mode;
+var MaskHighlightRules = require("./mask_highlight_rules").MaskHighlightRules;
+var MatchingBraceOutdent = require("./matching_brace_outdent").MatchingBraceOutdent;
+var CssBehaviour = require("./behaviour/css").CssBehaviour;
+var CStyleFoldMode = require("./folding/cstyle").FoldMode;
+
+var Mode = function() {
+    this.HighlightRules = MaskHighlightRules;
+    this.$outdent = new MatchingBraceOutdent();
+    this.$behaviour = new CssBehaviour();
+    this.foldingRules = new CStyleFoldMode();
+};
+oop.inherits(Mode, TextMode);
+
+(function() {
+   
+    this.lineCommentStart = "//";
+    this.blockComment = {start: "/*", end: "*/"};
+
+    this.getNextLineIndent = function(state, line, tab) {
+        var indent = this.$getIndent(line);
+
+        // ignore braces in comments
+        var tokens = this.getTokenizer().getLineTokens(line, state).tokens;
+        if (tokens.length && tokens[tokens.length-1].type == "comment") {
+            return indent;
+        }
+
+        var match = line.match(/^.*\{\s*$/);
+        if (match) {
+            indent += tab;
+        }
+
+        return indent;
+    };
+
+    this.checkOutdent = function(state, line, input) {
+        return this.$outdent.checkOutdent(line, input);
+    };
+
+    this.autoOutdent = function(state, doc, row) {
+        this.$outdent.autoOutdent(doc, row);
+    };
+
+    this.$id = "ace/mode/mask";
+}).call(Mode.prototype);
+
+exports.Mode = Mode;
+
+});
diff --git a/lib/ace/mode/mask_highlight_rules.js b/lib/ace/mode/mask_highlight_rules.js
new file mode 100644
index 00000000..8142ebe0
--- /dev/null
+++ b/lib/ace/mode/mask_highlight_rules.js
@@ -0,0 +1,309 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2014, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+exports.MaskHighlightRules = MaskHighlightRules;
+
+var oop = require("../lib/oop");
+var lang = require("../lib/lang");
+var TextRules   = require("./text_highlight_rules").TextHighlightRules;
+var JSRules     = require("./javascript_highlight_rules").JavaScriptHighlightRules;
+var CssRules    = require("./css_highlight_rules").CssHighlightRules;
+var MDRules     = require("./markdown_highlight_rules").MarkdownHighlightRules;
+var HTMLRules   = require("./html_highlight_rules").HtmlHighlightRules;
+
+var token_TAG       = "keyword.support.constant.language",
+    token_COMPO     = "support.function.markup.bold",
+    token_KEYWORD   = "keyword",
+    token_LANG      = "constant.language",
+    token_UTIL      = "keyword.control.markup.italic",
+    token_ATTR      = "support.variable.class",
+    token_PUNKT     = "keyword.operator",
+    token_ITALIC    = "markup.italic",
+    token_BOLD      = "markup.bold",
+    token_LPARE     = "paren.lparen",
+    token_RPARE     = "paren.rparen";
+
+var const_FUNCTIONS,
+    const_KEYWORDS,
+    const_CONST,
+    const_TAGS;
+(function(){
+    const_FUNCTIONS = lang.arrayToMap(
+        ("log").split("|")
+    );
+    const_CONST = lang.arrayToMap(
+        (":dualbind|:bind|:import|slot|event|style|html|markdown|md").split("|")
+    );
+    const_KEYWORDS = lang.arrayToMap(
+        ("debugger|define|var|if|each|for|of|else|switch|case|with|visible|+if|+each|+for|+switch|+with|+visible|include|import").split("|")
+    );
+    const_TAGS = lang.arrayToMap(
+        ("a|abbr|acronym|address|applet|area|article|aside|audio|b|base|basefont|bdo|" + 
+         "big|blockquote|body|br|button|canvas|caption|center|cite|code|col|colgroup|" + 
+         "command|datalist|dd|del|details|dfn|dir|div|dl|dt|em|embed|fieldset|" + 
+         "figcaption|figure|font|footer|form|frame|frameset|h1|h2|h3|h4|h5|h6|head|" + 
+         "header|hgroup|hr|html|i|iframe|img|input|ins|keygen|kbd|label|legend|li|" + 
+         "link|map|mark|menu|meta|meter|nav|noframes|noscript|object|ol|optgroup|" + 
+         "option|output|p|param|pre|progress|q|rp|rt|ruby|s|samp|script|section|select|" + 
+         "small|source|span|strike|strong|style|sub|summary|sup|table|tbody|td|" + 
+         "textarea|tfoot|th|thead|time|title|tr|tt|u|ul|var|video|wbr|xmp").split("|")
+    );
+}());
+
+function MaskHighlightRules () {
+
+    this.$rules = {
+        "start" : [
+            Token("comment", "\\/\\/.*$"),
+            Token("comment", "\\/\\*", [
+                Token("comment", ".*?\\*\\/", "start"),
+                Token("comment", ".+")
+            ]),
+            
+            Blocks.string("'''"),
+            Blocks.string('"""'),
+            Blocks.string('"'),
+            Blocks.string("'"),
+            
+            Blocks.syntax(/(markdown|md)\b/, "md-multiline", "multiline"),
+            Blocks.syntax(/html\b/, "html-multiline", "multiline"),
+            Blocks.syntax(/(slot|event)\b/, "js-block", "block"),
+            Blocks.syntax(/style\b/, "css-block", "block"),
+            Blocks.syntax(/var\b/, "js-statement", "attr"),
+            
+            Blocks.tag(),
+            
+            Token(token_LPARE, "[[({>]"),
+            Token(token_RPARE, "[\\])};]", "start"),
+            {
+                caseInsensitive: true
+            }
+        ]
+    };
+    var rules = this;
+    
+    addJavaScript("interpolation", /\]/, token_RPARE + "." + token_ITALIC);
+    addJavaScript("statement", /\)|}|;/);
+    addJavaScript("block", /\}/);
+    addCss();
+    addMarkdown();
+    addHtml();
+    
+    function addJavaScript(name, escape, closeType) {
+        var prfx  =  "js-" + name + "-",
+            rootTokens = name === "block" ? ["start"] : ["start", "no_regex"];
+        add(
+            JSRules
+            , prfx
+            , escape
+            , rootTokens
+            , closeType
+        );
+    }
+    function addCss() {
+        add(CssRules, "css-block-", /\}/);
+    }
+    function addMarkdown() {
+        add(MDRules, "md-multiline-", /("""|''')/, []);
+    }
+    function addHtml() {
+        add(HTMLRules, "html-multiline-", /("""|''')/);
+    }
+    function add(Rules, strPrfx, rgxEnd, rootTokens, closeType) {
+        var next = "pop";
+        var tokens = rootTokens || [ "start" ];
+        if (tokens.length === 0) {
+            tokens = null;
+        }
+        if (/block|multiline/.test(strPrfx)) {
+            next = strPrfx + "end";
+            rules.$rules[next] = [
+                Token("empty", "", "start")
+            ];
+        }
+        rules.embedRules(
+            Rules
+            , strPrfx
+            , [ Token(closeType || token_RPARE, rgxEnd, next) ]
+            , tokens
+            , tokens == null ? true : false
+        );
+    }
+
+    this.normalizeRules();
+}
+oop.inherits(MaskHighlightRules, TextRules);
+
+var Blocks = {
+    string: function(str, next){
+        var token = Token(
+            "string.start"
+            , str
+            , [
+                Token(token_LPARE + "." + token_ITALIC, /~\[/, Blocks.interpolation()),
+                Token("string.end", str, "pop"),
+                {
+                    defaultToken: "string"
+                }
+            ]
+            , next
+        );
+        if (str.length === 1){
+            var escaped = Token("string.escape", "\\\\" + str);
+            token.push.unshift(escaped);
+        }
+        return token;
+    },
+    interpolation: function(){
+        return [
+            Token(token_UTIL, /\s*\w*\s*:/),
+            "js-interpolation-start"
+        ];
+    },
+    tagHead: function (rgx) {
+      return Token(token_ATTR, rgx, [
+            Token(token_ATTR, /[\w\-_]+/),
+            Token(token_LPARE + "." + token_ITALIC, /~\[/, Blocks.interpolation()),
+            Blocks.goUp()
+        ]);
+    },
+    tag: function () {
+        return {
+            token: 'tag',
+            onMatch :  function(value) {
+                if (void 0 !== const_KEYWORDS[value])
+                    return token_KEYWORD;
+                if (void 0 !== const_CONST[value])
+                    return token_LANG;
+                if (void 0 !== const_FUNCTIONS[value])
+                    return "support.function";
+                if (void 0 !== const_TAGS[value.toLowerCase()])
+                    return token_TAG;
+                
+                return token_COMPO;
+            },
+            regex : /([@\w\-_:+]+)|((^|\s)(?=\s*(\.|#)))/,
+            push: [
+                Blocks.tagHead(/\./) ,
+                Blocks.tagHead(/\#/) ,
+                Blocks.expression(),
+                Blocks.attribute(),
+                
+                Token(token_LPARE, /[;>{]/, "pop")
+            ]
+        };
+    },
+    syntax: function(rgx, next, type){
+        return {
+            token: token_LANG,
+            regex : rgx,
+            push: ({
+                "attr": [
+                    next + "-start",
+                    Token(token_PUNKT, /;/, "start")
+                ],
+                "multiline": [
+                    Blocks.tagHead(/\./) ,
+                    Blocks.tagHead(/\#/) ,
+                    Blocks.attribute(),
+                    Blocks.expression(),
+                    Token(token_LPARE, /[>\{]/),
+                    Token(token_PUNKT, /;/, "start"),
+                    Token(token_LPARE, /'''|"""/, [ next + "-start" ])
+                ],
+                "block": [
+                    Blocks.tagHead(/\./) ,
+                    Blocks.tagHead(/\#/) ,
+                    Blocks.attribute(),
+                    Blocks.expression(),
+                    Token(token_LPARE, /\{/, [ next + "-start" ])
+                ]
+            })[type]
+        };
+    },
+    attribute: function(){
+        return Token(function(value){
+            return  /^x\-/.test(value)
+                ? token_ATTR + "." + token_BOLD
+                : token_ATTR;
+        }, /[\w_-]+/, [
+            Token(token_PUNKT, /\s*=\s*/, [
+                Blocks.string('"'),
+                Blocks.string("'"),
+                Blocks.word(),
+                Blocks.goUp()
+            ]),
+            Blocks.goUp()
+        ]);
+    },
+    expression: function(){
+        return Token(token_LPARE, /\(/, [ "js-statement-start" ]);
+    },
+    word: function(){
+        return Token("string", /[\w-_]+/);
+    },
+    goUp: function(){
+        return Token("text", "", "pop");
+    },
+    goStart: function(){
+        return Token("text", "", "start");
+    }
+};
+
+
+function Token(token, rgx, mix) {
+    var push, next, onMatch;
+    if (arguments.length === 4) {
+        push = mix;
+        next = arguments[3];
+    }
+    else if (typeof mix === "string") {
+        next = mix;
+    }
+    else {
+        push = mix;
+    }
+    if (typeof token === "function") {
+        onMatch = token;
+        token   = "empty";
+    }
+    return {
+        token: token,
+        regex: rgx,
+        push: push,
+        next: next,
+        onMatch: onMatch
+    };
+}
+
+});
diff --git a/lib/ace/mode/nim.js b/lib/ace/mode/nim.js
new file mode 100644
index 00000000..cbf48ef2
--- /dev/null
+++ b/lib/ace/mode/nim.js
@@ -0,0 +1,113 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var TextMode = require("./text").Mode;
+var NimHighlightRules = require("./nim_highlight_rules").NimHighlightRules;
+var NimFoldMode = require("./folding/pythonic").FoldMode;
+var Range = require("../range").Range;
+
+var Mode = function() {
+    this.HighlightRules = NimHighlightRules;
+    this.foldingRules = new NimFoldMode("\\:|=");
+};
+oop.inherits(Mode, TextMode);
+
+(function() {
+
+    this.lineCommentStart = "#";
+
+    this.getNextLineIndent = function(state, line, tab) {
+        var indent = this.$getIndent(line);
+
+        var tokenizedLine = this.getTokenizer().getLineTokens(line, state);
+        var tokens = tokenizedLine.tokens;
+
+        if (tokens.length && tokens[tokens.length-1].type == "comment") {
+            return indent;
+        }
+
+        if (state == "start") {
+            var match = line.match(/^.*[\{\(\[\:=]\s*$/);
+            if (match) {
+                indent += tab;
+            }
+        }
+
+        return indent;
+    };
+
+    var outdents = {
+        "discard": 1,
+        "return": 1,
+        "raise": 1,
+        "break": 1,
+        "continue": 1
+    };
+    
+    this.checkOutdent = function(state, line, input) {
+        if (input !== "\r\n" && input !== "\r" && input !== "\n")
+            return false;
+
+        var tokens = this.getTokenizer().getLineTokens(line.trim(), state).tokens;
+        
+        if (!tokens)
+            return false;
+        
+        // ignore trailing comments
+        do {
+            var last = tokens.pop();
+        } while (last && (last.type == "comment" || (last.type == "text" && last.value.match(/^\s+$/))));
+        
+        if (!last)
+            return false;
+        
+        return (last.type == "keyword" && outdents[last.value]);
+    };
+
+    this.autoOutdent = function(state, doc, row) {
+        // outdenting in python is slightly different because it always applies
+        // to the next line and only of a new line is inserted
+        
+        row += 1;
+        var indent = this.$getIndent(doc.getLine(row));
+        var tab = doc.getTabString();
+        if (indent.slice(-tab.length) == tab)
+            doc.remove(new Range(row, indent.length-tab.length, row, indent.length));
+    };
+
+    this.$id = "ace/mode/nim";
+}).call(Mode.prototype);
+
+exports.Mode = Mode;
+});
diff --git a/lib/ace/mode/nim_highlight_rules.js b/lib/ace/mode/nim_highlight_rules.js
new file mode 100644
index 00000000..e762a636
--- /dev/null
+++ b/lib/ace/mode/nim_highlight_rules.js
@@ -0,0 +1,238 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+/*
+ * TODO: nim delimiters
+ */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var TextHighlightRules = require("./text_highlight_rules").TextHighlightRules;
+var num_suffix = "(\'[Ff]32|\'[Ff]64|\'[IiUu]8|\'[IiUu]16|\'[IiUu]32|\'[IiUu]64)";
+
+var NimHighlightRules = function() {
+
+    var keywords = (
+        "addr|and|as|asm|atomic|bind|block|break|case|cast|const|continue|" +
+        "converter|defer|discard|distinct|div|do|elif|else|end|enum|except|" +
+        "export|finally|for|from|func|generic|if|import|in|include|interface|" +
+        "is|isnot|iterator|let|macro|method|mixin|mod|nil|not|notin|object|of|" +
+        "or|out|proc|ptr|raise|ref|return|shl|shr|static|template|try|tuple|" +
+        "type|using|var|when|while|with|without|xor|yield"
+    );
+
+    var builtinConstants = (
+        "true|false|nil|NotImplemented|Ellipsis"
+    );
+
+    var storageType = (
+        "string|seq|array|expr|stmt|typed|untyped|any|auto|bool|cdouble|cfloat|"+
+        "cchar|clongdouble|clong|clonglong|cshort|csize|cstring|cstringarray|"+
+        "culong|culonglong|cushort|guarded|natural|openarray|ordinal|pointer|"+
+        "range|set|shared|static|typedesc|varargs|void"
+    );
+
+    var builtinFunctions = (
+        "defined|declared|declaredInScope|echo|$"
+    );
+
+    //var futureReserved = "";
+    var keywordMapper = this.createKeywordMapper({
+        "invalid.deprecated": "debugger",
+        "support.function": builtinFunctions,
+        //"invalid.illegal": futureReserved,
+        "constant.language": builtinConstants,
+        "storage.type" : storageType,
+        "keyword": keywords
+    }, "identifier");
+
+    var strPre = "(?:r|R)?";
+
+    var decimalInteger = "(?:(?:[1-9]\\d*)|(?:0))";
+    var octInteger = "(?:0[o]?[0-7]+)";
+    var hexInteger = "(?:0[xX][\\dA-Fa-f]+)";
+    var binInteger = "(?:0[bB][01]+)";
+    var integer = "(?:" + decimalInteger + "|" + octInteger + "|" + hexInteger + "|" + binInteger + ")";
+
+    var exponent = "(?:[eE][+-]?\\d+)";
+    var fraction = "(?:\\.\\d+)";
+    var intPart = "(?:\\d+)";
+    var pointFloat = "(?:(?:" + intPart + "?" + fraction + ")|(?:" + intPart + "\\.))";
+    var exponentFloat = "(?:(?:" + pointFloat + "|" +  intPart + ")" + exponent + ")";
+    var floatNumber = "(?:" + exponentFloat + "|" + pointFloat + ")";
+
+    var stringEscape =  "\\\\(x[0-9A-Fa-f]{2}|[0-7]{3}|[\\\\abfnrtv'\"]|U[0-9A-Fa-f]{8}|u[0-9A-Fa-f]{4})";
+
+    this.$rules = {
+        "start" : [ {
+            token : "comment",
+            regex : "#.*$"
+        }, {
+            token : "keyword",
+            regex : "(proc|method|temdplate|macro|macromethod|converter|func|iterator) ",
+            next  : "qproc_name"
+        }, {
+            token : "storage.type",
+            regex : "(c|cu|u)?int(8|16|32|64)?",
+        }, {
+            token : "storage.type",
+            regex : "(c|cu|u|cs)?char",
+        }, {
+            token : "storage.type",
+            regex : "float(32|64)?",
+        }, {
+            token : "docstring",
+            regex : "##.*$"
+        }, {
+            token : "string",           // multi line """ string start
+            regex : strPre + '"{3}',
+            next : "qqstring3"
+        }, {
+            token : "string",           // " string
+            regex : strPre + '"(?=.)',
+            next : "qqstring"
+        }, {
+            token : "string",           // multi line ''' string start
+            regex : strPre + "'{3}",
+            next : "qstring3"
+        }, {
+            token : "backtick",           // ` string
+            regex : strPre + "`(?=.)",
+            next : "qxstring"
+        }, {
+            token : "string",           // ' string
+            regex : strPre + "'(?=.)",
+            next : "qstring"
+        }, {
+            token : "constant.numeric", // imaginary
+            regex : "(?:" + floatNumber + "|\\d+)[jJ]\\b"
+        }, {
+            token : "constant.numeric", // float
+            regex : floatNumber
+        }, {
+            token : "constant.numeric", // long integer
+            regex : integer + "[lL]\\b"
+        }, {
+            token : "constant.numeric", // integer
+            regex : integer + "\\b"
+        }, {
+            token : keywordMapper,
+            regex : "[a-zA-Z_$][a-zA-Z0-9_$]*\\b"
+        }, {
+            token : "keyword.operator",
+            regex : "\\+|\\-|\\*|\\*\\*|\\/|\\/\\/|%|<<|>>|&|\\||\\^|~|<|>|<=|=>|==|!=|<>|="
+        }, {
+            token : "paren.lparen",
+            regex : "[\\[\\(\\{]"
+        }, {
+            token : "paren.rparen",
+            regex : "[\\]\\)\\}]"
+        }, {
+            token : "text",
+            regex : "\\s+"
+        } ],
+        "qqstring3" : [ {
+            token : "constant.language.escape",
+            regex : stringEscape
+        }, {
+            token : "string", // multi line """ string end
+            regex : '"{3}',
+            next : "start"
+        }, {
+            defaultToken : "string"
+        } ],
+        "qstring3" : [ {
+            token : "constant.language.escape",
+            regex : stringEscape
+        }, {
+            token : "string",  // multi line ''' string end
+            regex : "'{3}",
+            next : "start"
+        }, {
+            defaultToken : "string"
+        } ],
+        "qqstring" : [{
+            token : "constant.language.escape",
+            regex : stringEscape
+        }, {
+            token : "string",
+            regex : "\\\\$",
+            next  : "qqstring"
+        }, {
+            token : "string",
+            regex : '"|$',
+            next  : "start"
+        }, {
+            defaultToken: "string"
+        }],
+        "qstring" : [{
+            token : "constant.language.escape",
+            regex : stringEscape
+        }, {
+            token : "string",
+            regex : "\\\\$",
+            next  : "qstring"
+        }, {
+            token : "string",
+            regex : "'|$",
+            next  : "start"
+        }, {
+            defaultToken: "string"
+        }],
+        "qxstring" : [{
+            token : "constant.language.escape",
+            regex : stringEscape
+        }, {
+            token : "backtick",
+            regex : "\\\\$",
+            next  : "qxstring"
+        }, {
+            token : "backtick",
+            regex : "`|$",
+            next  : "start"
+        }, {
+            defaultToken: "backtick"
+        }],
+        "qproc_name":[{
+            token : "proc_name",
+            regex : "\\w+",
+        },{
+            token : "start_bracket",
+            regex : "(\\(|=|$)",
+            next : "start"
+        }],
+    };
+};
+
+oop.inherits(NimHighlightRules, TextHighlightRules);
+
+exports.NimHighlightRules = NimHighlightRules;
+});
diff --git a/lib/ace/mode/php.js b/lib/ace/mode/php.js
index beeefda7..39119e22 100644
--- a/lib/ace/mode/php.js
+++ b/lib/ace/mode/php.js
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2010, Ajax.org B.V.
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *     * Redistributions of source code must retain the above copyright
@@ -14,7 +14,7 @@
  *     * Neither the name of Ajax.org B.V. nor the
  *       names of its contributors may be used to endorse or promote products
  *       derived from this software without specific prior written permission.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -41,16 +41,17 @@ var WorkerClient = require("../worker/worker_client").WorkerClient;
 var CstyleBehaviour = require("./behaviour/cstyle").CstyleBehaviour;
 var CStyleFoldMode = require("./folding/cstyle").FoldMode;
 var unicode = require("../unicode");
+var HtmlMode = require("./html").Mode;
+var JavaScriptMode = require("./javascript").Mode;
+var CssMode = require("./css").Mode;
 
-var Mode = function(opts) {
-    this.inlinePhp = opts && opts.inline;
-    var HighlightRules = this.inlinePhp ? PhpLangHighlightRules : PhpHighlightRules;
-    this.HighlightRules = HighlightRules;
+var PhpMode = function(opts) {
+    this.HighlightRules = PhpLangHighlightRules;
     this.$outdent = new MatchingBraceOutdent();
     this.$behaviour = new CstyleBehaviour();
     this.foldingRules = new CStyleFoldMode();
 };
-oop.inherits(Mode, TextMode);
+oop.inherits(PhpMode, TextMode);
 
 (function() {
 
@@ -60,7 +61,7 @@ oop.inherits(Mode, TextMode);
         + unicode.packages.Nd
         + unicode.packages.Pc + "\_]+", "g"
     );
-    
+
     this.nonTokenRe = new RegExp("^(?:[^"
         + unicode.packages.L
         + unicode.packages.Mn + unicode.packages.Mc
@@ -68,7 +69,7 @@ oop.inherits(Mode, TextMode);
         + unicode.packages.Pc + "\_]|\s])+", "g"
     );
 
-       
+
     this.lineCommentStart = ["//", "#"];
     this.blockComment = {start: "/*", end: "*/"};
 
@@ -79,18 +80,17 @@ oop.inherits(Mode, TextMode);
         var tokens = tokenizedLine.tokens;
         var endState = tokenizedLine.state;
 
-
         if (tokens.length && tokens[tokens.length-1].type == "comment") {
             return indent;
         }
 
-        if (state == "php-start") {
+        if (state == "start") {
             var match = line.match(/^.*[\{\(\[\:]\s*$/);
             if (match) {
                 indent += tab;
             }
-        } else if (state == "php-doc-start") {
-            if (endState != "php-doc-start") {
+        } else if (state == "doc-start") {
+            if (endState != "doc-start") {
                 return "";
             }
             var match = line.match(/^\s*(\/?)\*/);
@@ -113,18 +113,41 @@ oop.inherits(Mode, TextMode);
         this.$outdent.autoOutdent(doc, row);
     };
 
+    this.$id = "ace/mode/php-inline";
+}).call(PhpMode.prototype);
+
+var Mode = function(opts) {
+    if (opts && opts.inline) {
+        var mode = new PhpMode();
+        mode.createWorker = this.createWorker;
+        mode.inlinePhp = true;
+        return mode;
+    }
+    HtmlMode.call(this);
+    this.HighlightRules = PhpHighlightRules;
+    this.createModeDelegates({
+        "js-": JavaScriptMode,
+        "css-": CssMode,
+        "php-": PhpMode
+    });
+    this.foldingRules.subModes["php-"] = new CStyleFoldMode();
+};
+oop.inherits(Mode, HtmlMode);
+
+(function() {
+
     this.createWorker = function(session) {
         var worker = new WorkerClient(["ace"], "ace/mode/php_worker", "PhpWorker");
         worker.attachToDocument(session.getDocument());
-        
+
         if (this.inlinePhp)
             worker.call("setOptions", [{inline: true}]);
 
-        worker.on("error", function(e) {
+        worker.on("annotate", function(e) {
             session.setAnnotations(e.data);
         });
 
-        worker.on("ok", function() {
+        worker.on("terminate", function() {
             session.clearAnnotations();
         });
 
diff --git a/lib/ace/mode/php_test.js b/lib/ace/mode/php_test.js
new file mode 100644
index 00000000..9e86a304
--- /dev/null
+++ b/lib/ace/mode/php_test.js
@@ -0,0 +1,65 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+if (typeof process !== "undefined") {
+    require("amd-loader");
+}
+
+define(function(require, exports, module) {
+"use strict";
+
+var EditSession = require("../edit_session").EditSession;
+var Tokenizer = require("../tokenizer").Tokenizer;
+var Mode = require("./php").Mode;
+var assert = require("../test/assertions");
+
+module.exports = {
+    "test: inline mode" : function() {
+        var mode = new Mode();
+        var tokenizer = mode.getTokenizer();
+        var tokens = tokenizer.getLineTokens("'juhu kinners' ?> html   html  =|<<=|>>=|>>>=|<>|<|>|!|&&|\\|\\||\\?\\:|\\*=|%=|\\+=|\\-=|&=|\\^=|\\b(?:in|instanceof|new|delete|typeof|void)"
diff --git a/lib/ace/mode/rust_highlight_rules.js b/lib/ace/mode/rust_highlight_rules.js
index 1a7d38a6..056e7a55 100644
--- a/lib/ace/mode/rust_highlight_rules.js
+++ b/lib/ace/mode/rust_highlight_rules.js
@@ -36,6 +36,7 @@ define(function(require, exports, module) {
 var oop = require("../lib/oop");
 var TextHighlightRules = require("./text_highlight_rules").TextHighlightRules;
 
+var stringEscape = /\\(?:[nrt0'"]|x[\da-fA-F]{2}|u\{[\da-fA-F]{6}\})/.source;
 var RustHighlightRules = function() {
     // regexp must not have capturing parentheses. Use (?:) instead.
     // regexps are ordered -> the first match is used
@@ -44,13 +45,7 @@ var RustHighlightRules = function() {
        [ { token: 'variable.other.source.rust',
            regex: '\'[a-zA-Z_][a-zA-Z0-9_]*[^\\\']' },
          { token: 'string.quoted.single.source.rust',
-           regex: '\'',
-           push: 
-            [ { token: 'string.quoted.single.source.rust',
-                regex: '\'',
-                next: 'pop' },
-              { include: '#rust_escaped_character' },
-              { defaultToken: 'string.quoted.single.source.rust' } ] },
+           regex: "'(?:[^'\\\\]|" + stringEscape + ")'" },
          {
             stateName: "bracketedComment",
             onMatch : function(value, currentState, stack){
@@ -86,16 +81,16 @@ var RustHighlightRules = function() {
             [ { token: 'string.quoted.double.source.rust',
                 regex: '"',
                 next: 'pop' },
-              { include: '#rust_escaped_character' },
+              { token: 'constant.character.escape.source.rust',
+                regex: stringEscape },
               { defaultToken: 'string.quoted.double.source.rust' } ] },
-         { token: [ 'keyword.source.rust', 'meta.function.source.rust',
-              'entity.name.function.source.rust', 'meta.function.source.rust' ],
-           regex: '\\b(fn)(\\s+)([a-zA-Z_][a-zA-Z0-9_][\\w\\:,+ \\\'<>]*)(\\s*\\()' },
+         { token: [ 'keyword.source.rust', 'text', 'entity.name.function.source.rust' ],
+           regex: '\\b(fn)(\\s+)([a-zA-Z_][a-zA-Z0-9_]*)' },
          { token: 'support.constant', regex: '\\b[a-zA-Z_][\\w\\d]*::' },
          { token: 'keyword.source.rust',
-           regex: '\\b(?:as|assert|break|claim|const|copy|Copy|do|drop|else|extern|fail|for|if|impl|in|let|log|loop|match|mod|module|move|mut|Owned|priv|pub|pure|ref|return|unchecked|unsafe|use|while|mod|Send|static|trait|class|struct|enum|type)\\b' },
+           regex: '\\b(?:as|assert|break|claim|const|do|drop|else|extern|fail|for|if|impl|in|let|log|loop|match|mod|module|move|mut|Owned|priv|pub|pure|ref|return|unchecked|unsafe|use|while|mod|Send|static|trait|class|struct|enum|type)\\b' },
          { token: 'storage.type.source.rust',
-           regex: '\\b(?:Self|m32|m64|m128|f80|f16|f128|int|uint|float|char|bool|u8|u16|u32|u64|f32|f64|i8|i16|i32|i64|str|option|either|c_float|c_double|c_void|FILE|fpos_t|DIR|dirent|c_char|c_schar|c_uchar|c_short|c_ushort|c_int|c_uint|c_long|c_ulong|size_t|ptrdiff_t|clock_t|time_t|c_longlong|c_ulonglong|intptr_t|uintptr_t|off_t|dev_t|ino_t|pid_t|mode_t|ssize_t)\\b' },
+           regex: '\\b(?:Self|m32|m64|m128|f80|f16|f128|int|uint|isize|usize|float|char|bool|u8|u16|u32|u64|f32|f64|i8|i16|i32|i64|str|option|either|c_float|c_double|c_void|FILE|fpos_t|DIR|dirent|c_char|c_schar|c_uchar|c_short|c_ushort|c_int|c_uint|c_long|c_ulong|size_t|ptrdiff_t|clock_t|time_t|c_longlong|c_ulonglong|intptr_t|uintptr_t|off_t|dev_t|ino_t|pid_t|mode_t|ssize_t)\\b' },
          { token: 'variable.language.source.rust', regex: '\\bself\\b' },
          { token: 'keyword.operator',
             regex: '!|\\$|\\*|\\-\\-|\\-|\\+\\+|\\+|-->|===|==|=|!=|!==|<=|>=|<<=|>>=|>>>=|<>|<|>|!|&&|\\|\\||\\?\\:|\\*=|/=|%=|\\+=|\\-=|&=|\\^=|,|;' },
@@ -106,11 +101,11 @@ var RustHighlightRules = function() {
          { token: 'meta.preprocessor.source.rust',
            regex: '\\b\\w\\(\\w\\)*!|#\\[[\\w=\\(\\)_]+\\]\\b' },
          { token: 'constant.numeric.integer.source.rust',
-           regex: '\\b(?:[0-9][0-9_]*|[0-9][0-9_]*(?:u|u8|u16|u32|u64)|[0-9][0-9_]*(?:i|i8|i16|i32|i64))\\b' },
+           regex: '\\b(?:[0-9][0-9_]*|[0-9][0-9_]*(?:u|us|u8|u16|u32|u64)|[0-9][0-9_]*(?:i|is|i8|i16|i32|i64))\\b' },
          { token: 'constant.numeric.hex.source.rust',
-           regex: '\\b(?:0x[a-fA-F0-9_]+|0x[a-fA-F0-9_]+(?:u|u8|u16|u32|u64)|0x[a-fA-F0-9_]+(?:i|i8|i16|i32|i64))\\b' },
+           regex: '\\b(?:0x[a-fA-F0-9_]+|0x[a-fA-F0-9_]+(?:u|us|u8|u16|u32|u64)|0x[a-fA-F0-9_]+(?:i|is|i8|i16|i32|i64))\\b' },
          { token: 'constant.numeric.binary.source.rust',
-           regex: '\\b(?:0b[01_]+|0b[01_]+(?:u|u8|u16|u32|u64)|0b[01_]+(?:i|i8|i16|i32|i64))\\b' },
+           regex: '\\b(?:0b[01_]+|0b[01_]+(?:u|us|u8|u16|u32|u64)|0b[01_]+(?:i|is|i8|i16|i32|i64))\\b' },
          { token: 'constant.numeric.float.source.rust',
            regex: '[0-9][0-9_]*(?:f32|f64|f)|[0-9][0-9_]*[eE][+-]=[0-9_]+|[0-9][0-9_]*[eE][+-]=[0-9_]+(?:f32|f64|f)|[0-9][0-9_]*\\.[0-9_]+|[0-9][0-9_]*\\.[0-9_]+(?:f32|f64|f)|[0-9][0-9_]*\\.[0-9_]+%[eE][+-]=[0-9_]+|[0-9][0-9_]*\\.[0-9_]+%[eE][+-]=[0-9_]+(?:f32|f64|f)' },
          { token: 'comment.line.documentation.source.rust',
@@ -127,16 +122,17 @@ var RustHighlightRules = function() {
                 regex: '$',
                 next: 'pop' },
               { defaultToken: 'comment.line.double-dash.source.rust' } ] },
-         { token: 'comment.block.source.rust',
+         { token: 'comment.start.block.source.rust',
            regex: '/\\*',
+           stateName: 'comment',
            push: 
-            [ { token: 'comment.block.source.rust',
+            [ { token: 'comment.start.block.source.rust',
+                regex: '/\\*',
+                push: 'comment' },
+              { token: 'comment.end.block.source.rust',
                 regex: '\\*/',
                 next: 'pop' },
-              { defaultToken: 'comment.block.source.rust' } ] } ],
-      '#rust_escaped_character': 
-       [ { token: 'constant.character.escape.source.rust',
-           regex: '\\\\(?:x[\\da-fA-F]{2}|[0-2][0-7]{,2}|3[0-6][0-7]?|37[0-7]?|[4-7][0-7]?|.)' } ] }
+              { defaultToken: 'comment.block.source.rust' } ] } ] }
     
     this.normalizeRules();
 };
diff --git a/lib/ace/mode/scheme.js b/lib/ace/mode/scheme.js
index aa462a10..2360b3da 100644
--- a/lib/ace/mode/scheme.js
+++ b/lib/ace/mode/scheme.js
@@ -39,15 +39,92 @@ define(function(require, exports, module) {
 var oop = require("../lib/oop");
 var TextMode = require("./text").Mode;
 var SchemeHighlightRules = require("./scheme_highlight_rules").SchemeHighlightRules;
+var MatchingParensOutdent = require("./matching_parens_outdent").MatchingParensOutdent;
 
 var Mode = function() {
     this.HighlightRules = SchemeHighlightRules;
+	this.$outdent = new MatchingParensOutdent();
 };
 oop.inherits(Mode, TextMode);
 
 (function() {
        
     this.lineCommentStart = ";";
+    this.minorIndentFunctions = ["define", "lambda", "define-macro", "define-syntax", "syntax-rules", "define-record-type", "define-structure"];
+
+    this.$toIndent = function(str) {
+        return str.split('').map(function(ch) {
+            if (/\s/.exec(ch)) {
+                return ch;
+            } else {
+                return ' ';
+            }
+        }).join('');
+    };
+
+    this.$calculateIndent = function(line, tab) {
+        var baseIndent = this.$getIndent(line);
+        var delta = 0;
+        var isParen, ch;
+        // Walk back from end of line, find matching braces
+        for (var i = line.length - 1; i >= 0; i--) {
+            ch = line[i];
+            if (ch === '(') {
+                delta--;
+                isParen = true;
+            } else if (ch === '(' || ch === '[' || ch === '{') {
+                delta--;
+                isParen = false;
+            } else if (ch === ')' || ch === ']' || ch === '}') {
+                delta++;
+            }
+            if (delta < 0) {
+                break;
+            }
+        }
+        if (delta < 0 && isParen) {
+            // Were more brackets opened than closed and was a ( left open?
+            i += 1;
+            var iBefore = i;
+            var fn = '';
+            while (true) {
+                ch = line[i];
+                if (ch === ' ' || ch === '\t') {
+                    if(this.minorIndentFunctions.indexOf(fn) !== -1) {
+                        return this.$toIndent(line.substring(0, iBefore - 1) + tab);
+                    } else {
+                        return this.$toIndent(line.substring(0, i + 1));
+                    }
+                } else if (ch === undefined) {
+                    return this.$toIndent(line.substring(0, iBefore - 1) + tab);
+                }
+                fn += line[i];
+                i++;
+            }
+        } else if(delta < 0 && !isParen) {
+            // Were more brackets openend than closed and was it not a (?
+            return this.$toIndent(line.substring(0, i+1));
+        } else if(delta > 0) {
+            // Mere more brackets closed than opened? Outdent.
+            baseIndent = baseIndent.substring(0, baseIndent.length - tab.length);
+            return baseIndent;
+        } else {
+            // Were they nicely matched? Just indent like line before.
+            return baseIndent;
+        }
+    };
+
+    this.getNextLineIndent = function(state, line, tab) {
+        return this.$calculateIndent(line, tab);
+    };
+
+    this.checkOutdent = function(state, line, input) {
+        return this.$outdent.checkOutdent(line, input);
+    };
+
+    this.autoOutdent = function(state, doc, row) {
+        this.$outdent.autoOutdent(doc, row);
+    };
     
     this.$id = "ace/mode/scheme";
 }).call(Mode.prototype);
diff --git a/lib/ace/mode/sh_highlight_rules.js b/lib/ace/mode/sh_highlight_rules.js
index 9dd9aa33..9d32055a 100644
--- a/lib/ace/mode/sh_highlight_rules.js
+++ b/lib/ace/mode/sh_highlight_rules.js
@@ -104,7 +104,7 @@ var ShHighlightRules = function() {
             token : "keyword.operator"
         }, {
             stateName: "heredoc",
-            regex : "(<<)(\\s*)(['\"`]?)([\\w\\-]+)(['\"`]?)",
+            regex : "(<<-?)(\\s*)(['\"`]?)([\\w\\-]+)(['\"`]?)",
             onMatch : function(value, currentState, stack) {
                 var next = value[2] == '-' ? "indentedHeredoc" : "heredoc";
                 var tokens = value.split(this.splitRegex);
diff --git a/lib/ace/mode/soy_template_highlight_rules.js b/lib/ace/mode/soy_template_highlight_rules.js
index 50e3ae48..aa913fac 100644
--- a/lib/ace/mode/soy_template_highlight_rules.js
+++ b/lib/ace/mode/soy_template_highlight_rules.js
@@ -188,7 +188,7 @@ var SoyTemplateHighlightRules = function() {
                  [ 'entity.other.attribute-name.soy',
                    'text',
                    'keyword.operator.soy' ],
-                regex: '\\b([\\w]*)(\\s*)((?::)?)' },
+                regex: '\\b([\\w]+)(\\s*)((?::)?)' },
               { defaultToken: 'meta.tag.param.soy' } ] } ],
       '#primitive': 
        [ { token: 'constant.language.soy',
diff --git a/lib/ace/mode/sql_highlight_rules.js b/lib/ace/mode/sql_highlight_rules.js
index f9ff39d9..31e77c82 100644
--- a/lib/ace/mode/sql_highlight_rules.js
+++ b/lib/ace/mode/sql_highlight_rules.js
@@ -38,21 +38,28 @@ var SqlHighlightRules = function() {
 
     var keywords = (
         "select|insert|update|delete|from|where|and|or|group|by|order|limit|offset|having|as|case|" +
-        "when|else|end|type|left|right|join|on|outer|desc|asc|union"
+        "when|else|end|type|left|right|join|on|outer|desc|asc|union|create|table|primary|key|if|" +
+        "foreign|not|references|default|null|inner|cross|natural|database|drop|grant"
     );
 
     var builtinConstants = (
-        "true|false|null"
+        "true|false"
     );
 
     var builtinFunctions = (
         "count|min|max|avg|sum|rank|now|coalesce"
     );
 
+    var dataTypes = (
+        "int|numeric|decimal|date|varchar|char|bigint|float|double|bit|binary|text|set|timestamp|" +
+        "money|real|number|integer"
+    );
+
     var keywordMapper = this.createKeywordMapper({
         "support.function": builtinFunctions,
         "keyword": keywords,
-        "constant.language": builtinConstants
+        "constant.language": builtinConstants,
+        "storage.type": dataTypes
     }, "identifier", true);
 
     this.$rules = {
diff --git a/lib/ace/keyboard/vim/maps/aliases.js b/lib/ace/mode/sqlserver.js
similarity index 64%
rename from lib/ace/keyboard/vim/maps/aliases.js
rename to lib/ace/mode/sqlserver.js
index 1a5f32f7..5f24730c 100644
--- a/lib/ace/keyboard/vim/maps/aliases.js
+++ b/lib/ace/mode/sqlserver.js
@@ -27,68 +27,36 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  * ***** END LICENSE BLOCK ***** */
- 
-"use strict"
 
 define(function(require, exports, module) {
-module.exports = {
-    "x": {
-        operator: {
-            ch: "d",
-            count: 1
-        },
-        motion: {
-            ch: "l",
-            count: 1
-        }
-    },
-    "X": {
-        operator: {
-            ch: "d",
-            count: 1
-        },
-        motion: {
-            ch: "h",
-            count: 1
-        }
-    },
-    "D": {
-        operator: {
-            ch: "d",
-            count: 1
-        },
-        motion: {
-            ch: "$",
-            count: 1
-        }
-    },
-    "C": {
-        operator: {
-            ch: "c",
-            count: 1
-        },
-        motion: {
-            ch: "$",
-            count: 1
-        }
-    },
-    "s": {
-        operator: {
-            ch: "c",
-            count: 1
-        },
-        motion: {
-            ch: "l",
-            count: 1
-        }
-    },
-    "S": {
-        operator: {
-            ch: "c",
-            count: 1
-        },
-        param: "c"
-    }
-};
-});
+"use strict";
 
+var oop = require("../lib/oop");
+var TextMode = require("./text").Mode;
+var SqlServerHighlightRules = require("./sqlserver_highlight_rules").SqlHighlightRules;
+var Range = require("../range").Range;
+var SqlServerFoldMode = require("./folding/sqlserver").FoldMode;
+
+var Mode = function() {
+    this.HighlightRules = SqlServerHighlightRules;
+    this.foldingRules = new SqlServerFoldMode();
+};
+oop.inherits(Mode, TextMode);
+
+(function() {
+    this.lineCommentStart = "--";
+    this.blockComment = {start: "/*", end: "*/"};
+    
+    /**
+     * Override keyword completions using list created in highlight rules
+     */
+    this.getCompletions = function(state, session, pos, prefix) {
+        return session.$mode.$highlightRules.completions;
+    };
+    
+    this.$id = "ace/mode/sql";
+}).call(Mode.prototype);
+
+exports.Mode = Mode;
+
+});
diff --git a/lib/ace/mode/sqlserver_highlight_rules.js b/lib/ace/mode/sqlserver_highlight_rules.js
new file mode 100644
index 00000000..c914c0ae
--- /dev/null
+++ b/lib/ace/mode/sqlserver_highlight_rules.js
@@ -0,0 +1,232 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+"use strict";
+
+var oop = require("../lib/oop");
+var DocCommentHighlightRules = require("./doc_comment_highlight_rules").DocCommentHighlightRules;
+var TextHighlightRules = require("./text_highlight_rules").TextHighlightRules;
+
+var SqlServerHighlightRules = function() {
+    /**
+     * Transact-SQL Syntax Conventions: https://msdn.microsoft.com/en-us/library/ms177563.aspx
+     * Goal: make this imitate SSMS (SQL Server Managment Studio)
+     */
+
+    // https://msdn.microsoft.com/en-us/library/ms189773.aspx
+    var logicalOperators = "ALL|AND|ANY|BETWEEN|EXISTS|IN|LIKE|NOT|OR|SOME";
+    logicalOperators += "|NULL|IS|APPLY|INNER|OUTER|LEFT|RIGHT|JOIN|CROSS"; //SSMS colors these gray too
+    //note: manually removed LEFT and RIGHT from built in functions below to color it same way SSMS does
+    
+
+    var builtinFunctions = (
+        /* https://msdn.microsoft.com/en-us/library/ms187957.aspx */
+        "OPENDATASOURCE|OPENQUERY|OPENROWSET|OPENXML|" +
+        /* https://msdn.microsoft.com/en-us/library/ms173454.aspx */
+        "AVG|CHECKSUM_AGG|COUNT|COUNT_BIG|GROUPING|GROUPING_ID|MAX|MIN|STDEV|STDEVP|SUM|VAR|VARP|" +
+        /* https://msdn.microsoft.com/en-us/library/ms189798.aspx */
+        "DENSE_RANK|NTILE|RANK|ROW_NUMBER" +
+        /* https://msdn.microsoft.com/en-us/library/ms173823.aspx */
+        "@@DATEFIRST|@@DBTS|@@LANGID|@@LANGUAGE|@@LOCK_TIMEOUT|@@MAX_CONNECTIONS|@@MAX_PRECISION|@@NESTLEVEL|@@OPTIONS|@@REMSERVER|@@SERVERNAME|@@SERVICENAME|@@SPID|@@TEXTSIZE|@@VERSION|" +
+        /* https://msdn.microsoft.com/en-us/library/hh231076.aspx */
+        "CAST|CONVERT|PARSE|TRY_CAST|TRY_CONVERT|TRY_PARSE" +
+        /* https://msdn.microsoft.com/en-us/library/ms186285.aspx */
+        "@@CURSOR_ROWS|@@FETCH_STATUS|CURSOR_STATUS|" +
+        /* https://msdn.microsoft.com/en-us/library/ms186724.aspx */
+        "@@DATEFIRST|@@LANGUAGE|CURRENT_TIMESTAMP|DATEADD|DATEDIFF|DATEFROMPARTS|DATENAME|DATEPART|DATETIME2FROMPARTS|DATETIMEFROMPARTS|DATETIMEOFFSETFROMPARTS|DAY|EOMONTH|GETDATE|GETUTCDATE|ISDATE|MONTH|SET DATEFIRST|SET DATEFORMAT|SET LANGUAGE|SMALLDATETIMEFROMPARTS|SP_HELPLANGUAGE|SWITCHOFFSET|SYSDATETIME|SYSDATETIMEOFFSET|SYSUTCDATETIME|TIMEFROMPARTS|TODATETIMEOFFSET|YEAR|" +
+        /* https://msdn.microsoft.com/en-us/library/hh213226.aspx */
+        "CHOOSE|IIF|" +
+        /* https://msdn.microsoft.com/en-us/library/ms177516.aspx */
+        "ABS|ACOS|ASIN|ATAN|ATN2|CEILING|COS|COT|DEGREES|EXP|FLOOR|LOG|LOG10|PI|POWER|RADIANS|RAND|ROUND|SIGN|SIN|SQRT|SQUARE|TAN|" +
+        /* https://msdn.microsoft.com/en-us/library/ms187812.aspx */
+        "@@PROCID|APPLOCK_MODE|APPLOCK_TEST|APP_NAME|ASSEMBLYPROPERTY|COLUMNPROPERTY|COL_LENGTH|COL_NAME|DATABASEPROPERTYEX|DATABASE_PRINCIPAL_ID|DB_ID|DB_NAME|FILEGROUPPROPERTY|FILEGROUP_ID|FILEGROUP_NAME|FILEPROPERTY|FILE_ID|FILE_IDEX|FILE_NAME|FULLTEXTCATALOGPROPERTY|FULLTEXTSERVICEPROPERTY|INDEXKEY_PROPERTY|INDEXPROPERTY|INDEX_COL|OBJECTPROPERTY|OBJECTPROPERTYEX|OBJECT_DEFINITION|OBJECT_ID|OBJECT_NAME|OBJECT_SCHEMA_NAME|ORIGINAL_DB_NAME|PARSENAME|SCHEMA_ID|SCHEMA_NAME|SCOPE_IDENTITY|SERVERPROPERTY|STATS_DATE|TYPEPROPERTY|TYPE_ID|TYPE_NAME|" +
+        /* https://msdn.microsoft.com/en-us/library/ms186236.aspx */
+        "CERTENCODED|CERTPRIVATEKEY|CURRENT_USER|DATABASE_PRINCIPAL_ID|HAS_PERMS_BY_NAME|IS_MEMBER|IS_ROLEMEMBER|IS_SRVROLEMEMBER|ORIGINAL_LOGIN|PERMISSIONS|PWDCOMPARE|PWDENCRYPT|SCHEMA_ID|SCHEMA_NAME|SESSION_USER|SUSER_ID|SUSER_NAME|SUSER_SID|SUSER_SNAME|SYS.FN_BUILTIN_PERMISSIONS|SYS.FN_GET_AUDIT_FILE|SYS.FN_MY_PERMISSIONS|SYSTEM_USER|USER_ID|USER_NAME|" +
+        /* https://msdn.microsoft.com/en-us/library/ms181984.aspx */
+        "ASCII|CHAR|CHARINDEX|CONCAT|DIFFERENCE|FORMAT|LEN|LOWER|LTRIM|NCHAR|PATINDEX|QUOTENAME|REPLACE|REPLICATE|REVERSE|RTRIM|SOUNDEX|SPACE|STR|STUFF|SUBSTRING|UNICODE|UPPER|" +
+        /* https://msdn.microsoft.com/en-us/library/ms187786.aspx */
+        "$PARTITION|@@ERROR|@@IDENTITY|@@PACK_RECEIVED|@@ROWCOUNT|@@TRANCOUNT|BINARY_CHECKSUM|CHECKSUM|CONNECTIONPROPERTY|CONTEXT_INFO|CURRENT_REQUEST_ID|ERROR_LINE|ERROR_MESSAGE|ERROR_NUMBER|ERROR_PROCEDURE|ERROR_SEVERITY|ERROR_STATE|FORMATMESSAGE|GETANSINULL|GET_FILESTREAM_TRANSACTION_CONTEXT|HOST_ID|HOST_NAME|ISNULL|ISNUMERIC|MIN_ACTIVE_ROWVERSION|NEWID|NEWSEQUENTIALID|ROWCOUNT_BIG|XACT_STATE|" +
+        /* https://msdn.microsoft.com/en-us/library/ms177520.aspx */
+        "@@CONNECTIONS|@@CPU_BUSY|@@IDLE|@@IO_BUSY|@@PACKET_ERRORS|@@PACK_RECEIVED|@@PACK_SENT|@@TIMETICKS|@@TOTAL_ERRORS|@@TOTAL_READ|@@TOTAL_WRITE|FN_VIRTUALFILESTATS|" +
+        /* https://msdn.microsoft.com/en-us/library/ms188353.aspx */
+        "PATINDEX|TEXTPTR|TEXTVALID|" +
+        /* other */
+        "COALESCE|NULLIF"
+    );
+    
+
+    // https://msdn.microsoft.com/en-us/library/ms187752.aspx
+    var dataTypes = ("BIGINT|BINARY|BIT|CHAR|CURSOR|DATE|DATETIME|DATETIME2|DATETIMEOFFSET|DECIMAL|FLOAT|HIERARCHYID|IMAGE|INTEGER|INT|MONEY|NCHAR|NTEXT|NUMERIC|NVARCHAR|REAL|SMALLDATETIME|SMALLINT|SMALLMONEY|SQL_VARIANT|TABLE|TEXT|TIME|TIMESTAMP|TINYINT|UNIQUEIDENTIFIER|VARBINARY|VARCHAR|XML");
+    
+    
+    //https://msdn.microsoft.com/en-us/library/ms176007.aspx (these are lower case!)
+    var builtInStoredProcedures = "sp_addextendedproc|sp_addextendedproperty|sp_addmessage|sp_addtype|sp_addumpdevice|sp_add_data_file_recover_suspect_db|sp_add_log_file_recover_suspect_db|sp_altermessage|sp_attach_db|sp_attach_single_file_db|sp_autostats|sp_bindefault|sp_bindrule|sp_bindsession|sp_certify_removable|sp_clean_db_file_free_space|sp_clean_db_free_space|sp_configure|sp_control_plan_guide|sp_createstats|sp_create_plan_guide|sp_create_plan_guide_from_handle|sp_create_removable|sp_cycle_errorlog|sp_datatype_info|sp_dbcmptlevel|sp_dbmmonitoraddmonitoring|sp_dbmmonitorchangealert|sp_dbmmonitorchangemonitoring|sp_dbmmonitordropalert|sp_dbmmonitordropmonitoring|sp_dbmmonitorhelpalert|sp_dbmmonitorhelpmonitoring|sp_dbmmonitorresults|sp_db_increased_partitions|sp_delete_backuphistory|sp_depends|sp_describe_first_result_set|sp_describe_undeclared_parameters|sp_detach_db|sp_dropdevice|sp_dropextendedproc|sp_dropextendedproperty|sp_dropmessage|sp_droptype|sp_execute|sp_executesql|sp_getapplock|sp_getbindtoken|sp_help|sp_helpconstraint|sp_helpdb|sp_helpdevice|sp_helpextendedproc|sp_helpfile|sp_helpfilegroup|sp_helpindex|sp_helplanguage|sp_helpserver|sp_helpsort|sp_helpstats|sp_helptext|sp_helptrigger|sp_indexoption|sp_invalidate_textptr|sp_lock|sp_monitor|sp_prepare|sp_prepexec|sp_prepexecrpc|sp_procoption|sp_recompile|sp_refreshview|sp_releaseapplock|sp_rename|sp_renamedb|sp_resetstatus|sp_sequence_get_range|sp_serveroption|sp_setnetname|sp_settriggerorder|sp_spaceused|sp_tableoption|sp_unbindefault|sp_unbindrule|sp_unprepare|sp_updateextendedproperty|sp_updatestats|sp_validname|sp_who|sys.sp_merge_xtp_checkpoint_files|sys.sp_xtp_bind_db_resource_pool|sys.sp_xtp_checkpoint_force_garbage_collection|sys.sp_xtp_control_proc_exec_stats|sys.sp_xtp_control_query_exec_stats|sys.sp_xtp_unbind_db_resource_pool";
+    
+    
+    // https://msdn.microsoft.com/en-us/library/ms189822.aspx
+    var keywords = "ABSOLUTE|ACTION|ADA|ADD|ADMIN|AFTER|AGGREGATE|ALIAS|ALL|ALLOCATE|ALTER|AND|ANY|ARE|ARRAY|AS|ASC|ASENSITIVE|ASSERTION|ASYMMETRIC|AT|ATOMIC|AUTHORIZATION|BACKUP|BEFORE|BEGIN|BETWEEN|BIT_LENGTH|BLOB|BOOLEAN|BOTH|BREADTH|BREAK|BROWSE|BULK|BY|CALL|CALLED|CARDINALITY|CASCADE|CASCADED|CASE|CATALOG|CHARACTER|CHARACTER_LENGTH|CHAR_LENGTH|CHECK|CHECKPOINT|CLASS|CLOB|CLOSE|CLUSTERED|COALESCE|COLLATE|COLLATION|COLLECT|COLUMN|COMMIT|COMPLETION|COMPUTE|CONDITION|CONNECT|CONNECTION|CONSTRAINT|CONSTRAINTS|CONSTRUCTOR|CONTAINS|CONTAINSTABLE|CONTINUE|CORR|CORRESPONDING|COVAR_POP|COVAR_SAMP|CREATE|CROSS|CUBE|CUME_DIST|CURRENT|CURRENT_CATALOG|CURRENT_DATE|CURRENT_DEFAULT_TRANSFORM_GROUP|CURRENT_PATH|CURRENT_ROLE|CURRENT_SCHEMA|CURRENT_TIME|CURRENT_TRANSFORM_GROUP_FOR_TYPE|CYCLE|DATA|DATABASE|DBCC|DEALLOCATE|DEC|DECLARE|DEFAULT|DEFERRABLE|DEFERRED|DELETE|DENY|DEPTH|DEREF|DESC|DESCRIBE|DESCRIPTOR|DESTROY|DESTRUCTOR|DETERMINISTIC|DIAGNOSTICS|DICTIONARY|DISCONNECT|DISK|DISTINCT|DISTRIBUTED|DOMAIN|DOUBLE|DROP|DUMP|DYNAMIC|EACH|ELEMENT|ELSE|END|END-EXEC|EQUALS|ERRLVL|ESCAPE|EVERY|EXCEPT|EXCEPTION|EXEC|EXECUTE|EXISTS|EXIT|EXTERNAL|EXTRACT|FETCH|FILE|FILLFACTOR|FILTER|FIRST|FOR|FOREIGN|FORTRAN|FOUND|FREE|FREETEXT|FREETEXTTABLE|FROM|FULL|FULLTEXTTABLE|FUNCTION|FUSION|GENERAL|GET|GLOBAL|GO|GOTO|GRANT|GROUP|HAVING|HOLD|HOLDLOCK|HOST|HOUR|IDENTITY|IDENTITYCOL|IDENTITY_INSERT|IF|IGNORE|IMMEDIATE|IN|INCLUDE|INDEX|INDICATOR|INITIALIZE|INITIALLY|INNER|INOUT|INPUT|INSENSITIVE|INSERT|INTEGER|INTERSECT|INTERSECTION|INTERVAL|INTO|IS|ISOLATION|ITERATE|JOIN|KEY|KILL|LANGUAGE|LARGE|LAST|LATERAL|LEADING|LESS|LEVEL|LIKE|LIKE_REGEX|LIMIT|LINENO|LN|LOAD|LOCAL|LOCALTIME|LOCALTIMESTAMP|LOCATOR|MAP|MATCH|MEMBER|MERGE|METHOD|MINUTE|MOD|MODIFIES|MODIFY|MODULE|MULTISET|NAMES|NATIONAL|NATURAL|NCLOB|NEW|NEXT|NO|NOCHECK|NONCLUSTERED|NONE|NORMALIZE|NOT|NULL|NULLIF|OBJECT|OCCURRENCES_REGEX|OCTET_LENGTH|OF|OFF|OFFSETS|OLD|ON|ONLY|OPEN|OPERATION|OPTION|OR|ORDER|ORDINALITY|OUT|OUTER|OUTPUT|OVER|OVERLAPS|OVERLAY|PAD|PARAMETER|PARAMETERS|PARTIAL|PARTITION|PASCAL|PATH|PERCENT|PERCENTILE_CONT|PERCENTILE_DISC|PERCENT_RANK|PIVOT|PLAN|POSITION|POSITION_REGEX|POSTFIX|PRECISION|PREFIX|PREORDER|PREPARE|PRESERVE|PRIMARY|PRINT|PRIOR|PRIVILEGES|PROC|PROCEDURE|PUBLIC|RAISERROR|RANGE|READ|READS|READTEXT|RECONFIGURE|RECURSIVE|REF|REFERENCES|REFERENCING|REGR_AVGX|REGR_AVGY|REGR_COUNT|REGR_INTERCEPT|REGR_R2|REGR_SLOPE|REGR_SXX|REGR_SXY|REGR_SYY|RELATIVE|RELEASE|REPLICATION|RESTORE|RESTRICT|RESULT|RETURN|RETURNS|REVERT|REVOKE|ROLE|ROLLBACK|ROLLUP|ROUTINE|ROW|ROWCOUNT|ROWGUIDCOL|ROWS|RULE|SAVE|SAVEPOINT|SCHEMA|SCOPE|SCROLL|SEARCH|SECOND|SECTION|SECURITYAUDIT|SELECT|SEMANTICKEYPHRASETABLE|SEMANTICSIMILARITYDETAILSTABLE|SEMANTICSIMILARITYTABLE|SENSITIVE|SEQUENCE|SESSION|SET|SETS|SETUSER|SHUTDOWN|SIMILAR|SIZE|SOME|SPECIFIC|SPECIFICTYPE|SQL|SQLCA|SQLCODE|SQLERROR|SQLEXCEPTION|SQLSTATE|SQLWARNING|START|STATE|STATEMENT|STATIC|STATISTICS|STDDEV_POP|STDDEV_SAMP|STRUCTURE|SUBMULTISET|SUBSTRING_REGEX|SYMMETRIC|SYSTEM|TABLESAMPLE|TEMPORARY|TERMINATE|TEXTSIZE|THAN|THEN|TIMEZONE_HOUR|TIMEZONE_MINUTE|TO|TOP|TRAILING|TRAN|TRANSACTION|TRANSLATE|TRANSLATE_REGEX|TRANSLATION|TREAT|TRIGGER|TRIM|TRUNCATE|TSEQUAL|UESCAPE|UNDER|UNION|UNIQUE|UNKNOWN|UNNEST|UNPIVOT|UPDATE|UPDATETEXT|USAGE|USE|USER|USING|VALUE|VALUES|VARIABLE|VARYING|VAR_POP|VAR_SAMP|VIEW|WAITFOR|WHEN|WHENEVER|WHERE|WHILE|WIDTH_BUCKET|WINDOW|WITH|WITHIN|WITHIN GROUP|WITHOUT|WORK|WRITE|WRITETEXT|XMLAGG|XMLATTRIBUTES|XMLBINARY|XMLCAST|XMLCOMMENT|XMLCONCAT|XMLDOCUMENT|XMLELEMENT|XMLEXISTS|XMLFOREST|XMLITERATE|XMLNAMESPACES|XMLPARSE|XMLPI|XMLQUERY|XMLSERIALIZE|XMLTABLE|XMLTEXT|XMLVALIDATE|ZONE";
+    
+    
+    // Microsoft's keyword list is missing a lot of things that are located on various other pages
+    // https://msdn.microsoft.com/en-us/library/ms187373.aspx, https://msdn.microsoft.com/en-us/library/ms181714.aspx
+    keywords += "|KEEPIDENTITY|KEEPDEFAULTS|IGNORE_CONSTRAINTS|IGNORE_TRIGGERS|XLOCK|FORCESCAN|FORCESEEK|HOLDLOCK|NOLOCK|NOWAIT|PAGLOCK|READCOMMITTED|READCOMMITTEDLOCK|READPAST|READUNCOMMITTED|REPEATABLEREAD|ROWLOCK|SERIALIZABLE|SNAPSHOT|SPATIAL_WINDOW_MAX_CELLS|TABLOCK|TABLOCKX|UPDLOCK|XLOCK|IGNORE_NONCLUSTERED_COLUMNSTORE_INDEX|EXPAND|VIEWS|FAST|FORCE|KEEP|KEEPFIXED|MAXDOP|MAXRECURSION|OPTIMIZE|PARAMETERIZATION|SIMPLE|FORCED|RECOMPILE|ROBUST|PLAN|SPATIAL_WINDOW_MAX_CELLS|NOEXPAND|HINT";
+    // https://msdn.microsoft.com/en-us/library/ms173815.aspx
+    keywords += "|LOOP|HASH|MERGE|REMOTE";
+    // https://msdn.microsoft.com/en-us/library/ms175976.aspx
+    keywords += "|TRY|CATCH|THROW";
+    // highlighted words in SSMS that I'm not even sure where they come from
+    keywords += "|TYPE";
+    
+    
+    //remove specific built in types from keyword list
+    keywords = keywords.split('|');
+    keywords = keywords.filter(function(value, index, self) {
+        return logicalOperators.split('|').indexOf(value) === -1 && builtinFunctions.split('|').indexOf(value) === -1 && dataTypes.split('|').indexOf(value) === -1;
+    });
+    keywords = keywords.sort().join('|');
+    
+    
+    var keywordMapper = this.createKeywordMapper({
+        "constant.language": logicalOperators,
+        "storage.type": dataTypes,
+        "support.function": builtinFunctions,
+        "support.storedprocedure": builtInStoredProcedures,
+        "keyword": keywords,
+    }, "identifier", true);
+    
+    
+    //https://msdn.microsoft.com/en-us/library/ms190356.aspx
+    var setStatements = "SET ANSI_DEFAULTS|SET ANSI_NULLS|SET ANSI_NULL_DFLT_OFF|SET ANSI_NULL_DFLT_ON|SET ANSI_PADDING|SET ANSI_WARNINGS|SET ARITHABORT|SET ARITHIGNORE|SET CONCAT_NULL_YIELDS_NULL|SET CURSOR_CLOSE_ON_COMMIT|SET DATEFIRST|SET DATEFORMAT|SET DEADLOCK_PRIORITY|SET FIPS_FLAGGER|SET FMTONLY|SET FORCEPLAN|SET IDENTITY_INSERT|SET IMPLICIT_TRANSACTIONS|SET LANGUAGE|SET LOCK_TIMEOUT|SET NOCOUNT|SET NOEXEC|SET NUMERIC_ROUNDABORT|SET OFFSETS|SET PARSEONLY|SET QUERY_GOVERNOR_COST_LIMIT|SET QUOTED_IDENTIFIER|SET REMOTE_PROC_TRANSACTIONS|SET ROWCOUNT|SET SHOWPLAN_ALL|SET SHOWPLAN_TEXT|SET SHOWPLAN_XML|SET STATISTICS IO|SET STATISTICS PROFILE|SET STATISTICS TIME|SET STATISTICS XML|SET TEXTSIZE|SET XACT_ABORT".split('|');
+    var isolationLevels = "READ UNCOMMITTED|READ COMMITTED|REPEATABLE READ|SNAPSHOP|SERIALIZABLE".split('|');
+    for (var i = 0; i < isolationLevels.length; i++) {
+        setStatements.push('SET TRANSACTION ISOLATION LEVEL ' + isolationLevels[i]);
+    }
+    
+    
+    this.$rules = {
+        start: [{
+            token: "string.start",
+            regex: "'",
+            next: [{
+                token: "constant.language.escape",
+                regex: /''/
+            }, {
+                token: "string.end",
+                next: "start",
+                regex: "'"
+            }, {
+                defaultToken: "string"
+            }]
+        },
+        DocCommentHighlightRules.getStartRule("doc-start"), {
+            token: "comment",
+            regex: "--.*$"
+        }, {
+            token: "comment",
+            start: "/\\*",
+            end: "\\*/"
+        }, {
+            token: "constant.numeric", // float
+            regex: "[+-]?\\d+(?:(?:\\.\\d*)?(?:[eE][+-]?\\d+)?)?\\b"
+        }, {
+            token: keywordMapper,
+            regex: "@{0,2}[a-zA-Z_$][a-zA-Z0-9_$]*\\b(?!])" //up to 2 @symbols for some built in functions
+        }, {
+            token: "constant.class",
+            regex: "@@?[a-zA-Z_$][a-zA-Z0-9_$]*\\b"
+        }, {
+            //https://msdn.microsoft.com/en-us/library/ms174986.aspx
+            token: "keyword.operator",
+            regex: "\\+|\\-|\\/|\\/\\/|%|<@>|@>|<@|&|\\^|~|<|>|<=|=>|==|!=|<>|=|\\*"
+        }, {
+            token: "paren.lparen",
+            regex: "[\\(]"
+        }, {
+            token: "paren.rparen",
+            regex: "[\\)]"
+        }, {
+            token: "punctuation",
+            regex: ",|;"
+        }, {
+            token: "text",
+            regex: "\\s+"
+        }],
+        comment: [
+        DocCommentHighlightRules.getTagRule(), {
+            token: "comment",
+            regex: "\\*\\/",
+            next: "no_regex"
+        }, {
+            defaultToken: "comment",
+            caseInsensitive: true
+        }],
+    };
+    
+    //add each set statment as regex at top of rules so that they are processed first because they require multiple words
+    //note: this makes the statements not match if they are not upper case.. which is not ideal but I don't know of an easy way to fix this
+    for (var i = 0; i < setStatements.length; i++) {
+        this.$rules.start.unshift({
+            token: "set.statement",
+            regex: setStatements[i]
+        });
+    }
+    
+    this.embedRules(DocCommentHighlightRules, "doc-", [DocCommentHighlightRules.getEndRule("start")]);
+    this.normalizeRules();
+    
+    
+    //prepare custom keyword completions used by mode to override default completor
+    //this allows for custom 'meta' and proper case of completions
+    var completions = [];
+    var addCompletions = function(arr, meta) {
+        arr.forEach(function(v) {
+            completions.push({
+                name: v,
+                value: v,
+                score: 0,
+                meta: meta,
+            });
+        });
+    };
+    addCompletions(builtInStoredProcedures.split('|'), 'procedure');
+    addCompletions(logicalOperators.split('|'), 'operator');
+    addCompletions(builtinFunctions.split('|'), 'function');
+    addCompletions(dataTypes.split('|'), 'type');
+    addCompletions(setStatements, 'statement');
+    addCompletions(keywords.split('|'), 'keyword');
+    
+    this.completions = completions;
+};
+
+oop.inherits(SqlServerHighlightRules, TextHighlightRules);
+
+exports.SqlHighlightRules = SqlServerHighlightRules;
+});
diff --git a/lib/ace/mode/toml_highlight_rules.js b/lib/ace/mode/toml_highlight_rules.js
index 686ffae2..1a7871ab 100644
--- a/lib/ace/mode/toml_highlight_rules.js
+++ b/lib/ace/mode/toml_highlight_rules.js
@@ -57,6 +57,10 @@ var TomlHighlightRules = function() {
             regex : '"(?=.)',
             next  : "qqstring"
         },
+        {
+            token: ["variable.keygroup.toml"],
+            regex: "(?:^\\s*)(\\[\\[([^\\]]+)\\]\\])"
+        },
         {
             token: ["variable.keygroup.toml"],
             regex: "(?:^\\s*)(\\[([^\\]]+)\\])"
@@ -100,4 +104,4 @@ var TomlHighlightRules = function() {
 oop.inherits(TomlHighlightRules, TextHighlightRules);
 
 exports.TomlHighlightRules = TomlHighlightRules;
-});
\ No newline at end of file
+});
diff --git a/lib/ace/mode/vbscript_highlight_rules.js b/lib/ace/mode/vbscript_highlight_rules.js
index c706002d..ef829922 100644
--- a/lib/ace/mode/vbscript_highlight_rules.js
+++ b/lib/ace/mode/vbscript_highlight_rules.js
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2012, Ajax.org B.V.
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *     * Redistributions of source code must retain the above copyright
@@ -14,7 +14,7 @@
  *     * Neither the name of Ajax.org B.V. nor the
  *       names of its contributors may be used to endorse or promote products
  *       derived from this software without specific prior written permission.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -85,29 +85,35 @@ var VBScriptHighlightRules = function() {
         {
             token: "punctuation.definition.comment.asp",
             regex: "'|REM",
-            next: "comment"
+            next: "comment",
+            caseInsensitive: true
         },
         {
             token: [
                 "keyword.control.asp"
             ],
-            regex: "\\b(?:If|Then|Else|ElseIf|Else If|End If|While|Wend|For|To|Each|Case|Select|End Select|Return|Continue|Do|Until|Loop|Next|With|Exit Do|Exit For|Exit Function|Exit Property|Exit Sub|IIf)\\b"
+            regex: "\\b(?:If|Then|Else|ElseIf|Else If|End If|While|Wend|For|To|Each|Case|Select|End Select|Return|Continue|Do|Until|Loop|Next|With|Exit Do|Exit For|Exit Function|Exit Property|Exit Sub|IIf)\\b",
+            caseInsensitive: true
         },
         {
             token: "keyword.operator.asp",
-            regex: "\\b(?:Mod|And|Not|Or|Xor|as)\\b"
+            regex: "\\b(?:Mod|And|Not|Or|Xor|as)\\b",
+            caseInsensitive: true
         },
         {
             token: "storage.type.asp",
-            regex: "Dim|Call|Class|Const|Dim|Redim|Function|Sub|Private Sub|Public Sub|End sub|End Function|Set|Let|Get|New|Randomize|Option Explicit|On Error Resume Next|On Error GoTo"
+            regex: "Dim|Call|Class|Const|Dim|Redim|Function|Sub|Private Sub|Public Sub|End sub|End Function|Set|Let|Get|New|Randomize|Option Explicit|On Error Resume Next|On Error GoTo",
+            caseInsensitive: true
         },
         {
             token: "storage.modifier.asp",
-            regex: "\\b(?:Private|Public|Default)\\b"
+            regex: "\\b(?:Private|Public|Default)\\b",
+            caseInsensitive: true
         },
         {
             token: "constant.language.asp",
-            regex: "\\b(?:Empty|False|Nothing|Null|True)\\b"
+            regex: "\\b(?:Empty|False|Nothing|Null|True)\\b",
+            caseInsensitive: true
         },
         {
             token: "punctuation.definition.string.begin.asp",
@@ -122,23 +128,28 @@ var VBScriptHighlightRules = function() {
         },
         {
             token: "support.class.asp",
-            regex: "\\b(?:Application|ObjectContext|Request|Response|Server|Session)\\b"
+            regex: "\\b(?:Application|ObjectContext|Request|Response|Server|Session)\\b",
+            caseInsensitive: true
         },
         {
             token: "support.class.collection.asp",
-            regex: "\\b(?:Contents|StaticObjects|ClientCertificate|Cookies|Form|QueryString|ServerVariables)\\b"
+            regex: "\\b(?:Contents|StaticObjects|ClientCertificate|Cookies|Form|QueryString|ServerVariables)\\b",
+            caseInsensitive: true
         },
         {
             token: "support.constant.asp",
-            regex: "\\b(?:TotalBytes|Buffer|CacheControl|Charset|ContentType|Expires|ExpiresAbsolute|IsClientConnected|PICS|Status|ScriptTimeout|CodePage|LCID|SessionID|Timeout)\\b"
+            regex: "\\b(?:TotalBytes|Buffer|CacheControl|Charset|ContentType|Expires|ExpiresAbsolute|IsClientConnected|PICS|Status|ScriptTimeout|CodePage|LCID|SessionID|Timeout)\\b",
+            caseInsensitive: true
         },
         {
             token: "support.function.asp",
-            regex: "\\b(?:Lock|Unlock|SetAbort|SetComplete|BinaryRead|AddHeader|AppendToLog|BinaryWrite|Clear|End|Flush|Redirect|Write|CreateObject|HTMLEncode|MapPath|URLEncode|Abandon|Convert|Regex)\\b"
+            regex: "\\b(?:Lock|Unlock|SetAbort|SetComplete|BinaryRead|AddHeader|AppendToLog|BinaryWrite|Clear|End|Flush|Redirect|Write|CreateObject|HTMLEncode|MapPath|URLEncode|Abandon|Convert|Regex)\\b",
+            caseInsensitive: true
         },
         {
             token: "support.function.event.asp",
-            regex: "\\b(?:Application_OnEnd|Application_OnStart|OnTransactionAbort|OnTransactionCommit|Session_OnEnd|Session_OnStart)\\b"
+            regex: "\\b(?:Application_OnEnd|Application_OnStart|OnTransactionAbort|OnTransactionCommit|Session_OnEnd|Session_OnStart)\\b",
+            caseInsensitive: true
         },
 //        {
 //            token: [
@@ -148,7 +159,8 @@ var VBScriptHighlightRules = function() {
 //        },
         {
             token: "support.function.vb.asp",
-            regex: "\\b(?:Array|Add|Asc|Atn|CBool|CByte|CCur|CDate|CDbl|Chr|CInt|CLng|Conversions|Cos|CreateObject|CSng|CStr|Date|DateAdd|DateDiff|DatePart|DateSerial|DateValue|Day|Derived|Math|Escape|Eval|Exists|Exp|Filter|FormatCurrency|FormatDateTime|FormatNumber|FormatPercent|GetLocale|GetObject|GetRef|Hex|Hour|InputBox|InStr|InStrRev|Int|Fix|IsArray|IsDate|IsEmpty|IsNull|IsNumeric|IsObject|Item|Items|Join|Keys|LBound|LCase|Left|Len|LoadPicture|Log|LTrim|RTrim|Trim|Maths|Mid|Minute|Month|MonthName|MsgBox|Now|Oct|Remove|RemoveAll|Replace|RGB|Right|Rnd|Round|ScriptEngine|ScriptEngineBuildVersion|ScriptEngineMajorVersion|ScriptEngineMinorVersion|Second|SetLocale|Sgn|Sin|Space|Split|Sqr|StrComp|String|StrReverse|Tan|Time|Timer|TimeSerial|TimeValue|TypeName|UBound|UCase|Unescape|VarType|Weekday|WeekdayName|Year)\\b"
+            regex: "\\b(?:Array|Add|Asc|Atn|CBool|CByte|CCur|CDate|CDbl|Chr|CInt|CLng|Conversions|Cos|CreateObject|CSng|CStr|Date|DateAdd|DateDiff|DatePart|DateSerial|DateValue|Day|Derived|Math|Escape|Eval|Exists|Exp|Filter|FormatCurrency|FormatDateTime|FormatNumber|FormatPercent|GetLocale|GetObject|GetRef|Hex|Hour|InputBox|InStr|InStrRev|Int|Fix|IsArray|IsDate|IsEmpty|IsNull|IsNumeric|IsObject|Item|Items|Join|Keys|LBound|LCase|Left|Len|LoadPicture|Log|LTrim|RTrim|Trim|Maths|Mid|Minute|Month|MonthName|MsgBox|Now|Oct|Remove|RemoveAll|Replace|RGB|Right|Rnd|Round|ScriptEngine|ScriptEngineBuildVersion|ScriptEngineMajorVersion|ScriptEngineMinorVersion|Second|SetLocale|Sgn|Sin|Space|Split|Sqr|StrComp|String|StrReverse|Tan|Time|Timer|TimeSerial|TimeValue|TypeName|UBound|UCase|Unescape|VarType|Weekday|WeekdayName|Year)\\b",
+            caseInsensitive: true
         },
         {
             token: [
@@ -158,7 +170,8 @@ var VBScriptHighlightRules = function() {
         },
         {
             token: "support.type.vb.asp",
-            regex: "\\b(?:vbtrue|vbfalse|vbcr|vbcrlf|vbformfeed|vblf|vbnewline|vbnullchar|vbnullstring|int32|vbtab|vbverticaltab|vbbinarycompare|vbtextcomparevbsunday|vbmonday|vbtuesday|vbwednesday|vbthursday|vbfriday|vbsaturday|vbusesystemdayofweek|vbfirstjan1|vbfirstfourdays|vbfirstfullweek|vbgeneraldate|vblongdate|vbshortdate|vblongtime|vbshorttime|vbobjecterror|vbEmpty|vbNull|vbInteger|vbLong|vbSingle|vbDouble|vbCurrency|vbDate|vbString|vbObject|vbError|vbBoolean|vbVariant|vbDataObject|vbDecimal|vbByte|vbArray)\\b"
+            regex: "\\b(?:vbtrue|vbfalse|vbcr|vbcrlf|vbformfeed|vblf|vbnewline|vbnullchar|vbnullstring|int32|vbtab|vbverticaltab|vbbinarycompare|vbtextcomparevbsunday|vbmonday|vbtuesday|vbwednesday|vbthursday|vbfriday|vbsaturday|vbusesystemdayofweek|vbfirstjan1|vbfirstfourdays|vbfirstfullweek|vbgeneraldate|vblongdate|vbshortdate|vblongtime|vbshorttime|vbobjecterror|vbEmpty|vbNull|vbInteger|vbLong|vbSingle|vbDouble|vbCurrency|vbDate|vbString|vbObject|vbError|vbBoolean|vbVariant|vbDataObject|vbDecimal|vbByte|vbArray)\\b",
+            caseInsensitive: true
         },
         {
             token: [
diff --git a/lib/ace/mode/xml.js b/lib/ace/mode/xml.js
index 9b1d2f0a..38861eee 100644
--- a/lib/ace/mode/xml.js
+++ b/lib/ace/mode/xml.js
@@ -37,11 +37,12 @@ var TextMode = require("./text").Mode;
 var XmlHighlightRules = require("./xml_highlight_rules").XmlHighlightRules;
 var XmlBehaviour = require("./behaviour/xml").XmlBehaviour;
 var XmlFoldMode = require("./folding/xml").FoldMode;
+var WorkerClient = require("../worker/worker_client").WorkerClient;
 
 var Mode = function() {
-    this.HighlightRules = XmlHighlightRules;
-    this.$behaviour = new XmlBehaviour();
-    this.foldingRules = new XmlFoldMode();
+   this.HighlightRules = XmlHighlightRules;
+   this.$behaviour = new XmlBehaviour();
+   this.foldingRules = new XmlFoldMode();
 };
 
 oop.inherits(Mode, TextMode);
@@ -52,6 +53,21 @@ oop.inherits(Mode, TextMode);
 
     this.blockComment = {start: ""};
 
+    this.createWorker = function(session) {
+        var worker = new WorkerClient(["ace"], "ace/mode/xml_worker", "Worker");
+        worker.attachToDocument(session.getDocument());
+
+        worker.on("error", function(e) {
+            session.setAnnotations(e.data);
+        });
+
+        worker.on("terminate", function() {
+            session.clearAnnotations();
+        });
+
+        return worker;
+    };
+    
     this.$id = "ace/mode/xml";
 }).call(Mode.prototype);
 
diff --git a/lib/ace/mode/xml/dom-parser.js b/lib/ace/mode/xml/dom-parser.js
new file mode 100644
index 00000000..c99ded42
--- /dev/null
+++ b/lib/ace/mode/xml/dom-parser.js
@@ -0,0 +1,260 @@
+define(function(require, exports, module) {
+	'use strict';
+
+	var XMLReader = require('./sax'),
+		DOMImplementation = require('./dom');
+
+function DOMParser(options){
+	this.options = options ||{locator:{}};
+	
+}
+DOMParser.prototype.parseFromString = function(source,mimeType){	
+	var options = this.options;
+	var sax =  new XMLReader();
+	var domBuilder = options.domBuilder || new DOMHandler();//contentHandler and LexicalHandler
+	var errorHandler = options.errorHandler;
+	var locator = options.locator;
+	var defaultNSMap = options.xmlns||{};
+	var entityMap = {'lt':'<','gt':'>','amp':'&','quot':'"','apos':"'"}
+	if(locator){
+		domBuilder.setDocumentLocator(locator)
+	}
+	
+	sax.errorHandler = buildErrorHandler(errorHandler,domBuilder,locator);
+	sax.domBuilder = options.domBuilder || domBuilder;
+	if(/\/x?html?$/.test(mimeType)){
+		entityMap.nbsp = '\xa0';
+		entityMap.copy = '\xa9';
+		defaultNSMap['']= 'http://www.w3.org/1999/xhtml';
+	}
+	if(source){
+		sax.parse(source,defaultNSMap,entityMap);
+	}else{
+		sax.errorHandler.error("invalid document source");
+	}
+	return domBuilder.document;
+}
+function buildErrorHandler(errorImpl,domBuilder,locator){
+	if(!errorImpl){
+		if(domBuilder instanceof DOMHandler){
+			return domBuilder;
+		}
+		errorImpl = domBuilder ;
+	}
+	var errorHandler = {}
+	var isCallback = errorImpl instanceof Function;
+	locator = locator||{}
+	function build(key){
+		var fn = errorImpl[key];
+		if(!fn){
+			if(isCallback){
+				fn = errorImpl.length == 2?function(msg){errorImpl(key,msg)}:errorImpl;
+			}else{
+				var i=arguments.length;
+				while(--i){
+					if(fn = errorImpl[arguments[i]]){
+						break;
+					}
+				}
+			}
+		}
+		errorHandler[key] = fn && function(msg){
+			fn(msg+_locator(locator), msg, locator);
+		}||function(){};
+	}
+	build('warning','warn');
+	build('error','warn','warning');
+	build('fatalError','warn','warning','error');
+	return errorHandler;
+}
+/**
+ * +ContentHandler+ErrorHandler
+ * +LexicalHandler+EntityResolver2
+ * -DeclHandler-DTDHandler 
+ * 
+ * DefaultHandler:EntityResolver, DTDHandler, ContentHandler, ErrorHandler
+ * DefaultHandler2:DefaultHandler,LexicalHandler, DeclHandler, EntityResolver2
+ * @link http://www.saxproject.org/apidoc/org/xml/sax/helpers/DefaultHandler.html
+ */
+function DOMHandler() {
+    this.cdata = false;
+}
+function position(locator,node){
+	node.lineNumber = locator.lineNumber;
+	node.columnNumber = locator.columnNumber;
+}
+/**
+ * @see org.xml.sax.ContentHandler#startDocument
+ * @link http://www.saxproject.org/apidoc/org/xml/sax/ContentHandler.html
+ */ 
+DOMHandler.prototype = {
+	startDocument : function() {
+    	this.document = new DOMImplementation().createDocument(null, null, null);
+    	if (this.locator) {
+        	this.document.documentURI = this.locator.systemId;
+    	}
+	},
+	startElement:function(namespaceURI, localName, qName, attrs) {
+		var doc = this.document;
+	    var el = doc.createElementNS(namespaceURI, qName||localName);
+	    var len = attrs.length;
+	    appendElement(this, el);
+	    this.currentElement = el;
+	    
+		this.locator && position(this.locator,el)
+	    for (var i = 0 ; i < len; i++) {
+	        var namespaceURI = attrs.getURI(i);
+	        var value = attrs.getValue(i);
+	        var qName = attrs.getQName(i);
+			var attr = doc.createAttributeNS(namespaceURI, qName);
+			if( attr.getOffset){
+				position(attr.getOffset(1),attr)
+			}
+			attr.value = attr.nodeValue = value;
+			el.setAttributeNode(attr)
+	    }
+	},
+	endElement:function(namespaceURI, localName, qName) {
+		var current = this.currentElement
+	    var tagName = current.tagName;
+	    this.currentElement = current.parentNode;
+	},
+	startPrefixMapping:function(prefix, uri) {
+	},
+	endPrefixMapping:function(prefix) {
+	},
+	processingInstruction:function(target, data) {
+	    var ins = this.document.createProcessingInstruction(target, data);
+	    this.locator && position(this.locator,ins)
+	    appendElement(this, ins);
+	},
+	ignorableWhitespace:function(ch, start, length) {
+	},
+	characters:function(chars, start, length) {
+		chars = _toString.apply(this,arguments)
+		//console.log(chars)
+		if(this.currentElement && chars){
+			if (this.cdata) {
+				var charNode = this.document.createCDATASection(chars);
+				this.currentElement.appendChild(charNode);
+			} else {
+				var charNode = this.document.createTextNode(chars);
+				this.currentElement.appendChild(charNode);
+			}
+			this.locator && position(this.locator,charNode)
+		}
+	},
+	skippedEntity:function(name) {
+	},
+	endDocument:function() {
+		this.document.normalize();
+	},
+	setDocumentLocator:function (locator) {
+	    if(this.locator = locator){// && !('lineNumber' in locator)){
+	    	locator.lineNumber = 0;
+	    }
+	},
+	//LexicalHandler
+	comment:function(chars, start, length) {
+		chars = _toString.apply(this,arguments)
+	    var comm = this.document.createComment(chars);
+	    this.locator && position(this.locator,comm)
+	    appendElement(this, comm);
+	},
+	
+	startCDATA:function() {
+	    //used in characters() methods
+	    this.cdata = true;
+	},
+	endCDATA:function() {
+	    this.cdata = false;
+	},
+	
+	startDTD:function(name, publicId, systemId) {
+		var impl = this.document.implementation;
+	    if (impl && impl.createDocumentType) {
+	        var dt = impl.createDocumentType(name, publicId, systemId);
+	        this.locator && position(this.locator,dt)
+	        appendElement(this, dt);
+	    }
+	},
+	/**
+	 * @see org.xml.sax.ErrorHandler
+	 * @link http://www.saxproject.org/apidoc/org/xml/sax/ErrorHandler.html
+	 */
+	warning:function(error) {
+		console.warn(error,_locator(this.locator));
+	},
+	error:function(error) {
+		console.error(error,_locator(this.locator));
+	},
+	fatalError:function(error) {
+		console.error(error,_locator(this.locator));
+	    throw error;
+	}
+}
+function _locator(l){
+	if(l){
+		return '\n@'+(l.systemId ||'')+'#[line:'+l.lineNumber+',col:'+l.columnNumber+']'
+	}
+}
+function _toString(chars,start,length){
+	if(typeof chars == 'string'){
+		return chars.substr(start,length)
+	}else{//java sax connect width xmldom on rhino(what about: "? && !(chars instanceof String)")
+		if(chars.length >= start+length || start){
+			return new java.lang.String(chars,start,length)+'';
+		}
+		return chars;
+	}
+}
+
+/*
+ * @link http://www.saxproject.org/apidoc/org/xml/sax/ext/LexicalHandler.html
+ * used method of org.xml.sax.ext.LexicalHandler:
+ *  #comment(chars, start, length)
+ *  #startCDATA()
+ *  #endCDATA()
+ *  #startDTD(name, publicId, systemId)
+ *
+ *
+ * IGNORED method of org.xml.sax.ext.LexicalHandler:
+ *  #endDTD()
+ *  #startEntity(name)
+ *  #endEntity(name)
+ *
+ *
+ * @link http://www.saxproject.org/apidoc/org/xml/sax/ext/DeclHandler.html
+ * IGNORED method of org.xml.sax.ext.DeclHandler
+ * 	#attributeDecl(eName, aName, type, mode, value)
+ *  #elementDecl(name, model)
+ *  #externalEntityDecl(name, publicId, systemId)
+ *  #internalEntityDecl(name, value)
+ * @link http://www.saxproject.org/apidoc/org/xml/sax/ext/EntityResolver2.html
+ * IGNORED method of org.xml.sax.EntityResolver2
+ *  #resolveEntity(String name,String publicId,String baseURI,String systemId)
+ *  #resolveEntity(publicId, systemId)
+ *  #getExternalSubset(name, baseURI)
+ * @link http://www.saxproject.org/apidoc/org/xml/sax/DTDHandler.html
+ * IGNORED method of org.xml.sax.DTDHandler
+ *  #notationDecl(name, publicId, systemId) {};
+ *  #unparsedEntityDecl(name, publicId, systemId, notationName) {};
+ */
+"endDTD,startEntity,endEntity,attributeDecl,elementDecl,externalEntityDecl,internalEntityDecl,resolveEntity,getExternalSubset,notationDecl,unparsedEntityDecl".replace(/\w+/g,function(key){
+	DOMHandler.prototype[key] = function(){return null}
+})
+
+/* Private static helpers treated below as private instance methods, so don't need to add these to the public API; we might use a Relator to also get rid of non-standard public properties */
+function appendElement (hander,node) {
+    if (!hander.currentElement) {
+        hander.document.appendChild(node);
+    } else {
+        hander.currentElement.appendChild(node);
+    }
+}//appendChild and setAttributeNS are preformance key
+
+return {
+		DOMParser: DOMParser
+	 };
+});
+
diff --git a/lib/ace/mode/xml/dom.js b/lib/ace/mode/xml/dom.js
new file mode 100644
index 00000000..f843e726
--- /dev/null
+++ b/lib/ace/mode/xml/dom.js
@@ -0,0 +1,1138 @@
+define(function(require, exports, module) {
+
+/*
+ * DOM Level 2
+ * Object DOMException
+ * @see http://www.w3.org/TR/REC-DOM-Level-1/ecma-script-language-binding.html
+ * @see http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/ecma-script-binding.html
+ */
+
+function copy(src,dest){
+	for(var p in src){
+		dest[p] = src[p];
+	}
+}
+/**
+^\w+\.prototype\.([_\w]+)\s*=\s*((?:.*\{\s*?[\r\n][\s\S]*?^})|\S.*?(?=[;\r\n]));?
+^\w+\.prototype\.([_\w]+)\s*=\s*(\S.*?(?=[;\r\n]));?
+ */
+function _extends(Class,Super){
+	var pt = Class.prototype;
+	if(Object.create){
+		var ppt = Object.create(Super.prototype)
+		pt.__proto__ = ppt;
+	}
+	if(!(pt instanceof Super)){
+		function t(){};
+		t.prototype = Super.prototype;
+		t = new t();
+		copy(pt,t);
+		Class.prototype = pt = t;
+	}
+	if(pt.constructor != Class){
+		if(typeof Class != 'function'){
+			console.error("unknow Class:"+Class)
+		}
+		pt.constructor = Class
+	}
+}
+var htmlns = 'http://www.w3.org/1999/xhtml' ;
+// Node Types
+var NodeType = {}
+var ELEMENT_NODE                = NodeType.ELEMENT_NODE                = 1;
+var ATTRIBUTE_NODE              = NodeType.ATTRIBUTE_NODE              = 2;
+var TEXT_NODE                   = NodeType.TEXT_NODE                   = 3;
+var CDATA_SECTION_NODE          = NodeType.CDATA_SECTION_NODE          = 4;
+var ENTITY_REFERENCE_NODE       = NodeType.ENTITY_REFERENCE_NODE       = 5;
+var ENTITY_NODE                 = NodeType.ENTITY_NODE                 = 6;
+var PROCESSING_INSTRUCTION_NODE = NodeType.PROCESSING_INSTRUCTION_NODE = 7;
+var COMMENT_NODE                = NodeType.COMMENT_NODE                = 8;
+var DOCUMENT_NODE               = NodeType.DOCUMENT_NODE               = 9;
+var DOCUMENT_TYPE_NODE          = NodeType.DOCUMENT_TYPE_NODE          = 10;
+var DOCUMENT_FRAGMENT_NODE      = NodeType.DOCUMENT_FRAGMENT_NODE      = 11;
+var NOTATION_NODE               = NodeType.NOTATION_NODE               = 12;
+
+// ExceptionCode
+var ExceptionCode = {}
+var ExceptionMessage = {};
+var INDEX_SIZE_ERR              = ExceptionCode.INDEX_SIZE_ERR              = ((ExceptionMessage[1]="Index size error"),1);
+var DOMSTRING_SIZE_ERR          = ExceptionCode.DOMSTRING_SIZE_ERR          = ((ExceptionMessage[2]="DOMString size error"),2);
+var HIERARCHY_REQUEST_ERR       = ExceptionCode.HIERARCHY_REQUEST_ERR       = ((ExceptionMessage[3]="Hierarchy request error"),3);
+var WRONG_DOCUMENT_ERR          = ExceptionCode.WRONG_DOCUMENT_ERR          = ((ExceptionMessage[4]="Wrong document"),4);
+var INVALID_CHARACTER_ERR       = ExceptionCode.INVALID_CHARACTER_ERR       = ((ExceptionMessage[5]="Invalid character"),5);
+var NO_DATA_ALLOWED_ERR         = ExceptionCode.NO_DATA_ALLOWED_ERR         = ((ExceptionMessage[6]="No data allowed"),6);
+var NO_MODIFICATION_ALLOWED_ERR = ExceptionCode.NO_MODIFICATION_ALLOWED_ERR = ((ExceptionMessage[7]="No modification allowed"),7);
+var NOT_FOUND_ERR               = ExceptionCode.NOT_FOUND_ERR               = ((ExceptionMessage[8]="Not found"),8);
+var NOT_SUPPORTED_ERR           = ExceptionCode.NOT_SUPPORTED_ERR           = ((ExceptionMessage[9]="Not supported"),9);
+var INUSE_ATTRIBUTE_ERR         = ExceptionCode.INUSE_ATTRIBUTE_ERR         = ((ExceptionMessage[10]="Attribute in use"),10);
+//level2
+var INVALID_STATE_ERR        	= ExceptionCode.INVALID_STATE_ERR        	= ((ExceptionMessage[11]="Invalid state"),11);
+var SYNTAX_ERR               	= ExceptionCode.SYNTAX_ERR               	= ((ExceptionMessage[12]="Syntax error"),12);
+var INVALID_MODIFICATION_ERR 	= ExceptionCode.INVALID_MODIFICATION_ERR 	= ((ExceptionMessage[13]="Invalid modification"),13);
+var NAMESPACE_ERR            	= ExceptionCode.NAMESPACE_ERR           	= ((ExceptionMessage[14]="Invalid namespace"),14);
+var INVALID_ACCESS_ERR       	= ExceptionCode.INVALID_ACCESS_ERR      	= ((ExceptionMessage[15]="Invalid access"),15);
+
+
+function DOMException(code, message) {
+	if(message instanceof Error){
+		var error = message;
+	}else{
+		error = this;
+		Error.call(this, ExceptionMessage[code]);
+		this.message = ExceptionMessage[code];
+		if(Error.captureStackTrace) Error.captureStackTrace(this, DOMException);
+	}
+	error.code = code;
+	if(message) this.message = this.message + ": " + message;
+	return error;
+};
+DOMException.prototype = Error.prototype;
+copy(ExceptionCode,DOMException)
+/**
+ * @see http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-536297177
+ * The NodeList interface provides the abstraction of an ordered collection of nodes, without defining or constraining how this collection is implemented. NodeList objects in the DOM are live.
+ * The items in the NodeList are accessible via an integral index, starting from 0.
+ */
+function NodeList() {
+};
+NodeList.prototype = {
+	/**
+	 * The number of nodes in the list. The range of valid child node indices is 0 to length-1 inclusive.
+	 * @standard level1
+	 */
+	length:0, 
+	/**
+	 * Returns the indexth item in the collection. If index is greater than or equal to the number of nodes in the list, this returns null.
+	 * @standard level1
+	 * @param index  unsigned long 
+	 *   Index into the collection.
+	 * @return Node
+	 * 	The node at the indexth position in the NodeList, or null if that is not a valid index. 
+	 */
+	item: function(index) {
+		return this[index] || null;
+	}
+};
+function LiveNodeList(node,refresh){
+	this._node = node;
+	this._refresh = refresh
+	_updateLiveList(this);
+}
+function _updateLiveList(list){
+	var inc = list._node._inc || list._node.ownerDocument._inc;
+	if(list._inc != inc){
+		var ls = list._refresh(list._node);
+		//console.log(ls.length)
+		__set__(list,'length',ls.length);
+		copy(ls,list);
+		list._inc = inc;
+	}
+}
+LiveNodeList.prototype.item = function(i){
+	_updateLiveList(this);
+	return this[i];
+}
+
+_extends(LiveNodeList,NodeList);
+/**
+ * 
+ * Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name. Note that NamedNodeMap does not inherit from NodeList; NamedNodeMaps are not maintained in any particular order. Objects contained in an object implementing NamedNodeMap may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of a NamedNodeMap, and does not imply that the DOM specifies an order to these Nodes.
+ * NamedNodeMap objects in the DOM are live.
+ * used for attributes or DocumentType entities 
+ */
+function NamedNodeMap() {
+};
+
+function _findNodeIndex(list,node){
+	var i = list.length;
+	while(i--){
+		if(list[i] === node){return i}
+	}
+}
+
+function _addNamedNode(el,list,newAttr,oldAttr){
+	if(oldAttr){
+		list[_findNodeIndex(list,oldAttr)] = newAttr;
+	}else{
+		list[list.length++] = newAttr;
+	}
+	if(el){
+		newAttr.ownerElement = el;
+		var doc = el.ownerDocument;
+		if(doc){
+			oldAttr && _onRemoveAttribute(doc,el,oldAttr);
+			_onAddAttribute(doc,el,newAttr);
+		}
+	}
+}
+function _removeNamedNode(el,list,attr){
+	var i = _findNodeIndex(list,attr);
+	if(i>=0){
+		var lastIndex = list.length-1
+		while(i0 || key == 'xmlns'){
+//			return null;
+//		}
+		var i = this.length;
+		while(i--){
+			var attr = this[i];
+			if(attr.nodeName == key){
+				return attr;
+			}
+		}
+	},
+	setNamedItem: function(attr) {
+		var el = attr.ownerElement;
+		if(el && el!=this._ownerElement){
+			throw new DOMException(INUSE_ATTRIBUTE_ERR);
+		}
+		var oldAttr = this.getNamedItem(attr.nodeName);
+		_addNamedNode(this._ownerElement,this,attr,oldAttr);
+		return oldAttr;
+	},
+	/* returns Node */
+	setNamedItemNS: function(attr) {// raises: WRONG_DOCUMENT_ERR,NO_MODIFICATION_ALLOWED_ERR,INUSE_ATTRIBUTE_ERR
+		var el = attr.ownerElement, oldAttr;
+		if(el && el!=this._ownerElement){
+			throw new DOMException(INUSE_ATTRIBUTE_ERR);
+		}
+		oldAttr = this.getNamedItemNS(attr.namespaceURI,attr.localName);
+		_addNamedNode(this._ownerElement,this,attr,oldAttr);
+		return oldAttr;
+	},
+
+	/* returns Node */
+	removeNamedItem: function(key) {
+		var attr = this.getNamedItem(key);
+		_removeNamedNode(this._ownerElement,this,attr);
+		return attr;
+		
+		
+	},// raises: NOT_FOUND_ERR,NO_MODIFICATION_ALLOWED_ERR
+	
+	//for level2
+	removeNamedItemNS:function(namespaceURI,localName){
+		var attr = this.getNamedItemNS(namespaceURI,localName);
+		_removeNamedNode(this._ownerElement,this,attr);
+		return attr;
+	},
+	getNamedItemNS: function(namespaceURI, localName) {
+		var i = this.length;
+		while(i--){
+			var node = this[i];
+			if(node.localName == localName && node.namespaceURI == namespaceURI){
+				return node;
+			}
+		}
+		return null;
+	}
+};
+/**
+ * @see http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#ID-102161490
+ */
+function DOMImplementation(/* Object */ features) {
+	this._features = {};
+	if (features) {
+		for (var feature in features) {
+			 this._features = features[feature];
+		}
+	}
+};
+
+DOMImplementation.prototype = {
+	hasFeature: function(/* string */ feature, /* string */ version) {
+		var versions = this._features[feature.toLowerCase()];
+		if (versions && (!version || version in versions)) {
+			return true;
+		} else {
+			return false;
+		}
+	},
+	// Introduced in DOM Level 2:
+	createDocument:function(namespaceURI,  qualifiedName, doctype){// raises:INVALID_CHARACTER_ERR,NAMESPACE_ERR,WRONG_DOCUMENT_ERR
+		var doc = new Document();
+		doc.implementation = this;
+		doc.childNodes = new NodeList();
+		doc.doctype = doctype;
+		if(doctype){
+			doc.appendChild(doctype);
+		}
+		if(qualifiedName){
+			var root = doc.createElementNS(namespaceURI,qualifiedName);
+			doc.appendChild(root);
+		}
+		return doc;
+	},
+	// Introduced in DOM Level 2:
+	createDocumentType:function(qualifiedName, publicId, systemId){// raises:INVALID_CHARACTER_ERR,NAMESPACE_ERR
+		var node = new DocumentType();
+		node.name = qualifiedName;
+		node.nodeName = qualifiedName;
+		node.publicId = publicId;
+		node.systemId = systemId;
+		// Introduced in DOM Level 2:
+		//readonly attribute DOMString        internalSubset;
+		
+		//TODO:..
+		//  readonly attribute NamedNodeMap     entities;
+		//  readonly attribute NamedNodeMap     notations;
+		return node;
+	}
+};
+
+
+/**
+ * @see http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1950641247
+ */
+
+function Node() {
+};
+
+Node.prototype = {
+	firstChild : null,
+	lastChild : null,
+	previousSibling : null,
+	nextSibling : null,
+	attributes : null,
+	parentNode : null,
+	childNodes : null,
+	ownerDocument : null,
+	nodeValue : null,
+	namespaceURI : null,
+	prefix : null,
+	localName : null,
+	// Modified in DOM Level 2:
+	insertBefore:function(newChild, refChild){//raises 
+		return _insertBefore(this,newChild,refChild);
+	},
+	replaceChild:function(newChild, oldChild){//raises 
+		this.insertBefore(newChild,oldChild);
+		if(oldChild){
+			this.removeChild(oldChild);
+		}
+	},
+	removeChild:function(oldChild){
+		return _removeChild(this,oldChild);
+	},
+	appendChild:function(newChild){
+		return this.insertBefore(newChild,null);
+	},
+	hasChildNodes:function(){
+		return this.firstChild != null;
+	},
+	cloneNode:function(deep){
+		return cloneNode(this.ownerDocument||this,this,deep);
+	},
+	// Modified in DOM Level 2:
+	normalize:function(){
+		var child = this.firstChild;
+		while(child){
+			var next = child.nextSibling;
+			if(next && next.nodeType == TEXT_NODE && child.nodeType == TEXT_NODE){
+				this.removeChild(next);
+				child.appendData(next.data);
+			}else{
+				child.normalize();
+				child = next;
+			}
+		}
+	},
+  	// Introduced in DOM Level 2:
+	isSupported:function(feature, version){
+		return this.ownerDocument.implementation.hasFeature(feature,version);
+	},
+    // Introduced in DOM Level 2:
+    hasAttributes:function(){
+    	return this.attributes.length>0;
+    },
+    lookupPrefix:function(namespaceURI){
+    	var el = this;
+    	while(el){
+    		var map = el._nsMap;
+    		//console.dir(map)
+    		if(map){
+    			for(var n in map){
+    				if(map[n] == namespaceURI){
+    					return n;
+    				}
+    			}
+    		}
+    		el = el.nodeType == 2?el.ownerDocument : el.parentNode;
+    	}
+    	return null;
+    },
+    // Introduced in DOM Level 3:
+    lookupNamespaceURI:function(prefix){
+    	var el = this;
+    	while(el){
+    		var map = el._nsMap;
+    		//console.dir(map)
+    		if(map){
+    			if(prefix in map){
+    				return map[prefix] ;
+    			}
+    		}
+    		el = el.nodeType == 2?el.ownerDocument : el.parentNode;
+    	}
+    	return null;
+    },
+    // Introduced in DOM Level 3:
+    isDefaultNamespace:function(namespaceURI){
+    	var prefix = this.lookupPrefix(namespaceURI);
+    	return prefix == null;
+    }
+};
+
+
+function _xmlEncoder(c){
+	return c == '<' && '<' ||
+         c == '>' && '>' ||
+         c == '&' && '&' ||
+         c == '"' && '"' ||
+         '&#'+c.charCodeAt()+';'
+}
+
+
+copy(NodeType,Node);
+copy(NodeType,Node.prototype);
+
+/**
+ * @param callback return true for continue,false for break
+ * @return boolean true: break visit;
+ */
+function _visitNode(node,callback){
+	if(callback(node)){
+		return true;
+	}
+	if(node = node.firstChild){
+		do{
+			if(_visitNode(node,callback)){return true}
+        }while(node=node.nextSibling)
+    }
+}
+
+
+
+function Document(){
+}
+function _onAddAttribute(doc,el,newAttr){
+	doc && doc._inc++;
+	var ns = newAttr.namespaceURI ;
+	if(ns == 'http://www.w3.org/2000/xmlns/'){
+		//update namespace
+		el._nsMap[newAttr.prefix?newAttr.localName:''] = newAttr.value
+	}
+}
+function _onRemoveAttribute(doc,el,newAttr,remove){
+	doc && doc._inc++;
+	var ns = newAttr.namespaceURI ;
+	if(ns == 'http://www.w3.org/2000/xmlns/'){
+		//update namespace
+		delete el._nsMap[newAttr.prefix?newAttr.localName:'']
+	}
+}
+function _onUpdateChild(doc,el,newChild){
+	if(doc && doc._inc){
+		doc._inc++;
+		//update childNodes
+		var cs = el.childNodes;
+		if(newChild){
+			cs[cs.length++] = newChild;
+		}else{
+			//console.log(1)
+			var child = el.firstChild;
+			var i = 0;
+			while(child){
+				cs[i++] = child;
+				child =child.nextSibling;
+			}
+			cs.length = i;
+		}
+	}
+}
+
+/**
+ * attributes;
+ * children;
+ * 
+ * writeable properties:
+ * nodeValue,Attr:value,CharacterData:data
+ * prefix
+ */
+function _removeChild(parentNode,child){
+	var previous = child.previousSibling;
+	var next = child.nextSibling;
+	if(previous){
+		previous.nextSibling = next;
+	}else{
+		parentNode.firstChild = next
+	}
+	if(next){
+		next.previousSibling = previous;
+	}else{
+		parentNode.lastChild = previous;
+	}
+	_onUpdateChild(parentNode.ownerDocument,parentNode);
+	return child;
+}
+/**
+ * preformance key(refChild == null)
+ */
+function _insertBefore(parentNode,newChild,nextChild){
+	var cp = newChild.parentNode;
+	if(cp){
+		cp.removeChild(newChild);//remove and update
+	}
+	if(newChild.nodeType === DOCUMENT_FRAGMENT_NODE){
+		var newFirst = newChild.firstChild;
+		if (newFirst == null) {
+			return newChild;
+		}
+		var newLast = newChild.lastChild;
+	}else{
+		newFirst = newLast = newChild;
+	}
+	var pre = nextChild ? nextChild.previousSibling : parentNode.lastChild;
+
+	newFirst.previousSibling = pre;
+	newLast.nextSibling = nextChild;
+	
+	
+	if(pre){
+		pre.nextSibling = newFirst;
+	}else{
+		parentNode.firstChild = newFirst;
+	}
+	if(nextChild == null){
+		parentNode.lastChild = newLast;
+	}else{
+		nextChild.previousSibling = newLast;
+	}
+	do{
+		newFirst.parentNode = parentNode;
+	}while(newFirst !== newLast && (newFirst= newFirst.nextSibling))
+	_onUpdateChild(parentNode.ownerDocument||parentNode,parentNode);
+	//console.log(parentNode.lastChild.nextSibling == null)
+	if (newChild.nodeType == DOCUMENT_FRAGMENT_NODE) {
+		newChild.firstChild = newChild.lastChild = null;
+	}
+	return newChild;
+}
+function _appendSingleChild(parentNode,newChild){
+	var cp = newChild.parentNode;
+	if(cp){
+		var pre = parentNode.lastChild;
+		cp.removeChild(newChild);//remove and update
+		var pre = parentNode.lastChild;
+	}
+	var pre = parentNode.lastChild;
+	newChild.parentNode = parentNode;
+	newChild.previousSibling = pre;
+	newChild.nextSibling = null;
+	if(pre){
+		pre.nextSibling = newChild;
+	}else{
+		parentNode.firstChild = newChild;
+	}
+	parentNode.lastChild = newChild;
+	_onUpdateChild(parentNode.ownerDocument,parentNode,newChild);
+	return newChild;
+	//console.log("__aa",parentNode.lastChild.nextSibling == null)
+}
+Document.prototype = {
+	//implementation : null,
+	nodeName :  '#document',
+	nodeType :  DOCUMENT_NODE,
+	doctype :  null,
+	documentElement :  null,
+	_inc : 1,
+	
+	insertBefore :  function(newChild, refChild){//raises 
+		if(newChild.nodeType == DOCUMENT_FRAGMENT_NODE){
+			var child = newChild.firstChild;
+			while(child){
+				var next = child.nextSibling;
+				this.insertBefore(child,refChild);
+				child = next;
+			}
+			return newChild;
+		}
+		if(this.documentElement == null && newChild.nodeType == 1){
+			this.documentElement = newChild;
+		}
+		
+		return _insertBefore(this,newChild,refChild),(newChild.ownerDocument = this),newChild;
+	},
+	removeChild :  function(oldChild){
+		if(this.documentElement == oldChild){
+			this.documentElement = null;
+		}
+		return _removeChild(this,oldChild);
+	},
+	// Introduced in DOM Level 2:
+	importNode : function(importedNode,deep){
+		return importNode(this,importedNode,deep);
+	},
+	// Introduced in DOM Level 2:
+	getElementById :	function(id){
+		var rtv = null;
+		_visitNode(this.documentElement,function(node){
+			if(node.nodeType == 1){
+				if(node.getAttribute('id') == id){
+					rtv = node;
+					return true;
+				}
+			}
+		})
+		return rtv;
+	},
+	
+	//document factory method:
+	createElement :	function(tagName){
+		var node = new Element();
+		node.ownerDocument = this;
+		node.nodeName = tagName;
+		node.tagName = tagName;
+		node.childNodes = new NodeList();
+		var attrs	= node.attributes = new NamedNodeMap();
+		attrs._ownerElement = node;
+		return node;
+	},
+	createDocumentFragment :	function(){
+		var node = new DocumentFragment();
+		node.ownerDocument = this;
+		node.childNodes = new NodeList();
+		return node;
+	},
+	createTextNode :	function(data){
+		var node = new Text();
+		node.ownerDocument = this;
+		node.appendData(data)
+		return node;
+	},
+	createComment :	function(data){
+		var node = new Comment();
+		node.ownerDocument = this;
+		node.appendData(data)
+		return node;
+	},
+	createCDATASection :	function(data){
+		var node = new CDATASection();
+		node.ownerDocument = this;
+		node.appendData(data)
+		return node;
+	},
+	createProcessingInstruction :	function(target,data){
+		var node = new ProcessingInstruction();
+		node.ownerDocument = this;
+		node.tagName = node.target = target;
+		node.nodeValue= node.data = data;
+		return node;
+	},
+	createAttribute :	function(name){
+		var node = new Attr();
+		node.ownerDocument	= this;
+		node.name = name;
+		node.nodeName	= name;
+		node.localName = name;
+		node.specified = true;
+		return node;
+	},
+	createEntityReference :	function(name){
+		var node = new EntityReference();
+		node.ownerDocument	= this;
+		node.nodeName	= name;
+		return node;
+	},
+	// Introduced in DOM Level 2:
+	createElementNS :	function(namespaceURI,qualifiedName){
+		var node = new Element();
+		var pl = qualifiedName.split(':');
+		var attrs	= node.attributes = new NamedNodeMap();
+		node.childNodes = new NodeList();
+		node.ownerDocument = this;
+		node.nodeName = qualifiedName;
+		node.tagName = qualifiedName;
+		node.namespaceURI = namespaceURI;
+		if(pl.length == 2){
+			node.prefix = pl[0];
+			node.localName = pl[1];
+		}else{
+			//el.prefix = null;
+			node.localName = qualifiedName;
+		}
+		attrs._ownerElement = node;
+		return node;
+	},
+	// Introduced in DOM Level 2:
+	createAttributeNS :	function(namespaceURI,qualifiedName){
+		var node = new Attr();
+		var pl = qualifiedName.split(':');
+		node.ownerDocument = this;
+		node.nodeName = qualifiedName;
+		node.name = qualifiedName;
+		node.namespaceURI = namespaceURI;
+		node.specified = true;
+		if(pl.length == 2){
+			node.prefix = pl[0];
+			node.localName = pl[1];
+		}else{
+			//el.prefix = null;
+			node.localName = qualifiedName;
+		}
+		return node;
+	}
+};
+_extends(Document,Node);
+
+
+function Element() {
+	this._nsMap = {};
+};
+Element.prototype = {
+	nodeType : ELEMENT_NODE,
+	hasAttribute : function(name){
+		return this.getAttributeNode(name)!=null;
+	},
+	getAttribute : function(name){
+		var attr = this.getAttributeNode(name);
+		return attr && attr.value || '';
+	},
+	getAttributeNode : function(name){
+		return this.attributes.getNamedItem(name);
+	},
+	setAttribute : function(name, value){
+		var attr = this.ownerDocument.createAttribute(name);
+		attr.value = attr.nodeValue = "" + value;
+		this.setAttributeNode(attr)
+	},
+	removeAttribute : function(name){
+		var attr = this.getAttributeNode(name)
+		attr && this.removeAttributeNode(attr);
+	},
+	
+	//four real opeartion method
+	appendChild:function(newChild){
+		if(newChild.nodeType === DOCUMENT_FRAGMENT_NODE){
+			return this.insertBefore(newChild,null);
+		}else{
+			return _appendSingleChild(this,newChild);
+		}
+	},
+	setAttributeNode : function(newAttr){
+		return this.attributes.setNamedItem(newAttr);
+	},
+	setAttributeNodeNS : function(newAttr){
+		return this.attributes.setNamedItemNS(newAttr);
+	},
+	removeAttributeNode : function(oldAttr){
+		return this.attributes.removeNamedItem(oldAttr.nodeName);
+	},
+	//get real attribute name,and remove it by removeAttributeNode
+	removeAttributeNS : function(namespaceURI, localName){
+		var old = this.getAttributeNodeNS(namespaceURI, localName);
+		old && this.removeAttributeNode(old);
+	},
+	
+	hasAttributeNS : function(namespaceURI, localName){
+		return this.getAttributeNodeNS(namespaceURI, localName)!=null;
+	},
+	getAttributeNS : function(namespaceURI, localName){
+		var attr = this.getAttributeNodeNS(namespaceURI, localName);
+		return attr && attr.value || '';
+	},
+	setAttributeNS : function(namespaceURI, qualifiedName, value){
+		var attr = this.ownerDocument.createAttributeNS(namespaceURI, qualifiedName);
+		attr.value = attr.nodeValue = "" + value;
+		this.setAttributeNode(attr)
+	},
+	getAttributeNodeNS : function(namespaceURI, localName){
+		return this.attributes.getNamedItemNS(namespaceURI, localName);
+	},
+	
+	getElementsByTagName : function(tagName){
+		return new LiveNodeList(this,function(base){
+			var ls = [];
+			_visitNode(base,function(node){
+				if(node !== base && node.nodeType == ELEMENT_NODE && (tagName === '*' || node.tagName == tagName)){
+					ls.push(node);
+				}
+			});
+			return ls;
+		});
+	},
+	getElementsByTagNameNS : function(namespaceURI, localName){
+		return new LiveNodeList(this,function(base){
+			var ls = [];
+			_visitNode(base,function(node){
+				if(node !== base && node.nodeType === ELEMENT_NODE && (namespaceURI === '*' || node.namespaceURI === namespaceURI) && (localName === '*' || node.localName == localName)){
+					ls.push(node);
+				}
+			});
+			return ls;
+		});
+	}
+};
+Document.prototype.getElementsByTagName = Element.prototype.getElementsByTagName;
+Document.prototype.getElementsByTagNameNS = Element.prototype.getElementsByTagNameNS;
+
+
+_extends(Element,Node);
+function Attr() {
+};
+Attr.prototype.nodeType = ATTRIBUTE_NODE;
+_extends(Attr,Node);
+
+
+function CharacterData() {
+};
+CharacterData.prototype = {
+	data : '',
+	substringData : function(offset, count) {
+		return this.data.substring(offset, offset+count);
+	},
+	appendData: function(text) {
+		text = this.data+text;
+		this.nodeValue = this.data = text;
+		this.length = text.length;
+	},
+	insertData: function(offset,text) {
+		this.replaceData(offset,0,text);
+	
+	},
+	appendChild:function(newChild){
+		//if(!(newChild instanceof CharacterData)){
+			throw new Error(ExceptionMessage[3])
+		//}
+		return Node.prototype.appendChild.apply(this,arguments)
+	},
+	deleteData: function(offset, count) {
+		this.replaceData(offset,count,"");
+	},
+	replaceData: function(offset, count, text) {
+		var start = this.data.substring(0,offset);
+		var end = this.data.substring(offset+count);
+		text = start + text + end;
+		this.nodeValue = this.data = text;
+		this.length = text.length;
+	}
+}
+_extends(CharacterData,Node);
+function Text() {
+};
+Text.prototype = {
+	nodeName : "#text",
+	nodeType : TEXT_NODE,
+	splitText : function(offset) {
+		var text = this.data;
+		var newText = text.substring(offset);
+		text = text.substring(0, offset);
+		this.data = this.nodeValue = text;
+		this.length = text.length;
+		var newNode = this.ownerDocument.createTextNode(newText);
+		if(this.parentNode){
+			this.parentNode.insertBefore(newNode, this.nextSibling);
+		}
+		return newNode;
+	}
+}
+_extends(Text,CharacterData);
+function Comment() {
+};
+Comment.prototype = {
+	nodeName : "#comment",
+	nodeType : COMMENT_NODE
+}
+_extends(Comment,CharacterData);
+
+function CDATASection() {
+};
+CDATASection.prototype = {
+	nodeName : "#cdata-section",
+	nodeType : CDATA_SECTION_NODE
+}
+_extends(CDATASection,CharacterData);
+
+
+function DocumentType() {
+};
+DocumentType.prototype.nodeType = DOCUMENT_TYPE_NODE;
+_extends(DocumentType,Node);
+
+function Notation() {
+};
+Notation.prototype.nodeType = NOTATION_NODE;
+_extends(Notation,Node);
+
+function Entity() {
+};
+Entity.prototype.nodeType = ENTITY_NODE;
+_extends(Entity,Node);
+
+function EntityReference() {
+};
+EntityReference.prototype.nodeType = ENTITY_REFERENCE_NODE;
+_extends(EntityReference,Node);
+
+function DocumentFragment() {
+};
+DocumentFragment.prototype.nodeName =	"#document-fragment";
+DocumentFragment.prototype.nodeType =	DOCUMENT_FRAGMENT_NODE;
+_extends(DocumentFragment,Node);
+
+
+function ProcessingInstruction() {
+}
+ProcessingInstruction.prototype.nodeType = PROCESSING_INSTRUCTION_NODE;
+_extends(ProcessingInstruction,Node);
+function XMLSerializer(){}
+XMLSerializer.prototype.serializeToString = function(node){
+	var buf = [];
+	serializeToString(node,buf);
+	return buf.join('');
+}
+Node.prototype.toString =function(){
+	return XMLSerializer.prototype.serializeToString(this);
+}
+function serializeToString(node,buf){
+	switch(node.nodeType){
+	case ELEMENT_NODE:
+		var attrs = node.attributes;
+		var len = attrs.length;
+		var child = node.firstChild;
+		var nodeName = node.tagName;
+		var isHTML = htmlns === node.namespaceURI
+		buf.push('<',nodeName);
+		for(var i=0;i');
+			//if is cdata child node
+			if(isHTML && /^script$/i.test(nodeName)){
+				if(child){
+					buf.push(child.data);
+				}
+			}else{
+				while(child){
+					serializeToString(child,buf);
+					child = child.nextSibling;
+				}
+			}
+			buf.push('');
+		}else{
+			buf.push('/>');
+		}
+		return;
+	case DOCUMENT_NODE:
+	case DOCUMENT_FRAGMENT_NODE:
+		var child = node.firstChild;
+		while(child){
+			serializeToString(child,buf);
+			child = child.nextSibling;
+		}
+		return;
+	case ATTRIBUTE_NODE:
+		return buf.push(' ',node.name,'="',node.value.replace(/[<&"]/g,_xmlEncoder),'"');
+	case TEXT_NODE:
+		return buf.push(node.data.replace(/[<&]/g,_xmlEncoder));
+	case CDATA_SECTION_NODE:
+		return buf.push( '');
+	case COMMENT_NODE:
+		return buf.push( "");
+	case DOCUMENT_TYPE_NODE:
+		var pubid = node.publicId;
+		var sysid = node.systemId;
+		buf.push('');
+		}else if(sysid && sysid!='.'){
+			buf.push(' SYSTEM "',sysid,'">');
+		}else{
+			var sub = node.internalSubset;
+			if(sub){
+				buf.push(" [",sub,"]");
+			}
+			buf.push(">");
+		}
+		return;
+	case PROCESSING_INSTRUCTION_NODE:
+		return buf.push( "");
+	case ENTITY_REFERENCE_NODE:
+		return buf.push( '&',node.nodeName,';');
+	//case ENTITY_NODE:
+	//case NOTATION_NODE:
+	default:
+		buf.push('??',node.nodeName);
+	}
+}
+function importNode(doc,node,deep){
+	var node2;
+	switch (node.nodeType) {
+	case ELEMENT_NODE:
+		node2 = node.cloneNode(false);
+		node2.ownerDocument = doc;
+		//var attrs = node2.attributes;
+		//var len = attrs.length;
+		//for(var i=0;i
+
+function XMLReader(){
+	
+}
+
+XMLReader.prototype = {
+	parse:function(source,defaultNSMap,entityMap){
+		var domBuilder = this.domBuilder;
+		domBuilder.startDocument();
+		_copy(defaultNSMap ,defaultNSMap = {})
+		parse(source,defaultNSMap,entityMap,
+				domBuilder,this.errorHandler);
+		domBuilder.endDocument();
+	}
+}
+function parse(source,defaultNSMapCopy,entityMap,domBuilder,errorHandler){
+  function fixedFromCharCode(code) {
+		// String.prototype.fromCharCode does not supports
+		// > 2 bytes unicode chars directly
+		if (code > 0xffff) {
+			code -= 0x10000;
+			var surrogate1 = 0xd800 + (code >> 10)
+				, surrogate2 = 0xdc00 + (code & 0x3ff);
+
+			return String.fromCharCode(surrogate1, surrogate2);
+		} else {
+			return String.fromCharCode(code);
+		}
+	}
+	function entityReplacer(a){
+		var k = a.slice(1,-1);
+		if(k in entityMap){
+			return entityMap[k]; 
+		}else if(k.charAt(0) === '#'){
+			return fixedFromCharCode(parseInt(k.substr(1).replace('x','0x')))
+		}else{
+			errorHandler.error('entity not found:'+a);
+			return a;
+		}
+	}
+	function appendText(end){//has some bugs
+		var xt = source.substring(start,end).replace(/&#?\w+;/g,entityReplacer);
+		locator&&position(start);
+		domBuilder.characters(xt,0,end-start);
+		start = end
+	}
+	function position(start,m){
+		while(start>=endPos && (m = linePattern.exec(source))){
+			startPos = m.index;
+			endPos = startPos + m[0].length;
+			locator.lineNumber++;
+			//console.log('line++:',locator,startPos,endPos)
+		}
+		locator.columnNumber = start-startPos+1;
+	}
+	var startPos = 0;
+	var endPos = 0;
+	var linePattern = /.+(?:\r\n?|\n)|.*$/g
+	var locator = domBuilder.locator;
+	
+	var parseStack = [{currentNSMap:defaultNSMapCopy}]
+	var closeMap = {};
+	var start = 0;
+	while(true){
+		var i = source.indexOf('<',start);
+		if(i<0){
+			if(!source.substr(start).match(/^\s*$/)){
+				var doc = domBuilder.document;
+    			var text = doc.createTextNode(source.substr(start));
+    			doc.appendChild(text);
+    			domBuilder.currentElement = text;
+			}
+			return;
+		}
+		if(i>start){
+			appendText(i);
+		}
+		switch(source.charAt(i+1)){
+		case '/':
+			var end = source.indexOf('>',i+3);
+			var tagName = source.substring(i+2,end);
+			var config;
+			if (parseStack.length > 1) {
+				config = parseStack.pop();
+			} else {
+				errorHandler.fatalError("end tag name not found for: "+tagName);
+				break;
+			}
+			var localNSMap = config.localNSMap;
+			
+	        if(config.tagName != tagName){
+	            errorHandler.fatalError("end tag name: " + tagName + " does not match the current start tagName: "+config.tagName );
+	        }
+			domBuilder.endElement(config.uri,config.localName,tagName);
+			if(localNSMap){
+				for(var prefix in localNSMap){
+					domBuilder.endPrefixMapping(prefix) ;
+				}
+			}
+			end++;
+			break;
+			// end elment
+		case '?':// 
+			locator&&position(i);
+			end = parseInstruction(source,i,domBuilder);
+			break;
+		case '!':// 0){
+					value = source.slice(start,p).replace(/&#?\w+;/g,entityReplacer);
+					el.add(attrName,value,start-1);
+					s = S_E;
+				}else{
+					//fatalError: no end quot match
+					throw new Error('attribute value no end \''+c+'\' match');
+				}
+			}else if(s == S_V){
+				value = source.slice(start,p).replace(/&#?\w+;/g,entityReplacer);
+				//console.log(attrName,value,start,p)
+				el.add(attrName,value,start);
+				//console.dir(el)
+				errorHandler.warning('attribute "'+attrName+'" missed start quot('+c+')!!');
+				start = p+1;
+				s = S_E
+			}else{
+				//fatalError: no equal before
+				throw new Error('attribute value must after "="');
+			}
+			break;
+		case '/':
+			switch(s){
+			case S_TAG:
+				el.setTagName(source.slice(start,p));
+			case S_E:
+			case S_S:
+			case S_C:
+				s = S_C;
+				el.closed = true;
+			case S_V:
+			case S_ATTR:
+			case S_ATTR_S:
+				break;
+			//case S_EQ:
+			default:
+				throw new Error("attribute invalid close char('/')")
+			}
+			break;
+		case ''://end document
+			//throw new Error('unexpected end of input')
+			errorHandler.error('unexpected end of input');
+		case '>':
+			switch(s){
+			case S_TAG:
+				el.setTagName(source.slice(start,p));
+			case S_E:
+			case S_S:
+			case S_C:
+				break;//normal
+			case S_V://Compatible state
+			case S_ATTR:
+				value = source.slice(start,p);
+				if(value.slice(-1) === '/'){
+					el.closed  = true;
+					value = value.slice(0,-1)
+				}
+			case S_ATTR_S:
+				if(s === S_ATTR_S){
+					value = attrName;
+				}
+				if(s == S_V){
+					errorHandler.warning('attribute "'+value+'" missed quot(")!!');
+					el.add(attrName,value.replace(/&#?\w+;/g,entityReplacer),start)
+				}else{
+					errorHandler.warning('attribute "'+value+'" missed value!! "'+value+'" instead!!')
+					el.add(value,value,start)
+				}
+				break;
+			case S_EQ:
+				throw new Error('attribute value missed!!');
+			}
+//			console.log(tagName,tagNamePattern,tagNamePattern.test(tagName))
+			return p;
+		/*xml space '\x20' | #x9 | #xD | #xA; */
+		case '\u0080':
+			c = ' ';
+		default:
+			if(c<= ' '){//space
+				switch(s){
+				case S_TAG:
+					el.setTagName(source.slice(start,p));//tagName
+					s = S_S;
+					break;
+				case S_ATTR:
+					attrName = source.slice(start,p)
+					s = S_ATTR_S;
+					break;
+				case S_V:
+					var value = source.slice(start,p).replace(/&#?\w+;/g,entityReplacer);
+					errorHandler.warning('attribute "'+value+'" missed quot(")!!');
+					el.add(attrName,value,start)
+				case S_E:
+					s = S_S;
+					break;
+				//case S_S:
+				//case S_EQ:
+				//case S_ATTR_S:
+				//	void();break;
+				//case S_C:
+					//ignore warning
+				}
+			}else{//not space
+//S_TAG,	S_ATTR,	S_EQ,	S_V
+//S_ATTR_S,	S_E,	S_S,	S_C
+				switch(s){
+				//case S_TAG:void();break;
+				//case S_ATTR:void();break;
+				//case S_V:void();break;
+				case S_ATTR_S:
+					errorHandler.warning('attribute "'+attrName+'" missed value!! "'+attrName+'" instead!!')
+					el.add(attrName,attrName,start);
+					start = p;
+					s = S_ATTR;
+					break;
+				case S_E:
+					errorHandler.warning('attribute space is required"'+attrName+'"!!')
+				case S_S:
+					s = S_ATTR;
+					start = p;
+					break;
+				case S_EQ:
+					s = S_V;
+					start = p;
+					break;
+				case S_C:
+					throw new Error("elements closed character '/' and '>' must be connected to");
+				}
+			}
+		}
+		p++;
+	}
+}
+/**
+ * @return end of the elementStartPart(end of elementEndPart for selfClosed el)
+ */
+function appendElement(el,domBuilder,parseStack){
+	var tagName = el.tagName;
+	var localNSMap = null;
+	var currentNSMap = parseStack[parseStack.length-1].currentNSMap;
+	var i = el.length;
+	while(i--){
+		var a = el[i];
+		var qName = a.qName;
+		var value = a.value;
+		var nsp = qName.indexOf(':');
+		if(nsp>0){
+			var prefix = a.prefix = qName.slice(0,nsp);
+			var localName = qName.slice(nsp+1);
+			var nsPrefix = prefix === 'xmlns' && localName
+		}else{
+			localName = qName;
+			prefix = null
+			nsPrefix = qName === 'xmlns' && ''
+		}
+		//can not set prefix,because prefix !== ''
+		a.localName = localName ;
+		//prefix == null for no ns prefix attribute 
+		if(nsPrefix !== false){//hack!!
+			if(localNSMap == null){
+				localNSMap = {}
+				//console.log(currentNSMap,0)
+				_copy(currentNSMap,currentNSMap={})
+				//console.log(currentNSMap,1)
+			}
+			currentNSMap[nsPrefix] = localNSMap[nsPrefix] = value;
+			a.uri = 'http://www.w3.org/2000/xmlns/'
+			domBuilder.startPrefixMapping(nsPrefix, value) 
+		}
+	}
+	var i = el.length;
+	while(i--){
+		a = el[i];
+		var prefix = a.prefix;
+		if(prefix){//no prefix attribute has no namespace
+			if(prefix === 'xml'){
+				a.uri = 'http://www.w3.org/XML/1998/namespace';
+			}if(prefix !== 'xmlns'){
+				a.uri = currentNSMap[prefix]
+				
+				//{console.log('###'+a.qName,domBuilder.locator.systemId+'',currentNSMap,a.uri)}
+			}
+		}
+	}
+	var nsp = tagName.indexOf(':');
+	if(nsp>0){
+		prefix = el.prefix = tagName.slice(0,nsp);
+		localName = el.localName = tagName.slice(nsp+1);
+	}else{
+		prefix = null;//important!!
+		localName = el.localName = tagName;
+	}
+	//no prefix element has default namespace
+	var ns = el.uri = currentNSMap[prefix || ''];
+	domBuilder.startElement(ns,localName,tagName,el);
+	//endPrefixMapping and startPrefixMapping have not any help for dom builder
+	//localNSMap = null
+	if(el.closed){
+		domBuilder.endElement(ns,localName,tagName);
+		if(localNSMap){
+			for(prefix in localNSMap){
+				domBuilder.endPrefixMapping(prefix) 
+			}
+		}
+	}else{
+		el.currentNSMap = currentNSMap;
+		el.localNSMap = localNSMap;
+		parseStack.push(el);
+	}
+}
+function parseHtmlSpecialContent(source,elStartEnd,tagName,entityReplacer,domBuilder){
+	if(/^(?:script|textarea)$/i.test(tagName)){
+		var elEndStart =  source.indexOf('',elStartEnd);
+		var text = source.substring(elStartEnd+1,elEndStart);
+		if(/[&<]/.test(text)){
+			if(/^script$/i.test(tagName)){
+				//if(!/\]\]>/.test(text)){
+					//lexHandler.startCDATA();
+					domBuilder.characters(text,0,text.length);
+					//lexHandler.endCDATA();
+					return elEndStart;
+				//}
+			}//}else{//text area
+				text = text.replace(/&#?\w+;/g,entityReplacer);
+				domBuilder.characters(text,0,text.length);
+				return elEndStart;
+			//}
+			
+		}
+	}
+	return elStartEnd+1;
+}
+function fixSelfClosed(source,elStartEnd,tagName,closeMap){
+	//if(tagName in closeMap){
+	var pos = closeMap[tagName];
+	if(pos == null){
+		//console.log(tagName)
+		pos = closeMap[tagName] = source.lastIndexOf('')
+	}
+	return pos',start+4);
+			//append comment source.substring(4,end)//\n             the function returns false.
    If $i1 and $i2 are both nodes, they are compared as described\n             below:
    If the two nodes are of different kinds, the result is false.
    If the two nodes are both document nodes then they are deep-equal if and only if\n                   the sequence $i1/(*|text()) is deep-equal to the sequence\n                      $i2/(*|text()).
     If the two nodes are both element nodes then they are deep-equal if and only if\n                   all of the following conditions are satisfied:
    The two nodes have the same name, that is (node-name($i1) eq\n                            node-name($i2)).
    Either both nodes are both annotated as having simple content or both nodes are\n                         annotated as having complex content. For this purpose \"simple content\" means either a simple\n                      type or a complex type with simple content; \"complex content\" means a complex type whose variety\n                      is mixed, element-only, or empty.
    It is a consequence of this rule that validating a document\n                      D against a schema will usually (but not necessarily) result in a document that is not deep-equal\n                         to D. The exception is when the schema allows all elements to have mixed content.
    The two nodes have the same number of attributes, and for every attribute\n                            $a1 in $i1/@* there exists an attribute\n                            $a2 in $i2/@* such that $a1 and\n                            $a2 are deep-equal.
     One of the following conditions holds:
    Both element nodes are annotated as having simple content\n                               (as defined in 3(b) above), and\n                               the typed value of $i1 is deep-equal to the typed value\n                               of $i2.
    Both element nodes have a type annotation that is a complex type with\n                               variety element-only, and the sequence $i1/* is\n                               deep-equal to the sequence $i2/*.
    Both element nodes have a type annotation that is a complex type with\n                               variety mixed, and the sequence $i1/(*|text()) is\n                               deep-equal to the sequence $i2/(*|text()).
    Both element nodes have a type annotation that is a complex type with\n                               variety empty.
    If the two nodes are both attribute nodes then they are deep-equal if and only if\n                   both the following conditions are satisfied:
    The two nodes have the same name, that is (node-name($i1) eq\n                            node-name($i2)).
    The typed value of $i1 is deep-equal to the typed value of\n                            $i2.
     If the two nodes are both processing instruction nodes or namespace bindings, then they are deep-equal if and\n                   only if both the following conditions are satisfied:
    The two nodes have the same name, that is (node-name($i1) eq\n                            node-name($i2)).
    The string value of $i1 is equal to the string value of\n                            $i2.
     If the two nodes are both namespace nodes, then they are deep-equal if and only\n                   if both the following conditions are satisfied:
    The two nodes either have the same name or are both nameless, that is\n                            fn:deep-equal(node-name($i1), node-name($i2)).
    The string value of $i1 is equal to the string value of\n                            $i2 when compared using the Unicode codepoint collation.
    If the two nodes are both text nodes or comment nodes, then they are deep-equal if\n                   and only if their string-values are equal.
    A type error is raised \n             if either input sequence contains a function item.\n             \n          
    \n", "summary" : "
       This function assesses whether two sequences are deep-equal to each other.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "parameter1", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "parameter2", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "deep-equal", "qname" : "fn:deep-equal", "signature" : "($parameter1 as item()*, $parameter2 as item()*, $collation as xs:string) as xs:boolean external", "description" : " 
     This function assesses whether two sequences are deep-equal to each other. To\n             be deep-equal, they must contain items that are pairwise deep-equal; and for two items\n             to be deep-equal, they must either be atomic values that compare equal, or nodes of the\n             same kind, with the same name, whose children are deep-equal.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The $collation argument identifies a collation which is used at all levels\n             of recursion when strings are compared (but not when names are compared), according to\n             the rules in .
    If the two sequences are both empty, the function returns true.
    If the two sequences are of different lengths, the function returns\n             false.
    If the two sequences are of the same length, the function returns true if\n             and only if every item in the sequence $parameter1 is deep-equal to the\n             item at the same position in the sequence $parameter2. The rules for\n             deciding whether two items are deep-equal follow.
    Call the two items $i1 and $i2 respectively.
    If $i1 and $i2 are both atomic values, they are deep-equal if\n             and only if ($i1 eq $i2) is true, or if both values are\n                NaN. If the eq operator is not defined for $i1\n             and $i2, the function returns false.
     If one of the pair $i1 or $i2 is an atomic value and the\n             other is not,\n             \n             the function returns false.
    If $i1 and $i2 are both nodes, they are compared as described\n             below:
    If the two nodes are of different kinds, the result is false.
    If the two nodes are both document nodes then they are deep-equal if and only if\n                   the sequence $i1/(*|text()) is deep-equal to the sequence\n                      $i2/(*|text()).
     If the two nodes are both element nodes then they are deep-equal if and only if\n                   all of the following conditions are satisfied:
    The two nodes have the same name, that is (node-name($i1) eq\n                            node-name($i2)).
    Either both nodes are both annotated as having simple content or both nodes are\n                         annotated as having complex content. For this purpose \"simple content\" means either a simple\n                      type or a complex type with simple content; \"complex content\" means a complex type whose variety\n                      is mixed, element-only, or empty.
    It is a consequence of this rule that validating a document\n                      D against a schema will usually (but not necessarily) result in a document that is not deep-equal\n                         to D. The exception is when the schema allows all elements to have mixed content.
    The two nodes have the same number of attributes, and for every attribute\n                            $a1 in $i1/@* there exists an attribute\n                            $a2 in $i2/@* such that $a1 and\n                            $a2 are deep-equal.
     One of the following conditions holds:
    Both element nodes are annotated as having simple content\n                               (as defined in 3(b) above), and\n                               the typed value of $i1 is deep-equal to the typed value\n                               of $i2.
    Both element nodes have a type annotation that is a complex type with\n                               variety element-only, and the sequence $i1/* is\n                               deep-equal to the sequence $i2/*.
    Both element nodes have a type annotation that is a complex type with\n                               variety mixed, and the sequence $i1/(*|text()) is\n                               deep-equal to the sequence $i2/(*|text()).
    Both element nodes have a type annotation that is a complex type with\n                               variety empty.
    If the two nodes are both attribute nodes then they are deep-equal if and only if\n                   both the following conditions are satisfied:
    The two nodes have the same name, that is (node-name($i1) eq\n                            node-name($i2)).
    The typed value of $i1 is deep-equal to the typed value of\n                            $i2.
     If the two nodes are both processing instruction nodes or namespace bindings, then they are deep-equal if and\n                   only if both the following conditions are satisfied:
    The two nodes have the same name, that is (node-name($i1) eq\n                            node-name($i2)).
    The string value of $i1 is equal to the string value of\n                            $i2.
     If the two nodes are both namespace nodes, then they are deep-equal if and only\n                   if both the following conditions are satisfied:
    The two nodes either have the same name or are both nameless, that is\n                            fn:deep-equal(node-name($i1), node-name($i2)).
    The string value of $i1 is equal to the string value of\n                            $i2 when compared using the Unicode codepoint collation.
    If the two nodes are both text nodes or comment nodes, then they are deep-equal if\n                   and only if their string-values are equal.
    A type error is raised \n             if either input sequence contains a function item.\n             \n          
    \n", "summary" : "
       This function assesses whether two sequences are deep-equal to each other.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "parameter1", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "parameter2", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "default-collation", "qname" : "fn:default-collation", "signature" : "() as xs:string external", "description" : " 
    Returns the value of the default collation property from the static context.\n          
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    Returns the value of the default collation property from the static context. Components\n             of the static context are discussed in .
    The default collation property can never be absent. If it is not explicitly defined, a\n             system defined default can be invoked. If this is not provided, the Unicode codepoint\n             collation (http://www.w3.org/2005/xpath-functions/collation/codepoint) is\n             used. 
    \n", "summary" : "
      Returns the value of the default collation property from the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct-values", "qname" : "fn:distinct-values", "signature" : "($arg as xs:anyAtomicType*) as xs:anyAtomicType* external", "description" : " 
    Returns the values that appear in a sequence, with duplicates eliminated.
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The function returns the sequence that results from removing from $arg all\n             but one of a set of values that are equal to one another. Values are compared using the\n                eq operator, subject to the caveats defined below.
    Values of type xs:untypedAtomic are compared as if they were of type\n                xs:string.
    Values that cannot be compared, because the eq operator is not defined for\n             their types, are considered to be distinct.
    The collation used by this function is determined according to the rules in . This collation is used when string comparison is\n             required.
    For xs:float and xs:double values, positive zero is equal to\n             negative zero and, although NaN does not equal itself, if $arg\n             contains multiple NaN values a single NaN is returned.
     If xs:dateTime, xs:date or xs:time values do not\n             have a timezone, they are considered to have the implicit timezone provided by the\n             dynamic context for the purpose of comparison. Note that xs:dateTime,\n                xs:date or xs:time values can compare equal even if their\n             timezones are different.
    The order in which the sequence of values is returned is .
    Which value of a set of values that compare equal is returned is . 
    The static type of the result is a sequence of prime types as defined\n             in [Formal Semantics].
    \n             
    If the input sequence contains values of different numeric types that differ from\n                each other by small amounts, then the eq operator is not transitive, because of\n                rounding effects occurring during type promotion. In the situation where the input\n                contains three values A, B, and C such that\n                   A eq B, B eq C, but A ne C, then the number\n                of items in the result of the function (as well as the choice of which items are\n                returned) is , subject only to the\n                constraints that (a) no two items in the result sequence compare equal to each other,\n                and (b) every input item that does not appear in the result sequence compares equal\n                to some item that does appear in the result sequence.
    \n             
    For example, this arises when computing:
    \n                 distinct-values(\n             (xs:float('1.0'),\n             xs:decimal('1.0000000000100000000001',\n             xs:double( '1.00000000001'))\n             
    because the values of type xs:float and xs:double both\n                compare equal to the value of type xs:decimal but not equal to each\n                other. 
    \n          
    If $arg is the empty sequence, the function returns the empty sequence.
    \n", "summary" : "
      Returns the values that appear in a sequence, with duplicates eliminated.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "distinct-values", "qname" : "fn:distinct-values", "signature" : "($arg as xs:anyAtomicType*, $collation as xs:string) as xs:anyAtomicType* external", "description" : " 
    Returns the values that appear in a sequence, with duplicates eliminated.
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The function returns the sequence that results from removing from $arg all\n             but one of a set of values that are equal to one another. Values are compared using the\n                eq operator, subject to the caveats defined below.
    Values of type xs:untypedAtomic are compared as if they were of type\n                xs:string.
    Values that cannot be compared, because the eq operator is not defined for\n             their types, are considered to be distinct.
    The collation used by this function is determined according to the rules in . This collation is used when string comparison is\n             required.
    For xs:float and xs:double values, positive zero is equal to\n             negative zero and, although NaN does not equal itself, if $arg\n             contains multiple NaN values a single NaN is returned.
     If xs:dateTime, xs:date or xs:time values do not\n             have a timezone, they are considered to have the implicit timezone provided by the\n             dynamic context for the purpose of comparison. Note that xs:dateTime,\n                xs:date or xs:time values can compare equal even if their\n             timezones are different.
    The order in which the sequence of values is returned is .
    Which value of a set of values that compare equal is returned is . 
    The static type of the result is a sequence of prime types as defined\n             in [Formal Semantics].
    \n             
    If the input sequence contains values of different numeric types that differ from\n                each other by small amounts, then the eq operator is not transitive, because of\n                rounding effects occurring during type promotion. In the situation where the input\n                contains three values A, B, and C such that\n                   A eq B, B eq C, but A ne C, then the number\n                of items in the result of the function (as well as the choice of which items are\n                returned) is , subject only to the\n                constraints that (a) no two items in the result sequence compare equal to each other,\n                and (b) every input item that does not appear in the result sequence compares equal\n                to some item that does appear in the result sequence.
    \n             
    For example, this arises when computing:
    \n                 distinct-values(\n             (xs:float('1.0'),\n             xs:decimal('1.0000000000100000000001',\n             xs:double( '1.00000000001'))\n             
    because the values of type xs:float and xs:double both\n                compare equal to the value of type xs:decimal but not equal to each\n                other. 
    \n          
    If $arg is the empty sequence, the function returns the empty sequence.
    \n", "summary" : "
      Returns the values that appear in a sequence, with duplicates eliminated.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "doc-available", "qname" : "fn:doc-available", "signature" : "($uri as xs:string?) as xs:boolean external", "description" : " 
    The function returns true if and only if the function\n             call fn:doc($uri) would return a document node.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tavailable documents, and static base uri.\n \t
    If $uri is an empty sequence, this function returns\n                false.
    If a call on fn:doc($uri) would return a document\n             node, this function returns true.
    A dynamic error is raised  if\n                $uri is not a valid URI according to the rules applied by the\n             implementation of fn:doc.
    Otherwise, this function returns false.
    If this function returns true, then calling fn:doc($uri)\n             within the same  must return a document node. However,\n             if nondeterministic processing has been selected for the fn:doc function,\n             this guarantee is lost.
    \n", "summary" : "
      The function returns true if and only if the function\n             call  fn:doc($uri)  would return a document node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "doc", "qname" : "fn:doc", "signature" : "($uri as xs:string?) as document()? external", "description" : " 
    Retrieves a document using a URI supplied as an\n                xs:string, and returns the corresponding document node.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tavailable documents, and static base uri.\n \t
    If $uri is the empty sequence, the result is an empty sequence.
    If $uri is a relative URI reference, it is resolved\n             relative to the value of the Static Base URI property from the static context. The resulting\n             absolute URI is promoted to an xs:string.
    If the Available documents described in  provides a mapping from this string to a document\n             node, the function returns that document node.
    The URI may include a fragment identifier.
    By default, this function is deterministic. Two calls on this function\n             return the same document node if the same URI Reference (after resolution to an absolute\n             URI Reference) is supplied to both calls. Thus, the following expression (if it does not\n             raise an error) will always be true:
    doc(\"foo.xml\") is doc(\"foo.xml\")
    However, for performance reasons, implementations may provide a user option to evaluate\n             the function without a guarantee of determinism. The manner in which any such option is\n             provided is implementation-defined. If the user has not selected such an option, a call\n             of the function must either return a deterministic result or must raise a dynamic error\n                .
    For detailed type semantics, see [Formal Semantics].
    If $uri is read from a source document, it is generally appropriate to\n                resolve it relative to the base URI property of the relevant node in the source\n                document. This can be achieved by calling the fn:resolve-uri function,\n                and passing the resulting absolute URI as an argument to the fn:doc\n                function.
    If two calls to this function supply different absolute URI References as arguments, the\n             same document node may be returned if the implementation can determine that the two\n             arguments refer to the same resource.
     By defining the semantics of this function in terms of a string-to-document-node\n             mapping in the dynamic context, the specification is acknowledging that the results of\n             this function are outside the purview of the language specification itself, and depend\n             entirely on the run-time environment in which the expression is evaluated. This run-time\n             environment includes not only an unpredictable collection of resources (\"the web\"), but\n             configurable machinery for locating resources and turning their contents into document\n             nodes within the XPath data model. Both the set of resources that are reachable, and the\n             mechanisms by which those resources are parsed and validated, are .
     One possible processing model for this function is as follows. The resource identified\n             by the URI Reference is retrieved. If the resource cannot be retrieved, a dynamic error is\n             raised . The data resulting from the retrieval action\n             is then parsed as an XML document and a tree is constructed in accordance with the\n                . If the top-level media type is known and is\n             \"text\", the content is parsed in the same way as if the media type were text/xml;\n             otherwise, it is parsed in the same way as if the media type were application/xml. If\n             the contents cannot be parsed successfully, a dynamic error is raised . Otherwise, the result of the function is the document node at the root\n             of the resulting tree. This tree is then optionally validated against a schema.
    Various aspects of this processing are .\n             Implementations may provide external configuration options that allow any aspect of the\n             processing to be controlled by the user. In particular:
    The set of URI schemes that the implementation recognizes is\n                   implementation-defined. Implementations may allow the mapping of URIs to resources\n                   to be configured by the user, using mechanisms such as catalogs or user-written\n                   URI handlers.
    The handling of non-XML media types is implementation-defined. Implementations may\n                   allow instances of the data model to be constructed from non-XML resources, under\n                   user control.
    It is  whether DTD validation and/or schema\n                   validation is applied to the source document.
    Implementations may provide user-defined error handling options that allow\n                   processing to continue following an error in retrieving a resource, or in parsing\n                   and validating its content. When errors have been handled in this way, the\n                   function may return either an empty sequence, or a fallback document provided by\n                   the error handler.
    Implementations may provide user options that relax the requirement for the\n                   function to return deterministic results.
    A dynamic error may be raised  if $uri is not a valid URI.
    A dynamic error is raised  if the\n                available documents provides no mapping for the absolutized URI.
    A dynamic error is raised  if the resource cannot be\n             retrieved or cannot be parsed successfully as XML.
    A dynamic error is raised  if the implementation is not able\n             to guarantee that the result of the function will be deterministic, and the user has not\n             indicated that an unstable result is acceptable.
    \n", "summary" : "
      Retrieves a document using a URI supplied as an\n                 xs:string , and returns the corresponding document node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "document()?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "document-uri", "qname" : "fn:document-uri", "signature" : "() as xs:anyURI? external", "description" : " 
    Returns the URI of a resource where a document can be found, if available.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item\n                (.). The behavior of the function if the argument is omitted is exactly\n             the same as if the context item had been passed as the argument.
    If $arg is the empty sequence, the function returns the empty sequence.
    If $arg is not a document node, the function returns the empty\n             sequence.
    Otherwise, the function returns the value of the document-uri accessor\n             applied to $arg, as defined in  (See\n                ).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the URI of a resource where a document can be found, if available.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "document-uri", "qname" : "fn:document-uri", "signature" : "($arg as node()?) as xs:anyURI? external", "description" : " 
    Returns the URI of a resource where a document can be found, if available.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item\n                (.). The behavior of the function if the argument is omitted is exactly\n             the same as if the context item had been passed as the argument.
    If $arg is the empty sequence, the function returns the empty sequence.
    If $arg is not a document node, the function returns the empty\n             sequence.
    Otherwise, the function returns the value of the document-uri accessor\n             applied to $arg, as defined in  (See\n                ).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the URI of a resource where a document can be found, if available.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "element-with-id", "qname" : "fn:element-with-id", "signature" : "($arg as xs:string*) as element(*)* external", "description" : " 
     Returns the sequence of element nodes that have an\n                ID value matching the value of one or more of the IDREF\n             values supplied in $arg.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    \n             
    The effect of this function is identical to fn:id in respect\n                   of elements that have an attribute with the is-id property. However,\n                   it behaves differently in respect of element nodes with the is-id\n                   property. Whereas the fn:id, for legacy reasons, returns the element\n                   that has the is-id property, this parent returns the element\n                   identified by the ID, which is the parent of the element having the\n                      is-id property.
    \n             
    The function returns a sequence, in document order with duplicates eliminated,\n                containing every element node E that satisfies all the following\n                conditions:
    \n             
    \n                      E is in the target document. The target document is the document\n                      containing $node, or the document containing the context item\n                         (.) if the second argument is omitted. The behavior of the\n                      function if $node is omitted is exactly the same as if the context\n                      item had been passed as $node.
    E has an ID value equal to one of the candidate\n                         IDREF values, where:
     An element has an ID value equal to V if\n                            either or both of the following conditions are true:
    The element has an child element node whose is-id\n                                  property (See .) is true and\n                                  whose typed value is equal to V under the rules of the\n                                     eq operator using the Unicode code point collation\n                                     (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    The element has an attribute node whose is-id property\n                                  (See .) is true and whose\n                                  typed value is equal to V under the rules of the\n                                     eq operator using the Unicode code point collation\n                                     (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    Each xs:string in $arg is parsed as if it were\n                            of type IDREFS, that is, each xs:string in\n                               $arg is treated as a whitespace-separated sequence of\n                            tokens, each acting as an IDREF. These tokens are then\n                            included in the list of candidate IDREFs. If any of the\n                            tokens is not a lexically valid IDREF (that is, if it is not\n                            lexically an xs:NCName), it is ignored. Formally, the\n                            candidate IDREF values are the strings in the sequence given\n                            by the expression:
    for $s in $arg return\n    fn:tokenize(fn:normalize-space($s), ' ')[. castable as xs:IDREF]
     If several elements have the same ID value, then E\n                      is the one that is first in document order.
    \n              \n             
    A dynamic error is raised  if\n                   $node, or the context item if the second argument is omitted, is a\n                   node in a tree whose root is not a document node.
    \n             
    The following errors may be raised when $node is omitted:
    \n             
    • If the context\n                   item is absent, dynamic error\n                   
    • If the context item is not a\n                   node, type error .
    \n          
    \n", "summary" : "
       Returns the sequence of element nodes that have an\n                 ID  value matching the value of one or more of the  IDREF \n             values supplied in  $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "element-with-id", "qname" : "fn:element-with-id", "signature" : "($arg as xs:string*, $node as node()) as element(*)* external", "description" : " 
     Returns the sequence of element nodes that have an\n                ID value matching the value of one or more of the IDREF\n             values supplied in $arg.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    \n             
    The effect of this function is identical to fn:id in respect\n                   of elements that have an attribute with the is-id property. However,\n                   it behaves differently in respect of element nodes with the is-id\n                   property. Whereas the fn:id, for legacy reasons, returns the element\n                   that has the is-id property, this parent returns the element\n                   identified by the ID, which is the parent of the element having the\n                      is-id property.
    \n             
    The function returns a sequence, in document order with duplicates eliminated,\n                containing every element node E that satisfies all the following\n                conditions:
    \n             
    \n                      E is in the target document. The target document is the document\n                      containing $node, or the document containing the context item\n                         (.) if the second argument is omitted. The behavior of the\n                      function if $node is omitted is exactly the same as if the context\n                      item had been passed as $node.
    E has an ID value equal to one of the candidate\n                         IDREF values, where:
     An element has an ID value equal to V if\n                            either or both of the following conditions are true:
    The element has an child element node whose is-id\n                                  property (See .) is true and\n                                  whose typed value is equal to V under the rules of the\n                                     eq operator using the Unicode code point collation\n                                     (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    The element has an attribute node whose is-id property\n                                  (See .) is true and whose\n                                  typed value is equal to V under the rules of the\n                                     eq operator using the Unicode code point collation\n                                     (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    Each xs:string in $arg is parsed as if it were\n                            of type IDREFS, that is, each xs:string in\n                               $arg is treated as a whitespace-separated sequence of\n                            tokens, each acting as an IDREF. These tokens are then\n                            included in the list of candidate IDREFs. If any of the\n                            tokens is not a lexically valid IDREF (that is, if it is not\n                            lexically an xs:NCName), it is ignored. Formally, the\n                            candidate IDREF values are the strings in the sequence given\n                            by the expression:
    for $s in $arg return\n    fn:tokenize(fn:normalize-space($s), ' ')[. castable as xs:IDREF]
     If several elements have the same ID value, then E\n                      is the one that is first in document order.
    \n              \n             
    A dynamic error is raised  if\n                   $node, or the context item if the second argument is omitted, is a\n                   node in a tree whose root is not a document node.
    \n             
    The following errors may be raised when $node is omitted:
    \n             
    • If the context\n                   item is absent, dynamic error\n                   
    • If the context item is not a\n                   node, type error .
    \n          
    \n", "summary" : "
       Returns the sequence of element nodes that have an\n                 ID  value matching the value of one or more of the  IDREF \n             values supplied in  $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "*", "description" : "" }, { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "empty", "qname" : "fn:empty", "signature" : "($arg as item()*) as xs:boolean external", "description" : " 
    Returns true if the argument is the empty sequence.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the function returns\n                true; otherwise, the function returns false. 
    The expression fn:empty((1,2,3)[10]) returns true().
    The expression fn:empty(fn:remove((\"hello\", \"world\"), 1)) returns false().
    \n", "summary" : "
      Returns true if the argument is the empty sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "encode-for-uri", "qname" : "fn:encode-for-uri", "signature" : "($uri-part as xs:string?) as xs:string external", "description" : " 
    Encodes reserved characters in a string that is intended to be used in the path\n             segment of a URI.
    This function is deterministic, context-independent,  and focus-independent. 
    If $uri-part is the empty sequence, the function returns the zero-length\n             string.
    This function applies the URI escaping rules defined in section 2 of  to the xs:string supplied as $uri-part. The\n             effect of the function is to escape reserved characters. Each such character in the\n             string is replaced with its percent-encoded form as described in .
    Since  recommends that, for consistency, URI producers and\n             normalizers should use uppercase hexadecimal digits for all percent-encodings, this\n             function must always generate hexadecimal values using the upper-case letters A-F.
    All characters are escaped except those identified as \"unreserved\" by , that is the upper- and lower-case letters A-Z, the digits 0-9,\n             HYPHEN-MINUS (\"-\"), LOW LINE (\"_\"), FULL STOP \".\", and TILDE \"~\".
    This function escapes URI delimiters and therefore cannot be used indiscriminately to\n             encode \"invalid\" characters in a path segment.
    This function is invertible but not idempotent. This is because a string containing a\n             percent character will be modified by applying the function: for example\n                100% becomes 100%25, while 100%25 becomes\n                100%2525.
    \n", "summary" : "
      Encodes reserved characters in a string that is intended to be used in the path\n             segment of a URI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri-part", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "ends-with", "qname" : "fn:ends-with", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean external", "description" : " 
    Returns true if the string $arg1 contains $arg2 as a\n             trailing substring, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
    If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n                true. If the value of $arg1 is the zero-length string and\n             the value of $arg2 is not the zero-length string, then the function returns\n                false.
    The collation used by this function is determined according to the rules in .
    The function returns an xs:boolean indicating whether or not the value of\n                $arg1 starts with a sequence of collation units that provides a\n                match to the collation units of $arg2 according to the\n             collation that is used.
    \n                Match is defined in . 
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns true if the string  $arg1  contains  $arg2  as a\n             trailing substring, taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "ends-with", "qname" : "fn:ends-with", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:boolean external", "description" : " 
    Returns true if the string $arg1 contains $arg2 as a\n             trailing substring, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
    If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n                true. If the value of $arg1 is the zero-length string and\n             the value of $arg2 is not the zero-length string, then the function returns\n                false.
    The collation used by this function is determined according to the rules in .
    The function returns an xs:boolean indicating whether or not the value of\n                $arg1 starts with a sequence of collation units that provides a\n                match to the collation units of $arg2 according to the\n             collation that is used.
    \n                Match is defined in . 
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns true if the string  $arg1  contains  $arg2  as a\n             trailing substring, taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "environment-variable", "qname" : "fn:environment-variable", "signature" : "($arg as xs:string) as xs:string? external", "description" : " 
    Returns the value of a system environment variable, if it exists.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tenvironment variables.\n \t
    The set of available environment variables\n             is a set of (name, value) pairs forming part\n             of the dynamic context, in which the name is unique within the set of pairs. The name\n             and value are arbitrary strings.
    If the $name argument matches the name of one of these pairs, the function\n             returns the corresponding value.
    If there is no environment variable with a matching name, the function returns the empty\n             sequence.
    The collation used for matching names is , but\n             must be the same as the collation used to ensure that the names of all environment\n             variables are unique.
    The function is deterministic,\n             which means that if it is called several times\n          within the same execution scope, with the same arguments,\n             it must return the same result.
    On many platforms, the term \"environment variable\" has a natural meaning in terms of\n             facilities provided by the operating system. This interpretation of the concept does not\n             exclude other interpretations, such as a mapping to a set of configuration parameters in\n             a database system.
    Environment variable names are usually case sensitive. Names are usually of the form\n                (letter|_) (letter|_|digit)*, but this varies by platform.
    On some platforms, there may sometimes be multiple environment variables with the same name;\n             in this case, it is implementation-dependent as to which is returned; see for example\n                 (Chapter 8, Environment Variables).\n             Implementations may use prefixes or other naming conventions\n             to disambiguate the names.
    The requirement to ensure that the function is deterministic means in practice that\n          the implementation must make a snapshot of the environment variables at some time\n          during execution, and return values obtained from this snapshot, rather than using\n          live values that are subject to change at any time.
    Operating system environment variables may be associated with a particular process,\n          while queries and stylesheets may execute across multiple processes (or multiple machines).\n          In such circumstances implementations may choose to provide access\n          to the environment variables associated with the process in which the query or stylesheet\n          processing was initiated.
    Security advice: Queries from untrusted sources should not be permitted unrestricted\n             access to environment variables. For example, the name of the account under which the\n             query is running may be useful information to a would-be intruder. An implementation may\n             therefore choose to restrict access to the environment, or may provide a facility to\n             make fn:environment-variable always return the empty sequence.
    \n", "summary" : "
      Returns the value of a system environment variable, if it exists.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "environment-variable", "qname" : "fn:environment-variable", "signature" : "($name as xs:string) as xs:string? external", "description" : " 
    Returns the value of a system environment variable, if it exists.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tenvironment variables.\n \t
    The set of available environment variables\n             is a set of (name, value) pairs forming part\n             of the dynamic context, in which the name is unique within the set of pairs. The name\n             and value are arbitrary strings.
    If the $name argument matches the name of one of these pairs, the function\n             returns the corresponding value.
    If there is no environment variable with a matching name, the function returns the empty\n             sequence.
    The collation used for matching names is , but\n             must be the same as the collation used to ensure that the names of all environment\n             variables are unique.
    The function is deterministic,\n             which means that if it is called several times\n          within the same execution scope, with the same arguments,\n             it must return the same result.
    On many platforms, the term \"environment variable\" has a natural meaning in terms of\n             facilities provided by the operating system. This interpretation of the concept does not\n             exclude other interpretations, such as a mapping to a set of configuration parameters in\n             a database system.
    Environment variable names are usually case sensitive. Names are usually of the form\n                (letter|_) (letter|_|digit)*, but this varies by platform.
    On some platforms, there may sometimes be multiple environment variables with the same name;\n             in this case, it is implementation-dependent as to which is returned; see for example\n                 (Chapter 8, Environment Variables).\n             Implementations may use prefixes or other naming conventions\n             to disambiguate the names.
    The requirement to ensure that the function is deterministic means in practice that\n          the implementation must make a snapshot of the environment variables at some time\n          during execution, and return values obtained from this snapshot, rather than using\n          live values that are subject to change at any time.
    Operating system environment variables may be associated with a particular process,\n          while queries and stylesheets may execute across multiple processes (or multiple machines).\n          In such circumstances implementations may choose to provide access\n          to the environment variables associated with the process in which the query or stylesheet\n          processing was initiated.
    Security advice: Queries from untrusted sources should not be permitted unrestricted\n             access to environment variables. For example, the name of the account under which the\n             query is running may be useful information to a would-be intruder. An implementation may\n             therefore choose to restrict access to the environment, or may provide a facility to\n             make fn:environment-variable always return the empty sequence.
    \n", "summary" : "
      Returns the value of a system environment variable, if it exists.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "error", "qname" : "fn:error", "signature" : "() as none external", "description" : " 
    Calling the fn:error function raises an application-defined\n             error.
    This function is nondeterministic, context-independent,  and focus-independent. 
    This function never returns a value. Instead it always raises an error. The effect of\n             the error is identical to the effect of dynamic errors raised implicitly, for example\n             when an incorrect argument is supplied to a function.
    The parameters to the fn:error function supply information that is\n             associated with the error condition and that is made available to a caller that asks for\n             information about the error. The error may be caught either by the host language (using\n             a try/catch construct in XSLT or XQuery, for example), or by the calling application or\n             external processing environment. The way in which error information is returned to the\n             external processing environment is 
    If fn:error is called with no arguments, then its behavior is the same as\n             the function call: 
     fn:error(fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')) 
    If $code is the empty sequence then the effective value is the\n                xs:QName constructed by:
     fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')
    There are three pieces of information that may be associated with an error:
    The $code is an error code that distinguishes this error from others.\n                   It is an xs:QName; the namespace URI conventionally identifies the\n                   component, subsystem, or authority responsible for defining the meaning of the\n                   error code, while the local part identifies the specific error condition. The\n                   namespace URI http://www.w3.org/2005/xqt-errors is used for errors\n                   defined in this specification; other namespace URIs may be used for errors defined\n                   by the application.
    If the external processing environment expects the error code to be returned as a\n                   URI or a string rather than as an xs:QName, then an error code with\n                   namespace URI NS and local part LP will be returned in\n                   the form NS#LP. The namespace URI part of the error code should\n                   therefore not include a fragment identifier.
    The $description is a natural-language description of the error\n                   condition.
    The $error-object is an arbitrary value used to convey additional\n                   information about the error, and may be used in any way the application\n                   chooses.
    This function always raises a dynamic error. By default, it raises 
    \n", "summary" : "
      Calling the  fn:error  function raises an application-defined\n             error.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "none", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "error", "qname" : "fn:error", "signature" : "($code as xs:QName) as none external", "description" : " 
    Calling the fn:error function raises an application-defined\n             error.
    This function is nondeterministic, context-independent,  and focus-independent. 
    This function never returns a value. Instead it always raises an error. The effect of\n             the error is identical to the effect of dynamic errors raised implicitly, for example\n             when an incorrect argument is supplied to a function.
    The parameters to the fn:error function supply information that is\n             associated with the error condition and that is made available to a caller that asks for\n             information about the error. The error may be caught either by the host language (using\n             a try/catch construct in XSLT or XQuery, for example), or by the calling application or\n             external processing environment. The way in which error information is returned to the\n             external processing environment is 
    If fn:error is called with no arguments, then its behavior is the same as\n             the function call: 
     fn:error(fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')) 
    If $code is the empty sequence then the effective value is the\n                xs:QName constructed by:
     fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')
    There are three pieces of information that may be associated with an error:
    The $code is an error code that distinguishes this error from others.\n                   It is an xs:QName; the namespace URI conventionally identifies the\n                   component, subsystem, or authority responsible for defining the meaning of the\n                   error code, while the local part identifies the specific error condition. The\n                   namespace URI http://www.w3.org/2005/xqt-errors is used for errors\n                   defined in this specification; other namespace URIs may be used for errors defined\n                   by the application.
    If the external processing environment expects the error code to be returned as a\n                   URI or a string rather than as an xs:QName, then an error code with\n                   namespace URI NS and local part LP will be returned in\n                   the form NS#LP. The namespace URI part of the error code should\n                   therefore not include a fragment identifier.
    The $description is a natural-language description of the error\n                   condition.
    The $error-object is an arbitrary value used to convey additional\n                   information about the error, and may be used in any way the application\n                   chooses.
    This function always raises a dynamic error. By default, it raises 
    \n", "summary" : "
      Calling the  fn:error  function raises an application-defined\n             error.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "code", "type" : "xs:QName", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "none", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "error", "qname" : "fn:error", "signature" : "($code as xs:QName?, $description as xs:string) as none external", "description" : " 
    Calling the fn:error function raises an application-defined\n             error.
    This function is nondeterministic, context-independent,  and focus-independent. 
    This function never returns a value. Instead it always raises an error. The effect of\n             the error is identical to the effect of dynamic errors raised implicitly, for example\n             when an incorrect argument is supplied to a function.
    The parameters to the fn:error function supply information that is\n             associated with the error condition and that is made available to a caller that asks for\n             information about the error. The error may be caught either by the host language (using\n             a try/catch construct in XSLT or XQuery, for example), or by the calling application or\n             external processing environment. The way in which error information is returned to the\n             external processing environment is 
    If fn:error is called with no arguments, then its behavior is the same as\n             the function call: 
     fn:error(fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')) 
    If $code is the empty sequence then the effective value is the\n                xs:QName constructed by:
     fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')
    There are three pieces of information that may be associated with an error:
    The $code is an error code that distinguishes this error from others.\n                   It is an xs:QName; the namespace URI conventionally identifies the\n                   component, subsystem, or authority responsible for defining the meaning of the\n                   error code, while the local part identifies the specific error condition. The\n                   namespace URI http://www.w3.org/2005/xqt-errors is used for errors\n                   defined in this specification; other namespace URIs may be used for errors defined\n                   by the application.
    If the external processing environment expects the error code to be returned as a\n                   URI or a string rather than as an xs:QName, then an error code with\n                   namespace URI NS and local part LP will be returned in\n                   the form NS#LP. The namespace URI part of the error code should\n                   therefore not include a fragment identifier.
    The $description is a natural-language description of the error\n                   condition.
    The $error-object is an arbitrary value used to convey additional\n                   information about the error, and may be used in any way the application\n                   chooses.
    This function always raises a dynamic error. By default, it raises 
    \n", "summary" : "
      Calling the  fn:error  function raises an application-defined\n             error.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "code", "type" : "xs:QName", "occurrence" : "?", "description" : "" }, { "name" : "description", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "none", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "error", "qname" : "fn:error", "signature" : "($code as xs:QName?, $description as xs:string, $error-object as item()*) as none external", "description" : " 
    Calling the fn:error function raises an application-defined\n             error.
    This function is nondeterministic, context-independent,  and focus-independent. 
    This function never returns a value. Instead it always raises an error. The effect of\n             the error is identical to the effect of dynamic errors raised implicitly, for example\n             when an incorrect argument is supplied to a function.
    The parameters to the fn:error function supply information that is\n             associated with the error condition and that is made available to a caller that asks for\n             information about the error. The error may be caught either by the host language (using\n             a try/catch construct in XSLT or XQuery, for example), or by the calling application or\n             external processing environment. The way in which error information is returned to the\n             external processing environment is 
    If fn:error is called with no arguments, then its behavior is the same as\n             the function call: 
     fn:error(fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')) 
    If $code is the empty sequence then the effective value is the\n                xs:QName constructed by:
     fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')
    There are three pieces of information that may be associated with an error:
    The $code is an error code that distinguishes this error from others.\n                   It is an xs:QName; the namespace URI conventionally identifies the\n                   component, subsystem, or authority responsible for defining the meaning of the\n                   error code, while the local part identifies the specific error condition. The\n                   namespace URI http://www.w3.org/2005/xqt-errors is used for errors\n                   defined in this specification; other namespace URIs may be used for errors defined\n                   by the application.
    If the external processing environment expects the error code to be returned as a\n                   URI or a string rather than as an xs:QName, then an error code with\n                   namespace URI NS and local part LP will be returned in\n                   the form NS#LP. The namespace URI part of the error code should\n                   therefore not include a fragment identifier.
    The $description is a natural-language description of the error\n                   condition.
    The $error-object is an arbitrary value used to convey additional\n                   information about the error, and may be used in any way the application\n                   chooses.
    This function always raises a dynamic error. By default, it raises 
    \n", "summary" : "
      Calling the  fn:error  function raises an application-defined\n             error.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "code", "type" : "xs:QName", "occurrence" : "?", "description" : "" }, { "name" : "description", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "error-object", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "none", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "escape-html-uri", "qname" : "fn:escape-html-uri", "signature" : "($uri as xs:string?) as xs:string external", "description" : " 
    Escapes a URI in the same way that HTML user agents handle attribute values\n             expected to contain URIs.
    This function is deterministic, context-independent,  and focus-independent. 
    If $uri is the empty sequence, the function returns the zero-length\n             string.
    Otherwise, the function escapes all characters except\n             printable characters of the US-ASCII coded character set, specifically the codepoints between 32 and 126 (decimal) inclusive. Each\n             character in $uri to be escaped is replaced by an escape sequence, which is\n             formed by encoding the character as a sequence of octets in UTF-8, and then representing\n             each of these octets in the form %HH, where HH is the hexadecimal representation of the\n             octet. This function must always generate hexadecimal values using the upper-case\n             letters A-F.
    The behavior of this function corresponds to the recommended handling of non-ASCII\n             characters in URI attribute values as described in  Appendix\n             B.2.1.
    \n", "summary" : "
      Escapes a URI in the same way that HTML user agents handle attribute values\n             expected to contain URIs.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "exactly-one", "qname" : "fn:exactly-one", "signature" : "($arg as item()*) as item() external", "description" : " 
    Returns $arg if it contains exactly one item. Otherwise, raises an\n             error. 
    This function is deterministic, context-independent,  and focus-independent. 
    Except in error cases, the function returns $arg unchanged.
    For detailed type semantics, see [Formal Semantics].
    A dynamic error is raised  if $arg is an empty\n             sequence or a sequence containing more than one item.
    \n", "summary" : "
      Returns  $arg  if it contains exactly one item.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "exists", "qname" : "fn:exists", "signature" : "($arg as item()*) as xs:boolean external", "description" : " 
    Returns true if the argument is a non-empty sequence.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is a non-empty sequence, the function returns\n                true; otherwise, the function returns false. 
    The expression fn:exists(fn:remove((\"hello\"), 1)) returns false().
    The expression fn:exists(fn:remove((\"hello\", \"world\"), 1)) returns true().
    \n", "summary" : "
      Returns true if the argument is a non-empty sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "false", "qname" : "fn:false", "signature" : "() as xs:boolean external", "description" : " 
    Returns the xs:boolean value false.
    This function is deterministic, context-independent,  and focus-independent. 
    The result is equivalent to xs:boolean(\"0\").
    The expression fn:false() returns xs:boolean(0).
    \n", "summary" : "
      Returns the  xs:boolean  value  false .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "filter", "qname" : "fn:filter", "signature" : "($seq as item()*, $f as function (item()) as xs:boolean) as item()* external", "description" : " 
    Returns those items from the sequence $seq for which the supplied\n             function $f returns true.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function is equivalent to the following implementation in XQuery:
    \n declare function fn:filter(\n         $seq as item()*,\n         $f as function(item()) as xs:boolean)\n         as item()* {\n   if (fn:empty($seq))\n   then ()\n   else ( fn:head($seq)[$f(.) eq fn:true()],\n          fn:filter(fn:tail($seq), $f)\n        )\n };
    or its equivalent in XSLT:
    \n <xsl:function name=\"fn:filter\" as=\"item()*\">\n   <xsl:param name=\"seq\" as=\"item()*\"/>\n   <xsl:param name=\"f\" as=\"function(item()) as xs:boolean\"/>\n   <xsl:if test=\"fn:exists($seq)\">\n     <xsl:sequence select=\"fn:head($seq)[$f(.) eq fn:true()], fn:filter(fn:tail($seq), $f)\"/>\n   </xsl:if>\n </xsl:function>\n          
    As a consequence of the function signature and the function calling\n             rules, a type error occurs if the supplied function $f returns anything other\n             than a single xs:boolean item; there is no conversion to an effective\n             boolean value.
    \n", "summary" : "
      Returns those items from the sequence  $seq  for which the supplied\n             function  $f  returns true.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "f", "type" : "function (item()) as xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "floor", "qname" : "fn:floor", "signature" : "($arg as numeric?) as numeric? external", "description" : " 
    Rounds $arg downwards to a whole number.
    This function is deterministic, context-independent,  and focus-independent. 
    General rules: see .
    The function returns the largest (closest to positive infinity) number with no\n             fractional part that is not greater than the value of $arg.
    If the type of $arg is one of the four numeric types xs:float,\n                xs:double, xs:decimal or xs:integer the type\n             of the result is the same as the type of $arg. If the type of\n                $arg is a type derived from one of the numeric types, the result is an\n             instance of the base numeric type.
    For xs:float and xs:double arguments, if the argument is\n             positive zero, then positive zero is returned. If the argument is negative zero, then\n             negative zero is returned.
    For detailed type semantics, see [Formal Semantics].
    The expression fn:floor(10.5) returns 10.
    The expression fn:floor(-10.5) returns -11.
    \n", "summary" : "
      Rounds  $arg  downwards to a whole number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "numeric", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "numeric?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "fold-left", "qname" : "fn:fold-left", "signature" : "($seq as item()*, $zero as item()*, $f as function (item()*, item()) as item()*) as item()* external", "description" : " 
    Processes the supplied sequence from left to right, applying the supplied\n             function repeatedly to each item in turn, together with an accumulated result value.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function is equivalent to the following implementation in XQuery:
    \n declare function fn:fold-left(\n         $seq as item()*\n         $zero as item()*,\n         $f as function(item()*, item()) as item()*)\n         as item()* {\n   if (fn:empty($seq))\n   then $zero\n   else fn:fold-left(fn:tail($seq), $f($zero, fn:head($seq)), $f)\n };
    or its equivalent in XSLT:
    \n <xsl:function name=\"fn:fold-left\" as=\"item()*\">\n   <xsl:param name=\"seq\" as=\"item()*\"/>\n   <xsl:param name=\"zero\" as=\"item()*\"/>\n   <xsl:param name=\"f\" as=\"function(item()*, item()) as item()*\"/>\n   <xsl:choose>\n     <xsl:when test=\"fn:empty($seq)\">\n       <xsl:sequence select=\"$zero\"/>\n     </xsl:when>\n     <xsl:otherwise>\n       <xsl:sequence select=\"fn:fold-left(fn:tail($seq), $f($zero, fn:head($seq)), $f)\"/>\n     </xsl:otherwise>\n   </xsl:choose>\n </xsl:function>\n          
    As a consequence of the function signature and the function calling\n             rules, a type error occurs if the supplied function $f cannot be applied to\n             two arguments, where the first argument is either the value of $zero or the\n             result of a previous application of $f, and the second is $seq or\n             any trailing subsequence of $seq.
    \n", "summary" : "
      Processes the supplied sequence from left to right, applying the supplied\n             function repeatedly to each item in turn, together with an accumulated result value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "zero", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "f", "type" : "function (item()*, item()) as item()*", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "fold-right", "qname" : "fn:fold-right", "signature" : "($seq as item()*, $zero as item()*, $f as function (item()*, item()) as item()*) as item()* external", "description" : " 
    Processes the supplied sequence from right to left, applying the supplied\n             function repeatedly to each item in turn, together with an accumulated result value.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function is equivalent to the following implementation in XQuery:
    \n declare function fn:fold-right(\n         $seq as item()*,\n         $zero as item()*,\n         $f as function(item(), item()*) as item()*)\n         as item()* {\n   if (fn:empty($seq))\n   then $zero\n   else $f(fn:head($seq), fn:fold-right(fn:tail($seq), $zero, $f))\n };
    or its equivalent in XSLT:
    \n <xsl:function name=\"fn:fold-right\" as=\"item()*\">\n   <xsl:param name=\"seq\" as=\"item()*\"/>\n   <xsl:param name=\"zero\" as=\"item()*\"/>\n   <xsl:param name=\"f\" as=\"function(item(), item()*) as item()*\"/>\n   <xsl:choose>\n     <xsl:when test=\"fn:empty($seq)\">\n       <xsl:sequence select=\"$zero\"/>\n     </xsl:when>\n     <xsl:otherwise>\n       <xsl:sequence select=\"$f(fn:head($seq), fn:fold-right(fn:tail($seq), $zero, $f))\"/>\n     </xsl:otherwise>\n   </xsl:choose>\n </xsl:function>\n          
    As a consequence of the function signature and the function calling\n             rules, a type error occurs if the supplied function $f cannot be applied to\n             two arguments, where the first argument is any item in the sequence $seq, and\n             the second is either the value of $zero or the result of a previous\n             application of $f.
    \n", "summary" : "
      Processes the supplied sequence from right to left, applying the supplied\n             function repeatedly to each item in turn, together with an accumulated result value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "zero", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "f", "type" : "function (item()*, item()) as item()*", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "for-each-pair", "qname" : "fn:for-each-pair", "signature" : "($seq1 as item()*, $seq2 as item()*, $f as function (item(), item()) as item()*) as item()* external", "description" : " 
    Applies the function item $f to successive pairs of items taken one\n             from $seq1 and one from $seq2, returning the concatenation of the\n             resulting sequences in order.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function is equivalent to the following implementation in XQuery:
    \n declare function fn:for-each-pair($seq1, $seq2, $f)\n {\n    if(fn:exists($seq1) and fn:exists($seq2))\n    then (\n      $f(fn:head($seq1), fn:head($seq2)),\n      fn:for-each-pair(fn:tail($seq1), fn:tail($seq2), $f)\n    )\n    else ()\n };
    or its equivalent in XSLT:
    \n <xsl:function name=\"fn:for-each-pair\">\n   <xsl:param name=\"seq1/>\n   <xsl:param name=\"seq2/>\n   <xsl:param name=\"f\"/>\n   <xsl:if test=\"fn:exists($seq1) and fn:exists($seq2)\">\n     <xsl:sequence select=\"$f(fn:head($seq1), fn:head($seq2))\"/>\n     <xsl:sequence select=\"fn:for-each-pair(fn:tail($seq1), fn:tail($seq2), $f)\"/>\n   </xsl:if>\n </xsl:function>\n          
    The expression fn:for-each-pair((\"a\", \"b\", \"c\"), (\"x\", \"y\", \"z\"), concat#2) returns (\"ax\", \"by\", \"cz\").
    The expression fn:for-each-pair(1 to 5, 1 to 5, function($a, $b){10*$a + $b} returns (11, 22, 33, 44, 55).
    \n", "summary" : "
      Applies the function item  $f  to successive pairs of items taken one\n             from  $seq1  and one from  $seq2 , returning the concatenation of the\n             resulting sequences in order.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "seq2", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "f", "type" : "function (item(), item()) as item()*", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "for-each", "qname" : "fn:for-each", "signature" : "($seq as item()*, $f as function (item()) as item()*) as item()* external", "description" : " 
    Applies the function item $f to every item from the sequence\n                $seq in turn, returning the concatenation of the resulting sequences in\n             order.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function is equivalent to the following implementation in XQuery:
    \n declare function fn:for-each($seq, $f) {\n   if (fn:empty($seq))\n   then ()\n   else ($f(fn:head($seq)), fn:for-each(fn:tail($seq), $f))\n };
    or its equivalent in XSLT:
    \n <xsl:function name=\"fn:for-each\">\n   <xsl:param name=\"seq\"/>\n   <xsl:param name=\"f\"/>\n   <xsl:if test=\"fn:exists($seq)\">\n     <xsl:sequence select=\"$f(fn:head($seq)), fn:for-each(fn:tail($seq), $f)\"/>\n   </xsl:if>\n </xsl:function>\n          
    The function call fn:for-each($SEQ, $F) is equivalent to the expression\n                for $i in $SEQ return $F($i), assuming that\n                ordering mode is ordered.
    \n", "summary" : "
      Applies the function item  $f  to every item from the sequence\n                 $seq  in turn, returning the concatenation of the resulting sequences in\n             order.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "f", "type" : "function (item()) as item()*", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-date", "qname" : "fn:format-date", "signature" : "($value as xs:date?, $picture as xs:string) as xs:string? external", "description" : " 
    Returns a string containing an xs:date value formatted for display.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault calendar, and default language, and default place, and implicit timezone.\n \t
    The five-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone, and namespaces.\n \t
    See .
    \n", "summary" : "
      Returns a string containing an  xs:date  value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:date", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "format-date", "qname" : "fn:format-date", "signature" : "($value as xs:date?, $picture as xs:string, $language as xs:string?, $calendar as xs:string?, $place as xs:string?) as xs:string? external", "description" : " 
    Returns a string containing an xs:date value formatted for display.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault calendar, and default language, and default place, and implicit timezone.\n \t
    The five-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone, and namespaces.\n \t
    See .
    \n", "summary" : "
      Returns a string containing an  xs:date  value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:date", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "language", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "calendar", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "place", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-dateTime", "qname" : "fn:format-dateTime", "signature" : "($value as xs:dateTime?, $picture as xs:string) as xs:string? external", "description" : " 
    Returns a string containing an xs:dateTime value formatted for display.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault calendar, and default language, and default place, and implicit timezone.\n \t
    The five-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone, and namespaces.\n \t
    See .
    \n", "summary" : "
      Returns a string containing an  xs:dateTime  value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:dateTime", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "format-dateTime", "qname" : "fn:format-dateTime", "signature" : "($value as xs:dateTime?, $picture as xs:string, $language as xs:string?, $calendar as xs:string?, $place as xs:string?) as xs:string? external", "description" : " 
    Returns a string containing an xs:dateTime value formatted for display.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault calendar, and default language, and default place, and implicit timezone.\n \t
    The five-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone, and namespaces.\n \t
    See .
    \n", "summary" : "
      Returns a string containing an  xs:dateTime  value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:dateTime", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "language", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "calendar", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "place", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-integer", "qname" : "fn:format-integer", "signature" : "($value as xs:integer?, $picture as xs:string) as xs:string external", "description" : " 
    Formats an integer according to a given picture string, using the conventions\n             of a given natural language if specified.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault language.\n \t
    The three-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If $value is an empty sequence, the function returns a zero-length\n             string.
    In all other cases, the $picture argument describes the format in which\n                $value is output.
    The rules that follow describe how non-negative numbers are output. If the value of\n                $value is negative, the rules below are applied to the absolute value of\n                $value, and a minus sign is prepended to the result.
    The value of $picture consists of a primary format token,\n             optionally followed\n             by a format modifier. The primary format token is always present and must not\n             be zero-length. If the string contains one or more semicolons then everything that\n             precedes the last semicolon is taken as the primary format token and everything\n             that follows is taken as the format modifier; if the string contains no\n             semicolon then the entire picture is taken as the primary format token, and the\n             format modifier is taken to be absent (which is equivalent to supplying a\n             zero-length string).
    The primary format token is classified as one of the following:
    A decimal-digit-pattern made up of optional-digit-signs,\n                      mandatory-digit-signs, and grouping-separator-signs.
    The optional-digit-sign is the character \"#\".
    A mandatory-digit-sign is a character in Unicode category Nd. All\n                            mandatory-digit-signs within the format token must be from the\n                         same digit family, where a digit family is a sequence of ten consecutive\n                         characters in Unicode category Nd, having digit values 0 through 9. Within\n                         the format token, these digits are interchangeable: a three-digit number may\n                         thus be indicated equivalently by 000, 001, or\n                            999.
    a grouping-separator-sign is a non-alphanumeric character, that\n                         is a character whose Unicode category is\n                         other than Nd, Nl, No, Lu, Ll, Lt, Lm or Lo.
    If the primary format token contains at least one Unicode digit\n                   then it is taken as a decimal digit pattern, and in this case it must\n                   match the regular expression ^((\\p{Nd}|#|[^\\p{N}\\p{L}])+?)$. If it contains\n                   a digit but does not match this pattern, a dynamic error\n                   is raised .
    If a semicolon is to be used as a grouping separator, then the primary\n                format token as a whole must be followed by another semicolon, to ensure that\n                the grouping separator is not mistaken as a separator between the primary format\n                token and the format modifier.
    There must be at least one mandatory-digit-sign. There may be zero or\n                   more optional-digit-signs, and (if present) these must precede all\n                      mandatory-digit-signs. There may be zero or more\n                      grouping-separator-signs. A grouping-separator-sign must\n                   not appear at the start or end of the decimal-digit-pattern, nor\n                   adjacent to another grouping-separator-sign.
    The corresponding output format is a decimal number, using this digit family, with\n                   at least as many digits as there are mandatory-digit-signs in the\n                   format token. Thus, a format token 1 generates the sequence 0 1\n                      2 ... 10 11 12 ..., and a format token 01 (or equivalently,\n                      00 or 99) generates the sequence 00 01 02 ...\n                      09 10 11 12 ... 99 100 101. A format token of &#x661;\n                   (Arabic-Indic digit one) generates the sequence ١ then ٢\n                   then ٣ ...
    The grouping-separator-signs are handled as follows. The position of\n                   grouping separators within the format token, counting backwards from the last\n                   digit, indicates the position of grouping separators to appear within the\n                   formatted number, and the character used as the grouping-separator-sign\n                   within the format token indicates the character to be used as the corresponding\n                   grouping separator in the formatted number. If grouping-separator-signs\n                   appear at regular intervals within the format token, that is if the same grouping\n                   separator appears at positions forming a sequence N, 2N,\n                      3N, ... for some integer value N (including the case\n                   where there is only one number in the list), then the sequence is extrapolated to\n                   the left, so grouping separators will be used in the formatted number at every\n                   multiple of N. For example, if the format token is 0'000\n                   then the number one million will be formatted as 1'000'000, while the\n                   number fifteen will be formatted as 0'015.
    The only purpose of optional-digit-signs is to mark the position of\n                      grouping-separator-signs. For example, if the format token is\n                      #'##0 then the number one million will be formatted as\n                      1'000'000, while the number fifteen will be formatted as\n                      15. A grouping separator is included in the formatted number only\n                   if there is a digit to its left, which will only be the case if either (a) the\n                   number is large enough to require that digit, or (b) the number of\n                      mandatory-digit-signs in the format token requires insignificant\n                   leading zeros to be present.
    Numbers will never be truncated. Given the decimal-digit-pattern\n                      01, the number three hundred will be output as 300,\n                      despite the absence of any optional-digit-sign.
    The format token A, which generates the sequence A B C ... Z AA AB\n                      AC....
    The format token a, which generates the sequence a b c ... z aa ab\n                      ac....
    The format token i, which generates the sequence i ii iii iv v vi vii\n                      viii ix x ....
    The format token I, which generates the sequence I II III IV V VI VII\n                      VIII IX X ....
    The format token w, which generates numbers written as lower-case words, for\n                   example in English, one two three four ...\n                
    The format token W, which generates numbers written as upper-case words, for\n                   example in English, ONE TWO THREE FOUR ...\n                
    The format token Ww, which generates numbers written as title-case words, for\n                   example in English, One Two Three Four ...\n                
    Any other format token, which indicates a numbering sequence in which that token\n                   represents the number 1 (one) (but see the note below).\n                   \n                   It is implementation-defined which\n                   numbering sequences, additional to those listed above, are supported. If an\n                   implementation does not support a numbering sequence represented by the given\n                   token, it must use a format token of 1.
    In some traditional numbering sequences additional signs are added to denote\n                      that the letters should be interpreted as numbers; these are not included in\n                      the format token. An example (see also the example below) is classical Greek\n                      where a dexia keraia (x0374, ʹ) and sometimes an aristeri keraia\n                      (x0375, ͵) is added.
    For all format tokens other than the first kind above (one that consists of decimal\n             digits), there may be implementation-defined lower and upper bounds on the range of numbers that\n             can be formatted using this format token; indeed, for some numbering sequences there may\n             be intrinsic limits. For example, the format token &#x2460; (circled\n             digit one, ①) has a range imposed by the Unicode character repertoire — 1 to 20 in\n             Unicode versions prior to 4.0, increased in subsequent versions. For\n             the numbering sequences described above any upper bound imposed by the implementation\n                must not be less than 1000 (one thousand) and any lower bound must\n             not be greater than 1. Numbers that fall outside this range must be\n             formatted using the format token 1.
    The above expansions of numbering sequences for format tokens such as a and\n                i are indicative but not prescriptive. There are various conventions in\n             use for how alphabetic sequences continue when the alphabet is exhausted, and differing\n             conventions for how roman numerals are written (for example, IV versus\n                IIII as the representation of the number 4). Sometimes alphabetic\n             sequences are used that omit letters such as i and o. This\n             specification does not prescribe the detail of any sequence other than those sequences\n             consisting entirely of decimal digits.
    Many numbering sequences are language-sensitive. This applies especially to the sequence\n             selected by the tokens w, W and Ww. It also\n             applies to other sequences, for example different languages using the Cyrillic alphabet\n             use different sequences of characters, each starting with the letter #x410 (Cyrillic\n             capital letter A). In such cases, the $lang argument specifies which\n             language's conventions are to be used. If the argument\n             is specified, the value should be either an empty sequence\n             or a value that would be valid for the xml:lang attribute (see ).\n             Note that this permits the identification of sublanguages based on country codes (from ISO 3166-1)\n             as well as identification of dialects and regions within a country..
    The set of languages\n             for which numbering is supported is .\n             If the $lang argument is absent,\n             or is set to an empty sequence, or is invalid, or is not a language supported by the\n             implementation, then the number is formatted using the\n             default language from the dynamic context.\n             
    The format modifier must\n             be a string that matches the regular expression ^([co](\\(.+\\))?)?[at]?$. \n             That is, if it is present it must consist of one or more of\n             the following, in any order:
    either c or o, optionally followed by\n                   a sequence of characters enclosed between parentheses, to indicate cardinal or\n                   ordinal numbering respectively, the default being cardinal numbering
    either a or t, to indicate alphabetic\n                   or traditional numbering respectively, the default being implementation-defined.
    If the o modifier is present, this indicates a request to output ordinal\n             numbers rather than cardinal numbers. For example, in English, when used with the format\n             token 1, this outputs the sequence 1st 2nd 3rd 4th ..., and\n             when used with the format token w outputs the sequence first second\n             third fourth ....
    The string of characters between the parentheses, if present, is used to\n          select between other possible variations of cardinal or ordinal numbering sequences.\n          The interpretation of this string is implementation-defined. No error occurs\n          if the implementation does not define any interpretation for the defined string.
    For example, in some languages, ordinal numbers vary depending on the grammatical context:\n             they may have different genders and may decline with the noun that they qualify.\n             In such cases the string appearing in parentheses after the letter o may be\n             used to indicate the variation of the ordinal number required. The way in which the\n             variation is indicated will depend on the conventions of the language. For inflected\n             languages that vary the ending of the word, the recommended approach is to indicate the\n             required ending, preceded by a hyphen: for example in German, appropriate values are\n                o(-e), o(-er), o(-es), o(-en). 
    It is implementation-defined what\n             combinations of values of the format token, the language, and the cardinal/ordinal\n             modifier are supported. If ordinal numbering is not supported for the combination of the\n             format token, the language, and the string appearing in parentheses, the request is\n             ignored and cardinal numbers are generated instead.
    Ordinal Numbering in Italian
    The specification \"1;o(-º)\" with $lang equal to\n                   it, if supported, should produce the sequence:
    1º 2º 3º 4º ...
    The specification \"Ww;o\" with $lang equal to\n                   it, if supported, should produce the sequence:
    Primo Secondo Terzo Quarto Quinto ...
    The use of the a or t\n                modifier disambiguates between numbering sequences that use letters. In many\n             languages there are two commonly used numbering sequences that use letters. One\n             numbering sequence assigns numeric values to letters in alphabetic sequence, and the\n             other assigns numeric values to each letter in some other manner traditional in that\n             language. In English, these would correspond to the numbering sequences specified by the\n             format tokens a and i. In some languages, the first member of\n             each sequence is the same, and so the format token alone would be ambiguous. In the absence of the a or t modifier,\n                the default is implementation-defined.
    A dynamic error is raised  if the format token is invalid,\n             that is, if it violates any mandatory rules (indicated by an emphasized must\n             or required keyword in the above rules). For example, the error is raised if\n             the primary format token contains a digit but does not match the required regular expression.
    \n", "summary" : "
      Formats an integer according to a given picture string, using the conventions\n             of a given natural language if specified.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:integer", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "format-integer", "qname" : "fn:format-integer", "signature" : "($value as xs:integer?, $picture as xs:string, $language as xs:string) as xs:string external", "description" : " 
    Formats an integer according to a given picture string, using the conventions\n             of a given natural language if specified.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault language.\n \t
    The three-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If $value is an empty sequence, the function returns a zero-length\n             string.
    In all other cases, the $picture argument describes the format in which\n                $value is output.
    The rules that follow describe how non-negative numbers are output. If the value of\n                $value is negative, the rules below are applied to the absolute value of\n                $value, and a minus sign is prepended to the result.
    The value of $picture consists of a primary format token,\n             optionally followed\n             by a format modifier. The primary format token is always present and must not\n             be zero-length. If the string contains one or more semicolons then everything that\n             precedes the last semicolon is taken as the primary format token and everything\n             that follows is taken as the format modifier; if the string contains no\n             semicolon then the entire picture is taken as the primary format token, and the\n             format modifier is taken to be absent (which is equivalent to supplying a\n             zero-length string).
    The primary format token is classified as one of the following:
    A decimal-digit-pattern made up of optional-digit-signs,\n                      mandatory-digit-signs, and grouping-separator-signs.
    The optional-digit-sign is the character \"#\".
    A mandatory-digit-sign is a character in Unicode category Nd. All\n                            mandatory-digit-signs within the format token must be from the\n                         same digit family, where a digit family is a sequence of ten consecutive\n                         characters in Unicode category Nd, having digit values 0 through 9. Within\n                         the format token, these digits are interchangeable: a three-digit number may\n                         thus be indicated equivalently by 000, 001, or\n                            999.
    a grouping-separator-sign is a non-alphanumeric character, that\n                         is a character whose Unicode category is\n                         other than Nd, Nl, No, Lu, Ll, Lt, Lm or Lo.
    If the primary format token contains at least one Unicode digit\n                   then it is taken as a decimal digit pattern, and in this case it must\n                   match the regular expression ^((\\p{Nd}|#|[^\\p{N}\\p{L}])+?)$. If it contains\n                   a digit but does not match this pattern, a dynamic error\n                   is raised .
    If a semicolon is to be used as a grouping separator, then the primary\n                format token as a whole must be followed by another semicolon, to ensure that\n                the grouping separator is not mistaken as a separator between the primary format\n                token and the format modifier.
    There must be at least one mandatory-digit-sign. There may be zero or\n                   more optional-digit-signs, and (if present) these must precede all\n                      mandatory-digit-signs. There may be zero or more\n                      grouping-separator-signs. A grouping-separator-sign must\n                   not appear at the start or end of the decimal-digit-pattern, nor\n                   adjacent to another grouping-separator-sign.
    The corresponding output format is a decimal number, using this digit family, with\n                   at least as many digits as there are mandatory-digit-signs in the\n                   format token. Thus, a format token 1 generates the sequence 0 1\n                      2 ... 10 11 12 ..., and a format token 01 (or equivalently,\n                      00 or 99) generates the sequence 00 01 02 ...\n                      09 10 11 12 ... 99 100 101. A format token of &#x661;\n                   (Arabic-Indic digit one) generates the sequence ١ then ٢\n                   then ٣ ...
    The grouping-separator-signs are handled as follows. The position of\n                   grouping separators within the format token, counting backwards from the last\n                   digit, indicates the position of grouping separators to appear within the\n                   formatted number, and the character used as the grouping-separator-sign\n                   within the format token indicates the character to be used as the corresponding\n                   grouping separator in the formatted number. If grouping-separator-signs\n                   appear at regular intervals within the format token, that is if the same grouping\n                   separator appears at positions forming a sequence N, 2N,\n                      3N, ... for some integer value N (including the case\n                   where there is only one number in the list), then the sequence is extrapolated to\n                   the left, so grouping separators will be used in the formatted number at every\n                   multiple of N. For example, if the format token is 0'000\n                   then the number one million will be formatted as 1'000'000, while the\n                   number fifteen will be formatted as 0'015.
    The only purpose of optional-digit-signs is to mark the position of\n                      grouping-separator-signs. For example, if the format token is\n                      #'##0 then the number one million will be formatted as\n                      1'000'000, while the number fifteen will be formatted as\n                      15. A grouping separator is included in the formatted number only\n                   if there is a digit to its left, which will only be the case if either (a) the\n                   number is large enough to require that digit, or (b) the number of\n                      mandatory-digit-signs in the format token requires insignificant\n                   leading zeros to be present.
    Numbers will never be truncated. Given the decimal-digit-pattern\n                      01, the number three hundred will be output as 300,\n                      despite the absence of any optional-digit-sign.
    The format token A, which generates the sequence A B C ... Z AA AB\n                      AC....
    The format token a, which generates the sequence a b c ... z aa ab\n                      ac....
    The format token i, which generates the sequence i ii iii iv v vi vii\n                      viii ix x ....
    The format token I, which generates the sequence I II III IV V VI VII\n                      VIII IX X ....
    The format token w, which generates numbers written as lower-case words, for\n                   example in English, one two three four ...\n                
    The format token W, which generates numbers written as upper-case words, for\n                   example in English, ONE TWO THREE FOUR ...\n                
    The format token Ww, which generates numbers written as title-case words, for\n                   example in English, One Two Three Four ...\n                
    Any other format token, which indicates a numbering sequence in which that token\n                   represents the number 1 (one) (but see the note below).\n                   \n                   It is implementation-defined which\n                   numbering sequences, additional to those listed above, are supported. If an\n                   implementation does not support a numbering sequence represented by the given\n                   token, it must use a format token of 1.
    In some traditional numbering sequences additional signs are added to denote\n                      that the letters should be interpreted as numbers; these are not included in\n                      the format token. An example (see also the example below) is classical Greek\n                      where a dexia keraia (x0374, ʹ) and sometimes an aristeri keraia\n                      (x0375, ͵) is added.
    For all format tokens other than the first kind above (one that consists of decimal\n             digits), there may be implementation-defined lower and upper bounds on the range of numbers that\n             can be formatted using this format token; indeed, for some numbering sequences there may\n             be intrinsic limits. For example, the format token &#x2460; (circled\n             digit one, ①) has a range imposed by the Unicode character repertoire — 1 to 20 in\n             Unicode versions prior to 4.0, increased in subsequent versions. For\n             the numbering sequences described above any upper bound imposed by the implementation\n                must not be less than 1000 (one thousand) and any lower bound must\n             not be greater than 1. Numbers that fall outside this range must be\n             formatted using the format token 1.
    The above expansions of numbering sequences for format tokens such as a and\n                i are indicative but not prescriptive. There are various conventions in\n             use for how alphabetic sequences continue when the alphabet is exhausted, and differing\n             conventions for how roman numerals are written (for example, IV versus\n                IIII as the representation of the number 4). Sometimes alphabetic\n             sequences are used that omit letters such as i and o. This\n             specification does not prescribe the detail of any sequence other than those sequences\n             consisting entirely of decimal digits.
    Many numbering sequences are language-sensitive. This applies especially to the sequence\n             selected by the tokens w, W and Ww. It also\n             applies to other sequences, for example different languages using the Cyrillic alphabet\n             use different sequences of characters, each starting with the letter #x410 (Cyrillic\n             capital letter A). In such cases, the $lang argument specifies which\n             language's conventions are to be used. If the argument\n             is specified, the value should be either an empty sequence\n             or a value that would be valid for the xml:lang attribute (see ).\n             Note that this permits the identification of sublanguages based on country codes (from ISO 3166-1)\n             as well as identification of dialects and regions within a country..
    The set of languages\n             for which numbering is supported is .\n             If the $lang argument is absent,\n             or is set to an empty sequence, or is invalid, or is not a language supported by the\n             implementation, then the number is formatted using the\n             default language from the dynamic context.\n             
    The format modifier must\n             be a string that matches the regular expression ^([co](\\(.+\\))?)?[at]?$. \n             That is, if it is present it must consist of one or more of\n             the following, in any order:
    either c or o, optionally followed by\n                   a sequence of characters enclosed between parentheses, to indicate cardinal or\n                   ordinal numbering respectively, the default being cardinal numbering
    either a or t, to indicate alphabetic\n                   or traditional numbering respectively, the default being implementation-defined.
    If the o modifier is present, this indicates a request to output ordinal\n             numbers rather than cardinal numbers. For example, in English, when used with the format\n             token 1, this outputs the sequence 1st 2nd 3rd 4th ..., and\n             when used with the format token w outputs the sequence first second\n             third fourth ....
    The string of characters between the parentheses, if present, is used to\n          select between other possible variations of cardinal or ordinal numbering sequences.\n          The interpretation of this string is implementation-defined. No error occurs\n          if the implementation does not define any interpretation for the defined string.
    For example, in some languages, ordinal numbers vary depending on the grammatical context:\n             they may have different genders and may decline with the noun that they qualify.\n             In such cases the string appearing in parentheses after the letter o may be\n             used to indicate the variation of the ordinal number required. The way in which the\n             variation is indicated will depend on the conventions of the language. For inflected\n             languages that vary the ending of the word, the recommended approach is to indicate the\n             required ending, preceded by a hyphen: for example in German, appropriate values are\n                o(-e), o(-er), o(-es), o(-en). 
    It is implementation-defined what\n             combinations of values of the format token, the language, and the cardinal/ordinal\n             modifier are supported. If ordinal numbering is not supported for the combination of the\n             format token, the language, and the string appearing in parentheses, the request is\n             ignored and cardinal numbers are generated instead.
    Ordinal Numbering in Italian
    The specification \"1;o(-º)\" with $lang equal to\n                   it, if supported, should produce the sequence:
    1º 2º 3º 4º ...
    The specification \"Ww;o\" with $lang equal to\n                   it, if supported, should produce the sequence:
    Primo Secondo Terzo Quarto Quinto ...
    The use of the a or t\n                modifier disambiguates between numbering sequences that use letters. In many\n             languages there are two commonly used numbering sequences that use letters. One\n             numbering sequence assigns numeric values to letters in alphabetic sequence, and the\n             other assigns numeric values to each letter in some other manner traditional in that\n             language. In English, these would correspond to the numbering sequences specified by the\n             format tokens a and i. In some languages, the first member of\n             each sequence is the same, and so the format token alone would be ambiguous. In the absence of the a or t modifier,\n                the default is implementation-defined.
    A dynamic error is raised  if the format token is invalid,\n             that is, if it violates any mandatory rules (indicated by an emphasized must\n             or required keyword in the above rules). For example, the error is raised if\n             the primary format token contains a digit but does not match the required regular expression.
    \n", "summary" : "
      Formats an integer according to a given picture string, using the conventions\n             of a given natural language if specified.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:integer", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "language", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-number", "qname" : "fn:format-number", "signature" : "($value as numeric?, $picture as xs:string) as xs:string external", "description" : " 
    Returns a string containing a number formatted according to a given picture\n             string, taking account of decimal formats specified in the static context.
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdecimal formats, and namespaces.\n \t
    The effect of the two-argument form of the function is equivalent to calling\n          the three-argument form with an empty sequence as the value of the third argument.
    The function formats $value as a string using the picture string specified by the\n                $picture argument and the decimal-format named by the\n                $decimal-format-name argument, or the default decimal-format, if there\n             is no $decimal-format-name argument. The syntax of the picture string is\n             described in .
    The $value argument may be of any numeric data type\n             (xs:double, xs:float, xs:decimal, or their\n             subtypes including xs:integer). Note that if an xs:decimal is\n             supplied, it is not automatically promoted to an xs:double, as such\n             promotion can involve a loss of precision.
    If the supplied value of the $value argument is an empty sequence, the\n             function behaves as if the supplied value were the xs:double value\n                NaN.
    The value of $decimal-format-name,\n             if present and non-empty, \n             must be a string which after removal of leading and trailing whitespace is in the form of an\n             an EQName as defined in the XPath 3.0 grammar, that is one of the following:
    A lexical QName, which is expanded using the\n                statically known namespaces.\n                The default namespace is not used (no prefix means no namespace).
    A URIQualifiedName using the syntax Q{uri}local,\n             where the URI can be zero-length to indicate a name in no namespace.
    The decimal format that is used is the decimal format\n          in the static context whose name matches $decimal-format-name if supplied,\n          or the default decimal format in the static context otherwise.
    The evaluation of the format-number function takes place in two\n             phases, an analysis phase described in  and a\n             formatting phase described in .
    The analysis phase takes as its inputs the picture\n                string and the variables derived from the relevant decimal format in the\n             static context, and produces as its output a number of variables with defined values.\n             The formatting phase takes as its inputs the number to be formatted and the variables\n             produced by the analysis phase, and produces as its output a string containing a\n             formatted representation of the number.
    The result of the function is the formatted string representation of the supplied\n             number.
    A dynamic error is raised  if the name specified as the\n                $decimal-format-name argument is\n             neither a valid lexical QName nor a valid URIQualifiedName, or if it\n             uses a prefix that is not found in the statically known namespaces, or if the static\n             context does not contain a declaration of a decimal-format with a matching expanded\n             QName. If the processor is able to detect the error statically (for example, when the\n             argument is supplied as a string literal), then the processor may\n             optionally signal this as a static error.
    \n", "summary" : "
      Returns a string containing a number formatted according to a given picture\n             string, taking account of decimal formats specified in the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "numeric", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "format-number", "qname" : "fn:format-number", "signature" : "($value as numeric?, $picture as xs:string, $decimal-format-name as xs:string) as xs:string external", "description" : " 
    Returns a string containing a number formatted according to a given picture\n             string, taking account of decimal formats specified in the static context.
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdecimal formats, and namespaces.\n \t
    The effect of the two-argument form of the function is equivalent to calling\n          the three-argument form with an empty sequence as the value of the third argument.
    The function formats $value as a string using the picture string specified by the\n                $picture argument and the decimal-format named by the\n                $decimal-format-name argument, or the default decimal-format, if there\n             is no $decimal-format-name argument. The syntax of the picture string is\n             described in .
    The $value argument may be of any numeric data type\n             (xs:double, xs:float, xs:decimal, or their\n             subtypes including xs:integer). Note that if an xs:decimal is\n             supplied, it is not automatically promoted to an xs:double, as such\n             promotion can involve a loss of precision.
    If the supplied value of the $value argument is an empty sequence, the\n             function behaves as if the supplied value were the xs:double value\n                NaN.
    The value of $decimal-format-name,\n             if present and non-empty, \n             must be a string which after removal of leading and trailing whitespace is in the form of an\n             an EQName as defined in the XPath 3.0 grammar, that is one of the following:
    A lexical QName, which is expanded using the\n                statically known namespaces.\n                The default namespace is not used (no prefix means no namespace).
    A URIQualifiedName using the syntax Q{uri}local,\n             where the URI can be zero-length to indicate a name in no namespace.
    The decimal format that is used is the decimal format\n          in the static context whose name matches $decimal-format-name if supplied,\n          or the default decimal format in the static context otherwise.
    The evaluation of the format-number function takes place in two\n             phases, an analysis phase described in  and a\n             formatting phase described in .
    The analysis phase takes as its inputs the picture\n                string and the variables derived from the relevant decimal format in the\n             static context, and produces as its output a number of variables with defined values.\n             The formatting phase takes as its inputs the number to be formatted and the variables\n             produced by the analysis phase, and produces as its output a string containing a\n             formatted representation of the number.
    The result of the function is the formatted string representation of the supplied\n             number.
    A dynamic error is raised  if the name specified as the\n                $decimal-format-name argument is\n             neither a valid lexical QName nor a valid URIQualifiedName, or if it\n             uses a prefix that is not found in the statically known namespaces, or if the static\n             context does not contain a declaration of a decimal-format with a matching expanded\n             QName. If the processor is able to detect the error statically (for example, when the\n             argument is supplied as a string literal), then the processor may\n             optionally signal this as a static error.
    \n", "summary" : "
      Returns a string containing a number formatted according to a given picture\n             string, taking account of decimal formats specified in the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "numeric", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "decimal-format-name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-time", "qname" : "fn:format-time", "signature" : "($value as xs:time?, $picture as xs:string) as xs:string? external", "description" : " 
    Returns a string containing an xs:time value formatted for display.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault calendar, and default language, and default place, and implicit timezone.\n \t
    The five-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone, and namespaces.\n \t
    See .
    \n", "summary" : "
      Returns a string containing an  xs:time  value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:time", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "format-time", "qname" : "fn:format-time", "signature" : "($value as xs:time?, $picture as xs:string, $language as xs:string?, $calendar as xs:string?, $place as xs:string?) as xs:string? external", "description" : " 
    Returns a string containing an xs:time value formatted for display.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tdefault calendar, and default language, and default place, and implicit timezone.\n \t
    The five-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone, and namespaces.\n \t
    See .
    \n", "summary" : "
      Returns a string containing an  xs:time  value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:time", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "language", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "calendar", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "place", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "function-arity", "qname" : "fn:function-arity", "signature" : "($func as function (*)) as xs:integer external", "description" : " 
    Returns the arity of the function identified by a function item.
    This function is deterministic, context-independent,  and focus-independent. 
    The fn:function-arity function returns the arity (number of arguments) of\n             the function identified by $func.
    The expression fn:function-arity(fn:substring#2) returns 2.
    The expression fn:function-arity(function($node){name($node)}) returns 1.
    The expression let $initial := fn:substring(?, 1, 1) return fn:function-arity($initial) returns 1.
    \n", "summary" : "
      Returns the arity of the function identified by a function item.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "func", "type" : "function (*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "generate-id", "qname" : "fn:generate-id", "signature" : "() as xs:string external", "description" : " 
    This function returns a string that uniquely identifies a given node. 
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the argument is the empty sequence, the result is the zero-length string.
    In other cases, the function returns a string that uniquely identifies a given node.
    The returned identifier must consist of ASCII alphanumeric characters\n             and must start with an alphabetic character. Thus, the string is\n             syntactically an XML name.
    An implementation is free to generate an identifier in any convenient way provided that\n             it always generates the same identifier for the same node and that different identifiers\n             are always generated from different nodes. An implementation is under no obligation to\n             generate the same identifiers each time a document is transformed or queried.
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      This function returns a string that uniquely identifies a given node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "generate-id", "qname" : "fn:generate-id", "signature" : "($arg as node()?) as xs:string external", "description" : " 
    This function returns a string that uniquely identifies a given node. 
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the argument is the empty sequence, the result is the zero-length string.
    In other cases, the function returns a string that uniquely identifies a given node.
    The returned identifier must consist of ASCII alphanumeric characters\n             and must start with an alphabetic character. Thus, the string is\n             syntactically an XML name.
    An implementation is free to generate an identifier in any convenient way provided that\n             it always generates the same identifier for the same node and that different identifiers\n             are always generated from different nodes. An implementation is under no obligation to\n             generate the same identifiers each time a document is transformed or queried.
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      This function returns a string that uniquely identifies a given node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "has-children", "qname" : "fn:has-children", "signature" : "() as xs:boolean external", "description" : " 
    Returns true if the supplied node has one or more child nodes (of any kind).
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    Provided that the supplied argument $node matches the expected\n          type node()?, the result of the function call fn:has-children($node) is defined to be\n             the same as the result of the expression\n             fn:exists($node/child::node()).
    The following errors may be raised when $node is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns true if the supplied node has one or more child nodes (of any kind).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "has-children", "qname" : "fn:has-children", "signature" : "($node as node()?) as xs:boolean external", "description" : " 
    Returns true if the supplied node has one or more child nodes (of any kind).
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    Provided that the supplied argument $node matches the expected\n          type node()?, the result of the function call fn:has-children($node) is defined to be\n             the same as the result of the expression\n             fn:exists($node/child::node()).
    The following errors may be raised when $node is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns true if the supplied node has one or more child nodes (of any kind).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "head", "qname" : "fn:head", "signature" : "($arg as item()*) as item()? external", "description" : " 
    Returns the first item in a sequence. 
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns the value of the expression $arg[1]
    If $arg is the empty sequence, the empty sequence is returned. Otherwise\n             the first item in the sequence is returned.
    \n", "summary" : "
      Returns the first item in a sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hours-from-duration", "qname" : "fn:hours-from-duration", "signature" : "($arg as xs:duration?) as xs:integer? external", "description" : " 
    Returns the number of hours in a duration.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer representing the hours\n             component in the value of $arg. The result is obtained by casting\n                $arg to an xs:dayTimeDuration (see ) and then computing the hours component as described in\n                .
    If $arg is a negative duration then the result will be negative..
    If $arg is an xs:yearMonthDuration the function returns 0.
    The expression fn:hours-from-duration(xs:dayTimeDuration(\"P3DT10H\")) returns 10.
    The expression fn:hours-from-duration(xs:dayTimeDuration(\"P3DT12H32M12S\")) returns 12.
    The expression fn:hours-from-duration(xs:dayTimeDuration(\"PT123H\")) returns 3.
    The expression fn:hours-from-duration(xs:dayTimeDuration(\"-P3DT10H\")) returns -10.
    \n", "summary" : "
      Returns the number of hours in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hours-from-time", "qname" : "fn:hours-from-time", "signature" : "($arg as xs:time?) as xs:integer? external", "description" : " 
    Returns the hours component of an xs:time.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer between 0 and 23, both\n             inclusive, representing the value of the hours component in the local value of\n                $arg.
    Assume that the dynamic context provides an implicit timezone value of\n                   -05:00. 
    The expression fn:hours-from-time(xs:time(\"11:23:00\")) returns 11.
    The expression fn:hours-from-time(xs:time(\"21:23:00\")) returns 21.
    The expression fn:hours-from-time(xs:time(\"01:23:00+05:00\")) returns 1.
    The expression fn:hours-from-time(fn:adjust-time-to-timezone(xs:time(\"01:23:00+05:00\"),\n                   xs:dayTimeDuration(\"PT0S\"))) returns 20.
    The expression fn:hours-from-time(xs:time(\"24:00:00\")) returns 0.
    \n", "summary" : "
      Returns the hours component of an  xs:time .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "id", "qname" : "fn:id", "signature" : "($arg as xs:string*) as element(*)* external", "description" : " 
    Returns the sequence of element nodes that have an ID value\n             matching the value of one or more of the IDREF values supplied in\n                $arg.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence, in document order with duplicates eliminated,\n             containing every element node E that satisfies all the following\n             conditions:
    \n                   E is in the target document. The target document is the document\n                   containing $node, or the document containing the context item\n                      (.) if the second argument is omitted. The behavior of the\n                   function if $node is omitted is exactly the same as if the context\n                   item had been passed as $node.
    E has an ID value equal to one of the candidate\n                      IDREF values, where:
     An element has an ID value equal to V if either\n                         or both of the following conditions are true:
    The is-id property (See .) of the element node is true, and the typed value\n                               of the element node is equal to V under the rules of the\n                                  eq operator using the Unicode codepoint collation\n                                  (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    The element has an attribute node whose is-id property\n                               (See .) is true and whose typed\n                               value is equal to V under the rules of the\n                                  eq operator using the Unicode code point collation\n                                  (http://www.w3.org/2005/xpath-functions/collation/codepoint).
     Each xs:string in $arg is parsed as if it were of\n                         type IDREFS, that is, each xs:string in\n                            $arg is treated as a whitespace-separated sequence of\n                         tokens, each acting as an IDREF. These tokens are then included\n                         in the list of candidate IDREFs. If any of the tokens is not a\n                         lexically valid IDREF (that is, if it is not lexically an\n                            xs:NCName), it is ignored. Formally, the candidate\n                            IDREF values are the strings in the sequence given by the\n                         expression:
    for $s in $arg return\n     fn:tokenize(fn:normalize-space($s), ' ')[. castable as xs:IDREF]
    If several elements have the same ID value, then E is\n                   the one that is first in document order.
    A dynamic error is raised  if\n                $node, or the context item if the second argument is absent, is a node\n                in a tree whose root is not a document node.
    The following errors may be raised when $node is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the sequence of element nodes that have an  ID  value\n             matching the value of one or more of the  IDREF  values supplied in\n                 $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "id", "qname" : "fn:id", "signature" : "($arg as xs:string*, $node as node()) as element(*)* external", "description" : " 
    Returns the sequence of element nodes that have an ID value\n             matching the value of one or more of the IDREF values supplied in\n                $arg.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence, in document order with duplicates eliminated,\n             containing every element node E that satisfies all the following\n             conditions:
    \n                   E is in the target document. The target document is the document\n                   containing $node, or the document containing the context item\n                      (.) if the second argument is omitted. The behavior of the\n                   function if $node is omitted is exactly the same as if the context\n                   item had been passed as $node.
    E has an ID value equal to one of the candidate\n                      IDREF values, where:
     An element has an ID value equal to V if either\n                         or both of the following conditions are true:
    The is-id property (See .) of the element node is true, and the typed value\n                               of the element node is equal to V under the rules of the\n                                  eq operator using the Unicode codepoint collation\n                                  (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    The element has an attribute node whose is-id property\n                               (See .) is true and whose typed\n                               value is equal to V under the rules of the\n                                  eq operator using the Unicode code point collation\n                                  (http://www.w3.org/2005/xpath-functions/collation/codepoint).
     Each xs:string in $arg is parsed as if it were of\n                         type IDREFS, that is, each xs:string in\n                            $arg is treated as a whitespace-separated sequence of\n                         tokens, each acting as an IDREF. These tokens are then included\n                         in the list of candidate IDREFs. If any of the tokens is not a\n                         lexically valid IDREF (that is, if it is not lexically an\n                            xs:NCName), it is ignored. Formally, the candidate\n                            IDREF values are the strings in the sequence given by the\n                         expression:
    for $s in $arg return\n     fn:tokenize(fn:normalize-space($s), ' ')[. castable as xs:IDREF]
    If several elements have the same ID value, then E is\n                   the one that is first in document order.
    A dynamic error is raised  if\n                $node, or the context item if the second argument is absent, is a node\n                in a tree whose root is not a document node.
    The following errors may be raised when $node is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the sequence of element nodes that have an  ID  value\n             matching the value of one or more of the  IDREF  values supplied in\n                 $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "*", "description" : "" }, { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "idref", "qname" : "fn:idref", "signature" : "($arg as xs:string*) as node()* external", "description" : " 
    Returns the sequence of element or attribute nodes with an IDREF\n             value matching the value of one or more of the ID values supplied in\n                $arg.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
     The function returns a sequence, in document order with duplicates eliminated,\n             containing every element or attribute node $N that satisfies all the\n             following conditions:
    $N is in the target document. The target document is the document\n                   containing $node or the document containing the context item\n                      (.) if the second argument is omitted. The behavior of the\n                   function if $node is omitted is exactly the same as if the context\n                   item had been passed as $node.
    $N has an IDREF value equal to one of the candidate\n                      ID values, where:
    A node $N has an IDREF value equal to\n                            V if both of the following conditions are true:
    The is-idrefs property (see ) of $N is true.
    The sequence fn:tokenize(fn:normalize-space(fn:string($N)), ' ')\n                                contains a string that is\n                               equal to V under the rules of the eq\n                               operator using the Unicode code point collation\n                                  (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    Each xs:string in $arg is parsed as if it were of\n                         lexically of type xs:ID. These xs:strings are then\n                         included in the list of candidate xs:IDs. If any of the strings\n                         in $arg is not a lexically valid xs:ID (that is,\n                         if it is not lexically an xs:NCName), it is ignored. More\n                         formally, the candidate ID values are the strings in the\n                         sequence:
    $arg[. castable as xs:NCName]
    A dynamic error is raised  if\n                $node, or the context item if the second argument is omitted, is a node\n                in a tree whose root is not a document node. 
    The following errors may be raised when $node is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the sequence of element or attribute nodes with an  IDREF \n             value matching the value of one or more of the  ID  values supplied in\n                 $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "idref", "qname" : "fn:idref", "signature" : "($arg as xs:string*, $node as node()) as node()* external", "description" : " 
    Returns the sequence of element or attribute nodes with an IDREF\n             value matching the value of one or more of the ID values supplied in\n                $arg.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
     The function returns a sequence, in document order with duplicates eliminated,\n             containing every element or attribute node $N that satisfies all the\n             following conditions:
    $N is in the target document. The target document is the document\n                   containing $node or the document containing the context item\n                      (.) if the second argument is omitted. The behavior of the\n                   function if $node is omitted is exactly the same as if the context\n                   item had been passed as $node.
    $N has an IDREF value equal to one of the candidate\n                      ID values, where:
    A node $N has an IDREF value equal to\n                            V if both of the following conditions are true:
    The is-idrefs property (see ) of $N is true.
    The sequence fn:tokenize(fn:normalize-space(fn:string($N)), ' ')\n                                contains a string that is\n                               equal to V under the rules of the eq\n                               operator using the Unicode code point collation\n                                  (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    Each xs:string in $arg is parsed as if it were of\n                         lexically of type xs:ID. These xs:strings are then\n                         included in the list of candidate xs:IDs. If any of the strings\n                         in $arg is not a lexically valid xs:ID (that is,\n                         if it is not lexically an xs:NCName), it is ignored. More\n                         formally, the candidate ID values are the strings in the\n                         sequence:
    $arg[. castable as xs:NCName]
    A dynamic error is raised  if\n                $node, or the context item if the second argument is omitted, is a node\n                in a tree whose root is not a document node. 
    The following errors may be raised when $node is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the sequence of element or attribute nodes with an  IDREF \n             value matching the value of one or more of the  ID  values supplied in\n                 $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "*", "description" : "" }, { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "implicit-timezone", "qname" : "fn:implicit-timezone", "signature" : "() as xs:dayTimeDuration external", "description" : " 
    Returns the value of the implicit timezone property from the dynamic context.\n          
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\timplicit timezone.\n \t
    Returns the value of the implicit timezone property from the dynamic context. Components\n             of the dynamic context are discussed in .
    \n", "summary" : "
      Returns the value of the implicit timezone property from the dynamic context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:dayTimeDuration", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "in-scope-prefixes", "qname" : "fn:in-scope-prefixes", "signature" : "($element as element(*)) as xs:string* external", "description" : " 
    Returns the prefixes of the in-scope namespaces for an element node.
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence of strings representing the prefixes of the in-scope\n             namespaces for $element.
    For namespace bindings that have a prefix, the function returns the prefix as an\n                xs:NCName. For the default namespace, which has no prefix, it returns\n             the zero-length string. 
    The result sequence contains no duplicates.
    The ordering of the result sequence is implementation-dependent.
    \n", "summary" : "
      Returns the prefixes of the in-scope namespaces for an element node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of", "qname" : "fn:index-of", "signature" : "($seq as xs:anyAtomicType*, $search as xs:anyAtomicType) as xs:integer* external", "description" : " 
    Returns a sequence of positive integers giving the positions within the\n             sequence $seq of items that are equal to $search.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The function returns a sequence of positive integers giving the positions within the\n             sequence $seq of items that are equal to $search.
    The collation used by this function is determined according to the rules in . This collation is used when string comparison is\n             required.
    The items in the sequence $seq are compared with $search under\n             the rules for the eq operator. Values of type xs:untypedAtomic\n             are compared as if they were of type xs:string. Values that cannot be\n             compared, because the eq operator is not defined for their types, are\n             considered to be distinct. If an item compares equal, then the position of that item in\n             the sequence $seq is included in the result.
    The first item in a sequence is at position 1, not position 0.
    The result sequence is in ascending numeric order.
    If the value of $seq is the empty sequence, or if no item in\n                $seq matches $search, then the function returns the empty\n             sequence.
    No error occurs if non-comparable values are encountered. So when\n             comparing two atomic values, the effective boolean value of fn:index-of($a,\n                $b) is true if $a and $b are equal, false if they\n             are not equal or not comparable.
    \n", "summary" : "
      Returns a sequence of positive integers giving the positions within the\n             sequence  $seq  of items that are equal to  $search .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" }, { "name" : "search", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "index-of", "qname" : "fn:index-of", "signature" : "($seq as xs:anyAtomicType*, $search as xs:anyAtomicType, $collation as xs:string) as xs:integer* external", "description" : " 
    Returns a sequence of positive integers giving the positions within the\n             sequence $seq of items that are equal to $search.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The function returns a sequence of positive integers giving the positions within the\n             sequence $seq of items that are equal to $search.
    The collation used by this function is determined according to the rules in . This collation is used when string comparison is\n             required.
    The items in the sequence $seq are compared with $search under\n             the rules for the eq operator. Values of type xs:untypedAtomic\n             are compared as if they were of type xs:string. Values that cannot be\n             compared, because the eq operator is not defined for their types, are\n             considered to be distinct. If an item compares equal, then the position of that item in\n             the sequence $seq is included in the result.
    The first item in a sequence is at position 1, not position 0.
    The result sequence is in ascending numeric order.
    If the value of $seq is the empty sequence, or if no item in\n                $seq matches $search, then the function returns the empty\n             sequence.
    No error occurs if non-comparable values are encountered. So when\n             comparing two atomic values, the effective boolean value of fn:index-of($a,\n                $b) is true if $a and $b are equal, false if they\n             are not equal or not comparable.
    \n", "summary" : "
      Returns a sequence of positive integers giving the positions within the\n             sequence  $seq  of items that are equal to  $search .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" }, { "name" : "search", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "innermost", "qname" : "fn:innermost", "signature" : "($nodes as node()*) as node()* external", "description" : " 
    Returns every node within the input sequence that is not an ancestor of another member\n             of the input sequence; the nodes are returned in document order with duplicates\n             eliminated.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function call fn:innermost($nodes) is defined to be\n             equivalent to the result of the expression $nodes except\n                $nodes/ancestor::node().
    That is, the function takes as input a sequence of nodes, and returns every node within\n             the sequence that is not an ancestor of another node within the sequence; the nodes are\n             returned in document order with duplicates eliminated.
    If the source document contains nested sections represented by div\n                elements, the expression innermost(//div) returns those div\n                elements that do not contain further div elements.
    \n", "summary" : "
      Returns every node within the input sequence that is not an ancestor of another member\n             of the input sequence; the nodes are returned in document order with duplicates\n             eliminated.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "insert-before", "qname" : "fn:insert-before", "signature" : "($target as item()*, $position as xs:integer, $inserts as item()*) as item()* external", "description" : " 
    Returns a sequence constructed by inserting an item or a sequence of items at a\n             given position within an existing sequence.
    This function is deterministic, context-independent,  and focus-independent. 
    The value returned by the function consists of all items of $target whose\n             index is less than $position, followed by all items of\n                $inserts, followed by the remaining elements of $target, in\n             that order. 
    For detailed type semantics, see [Formal Semantics].
    If $target is the empty sequence, $inserts is returned. If\n                $inserts is the empty sequence, $target is returned.
    If $position is less than one (1), the first position, the effective value\n             of $position is one (1). If $position is greater than the\n             number of items in $target, then the effective value of\n                $position is equal to the number of items in $target plus\n             1. 
    The value of $target is not affected by the sequence construction.
    \n", "summary" : "
      Returns a sequence constructed by inserting an item or a sequence of items at a\n             given position within an existing sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "target", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "position", "type" : "xs:integer", "occurrence" : null, "description" : "" }, { "name" : "inserts", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "iri-to-uri", "qname" : "fn:iri-to-uri", "signature" : "($iri as xs:string?) as xs:string external", "description" : " 
    Converts a string containing an IRI into a URI according to the rules of\n                .
    This function is deterministic, context-independent,  and focus-independent. 
    If $iri is the empty sequence, the function returns the zero-length\n             string.
    Otherwise, the function converts the value of $iri into a URI according to\n             the rules given in Section 3.1 of  by percent-encoding characters\n             that are allowed in an IRI but not in a URI. If $iri contains a character\n             that is invalid in an IRI, such as the space character (see note below), the invalid\n             character is replaced by its percent-encoded form as described in  before the conversion is performed.
    Since  recommends that, for consistency, URI producers and\n             normalizers should use uppercase hexadecimal digits for all percent-encodings, this\n             function must always generate hexadecimal values using the upper-case letters A-F.
    The function is idempotent but not invertible. Both the inputs My Documents\n             and My%20Documents will be converted to the output\n                My%20Documents.
    This function does not check whether $iri is a valid IRI. It treats it as\n             an string and operates on the characters in the string.
     The following printable ASCII characters are invalid in an IRI: \"<\", \">\", \n                \"  (double quote), space, \"{\", \"}\", \"|\", \"\\\", \"^\", and \"`\". Since these\n             characters should not appear in an IRI, if they do appear in $iri they will\n             be percent-encoded. In addition, characters outside the range x20-x7E will be percent-encoded because they are invalid in a URI. 
     Since this function does not escape the PERCENT SIGN \"%\" and this character is not\n             allowed in data within a URI, users wishing to convert character strings (such as file\n             names) that include \"%\" to a URI should manually escape \"%\" by replacing it with \"%25\".\n          
    \n", "summary" : "
      Converts a string containing an IRI into a URI according to the rules of\n                  .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "iri", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "lang", "qname" : "fn:lang", "signature" : "($testlang as xs:string?) as xs:boolean external", "description" : " 
    This function tests whether the language of $node, or the context\n             item if the second argument is omitted, as specified by xml:lang attributes\n             is the same as, or is a sublanguage of, the language specified by\n             $testlang.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The behavior of the function if the second argument is omitted is exactly the same as if\n             the context item (.) had been passed as the second argument.
    The language of the argument $node, or the context item if the second\n             argument is omitted, is determined by the value of the xml:lang attribute\n             on the node, or, if the node has no such attribute, by the value of the\n                xml:lang attribute on the nearest ancestor of the node that has an\n                xml:lang attribute. If there is no such ancestor, then the function\n             returns false. 
    If $testlang is the empty sequence it is interpreted as the zero-length\n             string.
    The relevant xml:lang attribute is determined by the value of the XPath\n             expression:
    (ancestor-or-self::*/@xml:lang)[last()]
    If this expression returns an empty sequence, the function returns false. 
    Otherwise, the function returns true if and only if, based on a caseless\n             default match as specified in section 3.13 of , either:
    \n                   $testlang is equal to the string-value of the relevant\n                      xml:lang attribute, or
    \n                   $testlang is equal to some substring of the string-value of the\n                   relevant xml:lang attribute that starts at the start of the\n                   string-value and ends immediately before a hyphen, \"-\" (the character \"-\" is\n                   HYPHEN-MINUS, #x002D).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      This function tests whether the language of  $node , or the context\n             item if the second argument is omitted, as specified by  xml:lang  attributes\n             is the same as, or is a sublanguage of, the language specified by\n              $testlang .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "testlang", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "lang", "qname" : "fn:lang", "signature" : "($testlang as xs:string?, $node as node()) as xs:boolean external", "description" : " 
    This function tests whether the language of $node, or the context\n             item if the second argument is omitted, as specified by xml:lang attributes\n             is the same as, or is a sublanguage of, the language specified by\n             $testlang.
    The one-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The behavior of the function if the second argument is omitted is exactly the same as if\n             the context item (.) had been passed as the second argument.
    The language of the argument $node, or the context item if the second\n             argument is omitted, is determined by the value of the xml:lang attribute\n             on the node, or, if the node has no such attribute, by the value of the\n                xml:lang attribute on the nearest ancestor of the node that has an\n                xml:lang attribute. If there is no such ancestor, then the function\n             returns false. 
    If $testlang is the empty sequence it is interpreted as the zero-length\n             string.
    The relevant xml:lang attribute is determined by the value of the XPath\n             expression:
    (ancestor-or-self::*/@xml:lang)[last()]
    If this expression returns an empty sequence, the function returns false. 
    Otherwise, the function returns true if and only if, based on a caseless\n             default match as specified in section 3.13 of , either:
    \n                   $testlang is equal to the string-value of the relevant\n                      xml:lang attribute, or
    \n                   $testlang is equal to some substring of the string-value of the\n                   relevant xml:lang attribute that starts at the start of the\n                   string-value and ends immediately before a hyphen, \"-\" (the character \"-\" is\n                   HYPHEN-MINUS, #x002D).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      This function tests whether the language of  $node , or the context\n             item if the second argument is omitted, as specified by  xml:lang  attributes\n             is the same as, or is a sublanguage of, the language specified by\n              $testlang .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "testlang", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "last", "qname" : "fn:last", "signature" : "() as xs:integer external", "description" : " 
    Returns the context size from the dynamic context.
    This function is deterministic, context-dependent,  and focus-dependent. 
    Returns the context size from the dynamic context. (See .)
    A dynamic error is raised  if the\n             context item is absent.
    \n", "summary" : "
      Returns the context size from the dynamic context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "local-name-from-QName", "qname" : "fn:local-name-from-QName", "signature" : "($arg as xs:QName?) as xs:NCName? external", "description" : " 
    Returns the local part of the supplied QName.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence the function returns the empty sequence.
    Otherwise, the function returns an xs:NCName representing the local part of\n                $arg.
    The expression fn:local-name-from-QName(fn:QName(\"http://www.example.com/example\",\n                   \"person\")) returns \"person\".
    \n", "summary" : "
      Returns the local part of the supplied QName.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:QName", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:NCName?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "local-name", "qname" : "fn:local-name", "signature" : "() as xs:string external", "description" : " 
    Returns the local part of the name of $arg as an\n                xs:string that is either the zero-length string, or has the lexical form\n             of an xs:NCName.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the argument is supplied and is the empty sequence, the function returns the\n             zero-length string.
    If the node identified by $arg has no name (that is, if it is a document\n             node, a comment, a text node, or a namespace node having no name), the function returns\n             the zero-length string.
    Otherwise, the function returns the local part of the expanded-QName of the node\n             identified by $arg, as determined by the dm:node-name accessor\n             defined in ). This will be an\n                xs:string whose lexical form is an xs:NCName.
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the local part of the name of  $arg  as an\n                 xs:string  that is either the zero-length string, or has the lexical form\n             of an  xs:NCName .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "local-name", "qname" : "fn:local-name", "signature" : "($arg as node()?) as xs:string external", "description" : " 
    Returns the local part of the name of $arg as an\n                xs:string that is either the zero-length string, or has the lexical form\n             of an xs:NCName.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the argument is supplied and is the empty sequence, the function returns the\n             zero-length string.
    If the node identified by $arg has no name (that is, if it is a document\n             node, a comment, a text node, or a namespace node having no name), the function returns\n             the zero-length string.
    Otherwise, the function returns the local part of the expanded-QName of the node\n             identified by $arg, as determined by the dm:node-name accessor\n             defined in ). This will be an\n                xs:string whose lexical form is an xs:NCName.
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the local part of the name of  $arg  as an\n                 xs:string  that is either the zero-length string, or has the lexical form\n             of an  xs:NCName .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "lower-case", "qname" : "fn:lower-case", "signature" : "($arg as xs:string?) as xs:string external", "description" : " 
    Converts a string to lower case.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the zero-length string is\n             returned.
    Otherwise, the function returns the value of $arg after translating every\n                character to its lower-case correspondent as\n             defined in the appropriate case mappings section in the Unicode standard . For versions of Unicode beginning with the 2.1.8 update, only\n             locale-insensitive case mappings should be applied. Beginning with version 3.2.0 (and\n             likely future versions) of Unicode, precise mappings are described in default case\n             operations, which are full case mappings in the absence of tailoring for particular\n             languages and environments. Every upper-case character that does not have a lower-case\n             correspondent, as well as every lower-case character, is included in the returned value\n             in its original form. 
    Case mappings may change the length of a string. In general, the\n                fn:upper-case and fn:lower-case functions are not inverses\n             of each other: fn:lower-case(fn:upper-case($arg)) is not guaranteed to\n             return $arg, nor is fn:upper-case(fn:lower-case($arg)). The\n             Latin small letter dotless i (as used in Turkish) is perhaps the most prominent\n             lower-case letter which will not round-trip. The Latin capital letter i with dot above\n             is the most prominent upper-case letter which will not round trip; there are others,\n             such as Latin capital letter Sharp S (#1E9E) which is introduced in Unicode 5.1.
     These functions may not always be linguistically appropriate (e.g. Turkish i without\n             dot) or appropriate for the application (e.g. titlecase). In cases such as Turkish, a\n             simple translation should be used first.
     Because the function is not sensitive to locale, results will not always match user\n             expectations. In Quebec, for example, the standard uppercase equivalent of \"è\" is \"È\",\n             while in metropolitan France it is more commonly \"E\"; only one of these is supported by\n             the functions as defined.
     Many characters of class Ll lack uppercase equivalents in the Unicode case mapping\n             tables; many characters of class Lu lack lowercase equivalents.
    \n", "summary" : "
      Converts a string to lower case.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "matches", "qname" : "fn:matches", "signature" : "($input as xs:string?, $pattern as xs:string) as xs:boolean external", "description" : " 
    Returns true if the supplied string matches a given regular expression.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the first version of this function (omitting the argument\n                $flags) is the same as the effect of calling the second version with the\n                $flags argument set to a zero-length string. Flags are defined in\n                .
    If $input is the empty sequence, it is interpreted as the zero-length\n             string.
    The function returns true if $input or some substring of\n                $input matches the regular expression supplied as $pattern.\n             Otherwise, the function returns false. The matching rules are influenced by\n             the value of $flags if present. 
    A dynamic error is raised  if the value of\n                $pattern is invalid according to the rules described in . 
    A dynamic error is raised  if the value of\n                $flags is invalid according to the rules described in . 
    \n", "summary" : "
      Returns true if the supplied string matches a given regular expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "matches", "qname" : "fn:matches", "signature" : "($input as xs:string?, $pattern as xs:string, $flags as xs:string) as xs:boolean external", "description" : " 
    Returns true if the supplied string matches a given regular expression.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the first version of this function (omitting the argument\n                $flags) is the same as the effect of calling the second version with the\n                $flags argument set to a zero-length string. Flags are defined in\n                .
    If $input is the empty sequence, it is interpreted as the zero-length\n             string.
    The function returns true if $input or some substring of\n                $input matches the regular expression supplied as $pattern.\n             Otherwise, the function returns false. The matching rules are influenced by\n             the value of $flags if present. 
    A dynamic error is raised  if the value of\n                $pattern is invalid according to the rules described in . 
    A dynamic error is raised  if the value of\n                $flags is invalid according to the rules described in . 
    \n", "summary" : "
      Returns true if the supplied string matches a given regular expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "flags", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "max", "qname" : "fn:max", "signature" : "($arg as xs:anyAtomicType*) as xs:anyAtomicType? external", "description" : " 
    Returns a value that is equal to the highest value appearing in the input\n             sequence.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The following rules are applied to the input sequence $arg:
    Values of type xs:untypedAtomic in $arg are cast to\n                      xs:double.
    Numeric and xs:anyURI values are converted to\n                   the least common type reachable by a combination of type promotion and subtype\n                   substitution. See  and .
    The items in the resulting sequence may be reordered in an arbitrary order. The\n             resulting sequence is referred to below as the converted sequence. The function returns\n             an item from the converted sequence rather than the input sequence. 
    If the converted sequence is empty, the function returns the empty sequence.
    All items in the converted sequence must be\n                derived from a single base type for which the le operator is\n             defined. In addition, the values in the sequence must have a total order. If date/time\n             values do not have a timezone, they are considered to have the implicit timezone\n             provided by the dynamic context for the purpose of comparison. Duration values must\n             either all be xs:yearMonthDuration values or must all be\n                xs:dayTimeDuration values.
    If the converted sequence contains the value NaN, the value\n                NaN is returned.
    If the items in the converted sequence are of\n             type xs:string or types derived by restriction from xs:string,\n             then the determination of the item with the smallest value is made according to the\n             collation that is used. If the type of the items in the converted sequence is not xs:string and\n                $collation is specified, the collation is ignored.
    The collation used by this function is determined according to the rules in .
    The function returns the result of the expression:
    \n    if (every $v in $c satisfies $c[1] ge $v)\n    then $c[1]\n    else fn:max(fn:subsequence($c, 2))
    evaluated with $collation as the default collation if specified, and with\n                $c as the converted sequence.
    For detailed type semantics, see [Formal Semantics].
    A type error is raised  if the input sequence contains\n             items of incompatible types, as described above.
    \n", "summary" : "
      Returns a value that is equal to the highest value appearing in the input\n             sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "max", "qname" : "fn:max", "signature" : "($arg as xs:anyAtomicType*, $collation as xs:string) as xs:anyAtomicType? external", "description" : " 
    Returns a value that is equal to the highest value appearing in the input\n             sequence.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The following rules are applied to the input sequence $arg:
    Values of type xs:untypedAtomic in $arg are cast to\n                      xs:double.
    Numeric and xs:anyURI values are converted to\n                   the least common type reachable by a combination of type promotion and subtype\n                   substitution. See  and .
    The items in the resulting sequence may be reordered in an arbitrary order. The\n             resulting sequence is referred to below as the converted sequence. The function returns\n             an item from the converted sequence rather than the input sequence. 
    If the converted sequence is empty, the function returns the empty sequence.
    All items in the converted sequence must be\n                derived from a single base type for which the le operator is\n             defined. In addition, the values in the sequence must have a total order. If date/time\n             values do not have a timezone, they are considered to have the implicit timezone\n             provided by the dynamic context for the purpose of comparison. Duration values must\n             either all be xs:yearMonthDuration values or must all be\n                xs:dayTimeDuration values.
    If the converted sequence contains the value NaN, the value\n                NaN is returned.
    If the items in the converted sequence are of\n             type xs:string or types derived by restriction from xs:string,\n             then the determination of the item with the smallest value is made according to the\n             collation that is used. If the type of the items in the converted sequence is not xs:string and\n                $collation is specified, the collation is ignored.
    The collation used by this function is determined according to the rules in .
    The function returns the result of the expression:
    \n    if (every $v in $c satisfies $c[1] ge $v)\n    then $c[1]\n    else fn:max(fn:subsequence($c, 2))
    evaluated with $collation as the default collation if specified, and with\n                $c as the converted sequence.
    For detailed type semantics, see [Formal Semantics].
    A type error is raised  if the input sequence contains\n             items of incompatible types, as described above.
    \n", "summary" : "
      Returns a value that is equal to the highest value appearing in the input\n             sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "min", "qname" : "fn:min", "signature" : "($arg as xs:anyAtomicType*) as xs:anyAtomicType? external", "description" : " 
    Returns a value that is equal to the lowest value appearing in the input\n             sequence.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The following rules are applied to the input sequence:
    Values of type xs:untypedAtomic in $arg are cast to\n                      xs:double.
    Numeric and xs:anyURI values are converted to\n                   the least common type reachable by a combination of type promotion and subtype\n                   substitution. See  and .
    The items in the resulting sequence may be reordered in an arbitrary order. The\n             resulting sequence is referred to below as the converted sequence. The function returns\n             an item from the converted sequence rather than the input sequence. 
    If the converted sequence is empty, the empty sequence is returned.
    All items in the converted sequence must be\n                derived from a single base type for which the le operator is\n             defined. In addition, the values in the sequence must have a total order. If date/time\n             values do not have a timezone, they are considered to have the implicit timezone\n             provided by the dynamic context for the purpose of comparison. Duration values must\n             either all be xs:yearMonthDuration values or must all be\n                xs:dayTimeDuration values.
    If the converted sequence contains the value NaN, the value\n                NaN is returned.
    If the items in the converted sequence are of\n             type xs:string or types derived by restriction from xs:string,\n             then the determination of the item with the smallest value is made according to the\n             collation that is used. If the type of the items in the converted sequence is not xs:string and\n                $collation is specified, the collation is ignored.
    The collation used by this function is determined according to the rules in .
    The function returns the result of the expression:
    \n    if (every $v in $c satisfies $c[1] le $v)\n    then $c[1]\n    else fn:min(fn:subsequence($c, 2))
    evaluated with $collation as the default collation if specified, and with\n                $c as the converted sequence.
    For detailed type semantics, see [Formal Semantics].
    A type error is raised  if the input sequence contains\n             items of incompatible types, as described above.
    \n", "summary" : "
      Returns a value that is equal to the lowest value appearing in the input\n             sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "min", "qname" : "fn:min", "signature" : "($arg as xs:anyAtomicType*, $collation as xs:string) as xs:anyAtomicType? external", "description" : " 
    Returns a value that is equal to the lowest value appearing in the input\n             sequence.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and implicit timezone.\n \t
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri, and implicit timezone.\n \t
    The following rules are applied to the input sequence:
    Values of type xs:untypedAtomic in $arg are cast to\n                      xs:double.
    Numeric and xs:anyURI values are converted to\n                   the least common type reachable by a combination of type promotion and subtype\n                   substitution. See  and .
    The items in the resulting sequence may be reordered in an arbitrary order. The\n             resulting sequence is referred to below as the converted sequence. The function returns\n             an item from the converted sequence rather than the input sequence. 
    If the converted sequence is empty, the empty sequence is returned.
    All items in the converted sequence must be\n                derived from a single base type for which the le operator is\n             defined. In addition, the values in the sequence must have a total order. If date/time\n             values do not have a timezone, they are considered to have the implicit timezone\n             provided by the dynamic context for the purpose of comparison. Duration values must\n             either all be xs:yearMonthDuration values or must all be\n                xs:dayTimeDuration values.
    If the converted sequence contains the value NaN, the value\n                NaN is returned.
    If the items in the converted sequence are of\n             type xs:string or types derived by restriction from xs:string,\n             then the determination of the item with the smallest value is made according to the\n             collation that is used. If the type of the items in the converted sequence is not xs:string and\n                $collation is specified, the collation is ignored.
    The collation used by this function is determined according to the rules in .
    The function returns the result of the expression:
    \n    if (every $v in $c satisfies $c[1] le $v)\n    then $c[1]\n    else fn:min(fn:subsequence($c, 2))
    evaluated with $collation as the default collation if specified, and with\n                $c as the converted sequence.
    For detailed type semantics, see [Formal Semantics].
    A type error is raised  if the input sequence contains\n             items of incompatible types, as described above.
    \n", "summary" : "
      Returns a value that is equal to the lowest value appearing in the input\n             sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minutes-from-dateTime", "qname" : "fn:minutes-from-dateTime", "signature" : "($arg as xs:dateTime?) as xs:integer? external", "description" : " 
    Returns the minute component of an xs:dateTime.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer value between 0 and 59, both\n             inclusive, representing the minute component in the local value of\n             $arg.
    The expression fn:minutes-from-dateTime(xs:dateTime(\"1999-05-31T13:20:00-05:00\")) returns 20.
    The expression fn:minutes-from-dateTime(xs:dateTime(\"1999-05-31T13:30:00+05:30\")) returns 30.
    \n", "summary" : "
      Returns the minute component of an  xs:dateTime .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minutes-from-duration", "qname" : "fn:minutes-from-duration", "signature" : "($arg as xs:duration?) as xs:integer? external", "description" : " 
    Returns the number of minutes in a duration.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer representing the minutes\n             component in the value of $arg. The result is obtained by casting\n                $arg to an xs:dayTimeDuration (see ) and then computing the minutes component as described\n             in .
    If $arg is a negative duration then the result will be negative..
    If $arg is an xs:yearMonthDuration the function returns 0.
    The expression fn:minutes-from-duration(xs:dayTimeDuration(\"P3DT10H\")) returns 0.
    The expression fn:minutes-from-duration(xs:dayTimeDuration(\"-P5DT12H30M\")) returns -30.
    \n", "summary" : "
      Returns the number of minutes in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minutes-from-time", "qname" : "fn:minutes-from-time", "signature" : "($arg as xs:time?) as xs:integer? external", "description" : " 
    Returns the minutes component of an xs:time.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer value between 0 and 59, both\n             inclusive, representing the value of the minutes component in the local value of\n                $arg.
    The expression fn:minutes-from-time(xs:time(\"13:00:00Z\")) returns 0.
    \n", "summary" : "
      Returns the minutes component of an  xs:time .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "month-from-date", "qname" : "fn:month-from-date", "signature" : "($arg as xs:date?) as xs:integer? external", "description" : " 
    Returns the month component of an xs:date.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer between 1 and 12, both\n             inclusive, representing the month component in the local value of $arg.\n          
    The expression fn:month-from-date(xs:date(\"1999-05-31-05:00\")) returns 5.
    The expression fn:month-from-date(xs:date(\"2000-01-01+05:00\")) returns 1.
    \n", "summary" : "
      Returns the month component of an  xs:date .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "months-from-duration", "qname" : "fn:months-from-duration", "signature" : "($arg as xs:duration?) as xs:integer? external", "description" : " 
    Returns the number of months in a duration.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer representing the months\n             component in the value of $arg. The result is obtained by casting\n                $arg to an xs:yearMonthDuration (see ) and then computing the months component as described in\n                .
    If $arg is a negative duration then the result will be negative..
    If $arg is an xs:dayTimeDuration the function returns 0.
    The expression fn:months-from-duration(xs:yearMonthDuration(\"P20Y15M\")) returns 3.
    The expression fn:months-from-duration(xs:yearMonthDuration(\"-P20Y18M\")) returns -6.
    The expression fn:months-from-duration(xs:dayTimeDuration(\"-P2DT15H0M0S\")) returns 0.
    \n", "summary" : "
      Returns the number of months in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "name", "qname" : "fn:name", "signature" : "() as xs:string external", "description" : " 
    Returns the name of a node, as an xs:string that is either the\n             zero-length string, or has the lexical form of an xs:QName. 
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the argument is supplied and is the empty sequence, the function returns the\n             zero-length string.
    If the node identified by $arg has no name (that is, if it is a document\n             node, a comment, a text node, or a namespace node having no name), the function returns\n             the zero-length string.
    Otherwise, the function returns the value of the expression\n                fn:string(fn:node-name($arg)).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the name of a node, as an  xs:string  that is either the\n             zero-length string, or has the lexical form of an  xs:QName .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "name", "qname" : "fn:name", "signature" : "($arg as node()?) as xs:string external", "description" : " 
    Returns the name of a node, as an xs:string that is either the\n             zero-length string, or has the lexical form of an xs:QName. 
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the argument is supplied and is the empty sequence, the function returns the\n             zero-length string.
    If the node identified by $arg has no name (that is, if it is a document\n             node, a comment, a text node, or a namespace node having no name), the function returns\n             the zero-length string.
    Otherwise, the function returns the value of the expression\n                fn:string(fn:node-name($arg)).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the name of a node, as an  xs:string  that is either the\n             zero-length string, or has the lexical form of an  xs:QName .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "namespace-uri-for-prefix", "qname" : "fn:namespace-uri-for-prefix", "signature" : "($prefix as xs:string?, $element as element(*)) as xs:anyURI? external", "description" : " 
    Returns the namespace URI of one of the in-scope namespaces for\n                $element, identified by its namespace prefix.
    This function is deterministic, context-independent,  and focus-independent. 
    If $element has an in-scope namespace whose namespace prefix is equal to\n                $prefix, the function returns the namespace URI of that namespace.
    If $element has no in-scope namespace whose namespace prefix is equal to\n             $prefix, the function returns the empty sequence.
    If $prefix is the zero-length string or the empty\n             sequence, then if $element has a default namespace (that is, a namespace\n             node with no name), the function returns the namespace URI of the default namespace. If\n                $element has no default namespace, the function returns the empty\n             sequence.
    Prefixes are equal only if their Unicode codepoints match exactly.
    let $e := \n <z:a xmlns=\"http://example.org/one\" xmlns:z=\"http://example.org/two\">\n   <b xmlns=\"\"/>\n </z:a>
    The expression fn:namespace-uri-for-prefix(\"z\", $e) returns \"http://example.org/two\".
    The expression fn:namespace-uri-for-prefix(\"\", $e) returns \"http://example.org/one\".
    The expression fn:namespace-uri-for-prefix((), $e) returns \"http://example.org/one\".
    The expression fn:namespace-uri-for-prefix(\"xml\", $e) returns \"http://www.w3.org/XML/1998/namespace\".
    The expression fn:namespace-uri-for-prefix(\"xml\", $e) returns \"http://www.w3.org/XML/1998/namespace\".
    \n", "summary" : "
      Returns the namespace URI of one of the in-scope namespaces for\n                 $element , identified by its namespace prefix.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "prefix", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "namespace-uri-from-QName", "qname" : "fn:namespace-uri-from-QName", "signature" : "($arg as xs:QName?) as xs:anyURI? external", "description" : " 
    Returns the namespace URI part of the supplied QName.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence the function returns the empty sequence.
    Otherwise, the function returns an xs:anyURI representing the namespace URI\n             part of $arg.
    If $arg is in no namespace, the function returns the zero-length\n                xs:anyURI.
    The expression fn:namespace-uri-from-QName(fn:QName(\"http://www.example.com/example\",\n                   \"person\")) returns xs:anyURI(\"http://www.example.com/example\").
    \n", "summary" : "
      Returns the namespace URI part of the supplied QName.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:QName", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "namespace-uri", "qname" : "fn:namespace-uri", "signature" : "() as xs:anyURI external", "description" : " 
    Returns the namespace URI part of the name of\n                $arg, as an xs:anyURI value.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context node (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the node identified by $arg is neither an element nor an attribute node,\n             or if it is an element or attribute node whose expanded-QName (as determined by the\n                dm:node-name accessor in the )\n             is in no namespace, then the function returns the zero-length xs:anyURI\n             value.
    Otherwise, the result will be the namespace URI part of the expanded-QName of the node\n             identified by $arg, as determined by the dm:node-name accessor\n             defined in ), returned as an\n                xs:anyURI value.
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the namespace URI part of the name of\n                 $arg , as an  xs:anyURI  value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "namespace-uri", "qname" : "fn:namespace-uri", "signature" : "($arg as node()?) as xs:anyURI external", "description" : " 
    Returns the namespace URI part of the name of\n                $arg, as an xs:anyURI value.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context node (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If the node identified by $arg is neither an element nor an attribute node,\n             or if it is an element or attribute node whose expanded-QName (as determined by the\n                dm:node-name accessor in the )\n             is in no namespace, then the function returns the zero-length xs:anyURI\n             value.
    Otherwise, the result will be the namespace URI part of the expanded-QName of the node\n             identified by $arg, as determined by the dm:node-name accessor\n             defined in ), returned as an\n                xs:anyURI value.
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the namespace URI part of the name of\n                 $arg , as an  xs:anyURI  value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyURI", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "nilled", "qname" : "fn:nilled", "signature" : "() as xs:boolean external", "description" : " 
    Returns true for an element that is nilled.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the function returns the result of the dm:nilled accessor as\n             defined in  (see ).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns true for an element that is  nilled .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "nilled", "qname" : "fn:nilled", "signature" : "($arg as node()?) as xs:boolean? external", "description" : " 
    Returns true for an element that is nilled.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item (.). The\n             behavior of the function if the argument is omitted is exactly the same as if the\n             context item had been passed as the argument.
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the function returns the result of the dm:nilled accessor as\n             defined in  (see ).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns true for an element that is  nilled .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "node-name", "qname" : "fn:node-name", "signature" : "() as xs:QName? external", "description" : " 
    Returns the name of a node, as an xs:QName.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item\n                (.). The behavior of the function if the argument is omitted is exactly\n             the same as if the context item had been passed as the argument.
    If $arg is the empty sequence, the empty sequence is returned.
    Otherwise, the function returns the result of the dm:node-name accessor as\n             defined in  (see ).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the name of a node, as an  xs:QName .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "node-name", "qname" : "fn:node-name", "signature" : "($arg as node()?) as xs:QName? external", "description" : " 
    Returns the name of a node, as an xs:QName.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the argument is omitted, it defaults to the context item\n                (.). The behavior of the function if the argument is omitted is exactly\n             the same as if the context item had been passed as the argument.
    If $arg is the empty sequence, the empty sequence is returned.
    Otherwise, the function returns the result of the dm:node-name accessor as\n             defined in  (see ).
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the name of a node, as an  xs:QName .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:QName?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "normalize-space", "qname" : "fn:normalize-space", "signature" : "() as xs:string external", "description" : " 
    Returns the value of $arg with leading and trailing whitespace\n             removed, and sequences of internal whitespace reduced to a single space character.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the function returns the\n             zero-length string.
    The function returns a string constructed by stripping leading and trailing whitespace\n             from the value of $arg, and replacing sequences of one or more adjacent\n             whitespace characters with a single space, #x20.
    The whitespace characters are defined in the metasymbol S (Production 3) of .
    If no argument is supplied, then $arg defaults to the\n             string value (calculated using fn:string) of the context item\n                (.). 
    If no argument is supplied and the context item is absent then a dynamic error is raised: .
    \n", "summary" : "
      Returns the value of  $arg  with leading and trailing whitespace\n             removed, and sequences of internal whitespace reduced to a single space character.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "normalize-space", "qname" : "fn:normalize-space", "signature" : "($arg as xs:string?) as xs:string external", "description" : " 
    Returns the value of $arg with leading and trailing whitespace\n             removed, and sequences of internal whitespace reduced to a single space character.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the function returns the\n             zero-length string.
    The function returns a string constructed by stripping leading and trailing whitespace\n             from the value of $arg, and replacing sequences of one or more adjacent\n             whitespace characters with a single space, #x20.
    The whitespace characters are defined in the metasymbol S (Production 3) of .
    If no argument is supplied, then $arg defaults to the\n             string value (calculated using fn:string) of the context item\n                (.). 
    If no argument is supplied and the context item is absent then a dynamic error is raised: .
    \n", "summary" : "
      Returns the value of  $arg  with leading and trailing whitespace\n             removed, and sequences of internal whitespace reduced to a single space character.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "normalize-unicode", "qname" : "fn:normalize-unicode", "signature" : "($arg as xs:string?) as xs:string external", "description" : " 
    Returns the value of $arg after applying Unicode\n             normalization.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the function returns the\n             zero-length string.
    If the single-argument version of the function is used, the result is the same as\n             calling the two-argument version with $normalizationForm set to the string\n             \"NFC\".
    Otherwise, the function returns the value of $arg normalized according to\n             the rules of the normalization form identified by the value of\n                $normalizationForm.
    The effective value of $normalizationForm is the value of the expression\n                fn:upper-case(fn:normalize-space($normalizationForm)).
    See  for a description of the\n             normalization forms.
    If the effective value of $normalizationForm is NFC,\n                   then the function returns the value of $arg converted to Unicode\n                   Normalization Form C (NFC).
    If the effective value of $normalizationForm is NFD,\n                   then the function returns the value of $arg converted to Unicode\n                   Normalization Form D (NFD).
    If the effective value of $normalizationForm is NFKC,\n                   then the function returns the value of $arg in Unicode Normalization\n                   Form KC (NFKC).
    If the effective value of $normalizationForm is NFKD,\n                   then the function returns the value of $arg converted to Unicode\n                   Normalization Form KD (NFKD).
    If the effective value of $normalizationForm is\n                      FULLY-NORMALIZED, then the function returns the value of\n                      $arg converted to fully normalized form. 
    If the effective value of $normalizationForm is the zero-length\n                   string, no normalization is performed and $arg is returned.
    Normalization forms NFC, NFD, NFKC, and NFKD, and the algorithms to be\n             used for converting a string to each of these forms, are defined in .
    The motivation for normalization form FULLY-NORMALIZED is explained in\n                . However, as that specification did not\n             progress beyond working draft status, the normative specification is as follows:
    A string is fully-normalized if (a) it is in normalization form NFC\n                   as defined in , and (b) it does not start\n                   with a composing character.
    A composing character is a character that is one or both of the following:
    the second character in the canonical decomposition mapping of some\n                         character that is not listed in the Composition Exclusion Table defined in\n                            ;
    of non-zero canonical combining class (as defined in ).
    A string is converted to FULLY-NORMALIZED form as follows:
    if the first character in the string is a composing character, prepend a\n                         single space (x20);
    convert the resulting string to normalization form NFC.
    Conforming implementations must support normalization form \"NFC\" and\n                may support normalization forms \"NFD\", \"NFKC\", \"NFKD\", and\n             \"FULLY-NORMALIZED\". They may also support other normalization forms\n             with implementation-defined semantics. 
    It is implementation-defined which version of\n             Unicode (and therefore, of the normalization algorithms and their underlying\n             data) is supported by the implementation. See  for details of the\n             stability policy regarding changes to the normalization rules in future\n             versions of Unicode. If the input string contains codepoints that are\n             unassigned in the relevant version of Unicode, or for which no normalization\n             rules are defined, the fn:normalize-unicode function leaves such codepoints\n             unchanged. If the implementation supports the requested normalization form then\n             it must be able to handle every input string without raising an error.
    A dynamic error is raised  if the effective value of the\n                $normalizationForm argument is not one of the values supported by the\n             implementation.
    \n", "summary" : "
      Returns the value of  $arg  after applying Unicode\n             normalization.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "normalize-unicode", "qname" : "fn:normalize-unicode", "signature" : "($arg as xs:string?, $normalizationForm as xs:string) as xs:string external", "description" : " 
    Returns the value of $arg after applying Unicode\n             normalization.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the function returns the\n             zero-length string.
    If the single-argument version of the function is used, the result is the same as\n             calling the two-argument version with $normalizationForm set to the string\n             \"NFC\".
    Otherwise, the function returns the value of $arg normalized according to\n             the rules of the normalization form identified by the value of\n                $normalizationForm.
    The effective value of $normalizationForm is the value of the expression\n                fn:upper-case(fn:normalize-space($normalizationForm)).
    See  for a description of the\n             normalization forms.
    If the effective value of $normalizationForm is NFC,\n                   then the function returns the value of $arg converted to Unicode\n                   Normalization Form C (NFC).
    If the effective value of $normalizationForm is NFD,\n                   then the function returns the value of $arg converted to Unicode\n                   Normalization Form D (NFD).
    If the effective value of $normalizationForm is NFKC,\n                   then the function returns the value of $arg in Unicode Normalization\n                   Form KC (NFKC).
    If the effective value of $normalizationForm is NFKD,\n                   then the function returns the value of $arg converted to Unicode\n                   Normalization Form KD (NFKD).
    If the effective value of $normalizationForm is\n                      FULLY-NORMALIZED, then the function returns the value of\n                      $arg converted to fully normalized form. 
    If the effective value of $normalizationForm is the zero-length\n                   string, no normalization is performed and $arg is returned.
    Normalization forms NFC, NFD, NFKC, and NFKD, and the algorithms to be\n             used for converting a string to each of these forms, are defined in .
    The motivation for normalization form FULLY-NORMALIZED is explained in\n                . However, as that specification did not\n             progress beyond working draft status, the normative specification is as follows:
    A string is fully-normalized if (a) it is in normalization form NFC\n                   as defined in , and (b) it does not start\n                   with a composing character.
    A composing character is a character that is one or both of the following:
    the second character in the canonical decomposition mapping of some\n                         character that is not listed in the Composition Exclusion Table defined in\n                            ;
    of non-zero canonical combining class (as defined in ).
    A string is converted to FULLY-NORMALIZED form as follows:
    if the first character in the string is a composing character, prepend a\n                         single space (x20);
    convert the resulting string to normalization form NFC.
    Conforming implementations must support normalization form \"NFC\" and\n                may support normalization forms \"NFD\", \"NFKC\", \"NFKD\", and\n             \"FULLY-NORMALIZED\". They may also support other normalization forms\n             with implementation-defined semantics. 
    It is implementation-defined which version of\n             Unicode (and therefore, of the normalization algorithms and their underlying\n             data) is supported by the implementation. See  for details of the\n             stability policy regarding changes to the normalization rules in future\n             versions of Unicode. If the input string contains codepoints that are\n             unassigned in the relevant version of Unicode, or for which no normalization\n             rules are defined, the fn:normalize-unicode function leaves such codepoints\n             unchanged. If the implementation supports the requested normalization form then\n             it must be able to handle every input string without raising an error.
    A dynamic error is raised  if the effective value of the\n                $normalizationForm argument is not one of the values supported by the\n             implementation.
    \n", "summary" : "
      Returns the value of  $arg  after applying Unicode\n             normalization.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "normalizationForm", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "not", "qname" : "fn:not", "signature" : "($arg as item()*) as xs:boolean external", "description" : " 
    Returns true if the effective boolean value of $arg\n             is false, or false if it is true.
    This function is deterministic, context-independent,  and focus-independent. 
    The value of $arg is first reduced to an effective boolean value by\n             applying the fn:boolean() function. The function returns true\n             if the effective boolean value is false, or false if the\n             effective boolean value is true. 
    The expression fn:not(fn:true()) returns false().
    The expression fn:not(\"false\") returns false().
    \n", "summary" : "
      Returns  true  if the effective boolean value of  $arg \n             is  false , or  false  if it is  true .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "number", "qname" : "fn:number", "signature" : "() as xs:double external", "description" : " 
    Returns the value indicated by $arg or, if $arg is\n             not specified, the context item after atomization, converted to an\n                xs:double. 
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    Calling the zero-argument version of the function is defined to give the same result as\n             calling the single-argument version with the context item (.). That is,\n                fn:number() is equivalent to fn:number(.), as\n          defined by the rules that follow.
    If $arg is the empty sequence or if $arg or the context item\n             cannot be converted to an xs:double, the xs:double value\n                NaN is returned. 
    Otherwise, $arg , or the context item after atomization, is converted to an\n                xs:double following the rules of . If\n             the conversion to xs:double fails, the xs:double value\n                NaN is returned.
    A dynamic error is raised  if\n                $arg is omitted and the context item is absent.
    As a consequence of the rules given above, a type error occurs if the context\n          item cannot be atomized, or if the result of atomizing the context item is a sequence containing\n          more than one atomic value.
    \n", "summary" : "
      Returns the value indicated by  $arg  or, if  $arg  is\n             not specified, the context item after atomization, converted to an\n                 xs:double .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "number", "qname" : "fn:number", "signature" : "($arg as xs:anyAtomicType?) as xs:double external", "description" : " 
    Returns the value indicated by $arg or, if $arg is\n             not specified, the context item after atomization, converted to an\n                xs:double. 
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    Calling the zero-argument version of the function is defined to give the same result as\n             calling the single-argument version with the context item (.). That is,\n                fn:number() is equivalent to fn:number(.), as\n          defined by the rules that follow.
    If $arg is the empty sequence or if $arg or the context item\n             cannot be converted to an xs:double, the xs:double value\n                NaN is returned. 
    Otherwise, $arg , or the context item after atomization, is converted to an\n                xs:double following the rules of . If\n             the conversion to xs:double fails, the xs:double value\n                NaN is returned.
    A dynamic error is raised  if\n                $arg is omitted and the context item is absent.
    As a consequence of the rules given above, a type error occurs if the context\n          item cannot be atomized, or if the result of atomizing the context item is a sequence containing\n          more than one atomic value.
    \n", "summary" : "
      Returns the value indicated by  $arg  or, if  $arg  is\n             not specified, the context item after atomization, converted to an\n                 xs:double .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "one-or-more", "qname" : "fn:one-or-more", "signature" : "($arg as item()*) as item()+ external", "description" : " 
    Returns $arg if it contains one or more items. Otherwise, raises\n             an error. 
    This function is deterministic, context-independent,  and focus-independent. 
    Except in error cases, the function returns $arg unchanged.
    For detailed type semantics, see [Formal Semantics].
    A dynamic error is raised  if $arg is an empty\n             sequence.
    \n", "summary" : "
      Returns  $arg  if it contains one or more items.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()+", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "outermost", "qname" : "fn:outermost", "signature" : "($nodes as node()*) as node()* external", "description" : " 
    Returns every node within the input sequence that has no ancestor that is itself a\n             member of the input sequence; the nodes are returned in document order with duplicates\n             eliminated.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of the function call fn:outermost($nodes) is defined to be\n             equivalent to the result of the expression $nodes[not(ancestor::node() intersect\n                $nodes)]/..
    That is, the function takes as input a sequence of nodes, and returns every node within\n             the sequence that does not have another node within the sequence as an ancestor; the nodes are\n             returned in document order with duplicates eliminated.
    The formulation $nodes except $nodes/descendant::node() might appear to be\n             simpler, but does not correctly account for attribute nodes, as these are not\n             descendants of their parent element.
    The motivation for the function was based on XSLT streaming use cases. There are cases\n             where the  streaming rules allow the construct\n                outermost(//section) but do not allow //section; the\n             function can therefore be useful in cases where it is known that sections will not be\n             nested, as well as cases where the application actually wishes to process all sections\n             except those that are nested within another.
    \n", "summary" : "
      Returns every node within the input sequence that has no ancestor that is itself a\n             member of the input sequence; the nodes are returned in document order with duplicates\n             eliminated.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "parse-xml-fragment", "qname" : "fn:parse-xml-fragment", "signature" : "($arg as xs:string?) as document(element(*,xs:untyped)) external", "description" : " 
    This function takes as input an XML external entity represented as a string,\n             and returns the document node at the root of an XDM tree representing the parsed\n             document fragment.
    This function is nondeterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    If $arg is the empty sequence, the function returns the empty sequence.
    The input must be a namespace-well-formed external general parsed entity. More specifically,\n             it must be a string conforming to the production rule extParsedEnt in , it must contain no entity references other\n             than references to predefined entities,\n             and it must satisfy all the rules\n             of  for namespace-well-formed documents with the exception\n             that the rule requiring it to be a well-formed document is replaced by the rule requiring\n             it to be a well-formed external general parsed entity.
    The string is parsed to form a sequence of nodes which\n             become children of the new document node, in the same way as the content of any element\n             is converted into a sequence of children for the resulting element node.
    Schema validation is not invoked, which means that the nodes in the\n             returned document will all be untyped.
    The precise process used to construct the XDM instance is . In\n             particular, it is implementation-defined whether an XML 1.0 or XML 1.1 parser is\n             used.
    The Static Base URI from the static context of the fn:parse-xml-fragment function call\n             is used as the base URI of the document node\n             that is returned.
    The document URI of the returned node is absent.
    The function is not\n             deterministic: that is, if the function is called\n             twice with the same arguments, it is implementation-dependent whether the same node is returned on both\n                occasions.
    A dynamic error is raised  if the content of\n                $arg is not a well-formed external general parsed entity,\n             if it contains entity references other than references to predefined entities, or if a document that\n             incorporates this well-formed parsed entity would not be namespace-well-formed.
    \n", "summary" : "
      This function takes as input an XML external entity represented as a string,\n             and returns the document node at the root of an XDM tree representing the parsed\n             document fragment.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "document(element(*,xs:untyped))", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "parse-xml", "qname" : "fn:parse-xml", "signature" : "($arg as xs:string?) as document(element(*,xs:untyped)) external", "description" : " 
    This function takes as input an XML document represented as a string, and\n             returns the document node at the root of an XDM tree representing the parsed\n             document.
    This function is nondeterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    If $arg is the empty sequence, the function returns the\n             empty sequence.
    The precise process used to construct the XDM instance is . In\n             particular, it is implementation-defined whether DTD and/or schema validation is invoked, and it is\n             implementation-defined whether an XML 1.0 or XML 1.1 parser is used.
    The Static Base URI property from the static context of the\n             fn:parse-xml function call is used both as the base URI used by the XML parser to resolve\n             relative entity references within the document, and as the base URI of the document node\n             that is returned.
    The document URI of the returned node is absent.
    The function is not\n             deterministic: that is, if the function is called\n             twice with the same arguments, it is implementation-dependent whether the same node is returned on both\n             occasions.
    A dynamic error is raised  if the content of\n                $arg is not a well-formed and namespace-well-formed XML document.
    A dynamic error is raised  if DTD-based\n             validation is carried out and the content of $arg is not valid against its\n             DTD.
    \n", "summary" : "
      This function takes as input an XML document represented as a string, and\n             returns the document node at the root of an XDM tree representing the parsed\n             document.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "document(element(*,xs:untyped))", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "parse-xml", "qname" : "fn:parse-xml", "signature" : "($arg as xs:string?, $baseURI as xs:string) as document(element(*,xs:untyped)) external", "description" : " 
    This function takes as input an XML document represented as a string, and\n             returns the document node at the root of an XDM tree representing the parsed\n             document.
    This function is nondeterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    If $arg is the empty sequence, the function returns the\n             empty sequence.
    The precise process used to construct the XDM instance is . In\n             particular, it is implementation-defined whether DTD and/or schema validation is invoked, and it is\n             implementation-defined whether an XML 1.0 or XML 1.1 parser is used.
    The Static Base URI property from the static context of the\n             fn:parse-xml function call is used both as the base URI used by the XML parser to resolve\n             relative entity references within the document, and as the base URI of the document node\n             that is returned.
    The document URI of the returned node is absent.
    The function is not\n             deterministic: that is, if the function is called\n             twice with the same arguments, it is implementation-dependent whether the same node is returned on both\n             occasions.
    A dynamic error is raised  if the content of\n                $arg is not a well-formed and namespace-well-formed XML document.
    A dynamic error is raised  if DTD-based\n             validation is carried out and the content of $arg is not valid against its\n             DTD.
    \n", "summary" : "
      This function takes as input an XML document represented as a string, and\n             returns the document node at the root of an XDM tree representing the parsed\n             document.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "baseURI", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "document(element(*,xs:untyped))", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "position", "qname" : "fn:position", "signature" : "() as xs:integer external", "description" : " 
    Returns the context position from the dynamic context.
    This function is deterministic, context-dependent,  and focus-dependent. 
    Returns the context position from the dynamic context. (See .)
    A dynamic error is raised  if the\n             context item is absent.
    \n", "summary" : "
      Returns the context position from the dynamic context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "prefix-from-QName", "qname" : "fn:prefix-from-QName", "signature" : "($arg as xs:QName?) as xs:NCName? external", "description" : " 
    Returns the prefix component of the supplied QName.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence the function returns the empty sequence.
    If $arg has no prefix component the function returns the empty\n             sequence.
    Otherwise, the function returns an xs:NCName representing the prefix\n             component of $arg.
    \n", "summary" : "
      Returns the prefix component of the supplied QName.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:QName", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:NCName?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove", "qname" : "fn:remove", "signature" : "($target as item()*, $position as xs:integer) as item()* external", "description" : " 
    Returns a new sequence containing all the items of $target except\n             the item at position $position.
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence consisting of all items of $target whose\n             index is less than $position, followed by all items of $target\n             whose index is greater than $position. 
    For detailed type semantics, see [Formal Semantics].
    If $position is less than 1 or greater than the number of items in\n                $target, $target is returned.
    If $target is the empty sequence, the empty sequence is returned.
    \n", "summary" : "
      Returns a new sequence containing all the items of  $target  except\n             the item at position  $position .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "target", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "position", "type" : "xs:integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "replace", "qname" : "fn:replace", "signature" : "($input as xs:string?, $pattern as xs:string, $replacement as xs:string) as xs:string external", "description" : " 
    Returns a string produced from the input string by replacing any substrings\n             that match a given regular expression with a supplied replacement string.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the first version of this function (omitting the argument\n                $flags) is the same as the effect of calling the second version with the\n                $flags argument set to a zero-length string. Flags are defined in\n                .
    The $flags argument is interpreted in the same manner as for the\n                fn:matches function. 
    If $input is the empty sequence, it is interpreted as the zero-length\n             string.
    The function returns the xs:string that is obtained by replacing each\n             non-overlapping substring of $input that matches the given\n                $pattern with an occurrence of the $replacement string.
    If two overlapping substrings of $input both match the\n                $pattern, then only the first one (that is, the one whose first character comes first in the $input string) is\n             replaced.
    If the q flag is present, the replacement string is used\n                as is.
    Otherwise, within the $replacement\n             string, a variable $N may be used to refer to the substring captured by the\n             Nth parenthesized sub-expression in the regular expression. For each match of the\n             pattern, these variables are assigned the value of the content matched by the relevant\n             sub-expression, and the modified replacement string is then substituted for the characters in $input that matched the pattern.\n                $0 refers to the substring captured by the regular expression as a\n             whole.
    More specifically, the rules are as follows, where S is the number of\n             parenthesized sub-expressions in the regular expression, and N is the\n             decimal number formed by taking all the digits that consecutively follow the\n                $ character:
    If N=0, then the variable is replaced by the substring\n                   matched by the regular expression as a whole.
    If 1<=N<=S, then the variable is\n                   replaced by the substring captured by the Nth parenthesized sub-expression. If the\n                      Nth parenthesized sub-expression was not matched, then the\n                   variable is replaced by the zero-length string.
    If S<N<=9, then the variable is\n                   replaced by the zero-length string.
    Otherwise (if N>S and\n                      N>9), the last digit of N is taken to\n                   be a literal character to be included \"as is\" in the replacement string, and the\n                   rules are reapplied using the number N formed by stripping off this\n                   last digit.
    For example, if the replacement string is \n                $23\n              and there are 5 substrings, the result contains the value of the substring that\n             matches the second sub-expression, followed by the digit \n                3\n             .
    Unless the q flag is used, a literal $\n             character within the replacement string must be written as \\$, and a\n             literal \\ character must be written as \\\\.
     If two alternatives within the pattern both match at the same position in the\n                $input, then the match that is chosen is the one matched by the first\n             alternative. For example:
     fn:replace(\"abcd\", \"(ab)|(a)\", \"[1=$1][2=$2]\") returns \"[1=ab][2=]cd\"
    A dynamic error is raised  if the value of\n                $pattern is invalid according to the rules described in section . 
    A dynamic error is raised  if the value of\n                $flags is invalid according to the rules described in section . 
    A dynamic error is raised  if the pattern matches a\n             zero-length string, that is, if the expression fn:matches(\"\", $pattern,\n                $flags) returns true. It is not an error, however, if a captured\n             substring is zero-length.
    A dynamic error is raised  if the value of\n                $replacement contains a \"$\" character that is not\n             immediately followed by a digit 0-9 and not immediately preceded by a\n             \"\\\".
    A dynamic error is raised  if the value of\n                $replacement contains a \"\\\" character that is not part of a\n                \"\\\\\" pair, unless it is immediately followed by a \"$\"\n             character.
    \n", "summary" : "
      Returns a string produced from the input string by replacing any substrings\n             that match a given regular expression with a supplied replacement string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "replacement", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "replace", "qname" : "fn:replace", "signature" : "($input as xs:string?, $pattern as xs:string, $replacement as xs:string, $flags as xs:string) as xs:string external", "description" : " 
    Returns a string produced from the input string by replacing any substrings\n             that match a given regular expression with a supplied replacement string.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the first version of this function (omitting the argument\n                $flags) is the same as the effect of calling the second version with the\n                $flags argument set to a zero-length string. Flags are defined in\n                .
    The $flags argument is interpreted in the same manner as for the\n                fn:matches function. 
    If $input is the empty sequence, it is interpreted as the zero-length\n             string.
    The function returns the xs:string that is obtained by replacing each\n             non-overlapping substring of $input that matches the given\n                $pattern with an occurrence of the $replacement string.
    If two overlapping substrings of $input both match the\n                $pattern, then only the first one (that is, the one whose first character comes first in the $input string) is\n             replaced.
    If the q flag is present, the replacement string is used\n                as is.
    Otherwise, within the $replacement\n             string, a variable $N may be used to refer to the substring captured by the\n             Nth parenthesized sub-expression in the regular expression. For each match of the\n             pattern, these variables are assigned the value of the content matched by the relevant\n             sub-expression, and the modified replacement string is then substituted for the characters in $input that matched the pattern.\n                $0 refers to the substring captured by the regular expression as a\n             whole.
    More specifically, the rules are as follows, where S is the number of\n             parenthesized sub-expressions in the regular expression, and N is the\n             decimal number formed by taking all the digits that consecutively follow the\n                $ character:
    If N=0, then the variable is replaced by the substring\n                   matched by the regular expression as a whole.
    If 1<=N<=S, then the variable is\n                   replaced by the substring captured by the Nth parenthesized sub-expression. If the\n                      Nth parenthesized sub-expression was not matched, then the\n                   variable is replaced by the zero-length string.
    If S<N<=9, then the variable is\n                   replaced by the zero-length string.
    Otherwise (if N>S and\n                      N>9), the last digit of N is taken to\n                   be a literal character to be included \"as is\" in the replacement string, and the\n                   rules are reapplied using the number N formed by stripping off this\n                   last digit.
    For example, if the replacement string is \n                $23\n              and there are 5 substrings, the result contains the value of the substring that\n             matches the second sub-expression, followed by the digit \n                3\n             .
    Unless the q flag is used, a literal $\n             character within the replacement string must be written as \\$, and a\n             literal \\ character must be written as \\\\.
     If two alternatives within the pattern both match at the same position in the\n                $input, then the match that is chosen is the one matched by the first\n             alternative. For example:
     fn:replace(\"abcd\", \"(ab)|(a)\", \"[1=$1][2=$2]\") returns \"[1=ab][2=]cd\"
    A dynamic error is raised  if the value of\n                $pattern is invalid according to the rules described in section . 
    A dynamic error is raised  if the value of\n                $flags is invalid according to the rules described in section . 
    A dynamic error is raised  if the pattern matches a\n             zero-length string, that is, if the expression fn:matches(\"\", $pattern,\n                $flags) returns true. It is not an error, however, if a captured\n             substring is zero-length.
    A dynamic error is raised  if the value of\n                $replacement contains a \"$\" character that is not\n             immediately followed by a digit 0-9 and not immediately preceded by a\n             \"\\\".
    A dynamic error is raised  if the value of\n                $replacement contains a \"\\\" character that is not part of a\n                \"\\\\\" pair, unless it is immediately followed by a \"$\"\n             character.
    \n", "summary" : "
      Returns a string produced from the input string by replacing any substrings\n             that match a given regular expression with a supplied replacement string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "replacement", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "flags", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "resolve-QName", "qname" : "fn:resolve-QName", "signature" : "($qname as xs:string?, $element as element(*)) as xs:QName? external", "description" : " 
    Returns an xs:QName value (that is, an expanded-QName) by taking\n             an xs:string that has the lexical form of an xs:QName (a\n             string in the form \"prefix:local-name\" or \"local-name\") and resolving it using the\n             in-scope namespaces for a given element.
    This function is deterministic, context-independent,  and focus-independent. 
    If $qname is the empty sequence, returns the empty sequence.
    More specifically, the function searches the namespace bindings of $element\n             for a binding whose name matches the prefix of $qname, or the zero-length\n             string if it has no prefix, and constructs an expanded-QName whose local name is taken\n             from the supplied $qname, and whose namespace URI is taken from the string\n             value of the namespace binding.
    If the $qname has no prefix, and there is no namespace binding for\n                $element corresponding to the default (unnamed) namespace, then the\n             resulting expanded-QName has no namespace part.
    The prefix (or absence of a prefix) in the supplied $qname argument is\n             retained in the returned expanded-QName, as discussed in .
    A dynamic error is raised  if $qname does not\n             have the correct lexical form for an instance of xs:QName.
    A dynamic error is raised  if $qname has a\n             prefix and there is no namespace binding for $element that matches this\n             prefix.
    \n", "summary" : "
      Returns an  xs:QName  value (that is, an expanded-QName) by taking\n             an  xs:string  that has the lexical form of an  xs:QName  (a\n             string in the form \"prefix:local-name\" or \"local-name\") and resolving it using the\n             in-scope namespaces for a given element.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "qname", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:QName?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "resolve-uri", "qname" : "fn:resolve-uri", "signature" : "($relative as xs:string?) as xs:anyURI? external", "description" : " 
    Resolves a relative IRI reference against an absolute IRI.
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the second argument is absent, the effect is the same as calling the two-argument\n             function with the value of fn:static-base-uri() as the second argument.
    The function is defined to operate on IRI references as defined in , and the implementation must permit all arguments that are valid\n             according to that specification. In addition, the implementation may\n             accept some or all strings that conform to the rules for (absolute or relative) Legacy\n             Extended IRI references as defined in . For the purposes of this\n             section, the terms IRI and IRI reference include these extensions, insofar as the\n             implementation chooses to support them.
    If $relative is the empty sequence, the function returns the empty\n             sequence.
    If $relative is an absolute IRI (as defined above), then it is returned\n             unchanged.
    Otherwise, the function resolves the relative IRI reference $relative\n             against the base IRI $base using the algorithm defined in , adapted by treating any character\n             that would not be valid in an RFC3986 URI or relative reference in the same way that\n             RFC3986 treats unreserved characters. No percent-encoding takes place.
    The first form of this function resolves $relative against the value of the\n             base-uri property from the static context. A dynamic error is raised  if the base-uri property is not initialized in the static context. 
    A dynamic error is raised  if $relative is not a\n             valid IRI according to the rules of RFC3987, extended with an implementation-defined\n             subset of the extensions permitted in LEIRI, or if it is not a suitable relative\n             reference to use as input to the RFC3986 resolution algorithm extended to handle\n             additional unreserved characters. 
    A dynamic error is raised  if $base is not a\n             valid IRI according to the rules of RFC3987, extended with an implementation-defined\n             subset of the extensions permitted in LEIRI, or if it is not a suitable IRI to use as\n             input to the chosen resolution algorithm (for example, if it is a relative IRI\n             reference, if it is a non-hierarchic URI, or if it contains a fragment identifier). 
    A dynamic error is raised  if the chosen resolution algorithm\n             fails for any other reason. 
    \n", "summary" : "
      Resolves a relative IRI reference against an absolute IRI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "relative", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "resolve-uri", "qname" : "fn:resolve-uri", "signature" : "($relative as xs:string?, $base as xs:string) as xs:anyURI? external", "description" : " 
    Resolves a relative IRI reference against an absolute IRI.
    The one-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The two-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the second argument is absent, the effect is the same as calling the two-argument\n             function with the value of fn:static-base-uri() as the second argument.
    The function is defined to operate on IRI references as defined in , and the implementation must permit all arguments that are valid\n             according to that specification. In addition, the implementation may\n             accept some or all strings that conform to the rules for (absolute or relative) Legacy\n             Extended IRI references as defined in . For the purposes of this\n             section, the terms IRI and IRI reference include these extensions, insofar as the\n             implementation chooses to support them.
    If $relative is the empty sequence, the function returns the empty\n             sequence.
    If $relative is an absolute IRI (as defined above), then it is returned\n             unchanged.
    Otherwise, the function resolves the relative IRI reference $relative\n             against the base IRI $base using the algorithm defined in , adapted by treating any character\n             that would not be valid in an RFC3986 URI or relative reference in the same way that\n             RFC3986 treats unreserved characters. No percent-encoding takes place.
    The first form of this function resolves $relative against the value of the\n             base-uri property from the static context. A dynamic error is raised  if the base-uri property is not initialized in the static context. 
    A dynamic error is raised  if $relative is not a\n             valid IRI according to the rules of RFC3987, extended with an implementation-defined\n             subset of the extensions permitted in LEIRI, or if it is not a suitable relative\n             reference to use as input to the RFC3986 resolution algorithm extended to handle\n             additional unreserved characters. 
    A dynamic error is raised  if $base is not a\n             valid IRI according to the rules of RFC3987, extended with an implementation-defined\n             subset of the extensions permitted in LEIRI, or if it is not a suitable IRI to use as\n             input to the chosen resolution algorithm (for example, if it is a relative IRI\n             reference, if it is a non-hierarchic URI, or if it contains a fragment identifier). 
    A dynamic error is raised  if the chosen resolution algorithm\n             fails for any other reason. 
    \n", "summary" : "
      Resolves a relative IRI reference against an absolute IRI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "relative", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "base", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "reverse", "qname" : "fn:reverse", "signature" : "($arg as item()*) as item()* external", "description" : " 
    Reverses the order of items in a sequence. 
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence containing the items in $arg in reverse\n             order.
    For detailed type semantics, see [Formal Semantics].
    If $arg is the empty sequence, the empty sequence is returned. 
    \n", "summary" : "
      Reverses the order of items in a sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "root", "qname" : "fn:root", "signature" : "() as node() external", "description" : " 
    Returns the root of the tree to which $arg belongs. This will\n             usually, but not necessarily, be a document node.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the function is called without an argument, the context item (.) is used\n             as the default argument. The behavior of the function if the argument is omitted is\n             exactly the same as if the context item had been passed as the argument.
    The function returns the value of the expression\n                ($arg/ancestor-or-self::node())[1].
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the root of the tree to which  $arg  belongs.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "node()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "root", "qname" : "fn:root", "signature" : "($arg as node()?) as node()? external", "description" : " 
    Returns the root of the tree to which $arg belongs. This will\n             usually, but not necessarily, be a document node.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    If the function is called without an argument, the context item (.) is used\n             as the default argument. The behavior of the function if the argument is omitted is\n             exactly the same as if the context item had been passed as the argument.
    The function returns the value of the expression\n                ($arg/ancestor-or-self::node())[1].
    The following errors may be raised when $arg is omitted:
    • If the context\n                item is absent, dynamic error\n                
    • If the context item is not a\n                node, type error .
    \n", "summary" : "
      Returns the root of the tree to which  $arg  belongs.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "node()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "node()?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "round-half-to-even", "qname" : "fn:round-half-to-even", "signature" : "($arg as numeric?) as numeric? external", "description" : " 
    Rounds a value to a specified number of decimal places, rounding to make the\n             last digit even if two such values are equally near.
    This function is deterministic, context-independent,  and focus-independent. 
    General rules: see .
    The function returns the nearest (that is, numerically closest) value to\n                $arg that is a multiple of ten to the power of minus\n                $precision. If two such values are equally near (e.g. if the fractional\n             part in $arg is exactly .500...), the function returns the one whose least\n             significant digit is even.
    If the type of $arg is one of the four numeric types xs:float,\n                xs:double, xs:decimal or xs:integer the type\n             of the result is the same as the type of $arg. If the type of\n                $arg is a type derived from one of the numeric types, the result is an\n             instance of the base numeric type.
     The first signature of this function produces the same result as the second signature\n             with $precision=0.
    For arguments of type xs:float and xs:double:
    If the argument is NaN, positive or negative zero, or positive or\n                   negative infinity, then the result is the same as the argument.
    In all other cases, the argument is cast to xs:decimal\n                   using an implementation of xs:decimal that imposes no\n                      limits on the number of digits that can be represented. The function\n                   is applied to this xs:decimal value, and the resulting\n                      xs:decimal is cast back to xs:float or\n                      xs:double as appropriate to form the function result. If the\n                   resulting xs:decimal value is zero, then positive or negative zero is\n                   returned according to the sign of the original argument.
    For detailed type semantics, see [Formal Semantics].
    This function is typically used in financial applications where the\n             argument is of type xs:decimal. For arguments of type xs:float\n             and xs:double the results may be counter-intuitive. For example, consider\n                round-half-to-even(xs:float(150.015), 2). The result is not 150.02 as\n             might be expected, but 150.01. This is because the conversion of the\n                xs:float value represented by the literal 150.015 to an\n                xs:decimal produces the xs:decimal value 150.014999389...,\n             which is closer to 150.01 than to 150.02.
    \n", "summary" : "
      Rounds a value to a specified number of decimal places, rounding to make the\n             last digit even if two such values are equally near.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "numeric", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "numeric?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "round-half-to-even", "qname" : "fn:round-half-to-even", "signature" : "($arg as numeric?, $precision as xs:integer) as numeric? external", "description" : " 
    Rounds a value to a specified number of decimal places, rounding to make the\n             last digit even if two such values are equally near.
    This function is deterministic, context-independent,  and focus-independent. 
    General rules: see .
    The function returns the nearest (that is, numerically closest) value to\n                $arg that is a multiple of ten to the power of minus\n                $precision. If two such values are equally near (e.g. if the fractional\n             part in $arg is exactly .500...), the function returns the one whose least\n             significant digit is even.
    If the type of $arg is one of the four numeric types xs:float,\n                xs:double, xs:decimal or xs:integer the type\n             of the result is the same as the type of $arg. If the type of\n                $arg is a type derived from one of the numeric types, the result is an\n             instance of the base numeric type.
     The first signature of this function produces the same result as the second signature\n             with $precision=0.
    For arguments of type xs:float and xs:double:
    If the argument is NaN, positive or negative zero, or positive or\n                   negative infinity, then the result is the same as the argument.
    In all other cases, the argument is cast to xs:decimal\n                   using an implementation of xs:decimal that imposes no\n                      limits on the number of digits that can be represented. The function\n                   is applied to this xs:decimal value, and the resulting\n                      xs:decimal is cast back to xs:float or\n                      xs:double as appropriate to form the function result. If the\n                   resulting xs:decimal value is zero, then positive or negative zero is\n                   returned according to the sign of the original argument.
    For detailed type semantics, see [Formal Semantics].
    This function is typically used in financial applications where the\n             argument is of type xs:decimal. For arguments of type xs:float\n             and xs:double the results may be counter-intuitive. For example, consider\n                round-half-to-even(xs:float(150.015), 2). The result is not 150.02 as\n             might be expected, but 150.01. This is because the conversion of the\n                xs:float value represented by the literal 150.015 to an\n                xs:decimal produces the xs:decimal value 150.014999389...,\n             which is closer to 150.01 than to 150.02.
    \n", "summary" : "
      Rounds a value to a specified number of decimal places, rounding to make the\n             last digit even if two such values are equally near.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "numeric", "occurrence" : "?", "description" : "" }, { "name" : "precision", "type" : "xs:integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "numeric?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "round", "qname" : "fn:round", "signature" : "($arg as numeric?) as numeric? external", "description" : " 
    Rounds a value to a specified number of decimal places, rounding upwards if two\n             such values are equally near.
    This function is deterministic, context-independent,  and focus-independent. 
    General rules: see .
    The function returns the nearest (that is, numerically closest) value to\n                $arg that is a multiple of ten to the power of minus\n                $precision. If two such values are equally near (for example, if the\n             fractional part in $arg is exactly .5), the function returns the one that\n             is closest to positive infinity.
    If the type of $arg is one of the four numeric types xs:float,\n                xs:double, xs:decimal or xs:integer the type\n             of the result is the same as the type of $arg. If the type of\n                $arg is a type derived from one of the numeric types, the result is an\n             instance of the base numeric type.
    The single-argument version of this function produces the same result as the\n             two-argument version with $precision=0 (that is, it rounds to a whole\n             number).
    When $arg is of type xs:float and xs:double:
    If $arg is NaN, positive or negative zero, or positive or negative\n                   infinity, then the result is the same as the argument.
    For other values, the argument is cast to xs:decimal using an\n                   implementation of xs:decimal that imposes no limits on the number of\n                   digits that can be represented. The function is applied to this\n                      xs:decimal value, and the resulting xs:decimal is\n                   cast back to xs:float or xs:double as appropriate to\n                   form the function result. If the resulting xs:decimal value is zero,\n                   then positive or negative zero is returned according to the sign of\n                      $arg.
    For detailed type semantics, see [Formal Semantics].
    This function is typically used with a non-zero $precision in financial\n             applications where the argument is of type xs:decimal. For arguments of\n             type xs:float and xs:double the results may be\n             counter-intuitive. For example, consider round(35.425e0, 2). The result is\n             not 35.43, as might be expected, but 35.42. This is because the xs:double written as 35.425e0\n             has an exact value equal to 35.42499999999..., which is closer\n             to 35.42 than to 35.43.
    \n", "summary" : "
      Rounds a value to a specified number of decimal places, rounding upwards if two\n             such values are equally near.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "numeric", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "numeric?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "round", "qname" : "fn:round", "signature" : "($arg as numeric?, $precision as xs:integer) as numeric? external", "description" : " 
    Rounds a value to a specified number of decimal places, rounding upwards if two\n             such values are equally near.
    This function is deterministic, context-independent,  and focus-independent. 
    General rules: see .
    The function returns the nearest (that is, numerically closest) value to\n                $arg that is a multiple of ten to the power of minus\n                $precision. If two such values are equally near (for example, if the\n             fractional part in $arg is exactly .5), the function returns the one that\n             is closest to positive infinity.
    If the type of $arg is one of the four numeric types xs:float,\n                xs:double, xs:decimal or xs:integer the type\n             of the result is the same as the type of $arg. If the type of\n                $arg is a type derived from one of the numeric types, the result is an\n             instance of the base numeric type.
    The single-argument version of this function produces the same result as the\n             two-argument version with $precision=0 (that is, it rounds to a whole\n             number).
    When $arg is of type xs:float and xs:double:
    If $arg is NaN, positive or negative zero, or positive or negative\n                   infinity, then the result is the same as the argument.
    For other values, the argument is cast to xs:decimal using an\n                   implementation of xs:decimal that imposes no limits on the number of\n                   digits that can be represented. The function is applied to this\n                      xs:decimal value, and the resulting xs:decimal is\n                   cast back to xs:float or xs:double as appropriate to\n                   form the function result. If the resulting xs:decimal value is zero,\n                   then positive or negative zero is returned according to the sign of\n                      $arg.
    For detailed type semantics, see [Formal Semantics].
    This function is typically used with a non-zero $precision in financial\n             applications where the argument is of type xs:decimal. For arguments of\n             type xs:float and xs:double the results may be\n             counter-intuitive. For example, consider round(35.425e0, 2). The result is\n             not 35.43, as might be expected, but 35.42. This is because the xs:double written as 35.425e0\n             has an exact value equal to 35.42499999999..., which is closer\n             to 35.42 than to 35.43.
    \n", "summary" : "
      Rounds a value to a specified number of decimal places, rounding upwards if two\n             such values are equally near.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "numeric", "occurrence" : "?", "description" : "" }, { "name" : "precision", "type" : "xs:integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "numeric?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "seconds-from-dateTime", "qname" : "fn:seconds-from-dateTime", "signature" : "($arg as xs:dateTime?) as xs:decimal? external", "description" : " 
    Returns the seconds component of an xs:dateTime.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:decimal value greater than or equal\n             to zero and less than 60, representing the seconds and fractional seconds in the local\n             value of $arg.
    The expression fn:seconds-from-dateTime(xs:dateTime(\"1999-05-31T13:20:00-05:00\")) returns 0.
    \n", "summary" : "
      Returns the seconds component of an  xs:dateTime .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "seconds-from-duration", "qname" : "fn:seconds-from-duration", "signature" : "($arg as xs:duration?) as xs:decimal? external", "description" : " 
    Returns the number of seconds in a duration.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:decimal representing the seconds\n             component in the value of $arg. The result is obtained by casting\n                $arg to an xs:dayTimeDuration (see ) and then computing the seconds component as described\n             in .
    If $arg is a negative duration then the result will be negative..
    If $arg is an xs:yearMonthDuration the function returns 0.
    The expression fn:seconds-from-duration(xs:dayTimeDuration(\"P3DT10H12.5S\")) returns 12.5.
    The expression fn:seconds-from-duration(xs:dayTimeDuration(\"-PT256S\")) returns -16.0.
    \n", "summary" : "
      Returns the number of seconds in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "seconds-from-time", "qname" : "fn:seconds-from-time", "signature" : "($arg as xs:time?) as xs:decimal? external", "description" : " 
    Returns the seconds component of an xs:time.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:decimal value greater than or equal\n             to zero and less than 60, representing the seconds and fractional seconds in the local\n             value of $arg.
    The expression fn:seconds-from-time(xs:time(\"13:20:10.5\")) returns 10.5.
    \n", "summary" : "
      Returns the seconds component of an  xs:time .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "serialize", "qname" : "fn:serialize", "signature" : "($arg as item()*) as xs:string external", "description" : " 
    This function serializes the supplied input\n                sequence\n             $arg as described in ,\n             returning the serialized representation of the\n                sequence as a string.
    This function is deterministic, context-independent,  and focus-independent. 
    The value of $arg acts as the input sequence to the serialization process,\n             which starts with sequence normalization.
    The single-argument version of this function has the same effect as\n             the two-argument version called with $params set to an empty sequence. This\n             in turn is the same as the effect of passing an\n                output:serialization-parameters element with no child elements.
    The $params argument is used to identify a set of\n             serialization parameters. These are supplied in the form of an\n                output:serialization-parameters element, having the format described in\n                .
    The final stage of serialization, that is, encoding, is skipped. If the serializer does\n             not allow this phase to be skipped, then the sequence of octets returned by the\n             serializer is decoded into a string by reversing the character encoding performed in the\n             final stage.
    If the host language makes serialization an optional feature and\n          the implementation does not support serialization, then a dynamic error\n              is raised.
    The serialization process will raise an error if $arg is an attribute or\n             namespace node.
    If any serialization error occurs, including the detection of an invalid value for a\n             serialization parameter, this results in the fn:serialize call failing with\n             a dynamic error.
    \n", "summary" : "
      This function serializes the supplied  input\n                sequence \n              $arg  as described in   ,\n             returning the serialized  representation of the\n                sequence  as a string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "serialize", "qname" : "fn:serialize", "signature" : "($arg as item()*, $params as element(output:serialization-parameters)?) as xs:string external", "description" : " 
    This function serializes the supplied input\n                sequence\n             $arg as described in ,\n             returning the serialized representation of the\n                sequence as a string.
    This function is deterministic, context-independent,  and focus-independent. 
    The value of $arg acts as the input sequence to the serialization process,\n             which starts with sequence normalization.
    The single-argument version of this function has the same effect as\n             the two-argument version called with $params set to an empty sequence. This\n             in turn is the same as the effect of passing an\n                output:serialization-parameters element with no child elements.
    The $params argument is used to identify a set of\n             serialization parameters. These are supplied in the form of an\n                output:serialization-parameters element, having the format described in\n                .
    The final stage of serialization, that is, encoding, is skipped. If the serializer does\n             not allow this phase to be skipped, then the sequence of octets returned by the\n             serializer is decoded into a string by reversing the character encoding performed in the\n             final stage.
    If the host language makes serialization an optional feature and\n          the implementation does not support serialization, then a dynamic error\n              is raised.
    The serialization process will raise an error if $arg is an attribute or\n             namespace node.
    If any serialization error occurs, including the detection of an invalid value for a\n             serialization parameter, this results in the fn:serialize call failing with\n             a dynamic error.
    \n", "summary" : "
      This function serializes the supplied  input\n                sequence \n              $arg  as described in   ,\n             returning the serialized  representation of the\n                sequence  as a string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "params", "type" : "element(output:serialization-parameters)", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "starts-with", "qname" : "fn:starts-with", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean external", "description" : " 
    Returns true if the string $arg1 contains $arg2 as a\n             leading substring, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
    If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n                true. If the value of $arg1 is the zero-length string and\n             the value of $arg2 is not the zero-length string, then the function returns\n                false.
    The collation used by this function is determined according to the rules in .
    The function returns an xs:boolean indicating whether or not the value of\n                $arg1 starts with a sequence of collation units that provides a\n                match to the collation units of $arg2 according to the\n             collation that is used.
    Match is defined in .
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns true if the string  $arg1  contains  $arg2  as a\n             leading substring, taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "starts-with", "qname" : "fn:starts-with", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:boolean external", "description" : " 
    Returns true if the string $arg1 contains $arg2 as a\n             leading substring, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
    If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n                true. If the value of $arg1 is the zero-length string and\n             the value of $arg2 is not the zero-length string, then the function returns\n                false.
    The collation used by this function is determined according to the rules in .
    The function returns an xs:boolean indicating whether or not the value of\n                $arg1 starts with a sequence of collation units that provides a\n                match to the collation units of $arg2 according to the\n             collation that is used.
    Match is defined in .
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns true if the string  $arg1  contains  $arg2  as a\n             leading substring, taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "static-base-uri", "qname" : "fn:static-base-uri", "signature" : "() as xs:anyURI? external", "description" : " 
    This function returns the value of the Static Base URI property from the static context.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The function returns the value of the Static Base URI property from the static context. If the\n             property is absent, the empty sequence is returned.
    Components of the static context are discussed in  .
    XQuery 3.0 and XSLT 3.0 give an implementation freedom to use different base URIs during the\n          static analysis phase and the dynamic evaluation phase, that is, for compile-time and run-time resources respectively.\n          In this situation, the fn:static-base-uri function should return a URI suitable for locating resources needed\n          during dynamic evaluation.
    \n", "summary" : "
      This function returns the value of the Static Base URI property from the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "string-join", "qname" : "fn:string-join", "signature" : "($arg1 as xs:string*) as xs:string external", "description" : " 
    Returns a string created by concatenating the items in a sequence, with a\n             defined separator between adjacent items.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the single-argument version of this function is\n             the same as calling the two-argument version with $arg2 set to a\n             zero-length string.
    The function returns an xs:string created by concatenating the items in the\n             sequence $arg1, in order, using the value of $arg2 as a\n             separator between adjacent items. If the value of $arg2 is the zero-length\n             string, then the members of $arg1 are concatenated without a separator.
    If the value of $arg1 is the empty sequence, the function returns the\n             zero-length string.
    \n", "summary" : "
      Returns a string created by concatenating the items in a sequence, with a\n             defined separator between adjacent items.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "string-join", "qname" : "fn:string-join", "signature" : "($arg1 as xs:string*, $arg2 as xs:string) as xs:string external", "description" : " 
    Returns a string created by concatenating the items in a sequence, with a\n             defined separator between adjacent items.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the single-argument version of this function is\n             the same as calling the two-argument version with $arg2 set to a\n             zero-length string.
    The function returns an xs:string created by concatenating the items in the\n             sequence $arg1, in order, using the value of $arg2 as a\n             separator between adjacent items. If the value of $arg2 is the zero-length\n             string, then the members of $arg1 are concatenated without a separator.
    If the value of $arg1 is the empty sequence, the function returns the\n             zero-length string.
    \n", "summary" : "
      Returns a string created by concatenating the items in a sequence, with a\n             defined separator between adjacent items.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "*", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "string-length", "qname" : "fn:string-length", "signature" : "() as xs:integer external", "description" : " 
    Returns the number of characters in a\n             string.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The function returns an xs:integer equal to the length in characters of the value of $arg.
    Calling the zero-argument version of the function is equivalent to calling\n                fn:string-length(fn:string(.)).
    If the value of $arg is the empty sequence, the function returns the\n                xs:integer value zero (0).
    If $arg is not specified and the context item is absent, a dynamic error is raised: .
    \n", "summary" : "
      Returns the number of  characters  in a\n             string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "string-length", "qname" : "fn:string-length", "signature" : "($arg as xs:string?) as xs:integer external", "description" : " 
    Returns the number of characters in a\n             string.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    The function returns an xs:integer equal to the length in characters of the value of $arg.
    Calling the zero-argument version of the function is equivalent to calling\n                fn:string-length(fn:string(.)).
    If the value of $arg is the empty sequence, the function returns the\n                xs:integer value zero (0).
    If $arg is not specified and the context item is absent, a dynamic error is raised: .
    \n", "summary" : "
      Returns the number of  characters  in a\n             string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "string-to-codepoints", "qname" : "fn:string-to-codepoints", "signature" : "($arg as xs:string?) as xs:integer* external", "description" : " 
    Returns the sequence of codepoints that\n             constitute an xs:string value. 
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence of integers, each integer being the Unicode codepoints of the corresponding character in $arg.
    If $arg is a zero-length string or the empty sequence, the function returns\n             the empty sequence.
    The expression fn:string-to-codepoints(\"Thérèse\") returns (84, 104, 233, 114, 232, 115, 101).
    \n", "summary" : "
      Returns the sequence of  codepoints  that\n             constitute an  xs:string  value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "string-to-codepoints", "qname" : "fn:string-to-codepoints", "signature" : "($arg as xs:string?) as xs:integer* external", "description" : " 
    Returns the sequence of codepoints that\n             constitute an xs:string value. 
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns a sequence of integers, each integer being the Unicode codepoints of the corresponding character in $arg.
    If $arg is a zero-length string or the empty sequence, the function returns\n             the empty sequence.
    The expression fn:string-to-codepoints(\"Thérèse\") returns (84, 104, 233, 114, 232, 115, 101).
    \n", "summary" : "
      Returns the sequence of  codepoints  that\n             constitute an  xs:string  value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "string", "qname" : "fn:string", "signature" : "() as xs:string external", "description" : " 
    Returns the value of $arg represented as an\n             xs:string.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    In the zero-argument version of the function, $arg defaults to the context\n             item. That is, calling fn:string() is equivalent to calling\n                fn:string(.).
    If $arg is the empty sequence, the function returns the zero-length\n             string.
    If $arg is a node, the function returns the string-value of the node, as\n             obtained using the dm:string-value accessor defined in  (see ).
    If $arg is an atomic value, the function returns the result of the\n             expression $arg cast as xs:string (see ).
    A dynamic error is raised  by the\n             zero-argument version of the function if the context item is absent. 
    A type error is raised  if\n                $arg is a function item. 
    \n", "summary" : "
      Returns the value of  $arg  represented as an\n              xs:string .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "string", "qname" : "fn:string", "signature" : "($arg as item()?) as xs:string external", "description" : " 
    Returns the value of $arg represented as an\n             xs:string.
    The zero-argument form of this function is deterministic, context-dependent,  and focus-dependent. 
    The one-argument form of this function is deterministic, context-independent,  and focus-independent. 
    In the zero-argument version of the function, $arg defaults to the context\n             item. That is, calling fn:string() is equivalent to calling\n                fn:string(.).
    If $arg is the empty sequence, the function returns the zero-length\n             string.
    If $arg is a node, the function returns the string-value of the node, as\n             obtained using the dm:string-value accessor defined in  (see ).
    If $arg is an atomic value, the function returns the result of the\n             expression $arg cast as xs:string (see ).
    A dynamic error is raised  by the\n             zero-argument version of the function if the context item is absent. 
    A type error is raised  if\n                $arg is a function item. 
    \n", "summary" : "
      Returns the value of  $arg  represented as an\n              xs:string .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "subsequence", "qname" : "fn:subsequence", "signature" : "($sourceSeq as item()*, $startingLoc as xs:double) as item()* external", "description" : " 
    Returns the contiguous sequence of items in the value of\n                $sourceSeq beginning at the position indicated by the value of\n                $startingLoc and continuing for the number of items indicated by the\n             value of $length. 
    This function is deterministic, context-independent,  and focus-independent. 
    In the two-argument case, returns:
    $sourceSeq[fn:round($startingLoc) le position()]
    In the three-argument case, returns:
    $sourceSeq[fn:round($startingLoc) le position()\n          and position() lt fn:round($startingLoc) + fn:round($length)]
    For detailed type semantics, see [Formal Semantics].
    The first item of a sequence is located at position 1, not position 0.
    If $sourceSeq is the empty sequence, the empty sequence is returned.
     If $startingLoc is zero or negative, the subsequence includes items from\n             the beginning of the $sourceSeq.
     If $length is not specified, the subsequence includes items to the end of\n                $sourceSeq.
     If $length is greater than the number of items in the value of\n                $sourceSeq following $startingLoc, the subsequence includes\n             items to the end of $sourceSeq.
    As an exception to the previous two notes, if\n                $startingLoc is -INF and $length is\n                +INF, then fn:round($startingLoc) + fn:round($length) is\n                NaN; since position() lt NaN is always false, the result is\n             an empty sequence.
    The reason the function accepts arguments of type xs:double is that many\n             computations on untyped data return an xs:double result; and the reason for\n             the rounding rules is to compensate for any imprecision in these floating-point\n             computations.
    \n", "summary" : "
      Returns the contiguous sequence of items in the value of\n                 $sourceSeq  beginning at the position indicated by the value of\n                 $startingLoc  and continuing for the number of items indicated by the\n             value of  $length .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sourceSeq", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "startingLoc", "type" : "xs:double", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "subsequence", "qname" : "fn:subsequence", "signature" : "($sourceSeq as item()*, $startingLoc as xs:double, $length as xs:double) as item()* external", "description" : " 
    Returns the contiguous sequence of items in the value of\n                $sourceSeq beginning at the position indicated by the value of\n                $startingLoc and continuing for the number of items indicated by the\n             value of $length. 
    This function is deterministic, context-independent,  and focus-independent. 
    In the two-argument case, returns:
    $sourceSeq[fn:round($startingLoc) le position()]
    In the three-argument case, returns:
    $sourceSeq[fn:round($startingLoc) le position()\n          and position() lt fn:round($startingLoc) + fn:round($length)]
    For detailed type semantics, see [Formal Semantics].
    The first item of a sequence is located at position 1, not position 0.
    If $sourceSeq is the empty sequence, the empty sequence is returned.
     If $startingLoc is zero or negative, the subsequence includes items from\n             the beginning of the $sourceSeq.
     If $length is not specified, the subsequence includes items to the end of\n                $sourceSeq.
     If $length is greater than the number of items in the value of\n                $sourceSeq following $startingLoc, the subsequence includes\n             items to the end of $sourceSeq.
    As an exception to the previous two notes, if\n                $startingLoc is -INF and $length is\n                +INF, then fn:round($startingLoc) + fn:round($length) is\n                NaN; since position() lt NaN is always false, the result is\n             an empty sequence.
    The reason the function accepts arguments of type xs:double is that many\n             computations on untyped data return an xs:double result; and the reason for\n             the rounding rules is to compensate for any imprecision in these floating-point\n             computations.
    \n", "summary" : "
      Returns the contiguous sequence of items in the value of\n                 $sourceSeq  beginning at the position indicated by the value of\n                 $startingLoc  and continuing for the number of items indicated by the\n             value of  $length .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sourceSeq", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "startingLoc", "type" : "xs:double", "occurrence" : null, "description" : "" }, { "name" : "length", "type" : "xs:double", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-after", "qname" : "fn:substring-after", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?) as xs:string external", "description" : " 
    Returns the part of $arg1 that follows the first occurrence of\n                $arg2, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
    If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n             the value of $arg1.
    If the value of $arg1 does not contain a string that is equal to the value\n             of $arg2, then the function returns the zero-length string. 
    The collation used by this function is determined according to the rules in .
    The function returns the substring of the value of $arg1 that follows in\n             the value of $arg1 the first occurrence of a sequence of collation units\n             that provides a minimal match to the collation units of $arg2\n             according to the collation that is used. 
    Minimal match is defined in . 
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns the part of  $arg1  that follows the first occurrence of\n                 $arg2 , taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "substring-after", "qname" : "fn:substring-after", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:string external", "description" : " 
    Returns the part of $arg1 that follows the first occurrence of\n                $arg2, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
    If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n             the value of $arg1.
    If the value of $arg1 does not contain a string that is equal to the value\n             of $arg2, then the function returns the zero-length string. 
    The collation used by this function is determined according to the rules in .
    The function returns the substring of the value of $arg1 that follows in\n             the value of $arg1 the first occurrence of a sequence of collation units\n             that provides a minimal match to the collation units of $arg2\n             according to the collation that is used. 
    Minimal match is defined in . 
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns the part of  $arg1  that follows the first occurrence of\n                 $arg2 , taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-before", "qname" : "fn:substring-before", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?) as xs:string external", "description" : " 
    Returns the part of $arg1 that precedes the first occurrence of\n                $arg2, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
     If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n             the zero-length string. 
    If the value of $arg1 does not contain a string that is equal to the value\n             of $arg2, then the function returns the zero-length string. 
    The collation used by this function is determined according to the rules in .
    The function returns the substring of the value of $arg1 that precedes in\n             the value of $arg1 the first occurrence of a sequence of collation units\n             that provides a minimal match to the collation units of $arg2\n             according to the collation that is used.
    Minimal match is defined in . 
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns the part of  $arg1  that precedes the first occurrence of\n                 $arg2 , taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "substring-before", "qname" : "fn:substring-before", "signature" : "($arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:string external", "description" : " 
    Returns the part of $arg1 that precedes the first occurrence of\n                $arg2, taking collations into account.
    The two-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations.\n \t
    The three-argument form of this function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tcollations, and static base uri.\n \t
     If the value of $arg1 or $arg2 is the empty sequence, or\n             contains only ignorable collation units, it is interpreted as the zero-length\n             string.
    If the value of $arg2 is the zero-length string, then the function returns\n             the zero-length string. 
    If the value of $arg1 does not contain a string that is equal to the value\n             of $arg2, then the function returns the zero-length string. 
    The collation used by this function is determined according to the rules in .
    The function returns the substring of the value of $arg1 that precedes in\n             the value of $arg1 the first occurrence of a sequence of collation units\n             that provides a minimal match to the collation units of $arg2\n             according to the collation that is used.
    Minimal match is defined in . 
    A dynamic error may be raised  if the\n             specified collation does not support collation units.
    \n", "summary" : "
      Returns the part of  $arg1  that precedes the first occurrence of\n                 $arg2 , taking collations into account.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "collation", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring", "qname" : "fn:substring", "signature" : "($sourceString as xs:string?, $start as xs:double) as xs:string external", "description" : " 
    Returns the portion of the value of $sourceString beginning at the\n             position indicated by the value of $start and continuing for the number of\n                characters indicated by the value of\n                $length.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $sourceString is the empty sequence, the function returns\n             the zero-length string. 
    Otherwise, the function returns a string comprising those characters of $sourceString whose index position (counting\n             from one) is greater than or equal to the value of $start (rounded to an\n             integer), and (if $length is specified) less than the sum of\n                $start and $length (both rounded to integers).
    The characters returned do not extend beyond $sourceString. If\n                $start is zero or negative, only those characters in positions greater\n             than zero are returned.
    More specifically, the three argument version of the function returns the characters in\n                $sourceString whose position $p satisfies:
    \n             fn:round($start) <= $p < fn:round($start) + fn:round($length)\n          
    The two argument version of the function assumes that $length is infinite\n             and thus returns the characters in\n                $sourceString whose position $p satisfies:
    \n             fn:round($start) <= $p\n          
    In the above computations, the rules for op:numeric-less-than and\n                op:numeric-greater-than apply.
    The first character of a string is located at position 1, not position 0.
    \n", "summary" : "
      Returns the portion of the value of  $sourceString  beginning at the\n             position indicated by the value of  $start  and continuing for the number of\n                 characters  indicated by the value of\n                 $length .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sourceString", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "start", "type" : "xs:double", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "substring", "qname" : "fn:substring", "signature" : "($sourceString as xs:string?, $start as xs:double, $length as xs:double) as xs:string external", "description" : " 
    Returns the portion of the value of $sourceString beginning at the\n             position indicated by the value of $start and continuing for the number of\n                characters indicated by the value of\n                $length.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $sourceString is the empty sequence, the function returns\n             the zero-length string. 
    Otherwise, the function returns a string comprising those characters of $sourceString whose index position (counting\n             from one) is greater than or equal to the value of $start (rounded to an\n             integer), and (if $length is specified) less than the sum of\n                $start and $length (both rounded to integers).
    The characters returned do not extend beyond $sourceString. If\n                $start is zero or negative, only those characters in positions greater\n             than zero are returned.
    More specifically, the three argument version of the function returns the characters in\n                $sourceString whose position $p satisfies:
    \n             fn:round($start) <= $p < fn:round($start) + fn:round($length)\n          
    The two argument version of the function assumes that $length is infinite\n             and thus returns the characters in\n                $sourceString whose position $p satisfies:
    \n             fn:round($start) <= $p\n          
    In the above computations, the rules for op:numeric-less-than and\n                op:numeric-greater-than apply.
    The first character of a string is located at position 1, not position 0.
    \n", "summary" : "
      Returns the portion of the value of  $sourceString  beginning at the\n             position indicated by the value of  $start  and continuing for the number of\n                 characters  indicated by the value of\n                 $length .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sourceString", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "start", "type" : "xs:double", "occurrence" : null, "description" : "" }, { "name" : "length", "type" : "xs:double", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sum", "qname" : "fn:sum", "signature" : "($arg as xs:anyAtomicType*) as xs:anyAtomicType external", "description" : " 
    Returns a value obtained by adding together the values in\n             $arg.
    This function is deterministic, context-independent,  and focus-independent. 
    Any values of type xs:untypedAtomic in $arg are cast to\n                xs:double. The items in the resulting sequence may be reordered in an\n             arbitrary order. The resulting sequence is referred to below as the converted\n             sequence.
    If the converted sequence is empty, then the single-argument form of the function\n             returns the xs:integer value 0; the two-argument form returns\n             the value of the argument $zero.
    If the converted sequence contains the value NaN, NaN is\n             returned.
    All items in $arg must be numeric or derived from a single base type. In\n             addition, the type must support addition. Duration values must either all be\n                xs:yearMonthDuration values or must all be\n                xs:dayTimeDuration values. For numeric values, the numeric promotion\n             rules defined in  are used to promote all values to a single\n             common type. The sum of a sequence of integers will therefore be an integer, while the\n             sum of a numeric sequence that includes at least one xs:double will be an\n                xs:double. 
    The result of the function, using the second signature, is the result of the\n             expression:
    \n if (fn:count($c) eq 0) then\n     $zero\n else if (fn:count($c) eq 1) then\n     $c[1]\n else\n     $c[1] + fn:sum(subsequence($c, 2))
    where $c is the converted sequence.
    The result of the function, using the first signature, is the result of the expression:\n                fn:sum($arg, 0).
    For detailed type semantics, see [Formal Semantics].
    A type error is raised  if the input sequence contains\n             items of incompatible types, as described above.
    \n", "summary" : "
      Returns a value obtained by adding together the values in\n              $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "sum", "qname" : "fn:sum", "signature" : "($arg as xs:anyAtomicType*, $zero as xs:anyAtomicType?) as xs:anyAtomicType? external", "description" : " 
    Returns a value obtained by adding together the values in\n             $arg.
    This function is deterministic, context-independent,  and focus-independent. 
    Any values of type xs:untypedAtomic in $arg are cast to\n                xs:double. The items in the resulting sequence may be reordered in an\n             arbitrary order. The resulting sequence is referred to below as the converted\n             sequence.
    If the converted sequence is empty, then the single-argument form of the function\n             returns the xs:integer value 0; the two-argument form returns\n             the value of the argument $zero.
    If the converted sequence contains the value NaN, NaN is\n             returned.
    All items in $arg must be numeric or derived from a single base type. In\n             addition, the type must support addition. Duration values must either all be\n                xs:yearMonthDuration values or must all be\n                xs:dayTimeDuration values. For numeric values, the numeric promotion\n             rules defined in  are used to promote all values to a single\n             common type. The sum of a sequence of integers will therefore be an integer, while the\n             sum of a numeric sequence that includes at least one xs:double will be an\n                xs:double. 
    The result of the function, using the second signature, is the result of the\n             expression:
    \n if (fn:count($c) eq 0) then\n     $zero\n else if (fn:count($c) eq 1) then\n     $c[1]\n else\n     $c[1] + fn:sum(subsequence($c, 2))
    where $c is the converted sequence.
    The result of the function, using the first signature, is the result of the expression:\n                fn:sum($arg, 0).
    For detailed type semantics, see [Formal Semantics].
    A type error is raised  if the input sequence contains\n             items of incompatible types, as described above.
    \n", "summary" : "
      Returns a value obtained by adding together the values in\n              $arg .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "" }, { "name" : "zero", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "tail", "qname" : "fn:tail", "signature" : "($arg as item()*) as item()* external", "description" : " 
    Returns all but the first item in a sequence. 
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns the value of the expression subsequence($arg, 2)
    If $arg is the empty sequence, or a sequence containing a single item, then\n             the empty sequence is returned. 
    \n", "summary" : "
      Returns all but the first item in a sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-date", "qname" : "fn:timezone-from-date", "signature" : "($arg as xs:date?) as xs:dayTimeDuration? external", "description" : " 
    Returns the timezone component of an xs:date.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns the timezone component of $arg, if any. If\n                $arg has a timezone component, then the result is an\n                xs:dayTimeDuration that indicates deviation from UTC; its value may\n             range from +14:00 to -14:00 hours, both inclusive. If $arg has no timezone\n             component, the result is the empty sequence.
    The expression fn:timezone-from-date(xs:date(\"1999-05-31-05:00\")) returns xs:dayTimeDuration(\"-PT5H\").
    The expression fn:timezone-from-date(xs:date(\"2000-06-12Z\")) returns xs:dayTimeDuration(\"PT0S\").
    \n", "summary" : "
      Returns the timezone component of an  xs:date .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:dayTimeDuration?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-dateTime", "qname" : "fn:timezone-from-dateTime", "signature" : "($arg as xs:dateTime?) as xs:dayTimeDuration? external", "description" : " 
    Returns the timezone component of an xs:dateTime.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns the timezone component of $arg, if any. If\n                $arg has a timezone component, then the result is an\n                xs:dayTimeDuration that indicates deviation from UTC; its value may\n             range from +14:00 to -14:00 hours, both inclusive. If $arg has no timezone\n             component, the result is the empty sequence.
    The expression fn:timezone-from-dateTime(xs:dateTime(\"1999-05-31T13:20:00-05:00\")) returns xs:dayTimeDuration(\"-PT5H\").
    The expression fn:timezone-from-dateTime(xs:dateTime(\"2000-06-12T13:20:00Z\")) returns xs:dayTimeDuration(\"PT0S\").
    The expression fn:timezone-from-dateTime(xs:dateTime(\"2004-08-27T00:00:00\")) returns ().
    \n", "summary" : "
      Returns the timezone component of an  xs:dateTime .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:dayTimeDuration?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-time", "qname" : "fn:timezone-from-time", "signature" : "($arg as xs:time?) as xs:dayTimeDuration? external", "description" : " 
    Returns the timezone component of an xs:time.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns the timezone component of $arg, if any. If\n                $arg has a timezone component, then the result is an\n                xs:dayTimeDuration that indicates deviation from UTC; its value may\n             range from +14:00 to -14:00 hours, both inclusive. If $arg has no timezone\n             component, the result is the empty sequence.
    The expression fn:timezone-from-time(xs:time(\"13:20:00-05:00\")) returns xs:dayTimeDuration(\"-PT5H\").
    The expression fn:timezone-from-time(xs:time(\"13:20:00\")) returns ().
    \n", "summary" : "
      Returns the timezone component of an  xs:time .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:dayTimeDuration?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "tokenize", "qname" : "fn:tokenize", "signature" : "($input as xs:string?, $pattern as xs:string) as xs:string* external", "description" : " 
    Returns a sequence of strings constructed by splitting the input wherever a\n             separator is found; the separator is any substring that matches a given regular\n             expression.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the first version of this function (omitting the argument\n                $flags) is the same as the effect of calling the second version with the\n                $flags argument set to a zero-length string. Flags are defined in\n                .
    The $flags argument is interpreted in the same way as for the\n                fn:matches function.
    If $input is the empty sequence, or if $input is the\n             zero-length string, the function returns the empty sequence.
    The function returns a sequence of strings formed by breaking the $input\n             string into a sequence of strings, treating any substring that matches\n                $pattern as a separator. The separators themselves are not returned.
    If a separator occurs at the start of the $input string, the result\n             sequence will start with a zero-length string. Zero-length strings will also occur in\n             the result sequence if a separator occurs at the end of the $input string,\n             or if two adjacent substrings match the supplied $pattern.
     If two alternatives within the supplied $pattern both match at the same\n             position in the $input string, then the match that is chosen is the first.\n             For example:
     fn:tokenize(\"abracadabra\", \"(ab)|(a)\") returns (\"\", \"r\", \"c\", \"d\", \"r\", \"\")
    A dynamic error is raised  if the value of\n                $pattern is invalid according to the rules described in section .
    A dynamic error is raised  if the value of\n                $flags is invalid according to the rules described in section .
    A dynamic error is raised  if the supplied\n                $pattern matches a zero-length string, that is, if fn:matches(\"\",\n                $pattern, $flags) returns true. 
    \n", "summary" : "
      Returns a sequence of strings constructed by splitting the input wherever a\n             separator is found; the separator is any substring that matches a given regular\n             expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "tokenize", "qname" : "fn:tokenize", "signature" : "($input as xs:string?, $pattern as xs:string, $flags as xs:string) as xs:string* external", "description" : " 
    Returns a sequence of strings constructed by splitting the input wherever a\n             separator is found; the separator is any substring that matches a given regular\n             expression.
    This function is deterministic, context-independent,  and focus-independent. 
    The effect of calling the first version of this function (omitting the argument\n                $flags) is the same as the effect of calling the second version with the\n                $flags argument set to a zero-length string. Flags are defined in\n                .
    The $flags argument is interpreted in the same way as for the\n                fn:matches function.
    If $input is the empty sequence, or if $input is the\n             zero-length string, the function returns the empty sequence.
    The function returns a sequence of strings formed by breaking the $input\n             string into a sequence of strings, treating any substring that matches\n                $pattern as a separator. The separators themselves are not returned.
    If a separator occurs at the start of the $input string, the result\n             sequence will start with a zero-length string. Zero-length strings will also occur in\n             the result sequence if a separator occurs at the end of the $input string,\n             or if two adjacent substrings match the supplied $pattern.
     If two alternatives within the supplied $pattern both match at the same\n             position in the $input string, then the match that is chosen is the first.\n             For example:
     fn:tokenize(\"abracadabra\", \"(ab)|(a)\") returns (\"\", \"r\", \"c\", \"d\", \"r\", \"\")
    A dynamic error is raised  if the value of\n                $pattern is invalid according to the rules described in section .
    A dynamic error is raised  if the value of\n                $flags is invalid according to the rules described in section .
    A dynamic error is raised  if the supplied\n                $pattern matches a zero-length string, that is, if fn:matches(\"\",\n                $pattern, $flags) returns true. 
    \n", "summary" : "
      Returns a sequence of strings constructed by splitting the input wherever a\n             separator is found; the separator is any substring that matches a given regular\n             expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "flags", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "trace", "qname" : "fn:trace", "signature" : "($value as item()*, $label as xs:string) as item()* external", "description" : " 
    Provides an execution trace intended to be used in debugging queries.
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns the value of $value, unchanged.
    In addition, the values of $value, converted to an xs:string,\n             and $label\n             may be directed to a trace data set. The destination of the trace\n             output is . The format of the trace output is\n                . The ordering of output from calls of the\n                fn:trace function is .
    Consider a situation in which a user wants to investigate the actual value passed to\n                a function. Assume that in a particular execution, $v is an\n                   xs:decimal with value 124.84. Writing fn:trace($v,\n                   'the value of $v is:') will put the strings \"124.84\" and\n                   \"the value of $v is:\" in the trace data set in implementation\n                dependent order.
    \n", "summary" : "
      Provides an execution trace intended to be used in debugging queries.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "label", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "translate", "qname" : "fn:translate", "signature" : "($arg as xs:string?, $mapString as xs:string, $transString as xs:string) as xs:string external", "description" : " 
    Returns the value of $arg modified by replacing or removing\n             individual characters. 
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the function returns the\n             zero-length string.
    Otherwise, the function returns a result string constructed by processing each character in the value of $arg, in order,\n             according to the following rules:
    If the character does not appear in the value of $mapString then it\n                   is added to the result string unchanged.
    If the character first appears in the value of $mapString at some\n                   position M, where the value of $transString is\n                      M or more characters in length, then the character at position\n                      M in $transString is added to the result string.
    If the character first appears in the value of $mapString at some\n                   position M, where the value of $transString is less than\n                      M characters in length, then the character is omitted from the\n                   result string.
    If $mapString is the zero-length string then the function returns\n                $arg unchanged.
    If a character occurs more than once in $mapString, then the first\n             occurrence determines the action taken.
    If $transString is longer than $mapString, the excess\n             characters are ignored.
    \n", "summary" : "
      Returns the value of  $arg  modified by replacing or removing\n             individual characters.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "mapString", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "transString", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "true", "qname" : "fn:true", "signature" : "() as xs:boolean external", "description" : " 
    Returns the xs:boolean value true.
    This function is deterministic, context-independent,  and focus-independent. 
    The result is equivalent to xs:boolean(\"1\").
    The expression fn:true() returns xs:boolean(1).
    \n", "summary" : "
      Returns the  xs:boolean  value  true .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "unordered", "qname" : "fn:unordered", "signature" : "($sourceSeq as item()*) as item()* external", "description" : " 
    Returns the items of $sourceSeq in an  order.
    This function is deterministic, context-independent,  and focus-independent. 
    The function returns the items of $sourceSeq in an  order.
    Query optimizers may be able to do a better job if the order of the output sequence is\n             not specified. For example, when retrieving prices from a purchase order, if an index\n             exists on prices, it may be more efficient to return the prices in index order rather\n             than in document order.
    \n", "summary" : "
      Returns the items of  $sourceSeq  in an    order.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sourceSeq", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "unparsed-text-available", "qname" : "fn:unparsed-text-available", "signature" : "($href as xs:string?) as xs:boolean external", "description" : " 
    Because errors in evaluating the fn:unparsed-text function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The fn:unparsed-text-available function determines whether a call\n             on the fn:unparsed-text function with identical arguments would\n             return a string.
    If the first argument is an empty sequence, the function returns false. If the second\n             argument is an empty sequence, the function behaves as if the second argument were\n             omitted.
    In other cases, the function returns true if a call on\n                fn:unparsed-text with the same arguments would succeed, and\n             false if a call on fn:unparsed-text with the same arguments would\n             fail with a non-recoverable dynamic error.
    The functions fn:unparsed-text and\n                fn:unparsed-text-available have the same requirement for\n                determinism as the functions\n                fn:doc and fn:doc-available. This means that unless the\n             user has explicitly stated a requirement for a reduced level of determinism, either of\n             these functions if called twice with the same arguments during the course of a\n             transformation must return the same results each time; moreover, the\n             results of a call on fn:unparsed-text-available\n             must be consistent with the results of a subsequent call on\n                unparsed-text with the same arguments.
    This requires that the unparsed-text-available function should\n             actually attempt to read the resource identified by the URI, and check that it is\n             correctly encoded and contains no characters that are invalid in XML. Implementations\n             may avoid the cost of repeating these checks for example by caching the validated\n             contents of the resource, to anticipate a subsequent call on the\n                unparsed-text\n             or unparsed-text-lines\n              function. Alternatively, implementations may be able to rewrite an expression\n             such as if (unparsed-text-available(A)) then unparsed-text(A) else ... to\n             generate a single call internally.
    \n", "summary" : "
      Because errors in evaluating the  fn:unparsed-text  function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "unparsed-text-available", "qname" : "fn:unparsed-text-available", "signature" : "($href as xs:string?) as xs:boolean external", "description" : " 
    Because errors in evaluating the fn:unparsed-text function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The fn:unparsed-text-available function determines whether a call\n             on the fn:unparsed-text function with identical arguments would\n             return a string.
    If the first argument is an empty sequence, the function returns false. If the second\n             argument is an empty sequence, the function behaves as if the second argument were\n             omitted.
    In other cases, the function returns true if a call on\n                fn:unparsed-text with the same arguments would succeed, and\n             false if a call on fn:unparsed-text with the same arguments would\n             fail with a non-recoverable dynamic error.
    The functions fn:unparsed-text and\n                fn:unparsed-text-available have the same requirement for\n                determinism as the functions\n                fn:doc and fn:doc-available. This means that unless the\n             user has explicitly stated a requirement for a reduced level of determinism, either of\n             these functions if called twice with the same arguments during the course of a\n             transformation must return the same results each time; moreover, the\n             results of a call on fn:unparsed-text-available\n             must be consistent with the results of a subsequent call on\n                unparsed-text with the same arguments.
    This requires that the unparsed-text-available function should\n             actually attempt to read the resource identified by the URI, and check that it is\n             correctly encoded and contains no characters that are invalid in XML. Implementations\n             may avoid the cost of repeating these checks for example by caching the validated\n             contents of the resource, to anticipate a subsequent call on the\n                unparsed-text\n             or unparsed-text-lines\n              function. Alternatively, implementations may be able to rewrite an expression\n             such as if (unparsed-text-available(A)) then unparsed-text(A) else ... to\n             generate a single call internally.
    \n", "summary" : "
      Because errors in evaluating the  fn:unparsed-text  function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "unparsed-text-available", "qname" : "fn:unparsed-text-available", "signature" : "($href as xs:string?, $encoding as xs:string) as xs:boolean external", "description" : " 
    Because errors in evaluating the fn:unparsed-text function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The fn:unparsed-text-available function determines whether a call\n             on the fn:unparsed-text function with identical arguments would\n             return a string.
    If the first argument is an empty sequence, the function returns false. If the second\n             argument is an empty sequence, the function behaves as if the second argument were\n             omitted.
    In other cases, the function returns true if a call on\n                fn:unparsed-text with the same arguments would succeed, and\n             false if a call on fn:unparsed-text with the same arguments would\n             fail with a non-recoverable dynamic error.
    The functions fn:unparsed-text and\n                fn:unparsed-text-available have the same requirement for\n                determinism as the functions\n                fn:doc and fn:doc-available. This means that unless the\n             user has explicitly stated a requirement for a reduced level of determinism, either of\n             these functions if called twice with the same arguments during the course of a\n             transformation must return the same results each time; moreover, the\n             results of a call on fn:unparsed-text-available\n             must be consistent with the results of a subsequent call on\n                unparsed-text with the same arguments.
    This requires that the unparsed-text-available function should\n             actually attempt to read the resource identified by the URI, and check that it is\n             correctly encoded and contains no characters that are invalid in XML. Implementations\n             may avoid the cost of repeating these checks for example by caching the validated\n             contents of the resource, to anticipate a subsequent call on the\n                unparsed-text\n             or unparsed-text-lines\n              function. Alternatively, implementations may be able to rewrite an expression\n             such as if (unparsed-text-available(A)) then unparsed-text(A) else ... to\n             generate a single call internally.
    \n", "summary" : "
      Because errors in evaluating the  fn:unparsed-text  function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "unparsed-text-available", "qname" : "fn:unparsed-text-available", "signature" : "($href as xs:string?, $encoding as xs:string) as xs:boolean external", "description" : " 
    Because errors in evaluating the fn:unparsed-text function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The fn:unparsed-text-available function determines whether a call\n             on the fn:unparsed-text function with identical arguments would\n             return a string.
    If the first argument is an empty sequence, the function returns false. If the second\n             argument is an empty sequence, the function behaves as if the second argument were\n             omitted.
    In other cases, the function returns true if a call on\n                fn:unparsed-text with the same arguments would succeed, and\n             false if a call on fn:unparsed-text with the same arguments would\n             fail with a non-recoverable dynamic error.
    The functions fn:unparsed-text and\n                fn:unparsed-text-available have the same requirement for\n                determinism as the functions\n                fn:doc and fn:doc-available. This means that unless the\n             user has explicitly stated a requirement for a reduced level of determinism, either of\n             these functions if called twice with the same arguments during the course of a\n             transformation must return the same results each time; moreover, the\n             results of a call on fn:unparsed-text-available\n             must be consistent with the results of a subsequent call on\n                unparsed-text with the same arguments.
    This requires that the unparsed-text-available function should\n             actually attempt to read the resource identified by the URI, and check that it is\n             correctly encoded and contains no characters that are invalid in XML. Implementations\n             may avoid the cost of repeating these checks for example by caching the validated\n             contents of the resource, to anticipate a subsequent call on the\n                unparsed-text\n             or unparsed-text-lines\n              function. Alternatively, implementations may be able to rewrite an expression\n             such as if (unparsed-text-available(A)) then unparsed-text(A) else ... to\n             generate a single call internally.
    \n", "summary" : "
      Because errors in evaluating the  fn:unparsed-text  function are\n             non-recoverable, these two functions are provided to allow an application to determine\n             whether a call with particular arguments would succeed.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "unparsed-text-lines", "qname" : "fn:unparsed-text-lines", "signature" : "($href as xs:string?) as xs:string* external", "description" : " 
    The fn:unparsed-text-lines function reads an external resource (for\n             example, a file) and returns its contents as a sequence of strings, one for each line of\n             text in the  string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The unparsed-text-lines function reads an external resource (for example, a\n             file) and returns its string representation as a sequence of strings, separated at newline\n             boundaries. 
    The result of the single-argument function is the same as the result of the expression\n                fn:tokenize(fn:unparsed-text($href), '\\r\\n|\\r|\\n')[not(position()=last() and\n                .='')]. The result of the two-argument function is the same as the result of\n             the expression fn:tokenize(fn:unparsed-text($href, $encoding),\n                '\\r\\n|\\r|\\n'))[not(position()=last() and .='')]. 
    The result is a thus a sequence of strings containing the text of the resource retrieved\n             using the URI, each string representing one line of text. Lines are separated by one of\n             the sequences x0A, x0D, or x0Dx0A. The characters representing the newline are not\n             included in the returned strings. If there are two adjacent newline sequences, a\n             zero-length string will be returned to represent the empty line; but if the external\n             resource ends with a newline sequence, no zero-length string will be returned as the\n             last item in the result.
    Error conditions are the same as for the fn:unparsed-text function.
    \n", "summary" : "
      The  fn:unparsed-text-lines  function reads an external resource (for\n             example, a file) and returns its contents as a sequence of strings, one for each line of\n             text in the   string representation  of the resource.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "unparsed-text-lines", "qname" : "fn:unparsed-text-lines", "signature" : "($href as xs:string?, $encoding as xs:string) as xs:string* external", "description" : " 
    The fn:unparsed-text-lines function reads an external resource (for\n             example, a file) and returns its contents as a sequence of strings, one for each line of\n             text in the  string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The unparsed-text-lines function reads an external resource (for example, a\n             file) and returns its string representation as a sequence of strings, separated at newline\n             boundaries. 
    The result of the single-argument function is the same as the result of the expression\n                fn:tokenize(fn:unparsed-text($href), '\\r\\n|\\r|\\n')[not(position()=last() and\n                .='')]. The result of the two-argument function is the same as the result of\n             the expression fn:tokenize(fn:unparsed-text($href, $encoding),\n                '\\r\\n|\\r|\\n'))[not(position()=last() and .='')]. 
    The result is a thus a sequence of strings containing the text of the resource retrieved\n             using the URI, each string representing one line of text. Lines are separated by one of\n             the sequences x0A, x0D, or x0Dx0A. The characters representing the newline are not\n             included in the returned strings. If there are two adjacent newline sequences, a\n             zero-length string will be returned to represent the empty line; but if the external\n             resource ends with a newline sequence, no zero-length string will be returned as the\n             last item in the result.
    Error conditions are the same as for the fn:unparsed-text function.
    \n", "summary" : "
      The  fn:unparsed-text-lines  function reads an external resource (for\n             example, a file) and returns its contents as a sequence of strings, one for each line of\n             text in the   string representation  of the resource.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "unparsed-text-lines", "qname" : "fn:unparsed-text-lines", "signature" : "($href as xs:string?, $encoding as xs:string) as xs:string* external", "description" : " 
    The fn:unparsed-text-lines function reads an external resource (for\n             example, a file) and returns its contents as a sequence of strings, one for each line of\n             text in the  string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The unparsed-text-lines function reads an external resource (for example, a\n             file) and returns its string representation as a sequence of strings, separated at newline\n             boundaries. 
    The result of the single-argument function is the same as the result of the expression\n                fn:tokenize(fn:unparsed-text($href), '\\r\\n|\\r|\\n')[not(position()=last() and\n                .='')]. The result of the two-argument function is the same as the result of\n             the expression fn:tokenize(fn:unparsed-text($href, $encoding),\n                '\\r\\n|\\r|\\n'))[not(position()=last() and .='')]. 
    The result is a thus a sequence of strings containing the text of the resource retrieved\n             using the URI, each string representing one line of text. Lines are separated by one of\n             the sequences x0A, x0D, or x0Dx0A. The characters representing the newline are not\n             included in the returned strings. If there are two adjacent newline sequences, a\n             zero-length string will be returned to represent the empty line; but if the external\n             resource ends with a newline sequence, no zero-length string will be returned as the\n             last item in the result.
    Error conditions are the same as for the fn:unparsed-text function.
    \n", "summary" : "
      The  fn:unparsed-text-lines  function reads an external resource (for\n             example, a file) and returns its contents as a sequence of strings, one for each line of\n             text in the   string representation  of the resource.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "unparsed-text", "qname" : "fn:unparsed-text", "signature" : "($href as xs:string?) as xs:string? external", "description" : " 
    The fn:unparsed-text function reads an external resource (for example, a\n             file) and returns a string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The $href argument must be a string in the form of a URI\n             reference, which must contain no fragment identifier, and\n                must identify a resource\n             for which a string representation is available. If the URI is a\n             relative URI reference, then it is resolved relative to the\n             Static Base URI property from the static context.
    The mapping of URIs to the string representation of a resource is the mapping defined\n             in the available text resources\n          component of the dynamic context.
    If the value of the $href argument is an empty sequence, the function\n             returns an empty sequence.
    The $encoding argument, if present, is the name of an encoding. The values\n             for this attribute follow the same rules as for the encoding attribute in\n             an XML declaration. The only values which every implementation is required to recognize are\n                utf-8 and utf-16.
    The encoding of the external resource is determined as follows:
    external encoding information is used if available, otherwise
    if the media type of the resource is text/xml or\n                      application/xml (see ), or if it matches\n                   the conventions text/*+xml or application/*+xml (see\n                       and/or its successors), then the encoding is recognized\n                   as specified in , otherwise
    the value of the $encoding argument is used if present, otherwise
    the processor may use implementation-defined heuristics to determine the likely encoding,\n                   otherwise
    UTF-8 is assumed.
    The result of the function is a string containing the\n             string representation of the resource retrieved\n             using the URI.
    A dynamic error is raised  if $href\n             contains a fragment identifier, or if it cannot be used to retrieve the\n             string representation of a resource.
    A dynamic error is raised  if the value\n             of the $encoding argument is not a valid encoding name, if the processor does not support the specified encoding,\n             if the string representation of the retrieved\n             resource contains octets that cannot be decoded into Unicode characters using the specified encoding, or if the resulting characters\n             are not permitted XML characters.
    A dynamic error is raised  if\n                $encoding is absent and the processor cannot infer the encoding using external information and the\n             encoding is not UTF-8.
    \n", "summary" : "
      The  fn:unparsed-text  function reads an external resource (for example, a\n             file) and returns  a string representation of the resource .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "unparsed-text", "qname" : "fn:unparsed-text", "signature" : "($href as xs:string?) as xs:string? external", "description" : " 
    The fn:unparsed-text function reads an external resource (for example, a\n             file) and returns a string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The $href argument must be a string in the form of a URI\n             reference, which must contain no fragment identifier, and\n                must identify a resource\n             for which a string representation is available. If the URI is a\n             relative URI reference, then it is resolved relative to the\n             Static Base URI property from the static context.
    The mapping of URIs to the string representation of a resource is the mapping defined\n             in the available text resources\n          component of the dynamic context.
    If the value of the $href argument is an empty sequence, the function\n             returns an empty sequence.
    The $encoding argument, if present, is the name of an encoding. The values\n             for this attribute follow the same rules as for the encoding attribute in\n             an XML declaration. The only values which every implementation is required to recognize are\n                utf-8 and utf-16.
    The encoding of the external resource is determined as follows:
    external encoding information is used if available, otherwise
    if the media type of the resource is text/xml or\n                      application/xml (see ), or if it matches\n                   the conventions text/*+xml or application/*+xml (see\n                       and/or its successors), then the encoding is recognized\n                   as specified in , otherwise
    the value of the $encoding argument is used if present, otherwise
    the processor may use implementation-defined heuristics to determine the likely encoding,\n                   otherwise
    UTF-8 is assumed.
    The result of the function is a string containing the\n             string representation of the resource retrieved\n             using the URI.
    A dynamic error is raised  if $href\n             contains a fragment identifier, or if it cannot be used to retrieve the\n             string representation of a resource.
    A dynamic error is raised  if the value\n             of the $encoding argument is not a valid encoding name, if the processor does not support the specified encoding,\n             if the string representation of the retrieved\n             resource contains octets that cannot be decoded into Unicode characters using the specified encoding, or if the resulting characters\n             are not permitted XML characters.
    A dynamic error is raised  if\n                $encoding is absent and the processor cannot infer the encoding using external information and the\n             encoding is not UTF-8.
    \n", "summary" : "
      The  fn:unparsed-text  function reads an external resource (for example, a\n             file) and returns  a string representation of the resource .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "unparsed-text", "qname" : "fn:unparsed-text", "signature" : "($href as xs:string?, $encoding as xs:string) as xs:string? external", "description" : " 
    The fn:unparsed-text function reads an external resource (for example, a\n             file) and returns a string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The $href argument must be a string in the form of a URI\n             reference, which must contain no fragment identifier, and\n                must identify a resource\n             for which a string representation is available. If the URI is a\n             relative URI reference, then it is resolved relative to the\n             Static Base URI property from the static context.
    The mapping of URIs to the string representation of a resource is the mapping defined\n             in the available text resources\n          component of the dynamic context.
    If the value of the $href argument is an empty sequence, the function\n             returns an empty sequence.
    The $encoding argument, if present, is the name of an encoding. The values\n             for this attribute follow the same rules as for the encoding attribute in\n             an XML declaration. The only values which every implementation is required to recognize are\n                utf-8 and utf-16.
    The encoding of the external resource is determined as follows:
    external encoding information is used if available, otherwise
    if the media type of the resource is text/xml or\n                      application/xml (see ), or if it matches\n                   the conventions text/*+xml or application/*+xml (see\n                       and/or its successors), then the encoding is recognized\n                   as specified in , otherwise
    the value of the $encoding argument is used if present, otherwise
    the processor may use implementation-defined heuristics to determine the likely encoding,\n                   otherwise
    UTF-8 is assumed.
    The result of the function is a string containing the\n             string representation of the resource retrieved\n             using the URI.
    A dynamic error is raised  if $href\n             contains a fragment identifier, or if it cannot be used to retrieve the\n             string representation of a resource.
    A dynamic error is raised  if the value\n             of the $encoding argument is not a valid encoding name, if the processor does not support the specified encoding,\n             if the string representation of the retrieved\n             resource contains octets that cannot be decoded into Unicode characters using the specified encoding, or if the resulting characters\n             are not permitted XML characters.
    A dynamic error is raised  if\n                $encoding is absent and the processor cannot infer the encoding using external information and the\n             encoding is not UTF-8.
    \n", "summary" : "
      The  fn:unparsed-text  function reads an external resource (for example, a\n             file) and returns  a string representation of the resource .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "unparsed-text", "qname" : "fn:unparsed-text", "signature" : "($href as xs:string?, $encoding as xs:string) as xs:string? external", "description" : " 
    The fn:unparsed-text function reads an external resource (for example, a\n             file) and returns a string representation of the resource.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tstatic base uri.\n \t
    The $href argument must be a string in the form of a URI\n             reference, which must contain no fragment identifier, and\n                must identify a resource\n             for which a string representation is available. If the URI is a\n             relative URI reference, then it is resolved relative to the\n             Static Base URI property from the static context.
    The mapping of URIs to the string representation of a resource is the mapping defined\n             in the available text resources\n          component of the dynamic context.
    If the value of the $href argument is an empty sequence, the function\n             returns an empty sequence.
    The $encoding argument, if present, is the name of an encoding. The values\n             for this attribute follow the same rules as for the encoding attribute in\n             an XML declaration. The only values which every implementation is required to recognize are\n                utf-8 and utf-16.
    The encoding of the external resource is determined as follows:
    external encoding information is used if available, otherwise
    if the media type of the resource is text/xml or\n                      application/xml (see ), or if it matches\n                   the conventions text/*+xml or application/*+xml (see\n                       and/or its successors), then the encoding is recognized\n                   as specified in , otherwise
    the value of the $encoding argument is used if present, otherwise
    the processor may use implementation-defined heuristics to determine the likely encoding,\n                   otherwise
    UTF-8 is assumed.
    The result of the function is a string containing the\n             string representation of the resource retrieved\n             using the URI.
    A dynamic error is raised  if $href\n             contains a fragment identifier, or if it cannot be used to retrieve the\n             string representation of a resource.
    A dynamic error is raised  if the value\n             of the $encoding argument is not a valid encoding name, if the processor does not support the specified encoding,\n             if the string representation of the retrieved\n             resource contains octets that cannot be decoded into Unicode characters using the specified encoding, or if the resulting characters\n             are not permitted XML characters.
    A dynamic error is raised  if\n                $encoding is absent and the processor cannot infer the encoding using external information and the\n             encoding is not UTF-8.
    \n", "summary" : "
      The  fn:unparsed-text  function reads an external resource (for example, a\n             file) and returns  a string representation of the resource .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "upper-case", "qname" : "fn:upper-case", "signature" : "($arg as xs:string?) as xs:string external", "description" : " 
    Converts a string to upper case.
    This function is deterministic, context-independent,  and focus-independent. 
    If the value of $arg is the empty sequence, the zero-length string is\n             returned.
    Otherwise, the function returns the value of $arg after translating every\n                character to its upper-case correspondent as\n             defined in the appropriate case mappings section in the Unicode standard . For versions of Unicode beginning with the 2.1.8 update, only\n             locale-insensitive case mappings should be applied. Beginning with version 3.2.0 (and\n             likely future versions) of Unicode, precise mappings are described in default case\n             operations, which are full case mappings in the absence of tailoring for particular\n             languages and environments. Every lower-case character that does not have an upper-case\n             correspondent, as well as every upper-case character, is included in the returned value\n             in its original form. 
    Case mappings may change the length of a string. In general, the\n                fn:upper-case and fn:lower-case functions are not inverses\n             of each other: fn:lower-case(fn:upper-case($arg)) is not guaranteed to\n             return $arg, nor is fn:upper-case(fn:lower-case($arg)). The\n             Latin small letter dotless i (as used in Turkish) is perhaps the most prominent\n             lower-case letter which will not round-trip. The Latin capital letter i with dot above\n             is the most prominent upper-case letter which will not round trip; there are others,\n             such as Latin capital letter Sharp S (#1E9E) which is introduced in Unicode 5.1.
     These functions may not always be linguistically appropriate (e.g. Turkish i without\n             dot) or appropriate for the application (e.g. titlecase). In cases such as Turkish, a\n             simple translation should be used first.
     Because the function is not sensitive to locale, results will not always match user\n             expectations. In Quebec, for example, the standard uppercase equivalent of \"è\" is \"È\",\n             while in metropolitan France it is more commonly \"E\"; only one of these is supported by\n             the functions as defined.
     Many characters of class Ll lack uppercase equivalents in the Unicode case mapping\n             tables; many characters of class Lu lack lowercase equivalents.
    \n", "summary" : "
      Converts a string to upper case.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "uri-collection", "qname" : "fn:uri-collection", "signature" : "() as xs:anyURI* external", "description" : " 
    Returns a sequence of xs:anyURI values representing the URIs in a resource collection.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tavailable resource collections, and static base uri.\n \t
    The zero-argument form of the function returns the URIs in the Default resource collection\n             described in .
    If the value of $arg is a relative xs:anyURI, it is resolved\n             against the value of the base-URI property from the static context. 
    If $arg is the empty sequence, the function behaves as if it had been\n             called without an argument. See above.
    The single-argument form of the function returns the sequence of URIs corresponding to the\n             supplied URI in the Available resource collections described in\n             .
    A dynamic error is raised  if no URI is supplied (that is, if the\n             the function is called with no arguments, or with a single argument that evaluates to an empty sequence), and the\n             value of the default resource collection is absent.
    A dynamic error is raised \n             if available resource collections provides no mapping for the absolutized URI.
    A dynamic error is raised  if $arg is not a\n             valid xs:anyURI.
    \n", "summary" : "
      Returns a sequence of  xs:anyURI  values representing the URIs in a resource collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "uri-collection", "qname" : "fn:uri-collection", "signature" : "() as xs:anyURI* external", "description" : " 
    Returns a sequence of xs:anyURI values representing the URIs in a resource collection.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tavailable resource collections, and static base uri.\n \t
    The zero-argument form of the function returns the URIs in the Default resource collection\n             described in .
    If the value of $arg is a relative xs:anyURI, it is resolved\n             against the value of the base-URI property from the static context. 
    If $arg is the empty sequence, the function behaves as if it had been\n             called without an argument. See above.
    The single-argument form of the function returns the sequence of URIs corresponding to the\n             supplied URI in the Available resource collections described in\n             .
    A dynamic error is raised  if no URI is supplied (that is, if the\n             the function is called with no arguments, or with a single argument that evaluates to an empty sequence), and the\n             value of the default resource collection is absent.
    A dynamic error is raised \n             if available resource collections provides no mapping for the absolutized URI.
    A dynamic error is raised  if $arg is not a\n             valid xs:anyURI.
    \n", "summary" : "
      Returns a sequence of  xs:anyURI  values representing the URIs in a resource collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "uri-collection", "qname" : "fn:uri-collection", "signature" : "($arg as xs:string?) as xs:anyURI* external", "description" : " 
    Returns a sequence of xs:anyURI values representing the URIs in a resource collection.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tavailable resource collections, and static base uri.\n \t
    The zero-argument form of the function returns the URIs in the Default resource collection\n             described in .
    If the value of $arg is a relative xs:anyURI, it is resolved\n             against the value of the base-URI property from the static context. 
    If $arg is the empty sequence, the function behaves as if it had been\n             called without an argument. See above.
    The single-argument form of the function returns the sequence of URIs corresponding to the\n             supplied URI in the Available resource collections described in\n             .
    A dynamic error is raised  if no URI is supplied (that is, if the\n             the function is called with no arguments, or with a single argument that evaluates to an empty sequence), and the\n             value of the default resource collection is absent.
    A dynamic error is raised \n             if available resource collections provides no mapping for the absolutized URI.
    A dynamic error is raised  if $arg is not a\n             valid xs:anyURI.
    \n", "summary" : "
      Returns a sequence of  xs:anyURI  values representing the URIs in a resource collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyURI*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "uri-collection", "qname" : "fn:uri-collection", "signature" : "($arg as xs:string?) as xs:anyURI* external", "description" : " 
    Returns a sequence of xs:anyURI values representing the URIs in a resource collection.
    This function is deterministic, context-dependent,  and focus-independent.  It depends on\n \t\tavailable resource collections, and static base uri.\n \t
    The zero-argument form of the function returns the URIs in the Default resource collection\n             described in .
    If the value of $arg is a relative xs:anyURI, it is resolved\n             against the value of the base-URI property from the static context. 
    If $arg is the empty sequence, the function behaves as if it had been\n             called without an argument. See above.
    The single-argument form of the function returns the sequence of URIs corresponding to the\n             supplied URI in the Available resource collections described in\n             .
    A dynamic error is raised  if no URI is supplied (that is, if the\n             the function is called with no arguments, or with a single argument that evaluates to an empty sequence), and the\n             value of the default resource collection is absent.
    A dynamic error is raised \n             if available resource collections provides no mapping for the absolutized URI.
    A dynamic error is raised  if $arg is not a\n             valid xs:anyURI.
    \n", "summary" : "
      Returns a sequence of  xs:anyURI  values representing the URIs in a resource collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:anyURI*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "year-from-date", "qname" : "fn:year-from-date", "signature" : "($arg as xs:date?) as xs:integer? external", "description" : " 
    Returns the year component of an xs:date.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer representing the year in the\n             local value of $arg. The value may be negative. 
    The expression fn:year-from-date(xs:date(\"1999-05-31\")) returns 1999.
    The expression fn:year-from-date(xs:date(\"2000-01-01+05:00\")) returns 2000.
    \n", "summary" : "
      Returns the year component of an  xs:date .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "years-from-duration", "qname" : "fn:years-from-duration", "signature" : "($arg as xs:duration?) as xs:integer? external", "description" : " 
    Returns the number of years in a duration.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise, the function returns an xs:integer representing the years\n             component in the value of $arg. The result is obtained by casting\n                $arg to an xs:yearMonthDuration (see ) and then computing the years component as described in\n                .
    If $arg is a negative duration then the result will be negative..
    If $arg is an xs:dayTimeDuration the function returns 0.
    The expression fn:years-from-duration(xs:yearMonthDuration(\"P20Y15M\")) returns 21.
    The expression fn:years-from-duration(xs:yearMonthDuration(\"-P15M\")) returns -1.
    The expression fn:years-from-duration(xs:dayTimeDuration(\"-P2DT15H\")) returns 0.
    \n", "summary" : "
      Returns the number of years in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "zero-or-one", "qname" : "fn:zero-or-one", "signature" : "($arg as item()*) as item()? external", "description" : " 
    Returns $arg if it contains zero or one items. Otherwise, raises\n             an error.
    This function is deterministic, context-independent,  and focus-independent. 
    Except in error cases, the function returns $arg unchanged.
    For detailed type semantics, see [Formal Semantics].
    A dynamic error is raised  if $arg contains more\n             than one item.
    \n", "summary" : "
      Returns  $arg  if it contains zero or one items.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "item()?", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/csv" : { "ns" : "http://zorba.io/modules/csv", "description" : " Function library providing converters from CSV/TXT to XML and back.\n The functions are optimized to work with large amounts of data, in a streaming way.\n", "sees" : [  ], "authors" : [ "Daniel Turcanu" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/csv", "prefix" : "csv" }, { "uri" : "http://zorba.io/modules/csv-options", "prefix" : "csv-options" }, { "uri" : "http://zorba.io/modules/schema", "prefix" : "schemaOptions" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "parse", "qname" : "csv:parse", "signature" : "($csv as xs:string, $options as element(csv-options:options)?) as element(*)*", "description" : " Parse a CSV or fixed size text and convert to XML.
    \n By default each line is converted to a <row> element, and each field to a <column> element inside <row>.
    \n The format of the param $options is:
    \n  
    \n    <csv-options:options>\n        <csv  [separator=\"default comma ,\"] ?\n          [quote-char=\"default double quotes &quote;\"]?\n          [quote-escape=\"default double double quotes &quote;&quote;\"]? />\n        or\n        <column-widths>\n          <column-width>[column fixed width, unsigned int]<column-width>*\n        </column-widths>\n        or\n        <column-positions>\n          <column-position>[column position on line, unsigned int]<column-position>*\n        </column-positions>\n        <first-row-is-header [line=\"first_line[-last_line]?\"]?/>?\n        <start-from-row line=\"first_line[-last_line]?\"/>?\n        <add-last-void-columns/>?\n        <xml-nodes>\n          [<row-name>\n            [<column-name/>]?\n          </row-name>]?\n        </xml-nodes>?\n    </csv-options:options>\n  
    \n    All the parameters are optional and can appear in any order.
    \n    All the parameters are case sensitive. The namespace used is \"http://zorba.io/modules/csv-options\".
    \n    All strings must have UTF-8 encoding.
    \n    Parameters csv, column-widths, column-positions are mutually exclusive. If none is specified,\n    the input string is assumed to be csv.
    \n    Description of parameters:\n    
    \n     
    csv
    \n     
     Specifies the parameters for parsing a csv string.
    \n       
    \n        
    separator
    \n        
    The character or group of characters used to separating fields in a row.\n            If it is not specified, it defaults to comma ','.\n        
    \n        
    quote-char
    \n        
    The character or group of characters used for quoting the fields that may contain special characters,\n             like separator, new line or this quote char. The default value is double quote \".
    \n        
    \n        
    quote-escape
    \n        
    The group of characters used for escaping the quote char inside a field. The whole quote escape group\n           is translated to a quote char during parsing. The default value is double double quotes \"\".
    \n        
    \n       
    \n     
    \n     
    \n     
    column-widths
    \n     
    Specifies the column widths for fixed size text. It contains multiple column-width child elements\n        specifying the fixed width of each column, from left to right.
    \n        If the line has more fields than specified, they are ignored.\n     
    \n     
    column-positions
    \n     
    This is an alternative to column-widths, and specifies instead the starting position of each column.\n        Column positions are 1 based, and are specified in order from left to right.\n        The last column is read until end of line. The first column position can be greater than 1, if you want\n        to parse only a part of the input text.\n     
    \n     
    first-row-is-header
    \n     
    The presence of this element indicates that the first row is to be treated as the name of the columns.\n        If it is not present, then each field is enclosed in a <column> element,\n        or how it is specified in <xml-nodes> parameter.
    \n        If the first row is the header, then each field is enclosed in an element with the corresponding name from the header.
    \n        For example, the csv:\n        
    \n        ID,Name,Occupation\n        1,John,student\n        
    \n        is parsed into:\n        
    \n        <row>\n        <ID>1</ID>\n        <Name>John</Name>\n        <Occupation>student</Occupation>\n        </row>\n        
    \n        If the header names contain characters that cannot be used in a QName, they are replaced with underscore '_'.
    \n        The namespace for the header QNames is taken from the column name specified in xml-nodes parameter, or from\n        the row name, or if that doesn't exist either then empty namespace is used. 
    \n        If the header is not the first line in the input string, the starting line can be specified in the line attribute.
    \n        If a column does not have a name, a new name is constructed in the form columnN where N is the position of the column,\n        starting from 1.
    \n        Subheaders
    \n        If the header consists of more than one line, this can be specified in the line attribute in the form\n        \"first_line - last_line\". Having more lines as the header translates into a hierarchy of elements in the xml.
    \n        For example, the csv:\n        
    \n        ID,Name,,Occupation\n        ,First Name,Last Name,\n        1,John,Howard,student\n        
    \n        is parsed into:\n        
    \n        <row>\n        <ID>1</ID>\n        <Name>\n          <First_Name>John</First_Name>\n          <Last_Name>Howard</Last_Name>\n        </Name>\n        <Occupation>student</Occupation>\n        </row>\n        
    \n        This element can have an attribute \"accept-all-lines\" with values \"false\" or \"true\" (default \"false\").\n        When set to true it tells the parser to not report lines that do not have the same number of items as\n        the header. If set to false, the parser will raise a csv:WrongInput error for these lines.
    \n     
    \n     
    start-from-row
    \n     
    If the data does not start from line 1 or immediately after the header,\n        you can specify the starting line in the line attribute.
    \n        Also you can use this attribute in the form \"first_line - last_line\" to specify also the last line\n        if you don't want the whole csv to be parsed.\n     
    \n     
    add-last-void-columns
    \n     
    In the case when using headers and some data lines are shorter than the header, by default the excess columns are ignored\n          for those lines. You can set the add-last-void-columns parameter to make all the columns appear in xml even if they are void.\n     
    \n     
    xml-nodes
    \n     
    With this parameter you can specify the names for the row element and for the column element if there is no header.
    \n        The first element child of this element specifies the desired QName of the row element in the output xml.\n        The name of this element will be used as the name of the row element.
    \n        The element child of this row element is the column element, and its name will be used as the name of the column elements\n        that enclose the fields in the output xml if there is no header. 
    \n        If the csv has a header, only the namespace is used from the column element.
    \n        For example, with parameter:\n        
    \n        <xml-nodes>\n        <r>\n          <c/>\n        </r>\n        </xml-nodes>\n        
    \n        the output for each line will look like:\n        
    \n        <r>\n          <c>field1</c>\n          <c>field2</c>\n          .......\n        </r>\n        
    \n     
    \n    
    \n", "summary" : "
     Parse a CSV or fixed size text and convert to XML.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "csv", "type" : "xs:string", "occurrence" : null, "description" : "
     the string containing the csv or fixed size text.
    " }, { "name" : "options", "type" : "element(csv-options:options)", "occurrence" : "?", "description" : "
     this parameter is validated against \"http://zorba.io/modules/csv-options\" schema. If this parameter is not specified, the row name is by default \"row\" and the column name is by default \"column\".
    " } ], "returns" : { "type" : "element(*)*", "description" : "a sequence of row elements, one for each line in csv" }, "errors" : [ "csv:CSV001 if the input string is streamable string and cannot be rewinded", "csv:WrongInput if the input string has lines with variable number of items, and the csv has headers and the options do not specify the ignore-foreign-input attribute", "err:XQDY0027 if $options can not be validated against the csv-options schema", "err:XQDY0084 if the options parameter doesn't have the name \"csv-options:options\"." ] }, { "isDocumented" : true, "arity" : 2, "name" : "serialize", "qname" : "csv:serialize", "signature" : "($xml as element(*)*, $options as element(csv-options:options)?) as xs:string", "description" : " Convert XML into CSV or fixed size text.\n Note: if you want to serialize out the result, make sure that the serializer method is set to \"text\".\n For example, in zorba command line, you have to set the param --serialize-text.\n When using the 
    file:write(...)
     function, you have to set the\n method serialization parameter to \"text\":\n 
    \n <output:serialization-parameters<\n   <output:method value=\"text\"/<\n </output:serialization-parameters<\n 
    \n The 
    $options
     parameter must have the following format:\n 
    \n    <csv-options:options>
    \n        <csv  [separator=\"default comma ,\"] ? 
    \n          [quote-char=\"default double quotes &quote;\"]? 
    \n          [quote-escape=\"default double double quotes &quote;&quote;\"]? /> 
    \n        
    \n        or
    \n        <column-widths [align=\"left|right\"]?>
    \n          <column-width [align=\"left|right\"]?>[column fixed width, unsigned int]<column-width>*
    \n        </column-widths>
    \n        
    \n        or
    \n        <column-positions [align=\"left|right\"]?>
    \n          <column-position [align=\"left|right\"]?>[column position on line, unsigned int]<column-position>*
    \n        </column-positions>
    \n        
    \n        <first-row-is-header/>?
    \n    </csv-options:options>\n 
    \n All the parameters are optional and can appear in any order.
    \n All the parameters are case sensitive. The namespace used is \"http://zorba.io/modules/csv-options\".
    \n All strings must have UTF-8 encoding.
    \n Parameters csv, column-widths, column-positions are mutually exclusive.\n If none is specified, the xml is converted to csv.\n Description of parameters:\n    
    \n     
    csv
    \n     
     Specifies the parameters for converting to csv.
    \n       
    \n        
    separator
    \n        
    The character or group of characters used to separating fields in a row.\n            If it is not specified, it defaults to comma ','.\n        
    \n        
    quote-char
    \n        
    The character or group of characters used for quoting the fields that may contain special characters,\n             like separator, new line or this quote char. The default value is double quote \".
    \n        
    \n        
    quote-escape
    \n        
    The group of characters used for escaping the quote char inside a field. The whole quote escape group\n           is translated to a quote char during parsing. The default value is double double quotes \"\".
    \n        
    \n       
    \n     
    \n     
    \n     
    column-widths
    \n     
    Specifies the column widths for fixed size text. It contains multiple column-width child elements\n        specifying the fixed width of each column, from left to right.
    \n        With the attribute align you can specify how to align fields that are smaller than the column width.\n        The default alignment is left.
    \n     
    \n     
    column-positions
    \n     
    This is an alternative to column-widths, and specifies instead the starting position of each column.\n        Column positions are 1 based, and are specified in order from left to right.\n        The last column has a variable length.
    \n        With the attribute align you can specify how to align fields that are smaller than the column width.\n        The default alignment is left. The last column does not need alignment.
    \n     
    \n     
    first-row-is-header
    \n     
    The presence of this element indicates that the first row will contain the header, that is, the names of\n        the column elements. Only the column names from the first row element are taken into account.
    \n        For example, the row xml:
    \n        <row>
    \n        <ID>1</ID>
    \n        <Name>John</Name>
    \n        <Occupation>student</Occupation>
    \n        </row>
    \n        
    \n        is converted to
    \n        ID,Name,Occupation
    \n        1,John,student
    \n        
    \n        The header names are the localnames of the column elements, and the namespace is ignored.
    \n        Subheaders
    \n        If the row-column hierarchy is more complex, then subheaders are also generated on subsequent lines.\n        The number of subheaders depends on the depth of the column hierarchy.
    \n        When generating the subheaders, the non-whitespace text nodes are also taken into account,\n        and a separate column is generated for them too.
    \n        For example, the xml row element:
    \n        <row>
    \n        <ID>1</ID>
    \n        <Name>
    \n          Mr.
    \n          <First_Name>John</First_Name>
    \n          <Last_Name>Howard</Last_Name>
    \n        </Name>
    \n        <Occupation>student</Occupation>
    \n        </row>
    \n        is converted to
    \n        ID,Name,,Occupation
    \n        ,,First Name,Last Name,
    \n        1,Mr.,John,Howard,student
    \n        
    \n        If first-row-is-header is not specified and the columns have a deeper hierarchy,\n          only the first layer of columns is processed, and the fields are the string values of each column.
    \n        This element can have an attribute \"ignore-foreign-input\" with values \"false\" or \"true\" (default \"false\").\n        When set to true it tells the serializer to ignore elements that to not match the header names.\n        If set to false, the serializer will raise a csv:ForeignInput error for these elements.
    \n     
    \n    
    \n", "summary" : "
     Convert XML into CSV or fixed size text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml", "type" : "element(*)", "occurrence" : "*", "description" : "
     a sequence of elements, each element representing a row. The name of each row element is ignored. The childs of each row are the column fields.
    " }, { "name" : "options", "type" : "element(csv-options:options)", "occurrence" : "?", "description" : "
     The options parameter. See the function description for details. This parameter is validated against \"http://zorba.io/modules/csv-options\" schema.
    " } ], "returns" : { "type" : "xs:string", "description" : "the csv or fixed size text as string containing all the lines" }, "errors" : [ "csv:CSV003 if the serialize output is streamable string and cannot be reset", "csv:ForeignInput if there are input elements in subsequent rows that do not match the headers, and the options specify first-row-is-header and do not specify the ignore-foreign-input attribute", "err:XQDY0027 if $options can not be validated against csv-options schema", "err:XQDY0084 if the options parameter doesn't have the name \"csv-options:options\"." ] } ], "variables" : [  ] }, "http://zorba.io/modules/reference" : { "ns" : "http://zorba.io/modules/reference", "description" : " The module provides functions to compute an immutable and opaque reference\n for nodes, objects, or arrays and to retrieve such items given their\n identifier, respectively.\n The identifiers are immutable, i.e. a identifier does not change\n during the items lifetime and cannot be reused for another item after the\n original item gets deleted.\n Identifiers are unique, in that, two different items will never have the same\n identifier. A item, at any time during its lifetime, can be retrieved by its\n identifier.\n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/reference", "prefix" : "ref" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "dereference", "qname" : "ref:dereference", "signature" : "($arg as xs:string) as item()? external", "description" : " 
    Returns the node, object, or array identified by the given reference.
    \n 
    The function returns the empty sequence if the item\n that is referenced does not exist.
    \n", "summary" : "
      Returns the node, object, or array identified by the given reference.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : null, "description" : "
     the URI of the item to retrieve.
    " } ], "returns" : { "type" : "item()?", "description" : "the item identified by the URI passed as parameter or the empty-sequence if no item with that URI is found." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "reference", "qname" : "ref:reference", "signature" : "($arg as item()) as xs:string external", "description" : " 
    Returns an immutable and opaque reference (with type xs:anyURI) for\n a given node, object, or array.
    \n 
    The generated identifier is immutable, i.e. a identifier does not\n change during the item's lifetime and cannot be reused for another node after\n the original item gets deleted.
    \n 
    Identifiers are also unique, in that, two different items will never\n have the same identifier.
    \n A item, at any time during its lifetime, can be retrieved by its\n identifier, using the ref:dereference function.\n Please note that a reference can only be retrieved for a JSON object or JSON\n array if the item is a member of a collection.\n", "summary" : "
      Returns an immutable and opaque reference (with type xs:anyURI) for\n a given node, object, or array.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : null, "description" : "
     the node, object, or array for which the URI should be computed
    " } ], "returns" : { "type" : "xs:string", "description" : "the opaque URI of the item." }, "errors" : [ "zerr::ZAPI0080 is raised if the object or array passed as argument is not a member of a collection." ] } ], "variables" : [  ] }, "http://zorba.io/modules/dctx" : { "ns" : "http://zorba.io/modules/dctx", "description" : " This module provides functions that gets components of the dynamic context.\n", "sees" : [  ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/dctx", "prefix" : "dctx" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "snapshot-id", "qname" : "dctx:snapshot-id", "signature" : "() as xs:unsignedLong external", "description" : " 
    Retrieves the current snapshot id.
    \n 
    The returned id is opaque and should not be used for reasoning about time.\n The only guarantee is that the value returned by this function increases each\n time a snapshot finishes.
    \n", "summary" : "
      Retrieves the current snapshot id.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:unsignedLong", "description" : "the current snapshot id." }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/facts" : { "ns" : "http://xbrl.io/modules/bizql/facts", "description" : " 
    This module provides functions for retrieving facts.
    \n 
    Facts are the smallest reportable piece of information.
    \n 
    Facts have a certain number of characteristics: the archive in\n which they were reported, a number of XBRL aspects (concept, entity, period,\n unit, further XBRL dimensions), as well as profile-specific information.
    \n 
    With this module, you can retrieve facts by picking the characteristics\n you would like your results to have. You can retrieve a fact with its FID\n (Fact ID). You can extract information about facts (period, entity, etc).\n You can perform a full-text search on fact values, and obtain footnotes.
    \n 
    If you are interested in the structures in which facts can be organized (such\n as hypercubes), look at the components module.
    \n 
    Facts are stored in a MongoDB datasource called xbrl.
    \n 
    Standard $options Parameter
    \n 
    Most functions in the BizQL package allow an additional $options\n    parameter. The options parameter is a JSON object allowing the following\n    fields:
    \n 
      \n 
    • Hypercube: a hypercube object can be passed with the options to apply\n     implicit filtering for it. Only facts belonging to this hypercube will be\n     returned. Hypercube semantics (such as default dimension values) apply.\n     By default, the dimensionless hypercube is used (no dimensions allowed, no filtering).\n     You can override Hypercube with null to bypass hypercube semantics.
      • \n 
    • Filter: an object specifying the fields to filter for. Filtering fields\n     can be any field contained in facts, including profile specific fields, e.g.:\n     
      \n   {\n     Filter:\n       {\n         Archive: \"0000034088-13-000011\",\n         Aspects:\n         {\n           \"us-gaap:DefinedBenefitPlansDisclosuresDefinedBenefitPlansAxis\" :\n             \"us-gaap:ForeignPensionPlansDefinedBenefitMember\"\n         },\n         Profiles: {\n           SEC: {\n             Fiscal: {\n               Year: [2011, 2012]\n             }\n           }\n         }\n       }\n   }\n   
      \n   A filter must contain at least on of the fields Archive, Aspects.xbrl:Concept,\n   Aspects.xbrl:Period, or Aspects.xbrl:Entity.
      • \n 
    • concept-maps:\n   
      1. a string which is a name of a report schema that is stored in the\n       reportschemas collection and from which to load a ConceptMap
        2. \n       
      2. an object which is a ConceptMap network object
        3. \n       
      3. an array of ConceptMap network objects (to learn more about concept-maps\n       refer to the concept-maps module documentation)
        4. \n   
      • \n 
    • Rules:\n   
      1. a string which is a name of a report schema that is stored in the\n       reportschemas collection and from which to load Rules
        2. \n       
      2. an object which is a Rule object
        3. \n       
      3. an array of Rule objects
        4. \n   
      • \n 
    • include-footnotes: include XBRL Footnotes in each fact (true | false)
      • \n 
    • Lang: language identifier according to http://www.ietf.org/rfc/rfc3066.txt,\n     i.e. only return footnotes etc. for this specific language
      • \n 
    • audit-trail: if set to \"debug\" the audit trails will be more verbose
      • \n 
    • facts-for-archives-and-concept: to override how underlying facts are\n     resolved, for example with finer-grained, profile-specific filtering (option value\n     must be a function item). facts:facts-for-archives-and-concepts#3 is used by\n     default, but it is possible to supply another function that, for examples, filters\n     irrelevant facts out.
      • \n 
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/concept-maps", "prefix" : "concept-maps" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/footnotes", "prefix" : "footnotes" }, { "uri" : "http://xbrl.io/modules/bizql/hypercubes", "prefix" : "hypercubes" }, { "uri" : "http://jsoniq.org/function-library", "prefix" : "j" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "mongo" }, { "uri" : "http://zorba.io/modules/reflection", "prefix" : "reflection" }, { "uri" : "http://xbrl.io/modules/bizql/rules", "prefix" : "rules" }, { "uri" : "http://zorba.io/modules/string", "prefix" : "string" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/modules/zorba-query", "prefix" : "zq" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "concept-for-fact", "qname" : "facts:concept-for-fact", "signature" : "($fact-or-id as item()) as string", "description" : " 
    Retrieves the concept against which a fact is reported.
    \n", "summary" : "
      Retrieves the concept against which a fact is reported.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-id", "type" : "item()", "occurrence" : null, "description" : "
     a fact or its FID.
    " } ], "returns" : { "type" : "string", "description" : "the concept name." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "decimal-value", "qname" : "facts:decimal-value", "signature" : "($facts as object()*) as decimal", "description" : " 
    Returns the value of the given facts in case that it\n    is castable to decimal. If no facts are given or a fact value\n    is not castable to decimal 0 is returned instead.
    \n", "summary" : "
      Returns the value of the given facts in case that it\n    is castable to decimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "facts", "type" : "object()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "decimal", "description" : "the decimal value of the facts or 0." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "duration-for-fact", "qname" : "facts:duration-for-fact", "signature" : "($fact-or-id as item()) as object()?", "description" : " 
    Retrieves the duration period for which a fact was reported.
    \n", "summary" : "
      Retrieves the duration period for which a fact was reported.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-id", "type" : "item()", "occurrence" : null, "description" : "
     a fact or its FID.
    " } ], "returns" : { "type" : "object()?", "description" : "the duration period as an object with Start and End, or the empty sequence if it is not instant." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "entity-for-fact", "qname" : "facts:entity-for-fact", "signature" : "($fact-or-id as item()) as string", "description" : " 
    Retrieves the eid of the entity who reported a fact.
    \n", "summary" : "
      Retrieves the eid of the entity who reported a fact.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-id", "type" : "item()", "occurrence" : null, "description" : "
     a fact or its FID.
    " } ], "returns" : { "type" : "string", "description" : "the eid." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-archives-and-aspects", "qname" : "facts:facts-for-archives-and-aspects", "signature" : "($archives-or-ids as item()*, $aspects as object()) as object()*", "description" : " 
    Return all facts reported in a given archive, and associated with a\n given entity, concept, period and/or other aspects.
    \n", "summary" : "
      Return all facts reported in a given archive, and associated with a\n given entity, concept, period and/or other aspects.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archives-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archive or archive IDs to filter (or $facts:ALL_OF_THEM to do not filter on archives).
    " }, { "name" : "aspects", "type" : "object()", "occurrence" : null, "description" : "
     an object containing aspects to filter, among which xbrl:Concept, xbrl:Entity and xbrl:Period (at least one of them is mandatory).
    " } ], "returns" : { "type" : "object()*", "description" : "all facts satisfying all supplied conditions." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "facts-for-archives-and-aspects", "qname" : "facts:facts-for-archives-and-aspects", "signature" : "($archives-or-ids as item()*, $aspects as object(), $options as object()?) as object()*", "description" : " 
    Return all facts associated with a given entity, concept, period\n and/or other aspects.
    \n", "summary" : "
      Return all facts associated with a given entity, concept, period\n and/or other aspects.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archives-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archive or archive IDs to filter (or $facts:ALL_OF_THEM to do not filter on archives).
    " }, { "name" : "aspects", "type" : "object()", "occurrence" : null, "description" : "
     an object containing aspects to filter, among which xbrl:Concept, xbrl:Entity and xbrl:Period (all optional).
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all facts satisfying all supplied conditions." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-archives-and-concepts", "qname" : "facts:facts-for-archives-and-concepts", "signature" : "($archives-or-ids as item()*, $concepts as item()*) as object()*", "description" : " 
    Return facts associated with given concepts and archives.
    \n", "summary" : "
      Return facts associated with given concepts and archives.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archives-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archive or archive IDs to filter (or $facts:ALL_OF_THEM to do not filter on archives).
    " }, { "name" : "concepts", "type" : "item()", "occurrence" : "*", "description" : "
     the concepts (or $facts:ALL_OF_THEM to do no filter on concepts).
    " } ], "returns" : { "type" : "object()*", "description" : "facts associated with these concepts and archives." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "facts-for-archives-and-concepts", "qname" : "facts:facts-for-archives-and-concepts", "signature" : "($archives-or-ids as item()*, $concepts as item()*, $options as object()?) as object()*", "description" : " 
    Return facts associated with given concepts and archives.
    \n", "summary" : "
      Return facts associated with given concepts and archives.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archives-or-ids", "type" : "item()", "occurrence" : "*", "description" : "" }, { "name" : "concepts", "type" : "item()", "occurrence" : "*", "description" : "
     the concepts (or $facts:ALL_OF_THEM to do no filter on concepts).
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "facts associated with these concepts." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts-for-archives", "qname" : "facts:facts-for-archives", "signature" : "($archives-or-ids as item()*) as object()*", "description" : " 
    Return all facts reported within a given archive.
    \n", "summary" : "
      Return all facts reported within a given archive.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archives-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or AIDs to filter.
    " } ], "returns" : { "type" : "object()*", "description" : "all facts reported in these archives." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts-for-aspects", "qname" : "facts:facts-for-aspects", "signature" : "($aspects as object()) as object()*", "description" : " 
    Return all facts associated with the given aspects.
    \n", "summary" : "
      Return all facts associated with the given aspects.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "aspects", "type" : "object()", "occurrence" : null, "description" : "
     an object containing aspects to filter, among which xbrl:Concept, xbrl:Entity and xbrl:Period (at least one of them is mandatory).
    " } ], "returns" : { "type" : "object()*", "description" : "all facts associated with these aspects." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-aspects", "qname" : "facts:facts-for-aspects", "signature" : "($aspects as object(), $options as object()?) as object()*", "description" : " 
    Return all facts associated with the given aspects.
    \n", "summary" : "
      Return all facts associated with the given aspects.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "aspects", "type" : "object()", "occurrence" : null, "description" : "
     an object containing aspects to filter, among which xbrl:Concept, xbrl:Entity and xbrl:Period (at least one of them is mandatory).
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all facts associated with these aspects." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts-for-concepts", "qname" : "facts:facts-for-concepts", "signature" : "($concepts as string*) as object()*", "description" : " 
    Return facts associated with given concepts.
    \n", "summary" : "
      Return facts associated with given concepts.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "concepts", "type" : "string", "occurrence" : "*", "description" : "
     the concepts.
    " } ], "returns" : { "type" : "object()*", "description" : "facts associated with these concepts." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-concepts", "qname" : "facts:facts-for-concepts", "signature" : "($concepts as string*, $options as object()?) as object()*", "description" : " 
    Return facts associated with given concepts.
    \n", "summary" : "
      Return facts associated with given concepts.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "concepts", "type" : "string", "occurrence" : "*", "description" : "
     the concepts.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "facts associated with these concepts." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts-for-entities", "qname" : "facts:facts-for-entities", "signature" : "($entities-or-ids as item()*) as object()*", "description" : " 
    Return facts reported by the given entities.
    \n", "summary" : "
      Return facts reported by the given entities.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entities-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the entities or EIDs.
    " } ], "returns" : { "type" : "object()*", "description" : "facts reported by the given entities." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts-for", "qname" : "facts:facts-for", "signature" : "($options as object()?) as object()*", "description" : " 
    Return all facts that match a given filter object optionally interpreted\n    in the context of an optionally given hypercube.
    \n", "summary" : "
      Return all facts that match a given filter object optionally interpreted\n    in the context of an optionally given hypercube.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all facts satisfying the filter and options." }, "errors" : [ "facts:FILTER-TOO-GENERIC The filter object must have at least one of the fields Archive, Aspects.xbrl:Concept, Aspects.xbrl:Period, or Aspects.xbrl:Entity." ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts-search", "qname" : "facts:facts-search", "signature" : "($search as string) as object()*", "description" : " 
    Return all facts that match the given search term.
    \n", "summary" : "
      Return all facts that match the given search term.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "search", "type" : "string", "occurrence" : null, "description" : "
     the search query
    " } ], "returns" : { "type" : "object()*", "description" : "all facts matching the given search query" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "facts", "qname" : "facts:facts", "signature" : "($fact-or-ids as item()*) as object()*", "description" : " 
    Return the fact with the given FIDs.
    \n", "summary" : "
      Return the fact with the given FIDs.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the FIDs or the facts themselves.
    " } ], "returns" : { "type" : "object()*", "description" : "the facts with the given FIDs the empty sequence if no fact was found or if the input is an empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "fid", "qname" : "facts:fid", "signature" : "($facts-or-ids as item()*) as atomic*", "description" : " 
    Converts the input to a normalized fact id (FID). The input\n can be either an FID, or a fact object which contains an _id.
    \n", "summary" : "
      Converts the input to a normalized fact id (FID).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "facts-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of fact objects or FIDs.
    " } ], "returns" : { "type" : "atomic*", "description" : "the normalized FIDs." }, "errors" : [ "facts:INVALID-PARAMETER if the FID or fact is not valid." ] }, { "isDocumented" : true, "arity" : 1, "name" : "instant-for-fact", "qname" : "facts:instant-for-fact", "signature" : "($fact-or-id as item()) as atomic?", "description" : " 
    Retrieves the instant period for which a fact was reported.
    \n", "summary" : "
      Retrieves the instant period for which a fact was reported.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-id", "type" : "item()", "occurrence" : null, "description" : "
     a fact or its FID.
    " } ], "returns" : { "type" : "atomic?", "description" : "the instance period, or the empty sequence if it is not instant." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-fact-forever", "qname" : "facts:is-fact-forever", "signature" : "($fact-or-id as item()) as boolean", "description" : " 
    Tests whether a fact is reported forever.
    \n", "summary" : "
      Tests whether a fact is reported forever.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-id", "type" : "item()", "occurrence" : null, "description" : "
     a fact or its FID.
    " } ], "returns" : { "type" : "boolean", "description" : "true if its period is forever, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "merge-objects", "qname" : "facts:merge-objects", "signature" : "($o1 as object()?, $o2 as object()?, $prioritize-first-object as boolean) as object()?", "description" : " 
    Helper function to deep-merge two objects. If the two given objects have\n    fields with the same name they are merged, which means:\n      1. if the values of the fields are objects then these are merged\n      2. in any other case the fields are accumulated into an array.
    \n 
    The third parameter can be used to priotitize the first object. If the first\n    object is prioritized and both objects contain fields with the same name,\n    the fields are either merged (in case of two object values) or the value of\n    the first object is taken.
    \n", "summary" : "
      Helper function to deep-merge two objects.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "o1", "type" : "object()", "occurrence" : "?", "description" : "
     first object
    " }, { "name" : "o2", "type" : "object()", "occurrence" : "?", "description" : "
     second object
    " }, { "name" : "prioritize-first-object", "type" : "boolean", "occurrence" : null, "description" : "
     boolean flag to give the first object higher priority in the merge
    " } ], "returns" : { "type" : "object()?", "description" : "one merge object or an empty-sequence (in case both input objects are empty)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "populate-with-footnotes", "qname" : "facts:populate-with-footnotes", "signature" : "($fact-or-ids as item()*) as object()*", "description" : " 
    Populates a sequence of facts with their associated footnotes.\n More in detail, in each returned fact object an additional field\n Footnotes is added which contains all connected footnotes in an\n array.
    \n", "summary" : "
      Populates a sequence of facts with their associated footnotes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the FIDs or the facts themselves.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated Footnotes field." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "populate-with-footnotes", "qname" : "facts:populate-with-footnotes", "signature" : "($fact-or-ids as item()*, $options as object()?) as object()*", "description" : " 
    Populates a sequence of facts with their associated footnotes.\n More in detail, in each returned fact object an additional field\n Footnotes is added which contains all connected footnotes in an\n array.
    \n", "summary" : "
      Populates a sequence of facts with their associated footnotes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the FIDs or the facts themselves.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated Footnotes field." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "prefix-from-fact-concept", "qname" : "facts:prefix-from-fact-concept", "signature" : "($fact as object()) as string?", "description" : " 
    Helper function to get the prefix of a given fact`s xbrl:Concept aspect.
    \n", "summary" : "
      Helper function to get the prefix of a given fact`s xbrl:Concept aspect.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact", "type" : "object()", "occurrence" : null, "description" : "
     a fact object.
    " } ], "returns" : { "type" : "string?", "description" : "the prefix of the fact's xbrl:Concept aspect or empty sequence if the concept doesn't have a prefix." }, "errors" : [  ] } ], "variables" : [ { "name" : "facts:col", "type" : "string", "description" : " Name of the collection the facts are stored in.\n" }, { "name" : "facts:ID", "type" : "string", "description" : " Name of the field that points to the facts FID.\n" }, { "name" : "facts:ARCHIVE", "type" : "string", "description" : " Name of the field that points to the archive.\n" }, { "name" : "facts:ASPECTS", "type" : "string", "description" : " Name of the field that stores the aspects.\n" }, { "name" : "facts:CONCEPT", "type" : "string", "description" : " Name of the concept aspect.\n" }, { "name" : "facts:PERIOD", "type" : "string", "description" : " Name of the period aspect.\n" }, { "name" : "facts:ENTITY", "type" : "string", "description" : " Name of the entity aspect.\n" }, { "name" : "facts:UNIT", "type" : "string", "description" : " Name of the unit aspect.\n" }, { "name" : "facts:FOOTNOTES", "type" : "string", "description" : " Name of the field that stores the Footnotes (if populated).\n" }, { "name" : "facts:ALL_OF_THEM", "type" : "boolean", "description" : " Joker for all archives or all concepts.\n" } ] }, "http://www.w3.org/2005/xqt-errors" : { "ns" : "http://www.w3.org/2005/xqt-errors", "description" : " This module contains one variable declaration for each diagnostic of the\n http://www.w3.org/2005/xqt-errors namespace.\n The variables serves as documentation for the errors but can also\n be used in the code. For example, one useful scenario is to compare\n an error caught in the catch clause of a try-catch expression with one of\n the variables.\n", "sees" : [  ], "authors" : [ "Carlos Lopez" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" } ], "functions" : [  ], "variables" : [ { "name" : "err:FORG0006", "type" : "xs:QName", "description" : " Invalid argument type.\n" }, { "name" : "err:FODF1280", "type" : "xs:QName", "description" : " Invalid decimal format name supplied to \\c fn:format-number().\n" }, { "name" : "err:FODF1310", "type" : "xs:QName", "description" : " Invalid decimal/integer format picture string.\n" }, { "name" : "err:FODT0001", "type" : "xs:QName", "description" : " Overflow/underflow in date/time operation.\n" }, { "name" : "err:FODT0002", "type" : "xs:QName", "description" : " Overflow/underflow in duration operation.\n" }, { "name" : "err:FODT0003", "type" : "xs:QName", "description" : " Invalid timezone value.\n" }, { "name" : "err:FONS0004", "type" : "xs:QName", "description" : " No namespace found for prefix.\n" }, { "name" : "err:FONS0005", "type" : "xs:QName", "description" : " Base-URI not defined in static context.\n" }, { "name" : "err:FORG0001", "type" : "xs:QName", "description" : " Invalid value for cast/constructor.\n" }, { "name" : "err:FORG0002", "type" : "xs:QName", "description" : " Invalid argument to \\c fn:resolve-uri().\n" }, { "name" : "err:FORG0003", "type" : "xs:QName", "description" : " \\c fn:zero-or-one() called with a sequence containing more than one\n item.\n" }, { "name" : "err:FORG0004", "type" : "xs:QName", "description" : " \\c fn:one-or-more() called with a sequence containing no items.\n" }, { "name" : "err:FORG0005", "type" : "xs:QName", "description" : " \\c fn:exactly-one() called with a sequence containing zero or more\n than one item.\n" }, { "name" : "err:FODC0007", "type" : "xs:QName", "description" : " Base URI passed to \\c fn:parse() is not a valid absolute URI.\n" }, { "name" : "err:FORG0008", "type" : "xs:QName", "description" : " The two arguments to fn:dateTime() have inconsistent timezones.\n" }, { "name" : "err:FORG0009", "type" : "xs:QName", "description" : " Error in resolving a relative URI against a base URI in\n \\c fn:resolve-uri().\n" }, { "name" : "err:FORX0001", "type" : "xs:QName", "description" : " Invalid regular expression flags.\n" }, { "name" : "err:FORX0002", "type" : "xs:QName", "description" : " Invalid regular expression.\n" }, { "name" : "err:FORX0003", "type" : "xs:QName", "description" : " Regular expression matches zero-length string.\n" }, { "name" : "err:FORX0004", "type" : "xs:QName", "description" : " Invalid replacement string.\n" }, { "name" : "err:FOTY0012", "type" : "xs:QName", "description" : " Argument node does not have a typed value.\n" }, { "name" : "err:FOTY0013", "type" : "xs:QName", "description" : " An argument to \\c fn:data() contains a node that does not have a typed\n value.\n" }, { "name" : "err:FOTY0014", "type" : "xs:QName", "description" : " The argument to \\c fn:string() is a function item.\n" }, { "name" : "err:FOTY0015", "type" : "xs:QName", "description" : " An argument to \\c fn:deep-equal() contains a function item.\n" }, { "name" : "err:FOUT1170", "type" : "xs:QName", "description" : " Identifier cannot be used to retrive a resource containing text\n" }, { "name" : "err:FOCA0005", "type" : "xs:QName", "description" : " NaN supplied as float/double value.\n" }, { "name" : "err:FTDY0016", "type" : "xs:QName", "description" : " It is a dynamic error if a weight value is not within the required range\n of values; it is also a dynamic error if an implementation that does not\n support negative weights encounters a negative weight value.\n" }, { "name" : "err:FTDY0017", "type" : "xs:QName", "description" : " It is a dynamic error if an implementation encounters a mild not\n selection, one of whose operands evaluates to an AllMatches that\n contains a StringExclude.\n" }, { "name" : "err:FTST0018", "type" : "xs:QName", "description" : " It is a static error if, during the static analysis phase, the query is\n found to contain a thesaurus option that refers to a thesaurus that is\n not found in the statically known thesauri.\n" }, { "name" : "err:FTST0019", "type" : "xs:QName", "description" : " It is a static error if, within a single FTMatchOptions, there is more\n than one match option of any given match option group.\n" }, { "name" : "err:FTDY0020", "type" : "xs:QName", "description" : " It is a dynamic error if, when \"wildcards\" is in effect, a query string\n violates wildcard syntax.\n" }, { "name" : "err:FOER0000", "type" : "xs:QName", "description" : " Unidentified error.\n" }, { "name" : "err:FOAR0001", "type" : "xs:QName", "description" : " Division by zero.\n" }, { "name" : "err:FOAR0002", "type" : "xs:QName", "description" : " Numeric operation overflow/underflow.\n" }, { "name" : "err:FOCA0001", "type" : "xs:QName", "description" : " Input value too large for decimal.\n" }, { "name" : "err:FOCA0002", "type" : "xs:QName", "description" : " Invalid lexical value.\n" }, { "name" : "err:FOCA0003", "type" : "xs:QName", "description" : " Input value too large for integer.\n" }, { "name" : "err:FOUT1190", "type" : "xs:QName", "description" : " Retrieved resource contains octets that cannot be decoded into Unicode\n using the specified encoding, the resulting characters are not\n permitted XML characters or requested encoding not supported\n" }, { "name" : "err:FOCA0006", "type" : "xs:QName", "description" : " Raised when casting a string to xs:decimal if the string has more\n digits of precision than the implementation can represent (the\n implementation also has the option of rounding).\n" }, { "name" : "err:FOCH0001", "type" : "xs:QName", "description" : " Code point not valid.\n" }, { "name" : "err:FOCH0002", "type" : "xs:QName", "description" : " Unsupported collation.\n" }, { "name" : "err:FOCH0003", "type" : "xs:QName", "description" : " Unsupported normalization form.\n" }, { "name" : "err:FOCH0004", "type" : "xs:QName", "description" : " Collation does not support collation units.\n" }, { "name" : "err:FODC0001", "type" : "xs:QName", "description" : " No context document.\n" }, { "name" : "err:FODC0002", "type" : "xs:QName", "description" : " Error retrieving resource.\n" }, { "name" : "err:FODC0003", "type" : "xs:QName", "description" : " Raised by fn:doc, fn:collection to indicate that it is not possible to\n return a result that is guaranteed deterministic.\n" }, { "name" : "err:FODC0004", "type" : "xs:QName", "description" : " Invalid argument to \\c fn:collection().\n" }, { "name" : "err:FODC0005", "type" : "xs:QName", "description" : " Invalid argument to \\c fn:doc() or \\c fn:doc-available().\n" }, { "name" : "err:FODC0006", "type" : "xs:QName", "description" : " Invalid content passed to \\c fn:parse().\n" }, { "name" : "err:SERE0005", "type" : "xs:QName", "description" : " It is an error if the serialized result would contain an NCName Names\n that contains a character that is not permitted by the version of\n Namespaces in XML specified by the version parameter.\n" }, { "name" : "err:XUDY0024", "type" : "xs:QName", "description" : " It is a dynamic error if the effect of a set of updating expressions is\n to introduce conflicting namespace bindings into an element node.\n" }, { "name" : "err:XUDY0027", "type" : "xs:QName", "description" : " It is a dynamic error if the target expression of an insert, replace, or\n rename expression evaluates to an empty sequence.\n" }, { "name" : "err:XUST0028", "type" : "xs:QName", "description" : " It is a static error if a function declaration specifies both \\c updating\n and a return type.\n" }, { "name" : "err:XUDY0029", "type" : "xs:QName", "description" : " In an insert expression where \\c before or \\c after is specified, it is\n a dynamic error if the node returned by the target expression does not\n have a parent.\n" }, { "name" : "err:XUDY0030", "type" : "xs:QName", "description" : " It is a dynamic error if an insert expression specifies the insertion of\n an attribute node before or after a child of a document node.\n" }, { "name" : "err:XUDY0031", "type" : "xs:QName", "description" : " It is a dynamic error if multiple calls to \\c fn:put() in the same\n snapshot specify the same URI (after resolution of relative URIs).\n" }, { "name" : "err:FOUP0001", "type" : "xs:QName", "description" : " It is a dynamic error if the first operand of \\c fn:put() is not a node\n of a supported kind.\n" }, { "name" : "err:FOUP0002", "type" : "xs:QName", "description" : " It is a dynamic error if the second operand of \\c fn:put() is not a valid\n lexical representation of the \\c xs:anyURI type.\n" }, { "name" : "err:SENR0001", "type" : "xs:QName", "description" : " It is an error if an item in S6 in sequence normalization is an attribute\n node or a namespace node.\n" }, { "name" : "err:SERE0003", "type" : "xs:QName", "description" : " It is an error if the serializer is unable to satisfy the rules for\n either a well-formed XML document entity or a well-formed XML external\n general parsed entity, or both, except for content modified by the\n character expansion phase of serialization.\n" }, { "name" : "err:SEPM0004", "type" : "xs:QName", "description" : " It is an error to specify the doctype-system parameter, or to specify\n the standalone parameter with a value other than omit, if the instance\n of the data model contains text nodes or multiple element nodes as\n children of the root node.\n" }, { "name" : "err:XUDY0023", "type" : "xs:QName", "description" : " It is a dynamic error if an insert, replace, or rename expression\n affects an element node by introducing a new namespace binding that\n conflicts with one of its existing namespace bindings.\n" }, { "name" : "err:SERE0006", "type" : "xs:QName", "description" : " It is an error if the serialized result would contain a character that is\n not permitted by the version of XML specified by the version parameter.\n" }, { "name" : "err:SESU0007", "type" : "xs:QName", "description" : " It is an error if an output encoding other than UTF-8 or UTF-16 is\n requested and the serializer does not support that encoding.\n" }, { "name" : "err:SERE0008", "type" : "xs:QName", "description" : " It is an error if a character that cannot be represented in the encoding\n that the serializer is using for output appears in a context where\n character references are not allowed (for example if the character\n occurs in the name of an element).\n" }, { "name" : "err:SEPM0009", "type" : "xs:QName", "description" : " It is an error if the omit-xml-declaration parameter has the value yes,\n and the standalone attribute has a value other than omit; or the version\n parameter has a value other than 1.0 and the doctype-system parameter is\n specified.\n" }, { "name" : "err:SEPM0010", "type" : "xs:QName", "description" : " It is an error if the output method is xml, the value of the\n undeclare-prefixes parameter is yes, and the value of the version\n parameter is 1.0.\n" }, { "name" : "err:SESU0011", "type" : "xs:QName", "description" : " It is an error if the value of the normalization-form parameter\n specifies a normalization form that is not supported by the serializer.\n" }, { "name" : "err:SERE0012", "type" : "xs:QName", "description" : " It is an error if the value of the normalization-form parameter is\n fully-normalized and any relevant construct of the result begins with a\n combining character.\n" }, { "name" : "err:SESU0013", "type" : "xs:QName", "description" : " It is an error if the serializer does not support the version of XML or\n HTML specified by the version parameter.\n" }, { "name" : "err:SERE0014", "type" : "xs:QName", "description" : " It is an error to use the HTML output method when characters which are\n legal in XML but not in HTML, specifically the control characters\n #x7F-#x9F, appear in the instance of the data model.\n" }, { "name" : "err:SERE0015", "type" : "xs:QName", "description" : " It is an error to use the HTML output method when \\c > appears within a\n processing instruction in the data model instance being serialized.\n" }, { "name" : "err:SEPM0016", "type" : "xs:QName", "description" : " It is a an error if a parameter value is invalid for the defined domain.\n" }, { "name" : "err:XUTY0010", "type" : "xs:QName", "description" : " In a replace expression where value of is not specified and\n the target is an element, text, comment, or processing instruction node,\n it is a type error if the replacement sequence does not consist of zero\n or more element, text, comment, or processing instruction nodes.\n" }, { "name" : "err:FOFL0001", "type" : "xs:QName", "description" : " This error is raised if the fn:function-lookup returns a context-dependent function and the context-dependent function is then called.\n" }, { "name" : "err:FOCZ0001", "type" : "xs:QName", "description" : " Invalid content passed to \\c x:canonicalize().\n" }, { "name" : "err:XUST0001", "type" : "xs:QName", "description" : " It is a static error if an updating expression is used in any position\n other than one of the following:\n - The topmost expression in the body of a query.\n - The \\c modify clause of a transform expression.\n - The \\c return clause of a FLWOR expression.\n - The \\c return clauses of a typeswitch expression in which every \\c\n return clause contains an updating expression or a vacuous expression.\n - The \\c then and \\c else clauses of a conditional statement in which\n both the \\c then and \\c else clauses contain either an updating\n expression or a vacuous expression.\n - An operand of a comma expression in which each operand is either an\n updating expression or a vacuous expression.\n - The content of a parenthesized expression.\n - The body of a function declaration in which the keyword \\c updating is\n specified.\n" }, { "name" : "err:XUST0002", "type" : "xs:QName", "description" : " It is a static error if a simple expression that is not a vacuous\n expression is used in one of the following positions:\n - The \\c modify clause of a transform expression.\n - The top-level expression in the body of a function declaration in\n which the keyword \\c updating is specified.\n" }, { "name" : "err:XUST0003", "type" : "xs:QName", "description" : " It is a static error if a Prolog contains more than one revalidation\n declaration.\n" }, { "name" : "err:XUTY0004", "type" : "xs:QName", "description" : " It is a type error if the insertion sequence of an insert expression\n contains an attribute node following a node that is not an attribute\n node.\n" }, { "name" : "err:XUTY0005", "type" : "xs:QName", "description" : " In an insert expression where into, as first\n into, or as last into is specified, it is a type\n error if the target expression returns a non-empty result that does not\n consist of a single element or document node.\n" }, { "name" : "err:XUTY0006", "type" : "xs:QName", "description" : " In an insert expression where \\c before or \\c after is specified, it is\n a type error if the target expression returns a non-empty result that\n does not consist of a single element, text, comment, or processing\n instruction node.\n" }, { "name" : "err:XUTY0007", "type" : "xs:QName", "description" : " It is a type error if the target expression of a delete expression does\n not return a sequence of zero or more nodes.\n" }, { "name" : "err:XUTY0008", "type" : "xs:QName", "description" : " In a replace expression, it is a type error if the target expression\n returns a non-empty result that does not consist of a single element,\n attribute, text, comment, or processing instruction node.\n" }, { "name" : "err:XUDY0009", "type" : "xs:QName", "description" : " In a replace expression where value of is not specified, it\n is a dynamic error if the node returned by the target expression does\n not have a parent.\n" }, { "name" : "err:FTST0009", "type" : "xs:QName", "description" : " It may be a static error if, during the static analysis phase, the query\n is found to contain a language identifier in a language option that the\n implementation does not support. The implementation may choose not to\n raise this error and instead provide some other implementation-defined\n behavior.\n" }, { "name" : "err:XUTY0011", "type" : "xs:QName", "description" : " In a replace expression where value of is not specified and\n the target is an attribute node, it is a type error if the replacement\n sequence does not consist of zero or more attribute nodes.\n" }, { "name" : "err:XUTY0012", "type" : "xs:QName", "description" : " In a rename expression, it is a type error if the target expression\n returns a non-empty result that does not consist of a single element,\n attribute, or processing instruction node.\n" }, { "name" : "err:XUTY0013", "type" : "xs:QName", "description" : " In a transform expression, it is a type error if a source expression in\n the \\c copy clause does not return a single node.\n" }, { "name" : "err:XUDY0014", "type" : "xs:QName", "description" : " In a transform expression, it is a dynamic error if the \\c modify clause\n modifies any node that was not created by the \\c copy clause.\n" }, { "name" : "err:XUDY0015", "type" : "xs:QName", "description" : " It is a dynamic error if any node is the target of more than one \\c\n rename expression within the same query.\n" }, { "name" : "err:XUDY0016", "type" : "xs:QName", "description" : " It is a dynamic error if any node is the target of more than one \\c\n replace expression (without value of being specified)\n within the same query.\n" }, { "name" : "err:XUDY0017", "type" : "xs:QName", "description" : " It is a dynamic error if any node is the target of more than one\n replace value of expression within the same query.\n" }, { "name" : "err:XUDY0018", "type" : "xs:QName", "description" : " It is a dynamic error if a function that was declared to be \\c external\n but not \\c updating returns a non-empty pending update list.\n" }, { "name" : "err:XUDY0019", "type" : "xs:QName", "description" : " It is a dynamic error if a function that was declared to be both \\c\n external and \\c updating returns a non-empty data model instance.\n" }, { "name" : "err:XUDY0021", "type" : "xs:QName", "description" : " It is a dynamic error if the XDM instance that would result from\n applying all the updates in a query violates any constraint specified in\n [XQuery 1.0 and XPath 2.0 Data Model]. In this case, none of the updates\n in the query are made effective.\n" }, { "name" : "err:XUTY0022", "type" : "xs:QName", "description" : " It is a type error if an insert expression specifies the insertion of an\n attribute node into a document node.\n" }, { "name" : "err:XQST0052", "type" : "xs:QName", "description" : " The type must be the name of a type defined in the in-scope schema types,\n and the {variety} of the type must be simple.\n" }, { "name" : "err:XQST0033", "type" : "xs:QName", "description" : " It is a static error if a module contains multiple bindings for the same\n namespace prefix.\n" }, { "name" : "err:XQST0034", "type" : "xs:QName", "description" : " It is a static error if multiple functions declared or imported by a\n module have the same number of arguments and their expanded QNames are\n equal (as defined by the eq operator).\n" }, { "name" : "err:XQST0035", "type" : "xs:QName", "description" : " It is a static error to import two schema components that both define the\n same name in the same symbol space and in the same scope.\n" }, { "name" : "err:XQST0036", "type" : "xs:QName", "description" : " It is a static error to import a module if the in-scope schema\n definitions of the importing module do not include all of the following:\n -# An in-scope schema type for each type-name that appears:\n - in the type of a variable that is declared in the imported module\n and referenced in the importing module, OR\n - in a parameter-type or result-type of a function that is declared in\n the imported module and referenced in the importing module.\n -# An in-scope element declaration for each element-name \\c EN such that:\n - \\c schema-element(EN) appears in the declared type of a variable in\n the imported module, and that variable is referenced in the\n importing module, OR\n - \\c schema-element(EN) appears in a parameter-type or result-type\n of a function declared in the imported module, and that function is\n referenced in the importing module.\n -# An in-scope attribute declaration for each attribute-name \\c AN such\n that:\n - \\c schema-attribute(AN) appears in the declared type of a variable\n in the imported module, and that variable is referenced in the\n importing module, OR\n - \\c schema-attribute(AN) appears in a parameter-type or result-type\n of a function declared in the imported module, and that function is\n referenced in the importing module.\n" }, { "name" : "err:XQST0038", "type" : "xs:QName", "description" : " It is a static error if a Prolog contains more than one default collation\n declaration, or the value specified by a default collation declaration is\n not present in statically known collations.\n" }, { "name" : "err:XQST0039", "type" : "xs:QName", "description" : " It is a static error for a function declaration to have more than one\n parameter with the same name.\n" }, { "name" : "err:XQST0040", "type" : "xs:QName", "description" : " It is a static error if the attributes specified by a direct element\n constructor do not have distinct expanded QNames.\n" }, { "name" : "err:XQST0045", "type" : "xs:QName", "description" : " It is a static error if the function name in a function declaration is in\n one of the following namespaces:\n http://www.w3.org/XML/1998/namespace,\n http://www.w3.org/2001/XMLSchema,\n http://www.w3.org/2001/XMLSchema-instance,\n http://www.w3.org/2005/xpath-functions.\n" }, { "name" : "err:XQST0046", "type" : "xs:QName", "description" : " An implementation MAY raise a static error if the value of a URILiteral\n is of nonzero length and is not in the lexical space of \\c xs:anyURI.\n" }, { "name" : "err:XQST0047", "type" : "xs:QName", "description" : " It is a static error if multiple module imports in the same Prolog\n specify the same target namespace.\n" }, { "name" : "err:XQST0048", "type" : "xs:QName", "description" : " It is a static error if a function or variable declared in a library\n module is not in the target namespace of the library module.\n" }, { "name" : "err:XQST0049", "type" : "xs:QName", "description" : " It is a static error if two or more variables declared or imported by a\n module have equal expanded QNames (as defined by the eq operator.)\n" }, { "name" : "err:XQST0032", "type" : "xs:QName", "description" : " A static error is raised if a Prolog contains more than one base URI\n declaration.\n" }, { "name" : "err:XQST0054", "type" : "xs:QName", "description" : " It is a static error if a variable depends on itself.\n" }, { "name" : "err:XQST0055", "type" : "xs:QName", "description" : " It is a static error if a Prolog contains more than one copy-namespaces\n declaration.\n" }, { "name" : "err:XQST0057", "type" : "xs:QName", "description" : " It is a static error if a schema import binds a namespace prefix but\n does not specify a target namespace other than a zero-length string.\n" }, { "name" : "err:XQST0058", "type" : "xs:QName", "description" : " It is a static error if multiple schema imports specify the same target\n namespace.\n" }, { "name" : "err:XQST0059", "type" : "xs:QName", "description" : " It is a static error if an implementation is unable to process a schema\n or module import by finding a schema or module with the specified\n target namespace.\n" }, { "name" : "err:XQST0060", "type" : "xs:QName", "description" : " It is a static error if the name of a function in a function declaration\n is not in a namespace (expanded QName has a null namespace URI).\n" }, { "name" : "err:XQST0065", "type" : "xs:QName", "description" : " A static error is raised if a Prolog contains more than one ordering mode\n declaration.\n" }, { "name" : "err:XQST0066", "type" : "xs:QName", "description" : " A static error is raised if a Prolog contains more than one default\n element/type namespace declaration, or more than one default function\n namespace declaration.\n" }, { "name" : "err:XQST0067", "type" : "xs:QName", "description" : " A static error is raised if a Prolog contains more than one construction\n declaration.\n" }, { "name" : "err:XQST0068", "type" : "xs:QName", "description" : " A static error is raised if a Prolog contains more than one\n boundary-space declaration.\n" }, { "name" : "err:XQST0069", "type" : "xs:QName", "description" : " A static error is raised if a Prolog contains more than one empty order\n declaration.\n" }, { "name" : "err:XPTY0019", "type" : "xs:QName", "description" : " It is a type error if the result of a step (other than the last step) in a\n path expression contains an atomic value.\n" }, { "name" : "err:XPST0001", "type" : "xs:QName", "description" : " It is a static error if analysis of an expression relies on some\n component of the static context that has not been assigned a value.\n" }, { "name" : "err:XPST0003", "type" : "xs:QName", "description" : " It is a static error if an expression is not a valid instance of the\n grammar.\n" }, { "name" : "err:XPST0005", "type" : "xs:QName", "description" : " During the analysis phase, it is a static error if the static type\n assigned to an expression other than the expression \\c () or \\c data(())\n is \\c empty-sequence().\n" }, { "name" : "err:XPST0008", "type" : "xs:QName", "description" : " It is a static error if an expression refers to an element name,\n attribute name, schema type name, namespace prefix, or variable name\n that is not defined in the static context, except for an ElementName in\n an ElementTest or an AttributeName in an AttributeTest.\n" }, { "name" : "err:XPST0017", "type" : "xs:QName", "description" : " It is a static error if the expanded QName and number of arguments in a\n function call do not match the name and arity of a function signature in\n the static context.\n" }, { "name" : "err:XPST0051", "type" : "xs:QName", "description" : " It is a static error if a QName that is used as an AtomicType in a\n SequenceType is not defined in the in-scope schema types as an atomic\n type.\n" }, { "name" : "err:XPST0080", "type" : "xs:QName", "description" : " It is a static error if the target type of a \\c cast or \\c castable\n expression is \\c xs:NOTATION or \\c xs:anyAtomicType.\n" }, { "name" : "err:XPST0081", "type" : "xs:QName", "description" : " It is a static error if a QName used in a query contains a namespace\n prefix that cannot be expanded into a namespace URI by using the\n statically known namespaces.\n" }, { "name" : "err:XPST0083", "type" : "xs:QName", "description" : " It is a static error if the target type of a \\c cast expression or\n constructor function is \\c xs:QName or a type derived from \\c xs:QName\n or \\c xs:NOTATION, and the argument of the cast expression or\n constructor function is not a string literal.\n" }, { "name" : "err:XPTY0004", "type" : "xs:QName", "description" : " It is a type error if, during the static analysis phase, an expression\n is found to have a static type that is not appropriate for the context\n in which the expression occurs, or during the dynamic evaluation phase,\n the dynamic type of a value does not match a required type as specified\n by the matching rules in 2.5.4 SequenceType Matching.\n" }, { "name" : "err:XPTY0018", "type" : "xs:QName", "description" : " It is a type error if the result of the last step in a path expression\n contains both nodes and non-nodes.\n" }, { "name" : "err:XQST0070", "type" : "xs:QName", "description" : " A static error is raised if one of the predefined prefixes \\c xml or \\c\n xmlns appears in a namespace declaration, or if any of the following\n conditions is statically detected in any expression or declaration:\n - The prefix \\c xml is bound to some namespace URI other than\n http://www.w3.org/XML/1998/namespace.\n - A prefix other than \\c xml is bound to the namespace URI\n http://www.w3.org/XML/1998/namespace.\n - The prefix \\c xmlns is bound to any namespace URI.\n - A prefix other than \\c xmlns is bound to the namespace URI\n http://www.w3.org/2000/xmlns/.\n" }, { "name" : "err:XPTY0020", "type" : "xs:QName", "description" : " It is a type error if, in an axis step, the context item is not a node.\n" }, { "name" : "err:XPTY0117", "type" : "xs:QName", "description" : " Attempt to cast to a namespace-sensitive type failed because the namespace\n bindings for the result can not be determined.\n" }, { "name" : "err:XQTY0024", "type" : "xs:QName", "description" : " It is a type error if the content sequence in an element constructor\n contains an attribute node following a node that is not an attribute node.\n" }, { "name" : "err:XQTY0030", "type" : "xs:QName", "description" : " It is a type error if the argument of a validate expression does not\n evaluate to exactly one document or element node.\n" }, { "name" : "err:XQTY0086", "type" : "xs:QName", "description" : " It is a type error if the typed value of a copied element or attribute\n node is namespace-sensitive when construction mode is \\c preserve and\n copy-namespaces mode is \\c no-preserve.\n" }, { "name" : "err:XQTY0105", "type" : "xs:QName", "description" : " It is a type error if the content sequence in an element constructor contains a function item.\n" }, { "name" : "err:XQST0009", "type" : "xs:QName", "description" : " An implementation that does not support the Schema Import Feature must\n raise a static error if a Prolog contains a schema import.\n" }, { "name" : "err:XQST0012", "type" : "xs:QName", "description" : " It is a static error if the set of definitions contained in all schemas\n imported by a Prolog do not satisfy the conditions for schema validity\n specified in Sections 3 and 5 of [XML Schema] Part 1--i.e., each\n definition must be valid, complete, and unique.\n" }, { "name" : "err:XQST0013", "type" : "xs:QName", "description" : " It is a static error if an implementation recognizes a pragma but\n determines that its content is invalid.\n" }, { "name" : "err:XQST0022", "type" : "xs:QName", "description" : " It is a static error if the value of a namespace declaration attribute is\n not a URILiteral.\n" }, { "name" : "err:XQST0031", "type" : "xs:QName", "description" : " It is a static error if the version number specified in a version\n declaration is not supported by the implementation.\n" }, { "name" : "err:XQDY0072", "type" : "xs:QName", "description" : " It is a dynamic error if the result of the content expression of a\n computed comment constructor contains two adjacent hyphens or ends with\n a hyphen.\n" }, { "name" : "err:XQST0128", "type" : "xs:QName", "description" : " It is a static error if a feature name that an implementation supports appears\n in a prohibit-feature option declaration, and the implementation is unable to\n disable the feature.\n" }, { "name" : "err:XPDY0002", "type" : "xs:QName", "description" : " It is a dynamic error if evaluation of an expression relies on some part\n of the dynamic context that has not been assigned a value.\n" }, { "name" : "err:XPDY0050", "type" : "xs:QName", "description" : " It is a dynamic error if the dynamic type of the operand of a treat\n expression does not match the sequence type specified by the treat\n expression. This error might also be raised by a path expression\n beginning with \"/\" or \"//\" if the context node\n is not in a tree that is rooted at a document node. This is because a\n leading \"/\" or \"//\" in a path expression is an\n abbreviation for an initial step that includes the clause \\c treat as \\c\n document-node().\n" }, { "name" : "err:XQDY0025", "type" : "xs:QName", "description" : " It is a dynamic error if any attribute of a constructed element does not\n have a name that is distinct from the names of all other attributes of\n the constructed element.\n" }, { "name" : "err:XQDY0026", "type" : "xs:QName", "description" : " It is a dynamic error if the result of the content expression of a\n computed processing instruction constructor contains the string \"?>\".\n" }, { "name" : "err:XQDY0027", "type" : "xs:QName", "description" : " In a validate expression, it is a dynamic error if the root element\n information item in the PSVI resulting from validation does not have the\n expected validity property: \\c valid if validation mode is \\c strict, or\n either \\c valid or \\c notKnown if validation mode is \\c lax.\n" }, { "name" : "err:XQDY0041", "type" : "xs:QName", "description" : " It is a dynamic error if the value of the name expression in a computed\n processing instruction constructor cannot be cast to the type\n \\c xs:NCName.\n" }, { "name" : "err:XQDY0044", "type" : "xs:QName", "description" : " It is a static error the node-name of a node constructed by a computed\n attribute constructor has any of the following properties:\n - Its namespace prefix is \\c xmlns.\n - It has no namespace prefix and its local name is \\c xmlns.\n - Its namespace URI is http://www.w3.org/2000/xmlns/.\n - Its namespace prefix is \\c xml and its namespace URI is not\n http://www.w3.org/XML/1998/namespace.\n - Its namespace prefix is other than \\c xml and its namespace URI is\n http://www.w3.org/XML/1998/namespace.\n" }, { "name" : "err:XQDY0054", "type" : "xs:QName", "description" : " It is a dynamic error if a cycle is encountered in the definition of a\n module's dynamic context components, for example because of a cycle in\n variable declarations.\n" }, { "name" : "err:XQDY0061", "type" : "xs:QName", "description" : " It is a dynamic error if the operand of a validate expression is a\n document node whose children do not consist of exactly one element node\n and zero or more comment and processing instruction nodes, in any order.\n" }, { "name" : "err:XQDY0064", "type" : "xs:QName", "description" : " It is a dynamic error if the value of the name expression in a computed\n processing instruction constructor is equal to \"XML\" (in any combination\n of upper and lower case).\n" }, { "name" : "err:XQST0127", "type" : "xs:QName", "description" : " It is a static error if a given feature is both required and prohibited, directly or indirectly, in a module.\n" }, { "name" : "err:XQDY0074", "type" : "xs:QName", "description" : " It is a dynamic error if the value of the name expression in a computed\n element or attribute constructor cannot be converted to an expanded\n QName (for example, because it contains a namespace prefix not found in\n statically known namespaces).\n" }, { "name" : "err:XQDY0084", "type" : "xs:QName", "description" : " It is a dynamic error if the element validated by a \\c validate statement\n does not have a top-level element declaration in the in-scope element\n declarations, if validation mode is \\c strict.\n" }, { "name" : "err:XQDY0091", "type" : "xs:QName", "description" : " An implementation MAY raise a dynamic error if an \\c xml:id error, as\n defined in [XML ID], is encountered during construction of an attribute\n named \\c xml:id.\n" }, { "name" : "err:XQDY0092", "type" : "xs:QName", "description" : " An implementation MAY raise a dynamic error if a constructed attribute\n named \\c xml:space has a value other than \\c preserve or \\c default.\n" }, { "name" : "err:XQDY0096", "type" : "xs:QName", "description" : " It is a dynamic error the node-name of a node constructed by a computed\n element constructor has any of the following properties:\n - Its namespace prefix is \\c xmlns.\n - Its namespace URI is http://www.w3.org/2000/xmlns/.\n - Its namespace prefix is \\c xml and its namespace URI is not\n http://www.w3.org/XML/1998/namespace.\n - Its namespace prefix is other than \\c xml and its namespace URI is\n http://www.w3.org/XML/1998/namespace.\n" }, { "name" : "err:XQDY0101", "type" : "xs:QName", "description" : " Invalid prefix and/or uri in computed namespace constructor\n" }, { "name" : "err:XQDY0102", "type" : "xs:QName", "description" : " In an element constructor, if two or more namespace bindings in the in-scope bindings would have the same prefix, then an error is raised if they have different URIs; if they would have the same prefix and URI, duplicate bindings are ignored.\n" }, { "name" : "err:XTDE1310", "type" : "xs:QName", "description" : " It is a non-recoverable dynamic error if the picture string does not\n satisfy the format-number function rules.\n" }, { "name" : "err:FOFD1340", "type" : "xs:QName", "description" : " It is a non-recoverable dynamic error if the $picture, $language,\n $calendar, or $place argument for fn:format-date, fn:format-time, or\n fn:format-dateTime is invalid.\n" }, { "name" : "err:FOFD1350", "type" : "xs:QName", "description" : " It is a non-recoverable dynamic error if a component specifier within\n the picture refers to components that are not available in the given\n type of $value.\n" }, { "name" : "err:FTST0008", "type" : "xs:QName", "description" : " It is a static error if, during the static analysis phase, the query is\n found to contain a stop word option that refers to a stop word list that\n is not found in the statically known stop word lists.\n" }, { "name" : "err:XQST0098", "type" : "xs:QName", "description" : " It is a static error if, for any named or unnamed decimal format, the\n properties representing characters used in a picture string do not each\n have distinct values. These properties are decimal-separator-sign,\n grouping-separator, percent-sign, per-mille-sign, zero-digit,\n digit-sign, and pattern-separator-sign.\n" }, { "name" : "err:XQST0071", "type" : "xs:QName", "description" : " A static error is raised if the namespace declaration attributes of a\n direct element constructor do not have distinct names.\n" }, { "name" : "err:XQST0076", "type" : "xs:QName", "description" : " It is a static error if a \\c collation subclause in an order by clause\n of a FLWOR expression does not identify a collation that is present in\n statically known collations.\n" }, { "name" : "err:XQST0079", "type" : "xs:QName", "description" : " It is a static error if an extension expression contains neither a\n pragma that is recognized by the implementation nor an expression\n enclosed in curly braces.\n" }, { "name" : "err:XQST0085", "type" : "xs:QName", "description" : " It is a static error if the namespace URI in a namespace declaration\n attribute is a zero-length string, and the implementation does not\n support [XML Names 1.1].\n" }, { "name" : "err:XQST0087", "type" : "xs:QName", "description" : " It is a static error if the encoding specified in a Version Declaration\n does not conform to the definition of \\c EncName specified in [XML 1.0]\n" }, { "name" : "err:XQST0088", "type" : "xs:QName", "description" : " It is a static error if the literal that specifies the target namespace\n in a module import or a module declaration is of zero length.\n" }, { "name" : "err:XQST0089", "type" : "xs:QName", "description" : " It is a static error if a variable bound in a \\c for or \\c window clause\n of a FLWOR expression, and its associated positional variable, do not\n have distinct names (expanded QNames).\n" }, { "name" : "err:XQST0090", "type" : "xs:QName", "description" : " It is a static error if a character reference does not identify a valid\n character in the version of XML that is in use.\n" }, { "name" : "err:XQST0093", "type" : "xs:QName", "description" : " It is a static error to import a module M1 if there exists a sequence of\n modules M1 ... Mi ... M1 such that each module directly depends on the\n next module in the sequence (informally, if M1 depends on itself through\n some chain of module dependencies.)\n" }, { "name" : "err:XQST0094", "type" : "xs:QName", "description" : " In the group by clause of a FLWOR expression, it is a static error if the\n name of a grouping variable is not equal (by the eq operator on expanded\n QNames) to the name of a variable that is bound by a for or let clause\n that precedes the group by clause.\n" }, { "name" : "err:XQST0097", "type" : "xs:QName", "description" : " It is a static error for a decimal-format to specify a value that is\n not valid for a given property.\n" }, { "name" : "err:NS", "type" : "item()*", "description" : "" }, { "name" : "err:XQST0099", "type" : "xs:QName", "description" : " If a module contains more than one context item declaration, a static error is raised [err:XQST0099].\n" }, { "name" : "err:XQST0103", "type" : "xs:QName", "description" : " All variables in a window clause must have distinct names.\n" }, { "name" : "err:XQST0106", "type" : "xs:QName", "description" : " It is a static error if a function's annotations contain more than one\n annotation named \\c private or \\c public.  It is a static error if a\n function's annotations contain more than one annotation named \\c\n deterministic or \\c nondeterministic.\n" }, { "name" : "err:XQST0111", "type" : "xs:QName", "description" : " It is a static error for a query prolog to contain two decimal formats\n with the same name, or to contain two default decimal formats.\n" }, { "name" : "err:XQST0113", "type" : "xs:QName", "description" : " Specifying a VarValue or VarDefaultValue for a context item declaration\n in a library module is a static error.\n" }, { "name" : "err:XQST0114", "type" : "xs:QName", "description" : " It is a static error for a decimal format declaration to define the\n same property more than once.\n" }, { "name" : "err:XQST0116", "type" : "xs:QName", "description" : " It is a static error if a variable declaration contains both a %private\n and a %public annotation, more than one %private annotation, or more\n than one %public annotation.\n" }, { "name" : "err:XQST0120", "type" : "xs:QName", "description" : " It is a static error if a feature required by require-feature is not\n supported by the implementation.\n" }, { "name" : "err:XQST0122", "type" : "xs:QName", "description" : " It is a static error if the name of a feature in require-feature or\n prohibit-feature is not in the lexical space of QName.\n" }, { "name" : "err:XQST0123", "type" : "xs:QName", "description" : " It is a static error if the name of a feature in require-feature is not\n recognized by the implementation.\n" }, { "name" : "err:XQST0126", "type" : "xs:QName", "description" : " It is a static error if all-extensions appears in a require-feature option declaration.\n" } ] }, "http://zorba.io/modules/excel/math" : { "ns" : "http://zorba.io/modules/excel/math", "description" : " This is a library module offering a part of the set of functions\n defined by Microsoft Excel 2003.\n", "sees" : [ "Excel 2003 Documentation: Math Functions" ], "authors" : [ "Daniel Turcanu" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/math", "prefix" : "excel" }, { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "abs", "qname" : "excel:abs", "signature" : "($arg as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Compute the abs of a numeric value.\n The value can also be a string and it will be casted to the appropriate numeric first.\n", "summary" : "
     Compute the abs of a numeric value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The parameter can be a number, string, boolean value.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The abs value as a numeric type." }, "errors" : [ "excel-err:Value if arg cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "cast-as-numeric", "qname" : "excel:cast-as-numeric", "signature" : "($number as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Cast the xs:anyAtomicType to a numeric type.\n If the value is already of a numeric type then nothing is changed.\n Otherwise the value is casted to the numeric type that is most appropriate.\n", "summary" : "
     Cast the xs:anyAtomicType to a numeric type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The parameter can be a number, string, boolean value.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The casted value." }, "errors" : [ "excel-err:Value if the value cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "ceiling", "qname" : "excel:ceiling", "signature" : "($number as xs:anyAtomicType, $significance as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Returns number rounded up, away from zero, to the nearest multiple of significance.\n Significance must have the same sign as number.\n Number and significance must be of a numeric type or castable to numeric.\n Significance must not be zero.\n", "summary" : "
     Returns number rounded up, away from zero, to the nearest multiple of significance.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value you want to round.
    " }, { "name" : "significance", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The multiple to which you want to round.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The rounded value." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type.", "excel-err:Num if significance is zero or it doesn't have the same sign as number." ] }, { "isDocumented" : true, "arity" : 1, "name" : "degrees", "qname" : "excel:degrees", "signature" : "($radian as xs:double) as xs:integer", "description" : " Converts radians into degrees.\n", "summary" : "
     Converts radians into degrees.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "radian", "type" : "xs:double", "occurrence" : null, "description" : "
     The value in radians.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The value in degrees 0 .. 360 or 0 .. -360." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "even", "qname" : "excel:even", "signature" : "($number as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Returns number rounded up to the nearest even integer.\n Regardless of the sign of number, a value is rounded up when adjusted away from zero.\n", "summary" : "
     Returns number rounded up to the nearest even integer.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value to round.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The rounded value casted as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "fact", "qname" : "excel:fact", "signature" : "($number as xs:anyAtomicType) as xs:integer", "description" : " Returns the factorial of a number.\n", "summary" : "
     Returns the factorial of a number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The nonnegative number you want the factorial of. If number is not an integer, it is truncated.
    " } ], "returns" : { "type" : "xs:integer", "description" : "Returns the factorial of a number. The factorial of a number is equal to 1*2*3*...* number." }, "errors" : [ "excel-err:Num if the number is smaller than zero" ] }, { "isDocumented" : true, "arity" : 1, "name" : "factdouble", "qname" : "excel:factdouble", "signature" : "($number as xs:integer) as xs:integer", "description" : " Returns the double factorial of a number.\n Computes the double factorial of n as n(n-2)(n-4)...\n", "summary" : "
     Returns the double factorial of a number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:integer", "occurrence" : null, "description" : "
     The positive integer value.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The result as integer." }, "errors" : [ "excel-err:Num if the number is negative." ] }, { "isDocumented" : true, "arity" : 2, "name" : "floor", "qname" : "excel:floor", "signature" : "($number as xs:anyAtomicType, $significance as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Rounds number down, toward zero, to the nearest multiple of significance.\n Significance must have the same sign as number.\n", "summary" : "
     Rounds number down, toward zero, to the nearest multiple of significance.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value you want to round. The value is casted to numeric.
    " }, { "name" : "significance", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The multiple to which you want to round.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The rounded value as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type.", "excel-err:Num if significance is zero or it doesn't have the same sign as number." ] }, { "isDocumented" : true, "arity" : 1, "name" : "gcd", "qname" : "excel:gcd", "signature" : "($numbers as xs:integer+) as xs:integer", "description" : " Returns the greatest common divisor GCD of a sequence of integers.\n The sequence can have one or more positive integers.\n", "summary" : "
     Returns the greatest common divisor GCD of a sequence of integers.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:integer", "occurrence" : "+", "description" : "
     The sequence of positive integers.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The GCD as integer." }, "errors" : [ "excel-err:Num if any number is smaller than zero." ] }, { "isDocumented" : true, "arity" : 1, "name" : "int", "qname" : "excel:int", "signature" : "($number as xs:anyAtomicType) as xs:integer", "description" : " Rounds a number down to the nearest integer.\n Positive numbers are rounded toward zero, negative numbers are rounded away from zero.\n", "summary" : "
     Rounds a number down to the nearest integer.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value to be rounded.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The rounded integer." }, "errors" : [ "excel-err:Value if parameter cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-a-number", "qname" : "excel:is-a-number", "signature" : "($value as xs:anyAtomicType) as xs:boolean", "description" : " Checks if the xs:anyAtomicType argument is actually a numeric type\n or can be converted to numeric.\n", "summary" : "
     Checks if the xs:anyAtomicType argument is actually a numeric type\n or can be converted to numeric.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     Parameter to be checked.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the value can be casted to numeric." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "lcm", "qname" : "excel:lcm", "signature" : "($numbers as xs:integer+) as xs:integer", "description" : " Returns the least common multiple of integers.
    \n LCM for two numbers is computed by multiplying them and dividing with GCD. 
    \n The function is applied recursively replacing the first two numbers in the sequence with their LCM.\n", "summary" : "
     Returns the least common multiple of integers.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:integer", "occurrence" : "+", "description" : "
     The sequence of one or more positive integers.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The LCM as integer." }, "errors" : [ "excel-err:Num if any number is smaller than zero." ] }, { "isDocumented" : true, "arity" : 2, "name" : "mod", "qname" : "excel:mod", "signature" : "($number as xs:anyAtomicType, $divisor as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Returns the remainder after number is divided by divisor.\n The result has the same sign as divisor.\n", "summary" : "
     Returns the remainder after number is divided by divisor.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The number for which you want to find the remainder.
    " }, { "name" : "divisor", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The number by which you want to divide number. This cannot be zero.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The remainder from division as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type.", "excel-err:Div0 if divisor is zero after casting to numeric." ] }, { "isDocumented" : true, "arity" : 2, "name" : "mround", "qname" : "excel:mround", "signature" : "($number as xs:anyAtomicType, $multiple as xs:anyAtomicType) as xs:anyAtomicType", "description" : " Returns a number rounded to the desired multiple.\n MROUND rounds up, away from zero, if the remainder of dividing number by multiple\n is greater than or equal to half the value of multiple.\n MROUND is computed through floor function.\n", "summary" : "
     Returns a number rounded to the desired multiple.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value to round, castable to numeric type.
    " }, { "name" : "multiple", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The multiple to which you want to round number.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The rounded number up to the desired multiple." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "odd", "qname" : "excel:odd", "signature" : "($number as xs:anyAtomicType) as xs:integer", "description" : " Returns number rounded up to the nearest odd integer, away from zero.\n", "summary" : "
     Returns number rounded up to the nearest odd integer, away from zero.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value to round.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The odd integer." }, "errors" : [ "excel-err:Value if parameter cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 0, "name" : "pi", "qname" : "excel:pi", "signature" : "() as xs:decimal", "description" : " Return the value of PI as decimal with 15 digits.\n", "summary" : "
     Return the value of PI as decimal with 15 digits.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:decimal", "description" : "The value of PI with 15 digits." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "power", "qname" : "excel:power", "signature" : "($number as xs:anyAtomicType, $power as xs:integer) as xs:anyAtomicType", "description" : " Returns the result of a number raised to a power.\n The result is computed through successive multiplications.\n", "summary" : "
     Returns the result of a number raised to a power.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The base number.
    " }, { "name" : "power", "type" : "xs:integer", "occurrence" : null, "description" : "
     The exponent as integer (cannot be floating point like in Excel).
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The result as numeric type." }, "errors" : [ "excel-err:Value if parameter cannot be casted to numeric type.", "excel-err:Value if power is smaller than zero." ] }, { "isDocumented" : true, "arity" : 1, "name" : "product", "qname" : "excel:product", "signature" : "($numbers as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies all the numbers given as arguments and returns the product.\n", "summary" : "
     Multiplies all the numbers given as arguments and returns the product.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The sequence of arguments convertable to numeric types. The sequence can be of any length.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The multiplication result as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "quotient", "qname" : "excel:quotient", "signature" : "($numerator as xs:anyAtomicType, $denominator as xs:anyAtomicType) as xs:integer", "description" : " Returns the integer portion of a division.\n", "summary" : "
     Returns the integer portion of a division.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numerator", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The divident.
    " }, { "name" : "denominator", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The divisor. It cannot be zero.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The result value as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type.", "excel-err:Div0 if denominator casted as numeric type has value zero." ] }, { "isDocumented" : true, "arity" : 1, "name" : "radians", "qname" : "excel:radians", "signature" : "($degree as xs:integer) as xs:decimal", "description" : " Converts degrees to radians.\n", "summary" : "
     Converts degrees to radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "degree", "type" : "xs:integer", "occurrence" : null, "description" : "
     An angle in degrees that you want to convert.
    " } ], "returns" : { "type" : "xs:decimal", "description" : "The value in radians." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "roman", "qname" : "excel:roman", "signature" : "($number as xs:integer) as xs:string", "description" : " Converts an arabic numeral to roman, as text.\n Only the clasic format is supported (out of all formats Excel requires).
    \n M is the largest digit, it represents 1000.\n Numbers bigger than 2000 will be represented by a sequence of \"M\".
    \n D = 500, C = 100, L = 50, X = 10, V = 5, I = 1.\n", "summary" : "
     Converts an arabic numeral to roman, as text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:integer", "occurrence" : null, "description" : "
     A positive integer.
    " } ], "returns" : { "type" : "xs:string", "description" : "The roman string representation." }, "errors" : [ "excel-err:Num if the input integer is negative" ] }, { "isDocumented" : true, "arity" : 2, "name" : "round", "qname" : "excel:round", "signature" : "($number as xs:anyAtomicType, $precision as xs:integer) as xs:anyAtomicType", "description" : " Rounds a number to a specified number of digits.\n If precision is greater than 0 (zero), then number is rounded\n to the specified number of decimal places.\n If num_digits is 0, then number is rounded to the nearest integer.\n If num_digits is less than 0, then number is rounded to the left of the decimal point.\n The 0.5 is rounded away from zero.\n", "summary" : "
     Rounds a number to a specified number of digits.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The number to round, castable to a numeric type.
    " }, { "name" : "precision", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of decimal places to keep.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The rounded number as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "rounddown", "qname" : "excel:rounddown", "signature" : "($number as xs:anyAtomicType, $precision as xs:integer) as xs:anyAtomicType", "description" : " Rounds a number down, toward zero.\n If num_digits is greater than 0 (zero), then number is rounded down\n to the specified number of decimal places.\n If num_digits is 0, then number is rounded down to the nearest integer.\n If num_digits is less than 0, then number is rounded down to the left of the decimal point.\n", "summary" : "
     Rounds a number down, toward zero.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The number to round, castable to numeric type.
    " }, { "name" : "precision", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of decimal places to keep.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the truncated number toward zero, as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "roundup", "qname" : "excel:roundup", "signature" : "($number as xs:anyAtomicType, $precision as xs:integer) as xs:anyAtomicType", "description" : " Rounds a number up, away from 0 (zero).\n If num_digits is greater than 0 (zero), then number is rounded down\n to the specified number of decimal places.\n If num_digits is 0, then number is rounded down to the nearest integer.\n If num_digits is less than 0, then number is rounded down to the left of the decimal point.\n", "summary" : "
     Rounds a number up, away from 0 (zero).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The number to round, castable to numeric type.
    " }, { "name" : "precision", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of decimal places to keep.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The truncated number away from zero, as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "sign", "qname" : "excel:sign", "signature" : "($number as xs:anyAtomicType) as xs:integer", "description" : " Determines the sign of a number.\n Returns 1 if the number is positive, zero (0) if the number is 0,\n and -1 if the number is negative.\n", "summary" : "
     Determines the sign of a number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The argument castable to numeric type.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The sign as (-1, 0, 1)." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "sort-numbers", "qname" : "excel:sort-numbers", "signature" : "($numbers as xs:anyAtomicType*) as xs:anyAtomicType*", "description" : " Helper function.
    \n Sorts a sequence of numbers or arguments castable to numeric.\n It first casts all arguments to numeric and then sorts ascending.\n", "summary" : "
     Helper function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The sequence of arguments castable to numeric.
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "The sorted sequence as numeric types." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "sum", "qname" : "excel:sum", "signature" : "($numbers as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Adds all the numbers in the sequence.\n", "summary" : "
     Adds all the numbers in the sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The sequence of arguments castable to numeric types. The sequence can be of any length.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The sum as numeric type." }, "errors" : [ "excel-err:Value if parameters cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 1, "name" : "trunc", "qname" : "excel:trunc", "signature" : "($number as xs:anyAtomicType) as xs:integer", "description" : " Truncates a number to an integer by removing the fractional part of the number.\n", "summary" : "
     Truncates a number to an integer by removing the fractional part of the number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The argument castable to numeric type.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The integer value." }, "errors" : [ "excel-err:Value if parameter cannot be casted to numeric type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "trunc", "qname" : "excel:trunc", "signature" : "($number as xs:anyAtomicType, $precision as xs:integer) as xs:anyAtomicType", "description" : " Truncates a number down to precision.\n This behaves exactly like rounddown.\n", "summary" : "
     Truncates a number down to precision.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The argument castable to numeric type.
    " }, { "name" : "precision", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of decimal places to keep .
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The integer value." }, "errors" : [ "excel-err:Value if parameter cannot be casted to numeric type." ] } ], "variables" : [  ] }, "http://api.28.io/browserview" : { "ns" : "http://api.28.io/browserview", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/browserview", "prefix" : "browserview" }, { "uri" : "http://api.28.io/model", "prefix" : "model" }, { "uri" : "http://zorba.io/modules/reference", "prefix" : "ref" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "node-path", "qname" : "browserview:node-path", "signature" : "($node)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "node-reference", "qname" : "browserview:node-reference", "signature" : "($node, $short as xs:boolean)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "short", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "serialize", "qname" : "browserview:serialize", "signature" : "($json)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "json", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "serializeMulti", "qname" : "browserview:serializeMulti", "signature" : "($json)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "json", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "show-namespaces", "qname" : "browserview:show-namespaces", "signature" : "($namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "show-node", "qname" : "browserview:show-node", "signature" : "($node, $namespaces, $short as xs:boolean)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "short", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "show-nodes", "qname" : "browserview:show-nodes", "signature" : "($nodes)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/json-csv" : { "ns" : "http://zorba.io/modules/json-csv", "description" : " This module provides an API for parsing and serializing CSV (comma-separated\n values) files.\n See RFC 4180,\n \"Common Format and MIME Type for Comma-Separated Values (CSV) Files.\"\n", "sees" : [  ], "authors" : [ "Paul J. Lucas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/json-csv", "prefix" : "csv" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "parse", "qname" : "csv:parse", "signature" : "($csv as string) as object()*", "description" : " Parses a CSV (comma-separated values) string using the default options.\n A newline (U+000A), optionally preceeded by a carriage-return (U+000D),\n terminates lines, aka, \"records.\"\n 
    \n Quoted values are always considered strings;\n unquoted values are attempted to be cast to other types, e.g., integer\n (unless the cast-unquoted-values option is false).\n Casting is attempted in the following order:\n integer, decimal, double, and boolean.\n If casting fails, the value is considered a string.\n Header field names are always considered strings even if unquoted.\n 
    \n In addition to the \"normal\" values of\n true and false for boolean,\n T and Y are also considered \"true\"\n and F and N are also considered \"false.\"\n 
    \n The default options are:\n  
    \n    
    cast-unquoted-values
    \n      
    \n        Whether to attempt to cast unquoted values to\n        integer, decimal, double, or boolean;\n        default: true.\n      
    \n    
    extra-name
    \n      
    \n        The field name for extra values, if any;\n        default: none (error csv:EXTRA_VALUE is raised).\n      
    \n    
    field-names
    \n      
    \n        A JSON array of strings denoting field names;\n        default: none.\n        The first CSV line is assumed to be a header line\n        and the field names are taken from this line.\n      
    \n    
    missing-value
    \n      
    \n        What should happen when a missing value is detected;\n        default: \"null\".\n        A \"missing\" value is one of:\n        
      \n          
    • Two consecutive quote-char characters.
      • \n          
    • A quote-char character as either the first\n              or last character on a line.
      • \n          
    • Fewer values than the number of field names.
      • \n        
    \n        When a missing value is detected,\n        the value is set to null.\n      
    \n    
    quote-char
    \n      
    \n        The single ASCII character that may be used to quote values;\n        default: \" (U+0022).\n      
    \n    
    quote-escape
    \n      
    \n        The single ASCII character used to escape quote-char;\n        default: same as quote-char.\n        This means that an escaped quote is doubled as \"\".\n      
    \n    
    separator
    \n      
    \n        The single ASCII character used to separate values;\n        default: , (U+002C).\n      
    \n  
    \n", "summary" : "
     Parses a CSV (comma-separated values) string using the default options.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "csv", "type" : "string", "occurrence" : null, "description" : "
     The CSV string to parse.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of zero or more JSON objects where each key is a field name and each value is a parsed value." }, "errors" : [ "csv:EXTRA_VALUE if an extra value is detected." ] }, { "isDocumented" : true, "arity" : 2, "name" : "parse", "qname" : "csv:parse", "signature" : "($csv as string, $options as object()) as object()* external", "description" : " Parses a CSV (comma-separated values) string using the given options.\n A newline (U+000A), optionally preceeded by a carriage-return (U+000D),\n terminates lines, aka, \"records.\"\n 
    \n Quoted values are always considered strings;\n unquoted values are attempted to be cast to other types, e.g., integer\n (unless the cast-unquoted-values option is false).\n Casting is attempted in the following order:\n integer, decimal, double, and boolean.\n If casting fails, the value is considered a string.\n Header field names are always considered strings even if unquoted.\n 
    \n In addition to the \"normal\" values of\n true and false for boolean,\n T and Y are also considered \"true\"\n and F and N are also considered \"false.\"\n", "summary" : "
     Parses a CSV (comma-separated values) string using the given options.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "csv", "type" : "string", "occurrence" : null, "description" : "
     The CSV string to parse.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The options to use: 
     
    cast-unquoted-values
     
     Whether to attempt to cast unquoted values to integer, decimal, double, or boolean; default: true. 
     
    extra-name
     
     The field name for extra values, if any; default: none (error csv:EXTRA_VALUE is raised). If this option is given and a line contains one or more extra values (that is, values that have no corresponding field names), then the extra values are assigned as the values for fields having extra-name as their names. 
     If extra-name contains a # (U+0023), then the # is substituted with the field number (where field numbers start at 1). If extra-name does not contains a #, then the field number is appended. 
     
    field-names
     
     A JSON array of strings denoting field names; default: none. If this option is given, then the first CSV line is assumed not to be a header line; if omitted, then the first CSV line is assumed to be a header line and the field names are taken from this line. 
     
    missing-value
     
     What should happen when a missing value is detected; default: \"null\". A \"missing\" value is one of: 
       
    • Two consecutive separator characters.
      •  
    • A separator character as either the first or last character on a line.
      •  
    • Fewer values than the number of field names.
      •  
     When a missing value is detected, the value of this option determines what happens: 
     
    \"error\"
     
    Error csv:MISSING_VALUE is raised.
     
    \"omit\"
     
    Both the value and its key are omitted from the result object.
     
    \"null\"
     
    The value is set to null.
     
     
     
    quote-char
     
     The single ASCII character that may be used to quote values; default: \" (U+0022). 
     
    quote-escape
     
     The single ASCII character used to escape quote-char; default: same as quote-char. If quote-escape equals quote-char, it means that quote-char must be doubled to escape it. If quote-escape does not equal quote-char, it means that quote-escape is used to escape quote-char. For example, a quote-char of \" (U+0022) and a quote-escape of \\ (U+005C) means that quotes will be escaped by \\\". 
     
    separator
     
     The single ASCII character used to separate values; default: , (U+002C). 
     
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of zero or more JSON objects where each key is a field name and each value is a parsed value." }, "errors" : [ "csv:INVALID_OPTION if the quote-char, quote-escape, or separator option is given and it's not a single ASCII character.", "csv:MISSING_VALUE if a missing value is detected and the missing-value option is \"error\".", "csv:EXTRA_VALUE if an extra value is detected and the extra-name option is not set." ] }, { "isDocumented" : true, "arity" : 1, "name" : "serialize", "qname" : "csv:serialize", "signature" : "($obj as object()*) as string*", "description" : " Serializes a sequence of JSON objects as CSV (comma-separated values) using\n the default options.\n The default options are:\n  
    \n    
    field-names
    \n      
    \n        A JSON array of strings denoting field names;\n        default: none.\n        The field names are taken from the first JSON object\n        and the order of the fields is implementation dependent.\n      
    \n    
    serialize-boolean-as
    \n      
    \n        What strings to serialize true and false as;\n        default: true and false.\n      
    \n    
    serialize-header
    \n      
    \n        Whether a header line is included;\n        default: true.\n        The first string result is the header line\n        comprised of all the objects' keys' names.\n      
    \n    
    serialize-null-as
    \n      
    \n        What string to serialize JSON null values as;\n        default: null.\n      
    \n    
    quote-char
    \n      
    \n        The single ASCII character that may be used to quote values;\n        default: \" (U+0022).\n      
    \n    
    quote-escape
    \n      
    \n        The single ASCII character used to escape quote-char;\n        default: same as quote-char.\n        This means that quote-char is doubled to escape it.\n      
    \n    
    separator
    \n      
    \n        The single ASCII character used to separate values;\n        default: , (U+002C).\n      
    \n  
    \n", "summary" : "
     Serializes a sequence of JSON objects as CSV (comma-separated values) using\n the default options.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "obj", "type" : "object()", "occurrence" : "*", "description" : "
     The sequence of JSON objects to serialize.
    " } ], "returns" : { "type" : "string*", "description" : "a sequence of strings where each string corresponds to a JSON object, aka, \"record.\"" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "serialize", "qname" : "csv:serialize", "signature" : "($obj as object()*, $options as object()) as string* external", "description" : " Serializes a sequence of JSON objects as CSV (comma-separated values) using\n the given options.\n", "summary" : "
     Serializes a sequence of JSON objects as CSV (comma-separated values) using\n the given options.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "obj", "type" : "object()", "occurrence" : "*", "description" : "
     The sequence of JSON objects to serialize.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The options to use: 
     
    field-names
     
     A JSON array of strings denoting field names; default: none. If this option is not set, the field names are taken from the first JSON object and the order of the fields is implementation dependent. If this option is set, the fields are serielized in the order they are in the array. In either case, every JSON object must have the same keys as the first object. 
     
    serialize-boolean-as
     
     What strings to serialize true and false as; default: true and false. This must be a sub-object with the two keys \"true\" and \"false\", e.g.: { \"true\" : \"Y\", \"false\" : \"N\" }. 
     
    serialize-header
     
     Whether a header line is included; default: true. If true, the first string result is the header line comprised of all the objects' keys' names; if false, the heder line is not returned. 
     
    serialize-null-as
     
     What string to serialize JSON null values as; default: null. 
     
    quote-char
     
     The single ASCII character that may be used to quote values; default: \" (U+0022). 
     
    quote-escape
     
     The single ASCII character used to escape quote-char; default: same as quote-char. If quote-escape equals quote-char, it means that quote-char must be doubled to escape it. If quote-escape does not equal quote-char, it means that quote-escape is used to escape quote-char. For example, a quote-char of \" (U+0022) and a quote-escape of \\ (U+005C) means that quotes will be escaped by \\\". 
     
    separator
     
     The single ASCII character used to separate values; default: , (U+002C). 
     
    " } ], "returns" : { "type" : "string*", "description" : "a sequence of strings where each string corresponds to a JSON object, aka, \"record.\"" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/email/imap" : { "ns" : "http://www.zorba-xquery.com/modules/email/imap", "description" : " This module provides functions for accessing and manipulating emails on mail\n servers through the IMAP protocol.\n All functions in this module receive as the first argument the IMAP host and user\n information. This is an element with the type hostInfoType as defined\n in the email schema: http://www.zorba-xquery.com/modules/email.\n For example:\n 
    \n <email:hostInfo>\n   <email:hostName>imap.example.com</email:hostName>\n   <email:userName>myuser</email:userName>\n   <email:password>mypassword</email:password>\n </email:hostInfo>\n 
    \n The hostInfoType only needs to be in the email schema namespace\n (http://www.zorba-xquery.com/modules/email). It does not need\n to be validated since it's validated by the module.\n", "sees" : [ "c-client library part of UW IMAP toolkit" ], "authors" : [ "Daniel Thomas, Gabriel Petrovay" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.zorba-xquery.com/modules/email", "prefix" : "email" }, { "uri" : "http://www.zorba-xquery.com/modules/email/imap", "prefix" : "imap" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 5, "name" : "copy", "qname" : "imap:copy", "signature" : "($host-info as element(email:hostInfo), $mailbox-from as xs:string, $mailbox-to as xs:string, $messages as xs:long+, $uid as xs:boolean?) as empty-sequence()", "description" : " Copies messages between mailboxes.\n Depending on the value of $uid, the messages are either specified\n through their sequence number or through their unique id. Both mailboxes must exist.\n", "summary" : "
     Copies messages between mailboxes.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox-from", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox in which the messages reside.
    " }, { "name" : "mailbox-to", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox in to which the messages are copied.
    " }, { "name" : "messages", "type" : "xs:long", "occurrence" : "+", "description" : "
     The messages to be copied, specified either by their sequence number or their unique id.
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     If true, $messages are treated as sequence numbers. Else as unique identifiers.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 2, "name" : "create", "qname" : "imap:create", "signature" : "($host-info as element(email:hostInfo), $mailbox-name as xs:string) as empty-sequence()", "description" : " Creates a new mailbox for the given user.\n", "summary" : "
     Creates a new mailbox for the given user.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox-name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name for the new mailbox.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete", "qname" : "imap:delete", "signature" : "($host-info as element(email:hostInfo), $mailbox-name as xs:string) as empty-sequence()", "description" : " Deletes a mailbox for the given user.\n", "summary" : "
     Deletes a mailbox for the given user.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox-name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the mailbox to delete.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 2, "name" : "expunge", "qname" : "imap:expunge", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string) as empty-sequence()", "description" : " Permanently deletes all messages of the given mailbox that have the \"deleted\" flag set.\n", "summary" : "
     Permanently deletes all messages of the given mailbox that have the \"deleted\" flag set.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox for which all messages that have the \\Deleted flag set should be permanently deleted.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 4, "name" : "fetch-envelope", "qname" : "imap:fetch-envelope", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long, $uid as xs:boolean?) as element(email:envelope)", "description" : " Fetches the envelope of a message.\n", "summary" : "
     Fetches the envelope of a message.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox in which to search for the message.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     The message for which to fetch the envelope (depending on $uid either as message sequence number or unique identifier).
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     If true, $message-number is treated as sequence number. Else as unique identifier.
    " } ], "returns" : { "type" : "element(email:envelope)", "description" : "The envelope of the requested message. The result is validated against the schema: http://www.zorba-xquery.com/modules/email." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 4, "name" : "fetch-flags", "qname" : "imap:fetch-flags", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long, $uid as xs:boolean?) as element(email:flags)", "description" : " Fetches the flags of a message.\n", "summary" : "
     Fetches the flags of a message.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox containing the specified message.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     Either the message sequence number or the unique identifier of the message.
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     If true, $message-number is treated as sequence number. Else as unique identifier.
    " } ], "returns" : { "type" : "element(email:flags)", "description" : "The flags of the specified message. The result is validated against the schema: http://www.zorba-xquery.com/modules/email." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 3, "name" : "fetch-from", "qname" : "imap:fetch-from", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long) as xs:string", "description" : " Fetches the 'from' string of a message.\n Please note that this function only words with message sequence numbers,\n not with unique identifiers. Only the first 255 characters of a 'from'\n string are fetched.\n", "summary" : "
     Fetches the 'from' string of a message.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox for which we want to get the 'from' string of a message.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     Denotes the message for which we want the 'from' string.
    " } ], "returns" : { "type" : "xs:string", "description" : "The 'from' string of the specified message." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 3, "name" : "fetch-message-sequence-number", "qname" : "imap:fetch-message-sequence-number", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long) as xs:long", "description" : " Fetches the message sequence number for a given unique identifier.\n", "summary" : "
     Fetches the message sequence number for a given unique identifier.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox for which we want to get the message sequence number of an unique identifier.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     The unique identifier for which we want the message sequence number.
    " } ], "returns" : { "type" : "xs:long", "description" : "The message sequence number of the of the given unique identifier." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 4, "name" : "fetch-message", "qname" : "imap:fetch-message", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long, $uid as xs:boolean) as element(email:message)", "description" : " Fetches a whole message.\n", "summary" : "
     Fetches a whole message.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox in which to search for the message.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     The message to fetch, denoted either by its sequence number or unique identifier.
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If true, $message-number is treated as sequence number. Else as unique identifier.
    " } ], "returns" : { "type" : "element(email:message)", "description" : "the message with the given $message-number. The result is validated against the schema: http://www.zorba-xquery.com/modules/email." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 3, "name" : "fetch-subject", "qname" : "imap:fetch-subject", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long) as xs:string", "description" : " Fetches the subject for a message.\n Please note that this function only works with message sequence numbers,\n not with unique identifiers. Only the first 255 characters of a subject\n are fetched.\n", "summary" : "
     Fetches the subject for a message.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox for which we want to get the subject of a message.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     Denotes the message for which we want the subject.
    " } ], "returns" : { "type" : "xs:string", "description" : "The subject of the specified message." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 3, "name" : "fetch-uid", "qname" : "imap:fetch-uid", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long) as xs:long", "description" : " Fetches the unique identifier for a given message sequence number.\n", "summary" : "
     Fetches the unique identifier for a given message sequence number.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox for which we want to get the unique identifier of a message sequence number.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     The message sequence number for which we want the unique identifier.
    " } ], "returns" : { "type" : "xs:long", "description" : "The unique identifier of the given message sequence number." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 4, "name" : "list", "qname" : "imap:list", "signature" : "($host-info as element(email:hostInfo), $mailbox-ref as xs:string, $pattern as xs:string, $only-subscribed as xs:boolean) as element(email:mailbox)*", "description" : " Lists IMAP folders for the specified user on the host that match the pattern.\n", "summary" : "
     Lists IMAP folders for the specified user on the host that match the pattern.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox-ref", "type" : "xs:string", "occurrence" : null, "description" : "
     is applied to pattern in an implementation dependent fashion to search for matching mailbox names.
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     The pattern for mailboxes to look for (can include wildcards '*' and '%').
    " }, { "name" : "only-subscribed", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If set true, only mailboxes are listed to which the user is subscribed.
    " } ], "returns" : { "type" : "element(email:mailbox)*", "description" : "A sequence of mailbox elements. The result elements are validated against the schema: http://www.zorba-xquery.com/modules/email." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 5, "name" : "move", "qname" : "imap:move", "signature" : "($host-info as element(email:hostInfo), $mailbox-from as xs:string, $mailbox-to as xs:string, $messages as xs:long+, $uid as xs:boolean?) as empty-sequence()", "description" : " Moves messages between mailboxes.\n Depending on the value of $uid, the messages are either specified through\n their sequence number or through their unique id. Both mailboxes must exist.\n", "summary" : "
     Moves messages between mailboxes.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox-from", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox in which the messages reside.
    " }, { "name" : "mailbox-to", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox in to which the messages should be moved.
    " }, { "name" : "messages", "type" : "xs:long", "occurrence" : "+", "description" : "
     The messages to be copied, specified either by their sequence number or their unique id.
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     If true, $messages are treated as sequence numbers. Else as unique identifiers.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 3, "name" : "rename", "qname" : "imap:rename", "signature" : "($host-info as element(email:hostInfo), $mailbox-old as xs:string, $mailbox-new as xs:string) as empty-sequence()", "description" : " Renames a mailbox.\n", "summary" : "
     Renames a mailbox.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox-old", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the mailbox we want to rename.
    " }, { "name" : "mailbox-new", "type" : "xs:string", "occurrence" : null, "description" : "
     The new name for the mailbox.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 4, "name" : "search", "qname" : "imap:search", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $criteria as xs:string, $uid as xs:boolean?) as xs:long*", "description" : " Searches a mailbox for messages that match the given criteria.\n The criteria should be a string as defined in the RFC3501 (IMAP4rev1).\n A valid example would be: 'FROM zorba@gmail.com OR NOT SUBJECT Bug'.\n Depending on the value of $uid, the function will either\n return matching sequence numbers or unique identifiers.\n", "summary" : "
     Searches a mailbox for messages that match the given criteria.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox to search.
    " }, { "name" : "criteria", "type" : "xs:string", "occurrence" : null, "description" : "
     The searching criteria.
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     If true, the function returns the sequence of unique identifiers corresponding to the matching mails, else the corresponding sequence numbers are returned.
    " } ], "returns" : { "type" : "xs:long*", "description" : "Either the sequence of matching sequence numbers or the sequence of matching unique identifiers." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 5, "name" : "set-flags", "qname" : "imap:set-flags", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string, $message-number as xs:long, $flags as element(email:flags), $uid as xs:boolean?) as empty-sequence()", "description" : " Sets the flags for a given message.\n The flags are set and unset according to the passed $flags.\n", "summary" : "
     Sets the flags for a given message.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox containing the specified message.
    " }, { "name" : "message-number", "type" : "xs:long", "occurrence" : null, "description" : "
     Either the message sequence number or the unique identifier of the message (depending on the value of $uid).
    " }, { "name" : "flags", "type" : "element(email:flags)", "occurrence" : null, "description" : "
     Defines which flags should be set for this message. The possibilities are \"seen\", \"deleted\", \"flagged\", \"answered\", and \"draft\". Setting all flags at once is done by passing the element:  <email:flags> <email:seen/> <email:deleted/> <email:flagged/> <email:answered/> <email:draft/> </email:flags> . Setting \"flagged\" only and unsetting all other at once can be done by passing:  <email:flags> <email:flagged/> </email:flags> .
    " }, { "name" : "uid", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     If true, $message-number is treated as sequence number. Else as unique identifier.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "imap:IMAP0003 If no message is found with the provided sequence number/unique identifier.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 2, "name" : "status", "qname" : "imap:status", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string) as element(email:status)", "description" : " Returns the status of the given mailbox.\n The status of a mailbox contains:\n 
      \n  
    • messages: the number of messages in the mailbox
      • \n  
    • recent: the number of messages flagged as recent
      • \n  
    • unseen: the number of messages flagged as unseen
      • \n  
    • uidnext: the next unique identifier that will be assigned to a message
      • \n  
    • uidvalidity: a value that, together with the uidnext value\n    forms a 64 bit number that must be unique for the server
      • \n 
    \n", "summary" : "
     Returns the status of the given mailbox.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox for which we want to have the status.
    " } ], "returns" : { "type" : "element(email:status)", "description" : "The status of the specified $mailbox. The result is validated against the schema: http://www.zorba-xquery.com/modules/email." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 2, "name" : "subscribe", "qname" : "imap:subscribe", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string) as empty-sequence()", "description" : " Subscribes the user to the specified mailbox.\n", "summary" : "
     Subscribes the user to the specified mailbox.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox the user wants to subscribe to.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] }, { "isDocumented" : true, "arity" : 2, "name" : "unsubscribe", "qname" : "imap:unsubscribe", "signature" : "($host-info as element(email:hostInfo), $mailbox as xs:string) as empty-sequence()", "description" : " Unsubscribes the user from the specified mailbox.\n", "summary" : "
     Unsubscribes the user from the specified mailbox.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The IMAP host, user name, and password.
    " }, { "name" : "mailbox", "type" : "xs:string", "occurrence" : null, "description" : "
     The mailbox the user wants to unsubscribe from.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "imap:IMAP0001 If the IMAP operation failed.", "imap:IMAP0002 If the connection to the IMAP server is refused.", "err:XQDY0027 If the value of $host-info is not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] } ], "variables" : [  ] }, "http://zorba.io/errors" : { "ns" : "http://zorba.io/errors", "description" : " This module contains one variable declaration for each diagnostic of the\n http://zorba.io/errors namespace.\n The variables serves as documentation for the errors but can also\n be used in the code. For example, one useful scenario is to compare\n an error caught in the catch clause of a try-catch expression with one of\n the variables.\n", "sees" : [  ], "authors" : [ "Carlos Lopez" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [  ], "variables" : [ { "name" : "zerr:ZDST0032", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0021", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0022", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0023", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0024", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0025", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0026", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0027", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0028", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0029", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0030", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0031", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0033", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0034", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0035", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0036", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0041", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0044", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0048", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0060", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDTY0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDTY0010", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDTY0011", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDTY0012", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZGDB0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0038", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0024", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0025", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0026", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0027", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0028", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0029", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0030", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0031", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0032", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0033", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0034", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0035", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0036", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0037", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0039", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0040", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0041", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0042", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0043", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY1000", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY1001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY1003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY1004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY1005", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY1006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDST0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:XSST0010", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0066", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJPE0010", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJSE0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZJ2X0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0012", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZOSE0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0010", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0011", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0023", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0013", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0015", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0016", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0020", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0021", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0030", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0040", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0041", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0045", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0050", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0055", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0060", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZSTR0065", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQD0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0036", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0037", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0038", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0039", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0040", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0050", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0060", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0061", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP8401", "type" : "xs:QName", "description" : " The version of the thesaurus is not the expected version.\n" }, { "name" : "zerr:ZXQP8402", "type" : "xs:QName", "description" : " The thesaurus data file's endianness does not match that of the CPU.\n" }, { "name" : "zerr:ZXQP8403", "type" : "xs:QName", "description" : " The thesaurus data contains an unexpected value.\n" }, { "name" : "zerr:ZXQD0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQD0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQD0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0035", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQD0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQD0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0011", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0014", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0015", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0019", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0014", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0000", "type" : "xs:QName", "description" : " An \"error\" constant for \"no error.\"\n" }, { "name" : "zerr:ZXQP0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0002", "type" : "xs:QName", "description" : " A Zorba programming assertion failed.  If this error occurs, it is a bug\n and should be reported.\n" }, { "name" : "zerr:ZXQP0003", "type" : "xs:QName", "description" : " Something unexpected occurred in Zorba.  If this error occurs, it is a\n bug and should be reported.\n" }, { "name" : "zerr:ZXQP0004", "type" : "xs:QName", "description" : " A particular XQuery feature has not been implemented by Zorba.\n" }, { "name" : "zerr:ZXQP0005", "type" : "xs:QName", "description" : " A particular XQuery feature has been implemented by Zorba, but the\n feature has not been enabled in the current build.\n" }, { "name" : "zerr:ZXQP0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0010", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0011", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0012", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0013", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0020", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0016", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0017", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0020", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0021", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0024", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0025", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0026", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0028", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0029", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0030", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0031", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0032", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZXQP0033", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0012", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0013", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0014", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0015", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0016", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0017", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0011", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0010", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0011", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0012", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0013", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0014", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0015", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0016", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0017", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0018", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0020", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0019", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0021", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZDDY0022", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0045", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0021", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0023", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0024", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0025", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0026", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0027", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0028", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0029", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0030", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0039", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0040", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0041", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0042", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0043", "type" : "item()*", "description" : "" }, { "name" : "zerr:NS", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0070", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0080", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZAPI0090", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0001", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0002", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0003", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0004", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0005", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0006", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0007", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0008", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0009", "type" : "item()*", "description" : "" }, { "name" : "zerr:ZCSE0010", "type" : "item()*", "description" : "" } ] }, "http://zorba.io/modules/sequence" : { "ns" : "http://zorba.io/modules/sequence", "description" : " This module provides an XQuery API to perform set operations on sequences.\n", "sees" : [  ], "authors" : [ "Paul J. Lucas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/sequence", "prefix" : "seq" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "value-except", "qname" : "seq:value-except", "signature" : "($seq1 as xs:anyAtomicType*, $seq2 as xs:anyAtomicType*) as xs:anyAtomicType* external", "description" : " Filters the first sequence of atomic items such that they are not in the\n second sequence based on their values.\n", "summary" : "
     Filters the first sequence of atomic items such that they are not in the\n second sequence based on their values.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The first sequence.
    " }, { "name" : "seq2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The second sequence.
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "a sequence only containing items from $seq1 that are not in $seq2." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "value-intersect", "qname" : "seq:value-intersect", "signature" : "($seq1 as xs:anyAtomicType*, $seq2 as xs:anyAtomicType*) as xs:anyAtomicType* external", "description" : " Performs a set intersection of two sequences of atomic items based on their\n values.\n", "summary" : "
     Performs a set intersection of two sequences of atomic items based on their\n values.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The first sequence.
    " }, { "name" : "seq2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The second sequence.
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "a sequence containing only items from $seq1 that are also in $seq2." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "value-union", "qname" : "seq:value-union", "signature" : "($seq1 as xs:anyAtomicType*, $seq2 as xs:anyAtomicType*) as xs:anyAtomicType* external", "description" : " Performs a set union of two sequences of atomic items based on their values.\n", "summary" : "
     Performs a set union of two sequences of atomic items based on their values.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The first sequence.
    " }, { "name" : "seq2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The second sequence.
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "a sequence containing all items from $seq1 and seq2$ but without duplicates." }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/functions" : { "ns" : "http://api.28.io/functions", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/functions", "prefix" : "functions" }, { "uri" : "http://api.28.io/model", "prefix" : "model" }, { "uri" : "http://www.zorba-xquery.com/schemas/pul", "prefix" : "pul" }, { "uri" : "http://zorba.io/modules/reference", "prefix" : "ref" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "response" }, { "uri" : "http://api.28.io/sandbox", "prefix" : "sandbox" }, { "uri" : "http://www.zorba-xquery.com/schemas/xdm", "prefix" : "xdm" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "apply-pul", "qname" : "functions:apply-pul", "signature" : "($pul)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "pul", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "collections", "qname" : "functions:collections", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "decodeURI", "qname" : "functions:decodeURI", "signature" : "($str as xs:string) as xs:anyURI", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "str", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:anyURI", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "encode-for-js", "qname" : "functions:encode-for-js", "signature" : "($str as xs:string) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "str", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 5, "name" : "entries", "qname" : "functions:entries", "signature" : "($collection as xs:string?, $node as xs:anyURI?, $index as xs:string?, $value as xs:string?, $format as xs:string)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "node", "type" : "xs:anyURI", "occurrence" : "?", "description" : "" }, { "name" : "index", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "value", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "format", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "indexes", "qname" : "functions:indexes", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "key", "qname" : "functions:key", "signature" : "($collection as xs:string, $condition as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "condition", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "namesearch", "qname" : "functions:namesearch", "signature" : "($collection as xs:string, $path as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "node-to-js", "qname" : "functions:node-to-js", "signature" : "($node) as xs:string*", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "parse-namespaces", "qname" : "functions:parse-namespaces", "signature" : "($namespaces as xs:string)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "namespaces", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "pksearch", "qname" : "functions:pksearch", "signature" : "($collection as xs:string)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "startpage", "qname" : "functions:startpage", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "strip-whitespaces", "qname" : "functions:strip-whitespaces", "signature" : "($xml)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "tuple", "qname" : "functions:tuple", "signature" : "($collection as xs:string, $condition as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "condition", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "valuesearch", "qname" : "functions:valuesearch", "signature" : "($collection as xs:string, $path as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "xmltojs", "qname" : "functions:xmltojs", "signature" : "($content)", "description" : " Internal function. Converts the XML contents of a POST BODY to JavaScript calls that rebuild the given XML for the collection browser frontend\n", "summary" : "
     Internal function.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "content", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "JavaScript calls for collection browser frontend" }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/profiles/sec/companies" : { "ns" : "http://xbrl.io/modules/bizql/profiles/sec/companies", "description" : " 
    This module provides functionality for querying companies (XBRL entities)\n  submitting to the SEC.
    \n 
    SEC Companies are nothing else than XBRL entities. For XBRL-generic requests on\n entities, use the generic entities module.
    \n 
    With this module, you can retrieve a company with its CIK (without converting\n it to an EID). You can also retrieve companies by sector, by SIC code, by types,\n by tags, by tickers.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/companies", "prefix" : "companies" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "mongo" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/core", "prefix" : "sec" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "companies-by-types", "qname" : "companies:companies-by-types", "signature" : "($company-types as string*) as object()*", "description" : " 
    Retrieves all companies whose company type matches the passed string(s).
    \n", "summary" : "
      Retrieves all companies whose company type matches the passed string(s).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "company-types", "type" : "string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all companies with matching company type." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "companies-for-SIC", "qname" : "companies:companies-for-SIC", "signature" : "($sic-codes as string*) as object()*", "description" : " 
    Retrieves all companies whose type of business\n matches the SIC (Standard Industrial Classification) code.
    \n", "summary" : "
      Retrieves all companies whose type of business\n matches the SIC (Standard Industrial Classification) code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sic-codes", "type" : "string", "occurrence" : "*", "description" : "
     a sequence of SIC codes.
    " } ], "returns" : { "type" : "object()*", "description" : "all companies with one of these SIC codes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "companies-for-sector", "qname" : "companies:companies-for-sector", "signature" : "($sectors as string*) as object()*", "description" : " 
    Retrieves all companies in the given sectors.
    \n", "summary" : "
      Retrieves all companies in the given sectors.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sectors", "type" : "string", "occurrence" : "*", "description" : "
     a sequence of sectors as strings.
    " } ], "returns" : { "type" : "object()*", "description" : "all companies in these sectors." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "companies-for-tags", "qname" : "companies:companies-for-tags", "signature" : "($tags as string*) as object()*", "description" : " 
    Return all companies with any of the given tags.
    \n", "summary" : "
      Return all companies with any of the given tags.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "tags", "type" : "string", "occurrence" : "*", "description" : "
     the tags to filter.
    " } ], "returns" : { "type" : "object()*", "description" : "all companies with the given tags." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "companies-for-tickers", "qname" : "companies:companies-for-tickers", "signature" : "($tickers as string*) as object()*", "description" : " 
    Return all companies with any of the given ticker symbols.
    \n 
    Tickers are case insensitive
    \n", "summary" : "
      Return all companies with any of the given ticker symbols.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "tickers", "type" : "string", "occurrence" : "*", "description" : "
     the tickers to filter.
    " } ], "returns" : { "type" : "object()*", "description" : "all companies with the given tickers." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "companies", "qname" : "companies:companies", "signature" : "() as object()*", "description" : " 
    Return all companies
    \n", "summary" : "
      Return all companies \n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "all companies." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "companies", "qname" : "companies:companies", "signature" : "($companies-or-ids as item()*) as object()*", "description" : " 
    Return the companies with the given identifiers.
    \n", "summary" : "
      Return the companies with the given identifiers.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "companies-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the ids of the companies or the companies themselves.
    " } ], "returns" : { "type" : "object()*", "description" : "the companies with the given identifiers the empty sequence if no company was found or if the input is an empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "company-type", "qname" : "companies:company-type", "signature" : "($company-name as string) as string", "description" : " 
    Return company type for a given company name. Company type can be one of:
    \n 
    \n   
      \n     
    • Corporation
      • \n     
    • Partnership
      • \n     
    • unknown
      • \n   
    \n 
    \n", "summary" : "
      Return company type for a given company name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "company-name", "type" : "string", "occurrence" : null, "description" : "
     the name of a company
    " } ], "returns" : { "type" : "string", "description" : "the company type string or \"unknown\" if the type can not be inferred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "eid", "qname" : "companies:eid", "signature" : "($companies-or-eids-or-ciks as item()*) as string*", "description" : " 
    Converts the input to a normalized CIK. The input\n can be either a pure CIK without scheme, or an already\n normalized CIK, or an entity object which contains a CIK\n in its id field.
    \n", "summary" : "
      Converts the input to a normalized CIK.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "companies-or-eids-or-ciks", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "string*", "description" : "the normalized CIK." }, "errors" : [ "sec:INVALID_PARAMETER if the CIK or entity is not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "types", "qname" : "companies:types", "signature" : "($companies-or-ciks as item()*) as string*", "description" : " 
    Retrieves the type of a company.
    \n", "summary" : "
      Retrieves the type of a company.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "companies-or-ciks", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of companies or their identifiers (CIKs).
    " } ], "returns" : { "type" : "string*", "description" : "all company types." }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/collections" : { "ns" : "http://api.28.io/collections", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/collections", "prefix" : "cm" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "resp" }, { "uri" : "http://api.28.io/util", "prefix" : "util" }, { "uri" : "http://api.28.io/validation", "prefix" : "validate" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "definition-for-dynamic-collection", "qname" : "cm:definition-for-dynamic-collection", "signature" : "($name as xs:string) as object()", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "delete-collection-property", "qname" : "cm:delete-collection-property", "signature" : "($name as xs:string, $property as xs:string) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "property", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "delete-collection", "qname" : "cm:delete-collection", "signature" : "($name) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "dispatch", "qname" : "cm:dispatch", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "get-collection-property", "qname" : "cm:get-collection-property", "signature" : "($name as xs:string, $property as xs:string)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "property", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "get-collection", "qname" : "cm:get-collection", "signature" : "($name as xs:string) as object()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "get-or-create-collection-dynamic", "qname" : "cm:get-or-create-collection-dynamic", "signature" : "($name as xs:string) as object()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "list-collections", "qname" : "cm:list-collections", "signature" : "() as array()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "array()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "metadata", "qname" : "cm:metadata", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "put-collection-property", "qname" : "cm:put-collection-property", "signature" : "($name as xs:string, $property as xs:string, $value) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "property", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "value", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "put-collection", "qname" : "cm:put-collection", "signature" : "($name as xs:string, $collection as object()) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "collection", "type" : "object()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "validate-collection", "qname" : "cm:validate-collection", "signature" : "($collection as object()) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "object()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/excel/math-sumproduct" : { "ns" : "http://zorba.io/modules/excel/math-sumproduct", "description" : " Module implementing the sumproduct functions from Excel 2003 math library.\n There are 30 functions defined, implementing the same function\n but with 1 to 30 parameters.\n Each parameter can be a sequence of infinite length.\n", "sees" : [ "Excel 2003 Documentation: Math-sumproduct Functions" ], "authors" : [ "Daniel Turcanu" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/math-sumproduct", "prefix" : "excel" }, { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/math", "prefix" : "excel-math" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Sums the values in the sequence.\n The sequence can be of any length.\n", "summary" : "
     Sums the values in the sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 10, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 11, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 12, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 13, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 14, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 15, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 16, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 17, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 18, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 19, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 2, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 20, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 21, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 22, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 23, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 24, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 25, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*, $array25 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array25", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 26, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*, $array25 as xs:anyAtomicType*, $array26 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array25", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array26", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 27, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*, $array25 as xs:anyAtomicType*, $array26 as xs:anyAtomicType*, $array27 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array25", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array26", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array27", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 28, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*, $array25 as xs:anyAtomicType*, $array26 as xs:anyAtomicType*, $array27 as xs:anyAtomicType*, $array28 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array25", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array26", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array27", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array28", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 29, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*, $array25 as xs:anyAtomicType*, $array26 as xs:anyAtomicType*, $array27 as xs:anyAtomicType*, $array28 as xs:anyAtomicType*, $array29 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array25", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array26", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array27", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array28", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array29", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 3, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 30, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*, $array10 as xs:anyAtomicType*, $array11 as xs:anyAtomicType*, $array12 as xs:anyAtomicType*, $array13 as xs:anyAtomicType*, $array14 as xs:anyAtomicType*, $array15 as xs:anyAtomicType*, $array16 as xs:anyAtomicType*, $array17 as xs:anyAtomicType*, $array18 as xs:anyAtomicType*, $array19 as xs:anyAtomicType*, $array20 as xs:anyAtomicType*, $array21 as xs:anyAtomicType*, $array22 as xs:anyAtomicType*, $array23 as xs:anyAtomicType*, $array24 as xs:anyAtomicType*, $array25 as xs:anyAtomicType*, $array26 as xs:anyAtomicType*, $array27 as xs:anyAtomicType*, $array28 as xs:anyAtomicType*, $array29 as xs:anyAtomicType*, $array30 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array10", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array11", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array12", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array13", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array14", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array15", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array16", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array17", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array18", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array19", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array20", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array21", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array22", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array23", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array24", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array25", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array26", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array27", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array28", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array29", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array30", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 4, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 5, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 6, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 7, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 8, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 9, "name" : "sumproduct", "qname" : "excel:sumproduct", "signature" : "($array1 as xs:anyAtomicType*, $array2 as xs:anyAtomicType*, $array3 as xs:anyAtomicType*, $array4 as xs:anyAtomicType*, $array5 as xs:anyAtomicType*, $array6 as xs:anyAtomicType*, $array7 as xs:anyAtomicType*, $array8 as xs:anyAtomicType*, $array9 as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Multiplies the elements on the same position in each sequence\n and sums up the results.\n", "summary" : "
     Multiplies the elements on the same position in each sequence\n and sums up the results.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "array1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array3", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array4", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array5", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array6", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array7", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array8", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " }, { "name" : "array9", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequences of numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of products" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 1, "name" : "sumsq", "qname" : "excel:sumsq", "signature" : "($numbers as xs:anyAtomicType+) as xs:anyAtomicType", "description" : " Returns the sum of the squares of the arguments.\n It used the sumproduct function.\n", "summary" : "
     Returns the sum of the squares of the arguments.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "+", "description" : "
     the sequence of one or more numbers or arguments castable to numeric
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the sum of squared values, as numeric type" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] } ], "variables" : [  ] }, "http://zorba.io/modules/item" : { "ns" : "http://zorba.io/modules/item", "description" : " This module provides utility functions on items. For example,\n it provides a function that allows estimating the size in bytes\n that a given item allocates in memory.\n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/item", "prefix" : "item" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "size", "qname" : "item:size", "signature" : "($item as item()) as xs:integer external", "description" : " Computes the size in bytes of the given item in main memory.
    \n", "summary" : "
     Computes the size in bytes of the given item in main memory.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "item()", "occurrence" : null, "description" : "
     the item whose size to compute.
    " } ], "returns" : { "type" : "xs:integer", "description" : "the size allocated by the item in bytes." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/xqdoc/menu" : { "ns" : "http://www.zorba-xquery.com/modules/xqdoc/menu", "description" : " Generate navigation for XQDoc batches.\n", "sees" : [  ], "authors" : [ "William Candillon" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.zorba-xquery.com/modules/xqdoc/menu", "prefix" : "menu" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : false, "arity" : 2, "name" : "categories-as-js", "qname" : "menu:categories-as-js", "signature" : "($url-prefix as xs:string, $cats as element(*)) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "url-prefix", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cats", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "categories", "qname" : "menu:categories", "signature" : "($top as element(*)) as xs:string*", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "top", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "closed-tabs", "qname" : "menu:closed-tabs", "signature" : "($item as element(section), $url-prefix as xs:string) as element(li)*", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "element(section)", "occurrence" : null, "description" : "" }, { "name" : "url-prefix", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(li)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "closed-tabs", "qname" : "menu:closed-tabs", "signature" : "($item as element(*)?, $result as element(*)*, $url-prefix as xs:string) as element(li)*", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "element(*)", "occurrence" : "?", "description" : "" }, { "name" : "result", "type" : "element(*)", "occurrence" : "*", "description" : "" }, { "name" : "url-prefix", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(li)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "item-uri", "qname" : "menu:item-uri", "signature" : "($item as element(*)) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "item-uri", "qname" : "menu:item-uri", "signature" : "($item as element(*)?, $result as xs:string*) as xs:string+", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "element(*)", "occurrence" : "?", "description" : "" }, { "name" : "result", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:string+", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "item", "qname" : "menu:item", "signature" : "($ctx as element(*)?, $path as xs:string*) as element(*)?", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "ctx", "type" : "element(*)", "occurrence" : "?", "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "element(*)?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "menu", "qname" : "menu:menu", "signature" : "($item as element(*), $url-prefix as xs:string)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "element(*)", "occurrence" : null, "description" : "" }, { "name" : "url-prefix", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] } ], "variables" : [ { "name" : "menu:not-found", "type" : "item()*", "description" : "" } ] }, "http://zorba.io/modules/dbgp-message-handler" : { "ns" : "http://zorba.io/modules/dbgp-message-handler", "description" : " Zorba debugger module.\n", "sees" : [  ], "authors" : [ "Gabriel Petrovay" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/base64", "prefix" : "base64" }, { "uri" : "http://zorba.io/modules/dbgp-message-handler", "prefix" : "dmh" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "process", "qname" : "dmh:process", "signature" : "($message as element(*)) as xs:anyAtomicType*", "description" : " Process one message received from the Zorba debugger server.\n", "summary" : "
     Process one message received from the Zorba debugger server.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "element(*)", "occurrence" : null, "description" : "
     the message.
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "()." }, "errors" : [  ] } ], "variables" : [ { "name" : "dmh:debug", "type" : "xs:boolean", "description" : " Set this variale to true if you want to have mode debug information when\n an error occurs.\n" } ] }, "http://www.28msec.com/modules/ws/mailchimp" : { "ns" : "http://www.28msec.com/modules/ws/mailchimp", "description" : " Mailchimp Client Module.\n", "sees" : [ "http://apidocs.mailchimp.com" ], "authors" : [ "William Candillon {william.candillon@28msec.com}" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://expath.org/ns/http-client", "prefix" : "http-client" }, { "uri" : "http://www.28msec.com/modules/ws/mailchimp", "prefix" : "mailchimp" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://www.28msec.com/modules/xmlrpc", "prefix" : "xmlrpc" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "apikey-add", "qname" : "mailchimp:apikey-add", "signature" : "($username as xs:string, $password as xs:string, $apikey as xs:string) as item()*", "description" : " Convenience function for apikey-add#4.\n", "summary" : "
     Convenience function for  apikey-add#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "username", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "password", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp password
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     Any valid API Key
    " } ], "returns" : { "type" : "item()*", "description" : "A new API Key that can be immediately used." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "apikey-add", "qname" : "mailchimp:apikey-add", "signature" : "($endpoint-url as xs:string, $username as xs:string, $password as xs:string, $apikey as xs:string) as item()*", "description" : " Add an API Key to your account. We will generate a new key for you and return it.\n", "summary" : "
     Add an API Key to your account.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "username", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp user name
    " }, { "name" : "password", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp password
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     Any valid API Key
    " } ], "returns" : { "type" : "item()*", "description" : "A new API Key that can be immediately used." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "apikey-expire", "qname" : "mailchimp:apikey-expire", "signature" : "($username as xs:string, $password as xs:string, $apikey as xs:string) as item()*", "description" : " Convenience function for apikey-expire#4.\n", "summary" : "
     Convenience function for  apikey-expire#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "username", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "password", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp password
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     Any valid API Key that you wish to expire
    " } ], "returns" : { "type" : "item()*", "description" : "True if it worked, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "apikey-expire", "qname" : "mailchimp:apikey-expire", "signature" : "($endpoint-url as xs:string, $username as xs:string, $password as xs:string, $apikey as xs:string) as item()*", "description" : " Expire a Specific API Key. Note that if you expire all of your keys, just visit your API dashboard to create a new one. If you are trying to shut off access to your account for an old developer, change your MailChimp password, then expire all of the keys they had access to. Note that this takes effect immediately, so make sure you replace the keys in any working application before expiring them! Consider yourself warned...\n", "summary" : "
     Expire a Specific API Key.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "username", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp user name
    " }, { "name" : "password", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp password
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     Any valid API Key that you wish to expire
    " } ], "returns" : { "type" : "item()*", "description" : "True if it worked, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "apikeys", "qname" : "mailchimp:apikeys", "signature" : "($username as xs:string, $password as xs:string, $apikey as xs:string, $expired as xs:boolean) as item()*", "description" : " Convenience function for apikeys#5.\n", "summary" : "
     Convenience function for  apikeys#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "username", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "password", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp password
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     Any valid API Key for your account
    " }, { "name" : "expired", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional - whether or not to include expired keys, defaults to false
    " } ], "returns" : { "type" : "item()*", "description" : "An array of API keys." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "apikeys", "qname" : "mailchimp:apikeys", "signature" : "($endpoint-url as xs:string, $username as xs:string, $password as xs:string, $apikey as xs:string, $expired as xs:boolean) as item()*", "description" : " Retrieve a list of all MailChimp API Keys for this User.\n", "summary" : "
     Retrieve a list of all MailChimp API Keys for this User.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "username", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp user name
    " }, { "name" : "password", "type" : "xs:string", "occurrence" : null, "description" : "
     Your MailChimp password
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     Any valid API Key for your account
    " }, { "name" : "expired", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional - whether or not to include expired keys, defaults to false
    " } ], "returns" : { "type" : "item()*", "description" : "An array of API keys." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-abuse-reports", "qname" : "mailchimp:campaign-abuse-reports", "signature" : "($apikey as xs:string, $cid as xs:string, $since as xs:integer, $start as xs:integer, $limit as xs:string) as item()*", "description" : " Convenience function for campaign-abuse-reports#6.\n", "summary" : "
     Convenience function for  campaign-abuse-reports#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull abuse reports for (can be gathered using campaigns())
    " }, { "name" : "since", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000
    " }, { "name" : "limit", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "Reports the abuse reports for this campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "campaign-abuse-reports", "qname" : "mailchimp:campaign-abuse-reports", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $since as xs:integer, $start as xs:integer, $limit as xs:string) as item()*", "description" : " Get all email addresses that complained about a given campaign.\n", "summary" : "
     Get all email addresses that complained about a given campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull abuse reports for (can be gathered using campaigns())
    " }, { "name" : "since", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000
    " }, { "name" : "limit", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "Reports the abuse reports for this campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-advice", "qname" : "mailchimp:campaign-advice", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-advice#3.\n", "summary" : "
     Convenience function for  campaign-advice#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull advice text for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Advice on the campaign's performance" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-advice", "qname" : "mailchimp:campaign-advice", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Retrieve the text presented in our app for how a campaign performed and any advice we may have for you - best suited for display in customized reports pages.\n Note: some messages will contain HTML - clean tags as necessary.\n", "summary" : "
     Retrieve the text presented in our app for how a campaign performed and any advice we may have for you - best suited for display in customized reports pages.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull advice text for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Advice on the campaign's performance" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-analytics", "qname" : "mailchimp:campaign-analytics", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-analytics#3.\n", "summary" : "
     Convenience function for  campaign-analytics#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Analytics we've collected for the passed campaign." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-analytics", "qname" : "mailchimp:campaign-analytics", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Retrieve the Google Analytics data we've collected for this campaign. Note, requires Google Analytics Add-on to be installed and configured.\n", "summary" : "
     Retrieve the Google Analytics data we've collected for this campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Analytics we've collected for the passed campaign." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-bounce-message", "qname" : "mailchimp:campaign-bounce-message", "signature" : "($apikey as xs:string, $cid as xs:string, $email as xs:string) as item()*", "description" : " Convenience function for campaign-bounce-message#4.\n", "summary" : "
     Convenience function for  campaign-bounce-message#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "email", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address or unique id of the member to pull a bounce message for.
    " } ], "returns" : { "type" : "item()*", "description" : "The full bounce message for this email+campaign along with some extra data." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-bounce-message", "qname" : "mailchimp:campaign-bounce-message", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $email as xs:string) as item()*", "description" : " Retrieve the most recent full bounce message for a specific email address on the given campaign. Messages over 30 days old are subject to being removed.\n", "summary" : "
     Retrieve the most recent full bounce message for a specific email address on the given campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "email", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address or unique id of the member to pull a bounce message for.
    " } ], "returns" : { "type" : "item()*", "description" : "The full bounce message for this email+campaign along with some extra data." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-bounce-messages", "qname" : "mailchimp:campaign-bounce-messages", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Convenience function for campaign-bounce-messages#6.\n", "summary" : "
     Convenience function for  campaign-bounce-messages#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 25, upper limit set at 50
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD format in GMT (we only store the date, not the time)
    " } ], "returns" : { "type" : "item()*", "description" : "Bounces the full bounce messages for this campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "campaign-bounce-messages", "qname" : "mailchimp:campaign-bounce-messages", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Retrieve the full bounce messages for the given campaign. Note that this can return very large amounts of data depending on how large the campaign was and how much cruft the bounce provider returned.\n", "summary" : "
     Retrieve the full bounce messages for the given campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 25, upper limit set at 50
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD format in GMT (we only store the date, not the time)
    " } ], "returns" : { "type" : "item()*", "description" : "Bounces the full bounce messages for this campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-click-detail-AIM", "qname" : "mailchimp:campaign-click-detail-AIM", "signature" : "($apikey as xs:string, $cid as xs:string, $url as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-click-detail-AIM#6.\n", "summary" : "
     Convenience function for  campaign-click-detail-AIM#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get click stats for (can be gathered using campaigns())
    " }, { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     the URL of the link that was clicked on
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing the total records matched and the specific records for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "campaign-click-detail-AIM", "qname" : "mailchimp:campaign-click-detail-AIM", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $url as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Return the list of email addresses that clicked on a given url, and how many times they clicked.\n", "summary" : "
     Return the list of email addresses that clicked on a given url, and how many times they clicked.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get click stats for (can be gathered using campaigns())
    " }, { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     the URL of the link that was clicked on
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing the total records matched and the specific records for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-click-stats", "qname" : "mailchimp:campaign-click-stats", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-click-stats#3.\n", "summary" : "
     Convenience function for  campaign-click-stats#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull stats for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "URLs will be keys and contain their associated statistics: clicks (number of times a specific link was clicked) and unique (number of unique people who clicked on the specific link)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-click-stats", "qname" : "mailchimp:campaign-click-stats", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Get an array of the urls being tracked, and their click counts for a given campaign.\n", "summary" : "
     Get an array of the urls being tracked, and their click counts for a given campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull stats for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "URLs will be keys and contain their associated statistics: clicks (number of times a specific link was clicked) and unique (number of unique people who clicked on the specific link)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-content", "qname" : "mailchimp:campaign-content", "signature" : "($apikey as xs:string, $cid as xs:string, $for_archive as xs:boolean) as item()*", "description" : " Convenience function for campaign-content#4.\n", "summary" : "
     Convenience function for  campaign-content#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get content for (can be gathered using campaigns())
    " }, { "name" : "for_archive", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional controls whether we return the Archive version (true) or the Raw version (false), defaults to true
    " } ], "returns" : { "type" : "item()*", "description" : "Struct containing all content for the campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-content", "qname" : "mailchimp:campaign-content", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $for_archive as xs:boolean) as item()*", "description" : " Get the content (both html and text) for a campaign either as it would appear in the campaign archive or as the raw, original content.\n", "summary" : "
     Get the content (both html and text) for a campaign either as it would appear in the campaign archive or as the raw, original content.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get content for (can be gathered using campaigns())
    " }, { "name" : "for_archive", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional controls whether we return the Archive version (true) or the Raw version (false), defaults to true
    " } ], "returns" : { "type" : "item()*", "description" : "Struct containing all content for the campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "campaign-create", "qname" : "mailchimp:campaign-create", "signature" : "($apikey as xs:string, $type as xs:string, $options as element(array), $content as element(array), $segment_opts as element(array), $type_opts as element(array)) as item()*", "description" : " Convenience function for campaign-create#7.\n", "summary" : "
     Convenience function for  campaign-create#7 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Type to create - one of \"regular\", \"plaintext\", \"absplit\", \"rss\", \"trans\", \"auto\"
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     a hash of the standard options for this campaign. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "content", "type" : "element(array)", "occurrence" : null, "description" : "
     the content for this campaign - use a struct with the following keys. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "segment_opts", "type" : "element(array)", "occurrence" : null, "description" : "
     optional - if you wish to do Segmentation with this campaign this array should contain: see campaign-segment-test(). It's suggested that you test your options against campaign-segment-test(). Also, \"trans\" campaigns do not support segmentation.
    " }, { "name" : "type_opts", "type" : "element(array)", "occurrence" : null, "description" : "
     optional -
    " } ], "returns" : { "type" : "item()*", "description" : "The ID for the created campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 7, "name" : "campaign-create", "qname" : "mailchimp:campaign-create", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $type as xs:string, $options as element(array), $content as element(array), $segment_opts as element(array), $type_opts as element(array)) as item()*", "description" : " Create a new draft campaign to send. You can not have more than 32,000 campaigns in your account.\n", "summary" : "
     Create a new draft campaign to send.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Type to create - one of \"regular\", \"plaintext\", \"absplit\", \"rss\", \"trans\", \"auto\"
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     a hash of the standard options for this campaign. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "content", "type" : "element(array)", "occurrence" : null, "description" : "
     the content for this campaign - use a struct with the following keys. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "segment_opts", "type" : "element(array)", "occurrence" : null, "description" : "
     optional - if you wish to do Segmentation with this campaign this array should contain: see campaign-segment-test(). It's suggested that you test your options against campaign-segment-test(). Also, \"trans\" campaigns do not support segmentation.
    " }, { "name" : "type_opts", "type" : "element(array)", "occurrence" : null, "description" : "
     optional
    " } ], "returns" : { "type" : "item()*", "description" : "The ID for the created campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-delete", "qname" : "mailchimp:campaign-delete", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-delete#3.\n", "summary" : "
     Convenience function for  campaign-delete#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Id to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if the delete succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-delete", "qname" : "mailchimp:campaign-delete", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Delete a campaign. Seriously, \"poof, gone!\" - be careful!.\n", "summary" : "
     Delete a campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Id to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if the delete succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-ecomm-order-add", "qname" : "mailchimp:campaign-ecomm-order-add", "signature" : "($apikey as xs:string, $order as element(array)) as item()*", "description" : " Convenience function for campaign-ecomm-order-add#3.\n", "summary" : "
     Convenience function for  campaign-ecomm-order-add#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "order", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of information pertaining to the order that has completed. Use the following keys. See Mailchimp API documentation for more information about the parameter structure.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the data is saved, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-ecomm-order-add", "qname" : "mailchimp:campaign-ecomm-order-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $order as element(array)) as item()*", "description" : " Attach Ecommerce Order Information to a Campaign.\n", "summary" : "
     Attach Ecommerce Order Information to a Campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "order", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of information pertaining to the order that has completed. Use the following keys. See Mailchimp API documentation for more information about the parameter structure.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the data is saved, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-ecomm-orders", "qname" : "mailchimp:campaign-ecomm-orders", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Convenience function for campaign-ecomm-orders#6.\n", "summary" : "
     Convenience function for  campaign-ecomm-orders#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "The total matching orders and the specific orders for the requested page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "campaign-ecomm-orders", "qname" : "mailchimp:campaign-ecomm-orders", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Retrieve the Ecommerce Orders tracked by campaign-ecomm-order-add().\n", "summary" : "
     Retrieve the Ecommerce Orders tracked by  campaign-ecomm-order-add() .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "The total matching orders and the specific orders for the requested page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-eep-url-stats", "qname" : "mailchimp:campaign-eep-url-stats", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-eep-url-stats#3.\n", "summary" : "
     Convenience function for  campaign-eep-url-stats#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Stats an array containing tweets, retweets, clicks, and referrer related to using the campaign's eepurl" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-eep-url-stats", "qname" : "mailchimp:campaign-eep-url-stats", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Retrieve the tracked eepurl mentions on Twitter.\n", "summary" : "
     Retrieve the tracked eepurl mentions on Twitter.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Stats an array containing tweets, retweets, clicks, and referrer related to using the campaign's eepurl" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-email-domain-performance", "qname" : "mailchimp:campaign-email-domain-performance", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-email-domain-performance#3.\n", "summary" : "
     Convenience function for  campaign-email-domain-performance#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull email domain performance for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Domains email domains and their associated stats" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-email-domain-performance", "qname" : "mailchimp:campaign-email-domain-performance", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Get the top 5 performing email domains for this campaign. Users want more than 5 should use campaign campaign-email-stats-AIM() or campaign-email-stats-AIM-all() and generate any additional stats they require.\n", "summary" : "
     Get the top 5 performing email domains for this campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull email domain performance for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Domains email domains and their associated stats" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-email-stats-AIM-all", "qname" : "mailchimp:campaign-email-stats-AIM-all", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-email-stats-AIM-all#5.\n", "summary" : "
     Convenience function for  campaign-email-stats-AIM-all#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get stats for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 1000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing a total record count and data including the actions (opens and clicks) for each email, with timestamps" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-email-stats-AIM-all", "qname" : "mailchimp:campaign-email-stats-AIM-all", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Given a campaign and correct paging limits, return the entire click and open history with timestamps, ordered by time, for every user a campaign was delivered to.\n", "summary" : "
     Given a campaign and correct paging limits, return the entire click and open history with timestamps, ordered by time, for every user a campaign was delivered to.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get stats for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 1000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing a total record count and data including the actions (opens and clicks) for each email, with timestamps" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-email-stats-AIM", "qname" : "mailchimp:campaign-email-stats-AIM", "signature" : "($apikey as xs:string, $cid as xs:string, $email_address as element(array)) as item()*", "description" : " Convenience function for campaign-email-stats-AIM#4.\n", "summary" : "
     Convenience function for  campaign-email-stats-AIM#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get stats for (can be gathered using campaigns())
    " }, { "name" : "email_address", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of up to 50 email addresses to check OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).
    " } ], "returns" : { "type" : "item()*", "description" : "Array an array with the keys listed in Returned Fields below" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-email-stats-AIM", "qname" : "mailchimp:campaign-email-stats-AIM", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $email_address as element(array)) as item()*", "description" : " Given a campaign and email address, return the entire click and open history with timestamps, ordered by time.\n", "summary" : "
     Given a campaign and email address, return the entire click and open history with timestamps, ordered by time.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get stats for (can be gathered using campaigns())
    " }, { "name" : "email_address", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of up to 50 email addresses to check OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).
    " } ], "returns" : { "type" : "item()*", "description" : "Array an array with the keys listed in Returned Fields below" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-geo-opens-for-country", "qname" : "mailchimp:campaign-geo-opens-for-country", "signature" : "($apikey as xs:string, $cid as xs:string, $code as xs:string) as item()*", "description" : " Convenience function for campaign-geo-opens-for-country#4.\n", "summary" : "
     Convenience function for  campaign-geo-opens-for-country#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "code", "type" : "xs:string", "occurrence" : null, "description" : "
     An ISO3166 2 digit country code
    " } ], "returns" : { "type" : "item()*", "description" : "Regions an array of regions within the provided country where opens occurred." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-geo-opens-for-country", "qname" : "mailchimp:campaign-geo-opens-for-country", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $code as xs:string) as item()*", "description" : " Retrieve the regions and number of opens tracked for a certain country. Email address are not returned.\n", "summary" : "
     Retrieve the regions and number of opens tracked for a certain country.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "code", "type" : "xs:string", "occurrence" : null, "description" : "
     An ISO3166 2 digit country code
    " } ], "returns" : { "type" : "item()*", "description" : "Regions an array of regions within the provided country where opens occurred." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-geo-opens", "qname" : "mailchimp:campaign-geo-opens", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-geo-opens#3.\n", "summary" : "
     Convenience function for  campaign-geo-opens#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Countries an array of countries where opens occurred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-geo-opens", "qname" : "mailchimp:campaign-geo-opens", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Retrieve the countries and number of opens tracked for each. Email address are not returned.\n", "summary" : "
     Retrieve the countries and number of opens tracked for each.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Countries an array of countries where opens occurred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-hard-bounces", "qname" : "mailchimp:campaign-hard-bounces", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-hard-bounces#5.\n", "summary" : "
     Convenience function for  campaign-hard-bounces#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "array a total of all hard bounced emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-hard-bounces", "qname" : "mailchimp:campaign-hard-bounces", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " DEPRECATED Get all email addresses with Hard Bounces for a given campaign the email address that bounced.\n", "summary" : "
      DEPRECATED  Get all email addresses with Hard Bounces for a given campaign the email address that bounced.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "array a total of all hard bounced emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-members", "qname" : "mailchimp:campaign-members", "signature" : "($apikey as xs:string, $cid as xs:string, $status as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-members#6.\n", "summary" : "
     Convenience function for  campaign-members#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull members for (can be gathered using campaigns())
    " }, { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the status to pull - one of 'sent', 'hard' (bounce), or 'soft' (bounce). By default, all records are returned
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "A total of all matching emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "campaign-members", "qname" : "mailchimp:campaign-members", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $status as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Get all email addresses the campaign was successfully sent to (ie, no bounces).\n", "summary" : "
     Get all email addresses the campaign was successfully sent to (ie, no bounces).
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull members for (can be gathered using campaigns())
    " }, { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the status to pull - one of 'sent', 'hard' (bounce), or 'soft' (bounce). By default, all records are returned
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "A total of all matching emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-not-opened-AIM", "qname" : "mailchimp:campaign-not-opened-AIM", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-not-opened-AIM#5.\n", "summary" : "
     Convenience function for  campaign-not-opened-AIM#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get no opens for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing the total records matched and the specific records for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-not-opened-AIM", "qname" : "mailchimp:campaign-not-opened-AIM", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Retrieve the list of email addresses that did not open a given campaign string email Email address that opened the campaign.\n", "summary" : "
     Retrieve the list of email addresses that did not open a given campaign string email Email address that opened the campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get no opens for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "array array containing the total records matched and the specific records for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-opened-AIM", "qname" : "mailchimp:campaign-opened-AIM", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-openedAIM#5.\n", "summary" : "
     Convenience function for  campaign-openedAIM#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get opens for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing the total records matched and the specific records for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-opened-AIM", "qname" : "mailchimp:campaign-opened-AIM", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Retrieve the list of email addresses that opened a given campaign with how many times they opened.\n", "summary" : "
     Retrieve the list of email addresses that opened a given campaign with how many times they opened.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get opens for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing the total records matched and the specific records for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-pause", "qname" : "mailchimp:campaign-pause", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-pause#3.\n", "summary" : "
     Convenience function for  campaign-pause#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to pause
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-pause", "qname" : "mailchimp:campaign-pause", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Pause an AutoResponder or RSS campaign from sending.\n", "summary" : "
     Pause an AutoResponder or RSS campaign from sending.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to pause
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-replicate", "qname" : "mailchimp:campaign-replicate", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-replicate#3.\n", "summary" : "
     Convenience function for  campaign-replicate#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Id to replicate
    " } ], "returns" : { "type" : "item()*", "description" : "The id of the replicated Campaign created, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-replicate", "qname" : "mailchimp:campaign-replicate", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Replicate a campaign.\n", "summary" : "
     Replicate a campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Id to replicate
    " } ], "returns" : { "type" : "item()*", "description" : "The id of the replicated Campaign created, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-resume", "qname" : "mailchimp:campaign-resume", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-resume#3.\n", "summary" : "
     Convenience function for  campaign-resume#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to pause
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-resume", "qname" : "mailchimp:campaign-resume", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Resume sending an AutoResponder or RSS campaign.\n", "summary" : "
     Resume sending an AutoResponder or RSS campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to pause
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-schedule", "qname" : "mailchimp:campaign-schedule", "signature" : "($apikey as xs:string, $cid as xs:string, $schedule_time as xs:string, $schedule_time_b as xs:string) as item()*", "description" : " Convenience function for campaign-schedule#5.\n", "summary" : "
     Convenience function for  campaign-schedule#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to schedule
    " }, { "name" : "schedule_time", "type" : "xs:string", "occurrence" : null, "description" : "
     the time to schedule the campaign. For A/B Split \"schedule\" campaigns, the time for Group A - in YYYY-MM-DD HH:II:SS format in GMT
    " }, { "name" : "schedule_time_b", "type" : "xs:string", "occurrence" : null, "description" : "
     optional -the time to schedule Group B of an A/B Split \"schedule\" campaign - in YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "boolean True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-schedule", "qname" : "mailchimp:campaign-schedule", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $schedule_time as xs:string, $schedule_time_b as xs:string) as item()*", "description" : " Schedule a campaign to be sent in the future.\n", "summary" : "
     Schedule a campaign to be sent in the future.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to schedule
    " }, { "name" : "schedule_time", "type" : "xs:string", "occurrence" : null, "description" : "
     the time to schedule the campaign. For A/B Split \"schedule\" campaigns, the time for Group A - in YYYY-MM-DD HH:II:SS format in GMT
    " }, { "name" : "schedule_time_b", "type" : "xs:string", "occurrence" : null, "description" : "
     optional -the time to schedule Group B of an A/B Split \"schedule\" campaign - in YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "boolean True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-segment-test", "qname" : "mailchimp:campaign-segment-test", "signature" : "($apikey as xs:string, $list_id as xs:string, $options as element(array)) as item()*", "description" : " Convenience function for campaign-segment-test#4.\n", "summary" : "
     Convenience function for  campaign-segment-test#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "list_id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list to test segmentation on - get lists using lists()
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     with 2 keys. See Mailchimp API documentation for more information about the parameter structure.
    " } ], "returns" : { "type" : "item()*", "description" : "The total number of subscribers matching your segmentation options" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-segment-test", "qname" : "mailchimp:campaign-segment-test", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $list_id as xs:string, $options as element(array)) as item()*", "description" : " Allows one to test their segmentation rules before creating a campaign using them.\n", "summary" : "
     Allows one to test their segmentation rules before creating a campaign using them.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "list_id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list to test segmentation on - get lists using lists()
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     with 2 keys. See Mailchimp API documentation for more information about the parameter structure.
    " } ], "returns" : { "type" : "item()*", "description" : "The total number of subscribers matching your segmentation options" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-send-now", "qname" : "mailchimp:campaign-send-now", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-send-now#3.\n", "summary" : "
     Convenience function for  campaign-send-now#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to send
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-send-now", "qname" : "mailchimp:campaign-send-now", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Send a given campaign immediately. For RSS campaigns, this will \"start\" them.\n", "summary" : "
     Send a given campaign immediately.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to send
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-send-test", "qname" : "mailchimp:campaign-send-test", "signature" : "($apikey as xs:string, $cid as xs:string, $test_emails as element(array), $send_type as xs:string) as item()*", "description" : " Convenience function for campaign-send-test#5.\n", "summary" : "
     Convenience function for  campaign-send-test#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to test
    " }, { "name" : "test_emails", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of email address to receive the test message
    " }, { "name" : "send_type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional by default (null) both formats are sent - \"html\" or \"text\" send just that format
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-send-test", "qname" : "mailchimp:campaign-send-test", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $test_emails as element(array), $send_type as xs:string) as item()*", "description" : " Send a test of this campaign to the provided email address.\n", "summary" : "
     Send a test of this campaign to the provided email address.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to test
    " }, { "name" : "test_emails", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of email address to receive the test message
    " }, { "name" : "send_type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional by default (null) both formats are sent - \"html\" or \"text\" send just that format
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-share-report", "qname" : "mailchimp:campaign-share-report", "signature" : "($apikey as xs:string, $cid as xs:string, $opts as element(array)) as item()*", "description" : " Convenience function for campaign-share-report#4.\n", "summary" : "
     Convenience function for  campaign-share-report#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to share a report for (can be gathered using campaigns())
    " }, { "name" : "opts", "type" : "element(array)", "occurrence" : null, "description" : "
     s optional various parameters which can be used to configure the shared report
    " } ], "returns" : { "type" : "item()*", "description" : "Struct containing details for the shared report" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-share-report", "qname" : "mailchimp:campaign-share-report", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $opts as element(array)) as item()*", "description" : " Get the URL to a customized VIP Report for the specified campaign and optionally send an email to someone with links to it. Note subsequent calls will overwrite anything already set for the same campign (eg, the password).\n", "summary" : "
     Get the URL to a customized  VIP Report  for the specified campaign and optionally send an email to someone with links to it.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to share a report for (can be gathered using campaigns())
    " }, { "name" : "opts", "type" : "element(array)", "occurrence" : null, "description" : "
     s optional various parameters which can be used to configure the shared report
    " } ], "returns" : { "type" : "item()*", "description" : "Struct containing details for the shared report" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-soft-bounces", "qname" : "mailchimp:campaign-soft-bounces", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-soft-bounces#5.\n", "summary" : "
     Convenience function for  campaign-soft-bounces#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "A total of all soft bounced emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-soft-bounces", "qname" : "mailchimp:campaign-soft-bounces", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " DEPRECATED Get all email addresses with Soft Bounces for a given campaign the email address that bounced.\n", "summary" : "
      DEPRECATED  Get all email addresses with Soft Bounces for a given campaign the email address that bounced.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "A total of all soft bounced emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-stats", "qname" : "mailchimp:campaign-stats", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-stats#3.\n", "summary" : "
     Convenience function for  campaign-stats#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull stats for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "array struct of the statistics for this campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-stats", "qname" : "mailchimp:campaign-stats", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Given a list and a campaign, get all the relevant campaign statistics (opens, bounces, clicks, etc.)\n", "summary" : "
     Given a list and a campaign, get all the relevant campaign statistics (opens, bounces, clicks, etc.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull stats for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "array struct of the statistics for this campaign" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-template-content", "qname" : "mailchimp:campaign-template-content", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-template-content#3.\n", "summary" : "
     Convenience function for  campaign-template-content#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get content for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing all content section for the campaign -" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-template-content", "qname" : "mailchimp:campaign-template-content", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Get the HTML template content sections for a campaign. Note that this will return very jagged, non-standard results based on the template a campaign is using. You only want to use this if you want to allow editing template sections in your applicaton.\n", "summary" : "
     Get the HTML template content sections for a campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to get content for (can be gathered using campaigns())
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing all content section for the campaign -" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaign-unschedule", "qname" : "mailchimp:campaign-unschedule", "signature" : "($apikey as xs:string, $cid as xs:string) as item()*", "description" : " Convenience function for campaign-unschedule#3.\n", "summary" : "
     Convenience function for  campaign-unschedule#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to unschedule
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaign-unschedule", "qname" : "mailchimp:campaign-unschedule", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string) as item()*", "description" : " Unschedule a campaign that is scheduled to be sent in the future.\n", "summary" : "
     Unschedule a campaign that is scheduled to be sent in the future.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the campaign to unschedule
    " } ], "returns" : { "type" : "item()*", "description" : "True on success" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-unsubscribes", "qname" : "mailchimp:campaign-unsubscribes", "signature" : "($apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaign-unsubscribes#5.\n", "summary" : "
     Convenience function for  campaign-unsubscribes#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "array email addresses that unsubscribed from this campaign along with reasons, if given array a total of all unsubscribed emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-unsubscribes", "qname" : "mailchimp:campaign-unsubscribes", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Get all unsubscribed email addresses for a given campaign.\n", "summary" : "
     Get all unsubscribed email addresses for a given campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the campaign id to pull bounces for (can be gathered using campaigns())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     art optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     mit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "array email addresses that unsubscribed from this campaign along with reasons, if given array a total of all unsubscribed emails and the specific emails for this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaign-update", "qname" : "mailchimp:campaign-update", "signature" : "($apikey as xs:string, $cid as xs:string, $name as xs:string, $value as item()) as item()*", "description" : " Convenience function for campaign-update#5.\n", "summary" : "
     Convenience function for  campaign-update#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Id to update
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the parameter name (see campaigncreate()). For items in the options array, this will be that parameter's name (subject, from_email, etc.). Additional parameters will be that option name (content, segment_opts). \"type_opts\" will be the name of the type - rss, auto, trans, etc.
    " }, { "name" : "value", "type" : "item()", "occurrence" : null, "description" : "
     e an appropriate value for the parameter ( see campaigncreate()). For items in the options array, this will be that parameter's value. For additional parameters, this is the same value passed to them.
    " } ], "returns" : { "type" : "item()*", "description" : "boolean true if the update succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaign-update", "qname" : "mailchimp:campaign-update", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $cid as xs:string, $name as xs:string, $value as item()) as item()*", "description" : " Update just about any setting for a campaign that has not been sent. See campaigncreate() for details.\n Caveats: 
    \n  
      \n    
    • If you set list_id, all segmentation options will be deleted and must be re-added.
      • \n    
    • If you set template_id, you need to follow that up by setting it's 'content'
      • \n    
    • If you set segment_opts, you should have tested your options against campaign-segment-test() as campaign-update() will not allow you to set a segment that includes no members.
      • \n  
    .\n", "summary" : "
     Update just about any setting for a campaign that has  not  been sent.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "cid", "type" : "xs:string", "occurrence" : null, "description" : "
     the Campaign Id to update
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the parameter name ( see campaigncreate()). For items in the options array, this will be that parameter's name (subject, from_email, etc.). Additional parameters will be that option name (content, segment_opts). \"type_opts\" will be the name of the type - rss, auto, trans, etc.
    " }, { "name" : "value", "type" : "item()", "occurrence" : null, "description" : "
     An appropriate value for the parameter ( see campaigncreate()). For items in the options array, this will be that parameter's value. For additional parameters, this is the same value passed to them.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the update succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "campaigns-for-email", "qname" : "mailchimp:campaigns-for-email", "signature" : "($apikey as xs:string, $email_address as xs:string) as item()*", "description" : " Convenience function for campaigns-for-email#3.\n", "summary" : "
     Convenience function for  campaigns-for-email#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to unsubscribe OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns
    " } ], "returns" : { "type" : "item()*", "description" : "An array of campaign_ids the member received" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "campaigns-for-email", "qname" : "mailchimp:campaigns-for-email", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $email_address as xs:string) as item()*", "description" : " Retrieve all Campaigns Ids a member was sent.\n", "summary" : "
     Retrieve all Campaigns Ids a member was sent.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to unsubscribe OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns
    " } ], "returns" : { "type" : "item()*", "description" : "An array of campaign_ids the member received" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "campaigns", "qname" : "mailchimp:campaigns", "signature" : "($apikey as xs:string, $filters as element(array), $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for campaigns#5.\n", "summary" : "
     Convenience function for  campaigns#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "filters", "type" : "element(array)", "occurrence" : null, "description" : "
     a hash of filters to apply to this query - all are optional. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of campaigns, start results at this campaign #, defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of campaigns, number of campaigns to return with each call, defaults to 25 (max=1000)
    " } ], "returns" : { "type" : "item()*", "description" : "An array containing a count of all matching campaigns and the specific ones for the current page (see Mailchimp API documentation for more information about the return type)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "campaigns", "qname" : "mailchimp:campaigns", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $filters as element(array), $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Get the list of campaigns and their details matching the specified filters.\n", "summary" : "
     Get the list of campaigns and their details matching the specified filters.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "filters", "type" : "element(array)", "occurrence" : null, "description" : "
     a hash of filters to apply to this query - all are optional. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of campaigns, start results at this campaign #, defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of campaigns, number of campaigns to return with each call, defaults to 25 (max=1000)
    " } ], "returns" : { "type" : "item()*", "description" : "An array containing a count of all matching campaigns and the specific ones for the current page (see Mailchimp API documentation for more information about the return type)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "chimp-chatter", "qname" : "mailchimp:chimp-chatter", "signature" : "($apikey as xs:string) as item()*", "description" : " Convenience function for chimp-chatter#2.\n", "summary" : "
     Convenience function for  chimp-chatter#2 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "An array of chatter messages and properties" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "chimp-chatter", "qname" : "mailchimp:chimp-chatter", "signature" : "($endpoint-url as xs:string, $apikey as xs:string) as item()*", "description" : " Return the current Chimp Chatter messages for an account.\n", "summary" : "
     Return the current Chimp Chatter messages for an account.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " } ], "returns" : { "type" : "item()*", "description" : "An array of chatter messages and properties" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "ecomm-order-add", "qname" : "mailchimp:ecomm-order-add", "signature" : "($apikey as xs:string, $order as element(array)) as item()*", "description" : " Convenience function for ecomm-order-add#3.\n", "summary" : "
     Convenience function for  ecomm-order-add#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "order", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of information pertaining to the order that has completed. Use the following keys. See Mailchimp API documentation for more information about the parameter structure.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the data is saved, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "ecomm-order-add", "qname" : "mailchimp:ecomm-order-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $order as element(array)) as item()*", "description" : " Import Ecommerce Order Information to be used for Segmentation.\n", "summary" : "
     Import Ecommerce Order Information to be used for Segmentation.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "order", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of information pertaining to the order that has completed. Use the following keys. See Mailchimp API documentation for more information about the parameter structure.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the data is saved, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "ecomm-order-del", "qname" : "mailchimp:ecomm-order-del", "signature" : "($apikey as xs:string, $store_id as xs:string, $order_id as xs:string) as item()*", "description" : " Convenience function for ecomm-order-del#4.\n", "summary" : "
     Convenience function for  ecomm-order-del#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "store_id", "type" : "xs:string", "occurrence" : null, "description" : "
     the store id the order belongs to
    " }, { "name" : "order_id", "type" : "xs:string", "occurrence" : null, "description" : "
     the order id (generated by the store) to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if an order is deleted, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "ecomm-order-del", "qname" : "mailchimp:ecomm-order-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $store_id as xs:string, $order_id as xs:string) as item()*", "description" : " Delete Ecommerce Order Information used for segmentation. This will generally be used by ecommerce package plugins that we provide or by 3rd part system developers.\n", "summary" : "
     Delete Ecommerce Order Information used for segmentation.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "store_id", "type" : "xs:string", "occurrence" : null, "description" : "
     the store id the order belongs to
    " }, { "name" : "order_id", "type" : "xs:string", "occurrence" : null, "description" : "
     the order id (generated by the store) to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if an order is deleted, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "ecomm-orders", "qname" : "mailchimp:ecomm-orders", "signature" : "($apikey as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Convenience function for ecomm-orders#5.\n", "summary" : "
     Convenience function for  ecomm-orders#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "Array the total matching orders and the specific orders for the requested page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "ecomm-orders", "qname" : "mailchimp:ecomm-orders", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Retrieve the Ecommerce Orders for an account.\n", "summary" : "
     Retrieve the Ecommerce Orders for an account.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "Array the total matching orders and the specific orders for the requested page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "folder-add", "qname" : "mailchimp:folder-add", "signature" : "($apikey as xs:string, $name as xs:string, $type as xs:string) as item()*", "description" : " Convenience function for folder-add#4.\n", "summary" : "
     Convenience function for  folder-add#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     a unique name for a folder (max 100 bytes)
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folder to create - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "The folder_id of the newly created folder." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "folder-add", "qname" : "mailchimp:folder-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $name as xs:string, $type as xs:string) as item()*", "description" : " Add a new folder to file campaigns or autoresponders in.\n", "summary" : "
     Add a new folder to file campaigns or autoresponders in.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     a unique name for a folder (max 100 bytes)
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folder to create - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "The folder_id of the newly created folder." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "folder-del", "qname" : "mailchimp:folder-del", "signature" : "($apikey as xs:string, $fid as xs:integer, $type as xs:string) as item()*", "description" : " Convenience function for folder-del#4.\n", "summary" : "
     Convenience function for  folder-del#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "fid", "type" : "xs:integer", "occurrence" : null, "description" : "
     the folder id to update - retrieve from folders()
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folder to create - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "True if the delete worked, otherwise an exception is thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "folder-del", "qname" : "mailchimp:folder-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $fid as xs:integer, $type as xs:string) as item()*", "description" : " Delete a campaign or autoresponder folder. Note that this will simply make campaigns in the folder appear unfiled, they are not removed.\n", "summary" : "
     Delete a campaign or autoresponder folder.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "fid", "type" : "xs:integer", "occurrence" : null, "description" : "
     the folder id to update - retrieve from folders()
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folder to create - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "True if the delete worked, otherwise an exception is thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "folder-update", "qname" : "mailchimp:folder-update", "signature" : "($apikey as xs:string, $fid as xs:integer, $name as xs:string, $type as xs:string) as item()*", "description" : " Convenience function for folder-update#5.\n", "summary" : "
     Convenience function for  folder-update#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "fid", "type" : "xs:integer", "occurrence" : null, "description" : "
     the folder id to update - retrieve from folders()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     a new, unique name for the folder (max 100 bytes)
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folder to create - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "True if the update worked, otherwise an exception is thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "folder-update", "qname" : "mailchimp:folder-update", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $fid as xs:integer, $name as xs:string, $type as xs:string) as item()*", "description" : " Update the name of a folder for campaigns or autoresponders.\n", "summary" : "
     Update the name of a folder for campaigns or autoresponders.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "fid", "type" : "xs:integer", "occurrence" : null, "description" : "
     the folder id to update - retrieve from folders()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     a new, unique name for the folder (max 100 bytes)
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folder to create - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "True if the update worked, otherwise an exception is thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "folders", "qname" : "mailchimp:folders", "signature" : "($apikey as xs:string, $type as xs:string) as item()*", "description" : " Convenience function for folders#3.\n", "summary" : "
     Convenience function for  folders#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folders to return - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "Array of folder structs (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "folders", "qname" : "mailchimp:folders", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $type as xs:string) as item()*", "description" : " List all the folders for a user account.\n", "summary" : "
     List all the folders for a user account.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional the type of folders to return - either \"campaign\" or \"autoresponder\". Defaults to \"campaign\"
    " } ], "returns" : { "type" : "item()*", "description" : "Array of folder structs (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "generate-text", "qname" : "mailchimp:generate-text", "signature" : "($apikey as xs:string, $type as xs:string, $content as item()) as item()*", "description" : " Convenience function for generate-text#4.\n", "summary" : "
     Convenience function for  generate-text#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     The type of content to parse. Must be one of: \"html\", \"template\", \"url\", \"cid\" (Campaign Id), or \"tid\" (Template Id)
    " }, { "name" : "content", "type" : "item()", "occurrence" : null, "description" : "
     The content to use. For \"html\" expects a single string value, \"template\" expects an array like you send to campaignCreate, \"url\" expects a valid & public URL to pull from, \"cid\" expects a valid Campaign Id, and \"tid\" expects a valid Template Id on your account.
    " } ], "returns" : { "type" : "item()*", "description" : "The content pass in converted to text." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "generate-text", "qname" : "mailchimp:generate-text", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $type as xs:string, $content as item()) as item()*", "description" : " Have HTML content auto-converted to a text-only format. You can send: plain HTML, an array of Template content, an existing Campaign Id, or an existing Template Id. Note that this will not save anything to or update any of your lists, campaigns, or templates.\n", "summary" : "
     Have HTML content auto-converted to a text-only format.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     The type of content to parse. Must be one of: \"html\", \"template\", \"url\", \"cid\" (Campaign Id), or \"tid\" (Template Id)
    " }, { "name" : "content", "type" : "item()", "occurrence" : null, "description" : "
     The content to use. For \"html\" expects a single string value, \"template\" expects an array like you send to campaignCreate, \"url\" expects a valid & public URL to pull from, \"cid\" expects a valid Campaign Id, and \"tid\" expects a valid Template Id on your account.
    " } ], "returns" : { "type" : "item()*", "description" : "The content pass in converted to text." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "get-account-details", "qname" : "mailchimp:get-account-details", "signature" : "($apikey as xs:string) as item()*", "description" : " Convenience function for get-account-details#2.\n", "summary" : "
     Convenience function for  get-account-details#2 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "array containing the details for the account tied to this API Key" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "get-account-details", "qname" : "mailchimp:get-account-details", "signature" : "($endpoint-url as xs:string, $apikey as xs:string) as item()*", "description" : " Retrieve lots of account information including payments made, plan info, some account stats, installed modules, contact info, and more.\n", "summary" : "
     Retrieve lots of account information including payments made, plan info, some account stats, installed modules, contact info, and more.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " } ], "returns" : { "type" : "item()*", "description" : "Array containing the details for the account tied to this API Key" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "inline-css", "qname" : "mailchimp:inline-css", "signature" : "($apikey as xs:string, $html as xs:string, $strip_css as xs:boolean) as item()*", "description" : " Convenience function for inline-css#4.\n", "summary" : "
     Convenience function for  inline-css#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "html", "type" : "xs:string", "occurrence" : null, "description" : "
     Your HTML content
    " }, { "name" : "strip_css", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional Whether you want the CSS &lt;style&gt; tags stripped from the returned document. Defaults to false.
    " } ], "returns" : { "type" : "item()*", "description" : "Your HTML content with all CSS inlined, just like if we sent it." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "inline-css", "qname" : "mailchimp:inline-css", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $html as xs:string, $strip_css as xs:boolean) as item()*", "description" : " Send your HTML content to have the CSS inlined and optionally remove the original styles.\n", "summary" : "
     Send your HTML content to have the CSS inlined and optionally remove the original styles.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "html", "type" : "xs:string", "occurrence" : null, "description" : "
     Your HTML content
    " }, { "name" : "strip_css", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional Whether you want the CSS &lt;style&gt; tags stripped from the returned document. Defaults to false.
    " } ], "returns" : { "type" : "item()*", "description" : "Your HTML content with all CSS inlined, just like if we sent it." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-abuse-reports", "qname" : "mailchimp:list-abuse-reports", "signature" : "($apikey as xs:string, $id as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Convenience function for list-abuse-reports#6.\n", "summary" : "
     Convenience function for  list-abuse-reports#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to pull abuse reports for (can be gathered using lists())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "The total of all reports and the specific reports reports this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-abuse-reports", "qname" : "mailchimp:list-abuse-reports", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $start as xs:integer, $limit as xs:integer, $since as xs:string) as item()*", "description" : " Get all email addresses that complained about a given campaign.\n", "summary" : "
     Get all email addresses that complained about a given campaign.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to pull abuse reports for (can be gathered using lists())
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 500, upper limit set at 1000
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
    " } ], "returns" : { "type" : "item()*", "description" : "The total of all reports and the specific reports reports this page" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-activity", "qname" : "mailchimp:list-activity", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-activity#3.\n", "summary" : "
     Convenience function for  list-activity#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "Array of array of daily values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-activity", "qname" : "mailchimp:list-activity", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Access up to the previous 180 days of daily detailed aggregated activity stats for a given list.\n", "summary" : "
     Access up to the previous 180 days of daily detailed aggregated activity stats for a given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "array array of array of daily values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-batch-subscribe", "qname" : "mailchimp:list-batch-subscribe", "signature" : "($apikey as xs:string, $id as xs:string, $batch as element(array), $double_optin as xs:boolean, $update_existing as xs:boolean, $replace_interests as xs:boolean) as item()*", "description" : " Convenience function for list-batch-subscribe#7.\n", "summary" : "
     Convenience function for  list-batch-subscribe#7 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "batch", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of structs for each address to import with two special keys: \"EMAIL\" for the email address, and \"EMAIL_TYPE\" for the email type option (html, text, or mobile)
    " }, { "name" : "double_optin", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to control whether to send an opt-in confirmation email - defaults to true
    " }, { "name" : "update_existing", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to control whether to update members that are already subscribed to the list or to return an error, defaults to false (return error)
    " }, { "name" : "replace_interests", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true)
    " } ], "returns" : { "type" : "item()*", "description" : "Array of result counts and any errors that occurred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 7, "name" : "list-batch-subscribe", "qname" : "mailchimp:list-batch-subscribe", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $batch as element(array), $double_optin as xs:boolean, $update_existing as xs:boolean, $replace_interests as xs:boolean) as item()*", "description" : " Subscribe a batch of email addresses to a list at once. If you are using a serialized version of the API, we strongly suggest that you only run this method as a POST request, and not a GET request. Maximum batch sizes vary based on the amount of data in each record, though you should cap them at 5k - 10k records, depending on your experience. These calls are also long, so be sure you increase your timeout values.\n", "summary" : "
     Subscribe a batch of email addresses to a list at once.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "batch", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of structs for each address to import with two special keys: \"EMAIL\" for the email address, and \"EMAIL_TYPE\" for the email type option (html, text, or mobile)
    " }, { "name" : "double_optin", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to control whether to send an opt-in confirmation email - defaults to true
    " }, { "name" : "update_existing", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to control whether to update members that are already subscribed to the list or to return an error, defaults to false (return error)
    " }, { "name" : "replace_interests", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true)
    " } ], "returns" : { "type" : "item()*", "description" : "Array of result counts and any errors that occurred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-batch-unsubscribe", "qname" : "mailchimp:list-batch-unsubscribe", "signature" : "($apikey as xs:string, $id as xs:string, $emails as element(array), $delete_member as xs:boolean, $send_goodbye as xs:boolean, $send_notify as xs:boolean) as item()*", "description" : " Convenience function for list-batch-unsubscribe#7.\n", "summary" : "
     Convenience function for  list-batch-unsubscribe#7 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "emails", "type" : "element(array)", "occurrence" : null, "description" : "
     array of email addresses to unsubscribe
    " }, { "name" : "delete_member", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to completely delete the member from your list instead of just unsubscribing, default to false
    " }, { "name" : "send_goodbye", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the goodbye email to the email addresses, defaults to true
    " }, { "name" : "send_notify", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to false
    " } ], "returns" : { "type" : "item()*", "description" : "Array of result counts and any errors that occurred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 7, "name" : "list-batch-unsubscribe", "qname" : "mailchimp:list-batch-unsubscribe", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $emails as element(array), $delete_member as xs:boolean, $send_goodbye as xs:boolean, $send_notify as xs:boolean) as item()*", "description" : " Unsubscribe a batch of email addresses to a list.\n", "summary" : "
     Unsubscribe a batch of email addresses to a list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "emails", "type" : "element(array)", "occurrence" : null, "description" : "
     array of email addresses to unsubscribe
    " }, { "name" : "delete_member", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to completely delete the member from your list instead of just unsubscribing, default to false
    " }, { "name" : "send_goodbye", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the goodbye email to the email addresses, defaults to true
    " }, { "name" : "send_notify", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to false
    " } ], "returns" : { "type" : "item()*", "description" : "Array of result counts and any errors that occurred" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-clients", "qname" : "mailchimp:list-clients", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-clients#3.\n", "summary" : "
     Convenience function for  list-clients#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "array the desktop and mobile user agents in use on the list" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-clients", "qname" : "mailchimp:list-clients", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Retrieve the clients that the list's subscribers have been tagged as being used based on user agents seen. Made possible by user-agent-string.info double penetration the percent of desktop clients in use array clients a record containing the 'client', an 'icon' image url, the 'percent' using the client, and the total 'members' represented double penetration the percent of mobile clients in use array clients a record containing the 'client', an 'icon' image url, the 'percent' using the client, and the total 'members' represented.\n", "summary" : "
     Retrieve the clients that the list's subscribers have been tagged as being used based on user agents seen.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "Array the desktop and mobile user agents in use on the list" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-growth-history", "qname" : "mailchimp:list-growth-history", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-growth-history#3.\n", "summary" : "
     Convenience function for  list-growth-history#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "Array of months and growth" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-growth-history", "qname" : "mailchimp:list-growth-history", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Access the Growth History by Month for a given list.\n", "summary" : "
     Access the Growth History by Month for a given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "Array of months and growth" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-interest-group-add", "qname" : "mailchimp:list-interest-group-add", "signature" : "($apikey as xs:string, $id as xs:string, $group_name as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Convenience function for list-interest-group-add#5.\n", "summary" : "
     Convenience function for  list-interest-group-add#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "group_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest group to add - group names must be unique within a grouping
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     ouping_id The grouping to add the new group to - get using list-interest-groupings(). If not supplied, the first grouping on the list is used.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-interest-group-add", "qname" : "mailchimp:list-interest-group-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $group_name as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Add a single Interest Group - if interest groups for the List are not yet enabled, adding the first group will automatically turn them on.\n", "summary" : "
     Add a single Interest Group - if interest groups for the List are not yet enabled, adding the first group will automatically turn them on.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "group_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest group to add - group names must be unique within a grouping
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     ouping_id The grouping to add the new group to - get using list-interest-groupings() . If not supplied, the first grouping on the list is used.
    " } ], "returns" : { "type" : "item()*", "description" : "bool true if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-interest-group-del", "qname" : "mailchimp:list-interest-group-del", "signature" : "($apikey as xs:string, $id as xs:string, $group_name as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Convenience function for list-interest-group-del#5.\n", "summary" : "
     Convenience function for  list-interest-group-del#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "group_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest group to delete
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     The grouping to delete the group from - get using list-interest-groupings() . If not supplied, the first grouping on the list is used.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-interest-group-del", "qname" : "mailchimp:list-interest-group-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $group_name as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Delete a single Interest Group - if the last group for a list is deleted, this will also turn groups for the list off.\n", "summary" : "
     Delete a single Interest Group - if the last group for a list is deleted, this will also turn groups for the list off.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "group_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest group to delete
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     The grouping to delete the group from - get using list-interest-groupings() . If not supplied, the first grouping on the list is used.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-interest-group-update", "qname" : "mailchimp:list-interest-group-update", "signature" : "($apikey as xs:string, $id as xs:string, $old_name as xs:string, $new_name as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Convenience function for list-interest-group-update#6.\n", "summary" : "
     Convenience function for  list-interest-group-update#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "old_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest group name to be changed
    " }, { "name" : "new_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the new interest group name to be set
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     ouping_id The grouping to delete the group from - get using list-interest-groupings() . If not supplied, the first grouping on the list is used.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-interest-group-update", "qname" : "mailchimp:list-interest-group-update", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $old_name as xs:string, $new_name as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Change the name of an Interest Group.\n", "summary" : "
     Change the name of an Interest Group.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "old_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest group name to be changed
    " }, { "name" : "new_name", "type" : "xs:string", "occurrence" : null, "description" : "
     the new interest group name to be set
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     ouping_id The grouping to delete the group from - get using list-interest-groupings() . If not supplied, the first grouping on the list is used.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-interest-grouping-add", "qname" : "mailchimp:list-interest-grouping-add", "signature" : "($apikey as xs:string, $id as xs:string, $name as xs:string, $type as xs:string, $groups as element(array)) as item()*", "description" : " Convenience function for list-interest-grouping-add#6.\n", "summary" : "
     Convenience function for  list-interest-grouping-add#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest grouping to add - grouping names must be unique
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     The type of the grouping to add - one of \"checkboxes\", \"hidden\", \"dropdown\", \"radio\"
    " }, { "name" : "groups", "type" : "element(array)", "occurrence" : null, "description" : "
     The lists of initial group names to be added - at least 1 is required and the names must be unique within a grouping. If the number takes you over the 60 group limit, an error will be thrown.
    " } ], "returns" : { "type" : "item()*", "description" : "The new grouping id if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-interest-grouping-add", "qname" : "mailchimp:list-interest-grouping-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $name as xs:string, $type as xs:string, $groups as element(array)) as item()*", "description" : " Add a new Interest Grouping - if interest groups for the List are not yet enabled, adding the first grouping will automatically turn them on.\n", "summary" : "
     Add a new Interest Grouping - if interest groups for the List are not yet enabled, adding the first grouping will automatically turn them on.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the interest grouping to add - grouping names must be unique
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     The type of the grouping to add - one of \"checkboxes\", \"hidden\", \"dropdown\", \"radio\"
    " }, { "name" : "groups", "type" : "element(array)", "occurrence" : null, "description" : "
     The lists of initial group names to be added - at least 1 is required and the names must be unique within a grouping. If the number takes you over the 60 group limit, an error will be thrown.
    " } ], "returns" : { "type" : "item()*", "description" : "The new grouping id if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-interest-grouping-del", "qname" : "mailchimp:list-interest-grouping-del", "signature" : "($apikey as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Convenience function for list-interest-grouping-del#3.\n", "summary" : "
     Convenience function for  list-interest-grouping-del#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the interest grouping id - get from list-interest-groupings()
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-interest-grouping-del", "qname" : "mailchimp:list-interest-grouping-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $grouping_id as xs:integer) as item()*", "description" : " Delete an existing Interest Grouping - this will permanently delete all contained interest groups and will remove those selections from all list members.\n", "summary" : "
     Delete an existing Interest Grouping - this will permanently delete all contained interest groups and will remove those selections from all list members.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the interest grouping id - get from list-interest-groupings()
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-interest-grouping-update", "qname" : "mailchimp:list-interest-grouping-update", "signature" : "($apikey as xs:string, $grouping_id as xs:integer, $name as xs:string, $value as xs:string) as item()*", "description" : " Convenience function for list-interest-grouping-update#5.\n", "summary" : "
     Convenience function for  list-interest-grouping-update#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the interest grouping id - get from list-interest-groupings()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the field to update - either \"name\" or \"type\". Groups with in the grouping should be manipulated using the standard listInterestGroup* methods
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     The new value of the field. Grouping names must be unique - only \"hidden\" and \"checkboxes\" grouping types can be converted between each other.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-interest-grouping-update", "qname" : "mailchimp:list-interest-grouping-update", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $grouping_id as xs:integer, $name as xs:string, $value as xs:string) as item()*", "description" : " Update an existing Interest Grouping.\n", "summary" : "
     Update an existing Interest Grouping.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "grouping_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the interest grouping id - get from list-interest-groupings()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the field to update - either \"name\" or \"type\". Groups with in the grouping should be manipulated using the standard listInterestGroup* methods
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     The new value of the field. Grouping names must be unique - only \"hidden\" and \"checkboxes\" grouping types can be converted between each other.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-interest-groupings", "qname" : "mailchimp:list-interest-groupings", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-interest-groupings#3.\n", "summary" : "
     Convenience function for  list-interest-groupings#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "List of interest groups for the list" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-interest-groupings", "qname" : "mailchimp:list-interest-groupings", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Get the list of interest groupings for a given list, including the label, form information, and included groups for each.\n", "summary" : "
     Get the list of interest groupings for a given list, including the label, form information, and included groups for each.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "List of interest groups for the list" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-locations", "qname" : "mailchimp:list-locations", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-locations#3.\n", "summary" : "
     Convenience function for  list-locations#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "Array of locations" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-locations", "qname" : "mailchimp:list-locations", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Retrieve the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.\n", "summary" : "
     Retrieve the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "Array of locations" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-member-activity", "qname" : "mailchimp:list-member-activity", "signature" : "($apikey as xs:string, $id as xs:string, $email_address as element(array)) as item()*", "description" : " Convenience function for list-member-activity#4.\n", "summary" : "
     Convenience function for  list-member-activity#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of up to 50 email addresses to get information for OR the \"id\"(s) for the member returned from listMembers, Webhooks, and Campaigns.
    " } ], "returns" : { "type" : "item()*", "description" : "Array of data and success/error counts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-member-activity", "qname" : "mailchimp:list-member-activity", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $email_address as element(array)) as item()*", "description" : " Get the most recent 100 activities for particular list members (open, click, bounce, unsub, abuse, sent to).\n", "summary" : "
     Get the most recent 100 activities for particular list members (open, click, bounce, unsub, abuse, sent to).
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of up to 50 email addresses to get information for OR the \"id\"(s) for the member returned from listMembers, Webhooks, and Campaigns.
    " } ], "returns" : { "type" : "item()*", "description" : "Array of data and success/error counts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-member-info", "qname" : "mailchimp:list-member-info", "signature" : "($apikey as xs:string, $id as xs:string, $email_address as element(array)) as item()*", "description" : " Convenience function for list-member-info#4.\n", "summary" : "
     Convenience function for  list-member-info#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of up to 50 email addresses to get information for OR the \"id\"(s) for the member returned from listMembers, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).
    " } ], "returns" : { "type" : "item()*", "description" : "Array of list members with their info in an array (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-member-info", "qname" : "mailchimp:list-member-info", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $email_address as element(array)) as item()*", "description" : " Get all the information for particular members of a list.\n", "summary" : "
     Get all the information for particular members of a list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of up to 50 email addresses to get information for OR the \"id\"(s) for the member returned from listMembers, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).
    " } ], "returns" : { "type" : "item()*", "description" : "Array of list members with their info in an array (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-members", "qname" : "mailchimp:list-members", "signature" : "($apikey as xs:string, $id as xs:string, $status as xs:string, $since as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for list-members#7.\n", "summary" : "
     Convenience function for  list-members#7 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "
     the status to get members for - one of(subscribed, unsubscribed, cleaned, updated), defaults to subscribed
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull all members whose status (subscribed/unsubscribed/cleaned) has changed or whose profile (updated) has changed since this date/time (in GMT) - format is YYYY-MM-DD HH:mm:ss (24hr)
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array of a the total records match and matching list member data for this page (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 7, "name" : "list-members", "qname" : "mailchimp:list-members", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $status as xs:string, $since as xs:string, $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Get all of the list members for a list that are of a particular status.\n", "summary" : "
     Get all of the list members for a list that are of a particular status.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "
     the status to get members for - one of(subscribed, unsubscribed, cleaned, updated), defaults to subscribed
    " }, { "name" : "since", "type" : "xs:string", "occurrence" : null, "description" : "
     optional pull all members whose status (subscribed/unsubscribed/cleaned) has changed or whose profile (updated) has changed since this date/time (in GMT) - format is YYYY-MM-DD HH:mm:ss (24hr)
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional for large data sets, the number of results to return - defaults to 100, upper limit set at 15000
    " } ], "returns" : { "type" : "item()*", "description" : "Array of a the total records match and matching list member data for this page (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-merge-var-add", "qname" : "mailchimp:list-merge-var-add", "signature" : "($apikey as xs:string, $id as xs:string, $tag as xs:string, $name as xs:string, $options as element(array)) as item()*", "description" : " Convenience function for list-merge-var-add#6.\n", "summary" : "
     Convenience function for  list-merge-var-add#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "tag", "type" : "xs:string", "occurrence" : null, "description" : "
     The merge tag to add, e.g. FNAME
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The long description of the tag being added, used for user displays
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     optional Various options for this merge var. note: for historical purposes this can also take a \"boolean\"
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-merge-var-add", "qname" : "mailchimp:list-merge-var-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $tag as xs:string, $name as xs:string, $options as element(array)) as item()*", "description" : " Add a new merge tag to a given list.\n", "summary" : "
     Add a new merge tag to a given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "tag", "type" : "xs:string", "occurrence" : null, "description" : "
     The merge tag to add, e.g. FNAME
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The long description of the tag being added, used for user displays
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     optional Various options for this merge var. note: for historical purposes this can also take a \"boolean\"
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-merge-var-del", "qname" : "mailchimp:list-merge-var-del", "signature" : "($apikey as xs:string, $id as xs:string, $tag as xs:string) as item()*", "description" : " Convenience function for list-merge-var-del#4.\n", "summary" : "
     Convenience function for  list-merge-var-del#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "tag", "type" : "xs:string", "occurrence" : null, "description" : "
     The merge tag to delete
    " } ], "returns" : { "type" : "item()*", "description" : "bool true if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-merge-var-del", "qname" : "mailchimp:list-merge-var-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $tag as xs:string) as item()*", "description" : " Delete a merge tag from a given list and all its members. Seriously - the data is removed from all members as well! Note that on large lists this method may seem a bit slower than calls you typically make.\n", "summary" : "
     Delete a merge tag from a given list and all its members.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "tag", "type" : "xs:string", "occurrence" : null, "description" : "
     The merge tag to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-merge-var-update", "qname" : "mailchimp:list-merge-var-update", "signature" : "($apikey as xs:string, $id as xs:string, $tag as xs:string, $options as element(array)) as item()*", "description" : " Convenience function for list-merge-var-update#5.\n", "summary" : "
     Convenience function for  list-merge-var-update#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "tag", "type" : "xs:string", "occurrence" : null, "description" : "
     The merge tag to update
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     The options to change for a merge var. See list-merge-var-add() for valid options
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-merge-var-update", "qname" : "mailchimp:list-merge-var-update", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $tag as xs:string, $options as element(array)) as item()*", "description" : " Update most parameters for a merge tag on a given list. You cannot currently change the merge type.\n", "summary" : "
     Update most parameters for a merge tag on a given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "tag", "type" : "xs:string", "occurrence" : null, "description" : "
     The merge tag to update
    " }, { "name" : "options", "type" : "element(array)", "occurrence" : null, "description" : "
     The options to change for a merge var. See list-merge-var-add() for valid options
    " } ], "returns" : { "type" : "item()*", "description" : "True if the request succeeds, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-merge-vars", "qname" : "mailchimp:list-merge-vars", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-merge-vars#3.\n", "summary" : "
     Convenience function for  list-merge-vars#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "List of merge tags for the list" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-merge-vars", "qname" : "mailchimp:list-merge-vars", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Get the list of merge tags for a given list, including their name, tag, and required setting.\n", "summary" : "
     Get the list of merge tags for a given list, including their name, tag, and required setting.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "List of merge tags for the list" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-static-segment-add", "qname" : "mailchimp:list-static-segment-add", "signature" : "($apikey as xs:string, $id as xs:string, $name as xs:string) as item()*", "description" : " Convenience function for list-static-segment-add#4.\n", "summary" : "
     Convenience function for  list-static-segment-add#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     a unique name per list for the segment - 50 byte maximum length, anything longer will throw an error
    " } ], "returns" : { "type" : "item()*", "description" : "The id of the new segment, otherwise an error will be thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-static-segment-add", "qname" : "mailchimp:list-static-segment-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $name as xs:string) as item()*", "description" : " Save a segment against a list for later use. There is no limit to the number of segments which can be saved. Static Segments are not tied to any merge data, interest groups, etc. They essentially allow you to configure an unlimited number of custom segments which will have standard performance. When using proper segments, Static Segments are one of the available options for segmentation just as if you used a merge var (and they can be used with other segmentation options), though performance may degrade at that point.\n", "summary" : "
     Save a segment against a list for later use.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     a unique name per list for the segment - 50 byte maximum length, anything longer will throw an error
    " } ], "returns" : { "type" : "item()*", "description" : "The id of the new segment, otherwise an error will be thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-static-segment-del", "qname" : "mailchimp:list-static-segment-del", "signature" : "($apikey as xs:string, $id as xs:string, $seg_id as xs:integer) as item()*", "description" : " Convenience function for list-static-segment-del#4.\n", "summary" : "
     Convenience function for  list-static-segment-del#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to delete - get from list-static-segments()
    " } ], "returns" : { "type" : "item()*", "description" : "True if it worked, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-static-segment-del", "qname" : "mailchimp:list-static-segment-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $seg_id as xs:integer) as item()*", "description" : " Delete a static segment. Note that this will, of course, remove any member affiliations with the segment.\n", "summary" : "
     Delete a static segment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to delete - get from list-static-segments()
    " } ], "returns" : { "type" : "item()*", "description" : "True if it worked, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-static-segment-members-add", "qname" : "mailchimp:list-static-segment-members-add", "signature" : "($apikey as xs:string, $id as xs:string, $seg_id as xs:integer, $batch as element(array)) as item()*", "description" : " Convenience function for list-static-segment-members-add#5.\n", "summary" : "
     Convenience function for  list-static-segment-members-add#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to modify - get from list-static-segments()
    " }, { "name" : "batch", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of email addresses and/or unique_ids to add to the segment
    " } ], "returns" : { "type" : "item()*", "description" : "An array with the results of the operation" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-static-segment-members-add", "qname" : "mailchimp:list-static-segment-members-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $seg_id as xs:integer, $batch as element(array)) as item()*", "description" : " Add list members to a static segment. It is suggested that you limit batch size to no more than 10,000 addresses per call. Email addresses must exist on the list in order to be included - this will not subscribe them to the list!.\n", "summary" : "
     Add list members to a static segment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to modify - get from list-static-segments()
    " }, { "name" : "batch", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of email addresses and/or unique_ids to add to the segment
    " } ], "returns" : { "type" : "item()*", "description" : "array an array with the results of the operation" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-static-segment-members-del", "qname" : "mailchimp:list-static-segment-members-del", "signature" : "($apikey as xs:string, $id as xs:string, $seg_id as xs:integer, $batch as element(array)) as item()*", "description" : " Convenience function for list-static-segment-members-del#5.\n", "summary" : "
     Convenience function for  list-static-segment-members-del#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to delete - get from list-static-segments()
    " }, { "name" : "batch", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of email addresses and/or unique_ids to remove from the segment
    " } ], "returns" : { "type" : "item()*", "description" : "An array with the results of the operation" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-static-segment-members-del", "qname" : "mailchimp:list-static-segment-members-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $seg_id as xs:integer, $batch as element(array)) as item()*", "description" : " Remove list members from a static segment. It is suggested that you limit batch size to no more than 10,000 addresses per call. Email addresses must exist on the list in order to be removed - this will not unsubscribe them from the list!.\n", "summary" : "
     Remove list members from a static segment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to delete - get from list-static-segments()
    " }, { "name" : "batch", "type" : "element(array)", "occurrence" : null, "description" : "
     an array of email addresses and/or unique_ids to remove from the segment
    " } ], "returns" : { "type" : "item()*", "description" : "An array with the results of the operation" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-static-segment-reset", "qname" : "mailchimp:list-static-segment-reset", "signature" : "($apikey as xs:string, $id as xs:string, $seg_id as xs:integer) as item()*", "description" : " Convenience function for list-static-segment-reset#4.\n", "summary" : "
     Convenience function for  list-static-segment-reset#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to reset - get from list-static-segments()
    " } ], "returns" : { "type" : "item()*", "description" : "True if it worked, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-static-segment-reset", "qname" : "mailchimp:list-static-segment-reset", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $seg_id as xs:integer) as item()*", "description" : " Resets a static segment - removes all members from the static segment. Note: does not actually affect list member data.\n", "summary" : "
     Resets a static segment - removes  all  members from the static segment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "seg_id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the static segment to reset - get from list-static-segments()
    " } ], "returns" : { "type" : "item()*", "description" : "True if it worked, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-static-segments", "qname" : "mailchimp:list-static-segments", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-static-segments#3.\n", "summary" : "
     Convenience function for  list-static-segments#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "An array of parameters for each static segment" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-static-segments", "qname" : "mailchimp:list-static-segments", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Retrieve all of the Static Segments for a list.\n", "summary" : "
     Retrieve all of the Static Segments for a list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "An array of parameters for each static segment" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 10, "name" : "list-subscribe", "qname" : "mailchimp:list-subscribe", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $email_address as xs:string, $merge_vars as element(array), $email_type as xs:string, $double_optin as xs:boolean, $update_existing as xs:boolean, $replace_interests as xs:boolean, $send_welcome as xs:boolean) as item()*", "description" : " Subscribe the provided email to a list.\n", "summary" : "
     Subscribe the provided email to a list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to subscribe
    " }, { "name" : "merge_vars", "type" : "element(array)", "occurrence" : null, "description" : "
     optional merges for the email (FNAME, LNAME, etc.) (see examples below for handling \"blank\" arrays). Note that a merge field can only hold up to 255 bytes. Also, there are a few \"special\" keys. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "email_type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional email type preference for the email (html, text, or mobile defaults to html)
    " }, { "name" : "double_optin", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional flag to control whether a double opt-in confirmation message is sent, defaults to true. Abusing this may cause your account to be suspended.
    " }, { "name" : "update_existing", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional flag to control whether a existing subscribers should be updated instead of throwing and error, defaults to false
    " }, { "name" : "replace_interests", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional flag to determine whether we replace the interest groups with the groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true)
    " }, { "name" : "send_welcome", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional if your double_optin is false and this is true, we will send your lists Welcome Email if this subscribe succeeds - this will *not* fire if we end up updating an existing subscriber. If double_optin is true, this has no effect. defaults to false.
    " } ], "returns" : { "type" : "item()*", "description" : "True on success, false on failure." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 9, "name" : "list-subscribe", "qname" : "mailchimp:list-subscribe", "signature" : "($apikey as xs:string, $id as xs:string, $email_address as xs:string, $merge_vars as element(array), $email_type as xs:string, $double_optin as xs:boolean, $update_existing as xs:boolean, $replace_interests as xs:boolean, $send_welcome as xs:boolean) as item()*", "description" : " Convenience function for list-subscribe#10.\n", "summary" : "
     Convenience function for  list-subscribe#10 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to subscribe
    " }, { "name" : "merge_vars", "type" : "element(array)", "occurrence" : null, "description" : "
     optional merges for the email (FNAME, LNAME, etc.) (see examples below for handling \"blank\" arrays). Note that a merge field can only hold up to 255 bytes. Also, there are a few \"special\" keys. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "email_type", "type" : "xs:string", "occurrence" : null, "description" : "
     optional email type preference for the email (html, text, or mobile defaults to html)
    " }, { "name" : "double_optin", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional flag to control whether a double opt-in confirmation message is sent, defaults to true. Abusing this may cause your account to be suspended.
    " }, { "name" : "update_existing", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional flag to control whether a existing subscribers should be updated instead of throwing and error, defaults to false
    " }, { "name" : "replace_interests", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional flag to determine whether we replace the interest groups with the groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true)
    " }, { "name" : "send_welcome", "type" : "xs:boolean", "occurrence" : null, "description" : "
     optional if your double_optin is false and this is true, we will send your lists Welcome Email if this subscribe succeeds - this will *not* fire if we end up updating an existing subscriber. If double_optin is true, this has no effect. defaults to false.
    " } ], "returns" : { "type" : "item()*", "description" : "True on success, false on failure." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-unsubscribe", "qname" : "mailchimp:list-unsubscribe", "signature" : "($apikey as xs:string, $id as xs:string, $email_address as xs:string, $delete_member as xs:boolean, $send_goodbye as xs:boolean, $send_notify as xs:boolean) as item()*", "description" : " Convenience function for list-unsubscribe#7.\n", "summary" : "
     Convenience function for  list-unsubscribe#7 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to unsubscribe OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns
    " }, { "name" : "delete_member", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to completely delete the member from your list instead of just unsubscribing, default to false
    " }, { "name" : "send_goodbye", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the goodbye email to the email address, defaults to true
    " }, { "name" : "send_notify", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to true
    " } ], "returns" : { "type" : "item()*", "description" : "True on success, false on failure." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 7, "name" : "list-unsubscribe", "qname" : "mailchimp:list-unsubscribe", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $email_address as xs:string, $delete_member as xs:boolean, $send_goodbye as xs:boolean, $send_notify as xs:boolean) as item()*", "description" : " Unsubscribe the given email address from the list.\n", "summary" : "
     Unsubscribe the given email address from the list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to unsubscribe OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns
    " }, { "name" : "delete_member", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to completely delete the member from your list instead of just unsubscribing, default to false
    " }, { "name" : "send_goodbye", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the goodbye email to the email address, defaults to true
    " }, { "name" : "send_notify", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to true
    " } ], "returns" : { "type" : "item()*", "description" : "True on success, false on failure." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-update-member", "qname" : "mailchimp:list-update-member", "signature" : "($apikey as xs:string, $id as xs:string, $email_address as xs:string, $merge_vars as element(array), $email_type as xs:string, $replace_interests as xs:boolean) as item()*", "description" : " Convenience function for list-update-member#7.\n", "summary" : "
     Convenience function for  list-update-member#7 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the current email address of the member to update OR the \"id\" for the member returned from listMemberInfo, Webhooks, and Campaigns
    " }, { "name" : "merge_vars", "type" : "element(array)", "occurrence" : null, "description" : "
     array of new field values to update the member with. See merge_vars in list-subscribe() for details.
    " }, { "name" : "email_type", "type" : "xs:string", "occurrence" : null, "description" : "
     change the email type preference for the member (\"html\", \"text\", or \"mobile\"). Leave blank to keep the existing preference (optional)
    " }, { "name" : "replace_interests", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true)
    " } ], "returns" : { "type" : "item()*", "description" : "True on success, false on failure." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 7, "name" : "list-update-member", "qname" : "mailchimp:list-update-member", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $email_address as xs:string, $merge_vars as element(array), $email_type as xs:string, $replace_interests as xs:boolean) as item()*", "description" : " Edit the email address, merge fields, and interest groups for a list member. If you are doing a batch update on lots of users, consider using #list-batch-subscribe() with the update_existing and possible replace_interests parameter.\n", "summary" : "
     Edit the email address, merge fields, and interest groups for a list member.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the current email address of the member to update OR the \"id\" for the member returned from listMemberInfo, Webhooks, and Campaigns
    " }, { "name" : "merge_vars", "type" : "element(array)", "occurrence" : null, "description" : "
     array of new field values to update the member with. See merge_vars in list-subscribe() for details.
    " }, { "name" : "email_type", "type" : "xs:string", "occurrence" : null, "description" : "
     change the email type preference for the member (\"html\", \"text\", or \"mobile\"). Leave blank to keep the existing preference (optional)
    " }, { "name" : "replace_interests", "type" : "xs:boolean", "occurrence" : null, "description" : "
     flag to determine whether we replace the interest groups with the updated groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true)
    " } ], "returns" : { "type" : "item()*", "description" : "True on success, false on failure." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "list-webhook-add", "qname" : "mailchimp:list-webhook-add", "signature" : "($apikey as xs:string, $id as xs:string, $url as xs:string, $actions as element(array), $sources as element(array)) as item()*", "description" : " Convenience function for list-webhook-add#6.\n", "summary" : "
     Convenience function for  list-webhook-add#6 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid URL for the Webhook - it will be validated. note that a url may only exist on a list once.
    " }, { "name" : "actions", "type" : "element(array)", "occurrence" : null, "description" : "
     optional a hash of actions to fire this Webhook for
    " }, { "name" : "sources", "type" : "element(array)", "occurrence" : null, "description" : "
     optional a hash of sources to fire this Webhook for
    " } ], "returns" : { "type" : "item()*", "description" : "True if the call succeeds, otherwise an exception will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "list-webhook-add", "qname" : "mailchimp:list-webhook-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $url as xs:string, $actions as element(array), $sources as element(array)) as item()*", "description" : " Add a new Webhook URL for the given list.\n", "summary" : "
     Add a new Webhook URL for the given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid URL for the Webhook - it will be validated. note that a url may only exist on a list once.
    " }, { "name" : "actions", "type" : "element(array)", "occurrence" : null, "description" : "
     optional a hash of actions to fire this Webhook for
    " }, { "name" : "sources", "type" : "element(array)", "occurrence" : null, "description" : "
     optional a hash of sources to fire this Webhook for
    " } ], "returns" : { "type" : "item()*", "description" : "True if the call succeeds, otherwise an exception will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-webhook-del", "qname" : "mailchimp:list-webhook-del", "signature" : "($apikey as xs:string, $id as xs:string, $url as xs:string) as item()*", "description" : " Convenience function for list-webhook-del#4.\n", "summary" : "
     Convenience function for  list-webhook-del#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     the URL of a Webhook on this list
    " } ], "returns" : { "type" : "item()*", "description" : "True if the call succeeds, otherwise an exception will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "list-webhook-del", "qname" : "mailchimp:list-webhook-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string, $url as xs:string) as item()*", "description" : " Delete an existing Webhook URL from a given list.\n", "summary" : "
     Delete an existing Webhook URL from a given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " }, { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     the URL of a Webhook on this list
    " } ], "returns" : { "type" : "item()*", "description" : "True if the call succeeds, otherwise an exception will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-webhooks", "qname" : "mailchimp:list-webhooks", "signature" : "($apikey as xs:string, $id as xs:string) as item()*", "description" : " Convenience function for list-webhooks#3.\n", "summary" : "
     Convenience function for  list-webhooks#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "List of webhooks" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "list-webhooks", "qname" : "mailchimp:list-webhooks", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:string) as item()*", "description" : " Return the Webhooks configured for the given list.\n", "summary" : "
     Return the Webhooks configured for the given list.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the list id to connect to. Get by calling lists()
    " } ], "returns" : { "type" : "item()*", "description" : "List of webhooks" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "lists-for-email", "qname" : "mailchimp:lists-for-email", "signature" : "($apikey as xs:string, $email_address as xs:string) as item()*", "description" : " Convenience function for lists-for-email#3.\n", "summary" : "
     Convenience function for  lists-for-email#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to check OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns
    " } ], "returns" : { "type" : "item()*", "description" : "An array of list_ids the member is subscribed to." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "lists-for-email", "qname" : "mailchimp:lists-for-email", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $email_address as xs:string) as item()*", "description" : " Retrieve all List Ids a member is subscribed to.\n", "summary" : "
     Retrieve all List Ids a member is subscribed to.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "email_address", "type" : "xs:string", "occurrence" : null, "description" : "
     the email address to check OR the email \"id\" returned from listMemberInfo, Webhooks, and Campaigns
    " } ], "returns" : { "type" : "item()*", "description" : "An array of list_ids the member is subscribed to." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "lists", "qname" : "mailchimp:lists", "signature" : "($apikey as xs:string, $filters as element(array), $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Convenience function for lists#5.\n", "summary" : "
     Convenience function for  lists#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "filters", "type" : "element(array)", "occurrence" : null, "description" : "
     a hash of filters to apply to this query - all are optional. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of lists, start results at this list #, defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of lists, number of lists to return with each call, defaults to 25 (max=100)
    " } ], "returns" : { "type" : "item()*", "description" : "Array with keys listed in Returned Fields below" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "lists", "qname" : "mailchimp:lists", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $filters as element(array), $start as xs:integer, $limit as xs:integer) as item()*", "description" : " Retrieve all of the lists defined for your user account.\n", "summary" : "
     Retrieve all of the lists defined for your user account.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "filters", "type" : "element(array)", "occurrence" : null, "description" : "
     a hash of filters to apply to this query - all are optional. See Mailchimp API documentation for more information about the parameter structure.
    " }, { "name" : "start", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of lists, start results at this list #, defaults to 1st page of data (page 0)
    " }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "
     optional - control paging of lists, number of lists to return with each call, defaults to 25 (max=100)
    " } ], "returns" : { "type" : "item()*", "description" : "Array with keys listed in Returned Fields below" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "ping", "qname" : "mailchimp:ping", "signature" : "($apikey as xs:string) as item()*", "description" : " Convenience function for ping#2.\n", "summary" : "
     Convenience function for  ping#2 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "Returns \"Everything's Chimpy!\" if everything is chimpy, otherwise returns an error message" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "ping", "qname" : "mailchimp:ping", "signature" : "($endpoint-url as xs:string, $apikey as xs:string) as item()*", "description" : " \"Ping\" the MailChimp API - a simple method you can call that will return a constant value as long as everything is good. Note than unlike most all of our methods, we don't throw an Exception if we are having issues. You will simply receive a different string back that will explain our view on what is going on.\n", "summary" : "
     \"Ping\" the MailChimp API - a simple method you can call that will return a constant value as long as everything is good.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " } ], "returns" : { "type" : "item()*", "description" : "Returns \"Everything's Chimpy!\" if everything is chimpy, otherwise returns an error message" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "template-add", "qname" : "mailchimp:template-add", "signature" : "($apikey as xs:string, $name as xs:string, $html as xs:string) as item()*", "description" : " Convenience function for template-add#4.\n", "summary" : "
     Convenience function for  template-add#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name for the template - names must be unique and a max of 50 bytes
    " }, { "name" : "html", "type" : "xs:string", "occurrence" : null, "description" : "
     a string specifying the entire template to be created. This is NOT campaign content. They are intended to utilize our template language.
    " } ], "returns" : { "type" : "item()*", "description" : "The new template id, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "template-add", "qname" : "mailchimp:template-add", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $name as xs:string, $html as xs:string) as item()*", "description" : " Create a new user template, NOT campaign content. These templates can then be applied while creating campaigns.\n", "summary" : "
     Create a new user template,  NOT  campaign content.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name for the template - names must be unique and a max of 50 bytes
    " }, { "name" : "html", "type" : "xs:string", "occurrence" : null, "description" : "
     a string specifying the entire template to be created. This is NOT campaign content. They are intended to utilize our template language.
    " } ], "returns" : { "type" : "item()*", "description" : "The new template id, otherwise an error is thrown." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "template-del", "qname" : "mailchimp:template-del", "signature" : "($apikey as xs:string, $id as xs:integer) as item()*", "description" : " Convenience function for template-del#3.\n", "summary" : "
     Convenience function for  template-del#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the user template to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if the template was deleted, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "template-del", "qname" : "mailchimp:template-del", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:integer) as item()*", "description" : " Delete (deactivate) a user template.\n", "summary" : "
     Delete (deactivate) a user template.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the user template to delete
    " } ], "returns" : { "type" : "item()*", "description" : "True if the template was deleted, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "template-info", "qname" : "mailchimp:template-info", "signature" : "($apikey as xs:string, $tid as xs:integer, $type as xs:string) as item()*", "description" : " Convenience function for template-info#4.\n", "summary" : "
     Convenience function for  template-info#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "tid", "type" : "xs:integer", "occurrence" : null, "description" : "
     the template id - get from templates()
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the template type to load - one of 'user', 'gallery', 'base'
    " } ], "returns" : { "type" : "item()*", "description" : "An array of info to be used when editing" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "template-info", "qname" : "mailchimp:template-info", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $tid as xs:integer, $type as xs:string) as item()*", "description" : " Pull details for a specific template to help support editing.\n", "summary" : "
     Pull details for a specific template to help support editing.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "tid", "type" : "xs:integer", "occurrence" : null, "description" : "
     the template id - get from templates()
    " }, { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the template type to load - one of 'user', 'gallery', 'base'
    " } ], "returns" : { "type" : "item()*", "description" : "An array of info to be used when editing" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "template-undel", "qname" : "mailchimp:template-undel", "signature" : "($apikey as xs:string, $id as xs:integer) as item()*", "description" : " Convenience function for template-undel#3.\n", "summary" : "
     Convenience function for  template-undel#3 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the user template to reactivate
    " } ], "returns" : { "type" : "item()*", "description" : "boolean true if the template was deleted, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "template-undel", "qname" : "mailchimp:template-undel", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:integer) as item()*", "description" : " Undelete (reactivate) a user template.\n", "summary" : "
     Undelete (reactivate) a user template.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the user template to reactivate
    " } ], "returns" : { "type" : "item()*", "description" : "boolean true if the template was deleted, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "template-update", "qname" : "mailchimp:template-update", "signature" : "($apikey as xs:string, $id as xs:integer, $values as element(array)) as item()*", "description" : " Convenience function for template-update#4.\n", "summary" : "
     Convenience function for  template-update#4 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the user template to update
    " }, { "name" : "values", "type" : "element(array)", "occurrence" : null, "description" : "
     s the values to updates - while both are optional, at least one should be provided. Both can be updated at the same time.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the template was updated, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "template-update", "qname" : "mailchimp:template-update", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $id as xs:integer, $values as element(array)) as item()*", "description" : " Replace the content of a user template, NOT campaign content.\n", "summary" : "
     Replace the content of a user template,  NOT  campaign content.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "id", "type" : "xs:integer", "occurrence" : null, "description" : "
     the id of the user template to update
    " }, { "name" : "values", "type" : "element(array)", "occurrence" : null, "description" : "
     s the values to updates - while both are optional, at least one should be provided. Both can be updated at the same time.
    " } ], "returns" : { "type" : "item()*", "description" : "True if the template was updated, otherwise an error will be thrown" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "templates", "qname" : "mailchimp:templates", "signature" : "($apikey as xs:string, $types as element(array), $category as xs:string, $inactives as element(array)) as item()*", "description" : " Convenience function for templates#5.\n", "summary" : "
     Convenience function for  templates#5 .
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "types", "type" : "element(array)", "occurrence" : null, "description" : "
     optional the types of templates to return
    " }, { "name" : "category", "type" : "xs:string", "occurrence" : null, "description" : "
     optional for Gallery templates only, limit to a specific template category
    " }, { "name" : "inactives", "type" : "element(array)", "occurrence" : null, "description" : "
     optional options to control how inactive templates are returned, if at all
    " } ], "returns" : { "type" : "item()*", "description" : "An array of structs, one for each template (see Returned Fields for details)" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "templates", "qname" : "mailchimp:templates", "signature" : "($endpoint-url as xs:string, $apikey as xs:string, $types as element(array), $category as xs:string, $inactives as element(array)) as item()*", "description" : " Retrieve various templates available in the system, allowing some thing similar to our template gallery to be created. boolean user Customer template for this user account. Defaults to true. boolean gallery Templates from our Gallery. Note that some templates that require extra configuration are withheld. (eg, the Etsy template). Defaults to false. boolean base Our \"start from scratch\" extremely basic templates boolean include user templates are not deleted, only set inactive. defaults to false. boolean only only include inactive templates. defaults to false.\n", "summary" : "
     Retrieve various templates available in the system, allowing some thing similar to our template gallery to be created.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint-url", "type" : "xs:string", "occurrence" : null, "description" : "
     Mailchimp endpoint URL, e.g. http://us1.api.mailchimp.com/1.3/
    " }, { "name" : "apikey", "type" : "xs:string", "occurrence" : null, "description" : "
     a valid API Key for your user account. Get by visiting your API dashboard
    " }, { "name" : "types", "type" : "element(array)", "occurrence" : null, "description" : "
     optional the types of templates to return
    " }, { "name" : "category", "type" : "xs:string", "occurrence" : null, "description" : "
     optional for Gallery templates only, limit to a specific template category
    " }, { "name" : "inactives", "type" : "element(array)", "occurrence" : null, "description" : "
     optional options to control how inactive templates are returned, if at all
    " } ], "returns" : { "type" : "item()*", "description" : "An array of structs, one for each template (see Returned Fields for details)" }, "errors" : [  ] } ], "variables" : [ { "name" : "mailchimp:gateway", "type" : "item()*", "description" : " Mailchimp gateway where the client data is stored.\n" }, { "name" : "mailchimp:version", "type" : "item()*", "description" : " Mailchimp API version.\n" }, { "name" : "mailchimp:endpoint", "type" : "item()*", "description" : " Endpoint URL for the XML-RPC requests.\n" } ] }, "http://www.zorba-xquery.com/modules/couchbase" : { "ns" : "http://www.zorba-xquery.com/modules/couchbase", "description" : " This module provides minimal functionality to interact with the\n Couchbase NoSQL database.\n The module is built using the libcouchbase C client library and\n exposes most of its functionality in XQuery with JSONiq extensions.\n Beyond just allowing for basic key-value store operations (e.g.\n put-/get-text or put-/get-binary, this module also allows to work\n with Couchbase views in order to allow for complex JSON query\n operations.\n", "sees" : [  ], "authors" : [ "Juan Zacarias" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.zorba-xquery.com/modules/couchbase", "prefix" : "cb" }, { "uri" : "http://jsoniq.org/functions", "prefix" : "jn" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "connect", "qname" : "cb:connect", "signature" : "($options as object()) as xs:anyURI external", "description" : " Connect to the Couchbase server and return an opaque identifier\n representing the established connection.\n", "summary" : "
     Connect to the Couchbase server and return an opaque identifier\n representing the established connection.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     a JSONiq object that contains the host, bucket, and user information.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "an identifier for the established connection. Example:  { \"host\": \"localhost:8091\", \"username\" : null, \"password\" : null, \"bucket\" : \"default\" } " }, "errors" : [ "cb:LCB0001 if the connection to the given host/bucket could not be established.", "cb:CB0001 if mandatory connection information is missing.", "cb:CB0007 if a given option is not supported." ] }, { "isDocumented" : true, "arity" : 4, "name" : "connect", "qname" : "cb:connect", "signature" : "($host as xs:string, $username as xs:string?, $password as xs:string?, $bucket as xs:string) as xs:anyURI", "description" : " Connect to the Couchbase server and return an opaque identifier\n representing the established connection.\n", "summary" : "
     Connect to the Couchbase server and return an opaque identifier\n representing the established connection.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host", "type" : "xs:string", "occurrence" : null, "description" : "
     address of the couchbase server (e.g. \"localhost:8091\")
    " }, { "name" : "username", "type" : "xs:string", "occurrence" : "?", "description" : "
     username used for the connection
    " }, { "name" : "password", "type" : "xs:string", "occurrence" : "?", "description" : "
     password used for the connection
    " }, { "name" : "bucket", "type" : "xs:string", "occurrence" : null, "description" : "
     name of the bucket to use (e.g. \"default\")
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "an identifier for the established connection." }, "errors" : [ "cb:LCB0001 if the connection to the given host/bucket could not be established." ] }, { "isDocumented" : true, "arity" : 3, "name" : "create-view", "qname" : "cb:create-view", "signature" : "($db as xs:anyURI, $doc-name as xs:string, $view-names as xs:string*) as xs:string* external", "description" : " Create a document/view.\n If the document already exists, it is replaced. A document can hold several\n views that must be specified in the same call of cb:create-view.\n", "summary" : "
     Create a document/view.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "doc-name", "type" : "xs:string", "occurrence" : null, "description" : "
     name of the document to create.
    " }, { "name" : "view-names", "type" : "xs:string", "occurrence" : "*", "description" : "
     names of the views to create in the document.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the names of the paths for the views that have been created." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 4, "name" : "create-view", "qname" : "cb:create-view", "signature" : "($db as xs:anyURI, $doc-name as xs:string, $view-names as xs:string*, $options as object()*) as xs:string* external", "description" : " Create a document/view.\n If the document already exists, it is replaced. A document can hold several\n views that must be specified in the same call of cb:create-view.\n", "summary" : "
     Create a document/view.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "doc-name", "type" : "xs:string", "occurrence" : null, "description" : "
     name of the document to create.
    " }, { "name" : "view-names", "type" : "xs:string", "occurrence" : "*", "description" : "
     names of the views to create in the document.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "*", "description" : "
     options describing how to create the view.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the names of the paths for the views that have been created." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0005 if the number of options doesn't match the number of view-names.", "cb:CB0007 if any of the options is not supported.", "cb:CB0010 if any of the given options has an invalid type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete-view", "qname" : "cb:delete-view", "signature" : "($db as xs:anyURI, $doc as xs:string*) as xs:string* external", "description" : " Delete a document/view.\n If the document doesn't exists, function does nothing. All the views hold in the\n Document are deleted, this function can't delete single views.\n", "summary" : "
     Delete a document/view.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "doc", "type" : "xs:string", "occurrence" : "*", "description" : "
    -name name of the document to create.
    " } ], "returns" : { "type" : "xs:string*", "description" : "empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 1, "name" : "flush", "qname" : "cb:flush", "signature" : "($db as xs:anyURI) as empty-sequence() external", "description" : " Remove all key/value pairs from the cluster\n", "summary" : "
     Remove all key/value pairs from the cluster\n
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 2, "name" : "get-binary", "qname" : "cb:get-binary", "signature" : "($db as xs:anyURI, $key as xs:string*) as xs:base64Binary* external", "description" : " Return the values of the given keys (type xs:string) as base64Binary.\n", "summary" : "
     Return the values of the given keys (type xs:string) as base64Binary.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the requested keys
    " } ], "returns" : { "type" : "xs:base64Binary*", "description" : "a sequence of xs:base64Binary items for the given keys." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 3, "name" : "get-binary", "qname" : "cb:get-binary", "signature" : "($db as xs:anyURI, $key as xs:string*, $options as object()) as xs:base64Binary* external", "description" : " Return the values of the given keys (type xs:string) as base64Binary.\n", "summary" : "
     Return the values of the given keys (type xs:string) as base64Binary.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the requested keys
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     JSONiq object with additional options
    " } ], "returns" : { "type" : "xs:base64Binary*", "description" : "a sequence of xs:base64Binary items for the given keys." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0007 if any of the options is not supported.", "cb:CB0009 if the given expiration time is not an xs:integer." ] }, { "isDocumented" : true, "arity" : 2, "name" : "get-text", "qname" : "cb:get-text", "signature" : "($db as xs:anyURI, $key as xs:string*) as xs:string* external", "description" : " Return the values of the given keys (type xs:string) as string.\n", "summary" : "
     Return the values of the given keys (type xs:string) as string.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the requested keys
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of string Items corresponding to the key" }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 3, "name" : "get-text", "qname" : "cb:get-text", "signature" : "($db as xs:anyURI, $key as xs:string*, $options as object()) as xs:string* external", "description" : " Return the values of the given keys (type xs:string) as string.\n", "summary" : "
     Return the values of the given keys (type xs:string) as string.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the requested keys
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     JSONiq object with additional options
    " } ], "returns" : { "type" : "xs:string*", "description" : "a sequence of strings for the given keys." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0006 if the given encoding is not supported.", "cb:CB0007 if any of the options is not supported.", "cb:CB0009 if the given expiration time is not an xs:integer." ] }, { "isDocumented" : true, "arity" : 3, "name" : "put-binary", "qname" : "cb:put-binary", "signature" : "($db as xs:anyURI, $key as xs:string*, $value as xs:base64Binary*) as empty-sequence()", "description" : " Store the given key-value bindings.\n", "summary" : "
     Store the given key-value bindings.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the keys to store
    " }, { "name" : "value", "type" : "xs:base64Binary", "occurrence" : "*", "description" : "
     the values (as xs:base64binary) to be stored.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0005 if the number of keys doesn't match the number of values." ] }, { "isDocumented" : true, "arity" : 4, "name" : "put-binary", "qname" : "cb:put-binary", "signature" : "($db as xs:anyURI, $key as xs:string*, $value as xs:base64Binary*, $options as object()) as empty-sequence() external", "description" : " Store the given key-value bindings.\n", "summary" : "
     Store the given key-value bindings.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the keys to store
    " }, { "name" : "value", "type" : "xs:base64Binary", "occurrence" : "*", "description" : "
     the values (as xs:base64binary) to be stored.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     JSONiq object with additional options
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0005 if the number of keys doesn't match the number of values.", "cb:CB0007 if any of the options is not supported.", "cb:CB0009 if the given expiration time is not an xs:integer.", "cb:CB0011 if the stored Variable was not stored" ] }, { "isDocumented" : true, "arity" : 3, "name" : "put-text", "qname" : "cb:put-text", "signature" : "($db as xs:anyURI, $key as xs:string*, $value as xs:string*) as empty-sequence()", "description" : " Store the given key-value bindings.\n The values are stored with the UTF-8 encoding and a default\n expiration time of 60 seconds.\n", "summary" : "
     Store the given key-value bindings.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the keys to store
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : "*", "description" : "
     the values (as xs:string) to be stored.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0005 if the number of keys doesn't match the number of values." ] }, { "isDocumented" : true, "arity" : 4, "name" : "put-text", "qname" : "cb:put-text", "signature" : "($db as xs:anyURI, $key as xs:string*, $value as xs:string*, $options as object()) as empty-sequence() external", "description" : " Store the given key-value bindings.\n", "summary" : "
     Store the given key-value bindings.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the keys to store
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : "*", "description" : "
     the values (as xs:string) to be stored.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     JSONiq object with additional options
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0005 if the number of keys doesn't match the number of values.", "cb:CB0006 if the given encoding is not supported.", "cb:CB0007 if any of the options is not supported.", "cb:CB0009 if the given expiration time is not an xs:integer.", "cb:CB0011 if the stored Variable was not stored" ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove", "qname" : "cb:remove", "signature" : "($db as xs:anyURI, $key as xs:string*) as empty-sequence() external", "description" : " Remove the values matching the given keys (xs:string) from the server.\n", "summary" : "
     Remove the values matching the given keys (xs:string) from the server.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the keys of the values that should be removed.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 3, "name" : "touch", "qname" : "cb:touch", "signature" : "($db as xs:anyURI, $key as xs:string*, $exp-time as xs:integer) as empty-sequence() external", "description" : " Refresh the expiration time of the given keys.\n", "summary" : "
     Refresh the expiration time of the given keys.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : "*", "description" : "
     the keys to touch
    " }, { "name" : "exp-time", "type" : "xs:integer", "occurrence" : null, "description" : "
     new expieration time in seconds
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "a empty sequence." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 2, "name" : "view", "qname" : "cb:view", "signature" : "($db as xs:anyURI, $path as xs:string*) as object()*", "description" : " Retrieve the content of existing views.\n", "summary" : "
     Retrieve the content of existing views.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "path", "type" : "xs:string", "occurrence" : "*", "description" : "
     contains the string of a view path (e.g. \"_design/test/_view/vies\").
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of strings (as JSON) containing information of the views." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server." ] }, { "isDocumented" : true, "arity" : 3, "name" : "view", "qname" : "cb:view", "signature" : "($db as xs:anyURI, $path as xs:string*, $options as object()) as object()*", "description" : " Retrieve the content of existing views.\n", "summary" : "
     Retrieve the content of existing views.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "db", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     connection reference
    " }, { "name" : "path", "type" : "xs:string", "occurrence" : "*", "description" : "
     contains the string of a view path (e.g. \"_design/test/_view/vies\").
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     JSONiq object with additional options
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of strings (as JSON) containing information of the views." }, "errors" : [ "cb:LCB0002 if any error occurs in the communication with the server.", "cb:CB0007 if any of the options is not supported." ] } ], "variables" : [  ] }, "http://zorba.io/modules/excel/text" : { "ns" : "http://zorba.io/modules/excel/text", "description" : " This is a library module offering the same set of functions\n defined by Microsoft Excel, under Text and Data Functions.\n", "sees" : [ "Excel Documentation: Text Functions" ], "authors" : [ "Sorin Nasoi" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/math", "prefix" : "excel-math" }, { "uri" : "http://zorba.io/modules/excel/text", "prefix" : "excel-text" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "asc", "qname" : "excel-text:asc", "signature" : "($text as xs:string) as xs:string", "description" : " Returns the given $text unchanged.\n", "summary" : "
     Returns the given $text unchanged.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : null, "description" : "
     the time
    " } ], "returns" : { "type" : "xs:string", "description" : "The given $text unchanged." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "char", "qname" : "excel-text:char", "signature" : "($number as xs:integer) as xs:string", "description" : " Returns the character specified by a certain codepoint.\n", "summary" : "
     Returns the character specified by a certain codepoint.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:integer", "occurrence" : null, "description" : "
     the codepoint.
    " } ], "returns" : { "type" : "xs:string", "description" : "the character specified by a certain codepoint." }, "errors" : [ "excel-err:Value provided $number must be in range [1,255]." ] }, { "isDocumented" : true, "arity" : 1, "name" : "clean", "qname" : "excel-text:clean", "signature" : "($arg as xs:string?) as xs:string?", "description" : " Removes all nonprintable characters from text.\n", "summary" : "
     Removes all nonprintable characters from text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string.
    " } ], "returns" : { "type" : "xs:string?", "description" : "Removes all nonprintable characters from text. The CLEAN function was designed. to remove the first 32 nonprinting characters in the 7-bit ASCII code (values 0 through 31) from text. 
     In the Unicode character set, there are additional nonprinting characters (values 127, 129, 141, 143, 144, and 157). 
     By itself, the CLEAN function does not remove these additional nonprinting characters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "code", "qname" : "excel-text:code", "signature" : "($arg as xs:string) as xs:integer", "description" : " Returns a codepoint for the first character in a text string.\n", "summary" : "
     Returns a codepoint for the first character in a text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : null, "description" : "
     the string.
    " } ], "returns" : { "type" : "xs:integer", "description" : "A codepoint for the first character in a text string." }, "errors" : [ "excel-err:Value Provided $arg was empty." ] }, { "isDocumented" : true, "arity" : 1, "name" : "concatenate", "qname" : "excel-text:concatenate", "signature" : "($args as xs:anyAtomicType*) as xs:string", "description" : " Joins several text strings into one text string.\n", "summary" : "
     Joins several text strings into one text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "args", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     a sequence of strings.
    " } ], "returns" : { "type" : "xs:string", "description" : "Joins several text strings into one text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "concatenate", "qname" : "excel-text:concatenate", "signature" : "($arg1 as xs:anyAtomicType?, $arg2 as xs:anyAtomicType?) as xs:string", "description" : " Joins two text strings into one text string.\n", "summary" : "
     Joins two text strings into one text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the first string.
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the second string.
    " } ], "returns" : { "type" : "xs:string", "description" : "Joins two text strings into one text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "dollar", "qname" : "excel-text:dollar", "signature" : "($number as xs:decimal) as xs:string", "description" : " Converts a number to text format and applies a currency symbol. The number of\ndigits to the right of the decimal point is 2.\n", "summary" : "
     Converts a number to text format and applies a currency symbol.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "Converts a number to text format and applies a currency symbol. The number of digits to the right of the decimal point is 2." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "dollar", "qname" : "excel-text:dollar", "signature" : "($number as xs:decimal, $decimals as xs:decimal) as xs:string", "description" : " Converts a number to text format and applies a currency symbol.\n", "summary" : "
     Converts a number to text format and applies a currency symbol.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number.
    " }, { "name" : "decimals", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number of digits to the right of the decimal point. 
     If decimals is negative, number is rounded to the left of the decimal point.
    " } ], "returns" : { "type" : "xs:string", "description" : "Converts a number to text format and applies a currency symbol." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "exact", "qname" : "excel-text:exact", "signature" : "($arg1 as xs:string, $arg2 as xs:string) as xs:boolean", "description" : " Compares two text strings and returns TRUE if they are exactly the same,\nFALSE otherwise. EXACT is case-sensitive but ignores formatting differences.\n", "summary" : "
     Compares two text strings and returns TRUE if they are exactly the same,\nFALSE otherwise.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:string", "occurrence" : null, "description" : "
     the first string.
    " }, { "name" : "arg2", "type" : "xs:string", "occurrence" : null, "description" : "
     the second string.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "Compares two text strings and returns TRUE if they are exactly the same, FALSE otherwise. EXACT is case-sensitive but ignores formatting differences." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "find", "qname" : "excel-text:find", "signature" : "($find_text as xs:string, $within_text as xs:string) as xs:integer?", "description" : " Locate one text string within a second text string, and return the number of the\n starting position of the first text string from the first character of the second text string. 
    \n The search is case sensitive.\n", "summary" : "
     Locate one text string within a second text string, and return the number of the\n starting position of the first text string from the first character of the second text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "find_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to find.
    " }, { "name" : "within_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text in which you want to search for $find_text.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "Locate one text string within a second text string, and return the number of the starting position of the first text string from the first character of the second text string. 
     The search is case sensitive." }, "errors" : [ "excel-err:Value the value is not greater than zero or is greater than the length of within_text.", "excel-err:Value value was not found." ] }, { "isDocumented" : true, "arity" : 3, "name" : "find", "qname" : "excel-text:find", "signature" : "($find_text as xs:string, $within_text as xs:string, $start_num as xs:integer) as xs:integer?", "description" : " Locate one text string within a second text string, and return the number of the\n starting position of the first text string from the first character of the second text string.
    \n The search is case sensitive.\n", "summary" : "
     Locate one text string within a second text string, and return the number of the\n starting position of the first text string from the first character of the second text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "find_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to find.
    " }, { "name" : "within_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text in which you want to search for $find_text.
    " }, { "name" : "start_num", "type" : "xs:integer", "occurrence" : null, "description" : "
     specifies the character at which to start the search.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "Locate one text string within a second text string, and return the number of the starting position of the first text string from the first character of the second text string.
     The search is case sensitive." }, "errors" : [ "excel-err:Value the value is not greater than zero or is greater than the length of within_text.", "excel-err:Value value was not found." ] }, { "isDocumented" : true, "arity" : 2, "name" : "fixed", "qname" : "excel-text:fixed", "signature" : "($number as xs:decimal, $decimals as xs:decimal) as xs:string", "description" : " Rounds a number to the specified number of decimals, formats the number in\n decimal format using a period and commas, and returns the result as text.\n", "summary" : "
     Rounds a number to the specified number of decimals, formats the number in\n decimal format using a period and commas, and returns the result as text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number you want to round and convert to text.
    " }, { "name" : "decimals", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number of digits to the right of the decimal point.
    " } ], "returns" : { "type" : "xs:string", "description" : "Rounds a number to the specified number of decimals, formats the number in decimal format using a period and commas, and returns the result as text." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "fixed", "qname" : "excel-text:fixed", "signature" : "($number as xs:decimal, $decimals as xs:decimal, $no_commas as xs:boolean) as xs:string", "description" : " Rounds a number to the specified number of decimals, formats the number in\ndecimal format using a period and commas, and returns the result as text.\n", "summary" : "
     Rounds a number to the specified number of decimals, formats the number in\ndecimal format using a period and commas, and returns the result as text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "number", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number you want to round and convert to text.
    " }, { "name" : "decimals", "type" : "xs:decimal", "occurrence" : null, "description" : "
     is the number of digits to the right of the decimal point.
    " }, { "name" : "no_commas", "type" : "xs:boolean", "occurrence" : null, "description" : "
     is a logical value that, if TRUE, prevents FIXED from including commas in the returned text.
    " } ], "returns" : { "type" : "xs:string", "description" : "Rounds a number to the specified number of decimals, formats the number in decimal format using a period and commas, and returns the result as text." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "left", "qname" : "excel-text:left", "signature" : "($arg as xs:string) as xs:string", "description" : " Returns the first character in a text string.\n", "summary" : "
     Returns the first character in a text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : null, "description" : "
     is the text string that contains the characters you want to extract.
    " } ], "returns" : { "type" : "xs:string", "description" : "The first character in a text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "left", "qname" : "excel-text:left", "signature" : "($text as xs:string, $num_chars as xs:integer) as xs:string", "description" : " Returns the first character or characters in $text, based on the number of $num_chars you specify.\n", "summary" : "
     Returns the first character or characters in $text, based on the number of $num_chars you specify.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : null, "description" : "
     is the text string that contains the characters you want to extract.
    " }, { "name" : "num_chars", "type" : "xs:integer", "occurrence" : null, "description" : "
     specifies the number of characters you want to extract.
    " } ], "returns" : { "type" : "xs:string", "description" : "The first character or characters in $text, based on the number of $num_chars you specify." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "len", "qname" : "excel-text:len", "signature" : "($arg as xs:string?) as xs:integer", "description" : " Returns the number of characters in a text string.\n", "summary" : "
     Returns the number of characters in a text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The number of characters in a text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "lower", "qname" : "excel-text:lower", "signature" : "($arg as xs:string?) as xs:string?", "description" : " Converts all uppercase letters in a text string to lowercase.\n", "summary" : "
     Converts all uppercase letters in a text string to lowercase.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string.
    " } ], "returns" : { "type" : "xs:string?", "description" : "Converts all uppercase letters in a text string to lowercase." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "mid", "qname" : "excel-text:mid", "signature" : "($text as xs:string?, $start_num as xs:integer, $num_chars as xs:integer) as xs:string?", "description" : " Returns a specific number of characters from a text string, starting at\nthe position you specify, based on the number of characters you specify.\n", "summary" : "
     Returns a specific number of characters from a text string, starting at\nthe position you specify, based on the number of characters you specify.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : "?", "description" : "
     the text string containing the characters you want to extract.
    " }, { "name" : "start_num", "type" : "xs:integer", "occurrence" : null, "description" : "
     the position of the first character you want to extract in text. The first character in text has start_num 1, and so on.
    " }, { "name" : "num_chars", "type" : "xs:integer", "occurrence" : null, "description" : "
     the number of characters you want to return from text.
    " } ], "returns" : { "type" : "xs:string?", "description" : "A specific number of characters from a text string, starting at the position you specify, based on the number of characters you specify." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "pad-integer-to-length", "qname" : "excel-text:pad-integer-to-length", "signature" : "($toPad as xs:anyAtomicType?, $padChar as xs:string, $length as xs:integer) as xs:string", "description" : " Returns $toPad appended with enough repetitions of $padChar to make its length $length, the characters are added before the string.\n", "summary" : "
     Returns $toPad appended with enough repetitions of $padChar to make its length $length, the characters are added before the string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "toPad", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value to be padded.
    " }, { "name" : "padChar", "type" : "xs:string", "occurrence" : null, "description" : "
     the character used for padding.
    " }, { "name" : "length", "type" : "xs:integer", "occurrence" : null, "description" : "
     the desired length.
    " } ], "returns" : { "type" : "xs:string", "description" : "$toPad appended with enough repetitions of $padChar to make its length $length, the characters are added before the string." }, "errors" : [ "excel-err:Value if the length of the $toPad is greater than the desired length." ] }, { "isDocumented" : true, "arity" : 4, "name" : "replace", "qname" : "excel-text:replace", "signature" : "($old_text as xs:string?, $start_num as xs:integer, $num_chars as xs:integer, $new_text as xs:string) as xs:string", "description" : " Replaces part of a text string, based on the number of characters you specify, with a different text string.\n", "summary" : "
     Replaces part of a text string, based on the number of characters you specify, with a different text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "old_text", "type" : "xs:string", "occurrence" : "?", "description" : "
     is text in which you want to replace some characters.
    " }, { "name" : "start_num", "type" : "xs:integer", "occurrence" : null, "description" : "
     the position of the character in old_text that you want to replace with new_text.
    " }, { "name" : "num_chars", "type" : "xs:integer", "occurrence" : null, "description" : "
     the number of characters in old_text that you want REPLACE to replace with new_text.
    " }, { "name" : "new_text", "type" : "xs:string", "occurrence" : null, "description" : "
     the text that will replace characters in old_text.
    " } ], "returns" : { "type" : "xs:string", "description" : "Replaces part of a text string, based on the number of characters you specify, with a different text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "right", "qname" : "excel-text:right", "signature" : "($arg as xs:string) as xs:string", "description" : " Returns the last character in a text string.\n", "summary" : "
     Returns the last character in a text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : null, "description" : "
     the text string containing the characters you want to extract.
    " } ], "returns" : { "type" : "xs:string", "description" : "The last character in a text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "right", "qname" : "excel-text:right", "signature" : "($text as xs:string, $num_chars as xs:integer) as xs:string", "description" : " Returns the last character or characters in a text string, based on the number of characters you specify.\n", "summary" : "
     Returns the last character or characters in a text string, based on the number of characters you specify.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : null, "description" : "
     the text string containing the characters you want to extract.
    " }, { "name" : "num_chars", "type" : "xs:integer", "occurrence" : null, "description" : "
     specifies the number of characters you want RIGHT to extract.
    " } ], "returns" : { "type" : "xs:string", "description" : "The last character or characters in a text string, based on the number of characters you specify." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "search", "qname" : "excel-text:search", "signature" : "($find_text as xs:string, $within_text as xs:string) as xs:integer?", "description" : " Locate one text string within a second text string, and return the number of\n the starting position of the first text string from the first character of the\n second text string. 
     The search starts at position 1, and it is not case sensitive.\n", "summary" : "
     Locate one text string within a second text string, and return the number of\n the starting position of the first text string from the first character of the\n second text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "find_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to find.
    " }, { "name" : "within_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text in which you want to search for $find_text.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "Locate one text string within a second text string, and return the number of the starting position of the first text string from the first character of the second text string. 
     The search starts at position 1, and it is not case sensitive." }, "errors" : [ "excel-err:Value the value is not greater than zero or is greater than the length of within_text.", "excel-err:Value value was not found." ] }, { "isDocumented" : true, "arity" : 3, "name" : "search", "qname" : "excel-text:search", "signature" : "($find_text as xs:string, $within_text as xs:string, $start_num as xs:integer) as xs:integer?", "description" : " Locate one text string within a second text string, and return the number of\n the starting position of the first text string from the first character of the\n second text string.
     The search starts at $start_num, and it is not case sensitive.\n", "summary" : "
     Locate one text string within a second text string, and return the number of\n the starting position of the first text string from the first character of the\n second text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "find_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to find.
    " }, { "name" : "within_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text in which you want to search for $find_text.
    " }, { "name" : "start_num", "type" : "xs:integer", "occurrence" : null, "description" : "
     the character number in within_text at which you want to start searching.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "Locate one text string within a second text string, and return the number of the starting position of the first text string from the first character of the second text string.
     The search starts at $start_num, and it is not case sensitive." }, "errors" : [ "excel-err:Value the value is not greater than zero or is greater than the length of within_text.", "excel-err:Value value was not found." ] }, { "isDocumented" : true, "arity" : 3, "name" : "substitute", "qname" : "excel-text:substitute", "signature" : "($text as xs:string, $old_text as xs:string, $new_text as xs:string) as xs:string?", "description" : " Substitutes new_text for old_text in a text string. Every occurrence of old_text in text is changed to new_text.\n", "summary" : "
     Substitutes new_text for old_text in a text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : null, "description" : "
     the text or the reference to a cell containing text for which you want to substitute characters.
    " }, { "name" : "old_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to replace.
    " }, { "name" : "new_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to replace old_text with.
    " } ], "returns" : { "type" : "xs:string?", "description" : "Substitutes new_text for old_text in a text string. Every occurrence of old_text in text is changed to new_text." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "substitute", "qname" : "excel-text:substitute", "signature" : "($text as xs:string, $old_text as xs:string, $new_text as xs:string, $instance_num as xs:integer?) as xs:string", "description" : " Substitutes new_text for old_text in a text string.\n", "summary" : "
     Substitutes new_text for old_text in a text string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : null, "description" : "
     the text or the reference to a cell containing text for which you want to substitute characters.
    " }, { "name" : "old_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to replace.
    " }, { "name" : "new_text", "type" : "xs:string", "occurrence" : null, "description" : "
     text you want to replace old_text with.
    " }, { "name" : "instance_num", "type" : "xs:integer", "occurrence" : "?", "description" : "
     specifies which occurrence of old_text you want to replace with new_text. 
     Only that instance of old_text is replaced.
    " } ], "returns" : { "type" : "xs:string", "description" : "Substitutes new_text for old_text in a text string. 
     Use SUBSTITUTE when you want to replace specific text in a text string; use REPLACE when you want to replace any text that occurs in a specific location in a text string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "t", "qname" : "excel-text:t", "signature" : "($value as xs:anyAtomicType?) as xs:string", "description" : " Converts the $value to string.\n", "summary" : "
     Converts the $value to string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value
    " } ], "returns" : { "type" : "xs:string", "description" : "Converts the $value to string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "trim", "qname" : "excel-text:trim", "signature" : "($text as xs:string?) as xs:string?", "description" : " Removes all spaces from text except for single spaces between words.\n", "summary" : "
     Removes all spaces from text except for single spaces between words.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : "?", "description" : "
     from which you want spaces removed.
    " } ], "returns" : { "type" : "xs:string?", "description" : "Removes all spaces from text except for single spaces between words." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "upper", "qname" : "excel-text:upper", "signature" : "($text as xs:string?) as xs:string?", "description" : " Converts text to uppercase.\n", "summary" : "
     Converts text to uppercase.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "text", "type" : "xs:string", "occurrence" : "?", "description" : "
     text you want converted to uppercase.
    " } ], "returns" : { "type" : "xs:string?", "description" : "Converts text to uppercase." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "value-except", "qname" : "excel-text:value-except", "signature" : "($arg1 as xs:anyAtomicType*, $arg2 as xs:anyAtomicType*) as xs:anyAtomicType*", "description" : " Returns the values in one sequence that do not appear in the second sequence in an implementation-defined order.\n", "summary" : "
     Returns the values in one sequence that do not appear in the second sequence in an implementation-defined order.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the first sequence.
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the second sequence.
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "The values in one sequence that do not appear in the second sequence in an implementation-defined order." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "value", "qname" : "excel-text:value", "signature" : "($arg as xs:anyAtomicType?) as xs:anyAtomicType?", "description" : " Converts a text string that represents a number to a number.\n", "summary" : "
     Converts a text string that represents a number to a number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "Converts a text string that represents a number to a number." }, "errors" : [ "excel-err:Value provided value is not a number." ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/http/response" : { "ns" : "http://www.28msec.com/modules/http/response", "description" : " The Sausalito response module can be used to modify the HTTP response\n that will be send as a result of this request. For example, the\n set-content-type function can be used to set the Content-Type\n header and determine the encoding of data in the response.\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "http" }, { "uri" : "http://www.w3.org/2010/xslt-xquery-serialization", "prefix" : "output" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "resp" }, { "uri" : "http://zorba.io/modules/schema", "prefix" : "s" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "code-for-status", "qname" : "resp:code-for-status", "signature" : "($status as xs:QName) as xs:int", "description" : " Convert between the HTTP status code as QName and\n the integer value of that status code.\n", "summary" : "
     Convert between the HTTP status code as QName and\n the integer value of that status code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:QName", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:int", "description" : "the integer value of the given QName as xs:int" }, "errors" : [ "http:invalid-status if the given QName does not represent a valid http status code" ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-binary", "qname" : "resp:content-type-binary", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a binary content-type. A\n content-type is considered to be binary if it's not a text\n content-type.
    \n", "summary" : "
      Test if a given content-type is a binary content-type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a binary content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-html", "qname" : "resp:content-type-html", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a HTML content-type, i.e.\n the content-type is the string \"text/html\".
    \n", "summary" : "
      Test if a given content-type is a HTML content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is the HTML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-json", "qname" : "resp:content-type-json", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a JSON content-type, i.e.\n the content-type is the string \"application/json\".
    \n", "summary" : "
      Test if a given content-type is a JSON content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is the JSON content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-mixed-json-xml", "qname" : "resp:content-type-mixed-json-xml", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a mixed JSON-XML content-type, i.e.\n the content-type is the string \"application/mixed-json-xml\".
    \n", "summary" : "
      Test if a given content-type is a mixed JSON-XML content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a mixed JSON-XML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-text", "qname" : "resp:content-type-text", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a text content-type.
    \n 
    A text content-type starts with \"text/\" or contains either of\n the strings \"xml\" or \"json\".
    \n", "summary" : "
      Test if a given content-type is a text content-type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a text content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-xhtml", "qname" : "resp:content-type-xhtml", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a XHTML content-type, i.e.\n the content-type is the string \"application/xhtml+xml\".
    \n", "summary" : "
      Test if a given content-type is a XHTML content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is the XHTML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-xml", "qname" : "resp:content-type-xml", "signature" : "($type as xs:string) as xs:boolean external", "description" : " 
    Test if a given content-type is a XML content-type
    \n 
    A XML content-type is a content-type that is \"application/xml\"\n or ends : with the string \"+xml\".
    \n", "summary" : "
      Test if a given content-type is a XML content-type \n  A XML content-type is a content-type that is \"application/xml\"\n or ends : with the string \"+xml\".
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a XML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "decode-binary", "qname" : "resp:decode-binary", "signature" : "() as xs:boolean external", "description" : " 
    Returns the boolean indiciating whether base64Binaries returned by\n this request will be decoded.
    \n 
    The default if not modified using resp:set-decode-binary is false.
    \n", "summary" : "
      Returns the boolean indiciating whether base64Binaries returned by\n this request will be decoded.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "the said boolean value" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "message-for-status", "qname" : "resp:message-for-status", "signature" : "($status as xs:QName) as xs:string", "description" : " Convert between the HTTP status code as QName and\n the name/message of that status code.\n", "summary" : "
     Convert between the HTTP status code as QName and\n the name/message of that status code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:QName", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "the message of the given QName as xs:string" }, "errors" : [ "http:invalid-status if the given QName does not represent a valid http status code" ] }, { "isDocumented" : true, "arity" : 0, "name" : "serialization-parameters", "qname" : "resp:serialization-parameters", "signature" : "() as element(output:serialization-parameters)", "description" : " 
    Returns the serialization parameters that are currently\n active, i.e. the ones that will be used to serialize the result\n of this request.
    \n 
    This will either be the default, the defaults set when\n calling resp:set-content-type(), or the ones set by\n resp:set-serialization-parameters().
    \n", "summary" : "
      Returns the serialization parameters that are currently\n active, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(output:serialization-parameters)", "description" : "the said serialization parameters" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-html", "qname" : "resp:serializer-defaults-html", "signature" : "() as element(*)*", "description" : " 
    Returns an element that can be used to specify the\n settings of serialization parameters for the HTML serialization\n method.
    \n 
    The defaults are\n 
      \n  
    • encoding: UTF-8
      • \n  
    • indent: yes
      • \n  
    • version: 4.01
      • \n  
    • doctype-system: http://www.w3.org/TR/html4/loose.dtd
      • \n  
    • doctype-public: -//W3C//DTD HTML 4.01 Transitional//EN
      • \n  
    • include-content-type: yes
      • \n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some HTML content-type (i.e. text/html).
    \n", "summary" : "
      Returns an element that can be used to specify the\n settings of serialization parameters for the HTML serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(*)*", "description" : "an element that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-json-xml-hybrid", "qname" : "resp:serializer-defaults-json-xml-hybrid", "signature" : "() as element(output:serialization-parameters)", "description" : " 
    Returns an element that can be used to specify the\n settings of serialization parameters for the json-xml-hybrid\n serialization method.
    \n 
    The defaults are\n 
      \n  
    • encoding: UTF-8
      • \n  
    • indent: yes
      • \n  
    • method: json-xml-hybrid
      • \n  
    • omit-xml-declaration: yes
      • \n  
    • version: 1.0
      • \n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to application/mixed-json-xml.
    \n", "summary" : "
      Returns an element that can be used to specify the\n settings of serialization parameters for the json-xml-hybrid\n serialization method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(output:serialization-parameters)", "description" : "an element that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-json", "qname" : "resp:serializer-defaults-json", "signature" : "() as element(output:serialization-parameters)", "description" : " 
    Returns an element that can be used to specify the\n settings of serialization parameters for the json\n serialization method.
    \n 
    The defaults are\n 
      \n  
    • encoding: UTF-8
      • \n  
    • indent: yes
      • \n  
    • method: json
      • \n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some JSON content-type (e.g. application/json).
    \n", "summary" : "
      Returns an element that can be used to specify the\n settings of serialization parameters for the json\n serialization method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(output:serialization-parameters)", "description" : "an element that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-text", "qname" : "resp:serializer-defaults-text", "signature" : "() as element(*)*", "description" : " 
    Returns an element that can be used to specify the\n settings of serialization parameters for the text serialization\n method.
    \n 
    The only default used is\n 
      \n  
    • encoding: UTF-8
      • \n 
    \n 
    \n 
    For example, this default is used when setting\n the content-type to some text content-type (e.g. text/plain).
    \n", "summary" : "
      Returns an element that can be used to specify the\n settings of serialization parameters for the text serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(*)*", "description" : "an element that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-xhtml", "qname" : "resp:serializer-defaults-xhtml", "signature" : "() as element(*)*", "description" : " 
    Returns an element that can be used to specify the\n settings of serialization parameters for the XHTML serialization\n method.
    \n 
    The defaults are\n 
      \n  
    • encoding: UTF-8
      • \n  
    • indent: yes
      • \n  
    • omit-xml-declaration: yes
      • \n  
    • version: 1.0
      • \n  
    • doctype-system: http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd
      • \n  
    • doctype-public: -//W3C//DTD XHTML 1.0 Transitional//EN
      • \n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some XHTML content-type (i.e. application/xhtml+xml).
    \n", "summary" : "
      Returns an element that can be used to specify the\n settings of serialization parameters for the XHTML serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(*)*", "description" : "an element that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-xml", "qname" : "resp:serializer-defaults-xml", "signature" : "() as element(output:serialization-parameters)", "description" : " 
    Returns an element that can be used to specify the\n settings of serialization parameters for the XML serialization\n method.
    \n 
    The defaults are\n 
      \n  
    • encoding: UTF-8
      • \n  
    • indent: yes
      • \n  
    • omit-xml-declaration: yes
      • \n  
    • version: 1.0
      • \n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some XML content-type (e.g. application/atom+xml).
    \n", "summary" : "
      Returns an element that can be used to specify the\n settings of serialization parameters for the XML serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "element(output:serialization-parameters)", "description" : "an element that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-content-type", "qname" : "resp:set-content-type", "signature" : "($type as xs:string) as empty-sequence()", "description" : " 
    Sets the Content-Type header for the response.
    \n 
    \n For example,\n resp:set-content-type(\"text/plain\") will cause the\n header\n Content-Type: text/plain to be added for the response.
    \n 
    In addtion to setting the Content-Type header, the function also\n sets the serialization parameters to the default values for serialization\n method for the given content-type. For example, if the content-type is set to\n text/plain, the default serialization parameters for the text\n serialization method will be used. For application/atom+xml, the default\n serialization parameters for the XML serialization method will be used.
    \n 
    The functions resp:content-type-text/xml/html/xhtml/binary may be used\n to figure out which serialization method will be used for a specific\n content-type.
    \n 
    If the given content-type contains a charset declaration (e.g.\n resp:set-content-type(\"text/plain;charset=ISO-8859-1\")), the\n content of the response will be transcoded to the given encoding.
    \n 
    The default serialization parameters set by this function can\n be overwritten using the resp:set-serialization-parameters() function.
    \n", "summary" : "
      Sets the Content-Type header for the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to be set
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [ "http:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "set-content-type", "qname" : "resp:set-content-type", "signature" : "($type as xs:string, $params as element(output:serialization-parameters)) as empty-sequence()", "description" : " 
    Sets the Content-Type header for the response.
    \n 
    For example,\n resp:set-content-type(\"text/plain\") will cause the\n header\n Content-Type: text/plain to be added for the response.
    \n 
    In addition to the content-type, the function also allows to\n specify the serialization method and parameters that will be used\n for serializing the result. For details about this parameter, please\n refer to resp:set-serialization-parameters().
    \n 
    If the given content-type contains a charset declaration (e.g.\n resp:set-content-type(\"text/plain;charset=ISO-8859-1\")), the\n content of the response will be transcoded to the given encoding.\n If the serialization parameters also contain a charset declaration,\n the charset contained in the content-type will be used. to transcode\n the result.
    \n", "summary" : "
      Sets the Content-Type header for the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to be set
    " }, { "name" : "params", "type" : "element(output:serialization-parameters)", "occurrence" : null, "description" : "
     the serialization parameters that will be used for serialization the result.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [ "http:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-decode-binary", "qname" : "resp:set-decode-binary", "signature" : "($decode as xs:boolean) as empty-sequence() external", "description" : " 
    If this function is invoked with true, the result of the request\n will not be serialized. Instead, the result will be the binary values\n of any item that is of type xs:base64Binary. The values of all other\n items will not be part of the result.
    \n 
    Please note that all serialization parameters which have been set using\n resp:set-serialization-parameters will be ignored. Also, the output encoding\n is ignored for binaries.
    \n", "summary" : "
      If this function is invoked with true, the result of the request\n will not be serialized.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "decode", "type" : "xs:boolean", "occurrence" : null, "description" : "
     boolean value indicating whether base64Binaries should be decoded.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-encoding", "qname" : "resp:set-encoding", "signature" : "($encoding as xs:string) as empty-sequence() external", "description" : " 
    The function sets the output encoding that will be\n used for the payload of the response.
    \n 
    For example,\n resp:set-encoding(\"ISO-8859-1\") will cause the\n content in the response to be encoded using ISO-8859-1.
    \n 
    Please note that the encoding only applies to textual data.\n It is not used if the function set-decode-binary()\n was invoked passing true as parameter.
    \n", "summary" : "
      The function sets the output encoding that will be\n used for the payload of the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "
     the encoding to be used for the payload of the response.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [ "http:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "set-header-impl", "qname" : "resp:set-header-impl", "signature" : "($name as xs:string, $value as xs:string) as xs:string? external", "description" : " 
    Set an HTTP header in the response.
    \n 
    This function is only used for internal purposes and should\n not be called by the user.
    \n", "summary" : "
      Set an HTTP header in the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name for the header to set
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     the value for the header to set
    " } ], "returns" : { "type" : "xs:string?", "description" : "the value of the header previously set or the empty sequence if no header has been set with the same name." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "set-header", "qname" : "resp:set-header", "signature" : "($name as xs:string, $value as xs:string) as xs:string?", "description" : " 
    Set a HTTP header in the response.
    \n 
    If a header with the same name was already set, the\n value is overwritten and the function returns the old value. As defined\n in the HTTP specification, multiple headers with the same name\n can be combined into one header whose value is a comma-separated\n list of the values.
    \n 
    The following headers must not be set using this function.\n Instead, other functions of this module should be used in order\n to implemented the required semantics:\n 
      \n   
    • Status: use set-status() instead
      • \n   
    • Content-Type: use set-content-type() instead
      • \n 
    \n 
    \n", "summary" : "
      Set a HTTP header in the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the header to set
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     the value of the header to set `
    " } ], "returns" : { "type" : "xs:string?", "description" : "the value of the header previously set or the empty sequence if no header has been set with the same name." }, "errors" : [ "resp:invalid-header-name if an invalid name is used for the header." ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-redirect", "qname" : "resp:set-redirect", "signature" : "($url as xs:string) as empty-sequence()", "description" : " This function sets the HTTP 302 redirect status code in the response. As\n a result, a redirect to the URL given as parameter will be made.\n", "summary" : "
     This function sets the HTTP 302 redirect status code in the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     The URL to which the redirect will be made.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The empty-sequence is returned." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-serialization-parameters", "qname" : "resp:set-serialization-parameters", "signature" : "($params as element(output:serialization-parameters)) as empty-sequence()", "description" : " 
    Set the serialization parameters used for serializing the result\n of the request.
    \n 
    The following example shows how to set several options\n for the HTML serialization method. Specifically, it sets the\n HTML method to HTML 4.01, set the doctype-system and\n doctype-public makes sure that the output is indented. In addition,\n the output is UTF-8 encoded and\n 
    \n <output:serialization-parameters>\n   <output:encoding value=\"UTF-8\"/>\n   <output:doctype-system value=\"http://www.w3.org/TR/html4/loose.dtd\"/>\n   <output:doctype-public value=\"-//W3C//DTD HTML 4.01 Transitional//EN\"/>\n </output:serialization-parameters>\n 
    \n 
    \n 
    The element passed as parameter need to be valid according\n to the schema http://www.w3.org/2010/xslt-xquery-serialization. This\n function validates its input (if it has not already been validated)\n and may raise an error if the input is not valid.
    \n 
    Please note that serialization options set by this function can\n be overwritten by a subsequent call to resp:set-content-type. In this\n case, the options will be reset to the default for the given\n content-type. Also note, that the output encoding can be overwritten\n by subsequently calling the resp:set-encoding function.
    \n", "summary" : "
      Set the serialization parameters used for serializing the result\n of the request.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "params", "type" : "element(output:serialization-parameters)", "occurrence" : null, "description" : "
     the serialization parameters that will be used to serialize the result of the request
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and, on success, returns the empty sequence." }, "errors" : [ "err:XQDY0027 if the input is not valid according to the schema http://www.w3.org/2010/xslt-xquery-serialization.", "http:invalid-encoding if the encoding specified in the serialization options is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-status-code", "qname" : "resp:set-status-code", "signature" : "($status as xs:integer) as empty-sequence() external", "description" : " 
    Sets the status code of the HTTP response to the integer given as\n parameter.
    \n For example,\n resp:set-status(204)\n will result in \"HTTP/1.1 204 No Content\".\n", "summary" : "
      Sets the status code of the HTTP response to the integer given as\n parameter.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:integer", "occurrence" : null, "description" : "
     The status code of the HTTP response as integer.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "On success, the empty-sequence is returned" }, "errors" : [ "http:invalid-status-code if the given integer does not reflect a valid HTTP status code" ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-status", "qname" : "resp:set-status", "signature" : "($status as xs:QName) as empty-sequence()", "description" : " 
    Sets the status code of the HTTP response to the QName given as\n parameter.
    \n For example,\n resp:set-status($http:no-content)\n will result in \"HTTP/1.1 204 No Content\".\n", "summary" : "
      Sets the status code of the HTTP response to the QName given as\n parameter.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:QName", "occurrence" : null, "description" : "
     The status code of the HTTP response as a QName (e.g. $http:no-content)
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "On success, the empty-sequence is returned" }, "errors" : [ "http:invalid-status if the given QName does not represent a valid HTTP status code;" ] }, { "isDocumented" : true, "arity" : 1, "name" : "valid-status", "qname" : "resp:valid-status", "signature" : "($status as xs:QName) as xs:boolean", "description" : " Test whether the given QName refers to a valid HTTP status code.\n", "summary" : "
     Test whether the given QName refers to a valid HTTP status code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:QName", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given QName refers to a valid HTTP status code, false otherwise." }, "errors" : [  ] } ], "variables" : [ { "name" : "http:precondition-required", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 428 Precondition Required (RFC 6585)\n" }, { "name" : "http:gone", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 410 GONE\n" }, { "name" : "http:length-required", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 411 Length Required\n" }, { "name" : "http:precondition-failed", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 412 Precondition Failed\n" }, { "name" : "http:request-entity-too-large", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 413 Request Entity Too Large\n" }, { "name" : "http:request-entity-too-long", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 414 Request Entity Too Long\n" }, { "name" : "http:unsupported-media-type", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 415 Unsupported Media Type\n" }, { "name" : "http:request-range-not-satisfiable", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 416 Request Range Not Satisfiable\n" }, { "name" : "http:expectation-failed", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 417 Expectation Failed\n" }, { "name" : "http:im-a-teapot", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 418 I'm a teapot (RFC 2324)\n" }, { "name" : "http:enhance-your-calm", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 420 Enhance Your Calm\n" }, { "name" : "http:unprocessable-entity", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 422 Unprocessable Entity (WebDAV; RFC 4918)\n" }, { "name" : "http:locked", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 423 Locked (WebDAV; RFC 4918)\n" }, { "name" : "http:failed-dependency", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 424 Failed Dependency (WebDAV; RFC 4918)\n" }, { "name" : "http:unordered-collection", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 425 Unordered Collection\n" }, { "name" : "http:upgrade-required", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 426 Upgrade Required\n" }, { "name" : "http:conflict", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 409 Conflict\n" }, { "name" : "http:too-many-requests", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 429 Too Many Requests (RFC 6585)\n" }, { "name" : "http:request-header-fields-too-large", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 431 Request Header Fields Too Large (RFC 6585)\n" }, { "name" : "http:internal-server-error", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 500 Internal Server Error\n" }, { "name" : "http:not-implemented", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 501 Not Implemented\n" }, { "name" : "http:bad-gateway", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 502 Bad Gateway\n" }, { "name" : "http:service-unavailable", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 503 Service Unavailable\n" }, { "name" : "http:gateway-timeout", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 504 Gateway Timeout\n" }, { "name" : "http:http-version-not-supported", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 505 HTTP Version Not Supported\n" }, { "name" : "http:variant-also-negotiates", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 506 Variant Also Negotiates (RFC 2295)\n" }, { "name" : "http:insufficient-storage", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 507 Insufficient Storage (WebDAV; RFC 4918)\n" }, { "name" : "http:loop-detected", "type" : "xs:QName", "description" : " QName representing the HTTP status code 508 Loop Detected (webdav; rfc 5842)\n" }, { "name" : "http:not-extended", "type" : "xs:QName", "description" : " QName representing the HTTP status code 510 Not Extended (RFC 2774)\n" }, { "name" : "http:network-authentication-required", "type" : "xs:QName", "description" : " QName representing the HTTP status code 511 Network Authentication Required (RFC 6585)\n" }, { "name" : "resp:status-info", "type" : "item()*", "description" : " Variable containing a description for all the HTTP Status Codes\n" }, { "name" : "http:see-other", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 303 See Other\n" }, { "name" : "http:switching-protocols", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 101 Switching Protocols\n" }, { "name" : "http:processing", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 102 Processing (Web; RFC 2518)\n" }, { "name" : "http:ok", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 200 OK\n" }, { "name" : "http:created", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 201 Created\n" }, { "name" : "http:accepted", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 202 Accepted\n" }, { "name" : "http:non-authoritative", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 203 Non-Authoritative\n" }, { "name" : "http:no-content", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 204 No Content\n" }, { "name" : "http:reset-content", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 205 Reset Content\n" }, { "name" : "http:partial-content", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 206 Partial Content\n" }, { "name" : "http:multi-status", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 207 Multi-Status (WebDAV; RFC 5842)\n" }, { "name" : "http:already-reported", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 208 Already Reported (WebDAV; RFC 5842)\n" }, { "name" : "http:im-used", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 226 IM Used (RFC 3229)\n" }, { "name" : "http:multiple-choices", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 300 Multiple Choices\n" }, { "name" : "http:moved-permanently", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 301 Moved Permantently\n" }, { "name" : "http:found", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 302 Found\n" }, { "name" : "http:continue", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 100 Continue\n" }, { "name" : "http:not-modified", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 304 Not Modified\n" }, { "name" : "http:use-proxy", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 305 Use Proxy\n" }, { "name" : "http:switch-proxy", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 306 Switch Proxy\n" }, { "name" : "http:temporary-redirect", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 307 Temporary Redirect\n" }, { "name" : "http:permanent-redirect", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 308 Permanent Redirect (http://tools.ietf.org/html/draft-reschke-http-status-308-07)\n" }, { "name" : "http:bad-request", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 400 Bad Request\n" }, { "name" : "http:unauthorized", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 401 Unauthorized\n" }, { "name" : "http:payment-required", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 402 Payment Required\n" }, { "name" : "http:forbidden", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 403 Forbidden\n" }, { "name" : "http:not-found", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 404 Not Found\n" }, { "name" : "http:not-allowed", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 405 Not Allowed\n" }, { "name" : "http:not-acceptable", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 406 Not Acceptable\n" }, { "name" : "http:proxy-authentication-required", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 407 Proxy Authentication Required\n" }, { "name" : "http:request-timeout", "type" : "xs:QName", "description" : " QName representing the HTTP Status Code 408 Request Timeout\n" } ] }, "http://zorba.io/modules/uri" : { "ns" : "http://zorba.io/modules/uri", "description" : " This module provides functions for processing URIs and URLs.\n", "sees" : [  ], "authors" : [ "Matthias Brantner, Luis Rodriguez Gonzalez" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/uri", "prefix" : "uri" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "decode", "qname" : "uri:decode", "signature" : "($u as xs:string) as xs:string", "description" : " Percent-decodes (aka URL decoding) the given string.\n All percent encoded octets will be translated into their\n decoded UTF-8 representation.\n Please note that the percent encoding guarantees that a string\n consists of ASCII characters only. Passing a string that contains\n non-ASCII characters results in undefined behavior.\n", "summary" : "
     Percent-decodes (aka URL decoding) the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "u", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "the percent decoded string" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "decode", "qname" : "uri:decode", "signature" : "($u as xs:string, $decode-plus as xs:boolean) as xs:string", "description" : " Percent-decodes (aka URL decoding) the given string.\n All percent encoded octets will be translated into their\n decoded UTF-8 representation.\n If $decode-plus is specified all occurrences of the char '+'\n will be replaced with a space ' ' before the percent decoding\n happens.\n Please note that the percent encoding guarantees that a string\n consists of ASCII characters only. Passing a string that contains\n non-ASCII characters results in undefined behavior.\n", "summary" : "
     Percent-decodes (aka URL decoding) the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "u", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "decode-plus", "type" : "xs:boolean", "occurrence" : null, "description" : "
     whether '+' chars will be replaced with spaces
    " } ], "returns" : { "type" : "xs:string", "description" : "the percent decoded string" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "decode", "qname" : "uri:decode", "signature" : "($s as xs:string, $decode-plus as xs:boolean, $charset as xs:string) as xs:string external", "description" : " Percent-decodes (aka URL decoding) the given string.\n All percent encoded octets will be translated into their\n decoded UTF-8 representation.\n If $decode-plus is specified all occurrences of the char '+'\n will be replaced with a space ' ' before the percent decoding\n happens.\n The $charset parameter specifies the source charset after precent\n decoding. It is used to convert the decoded string into UTF-8.\n Please note that the percent encoding guarantees that a string\n consists of ASCII characters only. Passing a string that contains\n non-ASCII characters results in undefined behavior.\n", "summary" : "
     Percent-decodes (aka URL decoding) the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : null, "description" : "
     the string to decode
    " }, { "name" : "decode-plus", "type" : "xs:boolean", "occurrence" : null, "description" : "
     whether '+' chars will be replaced with spaces
    " }, { "name" : "charset", "type" : "xs:string", "occurrence" : null, "description" : "
     the source charset of the string after percent decoding
    " } ], "returns" : { "type" : "xs:string", "description" : "the percent decoded string" }, "errors" : [ "uri:CHARSET_UNKNOWN if the given charset is unknown or not supported", "zerr:ZOSE0006 if there is an error transcoding the string" ] }, { "isDocumented" : true, "arity" : 1, "name" : "parse", "qname" : "uri:parse", "signature" : "($uri as xs:string) as object() external", "description" : " Parses the URI passed as string. The returned object\n contains only members with field names declared as constants in\n this module.\n For example,\n 
    \n let my-uri := \"http://www.my.project.com/a/b/c?user=john;pass=1234#profile\"\n return uri:parse(my-uri)\n 
    \n returns\n 
    \n { \"squeme\" : \"http\", \"host\" : \"www.my.project.com\", \"path\" : \"/a/b/c\",\n   \"query\" : \"user=john;pass=123\", \"fragment\" : \"profile\" }\n 
    \n", "summary" : "
     Parses the URI passed as string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     the URI to parse
    " } ], "returns" : { "type" : "object()", "description" : "the JSON object" }, "errors" : [ "err:XQST0046 if the URI is textually invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "serialize", "qname" : "uri:serialize", "signature" : "($uri as object()) as xs:string external", "description" : " Serialize the URI passed as object into a string.\n", "summary" : "
     Serialize the URI passed as object into a string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "object()", "occurrence" : null, "description" : "
     the object representing the URI
    " } ], "returns" : { "type" : "xs:string", "description" : "the URI as string" }, "errors" : [ "uri:OPAQUE_COMB_NOT_VALID if opaque part is specified in conjunction with host/port/path/user-info/query.", "uri:OPAQUE_WITHOUT_SCHEME if opaque part is present but no scheme is present.", "uri:INVALID_ABSOLUTE_PATH if a path component for an absolute URI doesn't start with \"/\"." ] } ], "variables" : [ { "name" : "uri:SCHEME", "type" : "xs:string", "description" : " Constant for the \"scheme\" part of a URI object.\n" }, { "name" : "uri:AUTHORITY", "type" : "xs:string", "description" : " Constant for the \"authority\" part of a URI object.\n" }, { "name" : "uri:USER-INFO", "type" : "xs:string", "description" : " Constant for the \"user-info\" part of a URI object.\n" }, { "name" : "uri:HOST", "type" : "xs:string", "description" : " Constant for the \"host\" part of a URI object.\n" }, { "name" : "uri:PORT", "type" : "xs:string", "description" : " Constant for the \"port\" part of a URI object.\n" }, { "name" : "uri:PATH", "type" : "xs:string", "description" : " Constant for the \"path\" part of a URI object.\n" }, { "name" : "uri:QUERY", "type" : "xs:string", "description" : " Constant for the \"query\" part of a URI object.\n" }, { "name" : "uri:FRAGMENT", "type" : "xs:string", "description" : " Constant for the \"fragment\" part of a URI object.\n" }, { "name" : "uri:OPAQUE-PART", "type" : "xs:string", "description" : " Constant for the \"opaque-part\" part of a URI object.\n If this is set in a URI object, then none of $uri:PATH, $uri:HOST,\n $uri:PORT, $uri:USER-INFO, or : $uri:QUERY may be specified.\n If this is set in a URI object, $uri:SCHEME must also be specified\n (ie, it must be an absolute URI).\n" } ] }, "http://xbrl.io/modules/bizql/profiles/sec/fiscal/core" : { "ns" : "http://xbrl.io/modules/bizql/profiles/sec/fiscal/core", "description" : " 
    This module provides functionality for querying fiscal reports (10-K, 10-Q)\n submitted to the SEC.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/companies", "prefix" : "companies" }, { "uri" : "http://xbrl.io/modules/bizql/components", "prefix" : "components" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/filings", "prefix" : "filings" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/fiscal/core", "prefix" : "fiscal-core" }, { "uri" : "http://jsoniq.org/function-library", "prefix" : "j" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "mongo" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/core", "prefix" : "sec" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/networks", "prefix" : "sec-networks" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "balance-sheets-for-fiscal-periods-and-years", "qname" : "fiscal-core:balance-sheets-for-fiscal-periods-and-years", "signature" : "($entity-or-ids as item()*, $fiscal-period-focus as string*, $fiscal-year-focus as integer*) as object()*", "description" : " 
    Retrieves the balance sheet for the given entities and fiscal periods and years.
    \n", "summary" : "
      Retrieves the balance sheet for the given entities and fiscal periods and years.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entity-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a list of entities or their EIDs.
    " }, { "name" : "fiscal-period-focus", "type" : "string", "occurrence" : "*", "description" : "
     the periods (YTD1, YTD2, YTD3, Q1, Q2, Q3 or FY) or $fiscal-core:ALL_FISCAL_PERIODS to accept all.
    " }, { "name" : "fiscal-year-focus", "type" : "integer", "occurrence" : "*", "description" : "
     the years (2012) or $fiscal-core:ALL_FISCAL_YEARS to accept all.
    " } ], "returns" : { "type" : "object()*", "description" : "the balance sheet at that date and for that formType." }, "errors" : [ "entities:INVALID_PARAMETER if the CIK or entity is not valid." ] }, { "isDocumented" : true, "arity" : 3, "name" : "facts-for-aspects-and-fiscal-periods-and-years", "qname" : "fiscal-core:facts-for-aspects-and-fiscal-periods-and-years", "signature" : "($aspects as object()?, $fiscal-period-focus as string*, $fiscal-year-focus as integer*) as object()*", "description" : " 
    Retrieves facts for the given aspects, fiscal periods and years.
    \n", "summary" : "
      Retrieves facts for the given aspects, fiscal periods and years.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "aspects", "type" : "object()", "occurrence" : "?", "description" : "
     an object containing aspects to filter, among which xbrl:Concept, xbrl:Entity and xbrl:Period (all optional).
    " }, { "name" : "fiscal-period-focus", "type" : "string", "occurrence" : "*", "description" : "
     the periods (YTD1, YTD2, YTD3, Q1, Q2, Q3 or FY).
    " }, { "name" : "fiscal-year-focus", "type" : "integer", "occurrence" : "*", "description" : "
     the years (2012)
    " } ], "returns" : { "type" : "object()*", "description" : "all facts matching the given aspects, fiscal period and year." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "facts-for-aspects-and-fiscal-periods-and-years", "qname" : "fiscal-core:facts-for-aspects-and-fiscal-periods-and-years", "signature" : "($aspects as object()?, $fiscal-period-focus as string*, $fiscal-year-focus as integer*, $options as object()?) as object()*", "description" : " 
    Retrieves facts for the given aspects, fiscal periods and years.
    \n", "summary" : "
      Retrieves facts for the given aspects, fiscal periods and years.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "aspects", "type" : "object()", "occurrence" : "?", "description" : "
     an object containing aspects to filter, among which xbrl:Concept, xbrl:Entity and xbrl:Period (all optional).
    " }, { "name" : "fiscal-period-focus", "type" : "string", "occurrence" : "*", "description" : "
     the periods (YTD1, YTD2, YTD3, Q1, Q2, Q3 or FY) or $fiscal-core:ALL_FISCAL_PERIODS to accept all.
    " }, { "name" : "fiscal-year-focus", "type" : "integer", "occurrence" : "*", "description" : "
     the years (2012) or $fiscal-core:ALL_FISCAL_YEARS to accept all.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all facts matching the given aspects, fiscal period and year." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "facts-for-entities-and-concepts-and-fiscal-periods-and-years", "qname" : "fiscal-core:facts-for-entities-and-concepts-and-fiscal-periods-and-years", "signature" : "($entities-or-ids as item()*, $concepts as string*, $fiscal-period-focus as string*, $fiscal-year-focus as integer*) as object()*", "description" : " 
    Retrieves facts for the given entities, concepts, fiscal periods and years.
    \n", "summary" : "
      Retrieves facts for the given entities, concepts, fiscal periods and years.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entities-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a list of entities or their EIDs.
    " }, { "name" : "concepts", "type" : "string", "occurrence" : "*", "description" : "
     a list of concept names (us-gaap:Assets)
    " }, { "name" : "fiscal-period-focus", "type" : "string", "occurrence" : "*", "description" : "
     the periods (YTD1, YTD2, YTD3, Q1, Q2, Q3 or FY) or $fiscal-core:ALL_FISCAL_PERIODS to accept all.
    " }, { "name" : "fiscal-year-focus", "type" : "integer", "occurrence" : "*", "description" : "
     the years (2012) or $fiscal-core:ALL_FISCAL_YEARS to accept all.
    " } ], "returns" : { "type" : "object()*", "description" : "all facts matching entities, concepts, fiscal periods and years" }, "errors" : [ "entities:INVALID_PARAMETER if the CIK or entity is not valid." ] }, { "isDocumented" : true, "arity" : 5, "name" : "facts-for-entities-and-concepts-and-fiscal-periods-and-years", "qname" : "fiscal-core:facts-for-entities-and-concepts-and-fiscal-periods-and-years", "signature" : "($entities-or-ids as item()*, $concepts as string*, $fiscal-period-focus as string*, $fiscal-year-focus as integer*, $options as object()?) as object()*", "description" : " 
    Retrieves facts for the given entities, concepts, fiscal periods and years.
    \n", "summary" : "
      Retrieves facts for the given entities, concepts, fiscal periods and years.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entities-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a list of entities or their EIDs.
    " }, { "name" : "concepts", "type" : "string", "occurrence" : "*", "description" : "
     a list of concept names (us-gaap:Assets)
    " }, { "name" : "fiscal-period-focus", "type" : "string", "occurrence" : "*", "description" : "
     the periods (YTD1, YTD2, YTD3, Q1, Q2, Q3 or FY) or $fiscal-core:ALL_FISCAL_PERIODS to accept all.
    " }, { "name" : "fiscal-year-focus", "type" : "integer", "occurrence" : "*", "description" : "
     the years (2012) or $fiscal-core:ALL_FISCAL_YEARS to accept all.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all facts matching entities, concepts, fiscal periods and years" }, "errors" : [ "entities:INVALID_PARAMETER if the CIK or entity is not valid." ] }, { "isDocumented" : true, "arity" : 3, "name" : "filings-for-entities-and-fiscal-periods-and-years", "qname" : "fiscal-core:filings-for-entities-and-fiscal-periods-and-years", "signature" : "($entities-or-ids as item()*, $fiscal-period-focus as string*, $fiscal-year-focus as integer*) as object()*", "description" : " 
    Retrieves all filings by entities and for given fiscal periods and years.
    \n", "summary" : "
      Retrieves all filings by entities and for given fiscal periods and years.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entities-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     entities or their ids.
    " }, { "name" : "fiscal-period-focus", "type" : "string", "occurrence" : "*", "description" : "
     fiscal periods (FY, YTD1, YTD2, YTD3, Q1, Q2, Q3, Q4) or $fiscal-core:ALL_FISCAL_PERIODS to accept all..
    " }, { "name" : "fiscal-year-focus", "type" : "integer", "occurrence" : "*", "description" : "
     fiscal years or $fiscal-core:ALL_FISCAL_YEARS to accept all..
    " } ], "returns" : { "type" : "object()*", "description" : "all filings that match the criteria." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "fiscal-period", "qname" : "fiscal-core:fiscal-period", "signature" : "($filing-fact-or-id as item()?) as string?", "description" : " 
    Retrieves the fiscal period of a filing or a fact.
    \n", "summary" : "
      Retrieves the fiscal period of a filing or a fact.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filing-fact-or-id", "type" : "item()", "occurrence" : "?", "description" : "
     a filing, a fact, or its id.
    " } ], "returns" : { "type" : "string?", "description" : "the fiscal period (FY, YTD2, YTD3, Q1, Q2 or Q3)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "fiscal-year", "qname" : "fiscal-core:fiscal-year", "signature" : "($filing-fact-or-id as item()?) as integer?", "description" : " 
    Retrieves the fiscal year of a filing or a fact.
    \n", "summary" : "
      Retrieves the fiscal year of a filing or a fact.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filing-fact-or-id", "type" : "item()", "occurrence" : "?", "description" : "
     a filing, a fact, or its id.
    " } ], "returns" : { "type" : "integer?", "description" : "the fiscal year (e.g., 2012)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "latest-reported-fiscal-period", "qname" : "fiscal-core:latest-reported-fiscal-period", "signature" : "($entity-or-id as item()) as object()*", "description" : " 
    Retrieves the latest reported fiscal period and year for the\n supplied entity.
    \n", "summary" : "
      Retrieves the latest reported fiscal period and year for the\n supplied entity.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entity-or-id", "type" : "item()", "occurrence" : null, "description" : "
     an entity or its EID.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with two fields: period and year." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "latest-reported-fiscal-period", "qname" : "fiscal-core:latest-reported-fiscal-period", "signature" : "($entity-or-id as item(), $type as string) as object()*", "description" : " 
    Retrieves the latest fiscal period and year for the\n supplied entity.
    \n", "summary" : "
      Retrieves the latest fiscal period and year for the\n supplied entity.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entity-or-id", "type" : "item()", "occurrence" : null, "description" : "
     an entity or its EID.
    " }, { "name" : "type", "type" : "string", "occurrence" : null, "description" : "
     10-K or 10-Q or FY, YTD1, YTD2, YTD3, Q1, Q2, or Q3.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with two fields: period and year." }, "errors" : [  ] } ], "variables" : [ { "name" : "fiscal-core:ALL_FISCAL_PERIODS", "type" : "string", "description" : " Joker for all fiscal periods.\n" }, { "name" : "fiscal-core:ALL_FISCAL_YEARS", "type" : "integer", "description" : " Joker for all fiscal years.\n" } ] }, "http://zorba.io/modules/base64" : { "ns" : "http://zorba.io/modules/base64", "description" : " 
    Base64 encoding and decoding.
    \n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/base64", "prefix" : "base64" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "decode", "qname" : "base64:decode", "signature" : "($base64 as base64Binary) as string external", "description" : " 
    Decode a base64Binary.
    \n 
    The function assumes that the content after decoding is valid\n UTF-8.
    \n", "summary" : "
      Decode a base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "base64", "type" : "base64Binary", "occurrence" : null, "description" : "
     The base64Binary item to decode
    " } ], "returns" : { "type" : "string", "description" : "the base64-decoded value as string" }, "errors" : [ "zerr:ZOSE0006 if $base64 contains invalid base-64 data." ] }, { "isDocumented" : true, "arity" : 2, "name" : "decode", "qname" : "base64:decode", "signature" : "($base64 as base64Binary, $encoding as string) as string external", "description" : " 
    Decode a base64Binary.
    \n 
    The function assumes that the content after decoding has\n the given encoding.
    \n", "summary" : "
      Decode a base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "base64", "type" : "base64Binary", "occurrence" : null, "description" : "
     The base64Binary item to decode
    " }, { "name" : "encoding", "type" : "string", "occurrence" : null, "description" : "
     The encoding of the string after base64-decoding it. The encoding parameter is case insensitive.
    " } ], "returns" : { "type" : "string", "description" : "the base64-decoded value as a string" }, "errors" : [ "zerr:ZXQP0006 if the given encoding is invalid or not supported. \"ASCII\" and \"UTF-8\" are guaranteed to be supported; other encodings may be supported depending on the installation.", "zerr:ZOSE0006 if $base64 contains invalid base-64 data." ] }, { "isDocumented" : true, "arity" : 1, "name" : "encode", "qname" : "base64:encode", "signature" : "($string as string) as base64Binary external", "description" : " 
    Encode a string as base64Binary.
    \n", "summary" : "
      Encode a string as base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "string", "occurrence" : null, "description" : "
     The item whose string-value should be encoded
    " } ], "returns" : { "type" : "base64Binary", "description" : "the base64-encoded string-value of the item parameter" }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/networks" : { "ns" : "http://xbrl.io/modules/bizql/networks", "description" : " 
    This module provides functionality for handling networks.
    \n 
    A network is a graph of concepts and resources, of which the edges\n share the same semantics.
    \n 
    There are several kinds of networks.\n A network can be a tree or a DAG of concepts. It can be a bipartite\n graph mapping concepts to resources.
    \n 
    XBRL defines a number of standard networks: presentation, calculation,\n definition (essence-alias, general-special, requires-element, similar-tuples, domain-member),\n and label networks.
    \n 
    With this module, you can retrieve the networks contained in a component, and you\n can retrieve a standard XBRL network with the provided short names.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/components", "prefix" : "components" }, { "uri" : "http://xbrl.io/modules/bizql/networks", "prefix" : "networks" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "networks-for-components-and-short-names", "qname" : "networks:networks-for-components-and-short-names", "signature" : "($components as item()*, $short-name as string*) as object()*", "description" : " 
    Retrieves the standardized networks in the supplied components with the given short names.
    \n", "summary" : "
      Retrieves the standardized networks in the supplied components with the given short names.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "components", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of components.
    " }, { "name" : "short-name", "type" : "string", "occurrence" : "*", "description" : "
     the short names of the networks.
    " } ], "returns" : { "type" : "object()*", "description" : "the standardized networks with these short names." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "networks-for-components", "qname" : "networks:networks-for-components", "signature" : "($components as item()*) as object()*", "description" : " 
    Retrieves all networks in the supplied components.
    \n", "summary" : "
      Retrieves all networks in the supplied components.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "components", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of components.
    " } ], "returns" : { "type" : "object()*", "description" : "all networks." }, "errors" : [  ] } ], "variables" : [ { "name" : "networks:PRESENTATION_NETWORK", "type" : "xs:string", "description" : " Short name of the presentation network.\n" }, { "name" : "networks:CALCULATION_NETWORK", "type" : "xs:string", "description" : " Short name of the calculation network.\n" }, { "name" : "networks:ESSENCE_ALIAS_NETWORK", "type" : "xs:string", "description" : " Short name of the essence-alias definition network.\n" }, { "name" : "networks:GENERAL_SPECIAL_NETWORK", "type" : "xs:string", "description" : " Short name of the general-special definition network.\n" }, { "name" : "networks:REQUIRES_ELEMENT_NETWORK", "type" : "xs:string", "description" : " Short name of the requires-element definition network.\n" }, { "name" : "networks:SIMILAR_TUPLES_NETWORK", "type" : "xs:string", "description" : " Short name of the similar-tuples definition network.\n" }, { "name" : "networks:DOMAIN_MEMBER_NETWORK", "type" : "xs:string", "description" : " Short name of the domain-member definition network.\n" } ] }, "http://jsound.io/modules/validate/map" : { "ns" : "http://jsound.io/modules/validate/map", "description" : " Map utility\n", "sees" : [  ], "authors" : [ "Chris Hillery, Cezar Andrei" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://jsound.io/modules/validate/map", "prefix" : "map" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "get", "qname" : "map:get", "signature" : "($map as object(), $key as string) as item()", "description" : " Returns the value under the key.\n", "summary" : "
     Returns the value under the key.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "map", "type" : "object()", "occurrence" : null, "description" : "
     the map JSON object
    " }, { "name" : "key", "type" : "string", "occurrence" : null, "description" : "
     the key
    " } ], "returns" : { "type" : "item()", "description" : "the value under the $key, () if empty Example:" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "has-key", "qname" : "map:has-key", "signature" : "($map as object(), $key as string) as boolean", "description" : " Returns true if $key exists in the map.\n", "summary" : "
     Returns true if $key exists in the map.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "map", "type" : "object()", "occurrence" : null, "description" : "
     the map JSON object
    " }, { "name" : "key", "type" : "string", "occurrence" : null, "description" : "
     the key
    " } ], "returns" : { "type" : "boolean", "description" : "true if $key exists, false otherwise Example:" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-if-empty", "qname" : "map:set-if-empty", "signature" : "($map as object(), $key as xs:string, $value as item()) as boolean", "description" : " Only if key doesn't exist, inserts new key and value into the map and\n returns true. Otherwise returns false.\n", "summary" : "
     Only if key doesn't exist, inserts new key and value into the map and\n returns true.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "map", "type" : "object()", "occurrence" : null, "description" : "
     the map JSON object
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : null, "description" : "
     the key
    " }, { "name" : "value", "type" : "item()", "occurrence" : null, "description" : "
     the value
    " } ], "returns" : { "type" : "boolean", "description" : "true if $key is empty, false otherwise Example:" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "set", "qname" : "map:set", "signature" : "($map as object(), $key as xs:string, $value as item()) as boolean", "description" : " Inserts new key and value into the map or replaces value under the exiting key.\n Returns true all the time.\n", "summary" : "
     Inserts new key and value into the map or replaces value under the exiting key.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "map", "type" : "object()", "occurrence" : null, "description" : "
     the map JSON object
    " }, { "name" : "key", "type" : "xs:string", "occurrence" : null, "description" : "
     the key
    " }, { "name" : "value", "type" : "item()", "occurrence" : null, "description" : "
     the value
    " } ], "returns" : { "type" : "boolean", "description" : "true Example:" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/xml" : { "ns" : "http://zorba.io/modules/xml", "description" : " 
    \n This module provides functions for reading XML files from string inputs.\n It allows reading of well-formed XML documents as well as well-formed\n external parsed entities, described by\n XML 1.0 Well-Formed\n Parsed Entities. The functions can also perform Schema and DTD\n validation of the input documents.\n 
    \n 
    The following example parses a sequence of XML elements and returns\n them in a streaming fashion - each at a time:
    \n 
    \n import module namespace x = \"http://zorba.io/modules/xml\";\n import schema namespace opt = \"http://zorba.io/modules/xml-options\";\n x:parse(\n   \"<from1>Jani</from1><from2>Jani</from2><from3>Jani</from3>\",\n   <opt:options>\n     <opt:parse-external-parsed-entity/>\n   </opt:options>\n )\n 
    \n 
    Another useful option allows to skip an arbitrary number of levels\n before returning a sequence of nodes as shown in the following example:
    \n 
    \n import module namespace x = \"http://zorba.io/modules/xml\";\n import schema namespace opt = \"http://zorba.io/modules/xml-options\";\n x:parse(\n   \"<root>\n     <from1>Jani1</from1>\n     <from2>Jani2</from2>\n     <from3>Jani3</from3>\n   </root>\",\n   <opt:options>\n     <opt:parse-external-parsed-entity opt:skip-root-nodes=\"1\"/>\n   </opt:options>\n )\n 
    \n", "sees" : [ "XML 1.0 Well-Formed Parsed Entities", " fn:parse-xml() function in XPath and XQuery Functions and Operators 3.0", "LibXml2 parser" ], "authors" : [ "Nicolae Brinza, Juan Zacarias" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/xml-options", "prefix" : "opt" }, { "uri" : "http://zorba.io/modules/schema", "prefix" : "schema" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/modules/xml", "prefix" : "x" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "canonicalize", "qname" : "x:canonicalize", "signature" : "($xml-string as xs:string) as xs:string", "description" : " 
    A function to canonicalize the given XML string, that is, transform\n it into Canonical XML as defined by Canonical XML.
    \n 
    Note: This function is not streamable. If a streamable string is used\n as input for the function it will be materialized.
    \n 
    Note: This function sets the\n XML_PARSE_NOERROR\n option when parsing the XML input.
    \n", "summary" : "
      A function to canonicalize the given XML string, that is, transform\n it into Canonical XML as defined by  Canonical XML .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml-string", "type" : "xs:string", "occurrence" : null, "description" : "
     a string representation of a well formed XML to canonicalize. XML fragments are not allowed.
    " } ], "returns" : { "type" : "xs:string", "description" : "the canonicalized XML string." }, "errors" : [ "err:CANO0001 invalid input." ] }, { "isDocumented" : true, "arity" : 2, "name" : "canonicalize", "qname" : "x:canonicalize", "signature" : "($xml-string as xs:string, $options as element(opt:options)) as xs:string", "description" : " 
    A function to canonicalize the given XML string, that is, transform\n it into Canonical XML as defined by Canonical XML.
    \n 
    This version of the function allows specifying certain options to be\n used when initially parsing the XML string. These are of the same form\n as the options to x:parse#2(), although the following options are\n currently ignored for this function:\n 
      \n 
    • <opt:no-error/>
      • \n 
    • <opt:base-uri/>
      • \n 
    • <opt:schema-validate/>
      • \n 
    • <opt:parse-external-parsed-entity/>
      • \n 
    \n 
    \n 
    Note: This function is not streamable, if a streamable string is used\n as input for the function it will be materialized.
    \n 
    Note: This function sets the\n XML_PARSE_NOERROR\n option when parsing the XML input.
    \n", "summary" : "
      A function to canonicalize the given XML string, that is, transform\n it into Canonical XML as defined by  Canonical XML .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml-string", "type" : "xs:string", "occurrence" : null, "description" : "
     a string representation of a well formed XML to canonicalize. XML fragments are not allowed.
    " }, { "name" : "options", "type" : "element(opt:options)", "occurrence" : null, "description" : "
     an XML containg options for the canonicalize function.
    " } ], "returns" : { "type" : "xs:string", "description" : "the canonicalized XML string." }, "errors" : [ "err:CANO0001 invalid input." ] }, { "isDocumented" : true, "arity" : 2, "name" : "parse", "qname" : "x:parse", "signature" : "($xml-string as xs:string?, $options as element(opt:options)?) as node()* external", "description" : " 
    A function to parse XML files and fragments (i.e.\n external general parsed\n entities).
    \n 
    The functions takes two arguments: the first one is the\n string to be parsed and the second argument is an <options/> element that\n passes a list of options to the parsing function. They are described below.\n The options element must conform to the xml-options:options element type\n from the xml-options.xsd schema. Some of these\n will be passed to the underlying library (LibXml2) and further documentation\n for them can be found at \n LibXml2 parser.
    \n The list of available options:\n 
      \n 
    • \n <base-uri/> - the element must have a \"value\" attribute, which will provide\n the baseURI that will be used as the baseURI for every node returned by this\n function.\n 
      • \n 
    • \n <no-error/> - if present, the option will disable fatal error processing. Any\n failure to parse or validate the input in the requested manner will result\n in the function returning an empty sequence and no error will raised.\n 
      • \n 
    • \n <schema-validate/> - if present, it will request that the input string be Schema\n validated. The element accepts an attribute named \"mode\" which can have two\n values: \"strict and \"lax\". Enabling the option will produce a result that is\n equivalent to processing the input with the option disabled, and then copying\n the result using the XQuery \"validate strict|lax\" expression. This option can not\n be used together with either the <DTD-validate/> or the <parse-external-parsed-entity/>\n option. Doing so will raise a zerr:ZXQD0003 error.\n 
      • \n 
    • \n <DTD-validate/> - the option will enable the DTD-based validation. If this\n option is enabled and the input references a DTD, then the input must be a\n well-formed and DTD-valid XML document. The <DTD-load/> option must be used for\n external DTD files to be loaded. If the option is enabled and the input does\n not reference a DTD then the option is ignored. If the option is disabled, the\n input is not required to reference a DTD and if it does reference a DTD then\n the DTD is ignored for validation purposes. This option can not\n be used together with either the <schema-validate/> or the <parse-external-parsed-entity>\n option. Doing so will raise a zerr:ZXQD0003 error.\n 
      • \n 
    • \n <DTD-load/> - if present, it will enable loading of external DTD files.\n 
      • \n 
    • \n <default-DTD-attributes/> - if present, it will enable the default DTD attributes.\n 
      • \n 
    • \n <parse-external-parsed-entity/> - if present, it will enable the processing of XML\n external entities. If the option\n is enabled, the input must conform to the syntax extParsedEnt (production\n [78] in XML 1.0, see \n Well-Formed Parsed Entities). In addition, by default a DOCTYPE declaration is allowed,\n as described by the [28] doctypedecl production, see \n Document Type Definition. A parameter is available to forbid the appearance of the DOCTYPE.\n The result of the function call is a list\n of nodes corresponding to the top-level components of the content of the\n external entity: that is, elements, processing instructions, comments, and\n text nodes. CDATA sections and character references are expanded, and\n adjacent characters are merged so the result contains no adjacent text\n nodes. If the option is disabled, the input must be a well-formed XML\n document conforming to the Document production\n (production [1] in XML 1.0).\n This option can not be used together with either the <schema-validate/> or the <DTD-validate/>\n option. Doing so will raise a zerr:ZXQD0003 error.\n The <parse-external-parsed-entity/> option has three parameters, given by attributes. The first\n attribute is \"skip-root-nodes\" and it can have a non-negative value. Specifying the paramter\n tells the parser to skip the given number of root nodes and return only their children. E.g.\n skip-root-nodes=\"1\" is equivalent to parse-xml($xml-string)/node()/node() . skip-root-nodes=\"2\" is equivalent\n to parse-xml($xml-string)/node()/node()/node() , etc. The second attribute is \"skip-top-level-text-nodes\" with a\n boolean value. Specifying \"true\" will tell the parser to skip top level text nodes, returning\n only the top level elements, comments, PIs, etc. This parameter works in combination with\n the \"skip-root-nodes\" paramter, thus top level text nodes are skipped after \"skip-root-nodes\" has\n been applied. The third paramter is \"error-on-doctype\" and will generate an error if a DOCTYPE\n declaration appears in the input, which by default is allowed.\n 
      • \n 
    • \n <substitute-entities/> - if present, it will enable the XML entities substitutions.\n 
      • \n 
    • \n <remove-redundant-ns/> - if present, the parser will remove redundant namespaces declarations.\n 
      • \n 
    • \n <no-CDATA/> - if present, the parser will merge CDATA nodes as text nodes.\n 
      • \n 
    • \n <xinclude-substitutions/> - if present, it will enable the XInclude substitutions.\n 
      • \n 
    • \n <no-xinclude-nodes/> - if present, the parser will not generate XInclude START/END nodes.\n 
      • \n 
    \n 
    \n An example that sets the base-uri of the parsed external entities:\n 
    \n 
    \n   import module namespace x = \"http://zorba.io/modules/xml\";\n   import schema namespace opt = \"http://zorba.io/modules/xml-options\";\n   x:parse(\"<from1>Jani</from1><from2>Jani</from2><from3>Jani</from3>\",\n     <opt:options>\n       <opt:base-uri opt:value=\"urn:test\"/>\n       <opt:parse-external-parsed-entity/>\n     </opt:options>\n   )\n 
    \n", "summary" : "
      A function to parse XML files and fragments (i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml-string", "type" : "xs:string", "occurrence" : "?", "description" : "
     The string that holds the XML to be parsed. If empty, the function will return an empty sequence
    " }, { "name" : "options", "type" : "element(opt:options)", "occurrence" : "?", "description" : "
     The options for the parsing
    " } ], "returns" : { "type" : "node()*", "description" : "The parsed XML as a document node or a list of nodes, or an empty sequence." }, "errors" : [ "zerr:ZXQD0003 The error will be raised if the options to the function are inconsistent.", "err:FODC0006 The error will be raised if the input string is not a valid XML document or fragment (external general parsed entity) or if DTD validation was enabled and the document has not passed it.", "err:XQDY0027 The error will be raised if schema validation was enabled and the input document has not passed it or if the parsing options are not conformant to the xml-options.xsd schema." ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/process" : { "ns" : "http://www.zorba-xquery.com/modules/process", "description" : " This module provides functions to create a native process and return the result\n (i.e. exit code, result on standard out and error).\n 
    \n Example:\n
    \n  import module namespace proc = \"http://www.zorba-xquery.com/modules/process\";\n  proc:exec(\"ls\")\n
    \n 
    \n 
    \n Potential result:\n 
    \n <result xmlns=\"http://www.zorba-xquery.com/modules/process\">\n   <stdout>myfile.txt</stout>\n   <stderr/>\n   <exit-code>0</exit-code>\n </result>\n 
    \n 
    \n", "sees" : [  ], "authors" : [ "Cezar Andrei" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.zorba-xquery.com/modules/process", "prefix" : "process" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "exec", "qname" : "process:exec", "signature" : "($cmd as xs:string) as element(process:result) external", "description" : " Executes the specified string command in a separate process.\n This function does not allow arguments to be passed to\n the command.\n", "summary" : "
     Executes the specified string command in a separate process.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "cmd", "type" : "xs:string", "occurrence" : null, "description" : "
     command to be executed (without arguments)
    " } ], "returns" : { "type" : "element(process:result)", "description" : "the result of the execution as an element as shown in the documentation of this module. The exit-code element returns the exit code of the child process. For POSIX compliant platforms: returns the process exit code. If process is terminated or stopped: 128 + termination signal code. For Windows platforms: returns the return value of the process or the exit or terminate process specified value." }, "errors" : [ "process:PROC01 if an error occurred while communicating with the executed process." ] }, { "isDocumented" : true, "arity" : 2, "name" : "exec", "qname" : "process:exec", "signature" : "($cmd as xs:string, $args as xs:string*) as element(process:result) external", "description" : " Executes the specified string command in a separate process.\n Each of the strings in the sequence passed in as the second\n argument is passed as an argument to the executed command.\n", "summary" : "
     Executes the specified string command in a separate process.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "cmd", "type" : "xs:string", "occurrence" : null, "description" : "
     command to be executed (without arguments)
    " }, { "name" : "args", "type" : "xs:string", "occurrence" : "*", "description" : "
     the arguments passed to the executed command (e.g. \"-la\")
    " } ], "returns" : { "type" : "element(process:result)", "description" : "the result of the execution as an element as shown in the documentation of this module. The exit-code element returns the exit code of the child process. For POSIX compliant platforms: returns the process exit code. If process is terminated or stopped: 128 + termination signal code. For Windows platforms: returns the return value of the process or the exit or terminate process specified value." }, "errors" : [ "process:PROC01 if an error occurred while communicating with the executed process." ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/maps" : { "ns" : "http://www.28msec.com/modules/maps", "description" : " 
    This module defines a set of functions for working with maps. A map\n is identified by a string and can be created using the map:create function\n and dropped using the map:drop function.
    \n 
    It is possible to create persistent and transient maps. The lifetime of a\n transient map is limited by the execution of the current query.\n A persistent map lives until it is explicitly dropped.\n Accordingly, it is also available to other requests.
    \n 
    For example,\n 
    map:create(\"my-map\", [\"string\", \"integer\"], { \"persistent\" : false })
    \n will create a transient map named my-map having two keys.\n The types of the keys are string and integer.\n 
    \n 
    The key of a particular entry in the map can consist of a tuple of\n atomic values (called key attributes). The actual type of each attribute\n is determined when the map is created. The value of each entry is a\n sequence of items. If an item in this sequence is a object or array,\n this item needs to belong to a collection, otherwise, an error is raised.
    \n 
    For every persistent map, 28.io will create a new collection\n in your MongoDB database. The collection will have the prefix _28.map.\n For example, if your map is called foo, the according collection will\n be named _28.map.foo.
    \n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/maps", "prefix" : "map" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "available-maps", "qname" : "map:available-maps", "signature" : "() as string* external", "description" : " The function returns a sequence of names of the maps that are\n available (persistent and non-persistent). The sequence will be\n empty if there are no maps.\n", "summary" : "
     The function returns a sequence of names of the maps that are\n available (persistent and non-persistent).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string*", "description" : "A sequence of string, one for each available map, or an emtpy sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "create", "qname" : "map:create", "signature" : "($name as string, $key-types as item()) as empty-sequence() external", "description" : " Create a persistent map with a given name and type identifiers for the key\n attributes.\n If the map has only one key attribute, a single type identifier is given,\n for more than one key attribute an array of type identifiers is given.\n Calling this function is equivalent to calling create with the options\n 
    { \"persistent\" : true }
    \n Note that the function is sequential and immediately creates the map.\n 
    Each key-type should be specified as string (e.g. \"integer\",\n \"string\", \"boolean\", \"double\", or \"datetime\").
    \n 
    For example,\n 
    map:create(\"my-map\", \"string\")
     or\n 
    map:create(\"my-map\", [\"string\", \"integer\"])
    .
    \n", "summary" : "
     Create a persistent map with a given name and type identifiers for the key\n attributes.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map (the restrictons on collection names apply)
    " }, { "name" : "key-types", "type" : "item()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and immediately creates the corresponding map. It returns the empty-sequence." }, "errors" : [ "err:XPTY0004 if any of the key attribute types is not a subtype of anyAtomicType.", "zerr:ZSTR0001 if a map with the given name already exists.", "zerr:ZDDY1000 if the given name is not a legal collection name", "zerr:ZDDY0043 if any of the given options has an invalid type" ] }, { "isDocumented" : true, "arity" : 3, "name" : "create", "qname" : "map:create", "signature" : "($name as string, $key-types as item(), $options as object()) as empty-sequence() external", "description" : " Create a map with a given name, type identifiers for the key attributes, and\n options.\n If the map has only one key attribute, a single type identifier is given,\n for more than one key attribute an array of type identifiers is given.\n Currently only one option is supported: To create a transient map the object\n { \"persistent\" : false }\n has to be passed to the $options parameter.\n Note that the function is sequential and immediately creates the map in the\n store.\n", "summary" : "
     Create a map with a given name, type identifiers for the key attributes, and\n options.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map (the restrictons on collection names apply)
    " }, { "name" : "key-types", "type" : "item()", "occurrence" : null, "description" : "" }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     an object describing options for the map
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and immediately creates the corresponding map but returns the empty-sequence." }, "errors" : [ "err:XPTY0004 if any of the attribute types is not a subtype of anyAtomicType.", "zerr:ZSTR0001 if a map with the given name already exists.", "zerr:ZDDY1000 if the given name is not a legal collection name", "zerr:ZDDY0043 if any of the given options has an invalid type" ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete", "qname" : "map:delete", "signature" : "($name as string, $key as item()) as empty-sequence() external", "description" : " Removes an entry identified by the given key from the map.\n If the map has only one key attribute, a single key value is given, for\n more than one key attribute an array of key values is given.\n Note that it is possible to insert entries with empty key attributes.\n However as the removing the entries is based on the \"eq\" comparison and\n as \"eq\" with an empty sequence always return false, it is not possible\n to delete these entries.\n", "summary" : "
     Removes an entry identified by the given key from the map.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map
    " }, { "name" : "key", "type" : "item()", "occurrence" : null, "description" : "
     either a single attribute key or an array of keys
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and immediately deletes the entry into the map but returns the empty-sequence." }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist.", "zerr:ZDDY0025 if the given number of key attributes does not match the number of key attributes specified when creating the map (see the map:create function).", "zerr:ZXQD0005 if any of the given key attributes can not be cast (or is not a subtype) of the corresponding key attribute specified when creating the map." ] }, { "isDocumented" : true, "arity" : 1, "name" : "drop", "qname" : "map:drop", "signature" : "($name as string) as empty-sequence() external", "description" : " Deletes the map with the given name.\n", "summary" : "
     Deletes the map with the given name.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map to drop
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and immediately drops the map. It returns the empty-sequence." }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist." ] }, { "isDocumented" : true, "arity" : 2, "name" : "get", "qname" : "map:get", "signature" : "($name as string, $key as item()) as item()* external", "description" : " Returns the value of the entry with the given key from the map.\n If the map has only one key attribute, a single key value is given, for\n more than one key attribute an array of key values is given.\n Note that it is possible to insert entries with empty key attributes.\n However as the getting the entries is based on the \"eq\" comparison and\n as \"eq\" with an empty sequence always return false, it is not possible\n to retrieve these entries.\n 
    For example,\n 
    map:get(\"my-map\", \"key\")
     or\n 
    map:get(\"my-map\", [ \"key1\", \"key2\" ])
    .
    \n", "summary" : "
     Returns the value of the entry with the given key from the map.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map
    " }, { "name" : "key", "type" : "item()", "occurrence" : null, "description" : "
     either a single attribute key or an array of keys
    " } ], "returns" : { "type" : "item()*", "description" : "the value of the entry in the map identified by the given key. The empty-sequence will be returned if no entry with the given key is contained in the map." }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist.", "zerr:ZDDY0025 if the given number of key attributes does not match the number of key attributes specified when creating the map (see the map:create function).", "zerr:ZXQD0005 if any of the given key attributes can not be cast (or is not a subtype) of the corresponding key attribute specified when creating the map." ] }, { "isDocumented" : true, "arity" : 3, "name" : "insert", "qname" : "map:insert", "signature" : "($name as string, $key as item(), $value as item()*) as empty-sequence() external", "description" : " Inserts a new entry into the map with the given name.\n If the map has only one key attribute, a single key value is given, for\n more than one key attribute an array of key values is given.\n If an entry with the given key already exists in the map, the value\n sequences of the existing entry and the sequence passed using $value\n argument are concatenated.\n 
    If a map is persistent and if an item in the value sequence\n is an object or array, this item needs to belong to a collection,\n otherwise, an an error is raised.
    \n Note that it is possible to insert entries with empty key attributes\n or key attributes having the value null. However, as\n the comparison with an empty sequence or null always returns false,\n it is not possible to retrieve these entries.\n 
    For example,\n 
    map:insert(\"my-map\", \"key\", \"value\")
     or\n 
    map:insert(\"my-map\", [ \"key1\", \"key2\" ] , (42, \"value\"))
    .
    \n", "summary" : "
     Inserts a new entry into the map with the given name.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map
    " }, { "name" : "key", "type" : "item()", "occurrence" : null, "description" : "
     either a single attribute key or an array of keys
    " }, { "name" : "value", "type" : "item()", "occurrence" : "*", "description" : "
     the value of the entry to insert
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and immediately inserts the entry into the map. It returns the empty-sequence." }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist.", "zerr:ZDDY0025 if the given number of key attributes does not match the number of key attributes specified when creating the map (see the map:create function).", "zerr:ZXQD0005 if any of the given key attributes can not be cast (or is not a subtype) of the corresponding key attribute specified when creating the map.", "zerr:ZDDY1003 if the value to insert is an object or array it must belong to a collection." ] }, { "isDocumented" : true, "arity" : 1, "name" : "keys", "qname" : "map:keys", "signature" : "($name as string) as array()* external", "description" : " Returns the keys of all entries of a map. The keys\n are returned as sequence of arrays.\n The following condition always holds:\n map:size($name) eq count(map:keys($name))\n", "summary" : "
     Returns the keys of all entries of a map.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map
    " } ], "returns" : { "type" : "array()*", "description" : "an sequence of arrays each array containing the values of all attributes of one key." }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist." ] }, { "isDocumented" : true, "arity" : 1, "name" : "options", "qname" : "map:options", "signature" : "($name as string) as object() external", "description" : " The function returns the options that were passed during creation or the\n default options if no options were passed.\n", "summary" : "
     The function returns the options that were passed during creation or the\n default options if no options were passed.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map
    " } ], "returns" : { "type" : "object()", "description" : "an options object" }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist." ] }, { "isDocumented" : true, "arity" : 1, "name" : "size", "qname" : "map:size", "signature" : "($name as string) as integer external", "description" : " The number of entries in a map.\n The following condition always holds:\n map:size($name) eq count(map:keys($name))\n", "summary" : "
     The number of entries in a map.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     the name of the map
    " } ], "returns" : { "type" : "integer", "description" : "the number of entries in the map." }, "errors" : [ "zerr:ZDDY0023 if a map with the given name does not exist." ] } ], "variables" : [  ] }, "http://www.w3.org/2005/xpath-functions/math" : { "ns" : "http://www.w3.org/2005/xpath-functions/math", "description" : " This module contains all the functions part of the\n W3C XPath and XQuery Functions and Operators 3.0\n section \"4.7 Trigonometric and exponential functions\".\n", "sees" : [ "http://www.w3.org/TR/xpath-functions-30/#trigonometry" ], "authors" : [ "www.w3c.org" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xpath-functions/math", "prefix" : "math" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "acos", "qname" : "math:acos", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the arc cosine of the argument, the result being in the range zero to\n                +π radians.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the arc cosine of $θ,\n             treated as an angle in radians, as defined in the \n             specification of the acos function applied to 64-bit binary floating point\n             values.
    The treatment of the invalidOperation exception is defined in . 
    If $arg is NaN, or if its absolute value is greater than one,\n             then the result is NaN.
    In other cases the result is an xs:double value representing an angle\n                θ in radians in the range 0 <= $θ <=\n                +π. 
    \n", "summary" : "
      Returns the arc cosine of the argument, the result being in the range zero to\n                + π  radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "asin", "qname" : "math:asin", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the arc sine of the argument, the result being in the range\n                -π/2 to +π/2 radians.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the arc sine of $θ,\n             treated as an angle in radians, as defined in the \n             specification of the asin function applied to 64-bit binary floating point\n             values.
    The treatment of the invalidOperation and underflow exceptions\n             is defined in . 
    If $arg is positive or negative zero, the result is $arg.
    If $arg is NaN, or if its absolute value is greater than one,\n             then the result is NaN.
    In other cases the result is an xs:double value representing an angle\n                θ in radians in the range -π/2 <=\n                $θ <= +π/2. 
    \n", "summary" : "
      Returns the arc sine of the argument, the result being in the range\n                - π /2 to + π /2 radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "atan", "qname" : "math:atan", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the arc tangent of the argument, the result being in the range\n                -π/2 to +π/2 radians.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the arc tangent of $θ,\n             treated as an angle in radians, as defined in the \n             specification of the atan function applied to 64-bit binary floating point\n             values.
    The treatment of the underflow exception is defined in . 
    If $arg is positive or negative zero, the result is $arg.
    If $arg is NaN then the result is NaN.
    In other cases the result is an xs:double value representing an angle\n                θ in radians in the range -π/2 <=\n                $θ <= +π/2. 
    \n", "summary" : "
      Returns the arc tangent of the argument, the result being in the range\n                - π /2 to + π /2 radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "atan2", "qname" : "math:atan2", "signature" : "($y as xs:double, $x as xs:double) as xs:double external", "description" : " 
    Returns the angle in radians subtended at the origin by the point on a plane\n             with coordinates (x, y) and the positive x-axis, the result being in the range\n                -π to +π.
    This function is deterministic, context-independent,  and focus-independent. 
    The result is the value of atan2(y, x) as defined in the\n                 specification of the atan2 function applied\n             to 64-bit binary floating point values.
    The treatment of the underflow exception is defined in . 
    If either argument is NaN\n             then the result is NaN.
    If $y is positive and $x is positive and finite, then\n             (subject to rules for overflow, underflow and approximation)\n          the value of atan2($y, $x) is atan($y div $x).
    If $y is positive and $x is negative and finite, then\n             (subject to the same caveats)\n             the value of atan2($y, $x) is π - atan($y div $x).
    Some results for special values of the arguments are shown in the examples below.
    \n", "summary" : "
      Returns the angle in radians subtended at the origin by the point on a plane\n             with coordinates (x, y) and the positive x-axis, the result being in the range\n                - π  to + π .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "y", "type" : "xs:double", "occurrence" : null, "description" : "" }, { "name" : "x", "type" : "xs:double", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "cos", "qname" : "math:cos", "signature" : "($theta as xs:double?) as xs:double? external", "description" : " 
    Returns the cosine of the argument, expressed in radians.
    This function is deterministic, context-independent,  and focus-independent. 
    If $θ is the empty sequence, the function returns the empty\n             sequence.
    If $θ is positive or negative infinity, or NaN,\n             then the result is NaN.
    Otherwise the result is the cosine of $θ,\n             treated as an angle in radians, as defined in the \n             specification of the cos function applied to 64-bit binary floating point\n             values.
    The treatment of the invalidOperation exception is defined in . 
    If $θ is positive or negative zero, the result is\n                $θ.
    If $θ is positive or negative infinity, or NaN,\n             then the result is NaN.
    Otherwise the result is always in the range -1.0e0 to +1.0e0
    \n", "summary" : "
      Returns the cosine of the argument, expressed in radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "theta", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "exp", "qname" : "math:exp", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the value of ex.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the mathematical constant e\n             raised to the power of $arg, as defined in the \n             specification of the exp function applied to 64-bit binary floating point\n             values.
    The treatment of overflow and underflow is defined in .
    \n", "summary" : "
      Returns the value of  e x .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "exp10", "qname" : "math:exp10", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the value of 10x.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is ten raised to the power of $arg,\n             as defined in the  specification of the exp10\n             function applied to 64-bit binary floating point values.
    The treatment of overflow and underflow is defined in .
    \n", "summary" : "
      Returns the value of  10 x .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "log", "qname" : "math:log", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the natural logarithm of the argument.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the natural logarithm of $arg, as\n             defined in the  specification of the log\n             function applied to 64-bit binary floating point values.
    The treatment of divideByZero and invalidOperation exceptions\n             is defined in . The effect is that if the argument is less\n             than or equal to zero, the result is NaN.
    \n", "summary" : "
      Returns the natural logarithm of the argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "log10", "qname" : "math:log10", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the base-ten logarithm of the argument.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the base-10 logarithm of $arg, as\n             defined in the  specification of the log10\n             function applied to 64-bit binary floating point values.
    The treatment of divideByZero and invalidOperation exceptions\n             is defined in . The effect is that if the argument is less\n             than or equal to zero, the result is NaN.
    \n", "summary" : "
      Returns the base-ten logarithm of the argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "pi", "qname" : "math:pi", "signature" : "() as xs:double external", "description" : " 
    Returns an approximation to the mathematical constant π.
    This function is deterministic, context-independent,  and focus-independent. 
    This function returns the xs:double value whose lexical representation is\n             3.141592653589793e0
    The expression 2*math:pi() returns 6.283185307179586e0.
    The expression 60 * (math:pi() div 180) converts an angle of 60 degrees\n                to radians. 
    \n", "summary" : "
      Returns an approximation to the mathematical constant  π .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "pow", "qname" : "math:pow", "signature" : "($x as xs:double?, $y as numeric) as xs:double? external", "description" : " 
    Returns the result of raising the first argument to the power of the\n             second.
    This function is deterministic, context-independent,  and focus-independent. 
    If $x is the empty sequence, the function returns the empty sequence.
    If $y is an instance of xs:integer, the result is\n                $x raised to the power of $y as defined in the  specification of the pown function applied to a\n             64-bit binary floating point value and an integer.
    Otherwise $y is converted to an xs:double by numeric\n             promotion, and the result is the value of $x raised to the power of\n                $y as defined in the  specification of the\n                pow function applied to two 64-bit binary floating point values.
    The treatment of the divideByZero and invalidOperation\n             exceptions is defined in . Some of the consequences are\n             illustrated in the examples below.
    \n", "summary" : "
      Returns the result of raising the first argument to the power of the\n             second.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "x", "type" : "xs:double", "occurrence" : "?", "description" : "" }, { "name" : "y", "type" : "numeric", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sin", "qname" : "math:sin", "signature" : "($theta as xs:double?) as xs:double? external", "description" : " 
    Returns the sine of the argument, expressed in radians.
    This function is deterministic, context-independent,  and focus-independent. 
    If $θ is the empty sequence, the function returns the empty\n             sequence.
    Otherwise the result is the sine of $θ,\n             treated as an angle in radians, as defined in the \n             specification of the sin function applied to 64-bit binary floating point\n             values.
    The treatment of the invalidOperation and underflow exceptions\n             is defined in . 
    If $θ is positive or negative zero, the result is\n                $θ.
    If $θ is positive or negative infinity, or NaN,\n             then the result is NaN.
    Otherwise the result is always in the range -1.0e0 to +1.0e0
    \n", "summary" : "
      Returns the sine of the argument, expressed in radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "theta", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sqrt", "qname" : "math:sqrt", "signature" : "($arg as xs:double?) as xs:double? external", "description" : " 
    Returns the non-negative square root of the argument.
    This function is deterministic, context-independent,  and focus-independent. 
    If $arg is the empty sequence, the function returns the empty sequence.
    Otherwise the result is the mathematical non-negative square root of\n                $arg as defined in the  specification of the\n                squareRoot function applied to 64-bit binary floating point values.
    The treatment of the invalidOperation exception is defined in . The effect is that if the argument is less than zero, the result\n             is NaN.
    If $arg is positive or negative zero, positive infinity, or\n                NaN, then the result is $arg. (Negative zero is the only\n             case where the result can have negative sign)
    \n", "summary" : "
      Returns the non-negative square root of the argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "tan", "qname" : "math:tan", "signature" : "($theta as xs:double?) as xs:double? external", "description" : " 
    Returns the tangent of the argument, expressed in radians.
    This function is deterministic, context-independent,  and focus-independent. 
    If $θ is the empty sequence, the function returns the empty\n             sequence.
    Otherwise the result is the tangent of $θ,\n             treated as an angle in radians, as defined in the \n             specification of the tan function applied to 64-bit binary floating point\n             values.
    The treatment of the invalidOperation and underflow exceptions\n             is defined in . 
    If $θ is positive or negative infinity, or NaN,\n             then the result is NaN.
    \n", "summary" : "
      Returns the tangent of the argument, expressed in radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "theta", "type" : "xs:double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:double?", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/oauth/client" : { "ns" : "http://www.zorba-xquery.com/modules/oauth/client", "description" : " This module provides the functions necessary to acquire access to the personal\n resources of a user through the open standard called\n OAuth.\n The application/mashup creator does not need to know the\n specifics of OAuth to use this module.\n", "sees" : [ "OAuth Website" ], "authors" : [ "Stephanie Russell", "William Candillon" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/base64", "prefix" : "base64" }, { "uri" : "http://zorba.io/features", "prefix" : "f" }, { "uri" : "http://zorba.io/modules/hmac", "prefix" : "hmac" }, { "uri" : "http://expath.org/ns/http-client", "prefix" : "http" }, { "uri" : "http://expath.org/ns/http-client", "prefix" : "http-client" }, { "uri" : "http://www.zorba-xquery.com/modules/oauth/client", "prefix" : "oauth" }, { "uri" : "http://www.zorba-xquery.com/modules/oauth/error", "prefix" : "oerr" }, { "uri" : "http://zorba.io/options/features", "prefix" : "op" }, { "uri" : "http://www.zorba-xquery.com/schemas/oauth/parameters", "prefix" : "p" }, { "uri" : "http://zorba.io/modules/random", "prefix" : "ra" }, { "uri" : "http://www.zorba-xquery.com/schemas/oauth/service-provider", "prefix" : "sp" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "access-token", "qname" : "oauth:access-token", "signature" : "($service-provider as schema-element(sp:service-provider), $parameters as schema-element(p:parameters)) as schema-element(p:parameters)", "description" : " This function allows the client to obtain a set of token credentials from the service provider by making an authenticated HTTP request to the Token Request endpoint.\n This function is provided for convenience.\n", "summary" : "
     This function allows the client to obtain a set of token credentials from the service provider by making an authenticated HTTP request to the Token Request endpoint.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "service-provider", "type" : "schema-element(sp:service-provider)", "occurrence" : null, "description" : "
     Contains service provider information
    " }, { "name" : "parameters", "type" : "schema-element(p:parameters)", "occurrence" : null, "description" : "
     parameters
    " } ], "returns" : { "type" : "schema-element(p:parameters)", "description" : "token credentials correctly parsed as parameter elements, or an error if http response status is not 200 OK 
     let $service-provider := oauth:service-provider(...) let $parameters := oauth:parameters(\"oauth_token\", \"#\") let $parameters := oauth:add-parameter($parameters, \"oauth_token_secret\", \"#\") let $tokens := oauth:access-token($service-provider, $parameters) ... 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "add-parameter", "qname" : "oauth:add-parameter", "signature" : "($parameters as schema-element(p:parameters)?, $name as xs:string, $value as xs:string) as schema-element(p:parameters)", "description" : " Adds an OAuth parameter to an OAuth Parameters instance.\n Instances of OAuth parameters are used to\n contain value/pair data such as oauth_token\n and oauth_token_secret.\n For instance the following code snippet:\n 
    \n  let $params := oauth:parameters(\"oauth_token\", \"#\")\n  let $params := oauth:add-parameter($params, \"oauth_token_secret\", \"#\")\n  return $params\n 
    \n Returns the following XML schema instance:\n 
    \n \n   \n   \n \n 
    \n", "summary" : "
     Adds an OAuth parameter to an OAuth Parameters instance.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "parameters", "type" : "schema-element(p:parameters)", "occurrence" : "?", "description" : "
     parameters
    " }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     parameter name
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     parameter value
    " } ], "returns" : { "type" : "schema-element(p:parameters)", "description" : "instance of the OAuth parameters XML schema." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "parameter", "qname" : "oauth:parameter", "signature" : "($params as schema-element(p:parameters), $string as xs:string) as xs:string", "description" : " This function returns the string value of the parameters whose key matches a $string input.\n", "summary" : "
     This function returns the string value of the parameters whose key matches a $string input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "params", "type" : "schema-element(p:parameters)", "occurrence" : null, "description" : "
     element parameters
    " }, { "name" : "string", "type" : "xs:string", "occurrence" : null, "description" : "
     string as the \"key\" name
    " } ], "returns" : { "type" : "xs:string", "description" : "string value of the parameter with key $string 
     let $params := oauth:parameters(\"oauth_token\", \"token\") let $params := oauth:add-parameter($params, \"oauth_token_secret\", \"secret\") let $token-secret := oauth:parameter($params, \"oauth_token_secret\") return $token-secret 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "parameters", "qname" : "oauth:parameters", "signature" : "($name as xs:string, $value as xs:string) as element(p:parameters)", "description" : " Create an OAuth Parameters instance.\n Instances of OAuth parameters are used to\n contain value/pair data such as oauth_token\n and oauth_token_secret.\n For instance the following code snippet:\n 
    \n  oauth:parameters(\"oauth_token\", \"#\")\n 
    \n Returns the following XML schema instance:\n 
    \n \n   \n \n 
    \n", "summary" : "
     Create an OAuth Parameters instance.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     parameter name
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     parameter value
    " } ], "returns" : { "type" : "element(p:parameters)", "description" : "instance of the OAuth parameters XML schema." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "protected-resource", "qname" : "oauth:protected-resource", "signature" : "($protected-resource as schema-element(http:request), $service-provider as schema-element(sp:service-provider), $parameters as schema-element(p:parameters)) as item()*", "description" : " This function allows the client access to the protected resources of the user.\n This function is provided for convenience.\n", "summary" : "
     This function allows the client access to the protected resources of the user.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "protected-resource", "type" : "schema-element(http:request)", "occurrence" : null, "description" : "
     (Not schema-validated) http:request element with http method and href.
    " }, { "name" : "service-provider", "type" : "schema-element(sp:service-provider)", "occurrence" : null, "description" : "
     Information about the service provider
    " }, { "name" : "parameters", "type" : "schema-element(p:parameters)", "occurrence" : null, "description" : "
     parameters
    " } ], "returns" : { "type" : "item()*", "description" : "protected resources parsed as parameter elements, or an error if http response status is not 200 OK 
     let $tokens := oauth:parameters(\"oauth_token\", \"#\") let $tokens := oauth:add-parameter($tokens, \"oauth_token_secret\", \"#\") let $service-provider := oauth:service-provider(...) let $request := validate {  } return oauth:protected-resource($request, $service-provider, $tokens) 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "request-token", "qname" : "oauth:request-token", "signature" : "($service-provider as schema-element(sp:service-provider)) as schema-element(p:parameters)", "description" : " This function allows the client to obtain a set of temporary credentials from the service provider by making an authenticated HTTP request to the Temporary Credential Request endpoint.\n This function is provided for convenience for request-token#2.\n Invoking this function is equivalent to:\n 
    \n oauth:request-token($service-provider, ())\n 
    \n", "summary" : "
     This function allows the client to obtain a set of temporary credentials from the service provider by making an authenticated HTTP request to the Temporary Credential Request endpoint.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "service-provider", "type" : "schema-element(sp:service-provider)", "occurrence" : null, "description" : "
     Information about the service provider
    " } ], "returns" : { "type" : "schema-element(p:parameters)", "description" : "temporary credentials correctly parsed as parameter elements, or an error if http response status is not 200 OK" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "request-token", "qname" : "oauth:request-token", "signature" : "($service-provider as schema-element(sp:service-provider), $parameters as schema-element(p:parameters)?) as schema-element(p:parameters)", "description" : " This function allows the client to obtain a set of temporary credentials from the service provider by making an authenticated HTTP request to the Temporary Credential Request endpoint.\n This function is provided for convenience.\n", "summary" : "
     This function allows the client to obtain a set of temporary credentials from the service provider by making an authenticated HTTP request to the Temporary Credential Request endpoint.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "service-provider", "type" : "schema-element(sp:service-provider)", "occurrence" : null, "description" : "
     Information about the service provider
    " }, { "name" : "parameters", "type" : "schema-element(p:parameters)", "occurrence" : "?", "description" : "
     Additionnal parameters to the request
    " } ], "returns" : { "type" : "schema-element(p:parameters)", "description" : "temporary credentials correctly parsed as parameter elements, or an error if http response status is not 200 OK 
     let $twitter-config := oauth:service-provider(...) let $additional-parameter := oauth:parameters(\"foo\", \"bar\") let $tokens := oauth:request-token($twitter-config, $additional-parameter) let $token := oauth:parameter($tokens, \"oauth_token\") let $token-secret := oauth:parameter($tokens, \"oauth_token_secret\") ... 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 10, "name" : "service-provider", "qname" : "oauth:service-provider", "signature" : "($consumer-key as xs:string, $consumer-secret as xs:string, $signature-method as xs:string, $realm as xs:string, $authorize-url as xs:string, $request-token-method as xs:string, $request-token-url as xs:string, $request-token-callback-url as xs:string, $access-token-method as xs:string, $access-token-url as xs:string) as schema-element(sp:service-provider)", "description" : " Utility function to build a service provider object.\n This object contains the information required by the\n OAuth client to interact with an OAuth service provider.\n For instance the following expression:\n 
    \n let $consumer-key     := \"#\"\n let $consumer-secret  := \"#\"\n let $signature-method := \"HMAC-SHA1\"\n let $realm            := \"twitter.com\"\n let $authorize-url    := \"http://api.twitter.com/oauth/authorize\"\n let $request-token-method := \"POST\"\n let $request-token-url := \"https://twitter.com/oauth/request_token\"\n let $request-token-callback-url := \"https://twitter.com/oauth/request_token\"\n let $access-token-method := \"POST\"\n let $access-token-url := \"https://api.twitter.com/oauth/access_token\"\n return oauth:service-provider(\n   $consumer-key, $consumer-secret, $signature-method,\n   $realm, $authorize-url, $request-token-method,\n   $request-token-url, $request-token-callback-url,\n   $access-token-method, $access-token-url\n )\n 
    \n Will return the following XML schema instance:\n 
    \n \n   \n   \n \n 
    \n", "summary" : "
     Utility function to build a service provider object.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "consumer-key", "type" : "xs:string", "occurrence" : null, "description" : "
     Client Identifier, also known as the consumer-key
    " }, { "name" : "consumer-secret", "type" : "xs:string", "occurrence" : null, "description" : "
     Client Shared-Secret, also known as the consumer-secret
    " }, { "name" : "signature-method", "type" : "xs:string", "occurrence" : null, "description" : "
     Method with which the signing key is signed (typically HMAC-SHA1)
    " }, { "name" : "realm", "type" : "xs:string", "occurrence" : null, "description" : "
     Realm that defines the protection space
    " }, { "name" : "authorize-url", "type" : "xs:string", "occurrence" : null, "description" : "
     authorize-url
    " }, { "name" : "request-token-method", "type" : "xs:string", "occurrence" : null, "description" : "
     request-token-method
    " }, { "name" : "request-token-url", "type" : "xs:string", "occurrence" : null, "description" : "
     request-token-url
    " }, { "name" : "request-token-callback-url", "type" : "xs:string", "occurrence" : null, "description" : "
     request-token-callback-url
    " }, { "name" : "access-token-method", "type" : "xs:string", "occurrence" : null, "description" : "
     access-token-method
    " }, { "name" : "access-token-url", "type" : "xs:string", "occurrence" : null, "description" : "
     access-token-url
    " } ], "returns" : { "type" : "schema-element(sp:service-provider)", "description" : "instance of the OAuth service provider XML schema." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/http/util/multipart" : { "ns" : "http://www.28msec.com/modules/http/util/multipart", "description" : " This module provides utility functions to help dealing with the\n content of multipart requests.\n In their implementation, all the functions use the multipart\n related functions of the request module (e.g. parts() or text-part()).\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.28msec.com/modules/http/util/multipart", "prefix" : "multipart" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "binary-content", "qname" : "multipart:binary-content", "signature" : "($name as xs:string) as xs:base64Binary*", "description" : " Returns the contents of the parts/files in the multipart requests with\n the given part name as xs:base64Binary.\n", "summary" : "
     Returns the contents of the parts/files in the multipart requests with\n the given part name as xs:base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested part.
    " } ], "returns" : { "type" : "xs:base64Binary*", "description" : "the said content or the empty sequence if no part with the given name exists." }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "binary-file", "qname" : "multipart:binary-file", "signature" : "($filename as xs:string) as xs:base64Binary*", "description" : " Returns the contents of the part/file in the multipart requests with\n the given filename as xs:base64Binary.\n Please note that the file is identified by the filename (and not the\n name of the part) that is contained in the Content-Disposition header\n of the part.\n", "summary" : "
     Returns the contents of the part/file in the multipart requests with\n the given filename as xs:base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filename", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested file.
    " } ], "returns" : { "type" : "xs:base64Binary*", "description" : "the said content or the empty sequence if no part with the given filename exists." }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-length", "qname" : "multipart:content-length", "signature" : "($name as xs:string) as xs:integer*", "description" : " Returns the content length of the parts/files in the multipart requests with\n the given part name as xs:integer.\n", "summary" : "
     Returns the content length of the parts/files in the multipart requests with\n the given part name as xs:integer.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested part.
    " } ], "returns" : { "type" : "xs:integer*", "description" : "The content-length in bytes of the parts/files or the empty sequence if the part does not exist" }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type", "qname" : "multipart:content-type", "signature" : "($name as xs:string) as xs:string*", "description" : " Returns the content type of the parts/files in the multipart requests with\n the given part name as xs:string.\n", "summary" : "
     Returns the content type of the parts/files in the multipart requests with\n the given part name as xs:string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested part.
    " } ], "returns" : { "type" : "xs:string*", "description" : "The content-types of the parts/files or the empty sequence if the part does not exist" }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "filename", "qname" : "multipart:filename", "signature" : "($name as xs:string) as xs:string*", "description" : " Returns the filenames of the parts/files in the multipart requests with\n the given part name as xs:string.\n", "summary" : "
     Returns the filenames of the parts/files in the multipart requests with\n the given part name as xs:string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested part.
    " } ], "returns" : { "type" : "xs:string*", "description" : "The filename of the parts/files or the empty sequence if the part does not exist" }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 0, "name" : "filenames", "qname" : "multipart:filenames", "signature" : "() as xs:string*", "description" : " Returns the filenames of all the parts contained in the multipart\n content of the given request.\n", "summary" : "
     Returns the filenames of all the parts contained in the multipart\n content of the given request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "the said filenames" }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 0, "name" : "names", "qname" : "multipart:names", "signature" : "() as xs:string*", "description" : " Returns the names of all the parts contained in the multipart\n content of the given request.\n", "summary" : "
     Returns the names of all the parts contained in the multipart\n content of the given request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "the said names" }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "part", "qname" : "multipart:part", "signature" : "($name as xs:string) as element(req:part)*", "description" : " Returns the req:part element among all the parts contained\n in the multipart requests with the given name.\n", "summary" : "
     Returns the  req:part  element among all the parts contained\n in the multipart requests with the given name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested part.
    " } ], "returns" : { "type" : "element(req:part)*", "description" : "the said part elements or the empty sequence if no part with the given name exists." }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "text-content", "qname" : "multipart:text-content", "signature" : "($name as xs:string) as xs:string*", "description" : " Returns the contents of the parts/files in the multipart requests with\n the given part name as a string.\n It is assumed that the character set of the file is UTF-8.\n", "summary" : "
     Returns the contents of the parts/files in the multipart requests with\n the given part name as a string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested part.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the said content or the empty sequence if no part with the given filename exists." }, "errors" : [ "request:no-text-content if the value of the part cannot be treated as text", "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 1, "name" : "text-file", "qname" : "multipart:text-file", "signature" : "($filename as xs:string) as xs:string*", "description" : " Returns the contents of the part/file in the multipart requests with\n the given filename as a string.\n It is assumed that the character set of the file is UTF-8.\n Please note that the file is identified by the filename (and not the\n name of the part) that is contained in the Content-Disposition header\n of the part.\n", "summary" : "
     Returns the contents of the part/file in the multipart requests with\n the given filename as a string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filename", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the requested file.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the said content or the empty sequence if no part with the given filename exists." }, "errors" : [ "request:no-text-content if the value of the part cannot be treated as text", "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] } ], "variables" : [  ] }, "http://zorba.io/modules/excel/statistical-zorba" : { "ns" : "http://zorba.io/modules/excel/statistical-zorba", "description" : " This module implements some Excel 2003 statistical functions\n that cannot be implemented with standard XQuery functions.\n It uses Zorba specific functions.\n", "sees" : [ "http://office.microsoft.com/en-us/excel/CH062528311033.aspx" ], "authors" : [ "Daniel Turcanu" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/statistical-zorba", "prefix" : "excel" }, { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/math", "prefix" : "excel-math" }, { "uri" : "http://zorba.io/modules/excel/statistical", "prefix" : "excel-statistical" }, { "uri" : "http://www.w3.org/2005/xpath-functions/math", "prefix" : "math" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "stdev", "qname" : "excel:stdev", "signature" : "($numbers as xs:anyAtomicType+) as xs:anyAtomicType", "description" : " Estimates standard deviation based on a sample.\n The standard deviation is a measure of how widely values are dispersed\n   from the average value (the mean).\n It is computed with formula:\n sqrt( sum((x-average_x)^2) / (n-1) )    = sqrt ( VAR(numbers) )\n", "summary" : "
     Estimates standard deviation based on a sample.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "+", "description" : "
     the sequence of numbers or values castable to numeric The sequence can be of any length, from 1 up.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the standard deviation, as numeric type" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 1, "name" : "stdeva", "qname" : "excel:stdeva", "signature" : "($numbers as xs:anyAtomicType+) as xs:anyAtomicType", "description" : " Estimates standard deviation based on a sample.\n The standard deviation is a measure of how widely values are dispersed\n   from the average value (the mean).\n It is computed with formula:\n sqrt( sum((x-average_x)^2) / (n-1) )    = sqrt ( VARA(numbers) )\n", "summary" : "
     Estimates standard deviation based on a sample.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "+", "description" : "
     the sequence of numbers or values castable to numeric The sequence can be of any length, from 1 up.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the standard deviation, as numeric type" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 1, "name" : "stdevp", "qname" : "excel:stdevp", "signature" : "($numbers as xs:anyAtomicType+) as xs:anyAtomicType", "description" : " Calculates standard deviation based on the entire population given as arguments.\n The standard deviation is a measure of how widely values are dispersed from\n   the average value (the mean).\n It is computed with formula:\n sqrt( sum((x-average_x)^2) / n )    = sqrt ( VARP(numbers) )\n", "summary" : "
     Calculates standard deviation based on the entire population given as arguments.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "+", "description" : "
     the sequence of numbers or values castable to numeric The sequence can be of any length, from 1 up.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the standard deviation, as numeric type" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 1, "name" : "stdevpa", "qname" : "excel:stdevpa", "signature" : "($numbers as xs:anyAtomicType+) as xs:anyAtomicType", "description" : " Calculates standard deviation based on the entire population given as arguments.\n The standard deviation is a measure of how widely values are dispersed from\n   the average value (the mean).\n It is computed with formula:\n sqrt( sum((x-average_x)^2) / n )    = sqrt ( VARPA(numbers) )\n", "summary" : "
     Calculates standard deviation based on the entire population given as arguments.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "+", "description" : "
     the sequence of numbers or values castable to numeric The sequence can be of any length, from 1 up.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "the standard deviation, as numeric type" }, "errors" : [ "excel-err:Value if the parameters cannot be casted to numeric type" ] }, { "isDocumented" : true, "arity" : 2, "name" : "subtotal", "qname" : "excel:subtotal", "signature" : "($function_num as xs:integer, $numbers as xs:anyAtomicType*) as xs:anyAtomicType", "description" : " Moved from math module.\n Returns a subtotal in a sequence of numbers.\n The function applied is given by $function_num.\n", "summary" : "
     Moved from math module.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "function_num", "type" : "xs:integer", "occurrence" : null, "description" : "
     
    defines the function to be applied on sequence values. The possible values are: 
    1 or 101
     
     AVERAGE
     
    2 or 102
     
     COUNT
     
    3 or 103
     
     COUNTA
     
    4 or 104
     
     MAX
     
    5 or 105
     
     MIN
     
    6 or 106
     
     PRODUCT
     
    7 or 107
     
     STDEV
     
    8 or 108
     
     STDEVP
     
    9 or 109
     
     SUM
     
    10 or 110
     
     VAR
     
    11 or 111
     
     VARP
     In this implementation there is no difference between x and 10x.
    " }, { "name" : "numbers", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of numbers or values castable to numeric. The sequence can be of any length.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The function result, as numeric type" }, "errors" : [ "depends on the function called", "excel-err:Num if $function_num is not a value between 1 .. 11 or 101 .. 111" ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/debug" : { "ns" : "http://www.28msec.com/modules/debug", "description" : " This module contains internal debug functions.\n", "sees" : [  ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/debug", "prefix" : "debug" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "non-seeakable-streamable-string", "qname" : "debug:non-seeakable-streamable-string", "signature" : "() as string external", "description" : " Returns a non seekable streamable string\n", "summary" : "
     Returns a non seekable streamable string\n
    ", "annotation_str" : " %an:deterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "deterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "a non seekable streamable string" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "test-01-cache", "qname" : "debug:test-01-cache", "signature" : "($arg as xs:integer) as item()* external", "description" : " Equivalent to:\n declare %an:cache function local:test-01-cache($x as xs:integer)\n {\n  if ($x < 10)\n  then $x * $x\n  else if ($x < 20)\n  then ()\n  else ($x, \" == \", $x * $x)\n };\n", "summary" : "
     Equivalent to:\n declare %an:cache function local:test-01-cache($x as xs:integer)\n {\n  if ($x < 10)\n  then $x * $x\n  else if ($x < 20)\n  then ()\n  else ($x, \" == \", $x * $x)\n };\n
    ", "annotation_str" : " %an:cache", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "cache", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:integer", "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "test-01-sd", "qname" : "debug:test-01-sd", "signature" : "($arg as xs:integer) as item()* external", "description" : " Equivalent to:\n declare %an:strictlydeterministic function local:test-01-sd($x as xs:integer)\n {\n  if ($x < 10)\n  then $x * $x\n  else if ($x < 20)\n  then ()\n  else ($x, \" == \", $x * $x)\n };\n", "summary" : "
     Equivalent to:\n declare %an:strictlydeterministic function local:test-01-sd($x as xs:integer)\n {\n  if ($x < 10)\n  then $x * $x\n  else if ($x < 20)\n  then ()\n  else ($x, \" == \", $x * $x)\n };\n
    ", "annotation_str" : " %an:strictlydeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "strictlydeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:integer", "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "test-02-cache", "qname" : "debug:test-02-cache", "signature" : "($arg) as item()* external", "description" : " Equivalent to:\n declare %an:cache function local:test-02-cache($arg)\n {\n   serialize($arg),\n   uuid:uuid()\n };\n", "summary" : "
     Equivalent to:\n declare %an:cache function local:test-02-cache($arg)\n {\n   serialize($arg),\n   uuid:uuid()\n };\n
    ", "annotation_str" : " %an:cache", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "cache", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : null, "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "test-02-sd", "qname" : "debug:test-02-sd", "signature" : "($arg) as item()* external", "description" : " Equivalent to:\n declare %an:strictlydeterministic function local:test-02-sd($arg)\n {\n   serialize($arg),\n   uuid:uuid()\n };\n", "summary" : "
     Equivalent to:\n declare %an:strictlydeterministic function local:test-02-sd($arg)\n {\n   serialize($arg),\n   uuid:uuid()\n };\n
    ", "annotation_str" : " %an:strictlydeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "strictlydeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : null, "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "test-03-cache", "qname" : "debug:test-03-cache", "signature" : "() as item()* external", "description" : " Equivalent to:\n declare %an:cache function local:test-03-cache()\n {\n   { \"a\" : 1 },\n   [1],\n   <a/>,\n   1\n };\n", "summary" : "
     Equivalent to:\n declare %an:cache function local:test-03-cache()\n {\n   { \"a\" : 1 },\n   [1],\n   <a/>,\n   1\n };\n
    ", "annotation_str" : " %an:cache", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "cache", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "test-03-sd", "qname" : "debug:test-03-sd", "signature" : "() as item()* external", "description" : " Equivalent to:\n declare %an:strictlydeterministic function local:test-03-sd()\n {\n   { \"a\" : 1 },\n   [1],\n   <a/>,\n   1\n };\n", "summary" : "
     Equivalent to:\n declare %an:strictlydeterministic function local:test-03-sd()\n {\n   { \"a\" : 1 },\n   [1],\n   <a/>,\n   1\n };\n
    ", "annotation_str" : " %an:strictlydeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "strictlydeterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "test-04-cache", "qname" : "debug:test-04-cache", "signature" : "($x, $y) as item()* external", "description" : " Equivalent to:\n declare %an:cache function local:test-04-cache($x, $y)\n {\n   debug:non-seeakable-streamable-string(),\n   {\"key\" : debug:non-seeakable-streamable-string()},\n   [debug:non-seeakable-streamable-string()],\n   <a>{debug:non-seeakable-streamable-string()}</a>\n   serialize($x),\n   serialize($y)\n };\n", "summary" : "
     Equivalent to:\n declare %an:cache function local:test-04-cache($x, $y)\n {\n   debug:non-seeakable-streamable-string(),\n   {\"key\" : debug:non-seeakable-streamable-string()},\n   [debug:non-seeakable-streamable-string()],\n   <a>{debug:non-seeakable-streamable-string()}</a>\n   serialize($x),\n   serialize($y)\n };\n
    ", "annotation_str" : " %an:cache", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "cache", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "x", "type" : null, "occurrence" : null, "description" : "
     as described above
    " }, { "name" : "y", "type" : null, "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "test-04-sd", "qname" : "debug:test-04-sd", "signature" : "($x, $y) as item()* external", "description" : " Equivalent to:\n declare %an:strictlydeterministic function local:test-04-sd($x, $y)\n {\n   debug:non-seeakable-streamable-string(),\n   {\"key\" : debug:non-seeakable-streamable-string()},\n   [debug:non-seeakable-streamable-string()],\n   <a>{debug:non-seeakable-streamable-string()}</a>\n   serialize($x),\n   serialize($y)\n };\n", "summary" : "
     Equivalent to:\n declare %an:strictlydeterministic function local:test-04-sd($x, $y)\n {\n   debug:non-seeakable-streamable-string(),\n   {\"key\" : debug:non-seeakable-streamable-string()},\n   [debug:non-seeakable-streamable-string()],\n   <a>{debug:non-seeakable-streamable-string()}</a>\n   serialize($x),\n   serialize($y)\n };\n
    ", "annotation_str" : " %an:strictlydeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "strictlydeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "x", "type" : null, "occurrence" : null, "description" : "
     as described above
    " }, { "name" : "y", "type" : null, "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "test-05-cache", "qname" : "debug:test-05-cache", "signature" : "($x as xs:boolean, $y) as item()* external", "description" : " Equivalent to:\n declare %an:cache function local:test-05-cache($x as xs:boolean, $y)\n {\n   if ($x)\n   then $y\n   else $x\n };\n", "summary" : "
     Equivalent to:\n declare %an:cache function local:test-05-cache($x as xs:boolean, $y)\n {\n   if ($x)\n   then $y\n   else $x\n };\n
    ", "annotation_str" : " %an:cache", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "cache", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "x", "type" : "xs:boolean", "occurrence" : null, "description" : "
     as described above
    " }, { "name" : "y", "type" : null, "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "test-05-sd", "qname" : "debug:test-05-sd", "signature" : "($x as xs:boolean, $y) as item()* external", "description" : " Equivalent to:\n declare %an:strictlydeterministic function local:test-05-sd($x as xs:boolean, $y)\n {\n   if ($x)\n   then $y\n   else $x\n };\n", "summary" : "
     Equivalent to:\n declare %an:strictlydeterministic function local:test-05-sd($x as xs:boolean, $y)\n {\n   if ($x)\n   then $y\n   else $x\n };\n
    ", "annotation_str" : " %an:strictlydeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "strictlydeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "x", "type" : "xs:boolean", "occurrence" : null, "description" : "
     as described above
    " }, { "name" : "y", "type" : null, "occurrence" : null, "description" : "
     as described above
    " } ], "returns" : { "type" : "item()*", "description" : "as described above" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "uuid", "qname" : "debug:uuid", "signature" : "() as string external", "description" : " This function is not deterministic despite the annotation\n", "summary" : "
     This function is not deterministic despite the annotation\n
    ", "annotation_str" : " %an:deterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "deterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "a uuid" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/json-xml" : { "ns" : "http://zorba.io/modules/json-xml", "description" : " Using this module, you can parse JSON data into XML, manipulate it like any\n other XML data using XQuery, and serialize the result back as JSON.
    \n There are many ways to represent JSON data in XML, some loss-less (\"round\n tripable\") and some lossy (\"one way\").  Loss-less representations preserve\n the JSON data types boolean, number, and null; lossy\n representations convert all data to strings.\n 
    \n For a loss-less representation, this module implements that proposed by\n John Snelson.\n For example:\n 
    \n   {\n     \"firstName\" : \"John\",\n     \"lastName\" : \"Smith\",\n     \"address\" : {\n       \"streetAddress\" : \"21 2nd Street\",\n       \"city\" : \"New York\",\n       \"state\" : \"NY\",\n       \"postalCode\" : 10021\n     },\n     \"phoneNumbers\" : [ \"212 732-1234\", \"646 123-4567\" ]\n   }\n 
    \n would be represented as:\n 
    \n   <json type=\"object\">\n     <pair name=\"firstName\" type=\"string\">John</pair>\n     <pair name=\"lastName\" type=\"string\">Smith</pair>\n     <pair name=\"address\" type=\"object\">\n       <pair name=\"streetAddress\" type=\"string\">21 2nd Street</pair>\n       <pair name=\"city\" type=\"string\">New York</pair>\n       <pair name=\"state\" type=\"string\">NY</pair>\n       <pair name=\"postalCode\" type=\"number\">10021</pair>\n     </pair>\n     <pair name=\"phoneNumbers\" type=\"array\">\n       <item type=\"string\">212 732-1234</item>\n       <item type=\"string\">646 123-4567</item>\n     </pair>\n   </json>\n 
    \n For a lossy representation, this module implements\n JsonML (the array form).\n For example:\n 
    \n   [ \"person\",\n     { \"created\" : \"2006-11-11T19:23\",\n       \"modified\" : \"2006-12-31T23:59\" },\n     [ \"firstName\", \"Robert\" ],\n     [ \"lastName\", \"Smith\" ],\n     [ \"address\",\n       { \"type\" : \"home\" },\n       [ \"street\", \"12345 Sixth Ave\" ],\n       [ \"city\", \"Anytown\" ],\n       [ \"state\", \"CA\" ],\n       [ \"postalCode\", \"98765-4321\" ]\n     ]\n   ]\n 
    \n would be represented as:\n 
    \n   <person created=\"2006-11-11T19:23\" modified=\"2006-12-31T23:59\">\n     <firstName>Robert</firstName>\n     <lastName>Smith</lastName>\n     <address type=\"home\">\n       <street>12345 Sixth Ave</street>\n       <city>Anytown</city>\n       <state>CA</state>\n       <postalCode>98765-4321</postalCode>\n     </address>\n   </person>\n 
    \n", "sees" : [  ], "authors" : [ "Paul J. Lucas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/json-xml", "prefix" : "jx" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "json-to-xml", "qname" : "jx:json-to-xml", "signature" : "($json as json-item()?) as element(*,xs:untyped)?", "description" : " Converts JSON data into an XDM instance using the Snelson representation\n described above.
    \n", "summary" : "
     Converts JSON data into an XDM instance using the Snelson representation\n described above.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "json", "type" : "json-item()", "occurrence" : "?", "description" : "
     The JSON data.
    " } ], "returns" : { "type" : "element(*,xs:untyped)?", "description" : "said XDM instance." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "json-to-xml", "qname" : "jx:json-to-xml", "signature" : "($json as json-item()?, $options as object()) as element(*,xs:untyped)?", "description" : " Converts JSON data into an XDM instance using one of the representations\n described above.
    \n", "summary" : "
     Converts JSON data into an XDM instance using one of the representations\n described above.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "json", "type" : "json-item()", "occurrence" : "?", "description" : "
     The JSON data.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The JSON conversion options, for example: 
     { \"json-format\" : \"JsonML-array\" } 
    " } ], "returns" : { "type" : "element(*,xs:untyped)?", "description" : "said XDM instance." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "xml-to-json", "qname" : "jx:xml-to-json", "signature" : "($xml as item()*) as json-item()*", "description" : " Converts XML data into a JSON item using the Snelson representation\n described above.
    \n", "summary" : "
     Converts XML data into a JSON item using the Snelson representation\n described above.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml", "type" : "item()", "occurrence" : "*", "description" : "
     The XML data to convert.
    " } ], "returns" : { "type" : "json-item()*", "description" : "said JSON items." }, "errors" : [ "zerr:ZJSE0001 if $xml is not a document or element node.", "zerr:ZJSE0002 if $xml contains an element that is missing a required attribute.", "zerr:ZJSE0003 if $xml contains an attribute having an illegal value.", "zerr:ZJSE0004 if $xml contains an illegal element. type.", "zerr:ZJSE0007 if $xml contains an element that is missing a required value.", "zerr:ZJSE0008 if $xml contains an illegal value for a JSON type." ] }, { "isDocumented" : true, "arity" : 2, "name" : "xml-to-json", "qname" : "jx:xml-to-json", "signature" : "($xml as item()*, $options as object()) as json-item()*", "description" : " Converts XML data into a JSON item using one of the respresentations\n described above.
    \n", "summary" : "
     Converts XML data into a JSON item using one of the respresentations\n described above.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xml", "type" : "item()", "occurrence" : "*", "description" : "
     The XML data to convert.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The conversion options, for example: 
     { \"json-format\" : \"JsonML-array\" } 
    " } ], "returns" : { "type" : "json-item()*", "description" : "said JSON items." }, "errors" : [ "zerr:ZJSE0001 if $xml is not a document or element node.", "zerr:ZJSE0002 if $xml contains an element that is missing a required attribute.", "zerr:ZJSE0003 if $xml contains an attribute having an illegal value.", "zerr:ZJSE0004 if $xml contains an illegal element. type.", "zerr:ZJSE0007 if $xml contains an element that is missing a required value.", "zerr:ZJSE0008 if $xml contains an illegal value for a JSON type." ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/image/manipulation" : { "ns" : "http://www.zorba-xquery.com/modules/image/manipulation", "description" : " This module provides functions to handle image manipulations like resizing, zooming,\n special effects etc.\n 
    The errors raised by functions of this module have the namespace\n http://www.zorba-xquery.com/modules/image/error (associated with prefix ierr).
    \n", "sees" : [  ], "authors" : [ "Daniel Thomas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://www.zorba-xquery.com/modules/image/error", "prefix" : "ierr" }, { "uri" : "http://www.zorba-xquery.com/modules/image/image", "prefix" : "image" }, { "uri" : "http://www.zorba-xquery.com/modules/image/manipulation", "prefix" : "man" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "add-noise", "qname" : "man:add-noise", "signature" : "($image as xs:base64Binary, $noise-type as xs:string) as xs:base64Binary", "description" : " Add noise to an image.\n Allowed noise types are:\n 
      \n  
    • UniformNoise
      • \n  
    • GaussianNoise
      • \n  
    • MultiplicativeGaussianNoise
      • \n  
    • ImpulseNoise
      • \n  
    • LaplaceianNoise
      • \n  
    • PoissonNoise
      • \n 
    \n", "summary" : "
     Add noise to an image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "noise-type", "type" : "xs:string", "occurrence" : null, "description" : "
     specifies the type of noise to add
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of $image with added noise" }, "errors" : [ "ierr:IM001 passed image is invalid", "err:FORG0001 unsupported noise type" ] }, { "isDocumented" : true, "arity" : 3, "name" : "blur", "qname" : "man:blur", "signature" : "($image as xs:base64Binary, $radius as xs:int, $sigma as xs:int) as xs:base64Binary external", "description" : " Blur an image.\n", "summary" : "
     Blur an image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "radius", "type" : "xs:int", "occurrence" : null, "description" : "
     is the radius of the Gaussian in pixels.
    " }, { "name" : "sigma", "type" : "xs:int", "occurrence" : null, "description" : "
     is the standard deviation of the Laplacian in pixels.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A blured copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 3, "name" : "charcoal", "qname" : "man:charcoal", "signature" : "($image as xs:base64Binary, $radius as xs:double, $sigma as xs:double) as xs:base64Binary external", "description" : " Apply a charcoal effect to the image (looks like a charcoal sketch).\n", "summary" : "
     Apply a charcoal effect to the image (looks like a charcoal sketch).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "radius", "type" : "xs:double", "occurrence" : null, "description" : "
     radius of the Gaussian in pixels
    " }, { "name" : "sigma", "type" : "xs:double", "occurrence" : null, "description" : "
     standard deviation of the Laplacian in pixels
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A charcoaled copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 3, "name" : "chop", "qname" : "man:chop", "signature" : "($image as xs:base64Binary, $upper-left-x as xs:unsignedInt, $upper-left-y as xs:unsignedInt) as xs:base64Binary external", "description" : " Copy a part of a source image as new image.\n The copied part is all right of $upper-left-x and below $upper-left-y.\n", "summary" : "
     Copy a part of a source image as new image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     source image
    " }, { "name" : "upper-left-x", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     x position of the upper left corner of the part to copy
    " }, { "name" : "upper-left-y", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     y position of the upper left corner of the part to copy
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A new image copied from a part of source image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "contrast", "qname" : "man:contrast", "signature" : "($image as xs:base64Binary, $sharpen as xs:double) as xs:base64Binary external", "description" : " Contrast an image (enhances image intensity differences) by a given value.\n", "summary" : "
     Contrast an image (enhances image intensity differences) by a given value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "sharpen", "type" : "xs:double", "occurrence" : null, "description" : "
     defines how much the image is contrasted.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A contrasted copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 3, "name" : "crop", "qname" : "man:crop", "signature" : "($image as xs:base64Binary, $lower-right-x as xs:unsignedInt, $lower-right-y as xs:unsignedInt) as xs:base64Binary external", "description" : " Copy a part of a source image as new image.\n The copied part is all left of $lower-right-x and above $lower-right-y.\n", "summary" : "
     Copy a part of a source image as new image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     source image
    " }, { "name" : "lower-right-x", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     x position of the lower right corner of the part to copy
    " }, { "name" : "lower-right-y", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     y position of the lower right corner of the part to copy
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A new image copied from a part of source image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "despeckle", "qname" : "man:despeckle", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Despeckle an image.\n", "summary" : "
     Despeckle an image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A despeckled copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "edge", "qname" : "man:edge", "signature" : "($image as xs:base64Binary, $radius as xs:unsignedInt) as xs:base64Binary external", "description" : " Highlight edges in an image.\n", "summary" : "
     Highlight edges in an image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "radius", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     radius of the pixel neighborhood (0 for automatic selection)
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "An edged copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 3, "name" : "emboss", "qname" : "man:emboss", "signature" : "($image as xs:base64Binary, $radius as xs:double, $sigma as xs:double) as xs:base64Binary external", "description" : " Emboss an images (highlights edges with 3D effect).\n", "summary" : "
     Emboss an images (highlights edges with 3D effect).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "radius", "type" : "xs:double", "occurrence" : null, "description" : "
     radius of the Gaussian in pixels
    " }, { "name" : "sigma", "type" : "xs:double", "occurrence" : null, "description" : "
     standard deviation of the Laplacian in pixels
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "An embossed copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "enhance", "qname" : "man:enhance", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Enhance an images (minimizes noise).\n", "summary" : "
     Enhance an images (minimizes noise).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "An enhanced copy of $image." }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "equalize", "qname" : "man:equalize", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Equalize an images (histogramm equalization).\n", "summary" : "
     Equalize an images (histogramm equalization).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "An equalized copy of $image." }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "erase", "qname" : "man:erase", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Set all pixels of the image to the current backround color.\n In most cases, this will result in all pixels to be set to white.\n", "summary" : "
     Set all pixels of the image to the current backround color.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     image to erase
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of image with all pixels set to the current background color" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "flip", "qname" : "man:flip", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Flip an image (vertical rotation).\n", "summary" : "
     Flip an image (vertical rotation).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     source image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A vertically rotated copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "flop", "qname" : "man:flop", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Flop an image (horizontal rotation).\n", "summary" : "
     Flop an image (horizontal rotation).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     source image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A horizontally rotated copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "gamma", "qname" : "man:gamma", "signature" : "($image as xs:base64Binary, $gamma-value as xs:double) as xs:base64Binary external", "description" : " Gamma correct an image.\n Gamma values less than zero will erase the image.\n", "summary" : "
     Gamma correct an image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "gamma-value", "type" : "xs:double", "occurrence" : null, "description" : "
     value for which to gamma correct the image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A gamma corrected copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 4, "name" : "gamma", "qname" : "man:gamma", "signature" : "($image as xs:base64Binary, $gamma-red as xs:double, $gamma-green as xs:double, $gamma-blue as xs:double) as xs:base64Binary external", "description" : " Gamma correct an image for every color channel seperately.\n Gamma values less than zero for any color will erase the corresponding color.\n", "summary" : "
     Gamma correct an image for every color channel seperately.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "gamma-red", "type" : "xs:double", "occurrence" : null, "description" : "
     value to gamma correct the red channel of the image
    " }, { "name" : "gamma-green", "type" : "xs:double", "occurrence" : null, "description" : "
     value to gamma correct the green channel of the image
    " }, { "name" : "gamma-blue", "type" : "xs:double", "occurrence" : null, "description" : "
     value to gamma correct the blue channel of the image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A gamma corrected copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "implode", "qname" : "man:implode", "signature" : "($image as xs:base64Binary, $factor as xs:double) as xs:base64Binary external", "description" : " Apply an implode effect to an image (a sort of special effect).\n", "summary" : "
     Apply an implode effect to an image (a sort of special effect).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "factor", "type" : "xs:double", "occurrence" : null, "description" : "
     factor to implode to
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "An imploded copy of $image." }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "oil-paint", "qname" : "man:oil-paint", "signature" : "($image as xs:base64Binary, $radius as xs:double) as xs:base64Binary external", "description" : " Apply an oil paint effect to an image (makes the image look as if it was\n an oil paint).\n", "summary" : "
     Apply an oil paint effect to an image (makes the image look as if it was\n an oil paint).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "radius", "type" : "xs:double", "occurrence" : null, "description" : "
     radius with which to oil paint
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A oil-painted copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 5, "name" : "overlay", "qname" : "man:overlay", "signature" : "($image as xs:base64Binary, $overlay-image as xs:base64Binary, $overlay-upper-left-x as xs:unsignedInt, $overlay-upper-left-y as xs:unsignedInt, $operator as xs:string) as xs:base64Binary", "description" : " Overlay $image with $overlay-image at the specfied position.\n The $operator defines the details of the overlay and can have one of the\n following values:\n 
      \n   
    • OverCompositeOp: The result is the union of the two image shapes\n       with the overlay image obscuring image in the region of overlap.
      • \n   
    • InCompositeOp: The result is a simple overlay image cut by the shape\n       of image. None of the image data of image is included in the result.
      • \n   
    • OutCompositeOp: The resulting image is the overlay image with the shape\n       of image cut out.
      • \n   
    • AtopCompositeOp: The result is the same shape as image, with overlay\n       image obscuring image there the image shapes overlap. Note that this\n       differs from OverCompositeOp because the portion of composite image\n       outside of image's shape does not appear in the result.
      • \n   
    • XorCompositeOp: The result is the image data from both overlay image\n       and image that is outside the overlap region. The overlap region will\n       be blank.
      • \n   
    • PlusCompositeOp: The result is just the sum of the image data of both\n       images. Output values are cropped to 255 (no overflow). This operation\n       is independent of the matte channels.
      • \n   
    • MinusCompositeOp: The result of overlay image - image, with overflow\n       cropped to zero. The matte chanel is ignored (set to 255, full\n       coverage).
      • \n   
    • AddCompositeOp: The result of overlay image + image, with overflow\n       wrapping around (mod 256).
      • \n   
    • SubtractCompositeOp: The result of overlay image - image, with underflow\n       wrapping around (mod 256). The add and subtract operators can be used to\n       perform reverible transformations.
      • \n   
    • DifferenceCompositeOp: The result of abs(overlay image - image). This is\n       useful for comparing two very similar images.
      • \n   
    • BumpmapCompositeOp: The result image shaded by overlay image.
      • \n 
    \n", "summary" : "
     Overlay $image with $overlay-image at the specfied position.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     base image
    " }, { "name" : "overlay-image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     image to overlay.
    " }, { "name" : "overlay-upper-left-x", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     horizontal position within $image where the left upper edge of the $overlay-image is placed
    " }, { "name" : "overlay-upper-left-y", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     vertical position within $image where the left upper edge of the $overlay-image is placed
    " }, { "name" : "operator", "type" : "xs:string", "occurrence" : null, "description" : "
     defines how the overlay image should be overlayed (see details in operator listing above)
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A new image consisting of $image overlayed with $overlay-image." }, "errors" : [ "ierr:IM001 passed image is invalid", "err:FORG0001 unsupported operator" ] }, { "isDocumented" : true, "arity" : 2, "name" : "reduce-noise", "qname" : "man:reduce-noise", "signature" : "($image as xs:base64Binary, $order as xs:double) as xs:base64Binary external", "description" : " Reduce noise of an image using a noise peak elemination filter.\n", "summary" : "
     Reduce noise of an image using a noise peak elemination filter.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "order", "type" : "xs:double", "occurrence" : null, "description" : "
     defines how much the noise is reduced
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of $image with reduced noise" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 3, "name" : "resize", "qname" : "man:resize", "signature" : "($image as xs:base64Binary, $width as xs:unsignedInt, $height as xs:unsignedInt) as xs:base64Binary external", "description" : " Get a copy of the passed image with changed width and height (without\n zooming the image's content).\n To change the size of the actual contents of an image, use the zoom function.\n More in detail: If the new dimensions are greater than the current dimensions\n the new image will have the passed image in the upper left corner and the rest\n will be filled with the current background color.\n If the passed dimensions are less than the current dimensions, the new image\n will contain the specified rectangle of the passed image beginning at the upper\n left corner.\n", "summary" : "
     Get a copy of the passed image with changed width and height (without\n zooming the image's content).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     image to resize
    " }, { "name" : "width", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     new width
    " }, { "name" : "height", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     new height
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "resized copy of the source image" }, "errors" : [ "ierr:IM001 passed image is invalid." ] }, { "isDocumented" : true, "arity" : 2, "name" : "rotate", "qname" : "man:rotate", "signature" : "($image as xs:base64Binary, $angle as xs:int) as xs:base64Binary external", "description" : " Get a new image as rotated copy of a passed source image (rotated by -360 to\n 360 degrees).\n The image is enlarged if this is required for containing the rotated image,\n but never shrunk even if the rotation would make a smaller image possible.\n", "summary" : "
     Get a new image as rotated copy of a passed source image (rotated by -360 to\n 360 degrees).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     source image.
    " }, { "name" : "angle", "type" : "xs:int", "occurrence" : null, "description" : "
     between -360 to 360 degrees. Other values will be adjusted by modulo 360
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A rotated copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "solarize", "qname" : "man:solarize", "signature" : "($image as xs:base64Binary, $factor as xs:double) as xs:base64Binary external", "description" : " Apply a solarize effect to the image (similar to the effect seen when\n exposing a photographic film to light during the development process).\n", "summary" : "
     Apply a solarize effect to the image (similar to the effect seen when\n exposing a photographic film to light during the development process).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "factor", "type" : "xs:double", "occurrence" : null, "description" : "
     strength of the solarization (0 to 65535; 65535=100%)
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A solarized copy of $image." }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "stereo", "qname" : "man:stereo", "signature" : "($left-image as xs:base64Binary, $right-image as xs:base64Binary) as xs:base64Binary external", "description" : " Make two passed images appear as stereo image when viewed with red-blue glasses.\n Both images should be same but from a slightly different angle for this to work.\n Both images should have the same size, if not, the size of the left image will\n be taken.\n", "summary" : "
     Make two passed images appear as stereo image when viewed with red-blue glasses.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "left-image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     left image for the stereo image.
    " }, { "name" : "right-image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     right image for the stereo image.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A new image as combined stereo image of both source images" }, "errors" : [ "ierr:IM001 one of the passed images is invalid" ] }, { "isDocumented" : true, "arity" : 5, "name" : "sub-image", "qname" : "man:sub-image", "signature" : "($image as xs:base64Binary, $left-upper-x as xs:unsignedInt, $left-upper-y as xs:unsignedInt, $width as xs:unsignedInt, $height as xs:unsignedInt) as xs:base64Binary external", "description" : " Copy a part of the source image specified by a rectangle.\n If the passed parameters for the sub-image specify a rectangle that isn't\n entirely within the source image only the area that lies within the image\n boundaries will be returned.\n", "summary" : "
     Copy a part of the source image specified by a rectangle.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the image from which to extract a sub-image
    " }, { "name" : "left-upper-x", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     is the x value of the upper left corner of the rectangle to cut out
    " }, { "name" : "left-upper-y", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     is the y value of the upper left corner of the rectangle to cut out.
    " }, { "name" : "width", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     width of the rectangle to cut out
    " }, { "name" : "height", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     height of the rectangle to cut out
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A new image containing parts of the source image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "swirl", "qname" : "man:swirl", "signature" : "($image as xs:base64Binary, $degree as xs:double) as xs:base64Binary external", "description" : " Swirl an image (image pixels are rotated by degree).\n", "summary" : "
     Swirl an image (image pixels are rotated by degree).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "degree", "type" : "xs:double", "occurrence" : null, "description" : "
     degree to swirl image pixels
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A swirled copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "transparent", "qname" : "man:transparent", "signature" : "($image as xs:base64Binary, $color as xs:string) as xs:base64Binary", "description" : " Make all pixels of the specfied color transparent.\n This works correctly only with image types supporting transparency\n (e.g GIF or PNG).\n", "summary" : "
     Make all pixels of the specfied color transparent.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "color", "type" : "xs:string", "occurrence" : null, "description" : "
     color to make transparent (e.g. '#FFFFFF')
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of $image with the specified color made transparent." }, "errors" : [ "ierr:IM001 passed image is invalid", "err:FORG0001 unsupported color" ] }, { "isDocumented" : true, "arity" : 1, "name" : "trim", "qname" : "man:trim", "signature" : "($image as xs:base64Binary) as xs:base64Binary external", "description" : " Trim edges of the image's background color from the image.\n", "summary" : "
     Trim edges of the image's background color from the image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A trimmed copy of $image" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "watermark", "qname" : "man:watermark", "signature" : "($image as xs:base64Binary, $watermark as xs:base64Binary) as xs:base64Binary external", "description" : " Add a $watermark image to $image.\n", "summary" : "
     Add a $watermark image to $image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the source image
    " }, { "name" : "watermark", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the watermark image
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A watermarked copy of $image" }, "errors" : [ "ierr:IM001 one of the passed images is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "zoom-by-height", "qname" : "man:zoom-by-height", "signature" : "($image as xs:base64Binary, $height as xs:unsignedInt) as xs:base64Binary external", "description" : " Zoom the passed image to a given new height while keeping the ratio between\n width and height.\n So, the width is scaled accordingly.\n Important note: this function does not change the size information stored\n in the image (e.g. basic:width will not show a different value).\n", "summary" : "
     Zoom the passed image to a given new height while keeping the ratio between\n width and height.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     image to resize
    " }, { "name" : "height", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     new height for the image in pixels
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of $image with given $height and width adjusted accordingly" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "zoom-by-width", "qname" : "man:zoom-by-width", "signature" : "($image as xs:base64Binary, $width as xs:unsignedInt) as xs:base64Binary external", "description" : " Zoom the passed image to a given new width while keeping the ratio between\n width and height.\n So, the height is scaled accordingly.\n Important note: this function does not change the size information stored\n in the image (e.g. basic:width will not show a different value).\n", "summary" : "
     Zoom the passed image to a given new width while keeping the ratio between\n width and height.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     image to resize
    " }, { "name" : "width", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     new width for the image in pixels
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of $image with given $width and height changed accordingly" }, "errors" : [ "ierr:IM001 passed image is invalid" ] }, { "isDocumented" : true, "arity" : 2, "name" : "zoom", "qname" : "man:zoom", "signature" : "($image as xs:base64Binary, $ratio as xs:double) as xs:base64Binary external", "description" : " Zoom the passed image by the specified factor while keeping the ratio between\n width and height.\n A ratio of less than 1 will make the image smaller.\n A ratio of less or equal than 0 will not effect the image.\n Important note: this function does not change the size information stored in the\n image (e.g. basic:width will not show a different value).\n", "summary" : "
     Zoom the passed image by the specified factor while keeping the ratio between\n width and height.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "image", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     image to resize
    " }, { "name" : "ratio", "type" : "xs:double", "occurrence" : null, "description" : "
     ratio to zoom width and height by
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "A copy of $image with resized content" }, "errors" : [ "ierr:IM001 passed image is invalid" ] } ], "variables" : [  ] }, "http://zorba.io/modules/http-client-wrapper" : { "ns" : "http://zorba.io/modules/http-client-wrapper", "description" : " 
    This module provides conversion functions between the\n XML Expath http-client request and response formats and the\n JSON http-client request and response formats used by the\n http://zorba.io/modules/http-client module.\n 
    \n 
    This module is reserved for internal use by the\n http://www.zorba-xquery.com/modules/http-client and the\n http://expath.org/ns/http-client modules.\n This module may be removed at any time. Method signature and\n semantics may change.\n 
    \n", "sees" : [  ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://expath.org/ns/error", "prefix" : "error" }, { "uri" : "http://expath.org/ns/http-client", "prefix" : "http-schema" }, { "uri" : "http://zorba.io/modules/http-client-wrapper", "prefix" : "http-wrapper" }, { "uri" : "http://jsoniq.org/functions", "prefix" : "jn" }, { "uri" : "http://zorba.io/modules/http-client", "prefix" : "json-http" }, { "uri" : "http://jsoniq.org/function-library", "prefix" : "libjn" }, { "uri" : "http://www.w3.org/2010/xslt-xquery-serialization", "prefix" : "ser" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "http-nondeterministic-request", "qname" : "http-wrapper:http-nondeterministic-request", "signature" : "($request as element(*)?, $href as xs:string?, $bodies as item()*) as item()+", "description" : " 
    This function sends an HTTP request and returns the corresponding response.\n This function is declared non-deterministic and should only be used to issue\n requests which do not change the state of the server.
    \n 
    Its inputs, outputs, and behavior are identical to the\n EXPath http-client's\n send-request() function (except that HTML responses are not tidied\n into XML - see the note above). It\n is provided here for use in Zorba installations that do not have\n the EXPath module available. If you have the option of using the\n EXPath module instead of this function, please do so, as it will\n allow your application to be more interoperable between different\n XQuery engines.
    \n 
    Full documentation of the $request parameter can be found in\n the EXPath\n specification.
    \n", "summary" : "
      This function sends an HTTP request and returns the corresponding response.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "request", "type" : "element(*)", "occurrence" : "?", "description" : "
     Contains the various parameters of the request (see above).
    " }, { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "
     The URL to which the request will be made (see note above). If this parameter is specified, it will override the \"href\" attribute of $request.
    " }, { "name" : "bodies", "type" : "item()", "occurrence" : "*", "description" : "
     is the request body content, for HTTP methods that can contain a body in the request (i.e. POST and PUT). It is an error if this param is not the empty sequence for methods
    " } ], "returns" : { "type" : "item()+", "description" : "standard http-client return type." }, "errors" : [ "error:HC001 An HTTP error occurred.", "error:HC002 Error parsing the response content as XML.", "error:HC003 With a multipart response, the override-media-type must be either a multipart media type or application/octet-stream.", "error:HC004 The src attribute on the body element is mutually exclusive with all other attribute (except the media-type).", "error:HC005 The input request element is not valid.", "error:HC006 A timeout occurred waiting for the response.", "error:HCV02 Trying to follow a redirect of a POST, PUT, or DELETE request" ] }, { "isDocumented" : true, "arity" : 3, "name" : "http-sequential-request", "qname" : "http-wrapper:http-sequential-request", "signature" : "($request as element(*)?, $href as xs:string?, $bodies as item()*) as item()+", "description" : " 
    This function sends an HTTP request and returns the corresponding response.\n This function is declared sequential and can be used to issue\n requests which change the state of the server.
    \n 
    Its inputs, outputs, and behavior are identical to the\n EXPath http-client's\n send-request() function (except that HTML responses are not tidied\n into XML - see the note above). It\n is provided here for use in Zorba installations that do not have\n the EXPath module available. If you have the option of using the\n EXPath module instead of this function, please do so, as it will\n allow your application to be more interoperable between different\n XQuery engines.
    \n 
    Full documentation of the $request parameter can be found in\n the EXPath\n specification.
    \n", "summary" : "
      This function sends an HTTP request and returns the corresponding response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "request", "type" : "element(*)", "occurrence" : "?", "description" : "
     Contains the various parameters of the request (see above).
    " }, { "name" : "href", "type" : "xs:string", "occurrence" : "?", "description" : "
     The URL to which the request will be made (see note above). If this parameter is specified, it will override the \"href\" attribute of $request.
    " }, { "name" : "bodies", "type" : "item()", "occurrence" : "*", "description" : "
     is the request body content, for HTTP methods that can contain a body in the request (i.e. POST and PUT). It is an error if this param is not the empty sequence for methods
    " } ], "returns" : { "type" : "item()+", "description" : "standard http-client return type." }, "errors" : [ "error:HC001 An HTTP error occurred.", "error:HC002 Error parsing the response content as XML.", "error:HC003 With a multipart response, the override-media-type must be either a multipart media type or application/octet-stream.", "error:HC004 The src attribute on the body element is mutually exclusive with all other attribute (except the media-type).", "error:HC005 The input request element is not valid.", "error:HC006 A timeout occurred waiting for the response.", "error:HCV02 Trying to follow a redirect of a POST, PUT, or DELETE request" ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/cloudsearch" : { "ns" : "http://www.28msec.com/modules/cloudsearch", "description" : " 
    This module offers functionality to search, add, update and remove documents in\n an Amazon CloudSearch domain.
    \n 
    For each functionality two methods are provided\n 
      \n  
    • one which accepts a single $options parameter. In this case the default\n      credentials for the \"CloudSearch\" category will be used to determine the\n      CloudSearch endpoint to use.
      • \n  
    • one which accepts both an $endpoint and an $options parameter.\n      In this case, if the $endpoint parameter is of type string, it will be\n      interpreted as the name of a credentials in the \"CloudSearch\" category.\n      Otherwise, if the $endpoint parameter is of type anyURI, it will be\n      interpreted as the endpoint URI.
      • \n 
    \n 
    \n 
    Important Notice Regarding Function Determinism
    \n 
    The search functions (search#1 and\n search#2) are declared deterministic, which means that\n their results could be cached when invoked multiple times with the same arguments\n in the same query execution.
    \n 
    To not use cached results you can use two alternative search functions\n (search-nondeterministic#1 and\n search-nondeterministic#2), which have\n been declared as being non deterministic.
    \n 
    Search options
    \n 
    The search settings are specified by means of an object whose form\n is described in the following. The two most important fields are the\n \"q\" and \"bq\" fields. At least one of them must be specified. If the \"bq\"\n field is specified in conjunction with the \"q\" parameter, the values\n are joined with a top-level AND.\n 
      \n   
    • bq: one or more match expressions that define a Boolean search. Multiple\n       expressions are joined with a top-level AND.\n       
      Type: string
      \n   
      • \n   
    • q: the string to search for. You use the q parameter to perform simple text\n       searches. This searches the default search field for the specified text.\n       
      Type: string
      \n   
      • \n 
    \n 
    \n 
    Additional documentation on the format of the query and boolean query strings can\n be found at:\n \n Expression Syntax for Boolean Queries.
    \n 
    The following additional optional parameters can be specified.\n 
      \n   
    • facet: a comma-separated list of the fields for which you want to compute facets.\n       The specified fields must be numeric fields or defined as facet enabled in the\n       domain configuration.\n       
      Type: string
      \n   
      • \n   
    • facet-FIELD-constraints: the field values (facet constraints) that\n       you want to count for a particular field. FIELD is the name of the field.\n       Constraints are specified as a comma-separated list of ranges or\n       single-quoted strings. If you don't specify facet constraints, counts\n       are computed for all field values.\n       
      Type: string
      \n   
      • \n   
    • facet-FIELD-sort: how you want to sort facet values for a\n       particular field. FIELD is the name of the field. There are four sorting options:\n       
        \n         
      • alpha: Sort the facet values alphabetically (in ascending order).
        • \n         
      • count: Sort the facet values by their counts (in descending order).
        • \n         
      • max: Sort the facet values according to the maximum values in the specified\n             field. This option is specified as max(FIELD). By default, the\n             facet values are sorted in ascending order. To sort in descending order,\n             prefix the sort option with - (minus): -max(FIELD).\n         
        • \n         
      • sum: Sort the facet values according to the sum of the values in the\n             specified field (in ascending order). This option is specified as\n             sum(FIELD).\n         
        • \n       
      \n   
      • \n   
    • facet-FIELD-top-n: set the maximum number of facet constraints to\n       be included for the specified field in the search results. By default,\n       the results include counts for the top 40 constraints.\n        
      Type: integer
      \n   
      • \n   
    • no-cache: if false, a cached result can be returned. If true, a revalidation of the\n        results is forced. Default is false.\n        
      Type: boolean
      \n   
      • \n   
    • rank: a comma-separated list of fields or rank expressions to use for ranking. A\n        maximum of 10 fields and rank expressions can be specified. You can use any uint\n        field to rank results numerically. Any result-enabled text or literal field can be\n        used to rank results alphabetically. To rank results by relevance, you can specify\n        the name of a custom rank expression or text_relevance. Hits are ordered according\n        to the specified rank field(s). By default, hits are ranked in ascending order.\n        
      You can prefix a field name with a minus (-) to rank in descending order. If no\n        rank parameter is specified, it defaults to rank=-text_relevance, which\n        lists results according to their text_relevance scores with the highest-scoring\n        documents first.
      \n       
      Type: string
      \n   
      • \n   
    • rank-RANKNAME: define a rank expression that can be used with the\n       rank parameter. You can also specify the new rank expression as a return\n       field and use it to set thresholds for the search results with the\n       t-FIELD parameter. For more information about constructing\n       rank expressions, see\n       \n       Customizing Result Ranking with Amazon CloudSearch.\n       
      Type: string
      \n   
      • \n   
    • return-fields: the document fields to include in the response. Up to 2 KB\n       of data can be returned from a text field. If the field contents exceed\n       2 KB, only the first 2 KB is included in the results. Specified as a\n       comma-separated list of field names. If no return-fields are specified,\n       only the document ids of the hits are returned.\n       
      Type: string
      \n   
      • \n   
    • size: the maximum number of search hits to return. The default is 10.\n       
      Type: integer
      \n   
      • \n   
    • start: the offset of the first search hit you want to return. The default is 0\n       (the first hit).\n       
      Type: integer
      \n   
      • \n   
    • t-FIELD: restrict the match set used in subsequent post-processing\n       steps according to the specified rank expression. Only hits that have a\n       score within the specified range are included. Ranges are specified as\n       described in\n       \n       Expression Syntax for Boolean Queries.\n       
      Type: integer
      \n   
      • \n 
    \n For additional details on the search parameters you can refer to the\n \n Amazon CloudSearch search requests documentation.
    \n 
    Search Results
    \n 
    The format of the returned object is the following:\n 
    \n {\n   \"rank\" : \"-text_relevance\",\n   \"match-expr\" : \"(label 'star wars')\",\n   \"hits\" :\n   {\n     \"found\" : 2,\n     \"start\" : 0,\n     \"hit\" :\n     [\n       {\n         \"id\" : \"tt1185834\",\n         \"data\" :\n         {\n           \"actor\" : [\"Abercrombie, Ian\",\"Baker, Dee\",\"Burton, Corey\"],\n           \"title\" : [\"Star Wars: The Clone Wars\"]\n         }\n       },\n       {\n         \"id\" :\"tt0121766\",\n         \"data\" :\n         {\n           \"actor\" : [\"Bai, Ling\",\"Bryant, Gene\",\"Castle-Hughes, Keisha\"],\n           \"title\" : [\"Star Wars: Episode III - Revenge of the Sith\"]\n         }\n       }\n     ]\n   },\n   \"info\" :\n   {\n     \"rid\" : \"b7c167f6c2da6d93531b9a7b314ad030b3a74803b4b7797edb905ba5a6a08\",\n     \"time-ms\" : 2,\n     \"cpu-time-ms\" : 0\n   }\n }\n 
    \n 
    \n 
    The returned object fields have the following meaning:\n 
      \n   
    • match-expr: Shows the match expression constructed from the search\n       parameters.
      • \n   
    • hits: Contains hit statistics (found, start) and a hit array that lists\n       the document ids and data for each hit.
      • \n   
    • found: The total number of hits that match the search request after\n       Amazon CloudSearch finished processing the match set.
      • \n   
    • start: The index of the first hit returned in this response.
      • \n   
    • hit: An array that lists the document ids and data for each hit.
      • \n   
    • id: The unique identifier for a document.
      • \n   
    • data: A list of returned fields.
      • \n   
    • facets: Contains facet information and facet counts.
      • \n   
    • FacetFieldName: A field for which facets were calculated.
      • \n   
    • constraints: An array of the facet values and counts.
      • \n   
    • value: The facet value being counted.
      • \n   
    • count: The number of hits that contain the facet value in FacetFieldName.\n       
      • \n   
    • info: Contains information about the request processing.
      • \n   
    • rank: Lists the fields that were used to rank the search hits.
      • \n   
    • rid: The encrypted Resource ID.
      • \n   
    • time-ms: How long it took to process the search request in milliseconds.\n       
      • \n   
    • cpu-time-ms: The CPU time required to process the search request in\n       milliseconds.
      • \n   
    • messages: Contains any error messages returned by the search service.\n       The severity, code, and message properties are included for each item.
      • \n   
    • severity: The severity of the message. It is always warning, which indicates\n       a problem with the query string that did not prevent the request from being\n       processed.
      • \n   
    • code: The error code. The search service returns the following error codes:\n     
        \n       
      • CS-InvalidFieldOrRankAliasInRankParameter: the specified ranking field\n           could not be found.
        • \n       
      • CS-RankExpressionParseError: one of the specified rank expressions could\n           not be parsed. No query-time rank expressions will be used. 
        • \n       
      • CS-RankExpressionValidationError: one of the specified rank expressions\n           could not be validated. No query-time rank expressions will be used.
        • \n       
      • CS-UndefinedField: an unknown field was specified in the match\n           expression.
        • \n       
      • CS-UnknownFieldInMatchExpression: a field specified in the bq parameter\n           could not be found.
        • \n       
      • CS-WildcardTermLimit: more than 2000 terms matched the wildcard in the\n           search request. The number of terms matched was limited to 2000.
        • \n     
      \n   
      • \n   
    • message: A description of the error that was returned by the search service.
      • \n 
    \n 
    \n", "sees" : [  ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/cloudsearch", "prefix" : "cloudsearch" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://zorba.io/modules/http-client", "prefix" : "http" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "add-document", "qname" : "cloudsearch:add-document", "signature" : "($options as object()) as object()", "description" : " 
    Adds or replaces a document in the default Amazon CloudSearch domain.
    \n 
    An add operation is applied only if a document with the same id is not\n present or if the version number specified in the operation is greater than\n the existing document's version number.
    \n 
    The document to add or replace is specified through an object with\n the following form:\n 
    \n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 1,\n   \"lang\" : \"en\",\n   \"fields\" :\n   {\n     \"title\" : \"The Seeker: The Dark Is Rising\",\n     \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"]\n   }\n }\n 
    \n 
    \n 
    Specifically, the fields in the request object have the following meaning:\n 
      \n   
    • id: An alphanumeric string. Allowed characters are: a-z, 0-9, and _.\n       Document IDs cannot begin with an underscore. The max length is 128\n       characters.
      • \n   
    • version: Any non-negative number less than 2^32.
      • \n   
    • lang: An ISO-639-1 two-letter language code.
      • \n   
    • fields: An object containing one or more fields. Each field specifies\n       a field within the document being added. Field names must begin with a\n       lowercase letter and can contain the following characters: a-z, 0-9,\n       and _. Field names must be at least 3 and no more than 64 characters.\n       The names \"body\", \"docid\", and \"text_relevance\" are reserved names and\n       cannot be used as field names. To specify multiple values for a field,\n       you can specify an array of values instead of a single value.
      • \n 
    \n 
    \n 
    The returned object lists all warnings that were generated.\n 
    \n {\n   \"status\" : \"success\",\n   \"warning\" :\n   [\n     {\"message\" : \"Warning message.\"}\n   ]\n }\n 
    \n 
    \n 
    Specifically, the fields in the response object have the following meaning:\n 
      \n   
    • status: the result status, always \"success\". In case an error occurred\n       processing the request, an error is raised.
      • \n   
    • warning: provides information about warnings generated during parsing\n       or validation. The field is not present if no warning were generated.
      • \n 
    \n 
    \n 
    Example, specifying endpoint URI:\n 
    \n cloudsearch:add-document(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 1,\n   \"lang\" : \"en\",\n   \"fields\" :\n   {\n     \"title\" : \"The Seeker: The Dark Is Rising\",\n     \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"]\n   }\n });\n 
    \n 
    \n 
    Example, using stored credentials:\n 
    \n cloudsearch:add-document(\"movies\",\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 1,\n   \"lang\" : \"en\",\n   \"fields\" :\n   {\n     \"title\" : \"The Seeker: The Dark Is Rising\",\n     \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"]\n   }\n });\n 
    \n 
    \n", "summary" : "
      Adds or replaces a document in the default Amazon CloudSearch domain.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying the request options
    " } ], "returns" : { "type" : "object()", "description" : "The request response" }, "errors" : [ "cloudsearch:ENDPOINT if the default credentials endpoint is invalid or not present", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:RESOURCES if the server storage or bandwidth resources are insufficient to execute the request", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 2, "name" : "add-document", "qname" : "cloudsearch:add-document", "signature" : "($endpoint as atomic, $options as object()) as object()", "description" : " 
    Adds or replaces a document in the specified Amazon CloudSearch domain.
    \n 
    An add operation is applied only if a document with the same id is not\n present or if the version number specified in the operation is greater than\n the existing document's version number.
    \n 
    The document to add or replace is specified through an object with\n the following form:\n 
    \n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 1,\n   \"lang\" : \"en\",\n   \"fields\" :\n   {\n     \"title\" : \"The Seeker: The Dark Is Rising\",\n     \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"]\n   }\n }\n 
    \n 
    \n 
    Specifically, the fields in the request object have the following meaning:\n 
      \n   
    • id: An alphanumeric string. Allowed characters are: a-z, 0-9, and _.\n       Document IDs cannot begin with an underscore. The max length is 128\n       characters.
      • \n   
    • version: Any non-negative number less than 2^32.
      • \n   
    • lang: An ISO-639-1 two-letter language code.
      • \n   
    • fields: An object containing one or more fields. Each field specifies\n       a field within the document being added. Field names must begin with a\n       lowercase letter and can contain the following characters: a-z, 0-9,\n       and _. Field names must be at least 3 and no more than 64 characters.\n       The names \"body\", \"docid\", and \"text_relevance\" are reserved names and\n       cannot be used as field names. To specify multiple values for a field,\n       you can specify an array of values instead of a single value.
      • \n 
    \n 
    \n 
    The returned object lists all warnings that were generated.\n 
    \n {\n   \"status\" : \"success\",\n   \"warning\" :\n   [\n     {\"message\" : \"Warning message.\"}\n   ]\n }\n 
    \n 
    \n 
    Specifically, the fields in the response object have the following meaning:\n 
      \n   
    • status: the result status, always \"success\". In case an error occurred\n       processing the request, an error is raised.
      • \n   
    • warning: provides information about warnings generated during parsing\n       or validation. The field is not present if no warning were generated.
      • \n 
    \n 
    \n 
    Example, specifying endpoint URI:\n 
    \n cloudsearch:add-document(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 1,\n   \"lang\" : \"en\",\n   \"fields\" :\n   {\n     \"title\" : \"The Seeker: The Dark Is Rising\",\n     \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"]\n   }\n });\n 
    \n 
    \n 
    Example, using stored credentials:\n 
    \n cloudsearch:add-document(\"movies\",\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 1,\n   \"lang\" : \"en\",\n   \"fields\" :\n   {\n     \"title\" : \"The Seeker: The Dark Is Rising\",\n     \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"]\n   }\n });\n 
    \n 
    \n", "summary" : "
      Adds or replaces a document in the specified Amazon CloudSearch domain.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint", "type" : "atomic", "occurrence" : null, "description" : "
     The endpoint URI or the name of a stored CloudSearch credentials
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying the request options
    " } ], "returns" : { "type" : "object()", "description" : "The request response" }, "errors" : [ "cloudsearch:ENDPOINT if the specified endpoint is invalid", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:RESOURCES if the server storage or bandwidth resources are insufficient to execute the request", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 1, "name" : "batch-document", "qname" : "cloudsearch:batch-document", "signature" : "($options as array()) as object()", "description" : " 
    Adds, replaces or removes one or more documents from the default Amazon\n CloudSearch domain.
    \n 
    An add or delete operation is only applied to an existing document if the\n version number specified in the operation is greater than the existing document\n version number.\n If multiple add or delete operations for the same document are specified, the\n operation with the highest version number is applied. If multiple operations in\n a batch specify the same document and version number, the document service\n arbitrarily picks which one to apply.
    \n 
    The documents to add, replace or delete can be specified through an array with\n the following form:\n 
    \n [\n   {\n     \"type\" : \"add\",\n     \"id\" :   \"tt0484562\",\n     \"version\" : 1,\n     \"lang\" : \"en\",\n     \"fields\" :\n     {\n       \"title\" : \"The Seeker: The Dark Is Rising\",\n       \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"],\n     }\n   },\n   {\n     \"type\" : \"delete\",\n     \"id\" :   \"tt0484575\",\n     \"version\" : 2\n   }\n ]\n 
    \n 
    \n 
    Specifically, the fields in the request array have the following meaning:\n 
      \n   
    • type: The operation type, \"add\" or \"delete\".
      • \n   
    • id: An alphanumeric string. Allowed characters are: a-z, 0-9, and _.\n       Document IDs cannot begin with an underscore. The max length is 128\n       characters.
      • \n   
    • version: Any non-negative number less than 2^32.
      • \n   
    • lang: An ISO-639-1 two-letter language code.
      • \n   
    • fields: An object containing one or more fields. Each field specifies\n       a field within the document being added. Field names must begin with a\n       lowercase letter and can contain the following characters: a-z, 0-9,\n       and _. Field names must be at least 3 and no more than 64 characters.\n       The names \"body\", \"docid\", and \"text_relevance\" are reserved names and\n       cannot be used as field names. To specify multiple values for a field,\n       you can specify an array of values instead of a single value.
      • \n 
    \n 
    \n 
    The response body lists any warning that was generated.\n 
    \n {\n   \"status\" : \"success\",\n   \"adds\" : 1,\n   \"deletes: 1,\n   \"warning\" :\n   [\n     {\"message\" : \"Warning message.\"}\n   ]\n }\n 
    \n 
    \n 
    Specifically, the fields in the response object have the following meaning:\n 
      \n   
    • status: the result status, which is either success or error.
      • \n   
    • adds: the number of add document operations that were performed.
      • \n   
    • deletes: the number of delete document operations that were performed.
      • \n   
    • warning: provides information about a warning generated during parsing\n       or validation. The field is not present if no warning was generated.
      • \n 
    \n 
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:batch-document(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n [\n   {\n     \"type\" : \"add\",\n     \"id\" :   \"tt0484562\",\n     \"version\" : 1,\n     \"lang\" : \"en\",\n     \"fields\" :\n     {\n       \"title\" : \"The Seeker: The Dark Is Rising\",\n       \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"],\n     }\n   },\n   {\n     \"type\" : \"delete\",\n     \"id\" :   \"tt0484575\",\n     \"version\" : 2\n   }\n ]);\n 
    \n 
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:batch-document(\"movies\",\n [\n   {\n     \"type\" : \"add\",\n     \"id\" :   \"tt0484562\",\n     \"version\" : 1,\n     \"lang\" : \"en\",\n     \"fields\" :\n     {\n       \"title\" : \"The Seeker: The Dark Is Rising\",\n       \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"],\n     }\n   },\n   {\n     \"type\" : \"delete\",\n     \"id\" :   \"tt0484575\",\n     \"version\" : 2\n   }\n ]);\n 
    \n 
    \n", "summary" : "
      Adds, replaces or removes one or more documents from the default Amazon\n CloudSearch domain.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "array()", "occurrence" : null, "description" : "
     An object specifying the request options
    " } ], "returns" : { "type" : "object()", "description" : "The request response" }, "errors" : [ "cloudsearch:ENDPOINT if the default credentials endpoint is invalid or not present", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:RESOURCES if the server storage or bandwidth resources are insufficient to execute the request", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 2, "name" : "batch-document", "qname" : "cloudsearch:batch-document", "signature" : "($endpoint as atomic, $options as array()) as object()", "description" : " 
    Adds, replaces or removes one or more documents from the specified Amazon\n CloudSearch domain.
    \n 
    An add or delete operation is only applied to an existing document if the\n version number specified in the operation is greater than the existing document\n version number.\n If multiple add or delete operations for the same document are specified, the\n operation with the highest version number is applied. If multiple operations in\n a batch specify the same document and version number, the document service\n arbitrarily picks which one to apply.
    \n 
    The documents to add, replace or delete can be specified through an array with\n the following form:\n 
    \n [\n   {\n     \"type\" : \"add\",\n     \"id\" :   \"tt0484562\",\n     \"version\" : 1,\n     \"lang\" : \"en\",\n     \"fields\" :\n     {\n       \"title\" : \"The Seeker: The Dark Is Rising\",\n       \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"],\n     }\n   },\n   {\n     \"type\" : \"delete\",\n     \"id\" :   \"tt0484575\",\n     \"version\" : 2\n   }\n ]\n 
    \n 
    \n 
    Specifically, the fields in the request array have the following meaning:\n 
      \n   
    • type: The operation type, \"add\" or \"delete\".
      • \n   
    • id: An alphanumeric string. Allowed characters are: a-z, 0-9, and _.\n       Document IDs cannot begin with an underscore. The max length is 128\n       characters.
      • \n   
    • version: Any non-negative number less than 2^32.
      • \n   
    • lang: An ISO-639-1 two-letter language code.
      • \n   
    • fields: An object containing one or more fields. Each field specifies\n       a field within the document being added. Field names must begin with a\n       lowercase letter and can contain the following characters: a-z, 0-9,\n       and _. Field names must be at least 3 and no more than 64 characters.\n       The names \"body\", \"docid\", and \"text_relevance\" are reserved names and\n       cannot be used as field names. To specify multiple values for a field,\n       you can specify an array of values instead of a single value.
      • \n 
    \n 
    \n 
    The response body lists any warning that was generated.\n 
    \n {\n   \"status\" : \"success\",\n   \"adds\" : 1,\n   \"deletes: 1,\n   \"warning\" :\n   [\n     {\"message\" : \"Warning message.\"}\n   ]\n }\n 
    \n 
    \n 
    Specifically, the fields in the response object have the following meaning:\n 
      \n   
    • status: the result status, which is either success or error.
      • \n   
    • adds: the number of add document operations that were performed.
      • \n   
    • deletes: the number of delete document operations that were performed.
      • \n   
    • warning: provides information about a warning generated during parsing\n       or validation. The field is not present if no warning was generated.
      • \n 
    \n 
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:batch-document(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n [\n   {\n     \"type\" : \"add\",\n     \"id\" :   \"tt0484562\",\n     \"version\" : 1,\n     \"lang\" : \"en\",\n     \"fields\" :\n     {\n       \"title\" : \"The Seeker: The Dark Is Rising\",\n       \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"],\n     }\n   },\n   {\n     \"type\" : \"delete\",\n     \"id\" :   \"tt0484575\",\n     \"version\" : 2\n   }\n ]);\n 
    \n 
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:batch-document(\"movies\",\n [\n   {\n     \"type\" : \"add\",\n     \"id\" :   \"tt0484562\",\n     \"version\" : 1,\n     \"lang\" : \"en\",\n     \"fields\" :\n     {\n       \"title\" : \"The Seeker: The Dark Is Rising\",\n       \"genre\" : [\"Adventure\",\"Drama\",\"Fantasy\",\"Thriller\"],\n     }\n   },\n   {\n     \"type\" : \"delete\",\n     \"id\" :   \"tt0484575\",\n     \"version\" : 2\n   }\n ]);\n 
    \n 
    \n", "summary" : "
      Adds, replaces or removes one or more documents from the specified Amazon\n CloudSearch domain.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint", "type" : "atomic", "occurrence" : null, "description" : "
     The endpoint URI or the name of a stored CloudSearch credentials
    " }, { "name" : "options", "type" : "array()", "occurrence" : null, "description" : "
     An object specifying the request options
    " } ], "returns" : { "type" : "object()", "description" : "The request response" }, "errors" : [ "cloudsearch:ENDPOINT if the specified endpoint is invalid", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:RESOURCES if the server storage or bandwidth resources are insufficient to execute the request", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete-document", "qname" : "cloudsearch:delete-document", "signature" : "($options as object()) as object()", "description" : " 
    Deletes a document from the default Amazon CloudSearch domain.
    \n 
    A delete operation is only applied to an existing document if the\n version number specified in the operation is greater than the existing\n document's version number.
    \n 
    The document to remove is specified through an object with the\n following form:\n 
    \n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 2\n }\n 
    \n 
    \n 
    Specifically, the fields in the request object have the following meaning:\n 
      \n   
    • id: An alphanumeric string. Allowed characters are: a-z, 0-9, and _.\n       Document IDs cannot begin with an underscore. The max length is 128\n       characters.
      • \n   
    • version: Any non-negative number less than 2^32.
      • \n 
    \n 
    \n 
    The response body lists any warning that was generated.\n 
    \n {\n   \"status\" : \"success\",\n   \"warning\" :\n   [\n     {\"message\" : \"Warning message.\"}\n   ]\n }\n 
    \n 
    \n 
    Specifically, the fields in the response object have the following meaning:\n 
      \n   
    • status: the result status, always \"success\". In case of errors an error is\n       raised.
      • \n   
    • warning: provides information about a warning generated during parsing or\n       validation. The field is not present if no warning was generated.
      • \n 
    \n 
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:delete-document(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 2\n });\n 
    \n 
    \n 
    Example, using specified stored endpoing:\n 
    \n cloudsearch:delete-document(\"movies\",\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 2\n });\n 
    \n 
    \n", "summary" : "
      Deletes a document from the default Amazon CloudSearch domain.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying the request options
    " } ], "returns" : { "type" : "object()", "description" : "The request response" }, "errors" : [ "cloudsearch:ENDPOINT if the default credentials endpoint is invalid or not present", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:RESOURCES if the server storage or bandwidth resources are insufficient to execute the request", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete-document", "qname" : "cloudsearch:delete-document", "signature" : "($endpoint as atomic, $options as object()) as object()", "description" : " 
    Deletes a document from the specified Amazon CloudSearch domain.
    \n 
    A delete operation is only applied to an existing document if the\n version number specified in the operation is greater than the existing\n document's version number.
    \n 
    The document to remove is specified through an object with the\n following form:\n 
    \n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 2\n }\n 
    \n 
    \n 
    Specifically, the fields in the request object have the following meaning:\n 
      \n   
    • id: An alphanumeric string. Allowed characters are: a-z, 0-9, and _.\n       Document IDs cannot begin with an underscore. The max length is 128\n       characters.
      • \n   
    • version: Any non-negative number less than 2^32.
      • \n 
    \n 
    \n 
    The response body lists any warning that was generated.\n 
    \n {\n   \"status\" : \"success\",\n   \"warning\" :\n   [\n     {\"message\" : \"Warning message.\"}\n   ]\n }\n 
    \n 
    \n 
    Specifically, the fields in the response object have the following meaning:\n 
      \n   
    • status: the result status, always \"success\". In case of errors an error is\n       raised.
      • \n   
    • warning: provides information about a warning generated during parsing or\n       validation. The field is not present if no warning was generated.
      • \n 
    \n 
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:delete-document(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 2\n });\n 
    \n 
    \n 
    Example, using specified stored endpoing:\n 
    \n cloudsearch:delete-document(\"movies\",\n {\n   \"id\" : \"tt0484562\",\n   \"version\" : 2\n });\n 
    \n 
    \n", "summary" : "
      Deletes a document from the specified Amazon CloudSearch domain.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint", "type" : "atomic", "occurrence" : null, "description" : "
     The endpoint URI or the name of a stored CloudSearch credentials
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying the request options
    " } ], "returns" : { "type" : "object()", "description" : "The request response" }, "errors" : [ "cloudsearch:ENDPOINT if the specified endpoint is invalid", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:RESOURCES if the server storage or bandwidth resources are insufficient to execute the request", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 1, "name" : "search-nondeterministic", "qname" : "cloudsearch:search-nondeterministic", "signature" : "($options as object()) as object()", "description" : " 
    Searches the documents in the default Amazon CloudSearch domain.
    \n 
    This function has the same semantics as search#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Searches the documents in the default Amazon CloudSearch domain.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The search options object
    " } ], "returns" : { "type" : "object()", "description" : "The search results object" }, "errors" : [ "cloudsearch:ENDPOINT if the default credentials endpoint is invalid or not present", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 2, "name" : "search-nondeterministic", "qname" : "cloudsearch:search-nondeterministic", "signature" : "($endpoint as atomic, $options as object()) as object()", "description" : " 
    Searches the documents in the specified Amazon CloudSearch domain.
    \n 
    This function has the same semantics as search#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Searches the documents in the specified Amazon CloudSearch domain.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "endpoint", "type" : "atomic", "occurrence" : null, "description" : "
     The endpoint URI or the name of a stored CloudSearch credentials
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The search options object
    " } ], "returns" : { "type" : "object()", "description" : "The search results object" }, "errors" : [ "cloudsearch:ENDPOINT if the specified endpoint is invalid", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 1, "name" : "search", "qname" : "cloudsearch:search", "signature" : "($options as object()) as object()", "description" : " 
    Searches the documents in the default Amazon CloudSearch domain.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The format of the search options object and\n of the search results object is documented in\n the module introduction.
    \n 
    Example:\n 
    \n cloudsearch:search({\"q\" : \"star+wars\", \"return-fields\" : \"title\"})\n 
    \n 
    \n 
    Example returned object:\n 
    \n {\n   \"rank\" : \"-text_relevance\",\n   \"match-expr\" : \"(label 'star wars')\",\n   \"hits\" :\n   {\n     \"found\" : 2,\n     \"start\" : 0,\n     \"hit\" :\n     [\n       {\n         \"id\" : \"tt1185834\",\n         \"data\" :\n         {\n           \"actor\" : [\"Abercrombie, Ian\",\"Baker, Dee\",\"Burton, Corey\"],\n           \"title\" : [\"Star Wars: The Clone Wars\"]\n         }\n       },\n       {\n         \"id\" :\"tt0121766\",\n         \"data\" :\n         {\n           \"actor\" : [\"Bai, Ling\",\"Bryant, Gene\",\"Castle-Hughes, Keisha\"],\n           \"title\" : [\"Star Wars: Episode III - Revenge of the Sith\"]\n         }\n       }\n     ]\n   },\n   \"info\" :\n   {\n     \"rid\" : \"b7c167f6c2da6d93531b9a7b314ad030b3a74803b4b7797edb905ba5a6a08\",\n     \"time-ms\" : 2,\n     \"cpu-time-ms\" : 0\n   }\n }\n 
    \n 
    \n", "summary" : "
      Searches the documents in the default Amazon CloudSearch domain.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The search options object
    " } ], "returns" : { "type" : "object()", "description" : "The search results object" }, "errors" : [ "cloudsearch:ENDPOINT if the default credentials endpoint is invalid or not present", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] }, { "isDocumented" : true, "arity" : 2, "name" : "search", "qname" : "cloudsearch:search", "signature" : "($endpoint as atomic, $options as object()) as object()", "description" : " 
    Searches the documents in the specified Amazon CloudSearch domain.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The format of the search options object and\n of the search results object is documented in\n the module introduction.
    \n 
    The following examples performs a simple text search for all documents\n containing both the word \"star\" and \"trek\" and returns the matching document\n title field.
    \n 
    Example, using specified endpoint URI:\n 
    \n cloudsearch:search(\n anyURI(\"http://doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1.cloudsearch.amazonaws.com\"),\n {\"q\" : \"star+wars\", \"return-fields\" : \"title\"})\n 
    \n 
    \n 
    Example, using a stored endpoint:\n 
    \n cloudsearch:search(\"movies\",\n {\"q\" : \"star+wars\", \"return-fields\" : \"title\"})\n 
    \n 
    \n", "summary" : "
      Searches the documents in the specified Amazon CloudSearch domain.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "endpoint", "type" : "atomic", "occurrence" : null, "description" : "
     The endpoint URI or the name of a stored CloudSearch credentials
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     The search options object
    " } ], "returns" : { "type" : "object()", "description" : "The search results object" }, "errors" : [ "cloudsearch:ENDPOINT if the specified endpoint is invalid", "cloudsearch:AUTHORIZATION if the request was unauthorized", "cloudsearch:HTTP if an HTTP error has occurred", "cloudsearch:REQUEST if the request is malformed", "cloudsearch:INTERNAL if an internal server error occurred", "cloudsearch:RESPONSE if the CloudSearch response cannot be parsed" ] } ], "variables" : [  ] }, "http://zorba.io/modules/store/static/indexes/ddl" : { "ns" : "http://zorba.io/modules/store/static/indexes/ddl", "description" : " This modules defines a set of functions for managing indexes that are\n declared in the prolog of a module.\n 
    \n This module is part of\n Zorba's XQuery Data Definition Facility.\n All the indexes managed by this module have to be pre-declared in the prolog\n of a module.\n Please refer to the\n general documentation\n for more information and examples.\n", "sees" : [ "Data Lifecycle", "XQuery Data Definition Facility", "http://zorba.io/modules/store/static/indexes/dml", "http://zorba.io/modules/store/static/collections/dml", "http://zorba.io/modules/store/static/collections/ddl", "http://zorba.io/modules/store/static/integrity-constraints/ddl", "http://zorba.io/modules/store/static/integrity-constraints/dml", "http://zorba.io/errors" ], "authors" : [ "Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/store/static/indexes/ddl", "prefix" : "iddl" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "available-indexes", "qname" : "iddl:available-indexes", "signature" : "() as xs:QName* external", "description" : " Gets the available indexes.\n", "summary" : "
     Gets the available indexes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each available index, or an empty sequence if none are." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "create", "qname" : "iddl:create", "signature" : "($name as xs:QName) external", "description" : " Creates an index.\n", "summary" : "
     Creates an index.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to create.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, creates the index with the given name." }, "errors" : [ "zerr:ZDDY0021 if $name is not equal to the name of any resource in the statically known indexes.", "zerr:ZDDY0022 if an index with $name already exists." ] }, { "isDocumented" : true, "arity" : 0, "name" : "declared-indexes", "qname" : "iddl:declared-indexes", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames representing the indexes that have been declared\n in the prolog of the static context.\n", "summary" : "
     Gets a sequence of QNames representing the indexes that have been declared\n in the prolog of the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each created collection, or an emtpy sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete", "qname" : "iddl:delete", "signature" : "($name as xs:QName) external", "description" : " Deletes an index.\n", "summary" : "
     Deletes an index.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to delete.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the index with the given name." }, "errors" : [ "zerr:ZDDY0009 if the index does not exist." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-available-index", "qname" : "iddl:is-available-index", "signature" : "($name as xs:QName) as xs:boolean external", "description" : " Gets whether an index exists.\n", "summary" : "
     Gets whether an index exists.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index that is being checked.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the index is available; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-declared-index", "qname" : "iddl:is-declared-index", "signature" : "($name as xs:QName) as xs:boolean external", "description" : " Gets whether an index has been declared in the prolog of the static context.\n", "summary" : "
     Gets whether an index has been declared in the prolog of the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index that is being checked.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the index was declared; false otherwise." }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/excel/datetime" : { "ns" : "http://zorba.io/modules/excel/datetime", "description" : " This is a library module offering the same set of functions\n defined by Microsoft Excel.\n", "sees" : [ "Excel Documentation: Datetime Functions" ], "authors" : [ "Sorin Nasoi" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/datetime", "prefix" : "excel-datetime" }, { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/text", "prefix" : "excel-text" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "date", "qname" : "excel-datetime:date", "signature" : "($year as xs:integer, $month as xs:integer, $day as xs:integer) as xs:date?", "description" : " Constructs a date given the hours, months and days.\n", "summary" : "
     Constructs a date given the hours, months and days.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "year", "type" : "xs:integer", "occurrence" : null, "description" : "
     the year
    " }, { "name" : "month", "type" : "xs:integer", "occurrence" : null, "description" : "
     the month
    " }, { "name" : "day", "type" : "xs:integer", "occurrence" : null, "description" : "
     the day
    " } ], "returns" : { "type" : "xs:date?", "description" : "A date given the hours, months and days" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day", "qname" : "excel-datetime:day", "signature" : "($date as xs:date) as xs:integer?", "description" : " Returns the day of a $date, represented by a serial number.\n", "summary" : "
     Returns the day of a $date, represented by a serial number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:date", "occurrence" : null, "description" : "
     the date.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "The day of a $date, represented by a serial number. The day is given as an integer ranging from 1 to 31." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "days360", "qname" : "excel-datetime:days360", "signature" : "($start_date as xs:date, $end_date as xs:date) as xs:integer", "description" : " Returns the number of days between two dates based on a 360-day year.\n", "summary" : "
     Returns the number of days between two dates based on a 360-day year.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "start_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the start date.
    " }, { "name" : "end_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the end date.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The number of days between two dates based on a 360-day year (twelve 30-day months), which is used in some accounting calculations.
     Use this function to help compute payments if your accounting system is based on twelve 30-day months.
     The metod used is U.S. (NASD). If the starting date is the last day of a month, it becomes equal to the 30th of the same month. 
     If the ending date is the last day of a month and the starting date is earlier than the 30th of a month, the ending date becomes equal to the 1st of the next month; otherwise the ending date becomes equal to the 30th of the same month." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "days360", "qname" : "excel-datetime:days360", "signature" : "($start_date as xs:date, $end_date as xs:date, $method as xs:boolean) as xs:integer", "description" : " Returns the number of days between two dates based on a 360-day year.\n", "summary" : "
     Returns the number of days between two dates based on a 360-day year.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "start_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the start date.
    " }, { "name" : "end_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the end date.
    " }, { "name" : "method", "type" : "xs:boolean", "occurrence" : null, "description" : "
     if false then US/NASD Method is used, otherwise the European Method is used.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The number of days between two dates based on a 360-day year (twelve 30-day months), which is used in some accounting calculations. Use this function to help compute payments if your accounting system is based on twelve 30-day months. 
     The European Method (30E/360)
     - If either date A or B falls on the 31st of the month, that date will be changed to the 30th;
     - Where date B falls on the last day of February, the actual date B will be used.
     The US/NASD Method (30US/360)
     - If both date A and B fall on the last day of February, then date B will be changed to the 30th.
     - If date A falls on the 31st of a month or last day of February, then date A will be changed to the 30th.
     - If date A falls on the 30th of a month after applying (2) above and date B falls on the 31st of a month, then date B will be changed to the 30th." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hour", "qname" : "excel-datetime:hour", "signature" : "($time as xs:time) as xs:integer?", "description" : " Returns the hour of a time value.\n", "summary" : "
     Returns the hour of a time value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "time", "type" : "xs:time", "occurrence" : null, "description" : "
     the time.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "The hour of a time value. The hour is as an integer, ranging from 0 (12:00 A.M.) to 23 (11:00 P.M.)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minute", "qname" : "excel-datetime:minute", "signature" : "($time as xs:time) as xs:integer?", "description" : " Returns the minutes of a time value.\n", "summary" : "
     Returns the minutes of a time value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "time", "type" : "xs:time", "occurrence" : null, "description" : "
     the time.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "The minutes of a time value. The minute is given as an integer, ranging from 0 to 59." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "month", "qname" : "excel-datetime:month", "signature" : "($date as xs:date) as xs:integer?", "description" : " Returns the month of a $date.\n", "summary" : "
     Returns the month of a $date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:date", "occurrence" : null, "description" : "
     the date.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "the month of a $date. The month is given as an integer, ranging from 1 (January) to 12 (December)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "networkdays", "qname" : "excel-datetime:networkdays", "signature" : "($start_date as xs:date, $end_date as xs:date) as xs:integer*", "description" : " Returns the number of whole working days between $start_date and $end_date.\n", "summary" : "
     Returns the number of whole working days between $start_date and $end_date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "start_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the start date.
    " }, { "name" : "end_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the end date.
    " } ], "returns" : { "type" : "xs:integer*", "description" : "The number of whole working days between start_date and end_date.
     Working days exclude weekends and any dates identified in holidays.
     Use NETWORKDAYS to calculate employee benefits that accrue based on the number of days worked during a specific term." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "networkdays", "qname" : "excel-datetime:networkdays", "signature" : "($start_date as xs:date, $end_date as xs:date, $holidays as xs:date*) as xs:integer*", "description" : " Returns the number of whole working days between $start_date and $end_date.\n", "summary" : "
     Returns the number of whole working days between $start_date and $end_date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "start_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the start date.
    " }, { "name" : "end_date", "type" : "xs:date", "occurrence" : null, "description" : "
     the end date.
    " }, { "name" : "holidays", "type" : "xs:date", "occurrence" : "*", "description" : "
     one or more dates to exclude from the working calendar, such as state and federal holidays and floating holidays.
    " } ], "returns" : { "type" : "xs:integer*", "description" : "The number of whole working days between start_date and end_date.
     Working days exclude weekends and any dates identified in holidays.
     Use NETWORKDAYS to calculate employee benefits that accrue based on the number of days worked during a specific term." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "now", "qname" : "excel-datetime:now", "signature" : "() as xs:dateTime?", "description" : " Returns the current date and time.\n", "summary" : "
     Returns the current date and time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:dateTime?", "description" : "The current date and time." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "second", "qname" : "excel-datetime:second", "signature" : "($time as xs:time) as xs:decimal?", "description" : " Returns the seconds of a $time value.\n", "summary" : "
     Returns the seconds of a $time value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "time", "type" : "xs:time", "occurrence" : null, "description" : "
     the time.
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "The seconds of a $time value. The second is given as an integer in the range 0 (zero) to 59." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "time", "qname" : "excel-datetime:time", "signature" : "($hour as xs:integer, $minute as xs:integer, $second as xs:integer) as xs:time?", "description" : " Constructs a time given the hours, minutes and seconds.\n", "summary" : "
     Constructs a time given the hours, minutes and seconds.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "hour", "type" : "xs:integer", "occurrence" : null, "description" : "
     the hour.
    " }, { "name" : "minute", "type" : "xs:integer", "occurrence" : null, "description" : "
     the minute.
    " }, { "name" : "second", "type" : "xs:integer", "occurrence" : null, "description" : "
     the second.
    " } ], "returns" : { "type" : "xs:time?", "description" : "A time given the hours, minutes and seconds." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "today", "qname" : "excel-datetime:today", "signature" : "() as xs:date?", "description" : " Returns the current date.\n", "summary" : "
     Returns the current date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:date?", "description" : "The current date." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "weekday", "qname" : "excel-datetime:weekday", "signature" : "($date as xs:date) as xs:integer?", "description" : " Returns the day of the week corresponding to a $date.\n", "summary" : "
     Returns the day of the week corresponding to a $date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:date", "occurrence" : null, "description" : "
     the date.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "The day of the week corresponding to a $date. The day is given as an integer, ranging from 1 (Sunday) to 7 (Saturday)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "weekday", "qname" : "excel-datetime:weekday", "signature" : "($date as xs:date, $return_type as xs:integer) as xs:integer?", "description" : " Returns the day of the week corresponding to a $date depending on $return_type.\n", "summary" : "
     Returns the day of the week corresponding to a $date depending on $return_type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:date", "occurrence" : null, "description" : "
     the date.
    " }, { "name" : "return_type", "type" : "xs:integer", "occurrence" : null, "description" : "
     1 for Numbers 1 (Sunday) through 7 (Saturday). 2 for Numbers 1 (Monday) through 7 (Sunday). 3 for Numbers 0 (Monday) through 6 (Sunday).
    " } ], "returns" : { "type" : "xs:integer?", "description" : "The day of the week corresponding to a $date depending on $return_type." }, "errors" : [ "excel-err:Value if $return_type is outside the range [1,3]." ] }, { "isDocumented" : true, "arity" : 1, "name" : "year", "qname" : "excel-datetime:year", "signature" : "($date as xs:date) as xs:integer?", "description" : " Returns the year corresponding to a date.\n", "summary" : "
     Returns the year corresponding to a date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:date", "occurrence" : null, "description" : "
     the date.
    " } ], "returns" : { "type" : "xs:integer?", "description" : "The year corresponding to a date." }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/profiles/sec/filings" : { "ns" : "http://xbrl.io/modules/bizql/profiles/sec/filings", "description" : " 
    This module provides functionality for querying financial reports (filings)\n submitted to the SEC.
    \n 
    SEC Filings are nothing else than XBRL archives. For XBRL-generic requests on archives,\n use the generic archives module.
    \n 
    With this module, you can access a number of properties of an SEC filing, such as\n its document type. You can also retrieve an SEC filing given an SEC company (or its CIK).
    \n 
    You can also access SEC filings statistics (the number of SEC Networks, of SEC Axes, etc).
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/companies", "prefix" : "companies" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://zorba.io/modules/datetime", "prefix" : "datetime" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/filings", "prefix" : "filings" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "mongo" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/core", "prefix" : "sec" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "acceptance-dateTimes", "qname" : "filings:acceptance-dateTimes", "signature" : "($filings-or-ids as item()*) as dateTime*", "description" : " 
    Retrieves the acceptance date of filings.
    \n", "summary" : "
      Retrieves the acceptance date of filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of filings or their IDs.
    " } ], "returns" : { "type" : "dateTime*", "description" : "the acceptance dateTimes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "document-types", "qname" : "filings:document-types", "signature" : "($filings-or-ids as item()*) as string?", "description" : " 
    Retrieves the document type of the filings.
    \n", "summary" : "
      Retrieves the document type of the filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of filings or their ids.
    " } ], "returns" : { "type" : "string?", "description" : "the document types (10-K, 10-Q)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "filing-dates", "qname" : "filings:filing-dates", "signature" : "($filings-or-ids as item()*) as date*", "description" : " 
    Retrieves the submission date of filings.
    \n", "summary" : "
      Retrieves the submission date of filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of filings or their IDs.
    " } ], "returns" : { "type" : "date*", "description" : "the submission dates." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "filings-for-companies", "qname" : "filings:filings-for-companies", "signature" : "($companies-or-ciks as item()*) as object()*", "description" : " 
    Return all filings submitted by the supplied companies.
    \n", "summary" : "
      Return all filings submitted by the supplied companies.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "companies-or-ciks", "type" : "item()", "occurrence" : "*", "description" : "
     arbitrary number of company objects or CIKs.
    " } ], "returns" : { "type" : "object()*", "description" : "all filings submitted by these companies." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "generators", "qname" : "filings:generators", "signature" : "($filings-or-ids as item()*) as string*", "description" : " 
    Retrieves the generators of filings.
    \n", "summary" : "
      Retrieves the generators of filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of filings or their IDs.
    " } ], "returns" : { "type" : "string*", "description" : "the generators used." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-abstracts", "qname" : "filings:num-abstracts", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of (distinct) abstracts in each of the given filings.\n", "summary" : "
     Return the number of (distinct) abstracts in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of abstracts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-axes", "qname" : "filings:num-axes", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of (distinct) axes in each of the given filings.\n", "summary" : "
     Return the number of (distinct) axes in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of axes" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-concepts", "qname" : "filings:num-concepts", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of (distinct) concepts in each of the given filings.\n", "summary" : "
     Return the number of (distinct) concepts in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of concepts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-extension-abstracts", "qname" : "filings:num-extension-abstracts", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of extension abstracts in each of the given filings.\n", "summary" : "
     Return the number of extension abstracts in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of abstracts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-extension-concepts", "qname" : "filings:num-extension-concepts", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of extension concepts in each of the given filings.\n", "summary" : "
     Return the number of extension concepts in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of concepts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-extension-facts", "qname" : "filings:num-extension-facts", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of extension facts in each of the given filings.\n", "summary" : "
     Return the number of extension facts in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of facts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-facts", "qname" : "filings:num-facts", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of facts in each of the given filings.\n", "summary" : "
     Return the number of facts in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of facts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-footnotes", "qname" : "filings:num-footnotes", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of footnotes in each of the given filings.\n", "summary" : "
     Return the number of footnotes in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of facts" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-line-items", "qname" : "filings:num-line-items", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of (distinct) line items in each of the given filings.\n", "summary" : "
     Return the number of (distinct) line items in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of line items" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-members", "qname" : "filings:num-members", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of (distinct) members in each of the given filings.\n", "summary" : "
     Return the number of (distinct) members in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of members" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-networks", "qname" : "filings:num-networks", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of networks in each of the given filings.\n", "summary" : "
     Return the number of networks in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of networks" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-report-elements", "qname" : "filings:num-report-elements", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of (distinct) report elements in each of the given filings.\n", "summary" : "
     Return the number of (distinct) report elements in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of report elements" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "num-tables", "qname" : "filings:num-tables", "signature" : "($filings-or-ids) as integer*", "description" : " Return the number of tables in each of the given filings.\n", "summary" : "
     Return the number of tables in each of the given filings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filings-or-ids", "type" : null, "occurrence" : null, "description" : "
     list of filings or IDs
    " } ], "returns" : { "type" : "integer*", "description" : "the said number of tables" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/string" : { "ns" : "http://zorba.io/modules/string", "description" : " 
    This module provides string related functions.
    \n 
    Mostly, the functions in this module provide primitives\n to work with streamable strings. For example, it allows to\n check whether a given string is streamable or seekable.
    \n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/string", "prefix" : "string" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "analyze-string", "qname" : "string:analyze-string", "signature" : "($input as xs:string?, $pattern as xs:string) as array()", "description" : " Analyzes a string using a regular expression, returning sequence of JSON\n objects that identify which parts of the input string matched or failed to\n match the regular expression; and in the case of matched substrings, which\n substrings matched each capturing group in the regular expression.\n 
    \n This function behaves like\n fn:analyze-string\n but returns a JSON array rather than an XML element.\n", "summary" : "
     Analyzes a string using a regular expression, returning sequence of JSON\n objects that identify which parts of the input string matched or failed to\n match the regular expression; and in the case of matched substrings, which\n substrings matched each capturing group in the regular expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "
     The string to analyze. If the empty sequence, the function behaves as if $input were a zero-length string.
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     The regular expression.
    " } ], "returns" : { "type" : "array()", "description" : "a JSON array of objects where each object contains a single key/value pair. Each key is either match or non-match. For non-match, the value is a string that is the part of $input that did not match; for match, the value is either a string that is the part of $input that matched (when $pattern contains no capturing groups) or an array containing values for both capturing groups and other matches. 
     Capturing group matches are themselves arrays where the first element is the group number (1-based) and subsequent elements are either a string that is the part of $input that matched or sub-arrays for nested capturing groups." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "analyze-string", "qname" : "string:analyze-string", "signature" : "($input as xs:string?, $pattern as xs:string, $flags as xs:string) as array() external", "description" : " Analyzes a string using a regular expression, returning sequence of JSON\n objects that identify which parts of the input string matched or failed to\n match the regular expression; and in the case of matched substrings, which\n substrings matched each capturing group in the regular expression.\n 
    \n This function behaves like\n fn:analyze-string\n but returns a JSON array rather than an XML element.\n", "summary" : "
     Analyzes a string using a regular expression, returning sequence of JSON\n objects that identify which parts of the input string matched or failed to\n match the regular expression; and in the case of matched substrings, which\n substrings matched each capturing group in the regular expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "xs:string", "occurrence" : "?", "description" : "
     The string to analyze. If the empty sequence, the function behaves as if $input were a zero-length string.
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     The regular expression.
    " }, { "name" : "flags", "type" : "xs:string", "occurrence" : null, "description" : "
     The  argument is interpreted in the same way as for the fn:matches function.
    " } ], "returns" : { "type" : "array()", "description" : "a JSON array of objects where each object contains a single key/value pair. Each key is either match or non-match. For non-match, the value is a string that is the part of $input that did not match; for match, the value is either a string that is the part of $input that matched (when $pattern contains no capturing groups) or an array containing values for both capturing groups and other matches. 
     Capturing group matches are themselves arrays where the first element is the group number (1-based) and subsequent elements are either a string that is the part of $input that matched or sub-arrays for nested capturing groups." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-seekable", "qname" : "string:is-seekable", "signature" : "($s as string) as boolean external", "description" : " 
    This function checks whether a given string item is a\n seekable stream string.
    \n 
    For example, a seekable streamable string is returned by the\n file module.
    \n", "summary" : "
      This function checks whether a given string item is a\n seekable stream string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "string", "occurrence" : null, "description" : "
     the string to check
    " } ], "returns" : { "type" : "boolean", "description" : "true if the given item is a seekable stream string or false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-streamable", "qname" : "string:is-streamable", "signature" : "($s as string) as boolean external", "description" : " 
    This function checks whether a given string item is implemented by a\n streamable string.
    \n 
    A streamable string is produced by some functions of a module.\n It's an optimized implementation of an string to handle arbitrary\n sized data. The drawback is that its value can only be consumed once.\n That is, only one function can access the value of a streamable string\n item.
    \n", "summary" : "
      This function checks whether a given string item is implemented by a\n streamable string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "string", "occurrence" : null, "description" : "
     the string to check
    " } ], "returns" : { "type" : "boolean", "description" : "true if the given item is implemented using a streamable string or false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "materialize", "qname" : "string:materialize", "signature" : "($s as string) as string external", "description" : " 
    This function materializes a streamable string.
    \n 
    The drawback of a streamable (non-seekable) string is that\n its value can only be consumed once. That is, only one function\n can access the value of a streamable string item.
    \n 
    In order to remedy this situation, this function can be used to\n convert a streamable string into its non-streamable counterpart. As a\n result, the string returned by this function has the same value as its\n input but is materialized and, hence, can be consumed multiple times.
    \n", "summary" : "
      This function materializes a streamable string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "string", "occurrence" : null, "description" : "
     the streamable string item to materialize
    " } ], "returns" : { "type" : "string", "description" : "a materialized string of its input or the input if the input item was not a streamable string." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "split", "qname" : "string:split", "signature" : "($s as string, $separator as string) as string* external", "description" : " 
    Returns a sequence of strings constructed by splitting the input wherever\n the given separator is found.
    \n 
    The function is different from tokenize. It doesn't allow\n the separator to be a regular expression. This restriction allows for more\n performant implementation. Specifically, the function processes\n streamable strings as input in a streamable way which is particularly useful\n to tokenize huge strings.
    \n", "summary" : "
      Returns a sequence of strings constructed by splitting the input wherever\n the given separator is found.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "string", "occurrence" : null, "description" : "
     the input string to split
    " }, { "name" : "separator", "type" : "string", "occurrence" : null, "description" : "
     the separator used for splitting the input string $s
    " } ], "returns" : { "type" : "string*", "description" : "a sequence of strings constructed by splitting the input" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/store" : { "ns" : "http://www.28msec.com/modules/store", "description" : " This module provides functions to perform MongoDB query operations\n (i.e. find and aggregate) on the database associated with the\n project.\n 
    The module is always imported so you don't need to import it explicitly.\n Also, you don't need to fully qualify the function if you want to invoke it.
    \n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/mongodb/types", "prefix" : "mongo" }, { "uri" : "http://www.28msec.com/modules/store", "prefix" : "store" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "aggregate", "qname" : "store:aggregate", "signature" : "($collection as string, $pipeline as array()) as object() external", "description" : " Performs a MongoDB aggregation framework job on the given collection.\n The $pipeline parameter needs to specify a valid aggregation\n framework pipeline. For example,\n 
    \n  [\n    { $project : {\n       author : 1,\n       tags : 1,\n    } },\n    { $unwind : \"$tags\" },\n    { $group : {\n       _id : { tags : \"$tags\" },\n       authors : { $addToSet : \"$author\" }\n    } }\n ]\n 
    \n The function returns the result as one object. The object contains\n the field named \"ok\" with value 0 if the execution failed or 1 if\n it succeeded. If it succeeded, the result is contained as an array\n in the result field. Otherwise, the errmsg field contains the description\n of the error. For exampl,e\n 
    \n {\n   \"result\" : [ ... ],\n   \"ok\" : 1\n }\n 
    \n", "summary" : "
     Performs a MongoDB aggregation framework job on the given collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : "string", "occurrence" : null, "description" : "
     the name of the collection to execute the job on
    " }, { "name" : "pipeline", "type" : "array()", "occurrence" : null, "description" : "
     the specification of the pipeline to execute
    " } ], "returns" : { "type" : "object()", "description" : "an object with the result or the error message." }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "clear-if", "qname" : "store:clear-if", "signature" : "($cond as boolean) as integer", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "cond", "type" : "boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "clear", "qname" : "store:clear", "signature" : "() as integer external", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "collection-chunk-specs", "qname" : "store:collection-chunk-specs", "signature" : "($name as string) as object()*", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "collection-chunk-specs", "qname" : "store:collection-chunk-specs", "signature" : "($name as string, $chunk-size as integer) as object()* external", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "chunk-size", "type" : "integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "collection-chunk", "qname" : "store:collection-chunk", "signature" : "($name as string, $chunk as object()) as item()* external", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "chunk", "type" : "object()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "find", "qname" : "store:find", "signature" : "($coll as string, $query as object()) as object()*", "description" : " Performs a MongoDB query operation on the given collection and\n returns all matches.\n", "summary" : "
     Performs a MongoDB query operation on the given collection and\n returns all matches.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "coll", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "query", "type" : "object()", "occurrence" : null, "description" : "
     the query operation to perform
    " } ], "returns" : { "type" : "object()*", "description" : "all matches returned by the given query operation" }, "errors" : [ "zerr:ZSTR0009 if the given collection does not exist" ] }, { "isDocumented" : true, "arity" : 3, "name" : "find", "qname" : "store:find", "signature" : "($coll as string, $query as object(), $options as object()) as object()* external", "description" : " Performs a MongoDB query operation on the given collection and\n returns all matches.\n Available options:\n 
      \n   
    • to-return: the maximum number of objects to return (0 = unlimited)
      • \n   
    • to-skip: start with the n-th object
      • \n   
    • batch-size: the number of objects to return in one batch
      • \n   
    • slave-ok: allow this query to be run against a replica secondary
      • \n   
    • await-data: the server will block for some extra time before returning,\n   waiting for more data to return
      • \n   
    • partial-results: return partial results if some shards are down instead\n   of returning an error
      • \n 
    \n", "summary" : "
     Performs a MongoDB query operation on the given collection and\n returns all matches.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "coll", "type" : "string", "occurrence" : null, "description" : "
     the name of the collection
    " }, { "name" : "query", "type" : "object()", "occurrence" : null, "description" : "
     the query operation to perform
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     the options for this operation
    " } ], "returns" : { "type" : "object()*", "description" : "all matches returned by the given query operation" }, "errors" : [ "zerr:ZSTR0009 if the given collection does not exist" ] }, { "isDocumented" : false, "arity" : 1, "name" : "flush-if", "qname" : "store:flush-if", "signature" : "($cond as boolean) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "cond", "type" : "boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "flush", "qname" : "store:flush", "signature" : "() as empty-sequence() external", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/hash" : { "ns" : "http://zorba.io/modules/hash", "description" : " This module provides functions that perform different hash operations.\n For example, they compute MD5 and various SHA functions on either\n strings or binary. The result is the base64 encoded value of the hash.\n", "sees" : [  ], "authors" : [ "Gabriel Petrovay, Markus Pilman, Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/hash", "prefix" : "hash" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "hash-binary", "qname" : "hash:hash-binary", "signature" : "($value as xs:base64Binary, $alg as xs:string) as xs:base64Binary external", "description" : " This function computes a hash value of the binary form of the given\n base64Binary item, i.e. the item is base64-decoded before hashing.\n", "summary" : "
     This function computes a hash value of the binary form of the given\n base64Binary item, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     The binary item to be hashed.
    " }, { "name" : "alg", "type" : "xs:string", "occurrence" : null, "description" : "
     The algorithm to use for this hashing operation. Supported algorithms are \"md5\", \"sha1\", and \"sha256\".
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The hash as xs:base64Binary of the provided binary" }, "errors" : [ "hash:UNSUPPORTED-ALGORITHM if the given hash algorithm is not supported" ] }, { "isDocumented" : true, "arity" : 2, "name" : "hash", "qname" : "hash:hash", "signature" : "($value as xs:string, $alg as xs:string) as xs:base64Binary external", "description" : " This function computes a hash value of the string provided as parameter.\n The function expects the hash algorithm to be used as parameter.\n", "summary" : "
     This function computes a hash value of the string provided as parameter.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     The string to be hashed.
    " }, { "name" : "alg", "type" : "xs:string", "occurrence" : null, "description" : "
     The algorithm to use for this hashing operation. Supported algorithms are \"md5\", \"sha1\", and \"sha256\".
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The hash as xs:base64binary of the provided string" }, "errors" : [ "hash:UNSUPPORTED-ALGORITHM if the given hash algorithm is not supported" ] }, { "isDocumented" : true, "arity" : 1, "name" : "md5-binary", "qname" : "hash:md5-binary", "signature" : "($value as xs:base64Binary) as xs:base64Binary", "description" : " This function computes the MD5 hash value of the binary form of the given\n base64Binary item, i.e. the item is base64-decoded before hashing.\n", "summary" : "
     This function computes the MD5 hash value of the binary form of the given\n base64Binary item, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     The binary item to hash.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The MD5 hash of the provided binary." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "md5", "qname" : "hash:md5", "signature" : "($value as xs:string) as xs:base64Binary", "description" : " Computes the MD5 hash of the string provided as parameter.\n", "summary" : "
     Computes the MD5 hash of the string provided as parameter.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     The string to hash
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The MD5 hash as xs:base64Binary" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sha1-binary", "qname" : "hash:sha1-binary", "signature" : "($value as xs:base64Binary) as xs:base64Binary", "description" : " This function computes the SHA1 hash value of the binary form of the given\n base64Binary item, i.e. the item is base64-decoded before hashing.\n", "summary" : "
     This function computes the SHA1 hash value of the binary form of the given\n base64Binary item, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     The binary item to hash.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The base64 encoded SHA1 hash of the provided binary." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sha1", "qname" : "hash:sha1", "signature" : "($value as xs:string) as xs:base64Binary", "description" : " Computes the SHA1 hash of the string provided as parameter.\n", "summary" : "
     Computes the SHA1 hash of the string provided as parameter.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     The string to hash.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The SHA1 hash as xs:base64Binary" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/xsl-fo" : { "ns" : "http://zorba.io/modules/xsl-fo", "description" : " This module converts XSL-FO documents\n to various formats such as PDF, EPS, PCL, AFP, Text, PNG, Postscript, RTF, and TIFF.\n For instance, the following example converts a simple XSL-FO document to PDF:\n 
    \n 
    import module namespace fop = \"http://zorba.io/modules/xsl-fo\";\n import module namespace file = \"http://expath.org/ns/file\";\n declare namespace fo = \"http://www.w3.org/1999/XSL/Format\";\n let $xsl-fo := <fo:root xmlns:fo=\"http://www.w3.org/1999/XSL/Format\">\n   <fo:layout-master-set>\n     <fo:simple-page-master master-name=\"my-page\">\n       <fo:region-body margin=\"1in\"/>\n     </fo:simple-page-master>\n   </fo:layout-master-set>\n   <fo:page-sequence master-reference=\"my-page\">\n     <fo:flow flow-name=\"xsl-region-body\">\n       <fo:block>Hello, world!</fo:block>\n     </fo:flow>\n   </fo:page-sequence>\n  </fo:root>\n let $pdf := fop:generator($fop:PDF, $xsl-fo)\n return file:write-binary(\"simple.pdf\", $pdf)
    \n 
    \n This module uses Apache-FOP to generate content from an XSL-FO document.\n See the Apache FOP documentation for further information.\n 
    \n Note for Windows users: On Windows, this module won't work out of the box, since\n this module uses Java. But the Java VM dll is not in the system path by default. To make\n this module work, you need to add the directory where the jvm.dll is located to the\n system path. This dll is located at JRE_DIR\\bin\\client. On a standard installation, this would\n be something a path like \"C:\\Program Files\\Java\\jre6\\bin\\client\".\n", "sees" : [ "http://xmlgraphics.apache.org/fop/" ], "authors" : [ "Markus Pilman" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://www.zorba-xquery.com/modules/util-jvm", "prefix" : "util-jvm" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/modules/xsl-fo", "prefix" : "xsl-fo" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "generator", "qname" : "xsl-fo:generator", "signature" : "($output-format as xs:string, $xsl-fo-document as node()) as xs:base64Binary", "description" : " The generator function takes an XSL-FO document as input and generates output\n in the format given as input.\n The output format can be given as a MIME type - for example \"application/pdf\"\n - or one of the predefined variables can be used - like $xsl-fo:PDF. Please\n refer to the Apache FOP documentation for\n supported output formats.\n Apache FOP does not support 100% of the XSL-FO standard.\n Please consult the official\n documentation for further information.\n This function tries to find the needed Java libraries itself.
    \n On a Mac OS X computer, it should be sufficient to install Apache FOP via Mac\n Ports.
    \n On Ubuntu it should be sufficient to install the fop packages via apt-get.
    \n On Windows, the classpath needs to be set manually using\n generator#3.
    \n This function tries to find the jar files via environment variables. The user can set the\n variable FOP_HOME to the root directory of an Apache FOP distribution. If you have all\n JAR files in the same directory, you can set the environment variable FOP_LIB_DIR to this\n directory.\n", "summary" : "
     The generator function takes an XSL-FO document as input and generates output\n in the format given as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "output-format", "type" : "xs:string", "occurrence" : null, "description" : "
     The mime of the output format, to tell Apache FOP which kind of document it should create.
    " }, { "name" : "xsl-fo-document", "type" : "node()", "occurrence" : null, "description" : "
     The XSL-FO document from which the output should be generated.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "The generated output document." }, "errors" : [ "xsl-fo:JVM-NOT-STARTED If zorba was unable to start the JVM.", "xsl-fo:JAVA-EXCEPTION If Apache FOP throws an exception - i.e. if the input format is not correct/supported.", "xsl-fo:JAR-NOT-FOUND If a needed Java library could not be found." ] } ], "variables" : [ { "name" : "xsl-fo:AFP", "type" : "xs:string", "description" : " The mime type of IBMs AFP format (application/x-afp).\n" }, { "name" : "xsl-fo:EPS", "type" : "xs:string", "description" : " The mime type of the EPS format (application/postscript).\n" }, { "name" : "xsl-fo:PCL", "type" : "xs:string", "description" : " The mime type of the PCL format (application/x-pcl).\n" }, { "name" : "xsl-fo:PDF", "type" : "xs:string", "description" : " The mime type of the PDF format (application/pdf).\n" }, { "name" : "xsl-fo:PLAIN_TEXT", "type" : "xs:string", "description" : " The mime type for plain text files (text/plain).\n" }, { "name" : "xsl-fo:PNG", "type" : "xs:string", "description" : " The mime type of the PNG format (image/png).\n" }, { "name" : "xsl-fo:POSTSCRIPT", "type" : "xs:string", "description" : " The mime type of the postscript format (application/postscript).\n" }, { "name" : "xsl-fo:RTF", "type" : "xs:string", "description" : " The mime type of the RTF format (application/rtf).\n" }, { "name" : "xsl-fo:TIFF", "type" : "xs:string", "description" : " The mime type of TIFF format (application/tiff).\n" } ] }, "http://zorba.io/warnings" : { "ns" : "http://zorba.io/warnings", "description" : " This module contains one variable declaration for each diagnostic of the\n http://zorba.io/warnings namespace.\n The variables serves as documentation for the errors but can also\n be used in the code. For example, one useful scenario is to compare\n an error caught in the catch clause of a try-catch expression with one of\n the variables.\n", "sees" : [  ], "authors" : [ "Carlos Lopez" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/warnings", "prefix" : "zwarn" } ], "functions" : [  ], "variables" : [ { "name" : "zwarn:NS", "type" : "item()*", "description" : "" }, { "name" : "zwarn:ZWST0002", "type" : "xs:QName", "description" : " This warning is reported if the declaration of a function, variable,\n collection, or index contains an annotation that is not in the\n http://zorba.io/annotations namespace and Zorba doesn't know how to\n handle.\n" }, { "name" : "zwarn:ZWST0003", "type" : "item()*", "description" : "" }, { "name" : "zwarn:ZWST0004", "type" : "item()*", "description" : "" }, { "name" : "zwarn:ZWST0005", "type" : "xs:QName", "description" : " This warning is raised if the user explicitly enables caching\n of function results (using the %an:cache or %an:strictlydeterministic\n annotation) but the function cannot be cached.\n For %an:cache this happens if the function is updating or variadic.\n For %an:strictlydeterministic this happens if the function is updating,\n variadic or sequential.\n" }, { "name" : "zwarn:ZWST0006", "type" : "xs:QName", "description" : " This warning is raised if the user explicitly enables caching\n of function results (using the %an:cache annotation) and the function\n is annotated as sequential or nondeterministic.\n" }, { "name" : "zwarn:ZWST0007", "type" : "item()*", "description" : "" }, { "name" : "zwarn:ZWST0008", "type" : "item()*", "description" : "" }, { "name" : "zwarn:ZWST0009", "type" : "xs:QName", "description" : " This warning is enabled when the \"common-language\" option is employed. It will raise warnings\n for language features that are not supported by both XQuery and JSONiq grammars.\n" } ] }, "http://www.28msec.com/modules/sparql" : { "ns" : "http://www.28msec.com/modules/sparql", "description" : " This module contains functions to interact with a SPARQL endpoint.\n Requests to an endpoint are made using HTTP.\n Specifically, this module allows SELECT, ASK, CONSTRUCT and DESCRIBE queries. Additionally, it also allows for UPDATE statements.\n Various result formats are supported (e.g. XML, JSON, CSV)\n 
    Configuration
    \n For this module you may use a preconfigured default or named datasource of the SPARQL category.\n You can also provide a configuration object directly.\n 
    As config parameter you can either pass a string that will be interpreted as a SPARQL endpoint datasource name or\n  an object with the following properties:\n 
      \n  
    • href: The URL of the SPARQL endpoint to use. Required.
      • \n  
    • auth_method: The HTTP authentication method to use.
      • \n  
    • username: The username to use for HTTP authentication.
      • \n  
    • password: The password to use for HTTP authentication.
      • \n 
    \n 
    \n 
    Options
    \n 
    The options object that can be passed to plenty of the functions in this module. It may have the following properties:\n 
      \n   
    • default-graph-uri: A string or an array of strings with the graph URIs to be used by the query.
      • \n   
    • named-graph-uri: A string or an array of strings with the named graph URIs to be used by the query.
      • \n   
    • using-graph-uri: A string or an array of strings with the graph URIs to be used by an update statement.
      • \n   
    • using-named-graph-uri: A string or an array of strings with the named graph URIs to be used by an update statement.
      • \n   
    • method: The request method to be used. Available method values are $sparql:METHOD-GET, $sparql:METHOD-POST-URLENCODED or $sparql:METHOD-POST-SPARQL.
      • \n   
    • format : The result format to request. Possible format values are $sparql:FORMAT-XML, $sparql:FORMAT-JSON, $sparql:FORMAT-CSV, $sparql:FORMAT-TSV, $sparql:FORMAT-ANY. For CONSTRUCT or DESCRIBE queries $sparql:FORMAT-RDF is available.
      • \n   
    • parameters: Many SPARQL endpoints support additional parameters which are not part of the SPARQL endpoint specification. They can be provided here.
      • \n   
    • http-headers: object that will be used as the headers property for the requests made by the http-client.
      • \n   
    • http-options: object that will be used as the options property for the requests made by the http-client.
      • \n  
    \n 
    All those properties are optional.
    \n 
    \n", "sees" : [  ], "authors" : [ "Alexander.Kreutz@28msec.com" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://zorba.io/modules/http-client", "prefix" : "http-client" }, { "uri" : "http://www.w3.org/1999/02/22-rdf-syntax-ns#", "prefix" : "rdf" }, { "uri" : "http://www.w3.org/2005/sparql-results#", "prefix" : "s" }, { "uri" : "http://www.28msec.com/modules/sparql", "prefix" : "sparql" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "ask", "qname" : "sparql:ask", "signature" : "($query as string) as xs:boolean", "description" : " 
    \n This function sends a SPARQL ASK query to an endpoint and returns the result as boolean value.\n The default datasource for SPARQL will be used.\n 
    \n", "summary" : "
      \n This function sends a SPARQL ASK query to an endpoint and returns the result as boolean value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL ASK query as string.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "The boolean ASK query result." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "ask", "qname" : "sparql:ask", "signature" : "($query as string, $options as object()?) as xs:boolean", "description" : " 
    \n This function sends a SPARQL ASK query to an endpoint and returns the result as boolean value.\n The default datasource for SPARQL will be used.\n 
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object may be used to request a specific result format. However this function will try to extract only the boolean answer from the result.
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL ASK query to an endpoint and returns the result as boolean value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL ASK query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "The boolean ASK query result." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "ask", "qname" : "sparql:ask", "signature" : "($config as item()?, $query as string, $options as object()?) as xs:boolean", "description" : " 
    \n This function sends a SPARQL ASK query to an endpoint and returns the result as boolean value.\n 
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object may be used to request a specific result format. However this function will try to extract only the boolean answer from the result.
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL ASK query to an endpoint and returns the result as boolean value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "config", "type" : "item()", "occurrence" : "?", "description" : "
     The name of the credentials to use as string or a config object as described in the module description.
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL ASK query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "The boolean ASK query result." }, "errors" : [ "sparql:INVALID-RESPONSE-TYPE if the response format cannot be handled by this function", "sparql:ERROR if any http or endpoint error occurs", "sparql:INVALID-PARAMETER invalid option specification", "sparql:CREDENTIALS-NOT-FOUND credential information not found", "sparql:CREDENTIALS-INVALID credential information not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "query-json", "qname" : "sparql:query-json", "signature" : "($query as string) as object()", "description" : " 
    \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL JSON format object.\n If the endpoint fails to deliver SPARQL JSON result format this function will try to convert the results to JSON if possible.\n The default datasource for SPARQL will be used.\n 
    \n 
    Link to the specification of the result format at W3C: SPARQL 1.1 Query Results JSON Format
    \n", "summary" : "
      \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL JSON format object.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL SELECT or ASK query as string.
    " } ], "returns" : { "type" : "object()", "description" : "The query result in SPARQL JSON format." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "query-json", "qname" : "sparql:query-json", "signature" : "($query as string, $options as object()?) as object()", "description" : " 
    \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL JSON format object.\n If the endpoint fails to deliver SPARQL JSON result format this function will try to convert the results to JSON if possible.\n The default datasource for SPARQL will be used.\n 
    \n 
    Link to the specification of the result format at W3C: SPARQL 1.1 Query Results JSON Format
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object will be ignored. \"application/sparql-results+json\" will be requested as result format. 
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL JSON format object.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL SELECT or ASK query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "object()", "description" : "The query result in SPARQL JSON format." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "query-json", "qname" : "sparql:query-json", "signature" : "($config as item()?, $query as string, $options as object()?) as object()", "description" : " 
    \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL JSON format object.\n If the endpoint fails to deliver SPARQL JSON result format this function will try to convert the results to JSON if possible.\n 
    \n 
    Link to the specification of the result format at W3C: SPARQL 1.1 Query Results JSON Format
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object will be ignored. \"application/sparql-results+json\" will be requested as result format. 
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL JSON format object.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "config", "type" : "item()", "occurrence" : "?", "description" : "
     The name of the credentials to use as string or a config object as described in the module description.
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL SELECT or ASK query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "object()", "description" : "The query result in SPARQL JSON format." }, "errors" : [ "sparql:INVALID-RESPONSE-TYPE if the response format cannot be handled by this function", "sparql:ERROR if any http or endpoint error occurs", "sparql:INVALID-PARAMETER invalid option specification", "sparql:CREDENTIALS-NOT-FOUND credential information not found", "sparql:CREDENTIALS-INVALID credential information not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "query-rdf", "qname" : "sparql:query-rdf", "signature" : "($query as string) as element(rdf:RDF)", "description" : " 
    \n This function sends a SPARQL CONSTRUCT or DESCRIBE query to an endpoint and returns the query response as RDF.\n The default datasource for SPARQL will be used.\n 
    \n 
    Link to the specification of the result format at W3C: RDF/XML Syntax Specification
    \n", "summary" : "
      \n This function sends a SPARQL CONSTRUCT or DESCRIBE query to an endpoint and returns the query response as RDF.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL CONSTRUCT or DESCRIBE query as string.
    " } ], "returns" : { "type" : "element(rdf:RDF)", "description" : "The query result as RDF XML element." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "query-rdf", "qname" : "sparql:query-rdf", "signature" : "($query as string, $options as object()?) as element(rdf:RDF)", "description" : " 
    \n This function sends a SPARQL CONSTRUCT or DESCRIBE query to an endpoint and returns the query response as RDF.\n The default datasource for SPARQL will be used.\n 
    \n 
    Link to the specification of the result format at W3C: RDF/XML Syntax Specification
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object will be ignored. \"application/rdf+xml\" will be requested as result format. 
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL CONSTRUCT or DESCRIBE query to an endpoint and returns the query response as RDF.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL CONSTRUCT or DESCRIBE query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "element(rdf:RDF)", "description" : "The query result as RDF XML element." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "query-rdf", "qname" : "sparql:query-rdf", "signature" : "($config as item()?, $query as string, $options as object()?) as element(rdf:RDF)", "description" : " 
    \n This function sends a SPARQL CONSTRUCT or DESCRIBE query to an endpoint and returns the query response as RDF.\n 
    \n 
    Link to the specification of the result format at W3C: RDF/XML Syntax Specification
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object will be ignored. \"application/rdf+xml\" will be requested as result format. 
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL CONSTRUCT or DESCRIBE query to an endpoint and returns the query response as RDF.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "config", "type" : "item()", "occurrence" : "?", "description" : "
     The name of the credentials to use as string or a config object as described in the module description.
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL CONSTRUCT or DESCRIBE query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "element(rdf:RDF)", "description" : "The query result as RDF XML element." }, "errors" : [ "sparql:INVALID-RESPONSE-TYPE if the response format cannot be handled by this function", "sparql:ERROR if any http or endpoint error occurs", "sparql:INVALID-PARAMETER invalid option specification", "sparql:CREDENTIALS-NOT-FOUND credential information not found", "sparql:CREDENTIALS-INVALID credential information not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "query-xml", "qname" : "sparql:query-xml", "signature" : "($query as string) as element(s:sparql)", "description" : " 
    \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL XML format element.\n If the endpoint fails to deliver SPARQL XML result format this function will try to convert the results to XML if possible.\n The default datasource for SPARQL will be used.\n 
    \n 
    Link to the specification of the result format at W3C: SPARQL Query Results XML Format
    \n", "summary" : "
      \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL XML format element.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL SELECT or ASK query as string.
    " } ], "returns" : { "type" : "element(s:sparql)", "description" : "The query result in SPARQL XML format." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "query-xml", "qname" : "sparql:query-xml", "signature" : "($query as string, $options as object()?) as element(s:sparql)", "description" : " 
    \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL XML format element.\n If the endpoint fails to deliver SPARQL XML result format this function will try to convert the results to XML if possible.\n The default datasource for SPARQL will be used.\n 
    \n 
    Link to the specification of the result format at W3C: SPARQL Query Results XML Format
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object will be ignored. \"application/sparql-results+xml\" will be requested as result format. 
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL XML format element.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL SELECT or ASK query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "element(s:sparql)", "description" : "The query result in SPARQL XML format." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "query-xml", "qname" : "sparql:query-xml", "signature" : "($config as item()?, $query as string, $options as object()?) as element(s:sparql)", "description" : " 
    \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL XML format element.\n If the endpoint fails to deliver SPARQL XML result format this function will try to convert the results to XML if possible.\n 
    \n 
    Link to the specification of the result format at W3C: SPARQL Query Results XML Format
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object will be ignored. \"application/sparql-results+xml\" will be requested as result format. 
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL SELECT or ASK query to an endpoint and returns the query response as SPARQL XML format element.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "config", "type" : "item()", "occurrence" : "?", "description" : "
     The name of the credentials to use as string or a config object as described in the module description.
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL SELECT or ASK query as string.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "element(s:sparql)", "description" : "The query result in SPARQL XML format." }, "errors" : [ "sparql:INVALID-RESPONSE-TYPE if the response format cannot be handled by this function", "sparql:ERROR if any http or endpoint error occurs", "sparql:INVALID-PARAMETER invalid option specification", "sparql:CREDENTIALS-NOT-FOUND credential information not found", "sparql:CREDENTIALS-INVALID credential information not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "query", "qname" : "sparql:query", "signature" : "($query as string) as object()", "description" : " 
    \n This function sends a SPARQL query to an endpoint and directly returns the corresponding HTTP response.\n The default datasource for SPARQL will be used.\n 
    \n", "summary" : "
      \n This function sends a SPARQL query to an endpoint and directly returns the corresponding HTTP response.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL query as string. May be any kind of query but not an update.
    " } ], "returns" : { "type" : "object()", "description" : "The endpoints response. This function returns the plain response object from the http-client." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "query", "qname" : "sparql:query", "signature" : "($query as string, $options as object()?) as object()", "description" : " 
    \n This function sends a SPARQL query to an endpoint and directly returns the corresponding HTTP response.\n The default datasource for SPARQL will be used.\n 
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object may be used to request a specific result format. XML will be used as default. However, note that this function does not interpret the result.
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL query to an endpoint and directly returns the corresponding HTTP response.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL query as string. May be any kind of query but not an update.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "object()", "description" : "The endpoints response. This function returns the plain response object from the http-client." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "query", "qname" : "sparql:query", "signature" : "($config as item()?, $query as string, $options as object()?) as object()", "description" : " 
    \n This function sends a SPARQL query to an endpoint and directly returns the corresponding HTTP response.\n 
    \n 
    \n   
      \n    
    • The default-graph-uri and named-graph-uri properties of the options object may be used to pass default graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. GET will be used as default.
      • \n    
    • The format property of the options object may be used to request a specific result format. XML will be used as default. However, note that this function does not interpret the result.
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL query to an endpoint and directly returns the corresponding HTTP response.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "config", "type" : "item()", "occurrence" : "?", "description" : "
     The name of the credentials to use as string or a config object as described in the module description.
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A SPARQL query as string. May be any kind of query but not an update.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "object()", "description" : "The endpoints response. This function returns the plain response object from the http-client." }, "errors" : [ "sparql:INVALID-PARAMETER invalid option specification", "sparql:CREDENTIALS-NOT-FOUND credential information not found", "sparql:CREDENTIALS-INVALID credential information not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "update", "qname" : "sparql:update", "signature" : "($update-statement as string) as object()", "description" : " 
    \n This function sends a SPARQL update statement to an endpoint and directly returns the corresponding HTTP response.\n The default datasource for SPARQL will be used.\n 
    \n", "summary" : "
      \n This function sends a SPARQL update statement to an endpoint and directly returns the corresponding HTTP response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "update-statement", "type" : "string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()", "description" : "The endpoints response. This function returns the plain response object from the http-client." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "update", "qname" : "sparql:update", "signature" : "($update-statement as string, $options as object()?) as object()", "description" : " 
    \n This function sends a SPARQL update statement to an endpoint and directly returns the corresponding HTTP response.\n The default datasource for SPARQL will be used.\n 
    \n 
    \n   
      \n    
    • The using-graph-uri and using-named-graph-uri properties of the options object may be used to pass graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. POST-URLENCODED will be used as default.
      • \n    
    • The format property of the options object may be used to request a specific result format. XML will be used as default. However, note that this function does not interpret the result.
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL update statement to an endpoint and directly returns the corresponding HTTP response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "update-statement", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "object()", "description" : "The endpoints response. This function returns the plain response object from the http-client." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "update", "qname" : "sparql:update", "signature" : "($config as item()?, $update-statement as string, $options as object()?) as object()", "description" : " 
    \n This function sends a SPARQL update statement to an endpoint and directly returns the corresponding HTTP response.\n 
    \n 
    \n   
      \n    
    • The using-graph-uri and using-named-graph-uri properties of the options object may be used to pass graph URIs or named graph URIs to the endpoint.
      • \n    
    • The method property of the options object may be used to set the request method to be used. POST-URLENCODED will be used as default.
      • \n    
    • The format property of the options object may be used to request a specific result format. XML will be used as default. However, note that this function does not interpret the result.
      • \n   
    \n 
    \n", "summary" : "
      \n This function sends a SPARQL update statement to an endpoint and directly returns the corresponding HTTP response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "config", "type" : "item()", "occurrence" : "?", "description" : "
     The name of the credentials to use as string or a config object as described in the module description.
    " }, { "name" : "update-statement", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An optional options object as described in the module description.
    " } ], "returns" : { "type" : "object()", "description" : "The endpoints response. This function returns the plain response object from the http-client." }, "errors" : [ "sparql:INVALID-PARAMETER invalid option specification", "sparql:CREDENTIALS-NOT-FOUND credential information not found", "sparql:CREDENTIALS-INVALID credential information not valid" ] } ], "variables" : [ { "name" : "sparql:CREDENTIALS-CATEGORY", "type" : "string", "description" : " This variable represents the category of the datasource.\n" }, { "name" : "sparql:METHOD-GET", "type" : "string", "description" : " This variable represents the request method using HTTP GET requests. May be used for the method property of the options object.\n" }, { "name" : "sparql:METHOD-POST-URLENCODED", "type" : "string", "description" : " This variable represents the request method using HTTP POST with URL-encoded parameters. May be used for the method property of the options object.\n" }, { "name" : "sparql:METHOD-POST-SPARQL", "type" : "string", "description" : " This variable represents the request method using HTTP POST with the application/sparql-query content type. May be used for the method property of the options object.\n" }, { "name" : "sparql:FORMAT-XML", "type" : "string", "description" : " This variable represents the SPARQL XML result format.May be used for the format property of the options object.\n" }, { "name" : "sparql:FORMAT-JSON", "type" : "string", "description" : " This variable represents the SPARQL JSON result format.May be used for the format property of the options object.\n" }, { "name" : "sparql:FORMAT-RDF", "type" : "string", "description" : " This variable represents the RDF+XML result format.May be used for the format property of the options object.\n" }, { "name" : "sparql:FORMAT-CSV", "type" : "string", "description" : " This variable represents the CSV result format.May be used for the format property of the options object.\n" }, { "name" : "sparql:FORMAT-TSV", "type" : "string", "description" : " This variable represents the TSV result format.May be used for the format property of the options object.\n" }, { "name" : "sparql:FORMAT-ANY", "type" : "string", "description" : " This variable represents any result format. May be used for the format property of the options object to not specify a requested format.\n" } ] }, "http://api.28.io/dispatcher" : { "ns" : "http://api.28.io/dispatcher", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/browserview", "prefix" : "browserview" }, { "uri" : "http://api.28.io/csvview", "prefix" : "csvview" }, { "uri" : "http://api.28.io/dispatcher", "prefix" : "dispatcher" }, { "uri" : "http://api.28.io/functions", "prefix" : "functions" }, { "uri" : "http://api.28.io/model", "prefix" : "model" }, { "uri" : "http://zorba.io/modules/xml", "prefix" : "parse-xml" }, { "uri" : "http://www.zorba-xquery.com/schemas/pul", "prefix" : "pul" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "response" }, { "uri" : "http://www.zorba-xquery.com/schemas/xdm", "prefix" : "xdm" }, { "uri" : "http://api.28.io/xdmview", "prefix" : "xdmview" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "restapi", "qname" : "dispatcher:restapi", "signature" : "()", "description" : " Main function for the collection browser. May be called from a handler function.\n Uses the call URL to determine which page needs to be returned.\n The URL for the initial page needs to end with /index\n", "summary" : "
     Main function for the collection browser.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "the requested page of the collection browser" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/store/static/collections/ddl" : { "ns" : "http://zorba.io/modules/store/static/collections/ddl", "description" : " This modules defines a set of functions for managing collections that are\n declared in the prolog of a module.\n For example, it provides functions to create, delete, or introspect\n collections.\n 
    \n This module is part of Zorba's XQuery Data\n Definition Facility. All the collections managed by this module\n have to be pre-declared in the prolog of a module. Please refer to the\n general documentation\n for more information and examples.\n", "sees" : [ "Data Lifecycle", "XQuery Data Definition Facility", "http://zorba.io/modules/store/static/collections/dml", "http://zorba.io/modules/store/static/indexes/ddl", "http://zorba.io/modules/store/static/indexes/dml", "http://zorba.io/modules/store/static/integrity-constraints/ddl", "http://zorba.io/modules/store/static/integrity-constraints/dml", "http://zorba.io/errors" ], "authors" : [ "Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/store/static/collections/ddl", "prefix" : "cddl" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "available-collections", "qname" : "cddl:available-collections", "signature" : "() as xs:QName* external", "description" : " Gets the QNames of the collections that have been statically declared and\n are available, if any.\n", "summary" : "
     Gets the QNames of the collections that have been statically declared and\n are available, if any.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence comprising one QName for each statically declared and available collection or an emtpy sequence if no such collections are available." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "create", "qname" : "cddl:create", "signature" : "($name as xs:QName) external", "description" : " Creates a collection.\n", "summary" : "
     Creates a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The of the collection to create.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, creates a collection with the given name." }, "errors" : [ "zerr:ZDDY0001 if $name is not equal to any of the declared collections in the static context.", "zerr:ZDDY0002 if a collection with $name already exists." ] }, { "isDocumented" : true, "arity" : 2, "name" : "create", "qname" : "cddl:create", "signature" : "($name as xs:QName, $content as item()*) external", "description" : " Creates a collection and adds the given sequence as content to the new\n collection.\n", "summary" : "
     Creates a collection and adds the given sequence as content to the new\n collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to create.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequences of items (nodes or JSON items) to be added to the new collection.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, creates a collection with the given name and inserts the given items into it." }, "errors" : [ "zerr:ZDDY0001 if $name is not equal to any of the declared collections in the static context.", "zerr:ZDDY0002 if a collection with $name already exists.", "zerr:ZDTY0001 if $content does not match the expected type declared by the collection according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 0, "name" : "declared-collections", "qname" : "cddl:declared-collections", "signature" : "() as xs:QName* external", "description" : " Gets the collections that have been declared in the prolog of the static\n context.\n", "summary" : "
     Gets the collections that have been declared in the prolog of the static\n context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each collection created in the static context, or an emtpy sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete", "qname" : "cddl:delete", "signature" : "($name as xs:QName) external", "description" : " Deletes a collection.\n", "summary" : "
     Deletes a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The collection to delete.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the collection with the given name." }, "errors" : [ "zerr:ZDDY0001 if $name is not equal to any of the declared collections in the static context.", "zerr:ZDDY0003 if the collection identified by $name is not available.", "zerr:ZDDY0013 if the domain or key expression of any of the available indexes access the collection having $name.", "zerr:ZDDY0015 if any of the in-scope variables references an item that belongs to the collection having $name" ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-available-collection", "qname" : "cddl:is-available-collection", "signature" : "($name as xs:QName) as xs:boolean external", "description" : " Gets whether a collection is statically declared and available.\n", "summary" : "
     Gets whether a collection is statically declared and available.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the collection was statically declared and is available; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-declared-collection", "qname" : "cddl:is-declared-collection", "signature" : "($name as xs:QName) as xs:boolean external", "description" : " Gers whether a collection was declared in the prolog of the static context.\n", "summary" : "
     Gers whether a collection was declared in the prolog of the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the collection was declared; false otherwise." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/math" : { "ns" : "http://www.28msec.com/modules/math", "description" : " The functions in this module perform trigonometric and other mathematical\n calculations on double values.\n For a more detailed description of the semantics of each function, please\n refer to \n Trigonometric and exponential functions.\n", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xpath-functions/math", "prefix" : "fnmath" }, { "uri" : "http://www.28msec.com/modules/math", "prefix" : "math" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "acos", "qname" : "math:acos", "signature" : "($arg as double?) as double?", "description" : " Returns the arc cosine of the argument, the result being in the range zero to +π radians.\n", "summary" : "
     Returns the arc cosine of the argument, the result being in the range zero to +π radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "asin", "qname" : "math:asin", "signature" : "($arg as double?) as double?", "description" : " Returns the arc sine of the argument, the result being in the range -π/2 to +π/2 radians.\n", "summary" : "
     Returns the arc sine of the argument, the result being in the range -π/2 to +π/2 radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "atan", "qname" : "math:atan", "signature" : "($arg as double?) as double?", "description" : " Returns the arc tangent of the argument, the result being in the range -π/2 to +π/2 radians.\n", "summary" : "
     Returns the arc tangent of the argument, the result being in the range -π/2 to +π/2 radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "atan2", "qname" : "math:atan2", "signature" : "($y as double, $x as double) as double", "description" : " Returns the angle in radians subtended at the origin by the point on a plane with\n coordinates (x, y) and the positive x-axis, the result being in the range -π to +π.\n", "summary" : "
     Returns the angle in radians subtended at the origin by the point on a plane with\n coordinates (x, y) and the positive x-axis, the result being in the range -π to +π.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "y", "type" : "double", "occurrence" : null, "description" : "" }, { "name" : "x", "type" : "double", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "cos", "qname" : "math:cos", "signature" : "($theta as double?) as double?", "description" : " Returns the cosine of the argument, expressed in radians.\n", "summary" : "
     Returns the cosine of the argument, expressed in radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "theta", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "exp", "qname" : "math:exp", "signature" : "($arg as double?) as double?", "description" : " Returns the value of ex.\n", "summary" : "
     Returns the value of ex.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "exp10", "qname" : "math:exp10", "signature" : "($arg as double?) as double?", "description" : " Returns the value of 10x.\n", "summary" : "
     Returns the value of 10x.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "log", "qname" : "math:log", "signature" : "($arg as double?) as double?", "description" : " Returns the natural logarithm of the argument.\n", "summary" : "
     Returns the natural logarithm of the argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "log10", "qname" : "math:log10", "signature" : "($arg as double?) as double?", "description" : " Returns the base-ten logarithm of the argument.\n", "summary" : "
     Returns the base-ten logarithm of the argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "pi", "qname" : "math:pi", "signature" : "() as double", "description" : " Returns an approximation to the mathematical constant π.\n", "summary" : "
     Returns an approximation to the mathematical constant π.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "pow", "qname" : "math:pow", "signature" : "($x as double?, $y) as double?", "description" : " Returns the result of raising the first argument to the power of the second.\n", "summary" : "
     Returns the result of raising the first argument to the power of the second.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "x", "type" : "double", "occurrence" : "?", "description" : "" }, { "name" : "y", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sin", "qname" : "math:sin", "signature" : "($theta as double?) as double?", "description" : " Returns the sine of the argument, expressed in radians.\n", "summary" : "
     Returns the sine of the argument, expressed in radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "theta", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sqrt", "qname" : "math:sqrt", "signature" : "($arg as double?) as double?", "description" : " Returns the non-negative square root of the argument.\n", "summary" : "
     Returns the non-negative square root of the argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "tan", "qname" : "math:tan", "signature" : "($theta as double?) as double?", "description" : " Returns the tangent of the argument, expressed in radians.\n", "summary" : "
     Returns the tangent of the argument, expressed in radians.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "theta", "type" : "double", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "double?", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/data-cleaning/normalization" : { "ns" : "http://zorba.io/modules/data-cleaning/normalization", "description" : " 
    This library module provides data normalization functions for processing calendar dates,\n temporal values, currency values, units of measurement, location names and postal addresses.\n These functions are particularly useful for converting different data representations into cannonical formats.
    \n 
    The logic contained in this module is not specific to any particular XQuery implementation.
    \n", "sees" : [  ], "authors" : [ "Bruno Martins and Diogo Simões" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.zorba-xquery.com/modules/http-client", "prefix" : "http" }, { "uri" : "http://zorba.io/modules/data-cleaning/normalization", "prefix" : "normalization" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "normalize-address", "qname" : "normalization:normalize-address", "signature" : "($addr as xs:string*) as xs:string*", "description" : " 
    Uses an address normalization Web service to convert a postal address given as input into a\n cannonical representation format.
    \n", "summary" : "
      Uses an address normalization Web service to convert a postal address given as input into a\n cannonical representation format.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "addr", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings encoding an address, where each string in the sequence corresponds to a different component (e.g., street, city, country, etc.) of the address.
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings with the address encoded in a cannonical format, where each string in the sequence corresponds to a different component (e.g., street, city, country, etc.) of the address." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "normalize-phone", "qname" : "normalization:normalize-phone", "signature" : "($addr as xs:string*) as xs:string*", "description" : " 
    Uses an phone number normalization Web service to convert a phone number given as input into a\n cannonical representation.
    \n", "summary" : "
      Uses an phone number normalization Web service to convert a phone number given as input into a\n cannonical representation.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "addr", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "A strings with the phone number encoded in a cannonical format. 
     
     Attention : This function is still not implemented. 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "to-date", "qname" : "normalization:to-date", "signature" : "($sd as xs:string, $format as xs:string?) as xs:string", "description" : " 
    Converts a given string representation of a date value into a date representation valid according\n to the corresponding XML Schema type.
    \n", "summary" : "
      Converts a given string representation of a date value into a date representation valid according\n to the corresponding XML Schema type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sd", "type" : "xs:string", "occurrence" : null, "description" : "
     The string representation for the date
    " }, { "name" : "format", "type" : "xs:string", "occurrence" : "?", "description" : "
     An optional parameter denoting the format used to represent the date in the string, according to a sequence of conversion specifications. In the format string, a conversion specification is introduced by '%', usually followed by a single letter or 'O' or 'E' and then a single letter. Any character in the format string that is not part of a conversion specification is interpreted literally, and the string '%%' gives '%'. The supported conversion specifications are as follows: 
     '%b' Abbreviated month name in the current locale. '%B' Full month name in the current locale. '%d' Day of the month as decimal number (01-31). '%m' Month as decimal number (01-12). '%x' Date, locale-specific. '%y' Year without century (00-99). '%Y' Year with century. '%C' Century (00-99): the integer part of the year divided by 100. '%D' Locale-specific date format such as '%m/%d/%y'. '%e' Day of the month as decimal number (1-31), with a leading pace for a single-digit number. '%F' Equivalent to %Y-%m-%d (the ISO 8601 date format). '%h' Equivalent to '%b'. 
    " } ], "returns" : { "type" : "xs:string", "description" : "The date value resulting from the conversion." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "to-dateTime", "qname" : "normalization:to-dateTime", "signature" : "($sd as xs:string, $format as xs:string?) as xs:string", "description" : " 
    Converts a given string representation of a dateTime value into a dateTime representation\n valid according to the corresponding XML Schema type.
    \n", "summary" : "
      Converts a given string representation of a dateTime value into a dateTime representation\n valid according to the corresponding XML Schema type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sd", "type" : "xs:string", "occurrence" : null, "description" : "
     The string representation for the dateTime.
    " }, { "name" : "format", "type" : "xs:string", "occurrence" : "?", "description" : "
     An optional parameter denoting the format used to represent the dateTime in the string, according to a sequence of conversion specifications. In the format string, a conversion specification is introduced by '%', usually followed by a single letter or 'O' or 'E' and then a single letter. Any character in the format string that is not part of a conversion specification is interpreted literally, and the string '%%' gives '%'. The supported conversion specifications are as follows: 
     
     '%b' Abbreviated month name in the current locale. '%B' Full month name in the current locale. '%c' Date and time, locale-specific. '%C' Century (00-99): the integer part of the year divided by 100. '%d' Day of the month as decimal number (01-31). '%H' Hours as decimal number (00-23). '%I' Hours as decimal number (01-12). '%j' Day of year as decimal number (001-366). '%m' Month as decimal number (01-12). '%M' Minute as decimal number (00-59). '%p' AM/PM indicator in the locale. Used in conjunction with '%I' and *not* with '%H'. '%S' Second as decimal number (00-61), allowing for up to two leap-seconds. '%x' Date, locale-specific. '%X' Time, locale-specific. '%y' Year without century (00-99). '%Y' Year with century. '%z' Offset from Greenwich, so '-0900' is 9 hours west of Greenwich. '%Z' Time zone as a character string. '%D' Locale-specific date format such as '%m/%d/%y': ISO C99 says it should be that exact format. '%e' Day of the month as decimal number (1-31), with a leading pace for a single-digit number. '%F' Equivalent to %Y-%m-%d (the ISO 8601 date format). '%g' The last two digits of the week-based year (see '%V'). '%G' The week-based year (see '%V') as a decimal number. '%h' Equivalent to '%b'. '%k' The 24-hour clock time with single digits preceded by a blank. '%l' The 12-hour clock time with single digits preceded by a blank. '%r' The 12-hour clock time (using the locale's AM or PM). '%R' Equivalent to '%H:%M'. '%T' Equivalent to '%H:%M:%S'. 
    " } ], "returns" : { "type" : "xs:string", "description" : "The dateTime value resulting from the conversion." }, "errors" : [ "normalization:NOTSUPPORTED if the dateTime type is not known to the service." ] }, { "isDocumented" : true, "arity" : 2, "name" : "to-time", "qname" : "normalization:to-time", "signature" : "($sd as xs:string, $format as xs:string?) as xs:string?", "description" : " 
    Converts a given string representation of a time value into a time representation valid according to\n the corresponding XML Schema type.
    \n", "summary" : "
      Converts a given string representation of a time value into a time representation valid according to\n the corresponding XML Schema type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sd", "type" : "xs:string", "occurrence" : null, "description" : "
     The string representation for the time.
    " }, { "name" : "format", "type" : "xs:string", "occurrence" : "?", "description" : "
     An optional parameter denoting the format used to represent the time in the string, according to a sequence of conversion specifications. In the format string, a conversion specification is introduced by '%', usually followed by a single letter or 'O' or 'E' and then a single letter. Any character in the format string that is not part of a conversion specification is interpreted literally, and the string '%%' gives '%'. The supported conversion specifications are as follows: 
     
     '%H' Hours as decimal number (00-23). '%I' Hours as decimal number (01-12). '%M' Minute as decimal number (00-59). '%p' AM/PM indicator in the locale. Used in conjunction with '%I' and *not* with '%H'. '%S' Second as decimal number (00-61), allowing for up to two leap-seconds. '%X' Time, locale-specific. '%z' Offset from Greenwich, so '-0900' is 9 hours west of Greenwich. '%Z' Time zone as a character string. '%k' The 24-hour clock time with single digits preceded by a blank. '%l' The 12-hour clock time with single digits preceded by a blank. '%r' The 12-hour clock time (using the locale's AM or PM). '%R' Equivalent to '%H:%M'. '%T' Equivalent to '%H:%M:%S'. 
    " } ], "returns" : { "type" : "xs:string?", "description" : "The time value resulting from the conversion." }, "errors" : [ "normalization:NOTSUPPORTED if the date type is not known to the service." ] } ], "variables" : [  ] }, "http://zorba.io/modules/excel/engineering" : { "ns" : "http://zorba.io/modules/excel/engineering", "description" : "  This is a library module offering the same set of functions\n defined by Microsoft Excel, under Engineering Functions.\n", "sees" : [ "Excel Documentation: Engineering Functions" ], "authors" : [ "Sorin Nasoi" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/engineering", "prefix" : "excel-engineering" }, { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/math", "prefix" : "excel-math" }, { "uri" : "http://zorba.io/modules/excel/text", "prefix" : "excel-text" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "bin2dec", "qname" : "excel-engineering:bin2dec", "signature" : "($arg as xs:anyAtomicType) as xs:integer", "description" : " Converts a binary number to decimal.\n", "summary" : "
     Converts a binary number to decimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:integer", "description" : "A decimal representation of a number given it's binary representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a binary representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 1, "name" : "bin2hex", "qname" : "excel-engineering:bin2hex", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a binary number to hexadecimal.\n", "summary" : "
     Converts a binary number to hexadecimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A hexadecimal representation of a number given it's binary representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a binary representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 2, "name" : "bin2hex", "qname" : "excel-engineering:bin2hex", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a binary number to hexadecimal.\n", "summary" : "
     Converts a binary number to hexadecimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A hexadecimal representation of a number given it's binary representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a binary representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small." ] }, { "isDocumented" : true, "arity" : 1, "name" : "bin2oct", "qname" : "excel-engineering:bin2oct", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a binary number to octal.\n", "summary" : "
     Converts a binary number to octal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A octal representation of a number given it's binary representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a binary representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 2, "name" : "bin2oct", "qname" : "excel-engineering:bin2oct", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a binary number to octal.\n", "summary" : "
     Converts a binary number to octal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A octal representation of a number given it's binary representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a binary representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small." ] }, { "isDocumented" : true, "arity" : 1, "name" : "dec2bin", "qname" : "excel-engineering:dec2bin", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a decimal number to binary.\n", "summary" : "
     Converts a decimal number to binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A binary representation of a number given it's decimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not numeric.", "excel-err:Num if provided value for $arg is smaller than -512 or bigger than 511." ] }, { "isDocumented" : true, "arity" : 2, "name" : "dec2bin", "qname" : "excel-engineering:dec2bin", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a decimal number to binary.\n", "summary" : "
     Converts a decimal number to binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A binary representation of a number given it's decimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not numeric.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small.", "excel-err:Num if provided value for $arg is smaller than -512 or bigger than 511." ] }, { "isDocumented" : true, "arity" : 1, "name" : "dec2hex", "qname" : "excel-engineering:dec2hex", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a decimal number to hexadecimal.\n", "summary" : "
     Converts a decimal number to hexadecimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A hexadecimal representation of a number given it's decimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not numeric.", "excel-err:Num if provided value for $arg is smaller than -549755813888 or bigger than 549755813887" ] }, { "isDocumented" : true, "arity" : 2, "name" : "dec2hex", "qname" : "excel-engineering:dec2hex", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a decimal number to hexadecimal.\n", "summary" : "
     Converts a decimal number to hexadecimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A hexadecimal representation of a number given it's decimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not numeric.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small.", "excel-err:Num if provided value for $arg is smaller than -549755813888 or bigger than 549755813887." ] }, { "isDocumented" : true, "arity" : 1, "name" : "dec2oct", "qname" : "excel-engineering:dec2oct", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a decimal number to octal.\n", "summary" : "
     Converts a decimal number to octal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "An octal representation of a number given it's decimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not numeric.", "excel-err:Num if provided value for $arg is smaller than -536870912 or bigger than 536870911." ] }, { "isDocumented" : true, "arity" : 2, "name" : "dec2oct", "qname" : "excel-engineering:dec2oct", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a decimal number to octal.\n", "summary" : "
     Converts a decimal number to octal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "An octal representation of a number given it's decimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not numeric", "excel-err:Value if provided value for $places is not numeric", "excel-err:Num if provided value for $places is zero or negative", "excel-err:Num if provided value for $places is too small", "excel-err:Num if provided value for $arg is smaller than -536870912 or bigger than 536870911" ] }, { "isDocumented" : true, "arity" : 1, "name" : "hex2bin", "qname" : "excel-engineering:hex2bin", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a hexadecimal number to binary.\n", "summary" : "
     Converts a hexadecimal number to binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A binary representation of a number given it's hexadecimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a hexadecimal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 2, "name" : "hex2bin", "qname" : "excel-engineering:hex2bin", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a hexadecimal number to binary.\n", "summary" : "
     Converts a hexadecimal number to binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A binary representation of a number given it's hexadecimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a hexadecimal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small." ] }, { "isDocumented" : true, "arity" : 1, "name" : "hex2dec", "qname" : "excel-engineering:hex2dec", "signature" : "($arg as xs:string) as xs:integer", "description" : " Converts a hexadecimal number to decimal.\n", "summary" : "
     Converts a hexadecimal number to decimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:integer", "description" : "A decimal representation of a number given it's hexadecimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a hexadecimal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 1, "name" : "hex2oct", "qname" : "excel-engineering:hex2oct", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts a hexadecimal number to octal.\n", "summary" : "
     Converts a hexadecimal number to octal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A octal representation of a number given it's hexadecimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a hexadecimal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 2, "name" : "hex2oct", "qname" : "excel-engineering:hex2oct", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts a hexadecimal number to octal.\n", "summary" : "
     Converts a hexadecimal number to octal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A octal representation of a number given it's hexadecimal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not a hexadecimal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small." ] }, { "isDocumented" : true, "arity" : 1, "name" : "oct2bin", "qname" : "excel-engineering:oct2bin", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts an octal number to binary.\n", "summary" : "
     Converts an octal number to binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A binary representation of a number given it's octal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not an octal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 2, "name" : "oct2bin", "qname" : "excel-engineering:oct2bin", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts an octal number to binary.\n", "summary" : "
     Converts an octal number to binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A binary representation of a number given it's octal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not an octal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small." ] }, { "isDocumented" : true, "arity" : 1, "name" : "oct2dec", "qname" : "excel-engineering:oct2dec", "signature" : "($arg as xs:anyAtomicType) as xs:integer", "description" : " Converts an octal number to decimal.\n", "summary" : "
     Converts an octal number to decimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:integer", "description" : "A decimal representation of a number given it's octal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not an octal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 1, "name" : "oct2hex", "qname" : "excel-engineering:oct2hex", "signature" : "($arg as xs:anyAtomicType) as xs:string", "description" : " Converts an octal number to hexadecimal.\n", "summary" : "
     Converts an octal number to hexadecimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " } ], "returns" : { "type" : "xs:string", "description" : "A hexadecimal representation of a number given it's octal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not an octal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters." ] }, { "isDocumented" : true, "arity" : 2, "name" : "oct2hex", "qname" : "excel-engineering:oct2hex", "signature" : "($arg as xs:anyAtomicType, $places as xs:anyAtomicType) as xs:string", "description" : " Converts an octal number to hexadecimal.\n", "summary" : "
     Converts an octal number to hexadecimal.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the number.
    " }, { "name" : "places", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     is the number of characters to use. Places is useful for padding the return value with leading 0s (zeros).
    " } ], "returns" : { "type" : "xs:string", "description" : "A hexadecimal representation of a number given it's octal representation." }, "errors" : [ "excel-err:Value if provided value for $arg is not an octal representation of a number.", "excel-err:Value if provided value for $arg contains more than 10 characters.", "excel-err:Value if provided value for $places is not numeric.", "excel-err:Num if provided value for $places is zero or negative.", "excel-err:Num if provided value for $places is too small." ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/util-jvm" : { "ns" : "http://www.zorba-xquery.com/modules/util-jvm", "description" : " This module provides common functionality for modules that use java\n implementations.\n 
    \n 
    \n Modules using java implementations must import this module\n to specify the dependency.\n 
    \n 
    \n Note: Since this module has a Java library dependency a JVM is required\n to be installed on the system. For Windows: jvm.dll is required on the system\n path (usually located in \"C:\\Program Files\\Java\\jre\\bin\\client\").\n", "sees" : [  ], "authors" : [ "Cezar Andrei" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.zorba-xquery.com/modules/util-jvm", "prefix" : "util-jvm" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [  ], "variables" : [  ] }, "http://www.28msec.com/modules/asynchronous-jobs" : { "ns" : "http://www.28msec.com/modules/asynchronous-jobs", "description" : " 
    This module provides functionality for executing asynchronous jobs.\n There are three kinds of jobs: (1) a job for executing a (public or private)\n query of your project, (2) a job for mapping an input\n collection into an output collection, and (3) a job for shuffling the items\n of an input collection to several output collections.\n Map and Shuffle jobs are mostly used within\n the parallelism framework and are not meant to be created directly.
    \n 
    Jobs that have been scheduled for execution can be referred to by\n an opaque identifier being returned by the corresponding scheduling\n function (e.g. job:execute or job:map). Specifically,\n the job's identifier can be used to retrieve the status of a job\n (e.g. job:status) or the names of its input and output collections.
    \n", "sees" : [  ], "authors" : [ "Ghislain Fourny", "Julien Ribon", "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/base64", "prefix" : "base64" }, { "uri" : "http://zorba.io/modules/fetch", "prefix" : "fetch" }, { "uri" : "http://www.zorba-xquery.com/modules/http-client", "prefix" : "http-client" }, { "uri" : "http://www.28msec.com/modules/asynchronous-jobs", "prefix" : "job" }, { "uri" : "http://www.28msec.com/modules/project", "prefix" : "project" }, { "uri" : "http://zorba.io/modules/random", "prefix" : "rand" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "request" }, { "uri" : "http://www.28msec.com/modules/store", "prefix" : "store" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "build-map-shuffle", "qname" : "job:build-map-shuffle", "signature" : "($input-collection as xs:string, $options as object()?) as object()", "description" : " 
    Builds an object describing an asynchronous job (map or shuffle).
    \n 
    This object can then be sent to the scheduler.
    \n 
    The $options parameter allows for the specification of properties for\n the shuffle job. Allowed options are:\n 
      \n   
    • kind: the kind of job (\"map\" or \"shuffle\").
      • \n   
    • map-function (map jobs only): a function with any signature\n   (item()* to item()*),\n   and that is used to map the input collection to the output collection.
      • \n   
    • shuffle-function (shuffle jobs only): a function taking an item\n   and returning an integer.\n   It is used to select the output collection to which each item is sent.
      • \n   
    • output-collection as string (map jobs only): the name of the collection in\n     which the output of the executed query is stored. If not specified,\n     the result of the query will be stored in a collection withing the\n     MongoDB database associated with the project. The name of the\n     collection is randomly generated and starts with _28.temporary\n   
      • \n   
    • output-collections as array (shuffle jobs only): an array with the names of the collections in\n     which the items of the input collections are shuffled. Compulsory.\n   
      • \n   
    • chunk-info as object: an object containing the specification of a chunk\n     of the input collection. The shuffling will only occur on this chunk.\n     If not specified, the entire input collection will be mapped.\n   
      • \n   
    • allow-streaming as boolean (map jobs only): a boolean indicating if calling the map function can\n     be distributed over partitions of the input collection. If false, the map function will\n     be called only once on the entire input collection. This might result\n     in a cache overflow if the number of items is too big. If true,\n     the input will be arbitrarily partitioned and the map function will be called for each\n     partition. The size of a partition is chosen in order to be smaller than the cache size.\n     The default is false.\n   
      • \n   
    • dependencies as array: an array containing the ids of all asynchronous jobs that must\n     be completed before this job starts. This job will be hold pending until all these dependencies\n     are completed.\n   
      • \n 
    \n 
    \n", "summary" : "
      Builds an object describing an asynchronous job (map or shuffle).
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "input-collection", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the collection that the job processes.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An object specifying above options for the asynchronous job.
    " } ], "returns" : { "type" : "object()", "description" : "the id of the scheduled job, which can be used to pull for the status and results." }, "errors" : [ "err:XPTY0004 if the type of a supplied option is incorrect.", "job:JBDY0005 if the supplied function does not have a name.", "job:JBDY0006 if the supplied function is in the local namespace.", "job:JBDY0008 if the supplied input collection is not available." ] }, { "isDocumented" : true, "arity" : 1, "name" : "error", "qname" : "job:error", "signature" : "($id as xs:string) as object()?", "description" : " 
    Returns the error object output by an asynchronous job, in case of a failed job.
    \n", "summary" : "
      Returns the error object output by an asynchronous job, in case of a failed job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "object()?", "description" : "the error object output by the corresponding asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute", "qname" : "job:execute", "signature" : "($query as xs:string) as xs:string", "description" : " 
    Schedules an asynchronous job executing the given (public or private)\n query from your project.
    \n 
    The result of the query will be stored in a collection withing the\n MongoDB database associated with the project. The name of the collection\n is randomly generated and starts with _28.temporary.
    \n", "summary" : "
      Schedules an asynchronous job executing the given (public or private)\n query from your project.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "xs:string", "occurrence" : null, "description" : "
     The path of the query to execute, which must begin with /public or /private. (examples: /public/query.xq, /private/query.jq).
    " } ], "returns" : { "type" : "xs:string", "description" : "The id of the scheduled job." }, "errors" : [ "job:JBDY0003 if the supplied query path does not begin with /public or /private.", "job:JBDY0004 if the supplied query path cannot be resolved." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute", "qname" : "job:execute", "signature" : "($query as xs:string, $options as object()?) as xs:string", "description" : " 
    Schedules an asynchronous job executing the given (public or private)\n query from your project.
    \n 
    The $options parameter allows for the specification of properties for\n the asynchronously executed job. Allowed options are:\n 
      \n   
    • output-collection as string: the name of the collection in\n     which the output of the executed query is stored. If not specified,\n     the result of the query will be stored in a collection withing the\n     MongoDB database associated with the project. The name of the\n     collection is randomly generated and starts with _28.temporary\n   
      • \n 
    \n 
    \n", "summary" : "
      Schedules an asynchronous job executing the given (public or private)\n query from your project.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "xs:string", "occurrence" : null, "description" : "
     The path of the query to execute, which must begin with /public or /private. (examples: /public/query.xq, /private/query.jq).
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An object specifying above options for the asynchronous job.
    " } ], "returns" : { "type" : "xs:string", "description" : "The id of the scheduled job." }, "errors" : [ "err:XPTY0004 if the type of a supplied option is incorrect.", "job:JBDY0003 if the supplied query path does not begin with /public or /private.", "job:JBDY0004 if the supplied query path cannot be resolved." ] }, { "isDocumented" : true, "arity" : 1, "name" : "function", "qname" : "job:function", "signature" : "($id as xs:string) as xs:string?", "description" : " 
    Returns the name of the map or shuffle function used by an asynchronous job.
    \n", "summary" : "
      Returns the name of the map or shuffle function used by an asynchronous job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "xs:string?", "description" : "the name of the map or shuffle function of the corresponding asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "get", "qname" : "job:get", "signature" : "($id as xs:string) as object()*", "description" : " 
    Returns the asynchronous job associated with the supplied asynchronous job id,\n or the asynchronous jobs associated with the supplied parallel job id.
    \n 
    This function is internal and should only be used by the parallelism module.
    \n", "summary" : "
      Returns the asynchronous job associated with the supplied asynchronous job id,\n or the asynchronous jobs associated with the supplied parallel job id.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous or parallel job to query.
    " } ], "returns" : { "type" : "object()*", "description" : "the objects describing the asynchronous jobs." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "input-collection", "qname" : "job:input-collection", "signature" : "($id as xs:string) as xs:string?", "description" : " 
    Returns the name of the input collection of a mapping asynchronous job.
    \n", "summary" : "
      Returns the name of the input collection of a mapping asynchronous job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "xs:string?", "description" : "the name of the input collection of the corresponding asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "jobs", "qname" : "job:jobs", "signature" : "() as object()*", "description" : " 
    Returns the ids of all jobs created by this project.
    \n", "summary" : "
      Returns the ids of all jobs created by this project.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "the sequence of the ids of all jobs created so far." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "kind", "qname" : "job:kind", "signature" : "($id as xs:string) as xs:string?", "description" : " 
    Returns the kind of the asynchronous job.
    \n", "summary" : "
      Returns the kind of the asynchronous job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "xs:string?", "description" : "the kind of the asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "map", "qname" : "job:map", "signature" : "($input-collection as xs:string, $map-function as function (item()*) as item()*) as xs:string", "description" : " 
    Schedules an asynchronous job mapping the input collection\n to an output collection with the specified function.
    \n 
    The name of the output collection is randomly generated and\n starts with _28.temporary.
    \n", "summary" : "
      Schedules an asynchronous job mapping the input collection\n to an output collection with the specified function.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "input-collection", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the collection that the job processes.
    " }, { "name" : "map-function", "type" : "function (item()*) as item()*", "occurrence" : null, "description" : "
     The function which is run on the input collection's contents.
    " } ], "returns" : { "type" : "xs:string", "description" : "The id of the scheduled job, which can be used to pull for the status and results." }, "errors" : [ "job:JBDY0005 if the supplied function does not have a name.", "job:JBDY0006 if the supplied function is in the local namespace.", "job:JBDY0008 if the supplied input collection does not exist." ] }, { "isDocumented" : true, "arity" : 3, "name" : "map", "qname" : "job:map", "signature" : "($input-collection as xs:string, $map-function as function (item()*) as item()*, $options as object()?) as xs:string", "description" : " 
    Schedules an asynchronous job mapping the input collection\n to an output collection with the specified function.
    \n 
    The $options parameter allows for the specification of properties for\n the map job. Allowed options are:\n 
      \n   
    • output-collection as string: the name of the collection in\n     which the output of the executed query is stored. If not specified,\n     the result of the query will be stored in a collection withing the\n     MongoDB database associated with the project. The name of the\n     collection is randomly generated and starts with _28.temporary\n   
      • \n   
    • chunk-info as object: an object containing the specification of a chunk\n     of the input collection. The mapping will only occur on this chunk.\n     If not specified, the entire input collection will be mapped.\n   
      • \n   
    • allow-streaming as boolean: a boolean indicating if calling the map function can\n     be distributed over partitions of the input collection. If false, the map function will\n     be called only once on the entire input collection. This might result\n     in a cache overflow if the number of items is too big. If true,\n     the input will be arbitrarily partitioned and the map function will be called for each\n     partition. The size of a partition is chosen in order to be smaller than the cache size.\n     The default is false.\n   
      • \n   
    • dependencies as array: an array containing the ids of all asynchronous jobs that must\n     be completed before this job starts. This job will be hold pending until all these dependencies\n     are completed.\n   
      • \n 
    \n 
    \n", "summary" : "
      Schedules an asynchronous job mapping the input collection\n to an output collection with the specified function.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "input-collection", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the collection that the job processes.
    " }, { "name" : "map-function", "type" : "function (item()*) as item()*", "occurrence" : null, "description" : "
     The function which is run on the collection's contents.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An object specifying above options for the asynchronous job.
    " } ], "returns" : { "type" : "xs:string", "description" : "the id of the scheduled job, which can be used to pull for the status and results." }, "errors" : [ "err:XPTY0004 if the type of a supplied option is incorrect.", "job:JBDY0005 if the supplied function does not have a name.", "job:JBDY0006 if the supplied function is in the local namespace.", "job:JBDY0008 if the supplied input collection does not exist." ] }, { "isDocumented" : true, "arity" : 1, "name" : "output-collection", "qname" : "job:output-collection", "signature" : "($id as xs:string) as xs:string?", "description" : " 
    Returns the name of the output collection of a mapping or executing asynchronous job.
    \n", "summary" : "
      Returns the name of the output collection of a mapping or executing asynchronous job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "xs:string?", "description" : "the name of the output collection of the corresponding asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "output-collections", "qname" : "job:output-collections", "signature" : "($id as xs:string) as xs:string*", "description" : " Returns the name of the output collections of a shuffle asynchronous job.\n", "summary" : "
     Returns the name of the output collections of a shuffle asynchronous job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "the name of the output collections of the corresponding asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "properties", "qname" : "job:properties", "signature" : "($id as xs:string) as object()", "description" : " 
    Returns the properties of an asynchronous job as an object with the following\n fields:
    \n 
      \n  
    • accessed: the time at which the job was last accessed.
      • \n  
    • completed: the time at which the job was completed.
      • \n  
    • created: the time at which the job was created.
      • \n  
    • lock-acquired: the time at which a processing lock was taken on the job.
      • \n  
    • status: the status of the job. One of pending, in progress,\n  completed, failed, timed out.
      • \n  
    • error: An object containing error information in case of failure.
      • \n 
    \n", "summary" : "
      Returns the properties of an asynchronous job as an object with the following\n fields: \n  \n   accessed : the time at which the job was last accessed.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "object()", "description" : "the time at which the corresponding asynchronous job was last accessed." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "query-name", "qname" : "job:query-name", "signature" : "($id as xs:string) as xs:string?", "description" : " 
    Returns the name of the query executed by an executing asynchronous job.
    \n", "summary" : "
      Returns the name of the query executed by an executing asynchronous job.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "id", "type" : "xs:string", "occurrence" : null, "description" : "
     the id of the asynchronous job to query.
    " } ], "returns" : { "type" : "xs:string?", "description" : "the name of the query executed by the corresponding asynchronous job." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "schedule", "qname" : "job:schedule", "signature" : "($jobs as object()*) as object()*", "description" : " 
    Sends jobs to the job queue.
    \n 
    This function is internal and should only be used by this and the parallelism module.
    \n", "summary" : "
      Sends jobs to the job queue.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "jobs", "type" : "object()", "occurrence" : "*", "description" : "
     The job to send, as generated by job:build-map-shuffle().
    " } ], "returns" : { "type" : "object()*", "description" : "Objects containing the new ids." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "shuffle", "qname" : "job:shuffle", "signature" : "($input-collection as xs:string, $shuffle-function as function (item()) as xs:integer, $options as object()?) as xs:string", "description" : " 
    Schedules an asynchronous job shuffling the items of the input collections to output collections\n using the specified shuffle function.
    \n 
    The $options parameter allows for the specification of properties for\n the shuffle job. Allowed options are:\n 
      \n   
    • output-collections as array: an array with the names of the collections in\n     which the items of the input collections are shuffled. Compulsory.\n   
      • \n   
    • chunk-info as object: an object containing the specification of a chunk\n     of the input collection. The shuffling will only occur on this chunk.\n     If not specified, the entire input collection will be mapped.\n   
      • \n   
    • dependencies as array: an array containing the ids of all asynchronous jobs that must\n     be completed before this job starts. This job will be hold pending until all these dependencies\n     are completed.\n   
      • \n 
    \n 
    \n", "summary" : "
      Schedules an asynchronous job shuffling the items of the input collections to output collections\n using the specified shuffle function.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "input-collection", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the collection that the job processes.
    " }, { "name" : "shuffle-function", "type" : "function (item()) as xs:integer", "occurrence" : null, "description" : "" }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     An object specifying above options for the asynchronous job.
    " } ], "returns" : { "type" : "xs:string", "description" : "the id of the scheduled job, which can be used to pull for the status and results." }, "errors" : [ "err:XPTY0004 if the type of a supplied option is incorrect.", "job:JBDY0005 if the supplied function does not have a name.", "job:JBDY0006 if the supplied function is in the local namespace.", "job:JBDY0008 if the supplied input collection does not exist." ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/datetime" : { "ns" : "http://www.28msec.com/modules/datetime", "description" : " This modules contains function that operate on items of type date, time,\n dateTime, and duration.\n 
    The module is always imported so you don't need to import it explicitly.\n Also, you don't need to fully qualify a function to invoke it.
    \n", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.28msec.com/modules/datetime", "prefix" : "datetime" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "adjust-date-to-timezone", "qname" : "datetime:adjust-date-to-timezone", "signature" : "($arg as date?) as date?", "description" : " Adjusts a date value to the implicit timezone.\n", "summary" : "
     Adjusts a date value to the implicit timezone.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "date?", "description" : "the date in the implicit timezone that contains the starting instant of the supplied date. For a detailed description of the semantics of this function, please see adjust-date-to-timezone." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "adjust-date-to-timezone", "qname" : "datetime:adjust-date-to-timezone", "signature" : "($arg as date?, $timezone as dayTimeDuration?) as date?", "description" : " Adjusts a date value to a specific timezone, or to no timezone at all.\n", "summary" : "
     Adjusts a date value to a specific timezone, or to no timezone at all.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "date", "occurrence" : "?", "description" : "" }, { "name" : "timezone", "type" : "dayTimeDuration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "date?", "description" : "the date in the target timezone that contains the starting instant of the supplied date. 
       
    • adjust-date-to-timezone(date(\"2002-03-07\"), dayTimeDuration(\"-PT10H\")) returns date(\"2002-03-06-10:00\").
      •  
    • adjust-date-to-timezone(date(\"2002-03-07-07:00\"), ()) returns date(\"2002-03-07\").
      •  
     For a detailed description of the semantics of this function, please see adjust-date-to-timezone" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "adjust-dateTime-to-timezone", "qname" : "datetime:adjust-dateTime-to-timezone", "signature" : "($arg as dateTime?) as dateTime", "description" : " Adjusts a dateTime value to the implicit timezone.\n", "summary" : "
     Adjusts a dateTime value to the implicit timezone.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "dateTime", "description" : "the dateTime in the implicit timezone. For a detailed description of the semantics of this function, please see adjust-dateTime-to-timezone" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "adjust-dateTime-to-timezone", "qname" : "datetime:adjust-dateTime-to-timezone", "signature" : "($arg as dateTime?, $timezone as dayTimeDuration?) as dateTime", "description" : " Adjusts a dateTime value to the specified timezone, or to no timezone at all.\n", "summary" : "
     Adjusts a dateTime value to the specified timezone, or to no timezone at all.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" }, { "name" : "timezone", "type" : "dayTimeDuration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "dateTime", "description" : "the dateTime in the specified timezone. 
       
    • adjust-dateTime-to-timezone(dateTime('2002-03-07T10:00:00-07:00'), dayTimeDuration(\"-PT10H\")) returns dateTime('2002-03-07T07:00:00-10:00').
      •  
    • adjust-dateTime-to-timezone(dateTime('2002-03-07T10:00:00'), ()) returns dateTime('2002-03-07T10:00:00').
      •  
     For a detailed description of the semantics of this function, please see adjust-dateTime-to-timezone" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "adjust-time-to-timezone", "qname" : "datetime:adjust-time-to-timezone", "signature" : "($arg as time?) as time?", "description" : " Adjusts a time value to an implicit timezone.\n", "summary" : "
     Adjusts a time value to an implicit timezone.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "time?", "description" : "the time in the implicit timezone. For a detailed description of the semantics of this function, please see adjust-time-to-timezone" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "adjust-time-to-timezone", "qname" : "datetime:adjust-time-to-timezone", "signature" : "($arg as time?, $timezone as dayTimeDuration?) as time?", "description" : " Adjusts a time value to a specific timezone, or to no timezone at all.\n", "summary" : "
     Adjusts a time value to a specific timezone, or to no timezone at all.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "time", "occurrence" : "?", "description" : "" }, { "name" : "timezone", "type" : "dayTimeDuration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "time?", "description" : "the time in the specified timezone. 
       
    • adjust-time-to-timezone(time(\"10:00:00\"), dayTimeDuration(\"-PT10H\")) returns time(\"07:00:00-10:00\").
      •  
    • adjust-time-to-timezone(time(\"10:00:00-07:00\"), ()) returns time(\"10:00:00\").
      •  
     For a detailed description of the semantics of this function, please see adjust-time-to-timezone" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "current-date", "qname" : "datetime:current-date", "signature" : "() as date external", "description" : " Returns the current date.\n For a detailed description of the semantics of this function, please see\n current-date\n", "summary" : "
     Returns the current date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "date", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "current-dateTime", "qname" : "datetime:current-dateTime", "signature" : "() as dateTimeStamp external", "description" : " Returns the current dateTime.\n For a detailed description of the semantics of this function, please see\n current-dateTime\n", "summary" : "
     Returns the current dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "dateTimeStamp", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "current-time", "qname" : "datetime:current-time", "signature" : "() as time external", "description" : " Returns the current time.\n For a detailed description of the semantics of this function, please see\n current-time\n", "summary" : "
     Returns the current time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "time", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "dateTime", "qname" : "datetime:dateTime", "signature" : "($arg1 as date?, $arg2 as time?) as dateTime?", "description" : " Returns a dateTime value created by combining a date and a time.\n", "summary" : "
     Returns a dateTime value created by combining a date and a time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "date", "occurrence" : "?", "description" : "" }, { "name" : "arg2", "type" : "time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "dateTime?", "description" : "the dateTime value created by combinding the given date and time. 
       
    • dateTime(date(\"1999-12-31\"), time(\"12:00:00\")) returns dateTime(\"1999-12-31T12:00:00\").
      •  
     For a detailed description of the semantics of this function, please see dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day-from-date", "qname" : "datetime:day-from-date", "signature" : "($arg as date?) as integer?", "description" : " Returns the day component of a date.\n", "summary" : "
     Returns the day component of a date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the day component of the given date. 
       
    • day-from-date(date(\"1999-05-31-05:00\")) returns 31.
      •  
     For a detailed description of the semantics of this function, please see day-from-date" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day-from-dateTime", "qname" : "datetime:day-from-dateTime", "signature" : "($arg as dateTime?) as integer?", "description" : " Returns the day component of a dateTime.\n", "summary" : "
     Returns the day component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the day component of the given dateTime. 
       
    • day-from-dateTime(dateTime(\"1999-12-31T20:00:00-05:00\")) returns 31.
      •  
     For a detailed description of the semantics of this function, please see day-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "days-from-duration", "qname" : "datetime:days-from-duration", "signature" : "($arg as duration?) as integer?", "description" : " Returns the number of days in a duration.\n", "summary" : "
     Returns the number of days in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the number of days in the given duration. 
       
    • days-from-duration(dayTimeDuration(\"P3DT55H\")) returns 5.
      •  
     For a detailed description of the semantics of this function, please see days-from-duration" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-date", "qname" : "datetime:format-date", "signature" : "($value as date?, $picture as string) as string?", "description" : " Returns a string containing a date value formatted for display.\n", "summary" : "
     Returns a string containing a date value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "date", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "string?", "description" : "the string formatted according to the given picture. The following examples assume let $d := date(\"2002-12-31\") and the Gregorian calendar as the default calendar. 
       
    • format-date($d, \"[Y0001]-[M01]-[D01]\") returns 2002-12-31.
      •  
    • format-date($d, \"[D1] [MI] [Y]\") returns 31 XII 2002.
      •  
     For a detailed description of the semantics of this function, please see format-date" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "format-date", "qname" : "datetime:format-date", "signature" : "($value as date?, $picture as string, $language as string?, $calendar as string?, $place as string?) as string?", "description" : " Returns a string containing a date value formatted for display.\n", "summary" : "
     Returns a string containing a date value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "date", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "language", "type" : "string", "occurrence" : "?", "description" : "" }, { "name" : "calendar", "type" : "string", "occurrence" : "?", "description" : "" }, { "name" : "place", "type" : "string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "string?", "description" : "the string formatted according to the given picture. The following examples assume let $d := date(\"2002-12-31\") and the Gregorian calendar as the default calendar. 
       
    • format-date($d, \"[YWw]\", \"en\", (), ()) returns Two Thousand and Three.
      •  
    • format-date($d, \"[D] [MNn], [Y]\", \"de\", (), ()) returns 31 Dezember, 2002.
      •  
    • format-date($d, \"[D\\u0E51] [Mn] [Y\\u0E51]\", \"th\", \"BE\", ()) returns ๓๑ ธันวาคม ๒๐๐๒.
      •  
     For a detailed description of the semantics of this function, please see format-date" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "format-dateTime", "qname" : "datetime:format-dateTime", "signature" : "($value as dateTime?, $picture as string) as string?", "description" : " Returns a string containing a dateTime value formatted for display.\n", "summary" : "
     Returns a string containing a dateTime value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "dateTime", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "string?", "description" : "the string formatted according to the given picture. The following examples assume let $dt := dateTime(\"2002-12-31T15:58:45\") and the Gregorian calendar as the default calendar. 
       
    • format-dateTime($dt, \"[h].[m01][Pn] on [FNn], [D1o] [MNn]\") returns 3.58pm on Tuesday, 31st December.
      •  
    • format-dateTime($dt, \"[M01]/[D01]/[Y0001] at [H01]:[m01]:[s01]\") returns 12/31/2002 at 15:58:45.
      •  
     For a detailed description of the semantics of this function, please see format-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 5, "name" : "format-dateTime", "qname" : "datetime:format-dateTime", "signature" : "($value as dateTime?, $picture as string, $language as string?, $calendar as string?, $place as string?) as string?", "description" : " Returns a string containing a dateTime value formatted for display.\n", "summary" : "
     Returns a string containing a dateTime value formatted for display.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "dateTime", "occurrence" : "?", "description" : "" }, { "name" : "picture", "type" : "string", "occurrence" : null, "description" : "" }, { "name" : "language", "type" : "string", "occurrence" : "?", "description" : "" }, { "name" : "calendar", "type" : "string", "occurrence" : "?", "description" : "" }, { "name" : "place", "type" : "string", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "string?", "description" : "the string formatted according to the given picture. For a detailed description of the semantics of this function, please see format-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hours-from-dateTime", "qname" : "datetime:hours-from-dateTime", "signature" : "($arg as dateTime?) as integer?", "description" : " Returns the hours component of a dateTime.\n", "summary" : "
     Returns the hours component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the hours component of the given dateTime. 
       
    • hours-from-dateTime(dateTime(\"1999-12-31T21:20:00-05:00\")) returns 21.
      •  
    • hours-from-dateTime(adjust-dateTime-to-timezone(dateTime(\"1999-12-31T21:20:00-05:00\"), dayTimeDuration(\"PT0S\"))) returns 2.
      •  
     For a detailed description of the semantics of this function, please see hours-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hours-from-duration", "qname" : "datetime:hours-from-duration", "signature" : "($arg as duration?) as integer?", "description" : " Returns the number of hours in a duration.\n", "summary" : "
     Returns the number of hours in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the number of hours in the given duration. 
       
    • hours-from-duration(dayTimeDuration(\"P3DT10H\")) returns 10.
      •  
    • hours-from-duration(dayTimeDuration(\"-P3DT10H\")) returns -10.
      •  
     For a detailed description of the semantics of this function, please see hours-from-duration" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hours-from-time", "qname" : "datetime:hours-from-time", "signature" : "($arg as time?) as integer?", "description" : " Returns the hours component of a time.\n", "summary" : "
     Returns the hours component of a time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the hours component of the given time. 
       
    • hours-from-time(time(\"11:23:00\")) returns 11.
      •  
    • hours-from-time(time(\"24:00:00\")) returns 0.
      •  
    • hours-from-time(adjust-time-to-timezone(time(\"01:23:00+05:00\"), dayTimeDuration(\"PT0S\"))) returns 20.
      •  
     For a detailed description of the semantics of this function, please see hours-from-time" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "implicit-timezone", "qname" : "datetime:implicit-timezone", "signature" : "() as dayTimeDuration", "description" : " Returns the value of the implicit timezone property set in the platform.\n", "summary" : "
     Returns the value of the implicit timezone property set in the platform.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "dayTimeDuration", "description" : "the implicit timezone property. For a detailed description of the semantics of this function, please see implicit-timezone" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minutes-from-dateTime", "qname" : "datetime:minutes-from-dateTime", "signature" : "($arg as dateTime?) as integer?", "description" : " Returns the minute component of a dateTime.\n", "summary" : "
     Returns the minute component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the minute component of the given dateTime. 
       
    • minutes-from-dateTime(dateTime(\"1999-05-31T13:20:00-05:00\")) returns 20.
      •  
     For a detailed description of the semantics of this function, please see minutes-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minutes-from-duration", "qname" : "datetime:minutes-from-duration", "signature" : "($arg as duration?) as integer?", "description" : " Returns the number of minutes in a duration.\n", "summary" : "
     Returns the number of minutes in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the number of minutes of the given duration. 
       
    • minutes-from-duration(dayTimeDuration(\"P3DT10H\")) returns 0.
      •  
    • minutes-from-duration(dayTimeDuration(\"-P5DT12H30M\")) returns -30.
      •  
     For a detailed description of the semantics of this function, please see minutes-from-duration" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "minutes-from-time", "qname" : "datetime:minutes-from-time", "signature" : "($arg as time?) as integer?", "description" : " Returns the minutes component of a time.\n", "summary" : "
     Returns the minutes component of a time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the minutes component of the given time. 
       
    • minutes-from-time(time(\"13:00:00Z\")) returns 0.
      •  
     For a detailed description of the semantics of this function, please see minutes-from-time" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "month-from-date", "qname" : "datetime:month-from-date", "signature" : "($arg as date?) as integer?", "description" : " Returns the month component of a date.\n", "summary" : "
     Returns the month component of a date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the month component of the given date. 
       
    • month-from-date(date(\"1999-05-31-05:00\")) returns 5.
      •  
    • month-from-date(date(\"2000-01-01+05:00\")) returns 1.
      •  
     For a detailed description of the semantics of this function, please see month-from-date" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "month-from-dateTime", "qname" : "datetime:month-from-dateTime", "signature" : "($arg as dateTime?) as integer?", "description" : " Returns the month component of a dateTime.\n", "summary" : "
     Returns the month component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the month component of the given dateTime. 
       
    • month-from-dateTime(dateTime(\"1999-05-31T21:20:00-05:00\")) returns 5.
      •  
    • month-from-dateTime(dateTime(\"2000-01-01T11:05:00+05:00\")) returns 1.
      •  
     For a detailed description of the semantics of this function, please see month-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "months-from-duration", "qname" : "datetime:months-from-duration", "signature" : "($arg as duration?) as integer?", "description" : " Returns the number of months in a duration.\n", "summary" : "
     Returns the number of months in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the number of months in the given duration. 
       
    • months-from-duration(yearMonthDuration(\"P20Y15M\")) returns 3.
      •  
    • months-from-duration(yearMonthDuration(\"-P20Y18M\")) returns 6.
      •  
     For a detailed description of the semantics of this function, please see months-from-duration" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "seconds-from-dateTime", "qname" : "datetime:seconds-from-dateTime", "signature" : "($arg as dateTime?) as decimal?", "description" : " Returns the seconds component of a dateTime.\n", "summary" : "
     Returns the seconds component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "decimal?", "description" : "the seconds component of the given dateTime. 
       
    • seconds-from-dateTime(dateTime(\"1999-05-31T13:20:00-05:00\")) returns 0.
      •  
     For a detailed description of the semantics of this function, please see seconds-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "seconds-from-duration", "qname" : "datetime:seconds-from-duration", "signature" : "($arg as duration?) as decimal?", "description" : " Returns the number of seconds in a duration.\n", "summary" : "
     Returns the number of seconds in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "decimal?", "description" : "the number of seconds in the given duration. 
       
    • seconds-from-duration(dayTimeDuration(\"P3DT10H12.5S\")) returns 12.5.
      •  
    • seconds-from-duration(dayTimeDuration(\"-PT256S\")) returns -16.0.
      •  
     For a detailed description of the semantics of this function, please see seconds-from-duration" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "seconds-from-time", "qname" : "datetime:seconds-from-time", "signature" : "($arg as time?) as decimal?", "description" : " Returns the seconds component of a time.\n", "summary" : "
     Returns the seconds component of a time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "decimal?", "description" : "the seconds component of the given time. 
       
    • seconds-from-time(time(\"13:20:10.5\")) returns 10.5.
      •  
     For a detailed description of the semantics of this function, please see seconds-from-time" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-date", "qname" : "datetime:timezone-from-date", "signature" : "($arg as date?) as dayTimeDuration?", "description" : " Returns the timezone component of a date.\n", "summary" : "
     Returns the timezone component of a date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "dayTimeDuration?", "description" : "the timezone component of the given date. 
       
    • timezone-from-date(date(\"1999-05-31-05:00\")) returns dayTimeDuration(\"-PT5H\").
      •  
    • timezone-from-date(date(\"2000-06-12Z\")) returns dayTimeDuration(\"PT0S\").
      •  
     For a detailed description of the semantics of this function, please see timezone-from-date" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-dateTime", "qname" : "datetime:timezone-from-dateTime", "signature" : "($arg as dateTime?) as dayTimeDuration?", "description" : " Returns the timezone component of a dateTime.\n", "summary" : "
     Returns the timezone component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "dayTimeDuration?", "description" : "the timezone component of the given dateTime. 
       
    • timezone-from-dateTime(dateTime(\"1999-05-31T13:20:00-05:00\")) returns dayTimeDuration(\"-PT5H\").
      •  
    • timezone-from-dateTime(dateTime(\"2000-06-12T13:20:00Z\")) returns dayTimeDuration(\"PT0S\").
      •  
     For a detailed description of the semantics of this function, please see timezone-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-time", "qname" : "datetime:timezone-from-time", "signature" : "($arg as time?) as dayTimeDuration?", "description" : " Returns the timezone component of a time.\n", "summary" : "
     Returns the timezone component of a time.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "time", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "dayTimeDuration?", "description" : "the timezone component of the given time. 
       
    • timezone-from-time(time(\"13:20:00-05:00\")) returns dayTimeDuration(\"-PT5H\").
      •  
    • timezone-from-time(time(\"13:20:00\")) returns ().
      •  
     For a detailed description of the semantics of this function, please see timezone-from-time" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "year-from-date", "qname" : "datetime:year-from-date", "signature" : "($arg as date?) as integer?", "description" : " Returns the year component of a date.\n", "summary" : "
     Returns the year component of a date.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "date", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the year component of the given date. 
       
    • year-from-date(date(\"2000-01-01+05:00\")) returns 2000.
      •  
     For a detailed description of the semantics of this function, please see year-from-date" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "year-from-dateTime", "qname" : "datetime:year-from-dateTime", "signature" : "($arg as dateTime?) as integer?", "description" : " Returns the year component of a dateTime.\n", "summary" : "
     Returns the year component of a dateTime.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "dateTime", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the year component of the given dateTime. 
       
    • year-from-dateTime(dateTime(\"1999-05-31T13:20:00-05:00\")) returns 1999.
      •  
    • year-from-dateTime(dateTime(\"1999-12-31T24:00:00\")) returns 2000.
      •  
     For a detailed description of the semantics of this function, please see year-from-dateTime" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "years-from-duration", "qname" : "datetime:years-from-duration", "signature" : "($arg as duration?) as integer?", "description" : " Returns the number of years in a duration.\n", "summary" : "
     Returns the number of years in a duration.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "duration", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "integer?", "description" : "the number of years in the given duration. 
       
    • years-from-duration(yearMonthDuration(\"P20Y15M\")) returns 21.
      •  
    • years-from-duration(yearMonthDuration(\"-P15M\")) returns -1.
      •  
     For a detailed description of the semantics of this function, please see years-from-duration" }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/jdbc" : { "ns" : "http://api.28.io/jdbc", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/jdbc", "prefix" : "api" }, { "uri" : "http://www.28msec.com/modules/jdbc", "prefix" : "jdbc" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "res" }, { "uri" : "http://www.28msec.com/modules/store", "prefix" : "store" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : false, "arity" : 0, "name" : "dispatch", "qname" : "api:dispatch", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "import", "qname" : "api:import", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "tables", "qname" : "api:tables", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/excel/information" : { "ns" : "http://zorba.io/modules/excel/information", "description" : " This is a library module offering the same set of functions\n defined by Microsoft Excel, under Information Functions.\n", "sees" : [ "Excel Documentation: Information Functions" ], "authors" : [ "Sorin Nasoi" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/information", "prefix" : "excel-information" }, { "uri" : "http://zorba.io/modules/excel/math", "prefix" : "excel-math" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "is-blank", "qname" : "excel-information:is-blank", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Test if the passed argument is empty of not.\n", "summary" : "
     Test if the passed argument is empty of not.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "If the value of $arg is the empty sequence, the function returns true, otherwise the function returns false." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-even", "qname" : "excel-information:is-even", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Test is a number is even.\n", "summary" : "
     Test is a number is even.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if number is even, FALSE if number is odd." }, "errors" : [ "excel-err:Value if provided value is not a number." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-odd", "qname" : "excel-information:is-odd", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Test is a number is odd.\n", "summary" : "
     Test is a number is odd.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if number is odd, FALSE if number is even." }, "errors" : [ "excel-err:Value if provided value is not a number." ] }, { "isDocumented" : true, "arity" : 1, "name" : "islogical", "qname" : "excel-information:islogical", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Tests if the passed $value is a logical value.\n", "summary" : "
     Tests if the passed $value is a logical value.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if $value refers to a logical value." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "isnumber", "qname" : "excel-information:isnumber", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Tests if the passed $value is a number.\n", "summary" : "
     Tests if the passed $value is a number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if $value refers to a number." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "istext", "qname" : "excel-information:istext", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Tests if the passed $value is a string.\n", "summary" : "
     Tests if the passed $value is a string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if $value refers to text." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "n", "qname" : "excel-information:n", "signature" : "($value as xs:anyAtomicType?) as xs:anyAtomicType", "description" : " Converts a $value to a number.\n", "summary" : "
     Converts a $value to a number.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value.
    " } ], "returns" : { "type" : "xs:anyAtomicType", "description" : "A $value converted to a number." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "na", "qname" : "excel-information:na", "signature" : "() as xs:anyAtomicType", "description" : " Raises the error value #N/A.\n", "summary" : "
     Raises the error value #N/A.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyAtomicType", "description" : "The error value #N/A. #N/A is the error value that means \"no value is available.\"" }, "errors" : [ "excel-err:NA the purpose of this function is to raise this error" ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/image/animation" : { "ns" : "http://www.zorba-xquery.com/modules/image/animation", "description" : " This module provides functions to create animated GIF images.\n", "sees" : [  ], "authors" : [ "Daniel Thomas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.zorba-xquery.com/modules/image/animation", "prefix" : "anim" }, { "uri" : "http://www.zorba-xquery.com/modules/image/error", "prefix" : "ierr" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "create-animated-gif", "qname" : "anim:create-animated-gif", "signature" : "($images as xs:base64Binary+, $delay as xs:unsignedInt, $iterations as xs:unsignedInt) as xs:base64Binary external", "description" : " Creates an animated GIF image.\n The resulting animated GIF shows the passed images consecutively.\n It has the same width and height as the first passed image.\n", "summary" : "
     Creates an animated GIF image.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "images", "type" : "xs:base64Binary", "occurrence" : "+", "description" : "
     the image sequence
    " }, { "name" : "delay", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     the hundredths of seconds an image is shown
    " }, { "name" : "iterations", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     the amount of times all images are shown. 0 for infinite.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the animated GIF" }, "errors" : [ "ierr:IM001 one of the passed images is invalid." ] }, { "isDocumented" : true, "arity" : 4, "name" : "create-morphed-gif", "qname" : "anim:create-morphed-gif", "signature" : "($images as xs:base64Binary+, $delay as xs:unsignedInt, $iterations as xs:unsignedInt, $nr-of-morph-images as xs:unsignedInt) as xs:base64Binary external", "description" : " Creates an animated GIF image with morph effect.\n The resulting animated GIF shows the passed images consecutively with morph effect between the changes.\n It has the same width and height as the first passed image.\n", "summary" : "
     Creates an animated GIF image with morph effect.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "images", "type" : "xs:base64Binary", "occurrence" : "+", "description" : "
     the image sequence
    " }, { "name" : "delay", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     the hundredths of seconds an image is shown
    " }, { "name" : "iterations", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     the amount of times all images are shown. 0 for infinite.
    " }, { "name" : "nr-of-morph-images", "type" : "xs:unsignedInt", "occurrence" : null, "description" : "
     the number of additionally added images to create the morph effect between two passed images.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the animated GIF" }, "errors" : [ "ierr:IM001 one of the passed images is invalid." ] } ], "variables" : [  ] }, "http://28.io/modules/error" : { "ns" : "http://28.io/modules/error", "description" : " 
    Applications written with Sausalito use this default error module\n if an error happens inside a Sausalito project.
    \n 
    An error can occur during the run time of a Sausalito project on one\n of the following cases:
    \n 
      \n   
    1. If the XQuery code raises a dynamic error that is not caught in a\n     try-catch block.
      2. \n   
    2. If the given XQuery program is syntactically incorrect or contains\n     other static errors.
      3. \n   
    3. If an explicit call to fn:error() was made and the error is not\n     caught in a try-catch block.
      4. \n   
    4. If a request is made to a module or a function which does\n     not exist.
      5. \n   
    5. If any other unexpected error happens during the processing of\n     the request.
      6. \n 
    \n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://28.io/modules/error", "prefix" : "err" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "request" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "resp" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 4, "name" : "handle", "qname" : "err:handle", "signature" : "($code as xs:QName, $description as xs:string?, $value as item()*, $stack) as item()*", "description" : " 
    This is the default function that is called if an error happens.\n The default can be overridden by adding an error.xq library module\n into the Sausalito project. This module needs to declare a function\n with the same signature as the err:handle function in this module.
    \n 
    The value returned by this function is sent to the client. If the\n default is overridden, the implementation is free to define all\n parameters of the response (e.g. set the corresponding HTTP status\n code or an arbitrary header).
    \n 
    If the default is used, the status code is 500 if the $code QName\n is not equal to one of the status code QNames declared in HTTP module.\n Otherwise, the corresponding status code is set.
    \n", "summary" : "
      This is the default function that is called if an error happens.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "code", "type" : "xs:QName", "occurrence" : null, "description" : "
     the error code that triggered the problem as a QName
    " }, { "name" : "description", "type" : "xs:string", "occurrence" : "?", "description" : "
     a description of the error
    " }, { "name" : "value", "type" : "item()", "occurrence" : "*", "description" : "
     a potentially empty list of items that were involved in causing the error
    " }, { "name" : "stack", "type" : null, "occurrence" : null, "description" : "
     the stacktrace leading to the error as an element. For example,  <stack> <call ns=\"http://www.example.com/\" localName=\"my-function\" arity=\"3\"/> </stack> 
    " } ], "returns" : { "type" : "item()*", "description" : "content of the response message" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/internal-debug" : { "ns" : "http://www.zorba-xquery.com/modules/internal-debug", "description" : " This internal module provides functions for testing error handling and\n internal function caching.\n", "sees" : [  ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.zorba-xquery.com/modules/internal-debug", "prefix" : "debug" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "cpp-error", "qname" : "debug:cpp-error", "signature" : "() as empty-sequence() external", "description" : " Raises a c++ exception.\n", "summary" : "
     Raises a c++ exception.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "empty sequence" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "cpp-exit", "qname" : "debug:cpp-exit", "signature" : "() as empty-sequence() external", "description" : " C++ exit is invoked.\n", "summary" : "
     C++ exit is invoked.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "empty sequence" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "user-error-no-location", "qname" : "debug:user-error-no-location", "signature" : "() as empty-sequence() external", "description" : " Raises a user error without query location.\n", "summary" : "
     Raises a user error without query location.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "empty sequence" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "user-error", "qname" : "debug:user-error", "signature" : "() as empty-sequence() external", "description" : " Raises a user error.\n", "summary" : "
     Raises a user error.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "empty sequence" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "zorba-error", "qname" : "debug:zorba-error", "signature" : "() as empty-sequence() external", "description" : " Raises a zorba error.\n", "summary" : "
     Raises a zorba error.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "empty sequence" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/reflection" : { "ns" : "http://zorba.io/modules/reflection", "description" : " This module provides functions to dynamically invoke functions or main modules,\n respectively. Each of the functions (invoke or eval) come in four variants depending\n whether the expression being invoked is simple, nondeterministic, updating,\n or sequential.\n", "sees" : [  ], "authors" : [ "Nicolae Brinza" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/reflection", "prefix" : "reflection" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "eval-n", "qname" : "reflection:eval-n", "signature" : "($query as xs:string) as item()* external", "description" : " See documentation of reflection:eval() except the main module that is to\n be executed may be nondeterministc.\n", "summary" : "
     See documentation of reflection:eval() except the main module that is to\n be executed may be nondeterministc.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "xs:string", "occurrence" : null, "description" : "
     the query string to be evaluated
    " } ], "returns" : { "type" : "item()*", "description" : "the result of evaluating the query" }, "errors" : [ "whatever error the evaluated XQuery may return", "err:XQST0031 If the XQuery version of the inner program is greater than the version of the outer program." ] }, { "isDocumented" : true, "arity" : 1, "name" : "eval-s", "qname" : "reflection:eval-s", "signature" : "($query as xs:string) as item()* external", "description" : " See documentation of reflection:eval() except the main module that is to\n be executed may be sequential, i.e. may have side-effects.\n", "summary" : "
     See documentation of reflection:eval() except the main module that is to\n be executed may be sequential, i.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "xs:string", "occurrence" : null, "description" : "
     the query string to be evaluated
    " } ], "returns" : { "type" : "item()*", "description" : "the result of evaluating the query (the result is not supposed to contain any PUL)." }, "errors" : [ "whatever error the evaluated XQuery may return", "err:XQST0031 If the XQuery version of the inner program is greater than the version of the outer program." ] }, { "isDocumented" : true, "arity" : 1, "name" : "eval-u", "qname" : "reflection:eval-u", "signature" : "($query as xs:string) external", "description" : " See documentation of reflection:eval() except the main module that is to\n be executed may be updating, i.e. return a pending update list.\n", "summary" : "
     See documentation of reflection:eval() except the main module that is to\n be executed may be updating, i.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : true, "parameters" : [ { "name" : "query", "type" : "xs:string", "occurrence" : null, "description" : "
     the query string to be evaluated
    " } ], "returns" : { "type" : null, "description" : "the PUL resulting from evaluating the query" }, "errors" : [ "whatever error the evaluated XQuery may return", "err:XQST0031 If the XQuery version of the inner program is greater than the version of the outer program." ] }, { "isDocumented" : true, "arity" : 1, "name" : "eval", "qname" : "reflection:eval", "signature" : "($query as xs:string) as item()* external", "description" : " The purpose of this function is to (dynamically) execute an XQuery program\n from inside another XQuery program.
    \n The XQuery program that invokes the\n eval function will be referred to as the \"outer\" program and the XQuery\n program that is executed by the eval invocation will be referred to as\n the \"inner\" program. The function is given as a string argument.\n Typically, the outer program constructs this string dynamically,\n e.g., based on data extracted from documents and/or the values of\n external variables. The eval function treats this string as\n an XQuery main module. That is, it parses the string, compiles the\n resulting parse tree, executes the resulting execution plan, and finally\n returns the result or error (if any) to the outer program.
    \n The given XQuery program needs to be a valid according to XQuery's\n MainModule production (see \n http://www.w3.org/TR/xquery/#doc-xquery-MainModule. Please note\n that the inner pogram must at least have the XQuery version of the\n outer program [err:XQST0031].
    \n The inner program \"inherits\" the static and dynamic context of the outer\n program. Specifically, evaluation of the inner program is done in static and\n dynamic contextes that are initialized as copies of the static and dynamic\n contextes of the outer program at the place where the eval invocation appears\n at. This means that, for example, all variables that are in-scope at the place\n where the eval function is invoked from, are also in-scope inside the inner\n program and can be referenced there without having to be re-declared. On the other\n hand, declarations that appear in the prolog of the inner main module or are\n imported by the inner main module from library modules, hide their corresponding\n inherited declarations. For example, if the inner main module declares\n a variable or function with the same name as an inherited variable or function,\n the inner variable/function hides the inherited one.
    \n If the inner program declares an external variable with the same name as an\n inherited variable, the value of the inherited variable is used to initialize\n the inner external variable. If, however, an inner external variable has no\n default initializer and no corresponding inherited variable, it will remain\n uninitialized, causing the inner program to raise an error when executed.\n", "summary" : "
     The purpose of this function is to (dynamically) execute an XQuery program\n from inside another XQuery program.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query", "type" : "xs:string", "occurrence" : null, "description" : "
     the query string to be evaluated
    " } ], "returns" : { "type" : "item()*", "description" : "the result of evaluating the query" }, "errors" : [ "whatever error the evaluated XQuery may return.", "err:XQST0031 If the XQuery version of the inner program is greater than the version of the outer program." ] }, { "isDocumented" : true, "arity" : 1, "name" : "invoke-n", "qname" : "reflection:invoke-n", "signature" : "($name as xs:QName) as item()* external", "description" : " See documentation for reflection:invoke except the function that\n is to be invoked may be nondeterministic.\n", "summary" : "
     See documentation for reflection:invoke except the function that\n is to be invoked may be nondeterministic.
    ", "annotation_str" : " %an:nondeterministic %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" }, { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the QName of the function that is to be invoked
    " } ], "returns" : { "type" : "item()*", "description" : "the result that is returned by the invoked function" }, "errors" : [ "whatever error the invoked function may return" ] }, { "isDocumented" : true, "arity" : 1, "name" : "invoke-s", "qname" : "reflection:invoke-s", "signature" : "($name as xs:QName) as item()* external", "description" : " See documentation for reflection:invoke except the function that\n is to be invoked may be sequential, i.e. may have side-effects.\n", "summary" : "
     See documentation for reflection:invoke except the function that\n is to be invoked may be sequential, i.
    ", "annotation_str" : " %an:variadic %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" }, { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the QName of the function that is to be invoked
    " } ], "returns" : { "type" : "item()*", "description" : "the result that is returned by the invoked function" }, "errors" : [ "whatever error the invoked function may return" ] }, { "isDocumented" : true, "arity" : 1, "name" : "invoke-u", "qname" : "reflection:invoke-u", "signature" : "($name as xs:QName) external", "description" : " See documentation for reflection:invoke-n except the function that\n is to be invoked may be updating, i.e. return a pending update list.\n", "summary" : "
     See documentation for reflection:invoke-n except the function that\n is to be invoked may be updating, i.
    ", "annotation_str" : " %an:nondeterministic %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" }, { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the QName of the function that is to be invoked
    " } ], "returns" : { "type" : null, "description" : "the result that is returned by the invoked function" }, "errors" : [ "whatever error the invoked function may return" ] }, { "isDocumented" : true, "arity" : 1, "name" : "invoke", "qname" : "reflection:invoke", "signature" : "($name as xs:QName) as item()* external", "description" : " The invoke function allows to dynamically call a function given its QName\n and parameters.
    \n It is possible to invoke a function whose name is not known\n at compilation time -- it can be computed, passed through an external\n variable, taken from a file, etc. The first parameter must always be a\n QName identifying a known function.
    \n The function is declared with the %an:variadic annotation. Hence, it allows\n for an arbitrary number of parameters. All of these parameters (except the\n first one) will be passed to the function that is called.\n 
    \n Example usage : 
     reflection:invoke ( xs:QName(\"fn:max\"), (1,2,3) ) 
    \n 
    \n Returns 
     3 
    .\n", "summary" : "
     The invoke function allows to dynamically call a function given its QName\n and parameters.
    ", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the QName of the function that is to be invoked
    " } ], "returns" : { "type" : "item()*", "description" : "the result that is returned by the invoked function" }, "errors" : [ "whatever error the invoked function may return" ] } ], "variables" : [  ] }, "http://zorba.io/modules/hmac" : { "ns" : "http://zorba.io/modules/hmac", "description" : " This module provides functions that perform HMAC\n (hash-based message authentication code) operations.\n For example, they calculate message codes involving hash functions such\n as MD5 and various SHA variants. The result is the base64 encoded value\n of the hash. A hash may be used to verify the data integrity and\n the authenticity of a message.\n", "sees" : [  ], "authors" : [ "William Candillon, Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/hmac", "prefix" : "hmac" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "compute-binary", "qname" : "hmac:compute-binary", "signature" : "($message as xs:base64Binary, $secret-key as xs:string, $hash-algo as xs:string) as xs:base64Binary external", "description" : " Calculate the HMAC for the given message and secret-key involving\n an custom hash function. Before calculating the code, the given\n base64-encoded message is base64-decoded.\n", "summary" : "
     Calculate the HMAC for the given message and secret-key involving\n an custom hash function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " }, { "name" : "hash-algo", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:base64Binary", "description" : "the base64 encoded message authentication code" }, "errors" : [ "hash:UNSUPPORTED-ALGORITHM if the given hash algorithm is not supported" ] }, { "isDocumented" : true, "arity" : 3, "name" : "compute", "qname" : "hmac:compute", "signature" : "($message as xs:string, $secret-key as xs:string, $alg as xs:string) as xs:base64Binary external", "description" : " Calculate the HMAC for the given message and secret-key involving\n an custom hash function.\n", "summary" : "
     Calculate the HMAC for the given message and secret-key involving\n an custom hash function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:string", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " }, { "name" : "alg", "type" : "xs:string", "occurrence" : null, "description" : "
     The algorithm to use for the hashing operation. Supported algorithms are \"md5\", \"sha1\", and \"sha256\".
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the base64 encoded message authentication code" }, "errors" : [ "hash:UNSUPPORTED-ALGORITHM if the given hash algorithm is not supported" ] }, { "isDocumented" : true, "arity" : 2, "name" : "md5-binary", "qname" : "hmac:md5-binary", "signature" : "($message as xs:base64Binary, $secret-key as xs:string) as xs:base64Binary", "description" : " Calculate the HMAC for the given message and secret-key involving\n the MD5 hash function. Before calculating the code, the given\n base64-encoded message is base64-decoded.\n", "summary" : "
     Calculate the HMAC for the given message and secret-key involving\n the MD5 hash function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the base64 encoded message authentication code" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "md5", "qname" : "hmac:md5", "signature" : "($message as xs:string, $secret-key as xs:string) as xs:base64Binary", "description" : " Calculate the HMAC for the given message and secret-key involving\n the MD5 hash function.\n", "summary" : "
     Calculate the HMAC for the given message and secret-key involving\n the MD5 hash function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:string", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the base64 encoded message authentication code" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "sha1-binary", "qname" : "hmac:sha1-binary", "signature" : "($message as xs:base64Binary, $secret-key as xs:string) as xs:base64Binary", "description" : " Calculate the HMAC for the given message and secret-key involving\n the SHA1 hash function. Before calculating the code, the given\n base64-encoded message is base64-decoded.\n", "summary" : "
     Calculate the HMAC for the given message and secret-key involving\n the SHA1 hash function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the base64 encoded message authentication code" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "sha1", "qname" : "hmac:sha1", "signature" : "($message as xs:string, $secret-key as xs:string) as xs:base64Binary", "description" : " Calculate the HMAC for the given message and secret-key involving\n the SHA1 hash function.\n", "summary" : "
     Calculate the HMAC for the given message and secret-key involving\n the SHA1 hash function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:string", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the base64 encoded message authentication code" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/sleep" : { "ns" : "http://www.28msec.com/modules/sleep", "description" : " This module provides a function to put the currently executing request\n to sleep.\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/sleep", "prefix" : "sleep" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "millis", "qname" : "sleep:millis", "signature" : "($millis as xs:integer) as empty-sequence() external", "description" : " Puts the currently executing request to sleep.\n This function is mainly useful in development e.g. to simulate the\n effects of long-running tasks wrt. the concurrent execution of\n requests.\n Here the function is used to simulate a request that runs for 1 second\n 
    \n declare $acquired := lock:try-acquire(\"my-lock\");\n if ($acquired)\n   sleep:millis(1000);\n else\n   fn:error(xs:QName(\"...\"), \"failed to acquire lock\");\n 
    \n", "summary" : "
     Puts the currently executing request to sleep.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "millis", "type" : "xs:integer", "occurrence" : null, "description" : "
     the number of milliseconds to sleep
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/cloudant" : { "ns" : "http://www.28msec.com/modules/cloudant", "description" : " 
    This module provides functionality for creating, reading, updating,\n deleting and searching data in Cloudant\n databases.
    \n 
    Before issuing a request to Cloudant it is mandatory to create\n a new connection through one of the connect functions.\n These functions return a connection identifier which needs to be used\n to access data in Cloudant through the other functions.
    \n 
    In these functions Cloudant databases will be identified through\n their names. By default, the functions will assume that the database is owned by\n the user for which the given connection has been created.\n To specify a different database owner, most functions accept an\n $options parameter that allows a database-owner\n option to specify a different database owner for a single request.\n Moreover, when connecting, it is possible to specify the default\n database owner using the connect#3 function.
    \n 
    Additional information on the Cloudant APIs can be found\n on the Cloudant website.
    \n 
    Important Notice Regarding Function Determinism
    \n 
    The non side-effecting functions:\n 
    \n are declared deterministic, which means that their results could be cached\n when invoked multiple times with the same arguments in the same query execution.
    \n 
    To not use cached results you can use the following alternative functions:\n 
    \n which have been declared as being non deterministic.
    \n", "sees" : [  ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/cloudant", "prefix" : "cloudant" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/http-client", "prefix" : "http" }, { "uri" : "http://www.28msec.com/modules/maps", "prefix" : "map" }, { "uri" : "http://zorba.io/modules/random", "prefix" : "random" }, { "uri" : "http://www.zorba-xquery.com/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "all-documents-nondeterministic", "qname" : "cloudant:all-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string) as object()", "description" : " 
    Lists all the documents in a given database.
    \n 
    This function has the same semantics as\n all-documents#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Lists all the documents in a given database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 3, "name" : "all-documents-nondeterministic", "qname" : "cloudant:all-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $options as object()) as object()", "description" : " 
    Lists all the documents in a given database.
    \n 
    This function has the same semantics as\n all-documents#3,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Lists all the documents in a given database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 2, "name" : "all-documents", "qname" : "cloudant:all-documents", "signature" : "($connection as anyURI, $database as string) as object()", "description" : " 
    Lists all the documents in a given database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    For example,\n 
    cloudant:all-documents($connection, \"db\")
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\":3,\n   \"offset\":0,\n   \"rows\":[\n   {\n     \"id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"key\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"value\":\n     {\n       \"rev\":\"2-9d5401898196997853b5ac4163857a29\"\n     }\n   },\n   {\n     \"id\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"key\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"value\":\n     {\n       \"rev\":\"2-ff7b85665c4c297838963c80ecf481a3\"\n      }\n   },\n   {\n     \"id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"key\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"value\":\n     {\n       \"rev\":\"2-cbdef49ef3ddc127eff86350844a6108\"\n     }\n   }]\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision number.
      • \n  
    • total_rows: number of documents in the database.
      • \n  
    • update_seq: current update sequence database.
      • \n 
    \n 
    \n", "summary" : "
      Lists all the documents in a given database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 3, "name" : "all-documents", "qname" : "cloudant:all-documents", "signature" : "($connection as anyURI, $database as string, $options as object()) as object()", "description" : " 
    Lists all the documents in a given database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • descending: return the documents in descending by key order (boolean,\n   default: false).
      • \n   
    • endkey: stop returning records when the specified key is reached (string).
      • \n   
    • endkey_docid: stop returning records when the specified document ID is\n   reached (string).
      • \n   
    • group: group the results using the reduce function to a group or single\n   row (boolean, default: false).
      • \n   
    • group_level: specify the group level to be used (numeric).
      • \n   
    • include_docs: include the full content of the documents in the return\n   (boolean, default: false).
      • \n   
    • inclusive_end: specifies whether the specified end key should be included\n   in the result (boolean, default: true).
      • \n   
    • key: return only documents that match the specified key (string).
      • \n   
    • limit: limit the number of the returned documents to the specified number\n   (numeric).
      • \n   
    • reduce: use the reduction function (boolean, default: true).
      • \n   
    • skip: skip this number of records before starting to return the results\n   (numeric, default: 0).
      • \n   
    • stale: allow the results from a stale view to be used (string, allowed\n   value: \"ok\").
      • \n   
    • startkey: start returning records when the specified key is reached (string).
      • \n   
    • startkey_docid: start returning records when the specified document ID\n   is reached (string).
      • \n   
    • database-owner: specifies the database owner (string, default: connection\n   user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:all-documents($connection, \"db\", {\"database-owner\": \"username\"})
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\":3,\n   \"offset\":0,\n   \"rows\":[\n   {\n     \"id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"key\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"value\":\n     {\n       \"rev\":\"2-9d5401898196997853b5ac4163857a29\"\n     }\n   },\n   {\n     \"id\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"key\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"value\":\n     {\n       \"rev\":\"2-ff7b85665c4c297838963c80ecf481a3\"\n      }\n   },\n   {\n     \"id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"key\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"value\":\n     {\n       \"rev\":\"2-cbdef49ef3ddc127eff86350844a6108\"\n     }\n   }]\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision number.
      • \n  
    • total_rows: number of documents in the database.
      • \n  
    • update_seq: current update sequence database.
      • \n 
    \n 
    \n", "summary" : "
      Lists all the documents in a given database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 4, "name" : "all-view-documents-nondeterministic", "qname" : "cloudant:all-view-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string) as object()", "description" : " 
    Returns a JSON object describing all the documents in a given view.
    \n 
    This function has the same semantics as\n all-view-documents#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns a JSON object describing all the documents in a given view.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 5, "name" : "all-view-documents-nondeterministic", "qname" : "cloudant:all-view-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string, $options as object()) as object()", "description" : " 
    Returns a JSON object describing all the documents in a given view.
    \n 
    This function has the same semantics as\n all-view-documents#5,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns a JSON object describing all the documents in a given view.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 4, "name" : "all-view-documents", "qname" : "cloudant:all-view-documents", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string) as object()", "description" : " 
    Returns a JSON object describing all the documents in a given view.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    For example,\n 
    cloudant:all-view-documents($connection, \"db\", \"recipes\", \"by_title\")
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"offset\" : 0,\n   \"rows\" :\n   [\n     {\n       \"id\" : \"3-tiersalmonspinachandavocadoterrine\",\n       \"key\" : \"3-tier salmon, spinach and avocado terrine\",\n       \"value\" : [\"3-tier salmon, spinach and avocado terrine\"]\n     },\n     {\n       \"id\" : \"Aberffrawcake\",\n       \"key\" : \"Aberffraw cake\",\n       \"value\" : [\"Aberffraw cake\"]\n     },\n     {\n       \"id\" : \"Adukiandorangecasserole-microwave\",\n       \"key\" : \"Aduki and orange casserole - microwave\",\n       \"value\" : [\"Aduki and orange casserole - microwave\"]\n     }\n   ],\n   \"total_rows\" : 3\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision number.
      • \n  
    • total_rows: number of documents in the database.
      • \n 
    \n 
    \n", "summary" : "
      Returns a JSON object describing all the documents in a given view.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 5, "name" : "all-view-documents", "qname" : "cloudant:all-view-documents", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string, $options as object()) as object()", "description" : " 
    Returns a JSON object describing all the documents in a given view.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • descending: return the documents in descending by key order (boolean,\n   default: false)
      • \n   
    • endkey: stop returning records when the specified key is reached (string)
      • \n   
    • endkey_docid: stop returning records when the specified document ID is\n   reached (string)
      • \n   
    • group: group the results using the reduce function to a group or single\n   row (boolean, default: false)
      • \n   
    • group_level: specify the group level to be used (numeric)
      • \n   
    • include_docs: include the full content of the documents in the return\n   (boolean, default: false)
      • \n   
    • inclusive_end: specifies whether the specified end key should be included\n   in the result (boolean, default: true)
      • \n   
    • key: return only documents that match the specified key (string)
      • \n   
    • limit: limit the number of the returned documents to the specified number\n   (numeric)
      • \n   
    • reduce: use the reduction function (boolean, default: true)
      • \n   
    • skip: skip this number of records before starting to return the results\n   (numeric, default: 0)
      • \n   
    • stale: allow the results from a stale view to be used (string, allowed\n   value: \"ok\")
      • \n   
    • startkey: start returning records when the specified key is reached\n   (string)
      • \n   
    • startkey_docid: start returning records when the specified document ID\n   is reached (string)
      • \n   
    • database-owner: specifies the database owner (string, default:\n   connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:all-view-documents($connection, \"db\", \"recipes\", \"by_title\",\n   {\"database-owner\" : \"username\"})
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"offset\" : 0,\n   \"rows\" :\n   [\n     {\n       \"id\" : \"3-tiersalmonspinachandavocadoterrine\",\n       \"key\" : \"3-tier salmon, spinach and avocado terrine\",\n       \"value\" : [\"3-tier salmon, spinach and avocado terrine\"]\n     },\n     {\n       \"id\" : \"Aberffrawcake\",\n       \"key\" : \"Aberffraw cake\",\n       \"value\" : [\"Aberffraw cake\"]\n     },\n     {\n       \"id\" : \"Adukiandorangecasserole-microwave\",\n       \"key\" : \"Aduki and orange casserole - microwave\",\n       \"value\" : [\"Aduki and orange casserole - microwave\"]\n     }\n   ],\n   \"total_rows\" : 3\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision\n  number.
      • \n  
    • total_rows: number of documents in the database.
      • \n 
    \n 
    \n", "summary" : "
      Returns a JSON object describing all the documents in a given view.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 4, "name" : "attachment-nondeterministic", "qname" : "cloudant:attachment-nondeterministic", "signature" : "($connection as anyURI, $database as string, $document-id as string, $attachment-name as string) as object()", "description" : " 
    Retrieves the specified document attachment.
    \n 
    This function has the same semantics as\n attachment#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Retrieves the specified document attachment.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     An attchment name
    " } ], "returns" : { "type" : "object()", "description" : "The specified document attachment" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 5, "name" : "attachment-nondeterministic", "qname" : "cloudant:attachment-nondeterministic", "signature" : "($connection as anyURI, $database as string, $document-id as string, $attachment-name as string, $options as object()) as object()", "description" : " 
    Retrieves the specified document attachment.
    \n 
    This function has the same semantics as attachment#5,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Retrieves the specified document attachment.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     An attchment name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "The specified document attachment" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:ATTACHMENT-NOT-EXISTS Attachment does not exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 4, "name" : "attachment", "qname" : "cloudant:attachment", "signature" : "($connection as anyURI, $database as string, $document-id as string, $attachment-name as string) as object()", "description" : " 
    Retrieves the specified document attachment.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    For example,\n 
    cloudant:attachment($connection, \"db\", \"DocID\", \"Attachment\")
    .\n 
    \n 
    Retrieving a design document attachment.
    \n 
    To retrieve a design document attachment the document id must\n start with _design/.
    \n 
    For example,\n 
    cloudant:attachment($connection, \"db\", \"_design/DocID\", \"Attachment\")
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the media-type of the attachment as\n it was specified when the attachment was submitted to the database and\n its raw content.\n The format of the returned object is the following:\n 
    \n {\n   \"media-type\": \"text/plain\",\n   \"content\" : \"Hello World\"\n }\n 
    \n 
    \n 
    The type of the content field is determined by the media-type returned by the\n server. If the media-type indicates that the body content is textual,\n then the content has type string, base64Binary otherwise.\n Specifically, the body content is considered textual only if the MIME-type specified in\n the media-type is one of:\n 
      \n   
    • \"application/json\"
      • \n   
    • \"application/x-javascript\"
      • \n   
    • \"application/xml\"
      • \n   
    • \"application/xml-external-parsed-entity\"
      • \n 
    \n or if the MIME-type starts with \"text/\" or ends with \"+xml\".
    \n", "summary" : "
      Retrieves the specified document attachment.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     An attchment name
    " } ], "returns" : { "type" : "object()", "description" : "The specified document attachment" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 5, "name" : "attachment", "qname" : "cloudant:attachment", "signature" : "($connection as anyURI, $database as string, $document-id as string, $attachment-name as string, $options as object()) as object()", "description" : " 
    Retrieves the specified document attachment.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:attachment($connection, \"db\", \"DocID\", \"Attachment\",\n   {\"database-owner\": \"username\"})
    .\n 
    \n 
    Retrieving a design document attachment.
    \n 
    To retrieve a design document attachment the document id must\n start with _design/.
    \n 
    For example,\n 
    cloudant:attachment($connection, \"db\", \"_design/DocID\", \"Attachment\",\n   {\"database-owner\": \"username\"})
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the media-type of the attachment as\n it was specified when the attachment was submitted to the database and\n its raw content.\n The format of the returned object is the following:\n 
    \n {\n   \"media-type\": \"text/plain\",\n   \"content\" : \"Hello World\"\n }\n 
    \n 
    \n 
    The type of the content field is determined by the media-type returned by the\n server. If the media-type indicates that the body content is textual,\n then the content has type string, base64Binary otherwise.\n Specifically, the body content is considered textual only if the MIME-type specified in\n the media-type is one of:\n 
      \n   
    • \"application/json\"
      • \n   
    • \"application/x-javascript\"
      • \n   
    • \"application/xml\"
      • \n   
    • \"application/xml-external-parsed-entity\"
      • \n 
    \n or if the MIME-type starts with \"text/\" or ends with \"+xml\".
    \n", "summary" : "
      Retrieves the specified document attachment.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     An attchment name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "The specified document attachment" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:ATTACHMENT-NOT-EXISTS Attachment does not exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "bulk-crud", "qname" : "cloudant:bulk-crud", "signature" : "($connection as anyURI, $database as string, $documents as object()*) as array()", "description" : " 
    Creates, updates or deletes multiple documents with a single request.
    \n 
    When creating new documents the document ID is optional. For updating\n existing documents, you must provide the document ID, revision information,\n and new document values. To delete existing documents, you must provide the\n document ID, revision information and add a field _deleted having\n value true.\n 
    \n 
    For example,\n 
    cloudant:bulk-crud($connection, \"db\",\n (\n   {\n     \"name\":\"Nicholas\",\n     \"age\":45,\n     \"gender\":\"male\",\n   },\n   {\n     \"name\":\"Taylor\",\n     \"age\":50,\n     \"gender\":\"male\",\n     \"_id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n   },\n   {\n     \"name\":\"Owen\",\n     \"age\":51,\n     \"gender\":\"male\",\n     \"_id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"_rev\":\"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n   },\n   {\n     \"_id\":\"b675e932-9bb6-4fc9-b889-50238ac3512b\",\n     \"_rev\":\"2-abd3942fdab3515bfed224abed2451feb\",\n     \"_deleted\": true\n   }\n ))\n 
    \n requires to insert the first document with a system-generated identifier, to\n insert the second one with a user-specified identifier, to update the third\n one and, finally,to delete the last one.\n 
    \n 
    \n The JSON returned by the_bulk_docs operation consists of an array\n of JSON structures, one for each submitted document.\n The returned JSON structure should be examined to ensure that all of\n the documents submitted in the original request were successfully added\n to the database. When no errors are raised, the revision of the new\n document is reported for all documents.\n 
    \n 
    \n 
    \n [{\n    \"id\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n    \"rev\":\"2-ff7b85665c4c297838963c80ecf481a3\"\n  },\n  {\n    \"id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n    \"rev\":\"2-9d5401898196997853b5ac4163857a29\"\n  },\n  {\n    \"id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n    \"rev\":\"2-cbdef49ef3ddc127eff86350844a6108\"\n  },\n  {\n    \"id\": \"b675e932-9bb6-4fc9-b889-50238ac3512b\",\n    \"rev\":\"2-12356bafb1232167befabb32127823943d\"\n  }]\n 
    \n 
    \n 
    Cloudant will only guarantee that some of the documents will be\n saved when you send the request. The response will contain the list of\n documents successfully inserted or updated during the process.\n In the event of a crash, some of the documents may have been successfully\n saved, and some will have been lost.\n The response structure will indicate whether the document was updated by\n supplying the rev parameter indicating a new document revision\n was created. If the update failed, then you will get an error of type\n conflict.
    \n 
    For example:\n 
    \n [\n   {\n     \"id\":\"FishStew\",\n     \"error\":\"conflict\",\n     \"reason\":\"Document update conflict.\"\n   },\n   {\n     \"id\":\"LambStew\",\n     \"error\":\"conflict\",\n     \"reason\":\"Document update conflict.\"\n   },\n   {\n     \"id\":\"7f7638c86173eb440b8890839ff35433\",\n     \"error\":\"conflict\",\n     \"reason\":\"Document update conflict.\"\n   }\n ]\n 
    \n In this case no new revision has been created and you will need to submit\n the document update with the correct revision tag, to update the document.\n 
    \n 
    The exact structure of each document in the returned array is:\n 
      \n   
    • id: the document ID
      • \n   
    • rev: the new document revision, if a new revision was created
      • \n   
    • error: the error type, if an error was raised
      • \n   
    • reason: a description of the raised error, if an error was raised
      • \n 
    \n 
    \n 
    The error type can either be conflict or forbidden. The first type means that\n the document as submitted is in conflict. The new revision has not been created\n and you will need to re-submit the document to the database. Entries with forbidden\n error type indicate that the validation routine applied to the document during submission\n has returned an error.
    \n", "summary" : "
      Creates, updates or deletes multiple documents with a single request.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "documents", "type" : "object()", "occurrence" : "*", "description" : "
     An sequence of documents
    " } ], "returns" : { "type" : "array()", "description" : "An object describing the performed operations" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "bulk-crud", "qname" : "cloudant:bulk-crud", "signature" : "($connection as anyURI, $database as string, $documents as object()*, $options as object()) as array()", "description" : " 
    Creates, updates or deletes multiple documents with a single request.
    \n 
    When creating new documents the document ID is optional. For updating\n existing documents, you must provide the document ID, revision information,\n and new document values. To delete existing documents, you must provide the\n document ID, revision information and add a field _deleted having\n value true.\n 
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • all_or_nothing: sets the database commit mode to use all-or-nothing\n   semantics (boolean, default: false).
      • \n   
    • database-owner: specifies the database owner (string, default: connection\n   user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:bulk-crud($connection, \"db\",\n (\n   {\n     \"name\":\"Nicholas\",\n     \"age\":45,\n     \"gender\":\"male\",\n   },\n   {\n     \"name\":\"Taylor\",\n     \"age\":50,\n     \"gender\":\"male\",\n     \"_id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n   },\n   {\n     \"name\":\"Owen\",\n     \"age\":51,\n     \"gender\":\"male\",\n     \"_id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"_rev\":\"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n   },\n   {\n     \"_id\":\"b675e932-9bb6-4fc9-b889-50238ac3512b\",\n     \"_rev\":\"2-abd3942fdab3515bfed224abed2451feb\",\n     \"_deleted\": true\n   }\n ),{\"database-owner\": \"username\"})\n 
    \n requires to insert the first document with a system-generated identifier, to\n insert the second one with a user-specified identifier, to update the third\n one and, finally, to delete the last one.\n 
    \n 
    \n The JSON returned by the_bulk_docs operation consists of an array\n of JSON structures, one for each document in the original submission.\n The returned JSON structure should be examined to ensure that all of\n the documents submitted in the original request were successfully added\n to the database. When no errors are raised, the revision of the new\n document is reported for all documents.\n 
    \n 
    \n 
    \n [{\n    \"id\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n    \"rev\":\"2-ff7b85665c4c297838963c80ecf481a3\"\n  },\n  {\n    \"id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n    \"rev\":\"2-9d5401898196997853b5ac4163857a29\"\n  },\n  {\n    \"id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n    \"rev\":\"2-cbdef49ef3ddc127eff86350844a6108\"\n  },\n  {\n    \"id\": \"b675e932-9bb6-4fc9-b889-50238ac3512b\",\n    \"rev\":\"2-12356bafb1232167befabb32127823943d\"\n  }]\n 
    \n 
    \n 
    Cloudant will only guarantee that some of the documents will be\n saved when you send the request. The response will contain the list of\n documents successfully inserted or updated during the process.\n In the event of a crash, some of the documents may have been successfully\n saved, and some will have been lost.\n The response structure will indicate whether the document was updated by\n supplying the rev parameter indicating a new document revision\n was created. If the update failed, then you will get an error of type\n conflict.
    \n 
    For example:\n 
    \n [\n   {\n     \"id\":\"FishStew\",\n     \"error\":\"conflict\",\n     \"reason\":\"Document update conflict.\"\n   },\n   {\n     \"id\":\"LambStew\",\n     \"error\":\"conflict\",\n     \"reason\":\"Document update conflict.\"\n   },\n   {\n     \"id\":\"7f7638c86173eb440b8890839ff35433\",\n     \"error\":\"conflict\",\n     \"reason\":\"Document update conflict.\"\n   }\n ]\n 
    \n In this case no new revision has been created and you will need to submit\n the document update with the correct revision tag, to update the document.\n 
    \n 
    The exact structure of each document in the returned array is:\n 
      \n   
    • id: the document ID
      • \n   
    • rev: the new document revision, if a new revision was created
      • \n   
    • error: the error type, if an error was raised
      • \n   
    • reason: a description of the raised error, if an error was raised
      • \n 
    \n 
    \n 
    The error type can either be conflict or forbidden. The first type means that\n the document as submitted is in conflict. The new revision has not been created\n and you will need to re-submit the document to the database. Entries with forbidden\n error type indicate that the validation routine applied to the document during submission\n has returned an error.
    \n", "summary" : "
      Creates, updates or deletes multiple documents with a single request.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "documents", "type" : "object()", "occurrence" : "*", "description" : "
     An sequence of documents
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "array()", "description" : "An object describing the performed operations" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 2, "name" : "commit-changes", "qname" : "cloudant:commit-changes", "signature" : "($connection as anyURI, $database as string) as object()", "description" : " 
    Commits any recent changes to the specified database to disk.
    \n 
    For example,\n 
    cloudant:commit-changes($connection, \"db\")
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"ok\" : true,\n   \"instance_start_time\" : \"0\"\n }\n 
    \n 
    \n", "summary" : "
      Commits any recent changes to the specified database to disk.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "object()", "description" : "An object reporting the instance start time" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NOT-EXISTS The specified database does not exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 3, "name" : "commit-changes", "qname" : "cloudant:commit-changes", "signature" : "($connection as anyURI, $database as string, $options as object()) as object()", "description" : " 
    Commits any recent changes to the specified database to disk.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection\n   user).
      • \n 
    \n 
    \n 
    For example,\n 
    \n cloudant:commit-changes($connection, \"db\", {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"ok\" : true,\n   \"instance_start_time\" : \"0\"\n }\n 
    \n 
    \n", "summary" : "
      Commits any recent changes to the specified database to disk.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object reporting the instance start time" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NOT-EXISTS The specified database does not exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 0, "name" : "connect", "qname" : "cloudant:connect", "signature" : "() as anyURI", "description" : " 
    Opens a connection to Cloudant using the default credentials.
    \n 
    The function returns an opaque URI that can represents the connection.\n This URI has to be passed to other functions of this module that require\n a $connection parameter as a first argument.
    \n 
    This function requires to specify an options object.\n The following options are supported:\n 
      \n   
    • username: the username used for connecting (string, mandatory).
      • \n   
    • password: the password used for connecting (string, mandatory).
      • \n   
    • default-database-owner: the default database owner which will be\n       used when calling the other module functions (string).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:connect()
    .\n 
    \n", "summary" : "
      Opens a connection to Cloudant using the default credentials.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "anyURI", "description" : "An identifier that represents the connection to the server" }, "errors" : [ "cloudant:CREDENTIALS Missing or invalid credentials", "cloudant:AUTHORIZATION Authentication error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 1, "name" : "connect", "qname" : "cloudant:connect", "signature" : "($credentials as item()) as anyURI", "description" : " 
    Opens a connection to Cloudant using the specified credentials.
    \n 
    The function returns an opaque URI that can represents the connection.\n This URI has to be passed to other functions of this module that require\n a $connection parameter as a first argument.
    \n 
    The $credentials parameter is used to specify the connection information.\n If a string is used, then the function will interpret it as the name of\n a credential in the Cloudant category.\n If an object is used, then the function will open a connection using it.\n The object structure is the following:\n 
      \n   
    • username: the username used for connecting (string, mandatory).
      • \n   
    • password: the password used for connecting (string, mandatory).
      • \n   
    • default-database-owner: the default database owner which will be\n       used when calling the other module functions (string, optional).
      • \n 
    \n 
    \n 
    For example, using stored credential:\n 
    cloudant:connect(\"credentials-name\")
    \n For example, specifying the connection information:\n 
    cloudant:connect(\n   {\n     \"username\": \"user\",\n     \"password: \"pass\",\n     \"owner\": \"another-user\"\n   })
    .\n 
    \n", "summary" : "
      Opens a connection to Cloudant using the specified credentials.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "credentials", "type" : "item()", "occurrence" : null, "description" : "
     The connection specification
    " } ], "returns" : { "type" : "anyURI", "description" : "An identifier that represents the connection to the server" }, "errors" : [ "cloudant:AUTHORIZATION Authentication error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:INTERNAL Cloudant internal error", "cloudant:CREDENTIALS Missing or malformed credentials" ] }, { "isDocumented" : true, "arity" : 2, "name" : "create-database", "qname" : "cloudant:create-database", "signature" : "($connection as anyURI, $database as string) as empty-sequence()", "description" : " 
    Creates a new database.
    \n 
    The database name must be composed of one or more of the following\n characters:\n 
      \n  
    • Lowercase characters (a-z).
      • \n  
    • Digits (0-9).
      • \n  
    • Any of the characters: _,$,(,),+,- and /.
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:create-database($connection, \"db\")
    .\n 
    \n", "summary" : "
      Creates a new database.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "Empty sequence" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DATABASE-EXISTS Database already exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 3, "name" : "create-document", "qname" : "cloudant:create-document", "signature" : "($connection as anyURI, $database as string, $document as object()) as object()", "description" : " 
    Creates a new document in the specified database.
    \n 
    Creates a new document in the specified database,\n using the supplied JSON document structure. If the JSON\n structure includes the _id field, then the document will\n be created with the specified document ID. If the _id\n field is not specified, a new unique ID will be generated.
    \n 
    You can include one or more attachments with a given document\n by incorporating the attachment information within the JSON of\n the document. This provides a simpler alternative to loading\n documents with attachments than making a separate call.\n To do so add you can add the _attachments object\n field to the document. It can have one ore more fields, each\n defining a different attachment.\n The name of the field is the name of the attachment.\n Its value is an object containing the following fields:\n 
      \n  
    • content_type: MIME Content type string
      • \n  
    • data: File attachment content, Base64 encoded
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:create-document($connection, \"db\",\n   {\n     \"_id\" : \"FishStew\",\n     \"servings\" : 4,\n     \"subtitle\" : \"Delicious with fresh bread\",\n     \"title\" : \"Fish Stew\"\n     \"_attachments\" : {\n       \"styling.css\" : {\n       \"content-type\" : \"text/css\",\n       \"data\" : \"cCB7IGZvbnQtc2l6ZTogMTJwdDsgfQo=\"\n       }\n     }\n   })\n 
    \n creates a document with an attachment named styling.css.\n 
    \n 
    Creating a design document
    \n 
    To create a design document the _id field must be present and must\n start with _design/.
    \n 
    For example, the following expression creates a design document\n 
    cloudant:create-document($connection, \"db\",\n   {\n     \"_id\": \"_design/DesDocID\",\n     \"views\": {\n       \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n       }\n     },\n     \"indexes\": {\n       \"mysearch\" : {\n         \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n         \"index\": \"function(doc){ ... }\"\n       },\n     }\n   }, {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    Return value
    \n 
    The returned JSON object will report the new document revision\n and has the following form:\n 
    \n {\n   \"id\":\"64575eef70ab90a2b8d55fc09e00440d\",\n   \"ok\":true,\n   \"rev\":\"1-9c65296036141e575d32ba9c034dd3ee\"\n }\n 
    \n 
    \n", "summary" : "
      Creates a new document in the specified database.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document", "type" : "object()", "occurrence" : null, "description" : "
     A document
    " } ], "returns" : { "type" : "object()", "description" : "An object which contains the document id and revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DOCUMENT Document creation conflict", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "create-document", "qname" : "cloudant:create-document", "signature" : "($connection as anyURI, $database as string, $document as object(), $options as object()) as object()", "description" : " 
    Creates a new document in the specified database
    \n 
    Creates a new document in the specified database,\n using the supplied JSON document structure. If the JSON\n structure includes the _id field, then the document will\n be created with the specified document ID. If the _id\n field is not specified, a new unique ID will be generated.
    \n 
    You can include one or more attachments with a given document\n by incorporating the attachment information within the JSON of\n the document. This provides a simpler alternative to loading\n documents with attachments than making a separate call.\n To do so add you can add the _attachments object\n field to the document. It can have one ore more fields, each\n defining a different attachment.\n The name of the field is the name of the attachment.\n Its value is an object containing the following fields:\n 
      \n  
    • content_type: MIME Content type string
      • \n  
    • data: File attachment content, Base64 encoded
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:create-document($connection, \"db\",\n   {\n     \"_id\" : \"FishStew\",\n     \"servings\" : 4,\n     \"subtitle\" : \"Delicious with fresh bread\",\n     \"title\" : \"Fish Stew\"\n     \"_attachments\" : {\n       \"styling.css\" : {\n       \"content-type\" : \"text/css\",\n       \"data\" : \"cCB7IGZvbnQtc2l6ZTogMTJwdDsgfQo=\"\n       }\n     }\n   }, {\"database-owner\": \"username\"})\n 
    \n creates a document with an attachment named styling.css.\n 
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • batch: requires batch mode for insertions (string, allowed value: \"ok\")
      • \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    You can write documents to the database at a higher rate\n by using the batch option. This collects document writes\n together in memory (on a user-by-user basis) before they are\n committed to disk. This increases the risk of the documents\n not being stored in the event of a failure, since the documents\n are not written to disk immediately.
    \n 
    Creating a design document
    \n 
    To create a design document the _id field must be present and must\n start with _design/.
    \n 
    For example, the following expression creates a design document\n 
    cloudant:create-document($connection, \"db\",\n   {\n     \"_id\": \"_design/DesDocID\",\n     \"views\": {\n       \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n       }\n     },\n     \"indexes\": {\n       \"mysearch\" : {\n         \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n         \"index\": \"function(doc){ ... }\"\n       },\n     }\n   }, {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    Return value
    \n 
    The returned JSON object will report the new document revision\n and has the following form:\n 
    \n {\n   \"id\":\"64575eef70ab90a2b8d55fc09e00440d\",\n   \"ok\":true,\n   \"rev\":\"1-9c65296036141e575d32ba9c034dd3ee\"\n }\n 
    \n 
    \n", "summary" : "
      Creates a new document in the specified database \n  Creates a new document in the specified database,\n using the supplied JSON document structure.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document", "type" : "object()", "occurrence" : null, "description" : "
     A document
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object which contains the document id and revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DOCUMENT Document creation conflict", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 7, "name" : "create-or-update-attachment", "qname" : "cloudant:create-or-update-attachment", "signature" : "($connection as anyURI, $database as string, $document-id as string, $document-rev as string, $attachment-name as string, $media-type as string, $attachment as atomic) as object()", "description" : " 
    Creates or updates a document attachment.
    \n 
    The latest document revision must be specified.
    \n 
    For example,\n 
    cloudant:create-or-update-attachment($connection, \"db\", \"FishStew\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\", \"text/plain\",\n   \"AttachmentContent\")
    .\n 
    \n 
    Creating or updating a design document attachment.
    \n 
    To create or update a design document attachment the document id must\n start with _design/.
    \n 
    For example,\n 
    cloudant:create-or-update-attachment($connection, \"db\", \"_design/DesDocId\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\", \"text/plain\",\n   \"AttachmentContent\")
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the document id and its new\n revision, as follows:\n 
    \n {\n   \"id\":\"FishStew\",\n   \"ok\":true,\n   \"rev\":\"9-247bb19a41bfd9bfdaf5ee6e2e05be74\"\n }\n 
    \n 
    \n", "summary" : "
      Creates or updates a document attachment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "document-rev", "type" : "string", "occurrence" : null, "description" : "
     A document revision
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     The name of the attachment
    " }, { "name" : "media-type", "type" : "string", "occurrence" : null, "description" : "
     The media-type of the attachment
    " }, { "name" : "attachment", "type" : "atomic", "occurrence" : null, "description" : "
    -name The name of the attachment
    " } ], "returns" : { "type" : "object()", "description" : "An object containing the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:ATTACHMENT-TYPE Attachment type must be string, base64Binary or hexBinary", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 8, "name" : "create-or-update-attachment", "qname" : "cloudant:create-or-update-attachment", "signature" : "($connection as anyURI, $database as string, $document-id as string, $document-rev as string, $attachment-name as string, $media-type as string, $attachment as atomic, $options as object()) as object()", "description" : " 
    Creates or updates a document attachment.
    \n 
    The latest document revision must be specified.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:create-or-update-attachment($connection, \"db\", \"FishStew\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\", \"text/plain\",\n   \"AttachmentContent\", {\"database-owner\": \"username\"})
    .\n 
    \n 
    Creating or updating a design document attachment.
    \n 
    To create or update a design document attachment the document id must\n start with _design/.
    \n 
    For example,\n 
    cloudant:create-or-update-attachment($connection, \"db\", \"_design/DesDocId\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\", \"text/plain\",\n   \"AttachmentContent\", {\"database-owner\": \"username\"})
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the document id and its new\n revision, as follows:\n 
    \n {\n   \"id\":\"FishStew\",\n   \"ok\":true,\n   \"rev\":\"9-247bb19a41bfd9bfdaf5ee6e2e05be74\"\n }\n 
    \n 
    \n", "summary" : "
      Creates or updates a document attachment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "document-rev", "type" : "string", "occurrence" : null, "description" : "
     A document revision
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     The name of the attachment
    " }, { "name" : "media-type", "type" : "string", "occurrence" : null, "description" : "
     The media-type of the attachment
    " }, { "name" : "attachment", "type" : "atomic", "occurrence" : null, "description" : "
    -name The name of the attachment
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object containing the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:ATTACHMENT-TYPE Attachment type must be string, base64Binary or hexBinary", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "create-or-update-document", "qname" : "cloudant:create-or-update-document", "signature" : "($connection as anyURI, $database as string, $document as object()) as object()", "description" : " 
    Creates or updates a document.
    \n 
    When creating a new document, the _id field must\n be specified.
    \n 
    For example,\n 
    cloudant:create-or-update-document($connection, \"db\",\n   {\n     \"name\":\"Hannah\",\n     \"age\":120,\n     \"gender\":\"female\",\n     \"_id\":\"DocID\"\n   })
    .\n 
    \n 
    When updating a document, the _id and the\n _rev field, which contains the last document revision,\n must be specified.
    \n 
    For example,\n 
    cloudant:create-or-update-document($connection, \"db\",\n   {\n     \"name\":\"Hannah\",\n     \"age\":40,\n     \"gender\":\"female\",\n     \"_id\":\"DocID\",\n     \"_rev\":\"1-764b9b11845fd0b73cfa0e61acc74ecf\"\n   })
    .\n 
    \n 
    Creating or updating a design document
    \n 
    To create or update a design document the document id must\n start with _design/.
    \n 
    For example, the following expression creates a design document\n 
    cloudant:create-or-update-document($connection, \"db\",\n   {\n     \"_id\": \"_design/DesDocID\",\n     \"views\": {\n       \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n       }\n     },\n     \"indexes\": {\n       \"mysearch\" : {\n         \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n         \"index\": \"function(doc){ ... }\"\n       },\n     }\n   })\n 
    .\n 
    \n 
    For example, the following expression updates a design document\n 
    cloudant:create-or-update-document($connection, \"db\",\n   {\n     \"_id\": \"_design/DesDocID\",\n     \"_rev\": \"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n     \"views\": {\n       \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n       }\n     },\n     \"indexes\": {\n       \"mysearch\" : {\n         \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n         \"index\": \"function(doc){ ... }\"\n       },\n     }\n   })\n 
    .
    \n 
    \n The meaning of the fields in the design document is the following:\n 
      \n   
    • _id: document ID
      • \n   
    • _rev: document revision
      • \n   
    • views: object defining the views. Each field defines a different view.\n       The field name is the name of the view and has the following content:\n     
        \n       
      • map: view map function
        • \n       
      • reduce: view reduce function (optional)
        • \n     
      \n   
      • \n   
    • indexes: object defining the view indexes. Each field defines a different index.\n       The field name is the name of the index and has the following content:\n     
        \n       
      • analyzer: Name of the analyzer to be used or an object with the\n       following fields:\n         
          \n           
        • name: Name of the analyzer
          • \n           
        • stopwords: An array of stop words. Stop words are words that\n           should not be indexed.
          • \n         
        \n       
        • \n       
      • index: Function that handles the indexing
        • \n     
      \n   
      • \n 
    \n 
    \n 
    Return value
    \n 
    The format of the returned object is the following and contains\n the document id and revision.\n 
    \n {\n   \"ok\":true,\n   \"id\":\"DocID\",\n   \"rev\":\"1-764b9b11845fd0b73cfa0e61acc74ecf\"\n }\n 
    \n 
    \n", "summary" : "
      Creates or updates a document.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document", "type" : "object()", "occurrence" : null, "description" : "
     A document
    " } ], "returns" : { "type" : "object()", "description" : "An object which specifies the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:DOCUMENT-MALFORMED Malformed document object", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "create-or-update-document", "qname" : "cloudant:create-or-update-document", "signature" : "($connection as anyURI, $database as string, $document as object(), $options as object()) as object()", "description" : " 
    Creates or updates a document.
    \n 
    When creating a new document, the _id field must\n be specified.
    \n 
    For example,\n 
    cloudant:create-or-update-document($connection, \"db\", \"DocID\",\n   {\n     \"name\":\"Hannah\",\n     \"age\":120,\n     \"gender\":\"female\",\n     \"_id\":\"DocID\"\n   }, {\"database-owner\": \"username\"})
    .\n 
    \n 
    When updating a document, the _id and the\n _rev field, which contains the last document revision,\n must be specified.
    \n 
    For example,\n 
    cloudant:create-or-update-document($connection, \"db\", \"DocID\",\n   {\n     \"name\":\"Hannah\",\n     \"age\":40,\n     \"gender\":\"female\",\n     \"_id\":\"DocID\",\n     \"_rev\":\"1-764b9b11845fd0b73cfa0e61acc74ecf\"\n   }, {\"database-owner\": \"username\"})
    .\n 
    \n 
    Creating or updating a design document
    \n 
    To create or update a design document the document id must\n start with _design/.
    \n 
    For example, the following expression creates a design document\n 
    cloudant:create-or-update-document($connection, \"db\",\n   {\n     \"_id\": \"_design/DesDocID\",\n     \"views\": {\n       \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n       }\n     },\n     \"indexes\": {\n       \"mysearch\" : {\n         \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n         \"index\": \"function(doc){ ... }\"\n       },\n     }\n   }, {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    cloudant:create-or-update-document($connection, \"db\",\n   {\n     \"_id\": \"_design/DesDocID\",\n     \"_rev\": \"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n     \"views\": {\n       \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n       }\n     },\n     \"indexes\": {\n       \"mysearch\" : {\n         \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n         \"index\": \"function(doc){ ... }\"\n       },\n     }\n   }, {\"database-owner\": \"username\"})\n 
    .\n 
    \n The meaning of the fields in the design document is the following:\n 
      \n   
    • _id: document ID
      • \n   
    • _rev: document revision
      • \n   
    • views: object defining the views. Each field defines a different view.\n       The field name is the name of the view and has the following content:\n     
        \n       
      • map: view map function
        • \n       
      • reduce: view reduce function (optional)
        • \n     
      \n   
      • \n   
    • indexes: object defining the view indexes. Each field defines a different index.\n       The field name is the name of the index and has the following content:\n     
        \n       
      • analyzer: Name of the analyzer to be used or an object with the\n       following fields:\n         
          \n           
        • name: Name of the analyzer
          • \n           
        • stopwords: An array of stop words. Stop words are words that\n           should not be indexed.
          • \n         
        \n       
        • \n       
      • index: Function that handles the indexing
        • \n     
      \n   
      • \n 
    \n 
    \n 
    Return value
    \n 
    The format of the returned object is the following and contains\n the document id and revision.\n 
    \n {\n   \"ok\":true,\n   \"id\":\"DocID\",\n   \"rev\":\"1-764b9b11845fd0b73cfa0e61acc74ecf\"\n }\n 
    \n 
    \n", "summary" : "
      Creates or updates a document.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document", "type" : "object()", "occurrence" : null, "description" : "
     A document
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object which specifies the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:DOCUMENT-MALFORMED Malformed document object", "cloudant:OPTIONS Malformed options object", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 2, "name" : "database-info-nondeterministic", "qname" : "cloudant:database-info-nondeterministic", "signature" : "($connection as anyURI, $database as string) as object()", "description" : " 
    Returns information about a database.
    \n 
    This function has the same semantics as database-info#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns information about a database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "object()", "description" : "An object describing the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 3, "name" : "database-info-nondeterministic", "qname" : "cloudant:database-info-nondeterministic", "signature" : "($connection as anyURI, $database as string, $options as object()) as object()", "description" : " 
    Returns information about a database.
    \n 
    This function has the same semantics as\n database-info#3,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns information about a database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     a database name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object describing the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 2, "name" : "database-info", "qname" : "cloudant:database-info", "signature" : "($connection as anyURI, $database as string) as object()", "description" : " 
    Returns information about a database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    For example,\n 
    cloudant:database-info($connection, \"db\")
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"update_seq\": \"0-g1AAAADneJzLYWBg...\",\n   \"db_name\": \"db\",\n   \"purge_seq\": 0,\n   \"other\": {\n     \"data_size\": 0\n   },\n   \"doc_del_count\": 0,\n   \"doc_count\": 0,\n   \"disk_size\": 316,\n   \"disk_format_version\": 5,\n   \"compact_running\": false,\n   \"instance_start_time\": \"0\"\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • compact_running: set to true if the database compaction routine is\n  operating on this database.
      • \n  
    • db_name: the name of the database.
      • \n  
    • disk_format_version: the version of the physical format used for the data\n  when it is stored on disk.
      • \n  
    • disk_size: size in bytes of the data as stored on the disk. Views indexes\n  are not included in the calculation.
      • \n  
    • doc_count: a count of the documents in the specified database.
      • \n  
    • doc_del_count: number of deleted documents.
      • \n  
    • instance_start_time: always 0.
      • \n  
    • purge_seq: the number of purge operations on the database.
      • \n  
    • update_seq: the current number of updates to the database.
      • \n  
    • other: JSON object containing a data_size field.
      • \n 
    \n 
    \n", "summary" : "
      Returns information about a database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "object()", "description" : "An object describing the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 3, "name" : "database-info", "qname" : "cloudant:database-info", "signature" : "($connection as anyURI, $database as string, $options as object()) as object()", "description" : " 
    Returns information about a database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:database-info($connection, \"db\", {\"database-owner\": \"username\"})
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"update_seq\": \"0-g1AAAADneJzLYWBg...\",\n   \"db_name\": \"db\",\n   \"purge_seq\": 0,\n   \"other\": {\n     \"data_size\": 0\n   },\n   \"doc_del_count\": 0,\n   \"doc_count\": 0,\n   \"disk_size\": 316,\n   \"disk_format_version\": 5,\n   \"compact_running\": false,\n   \"instance_start_time\": \"0\"\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • compact_running: set to true if the database compaction routine is\n  operating on this database.
      • \n  
    • db_name: the name of the database.
      • \n  
    • disk_format_version: the version of the physical format used for the data\n  when it is stored on disk.
      • \n  
    • disk_size: size in bytes of the data as stored on the disk. Views indexes\n  are not included in the calculation.
      • \n  
    • doc_count: a count of the documents in the specified database.
      • \n  
    • doc_del_count: number of deleted documents.
      • \n  
    • instance_start_time: always 0.
      • \n  
    • purge_seq: the number of purge operations on the database.
      • \n  
    • update_seq: the current number of updates to the database.
      • \n  
    • other: JSON object containing a data_size field.
      • \n 
    \n 
    \n", "summary" : "
      Returns information about a database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     a database name
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object describing the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 5, "name" : "delete-attachment", "qname" : "cloudant:delete-attachment", "signature" : "($connection as anyURI, $database as string, $document-id as string, $document-rev as string, $attachment-name as string) as object()", "description" : " 
    Deletes the specified attachment.
    \n 
    The latest document revision must be specified.
    \n 
    For example,\n 
    cloudant:delete-attachment($connection, \"db\", \"FishStew\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\")
    .\n 
    \n 
    Deleting a design document attachment.
    \n 
    To delete a design document attachment the document id must\n start with _design/.
    \n 
    For example,\n 
    cloudant:delete-attachment($connection, \"db\", \"_design/DesDocId\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\",\n   \"AttachmentName\", \"text/plain\", \"AttachmentContent\")
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the document id and its new\n revision, as follows:\n 
    \n {\n   \"id\":\"FishStew\",\n   \"ok\":true,\n   \"rev\":\"9-247bb19a41bfd9bfdaf5ee6e2e05be74\"\n }\n 
    \n 
    \n", "summary" : "
      Deletes the specified attachment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "document-rev", "type" : "string", "occurrence" : null, "description" : "
     A document revision
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     The name of the attachment
    " } ], "returns" : { "type" : "object()", "description" : "An object containing the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:ATTACHMENT-NOT-EXISTS Attachment does not exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:ATTACHMENT-TYPE Attachment type must be string, base64Binary or hexBinary", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 6, "name" : "delete-attachment", "qname" : "cloudant:delete-attachment", "signature" : "($connection as anyURI, $database as string, $document-id as string, $document-rev as string, $attachment-name as string, $options as object()) as object()", "description" : " 
    Deletes the specified attachment.
    \n 
    The latest document revision must be specified.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:delete-attachment($connection, \"db\", \"FishStew\",\n \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\",\n {\"database-owner\": \"username\"})
    .\n 
    \n 
    Deleting a design document attachment.
    \n 
    To delete a design document attachment the document id must\n start with _design/.
    \n 
    For example,\n 
    cloudant:delete-attachment($connection, \"db\", \"_design/DesDocId\",\n   \"8-7c4740b4dcf26683e941d6641c00c39d\", \"AttachmentName\", \"text/plain\",\n   \"AttachmentContent\", {\"database-owner\": \"username\"})
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the document id and its new\n revision, as follows:\n 
    \n {\n   \"id\":\"FishStew\",\n   \"ok\":true,\n   \"rev\":\"9-247bb19a41bfd9bfdaf5ee6e2e05be74\"\n }\n 
    \n 
    \n", "summary" : "
      Deletes the specified attachment.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "document-rev", "type" : "string", "occurrence" : null, "description" : "
     A document revision
    " }, { "name" : "attachment-name", "type" : "string", "occurrence" : null, "description" : "
     The name of the attachment
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object containing the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:ATTACHMENT-NOT-EXISTS Attachment does not exists", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:ATTACHMENT-TYPE Attachment type must be string, base64Binary or hexBinary", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete-database", "qname" : "cloudant:delete-database", "signature" : "($connection as anyURI, $database as string) as empty-sequence()", "description" : " 
    Deletes a database and all the documents and attachments contained in it.
    \n 
    The database name must be composed of one or more of the following characters:\n 
      \n  
    • Lowercase characters (a-z).
      • \n  
    • Digits (0-9).
      • \n  
    • Any of the characters: _,$,(,),+,- and /.
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:delete-database($connection, \"db\")
    .\n 
    \n", "summary" : "
      Deletes a database and all the documents and attachments contained in it.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "Empty sequence" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DATABASE-NOT-EXISTS Database does not exist", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "delete-document", "qname" : "cloudant:delete-document", "signature" : "($connection as anyURI, $database as string, $document-id as string, $document-rev as string) as object()", "description" : " 
    Deletes the specified document from a database.
    \n 
    The latest document revision must be specified.
    \n 
    For example,\n 
    \n cloudant:delete-document($connection, \"db\", \"DocID\", \"3-7c4740b4dcf26683e941d6641c00c39d\")\n 
    .\n 
    \n 
    Deleting a design document
    \n 
    To delete a design document the document id must\n start with _design/.
    \n 
    For example,\n 
    \n cloudant:delete-document($connection, \"db\", \"_design/DesDocID\", \"3-7c4740b4dcf26683e941d6641c00c39d\")\n 
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the document id and its\n new revision, as follows:\n 
    \n {\n   \"id\":\"DocID\",\n   \"ok\":true,\n   \"rev\":\"4-2719fd41187c60762ff584761b714cfb\"\n }\n 
    \n 
    \n", "summary" : "
      Deletes the specified document from a database.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "document-rev", "type" : "string", "occurrence" : null, "description" : "
     A document revision
    " } ], "returns" : { "type" : "object()", "description" : "An object which specifies the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:REVISION Specified revision is missing, invalid or not the latest.", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 5, "name" : "delete-document", "qname" : "cloudant:delete-document", "signature" : "($connection as anyURI, $database as string, $document-id as string, $document-rev as string, $options as object()) as object()", "description" : " 
    Deletes the specified document from a database.
    \n 
    The latest document revision must be specified.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    \n cloudant:delete-document($connection, \"db\", \"DocID\", \"3-7c4740b4dcf26683e941d6641c00c39d\",\n   {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    Deleting a design document
    \n 
    To delete a design document the document id must\n start with _design/.
    \n 
    For example,\n 
    \n cloudant:delete-document($connection, \"db\", \"_design/DesDocID\", \"3-7c4740b4dcf26683e941d6641c00c39d\",\n   {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    Return value
    \n 
    The returned object reports the document id and its\n new revision, as follows:\n 
    \n {\n   \"id\":\"DocID\",\n   \"ok\":true,\n   \"rev\":\"4-2719fd41187c60762ff584761b714cfb\"\n }\n 
    \n 
    \n", "summary" : "
      Deletes the specified document from a database.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "document-rev", "type" : "string", "occurrence" : null, "description" : "
     A document revision
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object which specifies the document id and its new revision" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:REVISION Specified revision is missing, invalid or not the latest.", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "document-info-nondeterministic", "qname" : "cloudant:document-info-nondeterministic", "signature" : "($connection as anyURI, $database as string, $document-id as string) as object()", "description" : " 
    Returns the latest revision and size for a given document.
    \n 
    This function has the same semantics as\n document-info#3,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns the latest revision and size for a given document.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " } ], "returns" : { "type" : "object()", "description" : "An object specifying the document id, revision and size" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "document-info-nondeterministic", "qname" : "cloudant:document-info-nondeterministic", "signature" : "($connection as anyURI, $database as string, $document-id as string, $options as object()) as object()", "description" : " 
    Returns the latest revision and size for a given document.
    \n 
    This function has the same semantics as\n document-info#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns the latest revision and size for a given document.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object specifying the document id, revision and size" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "document-info", "qname" : "cloudant:document-info", "signature" : "($connection as anyURI, $database as string, $document-id as string) as object()", "description" : " 
    Returns the latest revision and size for a given document.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    For example,\n 
    cloudant:document-info($connection, \"db\", \"DocID\")
    .\n 
    \n 
    The format of the returned object is the following and contains\n the document id, latest revision and size.\n 
    \n {\n   \"ok\": true,\n   \"id\": \"DocID\",\n   \"rev\": \"1-764b9b11845fd0b73cfa0e61acc74ecf\",\n   \"size\": 500\n }\n 
    \n 
    \n 
    Returning the latest revision and size for a given design document
    \n 
    To return the latest revision and size of a design document the document\n id must start with\n _design/.
    \n 
    For example,\n 
    cloudant:document-info($connection, \"db\", \"_design/DesDocID\")
    .\n 
    \n", "summary" : "
      Returns the latest revision and size for a given document.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " } ], "returns" : { "type" : "object()", "description" : "An object specifying the document id, revision and size" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "document-info", "qname" : "cloudant:document-info", "signature" : "($connection as anyURI, $database as string, $document-id as string, $options as object()) as object()", "description" : " 
    Returns the latest revision and size for a given document.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    \n cloudant:document-info($connection, \"db\", \"DocID\", {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    The format of the returned object is the following and contains\n the document id, latest revision and size.\n 
    \n {\n   \"ok\": true,\n   \"id\": \"DocID\",\n   \"rev\": \"1-764b9b11845fd0b73cfa0e61acc74ecf\",\n   \"size\": 500\n }\n 
    \n 
    \n 
    Returning the latest revision and size for a given design document
    \n 
    To return the latest revision and size of a design document the document\n id must start with _design/.
    \n 
    For example,\n 
    \n cloudant:document-info($connection, \"db\", \"_design/DesDocID\", {\"database-owner\": \"username\"})\n 
    .\n 
    \n", "summary" : "
      Returns the latest revision and size for a given document.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object specifying the document id, revision and size" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "document-nondeterministic", "qname" : "cloudant:document-nondeterministic", "signature" : "($connection as anyURI, $database as string, $document-id as string) as object()", "description" : " 
    Retrieves a document from the specified database.
    \n 
    This function has the same semantics as document#3,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Retrieves a document from the specified database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " } ], "returns" : { "type" : "object()", "description" : "The specified document" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "document-nondeterministic", "qname" : "cloudant:document-nondeterministic", "signature" : "($connection as anyURI, $database as string, $document-id as string, $options as object()) as object()", "description" : " 
    Retrieves a document from the specified database
    \n 
    This function has the same semantics as document#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Retrieves a document from the specified database \n  This function has the same semantics as  document#4 ,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "The specified document" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "document", "qname" : "cloudant:document", "signature" : "($connection as anyURI, $database as string, $document-id as string) as object()", "description" : " 
    Retrieves a document from the specified database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The latest revision of the document will be returned.
    \n 
    If the document includes attachments, then the\n returned structure will contain a summary of the\n attachments associated with the document, but not the\n attachment data itself.
    \n 
    For example,\n 
    cloudant:document($connection, \"db\", \"DocID\")
    .\n 
    \n 
    The returned JSON object will contain the document\n and has the following format:\n 
    \n {\n   \"_id\": \"DocID\",\n   \"_rev\": \"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n   \"name\": \"Anna\",\n   \"age\": 89,\n   \"gender\": \"female\",\n   \"_attachments\": {\n     \"my attachment\": {\n       \"content_type\": \"application/json; charset=UTF-8\",\n       \"revpos\": 2,\n       \"digest\": \"md5-37IZysiyWLRWx31J/1WQHw==\",\n       \"length\": 12,\n       \"stub\": true\n       }\n     }\n   }\n 
    \n 
    \n 
    \n The meaning of the fields in the returned object is the following:\n 
      \n   
    • _id: document ID
      • \n   
    • _rev: document revision
      • \n   
    • attachments: document attachments (optional), each field denotes the name\n       of a different attachment\n     
        \n       
      • content_type: attachment MIME Content type string
        • \n       
      • length: attachment length in bytes
        • \n       
      • revpos: revision where this attachment exists
        • \n       
      • digest: MD5 checksum of the attachment
        • \n       
      • stub: indicates whether the attachment is a stub
        • \n    
      \n  
      • \n 
    \n 
    \n 
    Retrieving a design document from the specified database
    \n 
    To retrieve a design document the document id must start with\n _design/.
    \n 
    For example,\n 
    cloudant:document($connection, \"db\", \"_design/DesDocID\")
    .\n 
    \n 
    A JSON object with the following format is returned:\n 
    \n {\n  \"_id\": \"_design/DesDocID\",\n   \"views\": {\n     \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n     }\n   },\n   \"indexes\": {\n     \"mysearch\" : {\n       \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n       \"index\": \"function(doc){ ... }\"\n     },\n   }\n }\n 
    \n 
    \n 
    \n The meaning of the fields in the returned object is the following:\n 
      \n   
    • _id: document ID
      • \n   
    • _rev: document revision
      • \n   
    • views: object defining the views. Each field defines a different view.\n       The field name is the name of the view and has the following content:\n     
        \n       
      • map: view map function
        • \n       
      • reduce: view reduce function (optional)
        • \n     
      \n   
      • \n   
    • indexes: object defining the view indexes. Each field defines a different index.\n       The field name is the name of the index and has the following content:\n     
        \n       
      • analyzer: Name of the analyzer to be used or an object with the\n       following fields:\n         
          \n           
        • name: Name of the analyzer
          • \n           
        • stopwords: An array of stop words. Stop words are words that\n           should not be indexed.
          • \n         
        \n       
        • \n       
      • index: Function that handles the indexing
        • \n     
      \n   
      • \n 
    \n 
    \n", "summary" : "
      Retrieves a document from the specified database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " } ], "returns" : { "type" : "object()", "description" : "The specified document" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "document", "qname" : "cloudant:document", "signature" : "($connection as anyURI, $database as string, $document-id as string, $options as object()) as object()", "description" : " 
    Retrieves a document from the specified database
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    Unless you request a specific revision, the latest\n revision of the document will always be returned.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • conflict: returns the conflict tree for the document (boolean)
      • \n   
    • rev: specifies the revision to return (string)
      • \n   
    • revs: return a list of the revisions for the document (boolean)
      • \n   
    • revs_info: return a list of detailed revision information for the document\n   (boolean, allowed value: true)
      • \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    If the document includes attachments, then the\n returned structure will contain a summary of the\n attachments associated with the document, but not the\n attachment data itself.
    \n 
    For example,\n 
    \n cloudant:document($connection, \"db\", \"DocID\", {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    The returned JSON object will contain the document\n and has the following format:\n 
    \n {\n   \"_id\": \"DocID\",\n   \"_rev\": \"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n   \"name\": \"Anna\",\n   \"age\": 89,\n   \"gender\": \"female\",\n   \"_attachments\": {\n     \"my attachment\": {\n       \"content_type\": \"application/json; charset=UTF-8\",\n       \"revpos\": 2,\n       \"digest\": \"md5-37IZysiyWLRWx31J/1WQHw==\",\n       \"length\": 12,\n       \"stub\": true\n       }\n     }\n   }\n 
    \n 
    \n 
    \n The meaning of the fields in the returned object is the following:\n 
      \n   
    • _id: document ID
      • \n   
    • _rev: document revision
      • \n   
    • attachments: document attachments (optional), each field denotes the name\n       of a different attachment:\n   
        \n     
      • content_type: attachment MIME Content type string
        • \n     
      • length: attachment length in bytes
        • \n     
      • revpos: revision where this attachment exists
        • \n     
      • digest: MD5 checksum of the attachment
        • \n     
      • stub: indicates whether the attachment is a stub
        • \n  
      \n  
      • \n 
    \n 
    \n 
    Retrieving a design document from the specified database
    \n 
    To retrieve a design document the document id must start with\n _design/.
    \n 
    For example,\n 
    cloudant:document($connection, \"db\", \"_design/DesDocID\", {\"database-owner\": \"username\"})
    .\n 
    \n 
    A JSON object with the following format is returned:\n 
    \n {\n  \"_id\": \"_design/DesDocID\",\n  \"_rev\": \"2-f29c836d0bedc4b4b95cfaa6d99e95df\",\n   \"views\": {\n     \"view1\": {\n       \"map\":\"function(doc){emit(doc.field, 1)}\",\n       \"reduce\": \"function(key, value, rereduce){return sum(values)}\"\n     }\n   },\n   \"indexes\": {\n     \"mysearch\" : {\n       \"analyzer\": {\"name\": \"portuguese\", \"stopwords\":[\"foo\", \"bar, \"baz\"]},\n       \"index\": \"function(doc){ ... }\"\n     },\n   }\n }\n 
    \n 
    \n 
    \n The meaning of the fields in the returned object is the following:\n 
      \n   
    • _id: document ID
      • \n   
    • _rev: document revision
      • \n   
    • views: object defining the views. Each field defines a different view.\n       The field name is the name of the view and has the following content:\n     
        \n       
      • map: view map function
        • \n       
      • reduce: view reduce function (optional)
        • \n     
      \n   
      • \n   
    • indexes: object defining the view indexes. Each field defines a different index.\n       The field name is the name of the index and has the following content:\n     
        \n       
      • analyzer: Name of the analyzer to be used or an object with the\n       following fields:\n         
          \n           
        • name: Name of the analyzer
          • \n           
        • stopwords: An array of stop words. Stop words are words that\n           should not be indexed.
          • \n         
        \n       
        • \n       
      • index: Function that handles the indexing
        • \n     
      \n   
      • \n 
    \n 
    \n 
    Getting a List of Revisions
    \n 
    You can obtain a list of the revisions for a given document\n by the revs option.
    \n 
    For example,\n 
    cloudant:document($connection, \"db\", \"DocID\", {\"revs\": true})
    .\n 
    \n 
    The returned JSON object includes the original document and\n a _revisions structure that includes the revision\n information:\n 
    \n {\n   \"servings\":4,\n   \"subtitle\":\"Delicious with a green salad\",\n   \"_id\":\"FishStew\",\n   \"title\":\"Irish Fish Stew\",\n   \"_revisions\":\n   {\n     \"ids\": [\n       \"a1a9b39ee3cc39181b796a69cb48521c\",\n       \"7c4740b4dcf26683e941d6641c00c39d\",\n       \"9c65296036141e575d32ba9c034dd3ee\"\n      ],\n     \"start\":3\n  },\n  \"_rev\":\"3-a1a9b39ee3cc39181b796a69cb48521c\"\n }\n 
    \n 
    \n 
    The meaning of the additional fields is the following:\n 
      \n   
    • _revisions: document revisions
      • \n   
    • _ids: array of valid revision IDs, in reverse order (latest first)
      • \n   
    • start: prefix number for the latest revision
      • \n 
    \n 
    \n 
    Obtaining an Extended Revision History
    \n 
    You can get additional information about the revisions for a given document\n with the revs_info option.
    \n 
    For example,\n 
    cloudant:document($connection, \"db\", \"DocID\", {\"revs_info\": true})
    .\n 
    \n 
    This returns extended revision information, including the availability and status\n of each revision:\n 
    \n {\n   \"servings\":4,\n   \"subtitle\":\"Delicious with a green salad\",\n   \"_id\":\"FishStew\",\n   \"_revs_info\":[\n     {\n       \"status\":\"available\",\n       \"rev\":\"3-a1a9b39ee3cc39181b796a69cb48521c\"\n     },\n     {\n       \"status\":\"available\",\n       \"rev\":\"2-7c4740b4dcf26683e941d6641c00c39d\"\n     },\n     {\n       \"status\":\"available\",\n       \"rev\":\"1-9c65296036141e575d32ba9c034dd3ee\"\n     }\n   ],\n   \"title\":\"Irish Fish Stew\",\n   \"_rev\":\"3-a1a9b39ee3cc39181b796a69cb48521c\"\n }\n 
    \n 
    \n 
    The meaning of the additional fields is the following:\n 
      \n   
    • _revs_info: document extended revision info
      • \n   
    • rev: revision ID
      • \n   
    • status: revision status
      • \n 
    \n 
    \n", "summary" : "
      Retrieves a document from the specified database \n  This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "document-id", "type" : "string", "occurrence" : null, "description" : "
     A document identifier
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "The specified document" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:DATABASE-NAME Invalid database name", "cloudant:DOCUMENT The specified document or revision cannot be found", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 1, "name" : "list-databases-nondeterministic", "qname" : "cloudant:list-databases-nondeterministic", "signature" : "($connection as anyURI) as array()", "description" : " 
    Returns an array containing the names of all the user's databases.
    \n 
    This function has the same semantics as\n list-databases#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns an array containing the names of all the user's databases.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " } ], "returns" : { "type" : "array()", "description" : "An array of all the database names" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-databases-nondeterministic", "qname" : "cloudant:list-databases-nondeterministic", "signature" : "($connection as anyURI, $options as object()) as array()", "description" : " 
    Returns an array containing the names of all the user's databases.
    \n 
    This function has the same semantics as\n list-databases#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Returns an array containing the names of all the user's databases.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "array()", "description" : "An array of all the databases names" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 1, "name" : "list-databases", "qname" : "cloudant:list-databases", "signature" : "($connection as anyURI) as array()", "description" : " 
    Returns an array containing the names of all the user's databases.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    For example,\n 
    cloudant:list-databases($connection)
    .\n 
    \n", "summary" : "
      Returns an array containing the names of all the user's databases.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " } ], "returns" : { "type" : "array()", "description" : "An array of all the database names" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 2, "name" : "list-databases", "qname" : "cloudant:list-databases", "signature" : "($connection as anyURI, $options as object()) as array()", "description" : " 
    Returns an array containing the names of all the user's databases.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • database-owner: specifies the database owner (string, default: connection user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:list-databases($connection, {\"database-owner\" : \"username\"})
    .\n 
    \n", "summary" : "
      Returns an array containing the names of all the user's databases.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "array()", "description" : "An array of all the databases names" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 5, "name" : "lucene-query-nondeterministic", "qname" : "cloudant:lucene-query-nondeterministic", "signature" : "($connection as anyURI, $database as string, $design-document as string, $index as string, $query as string) as object()", "description" : " 
    Executes a Lucene query against a view and returns the query result.
    \n 
    This function has the same semantics as\n lucene-query#5,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Executes a Lucene query against a view and returns the query result.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "index", "type" : "string", "occurrence" : null, "description" : "
     An index name
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A Lucene query
    " } ], "returns" : { "type" : "object()", "description" : "The Lucene query results" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 6, "name" : "lucene-query-nondeterministic", "qname" : "cloudant:lucene-query-nondeterministic", "signature" : "($connection as anyURI, $database as string, $design-document as string, $index as string, $query as string, $options as object()) as object()", "description" : " 
    Executes a Lucene query against a view and returns the query result.
    \n 
    This function has the same semantics as lucene-query#6,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Executes a Lucene query against a view and returns the query result.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "index", "type" : "string", "occurrence" : null, "description" : "
     An index name
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A Lucene query
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "The Lucene query results" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 5, "name" : "lucene-query", "qname" : "cloudant:lucene-query", "signature" : "($connection as anyURI, $database as string, $design-document as string, $index as string, $query as string) as object()", "description" : " 
    Executes a Lucene query against a view and returns the query result.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    This method searches for documents whose index fields match the Lucene query.\n Which fields of a document are indexed and how is determined by the index functions\n in the design document.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    For example,\n 
    cloudant:lucene-query($connection, \"db\", \"designdoc\", \"view\", \"a*\")
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\": 3,\n   \"bookmark\": \"g1AAAACWeJzLYWBgYMpgTmFQSElKzi9KdUhJMtbLTS3KLElMT9VLzskvTUnMK9HLSy3JAalMcgCSSfX____PAvPdQHwQSGTIIt6UPBaQlgNA6j_CJPsPcJOyANNEKzY\",\n   \"rows\":\n   [\n     {\n       \"id\": \"dd828eb4-c3f1-470f-aeff-c375ef70e4ad\",\n       \"order\": [0.0, 1],\n       \"fields\":\n       {\n         \"default\": \"aa\",\n         \"foo\": 0.0\n       }\n     },\n     {\n       \"id\": \"ea522cf1-eb8e-4477-aa92-d1fa459bb216\",\n       \"order\": [1.0, 0],\n       \"fields\":\n       {\n         \"default\": \"ab\",\n         \"foo\": 1.0\n       }\n     },\n     {\n       \"id\": \"c838baed-d573-43ea-9c34-621cf0f13301\",\n       \"order\": [2.0, 0],\n       \"fields\":\n       {\n         \"default\": \"ac\",\n         \"foo\": 2.0\n       }\n     }\n   ]\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • total_rows: number of results returned.
      • \n  
    • bookmark: string to be submitted in the next query to page through results.\n      If this response contained no results, the bookmark will be the same as the\n      one used to obtain this response.
      • \n  
    • rows: array of document objects, each document contains the following fields:\n    
        \n      
      • order: specifies the order with regard to the indexed fields.
        • \n      
      • fields: Object containing other search indexes.
        • \n    
      \n  
      • \n 
    \n 
    \n", "summary" : "
      Executes a Lucene query against a view and returns the query result.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "index", "type" : "string", "occurrence" : null, "description" : "
     An index name
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A Lucene query
    " } ], "returns" : { "type" : "object()", "description" : "The Lucene query results" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 6, "name" : "lucene-query", "qname" : "cloudant:lucene-query", "signature" : "($connection as anyURI, $database as string, $design-document as string, $index as string, $query as string, $options as object()) as object()", "description" : " 
    Executes a Lucene query against a view and returns the query result.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    This method searches for documents whose index fields match the Lucene query.\n Which fields of a document are indexed and how is determined by the index functions\n in the design document.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • bookmark: A bookmark that was received from a previous search. This\n   allows you to page through the results. If there are no more results after\n   the bookmark, you will get a response with an empty rows array and the\n   same bookmark. That way you can determine that you have reached the end\n   of the result list (string).
      • \n   
    • stale: allow the results from a stale view to be used (string, allowed\n   value: \"ok\").
      • \n   
    • limit: limit the number of the returned documents to the specified\n   number (numeric).
      • \n   
    • include_docs: include the full content of the documents in the return\n   (boolean, default: false).
      • \n   
    • sort: specifies the sort order of the results. A JSON string of the\n   form \"fieldname<type>\" or -fieldname<type>\n   for descending order, where fieldname is the name of a string or number field\n   and type is either number or string. The type part is optional and defaults\n   to number. Some examples are \"foo\", \"-foo\",\n   \"bar<string>\", \"-foo<number>\". String\n   fields used for sorting must not be analyzed fields. The field(s) used for\n   sorting must be indexed by the same indexer used for the search query.\n   Alternatively, a JSON array of such strings is allowed.
      • \n 
    \n 
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    For example,\n 
    cloudant:lucene-query($connection, \"db\", \"designdoc\", \"view\", \"a*\",\n {\"database-owner\": \"username\"})
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\": 3,\n   \"bookmark\": \"g1AAAACWeJzLYWBgYMpgTmFQSElKzi9KdUhJMtbLTS3KLElMT9VLzskvTUnMK9HLSy3JAalMcgCSSfX____PAvPdQHwQSGTIIt6UPBaQlgNA6j_CJPsPcJOyANNEKzY\",\n   \"rows\":\n   [\n     {\n       \"id\": \"dd828eb4-c3f1-470f-aeff-c375ef70e4ad\",\n       \"order\": [0.0, 1],\n       \"fields\":\n       {\n         \"default\": \"aa\",\n         \"foo\": 0.0\n       }\n     },\n     {\n       \"id\": \"ea522cf1-eb8e-4477-aa92-d1fa459bb216\",\n       \"order\": [1.0, 0],\n       \"fields\":\n       {\n         \"default\": \"ab\",\n         \"foo\": 1.0\n       }\n     },\n     {\n       \"id\": \"c838baed-d573-43ea-9c34-621cf0f13301\",\n       \"order\": [2.0, 0],\n       \"fields\":\n       {\n         \"default\": \"ac\",\n         \"foo\": 2.0\n       }\n     }\n   ]\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • total_rows: number of results returned.
      • \n  
    • bookmark: string to be submitted in the next query to page through results.\n      If this response contained no results, the bookmark will be the same as the\n      one used to obtain this response.
      • \n  
    • rows: array of document objects, each document contains the following fields:\n    
        \n      
      • order: specifies the order with regard to the indexed fields.
        • \n      
      • fields: Object containing other search indexes.
        • \n    
      \n  
      • \n 
    \n 
    \n", "summary" : "
      Executes a Lucene query against a view and returns the query result.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "index", "type" : "string", "occurrence" : null, "description" : "
     An index name
    " }, { "name" : "query", "type" : "string", "occurrence" : null, "description" : "
     A Lucene query
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "The Lucene query results" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "multiple-documents-nondeterministic", "qname" : "cloudant:multiple-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $keys as string*) as object()", "description" : " 
    List the specified documents in a given database.
    \n 
    This function has the same semantics as\n multiple-documents#3,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      List the specified documents in a given database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the specified documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "multiple-documents-nondeterministic", "qname" : "cloudant:multiple-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $keys as string*, $options as object()) as object()", "description" : " 
    Lists the specified documents in a given database.
    \n 
    This function has the same semantics as\n multiple-documents#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Lists the specified documents in a given database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the specified documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 3, "name" : "multiple-documents", "qname" : "cloudant:multiple-documents", "signature" : "($connection as anyURI, $database as string, $keys as string*) as object()", "description" : " 
    List the specified documents in a given database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    For example,\n 
    cloudant:multiple-documents($connection, \"db\",\n   (\"5a049246-179f-42ad-87ac-8f080426c17c\",\n    \"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n    \"96f898f0-f6ff-4a9b-aac4-503992f31b01\"))
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\":3,\n   \"offset\":0,\n   \"rows\":[\n   {\n     \"id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"key\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"value\":\n     {\n       \"rev\":\"2-9d5401898196997853b5ac4163857a29\"\n     }\n   },\n   {\n     \"id\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"key\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"value\":\n     {\n       \"rev\":\"2-ff7b85665c4c297838963c80ecf481a3\"\n      }\n   },\n   {\n     \"id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"key\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"value\":\n     {\n       \"rev\":\"2-cbdef49ef3ddc127eff86350844a6108\"\n     }\n   }]\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision number.
      • \n  
    • total_rows: number of documents in the database.
      • \n  
    • update_seq: current update sequence database.
      • \n 
    \n 
    \n", "summary" : "
      List the specified documents in a given database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the specified documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 4, "name" : "multiple-documents", "qname" : "cloudant:multiple-documents", "signature" : "($connection as anyURI, $database as string, $keys as string*, $options as object()) as object()", "description" : " 
    Lists the specified documents in a given database.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • descending: return the documents in descending by key order (boolean,\n   default: false).
      • \n   
    • endkey: stop returning records when the specified key is reached (string).
      • \n   
    • endkey_docid: stop returning records when the specified document ID is\n   reached (string).
      • \n   
    • group: group the results using the reduce function to a group or single\n   row (boolean, default: false).
      • \n   
    • group_level: specify the group level to be used (numeric).
      • \n   
    • include_docs: include the full content of the documents in the return\n   (boolean, default: false).
      • \n   
    • inclusive_end: specifies whether the specified end key should be included\n   in the result (boolean, default: true).
      • \n   
    • key: return only documents that match the specified key (string).
      • \n   
    • limit: limit the number of the returned documents to the specified number\n   (numeric).
      • \n   
    • reduce: use the reduction function (boolean, default: true).
      • \n   
    • skip: skip this number of records before starting to return the results\n   (numeric, default: 0).
      • \n   
    • stale: allow the results from a stale view to be used (string, allowed\n   value: \"ok\").
      • \n   
    • startkey: start returning records when the specified key is reached\n   (string).
      • \n   
    • startkey_docid: start returning records when the specified document ID\n   is reached (string).
      • \n   
    • database-owner: specifies the database owner (string, default: connection\n   user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:multiple-documents($connection, \"db\",\n   (\"5a049246-179f-42ad-87ac-8f080426c17c\",\n    \"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n    \"96f898f0-f6ff-4a9b-aac4-503992f31b01\"),\n   {\"database-owner\": \"username\"})
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\":3,\n   \"offset\":0,\n   \"rows\":[\n   {\n     \"id\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"key\":\"5a049246-179f-42ad-87ac-8f080426c17c\",\n     \"value\":\n     {\n       \"rev\":\"2-9d5401898196997853b5ac4163857a29\"\n     }\n   },\n   {\n     \"id\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"key\":\"96f898f0-f6ff-4a9b-aac4-503992f31b01\",\n     \"value\":\n     {\n       \"rev\":\"2-ff7b85665c4c297838963c80ecf481a3\"\n      }\n   },\n   {\n     \"id\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"key\":\"d1f61e66-7708-4da6-aa05-7cbc33b44b7e\",\n     \"value\":\n     {\n       \"rev\":\"2-cbdef49ef3ddc127eff86350844a6108\"\n     }\n   }]\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision number.
      • \n  
    • total_rows: number of documents in the database.
      • \n  
    • update_seq: current update sequence database.
      • \n 
    \n 
    \n", "summary" : "
      Lists the specified documents in a given database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing the specified documents in the specified database" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 5, "name" : "multiple-view-documents-nondeterministic", "qname" : "cloudant:multiple-view-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string, $keys as string*) as object()", "description" : " 
    List the specified documents in a given view.
    \n 
    This function has the same semantics as\n multiple-view-documents#5,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      List the specified documents in a given view.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all the specified documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 6, "name" : "multiple-view-documents-nondeterministic", "qname" : "cloudant:multiple-view-documents-nondeterministic", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string, $keys as string*, $options as object()) as object()", "description" : " 
    Lists the specified documents in a given view.
    \n 
    This function has the same semantics as\n multiple-view-documents#6,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
      Lists the specified documents in a given view.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all the specified documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] }, { "isDocumented" : true, "arity" : 5, "name" : "multiple-view-documents", "qname" : "cloudant:multiple-view-documents", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string, $keys as string*) as object()", "description" : " 
    List the specified documents in a given view.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    For example,\n 
    cloudant:multiple-view-documents($connection, \"db\", \"recipes\", \"by_ingredient\",\n (\"claret\", \"clear apple juice\"))\n 
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\" : 26484,\n   \"rows\" : [\n     {\n       \"value\" : [\"Scotch collops\"]],\n       \"id\" : \"Scotchcollops\",\n       \"key\" : \"claret\"\n     },\n     {\n       \"value\" : [\"Stand pie\"],\n       \"id\" : \"Standpie\",\n       \"key\" : \"clear apple juice\"\n     }\n   ],\n   \"offset\" : 6324\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision\n  number.
      • \n  
    • total_rows: number of documents in the database.
      • \n  
    • update_seq: current update sequence database.
      • \n 
    \n 
    \n", "summary" : "
      List the specified documents in a given view.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all the specified documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error" ] }, { "isDocumented" : true, "arity" : 6, "name" : "multiple-view-documents", "qname" : "cloudant:multiple-view-documents", "signature" : "($connection as anyURI, $database as string, $design-document as string, $view as string, $keys as string*, $options as object()) as object()", "description" : " 
    Lists the specified documents in a given view.
    \n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The information is returned as a JSON structure containing meta information\n about the return structure, and the list of documents each with its ID, revision\n and key. The key is generated from the document ID.
    \n 
    This function allows to specify an additional options object.\n The following options are supported:\n 
      \n   
    • descending: return the documents in descending by key order (boolean,\n   default: false).
      • \n   
    • endkey: stop returning records when the specified key is reached (string).
      • \n   
    • endkey_docid: stop returning records when the specified document ID is\n   reached (string).
      • \n   
    • group: group the results using the reduce function to a group or single\n   row (boolean, default: false).
      • \n   
    • group_level: specify the group level to be used (numeric).
      • \n   
    • include_docs: include the full content of the documents in the return\n   (boolean, default: false).
      • \n   
    • inclusive_end: specifies whether the specified end key should be included\n   in the result (boolean, default: true).
      • \n   
    • key: return only documents that match the specified key (string).
      • \n   
    • limit: limit the number of the returned documents to the specified number\n   (numeric).
      • \n   
    • reduce: use the reduction function (boolean, default: true).
      • \n   
    • skip: skip this number of records before starting to return the results\n   (numeric, default: 0).
      • \n   
    • stale: allow the results from a stale view to be used (string, allowed\n   value: \"ok\").
      • \n   
    • startkey: start returning records when the specified key is reached\n   (string).
      • \n   
    • startkey_docid: start returning records when the specified document ID\n   is reached (string).
      • \n   
    • database-owner: specifies the database owner (string, default: connection\n   user).
      • \n 
    \n 
    \n 
    For example,\n 
    cloudant:multiple-view-documents($connection, \"db\", \"recipes\",\n   \"by_ingredient\", (\"claret\", \"clear apple juice\"),\n   {\"database-owner\": \"username\"})\n 
    .\n 
    \n 
    An object with the following format is returned:\n 
    \n {\n   \"total_rows\" : 26484,\n   \"rows\" : [\n     {\n       \"value\" : [\"Scotch collops\"]],\n       \"id\" : \"Scotchcollops\",\n       \"key\" : \"claret\"\n     },\n     {\n       \"value\" : [\"Stand pie\"],\n       \"id\" : \"Standpie\",\n       \"key\" : \"clear apple juice\"\n     }\n   ],\n   \"offset\" : 6324\n }\n 
    \n 
    \n 
    The fields have the following meaning:\n 
      \n  
    • offset: offset where the document list started.
      • \n  
    • rows: array of document objects, each containing id, key and revision number.
      • \n  
    • total_rows: number of documents in the database.
      • \n  
    • update_seq: current update sequence database.
      • \n 
    \n 
    \n", "summary" : "
      Lists the specified documents in a given view.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection", "type" : "anyURI", "occurrence" : null, "description" : "
     A connection identifier
    " }, { "name" : "database", "type" : "string", "occurrence" : null, "description" : "
     A database name
    " }, { "name" : "design-document", "type" : "string", "occurrence" : null, "description" : "
     A design document name
    " }, { "name" : "view", "type" : "string", "occurrence" : null, "description" : "
     A view name
    " }, { "name" : "keys", "type" : "string", "occurrence" : "*", "description" : "
     The keys of the documents which must be retrieved
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     An object specifying additional request options
    " } ], "returns" : { "type" : "object()", "description" : "An object listing all the specified documents in the specified view" }, "errors" : [ "cloudant:AUTHORIZATION Authorization error", "cloudant:HTTP An HTTP error occurred when issuing the request", "cloudant:RESPONSE An error occurred parsing the server response", "cloudant:CONNECTION The specified connection does not exist", "cloudant:INTERNAL Cloudant internal error", "cloudant:OPTIONS Malformed options object" ] } ], "variables" : [  ] }, "http://api.28.io/exportimport" : { "ns" : "http://api.28.io/exportimport", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/collections", "prefix" : "cm" }, { "uri" : "http://api.28.io/exportimport", "prefix" : "exportimport" }, { "uri" : "http://zorba.io/modules/fetch", "prefix" : "fetch" }, { "uri" : "http://api.28.io/indices", "prefix" : "in" }, { "uri" : "http://www.28msec.com/modules/maps", "prefix" : "map" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "resp" }, { "uri" : "http://www.28msec.com/modules/store", "prefix" : "store" }, { "uri" : "http://api.28.io/validation", "prefix" : "validate" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "create-map", "qname" : "exportimport:create-map", "signature" : "($map as object())", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "map", "type" : "object()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "export", "qname" : "exportimport:export", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "import", "qname" : "exportimport:import", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "import", "qname" : "exportimport:import", "signature" : "($import as object(), $overwrite as xs:boolean)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "import", "type" : "object()", "occurrence" : null, "description" : "" }, { "name" : "overwrite", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "is-system-collection", "qname" : "exportimport:is-system-collection", "signature" : "($name as xs:string) as xs:boolean", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "validate-map", "qname" : "exportimport:validate-map", "signature" : "($map as object()) as empty-sequence()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "map", "type" : "object()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "empty-sequence()", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://jsoniq.org/errors" : { "ns" : "http://jsoniq.org/errors", "description" : " This module contains one variable declaration for each diagnostic of the\n http://jsoniq.org/errors namespace.\n The variables serves as documentation for the errors but can also\n be used in the code. For example, one useful scenario is to compare\n an error caught in the catch clause of a try-catch expression with one of\n the variables.\n", "sees" : [  ], "authors" : [ "Carlos Lopez" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://jsoniq.org/errors", "prefix" : "jerr" } ], "functions" : [  ], "variables" : [ { "name" : "jerr:JNSE0013", "type" : "xs:QName", "description" : "It is a dynamic error to serialize an atomic value not\n supported by JSON or a node with the JSON output method and with\n the jsoniq-serialization-extensions serialization parameter\n set to false.\n" }, { "name" : "jerr:JNDY0021", "type" : "xs:QName", "description" : "parser error raised by jn:parse-json\n" }, { "name" : "jerr:JNTY0021", "type" : "xs:QName", "description" : "array or object selector on heterogeneous sequence\n" }, { "name" : "jerr:JNTY0020", "type" : "xs:QName", "description" : "parser error for invalid option type\n" }, { "name" : "jerr:JNTY0024", "type" : "xs:QName", "description" : "objects or arrays don't have a string value\n" }, { "name" : "jerr:JNTY0023", "type" : "xs:QName", "description" : "It is a type error if the prefix is not a string or if the\n serialization parameters are not an element.\n" }, { "name" : "jerr:JNUP0019", "type" : "xs:QName", "description" : "It is a dynamic error if the content expression, in an object insert expression, does not evaluate to a sequence of objects.\n" }, { "name" : "jerr:JNTY0018", "type" : "xs:QName", "description" : "It is a dynamic error if there is not exactly one supplied parameter for an object or array selector.\n" }, { "name" : "jerr:JNUP0017", "type" : "xs:QName", "description" : " It is a dynamic error if the value in a replace expression is not exactly a single item.\n" }, { "name" : "jerr:JNUP0016", "type" : "xs:QName", "description" : "It is a dynamic error if it is attempted to create a replace, delete or rename update primitive with a selector that cannot be resolved against the target array or object.\n" }, { "name" : "jerr:JNSE0022", "type" : "xs:QName", "description" : "It is a dynamic error to serialize a sequence that does\n not exist of exactly one document node with XML, HTML, XHTML, Text.\n" }, { "name" : "jerr:JNSE0014", "type" : "xs:QName", "description" : "It is a dynamic error to serialize a function or a node with the\n JSON output method.\n" }, { "name" : "jerr:NS", "type" : "item()*", "description" : "" }, { "name" : "jerr:JNSE0012", "type" : "xs:QName", "description" : "It is a dynamic error to serialize a sequence of less\n or more than one item with the JSON output method if the\n jsoniq-serialization-multiple-items is set to no.\n" }, { "name" : "jerr:JNTY0011", "type" : "xs:QName", "description" : "It is a type error if the content sequence in a node constructor or in an XQUF insert or replace update expression contains an object or an array.\n" }, { "name" : "jerr:JNUP0010", "type" : "xs:QName", "description" : "It is a dynamic error if a pending update list contains two renaming update primitives on the same object and with the same selector.\n" }, { "name" : "jerr:JNUP0009", "type" : "xs:QName", "description" : "It is a dynamic error if a pending update list contains two replacing update primitives on the same object or array, and with the same selector.\n" }, { "name" : "jerr:JNUP0008", "type" : "xs:QName", "description" : "It is a dynamic error if the target of a deleting or replacing expression is not an array or an object.\n It is a dynamic error if the target of a renaming expression is not an object.\n It is a dynamic error if the target of an appending expression is not an array.\n It is a dynamic error if the target of a position-inserting expression is not an array.\n It is a dynamic error if the target of a non-position-inserting expression is not an object.\n" }, { "name" : "jerr:JNUP0007", "type" : "xs:QName", "description" : "It is a type error if, in an updating expression, an array selector cannot be cast to xs:integer or if an object selector cannot be cast to xs:string.\n" }, { "name" : "jerr:JNUP0006", "type" : "xs:QName", "description" : "It is a dynamic error if upd:applyUpdates causes an object to contain two pairs with the same name.\n" }, { "name" : "jerr:JNUP0005", "type" : "xs:QName", "description" : "It is a dynamic error if a pending update list contains two inserting update primitives on the same object and pair name.\n" }, { "name" : "jerr:JNTY0004", "type" : "xs:QName", "description" : "It is a type error to call fn:data on a sequence containing an array or an object.\n" }, { "name" : "jerr:JNDY0003", "type" : "xs:QName", "description" : "It is a dynamic error if two pairs in an object constructor or in a simple object union have the same name.\n" }, { "name" : "jerr:JNTY0002", "type" : "xs:QName", "description" : "It is a type error if the right-hand-side expression of a pair constructor does not return exactly one item.\n" } ] }, "http://zorba.io/modules/sctx" : { "ns" : "http://zorba.io/modules/sctx", "description" : " This module provides functions that gets components of the static context.\n", "sees" : [ "http://www.w3.org/TR/xquery/#id-xq-static-context-components" ], "authors" : [ "Nicolae Brinza" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/sctx", "prefix" : "sctx" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "base-uri", "qname" : "sctx:base-uri", "signature" : "() as xs:string? external", "description" : " Gets the base URI.\n", "summary" : "
     Gets the base URI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string?", "description" : "The base URI." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "boundary-space-policy", "qname" : "sctx:boundary-space-policy", "signature" : "() as xs:string external", "description" : " Gets the boundary whitespace policy used by direct element constructors.\n", "summary" : "
     Gets the boundary whitespace policy used by direct element constructors.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "Either preserve or strip." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "construction-mode", "qname" : "sctx:construction-mode", "signature" : "() as xs:string external", "description" : " Gets the static context construction mode of element and document nodes.\n", "summary" : "
     Gets the static context construction mode of element and document nodes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "Either preserve or strip." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "copy-namespaces-mode", "qname" : "sctx:copy-namespaces-mode", "signature" : "() as xs:string+ external", "description" : " Gets the static context components that control the the namespace bindings\n that are assigned when an existing element node is copied\n by an element constructor.\n", "summary" : "
     Gets the static context components that control the the namespace bindings\n that are assigned when an existing element node is copied\n by an element constructor.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string+", "description" : "A sequence of two strings: the first is either preserve or no-preserve and the second is either inherit or no-inherit." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "default-collation", "qname" : "sctx:default-collation", "signature" : "() as xs:string external", "description" : " Gets one of statically known collations used by functions and operators\n for comparing and ordering values of type xs:string\n or xs:anyURI when no explicit collation is specified.\n", "summary" : "
     Gets one of statically known collations used by functions and operators\n for comparing and ordering values of type  xs:string \n or  xs:anyURI  when no explicit collation is specified.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The collations that is used by default." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "default-collection-type", "qname" : "sctx:default-collection-type", "signature" : "() as xs:string external", "description" : " Gets the statically known default collection type.\n This is the type of the sequence of nodes that would result from calling the\n fn:collection function with no arguments.\n", "summary" : "
     Gets the statically known default collection type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The type of the default collection." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "default-function-namespace", "qname" : "sctx:default-function-namespace", "signature" : "() as xs:string external", "description" : " Gets the URI of the default function namespace.\n", "summary" : "
     Gets the URI of the default function namespace.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The URI of the of the default function namespace." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "default-order", "qname" : "sctx:default-order", "signature" : "() as xs:string external", "description" : " Gets the component that controls the processing of empty sequences and NaN\n values as ordering keys in an order by clause\n in a FLWOR expression.\n", "summary" : "
     Gets the component that controls the processing of empty sequences and NaN\n values as ordering keys in an  order by  clause\n in a FLWOR expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "Either greatest or least." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "function-annotations", "qname" : "sctx:function-annotations", "signature" : "($name as xs:QName, $arity as xs:integer) as xs:QName* external", "description" : " Gets the list of annotations declared for the given function.\n", "summary" : "
     Gets the list of annotations declared for the given function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the function.
    " }, { "name" : "arity", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of arguments the function takes.
    " } ], "returns" : { "type" : "xs:QName*", "description" : "the list of annotations" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "function-arguments-count", "qname" : "sctx:function-arguments-count", "signature" : "($function as xs:QName) as xs:int* external", "description" : " Gets the number of arguments the given XQuery function takes.\n", "summary" : "
     Gets the number of arguments the given XQuery function takes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "function", "type" : "xs:QName", "occurrence" : null, "description" : "
     A QName identifying a function.
    " } ], "returns" : { "type" : "xs:int*", "description" : "Either a sequence of zero or more integers (one for each overloaded version of the given function) or an empty sequence if the function is not defined." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "function-names", "qname" : "sctx:function-names", "signature" : "() as xs:QName* external", "description" : " Gets a sequence containing the QNames of all defined functions\n that are available to be called from within an expression.\n", "summary" : "
     Gets a sequence containing the QNames of all defined functions\n that are available to be called from within an expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence for QNames identifying all functions." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "functions", "qname" : "sctx:functions", "signature" : "() as object()* external", "description" : " Gets a sequence of JSON objects containing the name, arity, and annotations\n of all defined functions that are available to be called form within an\n expression.\n", "summary" : "
     Gets a sequence of JSON objects containing the name, arity, and annotations\n of all defined functions that are available to be called form within an\n expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "A sequence of objects." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "in-scope-attribute-declarations", "qname" : "sctx:in-scope-attribute-declarations", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames identifying declared attributes\n in the imported schemas.\n", "summary" : "
     Gets a sequence of QNames identifying declared attributes\n in the imported schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each attribute." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "in-scope-attribute-groups", "qname" : "sctx:in-scope-attribute-groups", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames identifying declared in-scope\n schema attribute groups.\n", "summary" : "
     Gets a sequence of QNames identifying declared in-scope\n schema attribute groups.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each attribute group." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "in-scope-element-declarations", "qname" : "sctx:in-scope-element-declarations", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames identifying declared elements\n in the imported schemas.\n", "summary" : "
     Gets a sequence of QNames identifying declared elements\n in the imported schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each declared element." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "in-scope-element-groups", "qname" : "sctx:in-scope-element-groups", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames identifying declared in-scope\n schema element groups.\n", "summary" : "
     Gets a sequence of QNames identifying declared in-scope\n schema element groups.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each element group." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "in-scope-schema-types", "qname" : "sctx:in-scope-schema-types", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames identifying in-scope schema types\n including all the predefined schema types and all definitions\n found in imported schemas.\n", "summary" : "
     Gets a sequence of QNames identifying in-scope schema types\n including all the predefined schema types and all definitions\n found in imported schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each defined type." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "in-scope-variables", "qname" : "sctx:in-scope-variables", "signature" : "() as xs:QName* external", "description" : " Gets a sequence of QNames identifying declared variables\n from the static context.\n", "summary" : "
     Gets a sequence of QNames identifying declared variables\n from the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each variable." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "option", "qname" : "sctx:option", "signature" : "($name as xs:QName) as xs:string? external", "description" : " Gets the value of an option that is declared in the prolog of the module.\n", "summary" : "
     Gets the value of an option that is declared in the prolog of the module.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the name of the option value to retrieve
    " } ], "returns" : { "type" : "xs:string?", "description" : "the value of the option if contained in the static context or the empty sequence otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "ordering-mode", "qname" : "sctx:ordering-mode", "signature" : "() as xs:string external", "description" : " Gets the ordering mode that affects the ordering of the result sequences\n returned by certain expressions.\n", "summary" : "
     Gets the ordering mode that affects the ordering of the result sequences\n returned by certain expressions.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "Either ordered or unordered." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "statically-known-collations", "qname" : "sctx:statically-known-collations", "signature" : "() as xs:anyURI* external", "description" : " Gets a sequence that contains the statically known collations.\n", "summary" : "
     Gets a sequence that contains the statically known collations.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI*", "description" : "The sequence of collations." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "statically-known-document-type", "qname" : "sctx:statically-known-document-type", "signature" : "($document as xs:string) as xs:QName external", "description" : " For the given document, returns the static type of its root node.\n", "summary" : "
     For the given document, returns the static type of its root node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "document", "type" : "xs:string", "occurrence" : null, "description" : "
     A URI of a document.
    " } ], "returns" : { "type" : "xs:QName", "description" : "The static type of the given document." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "statically-known-documents", "qname" : "sctx:statically-known-documents", "signature" : "() as xs:anyURI* external", "description" : " Gets a sequence that contains the URIs of all statically known documents.\n", "summary" : "
     Gets a sequence that contains the URIs of all statically known documents.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:anyURI*", "description" : "The sequence of document URIs." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "statically-known-namespace-binding", "qname" : "sctx:statically-known-namespace-binding", "signature" : "($prefix as xs:string) as xs:string? external", "description" : " Gets the bound URI for the given prefix.\n", "summary" : "
     Gets the bound URI for the given prefix.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "prefix", "type" : "xs:string", "occurrence" : null, "description" : "
     The prefix of the known namespace for which the bound URI is being requested.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The URI bound to the prefix is returned, or an empty sequence if the prefix is not known." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "statically-known-namespaces", "qname" : "sctx:statically-known-namespaces", "signature" : "() as xs:string* external", "description" : " Gets a list of known statically known namespaces as prefixes\n (fn, xml, xs, xsi, etc).\n", "summary" : "
     Gets a list of known statically known namespaces as prefixes\n (fn, xml, xs, xsi, etc).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "A sequence of xs:strings, one for each known namespace prefix." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "xpath10-compatibility-mode", "qname" : "sctx:xpath10-compatibility-mode", "signature" : "() as xs:boolean external", "description" : " Gets true or false depending on whether rules for compatibility\n with XPath 1.0 are in effect.\n XQuery set the value of this component to false.\n", "summary" : "
     Gets true or false depending on whether rules for compatibility\n with XPath 1.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "The function should return false." }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/profiles/sec/import" : { "ns" : "http://xbrl.io/modules/bizql/profiles/sec/import", "description" : " 
    This module provides functionality for querying XBRL Infosets of financial reports submitted to the SEC.\n 
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/import", "prefix" : "imp" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "m" }, { "uri" : "http://zorba.io/modules/string", "prefix" : "string" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "disclosure-for-network-label", "qname" : "imp:disclosure-for-network-label", "signature" : "($component as object()) as object()", "description" : " 
    \n Compute the disclore for a component's network label.\n 
    \n", "summary" : "
      \n Compute the disclore for a component's network label.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "component", "type" : "object()", "occurrence" : null, "description" : "
     the component
    " } ], "returns" : { "type" : "object()", "description" : "returns the given component ammended with the disclosure" }, "errors" : [  ] } ], "variables" : [ { "name" : "imp:disclosure-matching", "type" : "object()", "description" : " Declarative description of the disclosure matching heuristics.\n" } ] }, "http://xbrl.io/modules/bizql/profiles/sec/core" : { "ns" : "http://xbrl.io/modules/bizql/profiles/sec/core", "description" : " 
    This module provides functionality for querying XBRL Models of financial reports submitted to the SEC.\n 
    \n 
    Standard $options Parameter
    \n 
    Most functions in the BizQL package allow an additional $options\n    parameter. The options parameter is a JSON object which is defined in the documentation\n    of the facts module.
    \n 
    In addition to the option fields defined in the\n    facts module the following\n    fields can be used in the options of a function in the SEC profile:
    \n 
      \n 
    • HideAmendedFacts: if set to true (default behavior) all facts that have been\n     amended are not included in the result.
      • \n 
    • IncludeImpliedTable: set to true in order to output the implied table if\n     there is no Table (default is false).
      • \n 
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/concept-maps", "prefix" : "concept-maps" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/hypercubes", "prefix" : "hypercubes" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "m" }, { "uri" : "http://xbrl.io/modules/bizql/report-schemas", "prefix" : "report-schemas" }, { "uri" : "http://xbrl.io/modules/bizql/profiles/sec/core", "prefix" : "sec" }, { "uri" : "http://zorba.io/modules/string", "prefix" : "string" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "edgar-facts-for-archives", "qname" : "sec:edgar-facts-for-archives", "signature" : "($archive_or_ids as item()*) as object()*", "description" : " 
    Return all facts for concepts that are defined by one of the common\n edgar taxonomies. In particular, this function returns facts for concepts\n having one of the following prefixes:
    \n 
      \n   
    • xbrli
      • \n   
    • link
      • \n   
    • xl
      • \n   
    • xlink
      • \n   
    • xbrldt
      • \n   
    • xbrldi
      • \n   
    • nonnum
      • \n   
    • num
      • \n   
    • ref
      • \n   
    • us-gaap
      • \n   
    • dei
      • \n   
    • us-types
      • \n   
    • invest
      • \n   
    • country
      • \n   
    • currency
      • \n   
    • exch
      • \n   
    • naics
      • \n   
    • sic
      • \n   
    • stpr
      • \n   
    • rr
      • \n   
    • rr-ent
      • \n   
    • rr-cal
      • \n   
    • rr-def
      • \n   
    • rr-pre
      • \n 
    \n", "summary" : "
      Return all facts for concepts that are defined by one of the common\n edgar taxonomies.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive_or_ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archive or archive IDs to filter.
    " } ], "returns" : { "type" : "object()*", "description" : "all facts having one of the above prefixes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "end-date", "qname" : "sec:end-date", "signature" : "($filing-fact-or-id as item()?) as xs:date?", "description" : " 
    Retrieves the document end date of a filing or a fact.
    \n", "summary" : "
      Retrieves the document end date of a filing or a fact.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "filing-fact-or-id", "type" : "item()", "occurrence" : "?", "description" : "
     a filing, a fact, or its id.
    " } ], "returns" : { "type" : "xs:date?", "description" : "the document end date (e.g., xs:date(\"2011-04-30\"))." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "extension-facts-for-archives", "qname" : "sec:extension-facts-for-archives", "signature" : "($archive_or_ids as item()*) as object()*", "description" : " 
    Return all facts for concepts that are NOT defined by one of the common\n edgar taxonomies. In particular, this function returns facts for concepts\n having none of the prefixes listed under function\n sec:edgar-facts-for-archives.
    \n", "summary" : "
      Return all facts for concepts that are NOT defined by one of the common\n edgar taxonomies.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive_or_ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archive or archive IDs to filter.
    " } ], "returns" : { "type" : "object()*", "description" : "all facts having none of the common edgar prefixes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "fact-table-for-schema", "qname" : "sec:fact-table-for-schema", "signature" : "($schema as item(), $archives as item()*) as array()", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a report schema or its RID.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $sec:ALL_OF_THEM for no filtering.
    " } ], "returns" : { "type" : "array()", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-archives-and-concepts", "qname" : "sec:facts-for-archives-and-concepts", "signature" : "($archive_or_ids as item()*, $concepts as item()*) as object()*", "description" : " 
    Retrieves the facts associated with the supplied concepts\n from the supplied archive, that match the fiscal focus of the archive.
    \n", "summary" : "
      Retrieves the facts associated with the supplied concepts\n from the supplied archive, that match the fiscal focus of the archive.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive_or_ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their ids or $sec:ALL_OF_THEM for no filtering.
    " }, { "name" : "concepts", "type" : "item()", "occurrence" : "*", "description" : "
     the concepts or $sec:ALL_OF_THEM for no filtering.
    " } ], "returns" : { "type" : "object()*", "description" : "the latest facts associated with the supplied concept." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "facts-for-archives-and-concepts", "qname" : "sec:facts-for-archives-and-concepts", "signature" : "($archive_or_ids as item()*, $concepts as item()*, $options as object()?) as object()*", "description" : " 
    Retrieves the facts associated with the supplied concepts\n from the supplied archive, that match the fiscal focus of the archive.
    \n", "summary" : "
      Retrieves the facts associated with the supplied concepts\n from the supplied archive, that match the fiscal focus of the archive.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive_or_ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their ids or $sec:ALL_OF_THEM for no filtering.
    " }, { "name" : "concepts", "type" : "item()", "occurrence" : "*", "description" : "
     the concepts or $sec:ALL_OF_THEM for no filtering.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "the latest facts associated with the supplied concept." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-schema", "qname" : "sec:facts-for-schema", "signature" : "($schema as item(), $archives as item()*) as item()*", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema and to the fiscal focus, and populates\n them with the default dimension values when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema and to the fiscal focus, and populates\n them with the default dimension values when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a schema.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $sec:ALL_OF_THEM for no filtering.
    " } ], "returns" : { "type" : "item()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hide-amended-facts", "qname" : "sec:hide-amended-facts", "signature" : "($facts as object()*) as object()*", "description" : " 
    Filters a list of facts and returns only the latest amending facts.\n    Accordingly, all amended facts are filtered out.
    \n", "summary" : "
      Filters a list of facts and returns only the latest amending facts.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "facts", "type" : "object()", "occurrence" : "*", "description" : "
     a list of facts.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts without amended facts." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "populate-schema-with-facts", "qname" : "sec:populate-schema-with-facts", "signature" : "($schema as item(), $archives as item()*) as object()*", "description" : " 
    Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema. Default dimension values are added to the facts\n when missing.
    \n", "summary" : "
      Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a report schema or its RID.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "populate-schema-with-facts", "qname" : "sec:populate-schema-with-facts", "signature" : "($schema as item(), $archives as item()*, $options as object()?) as object()*", "description" : " 
    Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema. Default dimension values are added to the facts\n when missing.
    \n", "summary" : "
      Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a report schema or its RID.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $sec:ALL_OF_THEM for no filtering.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] } ], "variables" : [ { "name" : "sec:CIK", "type" : "xs:string", "description" : " Scheme for the SEC entity identifiers (i.e. http://www.sec.gov/CIK)\n" }, { "name" : "sec:ALL_OF_THEM", "type" : "boolean", "description" : " Joker value for all archives or all concepts.\n" }, { "name" : "sec:EDGAR_PREFIXES", "type" : "item()*", "description" : " All prefixes pre-declared in SEC's EDGAR.\n" } ] }, "http://zorba.io/modules/excel/logical" : { "ns" : "http://zorba.io/modules/excel/logical", "description" : " This is a library module offering the same set of functions\n defined by Microsoft Excel, under Logical Functions.\n", "sees" : [ "Excel Documentation: Logical Functions" ], "authors" : [ "Sorin Nasoi" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/excel/errors", "prefix" : "excel-err" }, { "uri" : "http://zorba.io/modules/excel/logical", "prefix" : "excel-logical" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "and", "qname" : "excel-logical:and", "signature" : "($values as xs:anyAtomicType*) as xs:boolean", "description" : " Returns TRUE if all its arguments are TRUE; FALSE if one or more arguments are FALSE.\n", "summary" : "
     Returns TRUE if all its arguments are TRUE; FALSE if one or more arguments are FALSE.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "values", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of arguments.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if all its arguments are TRUE; FALSE if one or more arguments are FALSE." }, "errors" : [ "excel-err:Value provided sequence is empty." ] }, { "isDocumented" : true, "arity" : 2, "name" : "and", "qname" : "excel-logical:and", "signature" : "($arg1 as xs:anyAtomicType, $arg2 as xs:anyAtomicType) as xs:boolean", "description" : " Returns TRUE if all its arguments are TRUE; FALSE if one or more arguments are FALSE.\n", "summary" : "
     Returns TRUE if all its arguments are TRUE; FALSE if one or more arguments are FALSE.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the first argument.
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the second argument.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if all its arguments are TRUE; FALSE if one or more arguments are FALSE." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "if", "qname" : "excel-logical:if", "signature" : "($logical_test as xs:boolean, $value_if_true as item()*, $value_if_false as item()*) as item()*", "description" : " Returns one value if a condition you specify evaluates to TRUE and another value if it evaluates to FALSE.\n", "summary" : "
     Returns one value if a condition you specify evaluates to TRUE and another value if it evaluates to FALSE.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "logical_test", "type" : "xs:boolean", "occurrence" : null, "description" : "
     is any value or expression that can be evaluated to TRUE or FALSE.
    " }, { "name" : "value_if_true", "type" : "item()", "occurrence" : "*", "description" : "
     the value that is returned if logical_test is TRUE.
    " }, { "name" : "value_if_false", "type" : "item()", "occurrence" : "*", "description" : "
     the value that is returned if logical_test is FALSE.
    " } ], "returns" : { "type" : "item()*", "description" : "One value if a condition you specify evaluates to TRUE and another value if it evaluates to FALSE." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "or", "qname" : "excel-logical:or", "signature" : "($values as xs:anyAtomicType*) as xs:boolean", "description" : " Returns TRUE if any argument is TRUE; FALSE if all arguments are FALSE.\n", "summary" : "
     Returns TRUE if any argument is TRUE; FALSE if all arguments are FALSE.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "values", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of arguments.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if any argument is TRUE; FALSE if all arguments are FALSE." }, "errors" : [ "excel-err:Value provided sequence is empty." ] }, { "isDocumented" : true, "arity" : 2, "name" : "or", "qname" : "excel-logical:or", "signature" : "($arg1 as xs:anyAtomicType, $arg2 as xs:anyAtomicType) as xs:boolean", "description" : " Returns TRUE if any argument is TRUE; FALSE if all arguments are FALSE.\n", "summary" : "
     Returns TRUE if any argument is TRUE; FALSE if all arguments are FALSE.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the first argument.
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the second argument.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "TRUE if any argument is TRUE; FALSE if all arguments are FALSE." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/sequence" : { "ns" : "http://www.28msec.com/modules/sequence", "description" : " The sequence module allows you to generate consecutive\n application-unique xs:integer ids. This is required e.g. in accounting\n applications as some legislations require consecutive invoice numbers.\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/store/static/collections/dml", "prefix" : "cdml" }, { "uri" : "http://zorba.io/modules/store/static/indexes/dml", "prefix" : "idml" }, { "uri" : "http://www.28msec.com/modules/lock", "prefix" : "lock" }, { "uri" : "http://www.28msec.com/modules/sequence", "prefix" : "seq" }, { "uri" : "http://www.28msec.com/modules/sleep", "prefix" : "sleep" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "id", "qname" : "seq:id", "signature" : "($uri as xs:string) as xs:integer", "description" : " Returns a unique (sequentially incremented) id for the\n uri specified as parameter.\n Here the function is used to create consecutive invoice numbers:\n 
    \n if (order:fulfilled($order-id))\n then\n   {\n     variable $invoice-id := seq:id(\"invoice\");\n     invoice:create($invoice-id, $order-id);\n   }\n else\n   ...\n 
    \n", "summary" : "
     Returns a unique (sequentially incremented) id for the\n uri specified as parameter.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the sequence counter as uri.
    " } ], "returns" : { "type" : "xs:integer", "description" : "A sequentially incremented id." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "reset", "qname" : "seq:reset", "signature" : "($uri as xs:string) as empty-sequence()", "description" : " Resets the unique (sequentially incremented) id generation\n for the uri specified as parameter.\n", "summary" : "
     Resets the unique (sequentially incremented) id generation\n for the uri specified as parameter.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the sequence counter as uri.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "empty-sequence()" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "value", "qname" : "seq:value", "signature" : "($uri as xs:string) as xs:integer", "description" : " Returns the id for the uri specified as parameter without incrementing it.\n", "summary" : "
     Returns the id for the uri specified as parameter without incrementing it.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the sequence counter as uri.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The current value" }, "errors" : [ "seq:not-found if no counter with the given $uri was found" ] } ], "variables" : [ { "name" : "seq:counters", "type" : "item()*", "description" : " The QName for the counters collection.\n" }, { "name" : "seq:counters-by-uri", "type" : "item()*", "description" : " The QName for the counters-by-uri collection.\n" } ] }, "http://api.28.io/databrowser" : { "ns" : "http://api.28.io/databrowser", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/databrowser", "prefix" : "api" }, { "uri" : "http://zorba.io/modules/base64", "prefix" : "base64" }, { "uri" : "http://zorba.io/modules/store/static/collections/dml", "prefix" : "dml" }, { "uri" : "http://www.zorba-xquery.com/extensions", "prefix" : "ext" }, { "uri" : "http://www.functx.com", "prefix" : "functx" }, { "uri" : "http://expath.org/ns/http-client", "prefix" : "http" }, { "uri" : "http://www.zorba-xquery.com/modules/http-client", "prefix" : "http-client" }, { "uri" : "http://zorba.io/modules/xml-options", "prefix" : "opt" }, { "uri" : "http://www.28msec.com/modules/project", "prefix" : "project" }, { "uri" : "http://zorba.io/modules/reflection", "prefix" : "r" }, { "uri" : "http://zorba.io/modules/reference", "prefix" : "ref" }, { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "res" }, { "uri" : "http://zorba.io/modules/xml", "prefix" : "xmlmod" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "collection", "qname" : "api:collection", "signature" : "($name as xs:string)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "delete", "qname" : "api:delete", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "dispatch", "qname" : "api:dispatch", "signature" : "()", "description" : " Data Browser API dispatched.\n Handles API authorization to the portal and dispatching.\n", "summary" : "
     Data Browser API dispatched.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "edit", "qname" : "api:edit", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "options", "qname" : "api:options", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "run", "qname" : "api:run", "signature" : "($sequential as xs:boolean) as object()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "sequential", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "object()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "serialize", "qname" : "api:serialize", "signature" : "($items as item()*) as object()", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "items", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "object()", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 0, "name" : "upload", "qname" : "api:upload", "signature" : "()", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/footnotes" : { "ns" : "http://xbrl.io/modules/bizql/footnotes", "description" : " 
    This module provides functions for retrieving XBRL footnotes\n (see section 4.11 Footnotes of the XBRL 2.1 specification).
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/footnotes", "prefix" : "footnotes" }, { "uri" : "http://www.28msec.com/modules/mongodb/types", "prefix" : "m" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "mongo" }, { "uri" : "http://zorba.io/modules/string", "prefix" : "string" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "fnid", "qname" : "footnotes:fnid", "signature" : "($footnote-or-id as item()) as atomic", "description" : " 
    Converts the input to a normalized footnote id (FNID). The input\n can be either an FNID, or a footnote object which contains an _id.
    \n", "summary" : "
      Converts the input to a normalized footnote id (FNID).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "footnote-or-id", "type" : "item()", "occurrence" : null, "description" : "
     an footnote object or FNID.
    " } ], "returns" : { "type" : "atomic", "description" : "the normalized FNID." }, "errors" : [ "footnotes:INVALID-PARAMETER if the FNID or footnote is not valid." ] }, { "isDocumented" : true, "arity" : 1, "name" : "footnotes-for-archives", "qname" : "footnotes:footnotes-for-archives", "signature" : "($archive-or-ids as item()*) as object()*", "description" : " 
    Return all footnotes reported within a given archive.
    \n", "summary" : "
      Return all footnotes reported within a given archive.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or AIDs to filter.
    " } ], "returns" : { "type" : "object()*", "description" : "all footnotes reported in these archives." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "footnotes-for-facts", "qname" : "footnotes:footnotes-for-facts", "signature" : "($facts-or-ids as item()*) as object()*", "description" : " 
    Return all footnotes associated with the given facts.
    \n", "summary" : "
      Return all footnotes associated with the given facts.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "facts-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of facts or fact IDs to filter
    " } ], "returns" : { "type" : "object()*", "description" : "all footnotes associated with these facts." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "footnotes-for-facts", "qname" : "footnotes:footnotes-for-facts", "signature" : "($facts-or-ids as item()*, $options as object()?) as object()*", "description" : " 
    Return all footnotes associated with the given facts.
    \n", "summary" : "
      Return all footnotes associated with the given facts.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "facts-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of facts or fact IDs to filter
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "all footnotes associated with these facts." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "footnotes-search", "qname" : "footnotes:footnotes-search", "signature" : "($search as string) as object()*", "description" : " 
    Return all footnotes that match the given search term.
    \n", "summary" : "
      Return all footnotes that match the given search term.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "search", "type" : "string", "occurrence" : null, "description" : "
     the search query
    " } ], "returns" : { "type" : "object()*", "description" : "all footnotes matching the given search query" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "footnotes", "qname" : "footnotes:footnotes", "signature" : "() as object()*", "description" : " 
    Return all footnotes.
    \n", "summary" : "
      Return all footnotes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "all footnotes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "footnotes", "qname" : "footnotes:footnotes", "signature" : "($footnote-or-ids as item()*) as object()?", "description" : " 
    Return the footnote with the given FNIDs.
    \n", "summary" : "
      Return the footnote with the given FNIDs.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "footnote-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the FNIDs or the footnotes themselves.
    " } ], "returns" : { "type" : "object()?", "description" : "the footnotes with the given FNIDs the empty sequence if no footnote was found or if the input is an empty sequence." }, "errors" : [  ] } ], "variables" : [ { "name" : "footnotes:col", "type" : "string", "description" : " Name of the collection the footnotes are stored in.\n" }, { "name" : "footnotes:ARCHIVE", "type" : "string", "description" : " Name of the field that points to the archive.\n" }, { "name" : "footnotes:FACTS", "type" : "string", "description" : " Name of the field that points to the facts linked to this footnote.\n" }, { "name" : "footnotes:LANG", "type" : "string", "description" : " Name of the field that holds the language attribute of the footnote.\n" } ] }, "http://zorba.io/modules/store/static/indexes/dml" : { "ns" : "http://zorba.io/modules/store/static/indexes/dml", "description" : " This module defines a set of functions to probe and refresh indexes which are\n declared in the prolog of a module.\n 
    \n This module is part of\n Zorba's XQuery Data Definition Facility.\n All the indexes managed by this module have to be pre-declared in the prolog\n of a library module.\n Please refer to the\n general documentation\n for more information and examples.\n", "sees" : [ "Data Lifecycle", "XQuery Data Definition Facility", "http://zorba.io/modules/store/static/indexes/ddl", "http://zorba.io/modules/store/static/collections/dml", "http://zorba.io/modules/store/static/collections/ddl", "http://zorba.io/modules/store/static/integrity-constraints/ddl", "http://zorba.io/modules/store/static/integrity-constraints/dml", "http://zorba.io/errors" ], "authors" : [ "Zorba Team" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/store/static/indexes/dml", "prefix" : "idml" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "keys", "qname" : "idml:keys", "signature" : "($name as xs:QName) as node()* external", "description" : " Gets a sequence of all keys contained in the index with the given name.\n Each element has the following structure:\n  
    \n   <key xmlns=\"http://zorba.io/modules/store/static/indexes/dml\">\n     <attribute value=\"key1_value\"/>\n     <attribute value=\"key2_value\"/>\n     <attribute value=\"key3_value\"/>\n   </key>\n  
    \n Note that the order of the attribute elements reflects the order of\n the keys in the index specification. Also note that the values in\n these attributes have the type that is declared in the corresponding\n index specification.\n", "summary" : "
     Gets a sequence of all keys contained in the index with the given name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to get the keys for.
    " } ], "returns" : { "type" : "node()*", "description" : "A sequence of elements comprising the keys in the index." }, "errors" : [ "zerr:ZDDY0021 if the index was not declared.", "zerr:ZDDY0023 if the index does not exist." ] }, { "isDocumented" : true, "arity" : 2, "name" : "probe-index-point-general", "qname" : "idml:probe-index-point-general", "signature" : "($name as xs:QName, $key as xs:anyAtomicType*) as node()* external", "description" : " Gets from an index the domain nodes associated by general equality with a\n given search sequence .\n The search sequence consists of an arbitrary number of search keys\n where each search key is an atomic item.\n The function is supported by general indexes only.\n", "summary" : "
     Gets from an index the domain nodes associated by general equality with a\n given  search sequence  .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to probe.
    " }, { "name" : "key", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The search sequence.
    " } ], "returns" : { "type" : "node()*", "description" : "The set of domain nodes for which the following XQuery expression returns true: 
     $keys = $node/keyExpr 
     where keyExpr is the expression specified in the keyspec of the index (remember that for general indexes, there can be only one keyspec)." }, "errors" : [ "err:XPTY0004 if the search sequence contains a search key whose type does not match the sequence type specified in the keyspec of the index.", "zerr:ZDDY0021 if the index with name $name is not declared.", "zerr:ZDDY0023 if the index with name $name does not exist.", "zerr:ZDDY0029 if the index is not general." ] }, { "isDocumented" : true, "arity" : 3, "name" : "probe-index-point-value-skip", "qname" : "idml:probe-index-point-value-skip", "signature" : "($name as xs:QName, $skip as xs:integer, $key_i as xs:anyAtomicType?) as node()* external", "description" : " This is an extension of the probe-index-point-value() function\n in that it allows index items to be skipped.\n", "summary" : "
     This is an extension of the  probe-index-point-value()  function\n in that it allows index items to be skipped.
    ", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to probe.
    " }, { "name" : "skip", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of index items to skip.
    " }, { "name" : "key_i", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     The search keys used to probe the index with. The i-th search key corresponds to the i-th key expression in the index declaration.
    " } ], "returns" : { "type" : "node()*", "description" : "The set of domain nodes that satisfy the search condition." }, "errors" : [ "zerr:ZDDY0021 if the index is not declared.", "zerr:ZDDY0023 if the index does not exist.", "zerr:ZDDY0025 if the number of search keys passed as arguments is not the same as the number of keys declared for the index.", "err:XPTY0004 if a non-empty seach key is given whose type does not match the sequence type specified in the corresponding keyspec." ] }, { "isDocumented" : true, "arity" : 2, "name" : "probe-index-point-value", "qname" : "idml:probe-index-point-value", "signature" : "($name as xs:QName, $key_i as xs:anyAtomicType?) as node()* external", "description" : " Gets the domain nodes from an index associated by value equality with a\n given search tuple.\n 
    \n The search tuple consists of a number of search keys where each\n search key is either an atomic item or the empty sequence.  The number of\n search keys given must be equal to the number of keys declared for the\n index. Since the number of keys differs from one index to another, this\n function is variadic.\n", "summary" : "
     Gets the domain nodes from an index associated by value equality with a\n given  search tuple .
    ", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The of the index to probe.
    " }, { "name" : "key_i", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     A search key used to probe the index with. The i-th search key corresponds to the i-th key expression in the index declaration.
    " } ], "returns" : { "type" : "node()*", "description" : "The set of domain nodes for which the following XQuery expression returns true: 
     $key1 eq $node/keyExpr1 and ... and $keyM eq $node/keyExprM 
     where keyExpri is the expression specified in the i-th keyspec of the index." }, "errors" : [ "zerr:ZDDY0021 if the index is not declared.", "zerr:ZDDY0023 if the index does not exist.", "zerr:ZDDY0025 if the number of search keys passed as arguments is not the same as the number of keys declared for the index.", "err:XPTY0004 if a non-empty seach key is given whose type does not match the sequence type specified in the corresponding keyspec." ] }, { "isDocumented" : true, "arity" : 7, "name" : "probe-index-range-general", "qname" : "idml:probe-index-range-general", "signature" : "($name as xs:QName, $lowerBound as xs:anyAtomicType*, $upperBound as xs:anyAtomicType*, $haveLowerBound as xs:boolean, $haveUpperBound as xs:boolean, $lowerBoundIncluded as xs:boolean, $upperBoundIncluded as xs:boolean) as node()* external", "description" : " Gets the domain nodes associated by general order-comparison (operators\n <=, <, >=,\n >) with one or two search sequences.\n 
    \n Each search sequence consists of an arbitrary number of\n search keys where each search key is an atomic item.\n This method is supported by general range indexes only.\n Its result is either an error or the set of domain nodes for which the\n following XQuery expression returns true:\n  
    \n    if ( $haveLowerBound and $haveUpperBound ) then\n      $lowerBoundKeys lop $node/keyExpr and $node/keyExpr uop $upperBoundKeys\n    else if ( $haveLowerBound ) then\n      $lowerBoundKeys lop $node/keyExpr\n    else if ( $haveUpperBound ) then\n      $node/keyExpr uop $upperBoundKeys\n    else\n      fn:true()\n  
    \n where keyExpr is the expression specified in the keyspec of the\n index, lop is either the <= or the <\n operator depending on whether $lowerBoundsIncluded is true or\n false, and uop is either the <= or the\n < operator depending on whether\n $upperBoundsIncluded is true or false.\n", "summary" : "
     Gets the domain nodes associated by general order-comparison (operators\n  <= ,  < ,  >= ,\n  > ) with one or two  search sequences .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The of the index to probe.
    " }, { "name" : "lowerBound", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The lower bound search sequence.
    " }, { "name" : "upperBound", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     The upper bound search sequence.
    " }, { "name" : "haveLowerBound", "type" : "xs:boolean", "occurrence" : null, "description" : "
     Whether a lower bound search sequence exists or not.
    " }, { "name" : "haveUpperBound", "type" : "xs:boolean", "occurrence" : null, "description" : "
     Whether an upper bound search sequence exists or not.
    " }, { "name" : "lowerBoundIncluded", "type" : "xs:boolean", "occurrence" : null, "description" : "
     Whether to use the <= or the < operator when comparing a search key from $lowerBound with an index key.
    " }, { "name" : "upperBoundIncluded", "type" : "xs:boolean", "occurrence" : null, "description" : "
     Whether to use the <= or the < operator when comparing an index key with a search key from $upperBound.
    " } ], "returns" : { "type" : "node()*", "description" : "The set of domain nodes that satisfy the search condition." }, "errors" : [ "zerr:ZDDY0021 if the index was not declared.", "zerr:ZDDY0023 if the index does not exist.", "zerr:ZDDY0030 if the index is not a general range index.", "err:XPTY0004 if $haveLowerBound is true and $lowerBoundKeys contains an atomic item whose type does not match the sequence type specified by the index keyspec, or $haveUpperBound is true and $upperBoundKeys contains an atomic item whose type does not match the sequence type specified by the index keyspec." ] }, { "isDocumented" : true, "arity" : 8, "name" : "probe-index-range-value-skip", "qname" : "idml:probe-index-range-value-skip", "signature" : "($name as xs:QName, $skip as xs:integer, $lowerBound-i as xs:anyAtomicType?, $upperBound-i as xs:anyAtomicType?, $haveLowerBound-i as xs:boolean, $haveUpperBound-i as xs:boolean, $lowerBoundIncluded-i as xs:boolean, $upperBoundIncluded-i as xs:boolean) as node()* external", "description" : " This function is an extension of the probe-index-range-value()\n function that index items to be skipped.\n", "summary" : "
     This function is an extension of the  probe-index-range-value() \n function that index items to be skipped.
    ", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The QName of the index to probe
    " }, { "name" : "skip", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of index items to skip.
    " }, { "name" : "lowerBound-i", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     The lower bound in a range of key values.
    " }, { "name" : "upperBound-i", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     The upper bound in a range of key values.
    " }, { "name" : "haveLowerBound-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then there is no lower bound, or equivalently, the lower bound is -INFINITY. Otherwise, the lower bound is the one given by the $lowerBound-i value.
    " }, { "name" : "haveUpperBound-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then there is no upper bound, or equivalently, the upper bound is +INFINITY. Otherwise, the upper bound is the one given by the $upperBound-i value.
    " }, { "name" : "lowerBoundIncluded-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then the range is open from below, i.e., the lowerBound-i value is not considered part of the range. Otherwise, the range is closed from below, i.e., the $lowerBound-i value is part of the range.
    " }, { "name" : "upperBoundIncluded-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then the range is open from above, i.e., the upperBound-i value is not considered part of the range. Otherwise, the range is closed from above, i.e., the $upperBound-i value is part of the range.
    " } ], "returns" : { "type" : "node()*", "description" : "The set of domain nodes that satisfy the search condition." }, "errors" : [ "zerr:ZDDY0021 if the index with name $name is not declared.", "zerr:ZDDY0023 if the index with name $name does not exist.", "zerr:ZDDY0025 if the number of rangespecs passed as arguments is zero or greater than the number of keys declared for the index.", "zerr:ZDDY0026 if the index is not a range index.", "err:XPTY0004 if $haveLowerBound-i is true and $lowerBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec, or $haveUpperBound-i is true and $upperBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec.", "zerr:ZDDY0034 if (a) the index is general (in which case there is only one rangespac), (b) the index is untyped, (c) there is both a lower and an upper bound, and (d) if T1 and T2 are the types of the lower and upper bound, neither T1 is a subtype of T2 nor T2 is a subtype of T1." ] }, { "isDocumented" : true, "arity" : 7, "name" : "probe-index-range-value", "qname" : "idml:probe-index-range-value", "signature" : "($name as xs:QName, $lowerBound-i as xs:anyAtomicType?, $upperBound-i as xs:anyAtomicType?, $haveLowerBound-i as xs:boolean, $haveUpperBound-i as xs:boolean, $lowerBoundIncluded-i as xs:boolean, $upperBoundIncluded-i as xs:boolean) as node()* external", "description" : " Gets the domain nodes associated by value order-comparison (operators\n le, lt, ge, gt) with a\n given search box.\n 
    \n The search box is specified as a number M of rangespecs\n where each rangespec consists of six values.\n The number M must be greater than 0 and less than or equal to the\n number N of keyspecs found in the index declaration.\n If M < N, then the \"missing\" rangespecs are assumed to have\n the following value: [(), (), false, false, false, false].\n As a result, we can assume that M = N.\n Remember that for general indexes, there can be only one IndexKeySpec and,\n as a result for general indexes, M = N = 1.\n Since the number of keys differs from one index to another,\n this function is variadic.\n 
    \n The ith rangespec corresponds to the ith keyspec, and\n specifies a search condition on the key values that are produced by\n evaluating that keyspec for every domain node.\n Specifically, we define the ith rangespec result as the\n set of domain nodes for which the following XQuery expression returns\n true:\n  
    \n    if ( $haveLowerBound-i and $haveUpperBound-i ) then\n      $lowerBound-i lop $node/keyExpr-i and $node/keyExpr-i uop $upperBound-i\n    else if ( $haveLowerBound-i ) then\n      $lowerBound-i lop $node/keyExpr-i\n    else if ( $haveUpperBound-i ) then\n      $node/keyExpr-i uop $upperBound-i\n    else\n      fn:true()\n  
    \n where keyExpr-i is the expression specified by the ith\n keyspec of the index, lop is either the le or the\n lt operator depending on whether\n $lowerBoundsIncluded-i is true or false, and uop is\n either the le or the lt operator depending on whether\n $upperBoundsIncluded-i is true or false.\n", "summary" : "
     Gets the domain nodes associated by value order-comparison (operators\n  le ,  lt ,  ge ,  gt ) with a\n given  search box .
    ", "annotation_str" : " %an:variadic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "variadic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to probe.
    " }, { "name" : "lowerBound-i", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     The lower bound in a range of key values.
    " }, { "name" : "upperBound-i", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     The upper bound in a range of key values.
    " }, { "name" : "haveLowerBound-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then there is no lower bound, or equivalently, the lower bound is -INFINITY. Otherwise, the lower bound is the one given by the $lowerBound-i value.
    " }, { "name" : "haveUpperBound-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then there is no upper bound, or equivalently, the upper bound is +INFINITY. Otherwise, the upper bound is the one given by the $upperBound-i value.
    " }, { "name" : "lowerBoundIncluded-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then the range is open from below, i.e., the $lowerBound-i value is not considered part of the range. Otherwise, the range is closed from below, i.e., the $lowerBound-i value is part of the range.
    " }, { "name" : "upperBoundIncluded-i", "type" : "xs:boolean", "occurrence" : null, "description" : "
     If false, then the range is open from above, i.e., the $upperBound-i value is not considered part of the range. Otherwise, the range is closed from above, i.e., the $upperBound-i value is part of the range.
    " } ], "returns" : { "type" : "node()*", "description" : "The intersection of all the rangespec results." }, "errors" : [ "zerr:ZDDY0021 if the index is not declared.", "zerr:ZDDY0023 if the index does not exist.", "zerr:ZDDY0025 if the number of rangespecs passed as arguments is zero or greater than the number of keys declared for the index.", "zerr:ZDDY0026 if the index is not a range index.", "err:XPTY0004 if $haveLowerBound-i is true and $lowerBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec, or $haveUpperBound-i is true and $upperBound-i is an atomic item whose type does not match the sequence type specified by the ith keyspec.", "zerr:ZDDY0034 if (a) the index is general (in which case there is only one rangespac), (b) the index is untyped, (c) there is both a lower and an upper bound, and (d) if T1 and T2 are the types of the lower and upper bound, neither T1 is a subtype of T2 nor T2 is a subtype of T1." ] }, { "isDocumented" : true, "arity" : 1, "name" : "refresh-index", "qname" : "idml:refresh-index", "signature" : "($name as xs:QName) external", "description" : " Updates the index with the given name.  Note that if the maintenance\n property of the index is automatic, this function does nothing.\n", "summary" : "
     Updates the index with the given name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the index to refresh.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, when applied, refreshes the contents of the index." }, "errors" : [ "zerr:ZDDY0021 if the index is not declared.", "zerr:ZDDY0023 if the index does not exist." ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/full-text" : { "ns" : "http://www.28msec.com/modules/full-text", "description" : " This module provides an API to full-text functions such as tokenization,\n stemming, or stop word detection. The default language is set to english\n for all functions that don't take an explicit language parameter.\n 
    Notes on stemming
    \n The stem() functions return the\n stem\n of a word.\n On 28.io,\n the stem of a word itself, however, is not guaranteed to be a word.\n It is best to consider a stem as an opaque byte sequence.\n All that is guaranteed about a stem is that,\n for a given word,\n the stem of that word will always be the same byte sequence.\n Hence,\n you sould never compare the result of one of the stem()\n functions against a non-stemmed string,\n for example:\n 
    \n  if ( ft:stem( \"apples\" ) eq \"apple\" )             ** WRONG **\n 
    \n Instead do:\n 
    \n  if ( ft:stem( \"apples\" ) eq ft:stem( \"apple\" ) )  ** CORRECT **\n 
    \n 
    Notes on the thesaurus
    \n 28msec uses the\n WordNet lexical database version 3.0,\n In WordNet, the number of \"levels\" that two phrases are apart\n are how many hierarchical meanings apart they are.\n For example,\n \"canary\" is 5 levels away from \"vertebrate\"\n (carary > finch > oscine > passerine > bird > vertebrate).\n 
    \n When using the WordNet implementation,\n 28msec supports all of the relationships (and their abbreviations)\n specified by\n ISO 2788\n and\n ANSI/NISO Z39.19-2005\n with the exceptions of \"HN\" (history note)\n and \"X SN\" (see scope note for).\n These relationships are:\n  \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n  
    Rel.MeaningWordNet Rel.
    BTbroader termhypernym
    BTGbroader term generichypernym
    BTIbroader term instanceinstance hypernym
    BTPbroader term partitivepart meronym
    NTnarrower termhyponym
    NTGnarrower term generichyponym
    NTInarrower term instanceinstance hyponym
    NTPnarrower term partitivepart holonym
    RTrelated termalso see
    SNscope noten/a
    TTtop termhypernym
    UFnon-preferred termn/a
    USEpreferred termn/a
    \n Note that you can specify relationships\n either by their abbreviation\n or their meaning.\n Relationships are case-insensitive.\n In addition to the\n ISO 2788\n and\n ANSI/NISO Z39.19-2005\n relationships,\n 28msec also supports all of the relationships offered by WordNet.\n These relationships are:\n  \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n  
    RelationshipMeaning
    also see\n        A word that is related to another,\n        e.g., for \"varnished\" (furniture)\n        one should also see \"finished.\"\n      
    antonym\n        A word opposite in meaning to another,\n        e.g., \"light\" is an antonym for \"heavy.\"\n      
    attribute\n        A noun for which adjectives express values,\n        e.g., \"weight\" is an attribute\n        for which the adjectives \"light\" and \"heavy\"\n        express values.\n      
    cause\n        A verb that causes another,\n        e.g., \"show\" is a cause of \"see.\"\n      
    derivationally related form\n        A word that is derived from a root word,\n        e.g., \"metric\" is a derivationally related form of \"meter.\"\n      
    derived from adjective\n        An adverb that is derived from an adjective,\n        e.g., \"correctly\" is derived from the adjective \"correct.\"\n      
    entailment\n        A verb that presupposes another,\n        e.g., \"snoring\" entails \"sleeping.\"\n      
    hypernym\n        A word with a broad meaning that more specific words fall under,\n        e.g., \"meal\" is a hypernym of \"breakfast.\"\n      
    hyponym\n        A word of more specific meaning than a general term applicable to it,\n        e.g., \"breakfast\" is a hyponym of \"meal.\"\n      
    instance hypernym\n        A word that denotes a category of some specific instance,\n        e.g., \"author\" is an instance hypernym of \"Asimov.\"\n      
    instance hyponym\n        A term that donotes a specific instance of some general category,\n        e.g., \"Asimov\" is an instance hyponym of \"author.\"\n      
    member holonym\n        A word that denotes a collection of individuals,\n        e.g., \"faculty\" is a member holonym of \"professor.\"\n      
    member meronym\n        A word that denotes a member of a larger group,\n        e.g., a \"person\" is a member meronym of a \"crowd.\"\n      
    part holonym\n        A word that denotes a larger whole comprised of some part,\n        e.g., \"car\" is a part holonym of \"engine.\"\n      
    part meronym\n        A word that denotes a part of a larger whole,\n        e.g., an \"engine\" is part meronym of a \"car.\"\n      
    participle of verb\n        An adjective that is the participle of some verb,\n        e.g., \"breaking\" is the participle of the verb \"break.\"\n      
    pertainym\n        An adjective that classifies its noun,\n        e.g., \"musical\" is a pertainym in \"musical instrument.\"\n      
    similar to\n        Similar, though not necessarily interchangeable, adjectives.\n        For example, \"shiny\" is similar to \"bright\",\n        but they have subtle differences.\n      
    substance holonym\n        A word that denotes a larger whole containing some constituent\n        substance, e.g., \"bread\" is a substance holonym of \"flour.\"\n      
    substance meronym\n        A word that denotes a constituant substance of some larger whole,\n        e.g., \"flour\" is a substance meronym of \"bread.\"\n      
    verb group\n        A verb that is a member of a group of similar verbs,\n        e.g., \"live\" is in the verb group\n        of \"dwell\", \"live\", \"inhabit\", etc.\n      
    \n", "sees" : [  ], "authors" : [ "Paul J. Lucas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://www.28msec.com/modules/full-text", "prefix" : "ft" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" }, { "uri" : "http://zorba.io/modules/full-text", "prefix" : "zft" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "is-stem-lang-supported", "qname" : "ft:is-stem-lang-supported", "signature" : "($lang as language) as boolean", "description" : " Checks whether the given language is supported for stemming.\n", "summary" : "
     Checks whether the given language is supported for stemming.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-stop-word-lang-supported", "qname" : "ft:is-stop-word-lang-supported", "signature" : "($lang as language) as boolean", "description" : " Checks whether the given language\n is supported for stop words.\n", "summary" : "
     Checks whether the given language\n is supported for stop words.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-stop-word", "qname" : "ft:is-stop-word", "signature" : "($word as string) as boolean", "description" : " Checks whether the given word is a stop-word.\n", "summary" : "
     Checks whether the given word is a stop-word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "string", "occurrence" : null, "description" : "
     The word to check. The word's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "boolean", "description" : "true only if $word is a stop-word." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-stop-word", "qname" : "ft:is-stop-word", "signature" : "($word as string, $lang as language) as boolean", "description" : " Checks whether the given word is a stop-word.\n", "summary" : "
     Checks whether the given word is a stop-word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "string", "occurrence" : null, "description" : "
     The word to check.
    " }, { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language of $word.
    " } ], "returns" : { "type" : "boolean", "description" : "true only if $word is a stop-word." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-thesaurus-lang-supported", "qname" : "ft:is-thesaurus-lang-supported", "signature" : "($lang as language) as boolean", "description" : " Checks whether the given language\n is supported for look-up using the Wordnet thesaurus.\n", "summary" : "
     Checks whether the given language\n is supported for look-up using the Wordnet thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-tokenizer-lang-supported", "qname" : "ft:is-tokenizer-lang-supported", "signature" : "($lang as language) as boolean", "description" : " Checks whether the given language\n is supported for tokenization.\n", "summary" : "
     Checks whether the given language\n is supported for tokenization.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "stem", "qname" : "ft:stem", "signature" : "($word as string) as string", "description" : " Stems the given word.\n", "summary" : "
     Stems the given word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "string", "occurrence" : null, "description" : "
     The word to stem. The word's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "string", "description" : "the stem of $word." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "stem", "qname" : "ft:stem", "signature" : "($word as string, $lang as language) as string", "description" : " Stems the given word.\n", "summary" : "
     Stems the given word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "string", "occurrence" : null, "description" : "
     The word to stem.
    " }, { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language of $word.
    " } ], "returns" : { "type" : "string", "description" : "the stem of $word." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "strip-diacritics", "qname" : "ft:strip-diacritics", "signature" : "($string as string) as string", "description" : " Strips all diacritical marks from all characters.\n", "summary" : "
     Strips all diacritical marks from all characters.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "string", "occurrence" : null, "description" : "
     The string to strip diacritical marks from.
    " } ], "returns" : { "type" : "string", "description" : "$string with diacritical marks stripped." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($phrase as string) as string*", "description" : " Looks-up the given phrase in the Wordnet thesaurus.\n", "summary" : "
     Looks-up the given phrase in the Wordnet thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "phrase", "type" : "string", "occurrence" : null, "description" : "
     The phrase to look up.
    " } ], "returns" : { "type" : "string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of Zorba.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which Zorba is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data." ] }, { "isDocumented" : true, "arity" : 2, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($phrase as string, $relationship as string) as string*", "description" : " Looks-up the given phrase in a thesaurus.\n", "summary" : "
     Looks-up the given phrase in a thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "phrase", "type" : "string", "occurrence" : null, "description" : "
     The phrase to look up.
    " }, { "name" : "relationship", "type" : "string", "occurrence" : null, "description" : "
     The relationship the results are to have to $phrase.
    " } ], "returns" : { "type" : "string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri.", "err:FTST0009 if $lang is not supported.", "zerr:ZOSE0001 if the thesaurus data file could not be found.", "zerr:ZOSE0002 if the thesaurus data file is not a plain file.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of Zorba.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which Zorba is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data file." ] }, { "isDocumented" : true, "arity" : 4, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($phrase as string, $relationship as string, $level-least as integer, $level-most as integer) as string*", "description" : " Looks-up the given phrase in a thesaurus.\n", "summary" : "
     Looks-up the given phrase in a thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "phrase", "type" : "string", "occurrence" : null, "description" : "
     The phrase to look up.
    " }, { "name" : "relationship", "type" : "string", "occurrence" : null, "description" : "
     The relationship the results are to have to $phrase.
    " }, { "name" : "level-least", "type" : "integer", "occurrence" : null, "description" : "
     The minimum number of levels within the thesaurus to be traversed.
    " }, { "name" : "level-most", "type" : "integer", "occurrence" : null, "description" : "
     The maximum number of levels within the thesaurus to be traversed.
    " } ], "returns" : { "type" : "string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FOCA0003 if either $level-least or $level-most is either negative or too large.", "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri.", "err:FTST0009 if $lang is not supported.", "zerr:ZOSE0001 if the thesaurus data file could not be found.", "zerr:ZOSE0002 if the thesaurus data file is not a plain file.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of Zorba.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which Zorba is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data file." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tokenize", "qname" : "ft:tokenize", "signature" : "($string as string) as string*", "description" : " Tokenizes the given string.\n", "summary" : "
     Tokenizes the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "string", "occurrence" : null, "description" : "
     The string to tokenize. The string's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "string*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "tokenize", "qname" : "ft:tokenize", "signature" : "($string as string, $lang as language) as string*", "description" : " Tokenizes the given string.\n", "summary" : "
     Tokenizes the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "string", "occurrence" : null, "description" : "
     The string to tokenize.
    " }, { "name" : "lang", "type" : "language", "occurrence" : null, "description" : "
     The language of $string.
    " } ], "returns" : { "type" : "string*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] } ], "variables" : [ { "name" : "ft:lang-da", "type" : "language", "description" : " Predeclared constant for the Danish language.\n" }, { "name" : "ft:lang-de", "type" : "language", "description" : " Predeclared constant for the German language.\n" }, { "name" : "ft:lang-en", "type" : "language", "description" : " Predeclared constant for the English language.\n" }, { "name" : "ft:lang-es", "type" : "language", "description" : " Predeclared constant for the Spanish language.\n" }, { "name" : "ft:lang-fi", "type" : "language", "description" : " Predeclared constant for the Finnish language.\n" }, { "name" : "ft:lang-fr", "type" : "language", "description" : " Predeclared constant for the French language.\n" }, { "name" : "ft:lang-hu", "type" : "language", "description" : " Predeclared constant for the Hungarian language.\n" }, { "name" : "ft:lang-it", "type" : "language", "description" : " Predeclared constant for the Italian language.\n" }, { "name" : "ft:lang-nl", "type" : "language", "description" : " Predeclared constant for the Dutch language.\n" }, { "name" : "ft:lang-no", "type" : "language", "description" : " Predeclared constant for the Norwegian language.\n" }, { "name" : "ft:lang-pt", "type" : "language", "description" : " Predeclared constant for the Portuguese language.\n" }, { "name" : "ft:lang-ro", "type" : "language", "description" : " Predeclared constant for the Romanian language.\n" }, { "name" : "ft:lang-ru", "type" : "language", "description" : " Predeclared constant for the Russian language.\n" }, { "name" : "ft:lang-sv", "type" : "language", "description" : " Predeclared constant for the Swedish language.\n" }, { "name" : "ft:lang-tr", "type" : "language", "description" : " Predeclared constant for the Turkish language.\n" } ] }, "http://xbrl.io/modules/bizql/report-schemas" : { "ns" : "http://xbrl.io/modules/bizql/report-schemas", "description" : " 
    This module provides functions for storing, retrieving, and modifying\n report schemas. Report schemas can be used in BizQL queries. They can be\n instantiated generating a business report.
    \n 
    Report schemas are nothing else than a user-defined component. However,\n one of their hypercubes (the default hypercube), as well as two of their\n networks (presentation, concept-map) are special. A report schema is identified\n with an RID (Report schema ID).
    \n 
    With this module, you can retrieve facts from an archive according to a report\n schema. You can retrieve them as a (2D) fact table, or populate the presentation\n network of the report schema with them. The concept map network will be used\n by default to map the report schema concepts to reported concepts.
    \n 
    Report schemas are stored in the collection reportschemas in\n the project's MongoDB database.
    \n 
    A report schema needs to be a syntactically valid JSound document.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://xbrl.io/modules/bizql/hypercubes", "prefix" : "hypercubes" }, { "uri" : "http://xbrl.io/modules/bizql/networks", "prefix" : "networks" }, { "uri" : "http://xbrl.io/modules/bizql/report-schemas", "prefix" : "report-schemas" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "add", "qname" : "report-schemas:add", "signature" : "($report-schema as object()) as empty-sequence()", "description" : " 
    Adds the given report schema to the database.
    \n", "summary" : "
      Adds the given report schema to the database.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "report-schema", "type" : "object()", "occurrence" : null, "description" : "
     the report schema to add.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the empty sequence." }, "errors" : [ "report-schemas:INVALID-SCHEMA if the given report schema object does not contain a name field", "report-schemas:EXISTS if a report schema with the given name already exists" ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete", "qname" : "report-schemas:delete", "signature" : "($report-schema-or-id as item()) as empty-sequence()", "description" : " 
    Deletes a report schema from the database.
    \n", "summary" : "
      Deletes a report schema from the database.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "report-schema-or-id", "type" : "item()", "occurrence" : null, "description" : "
     the report schema to delete or its RID.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the empty sequence." }, "errors" : [ "report-schemas:DOES-NOT-EXIST if no report schema with the given RID exists." ] }, { "isDocumented" : true, "arity" : 2, "name" : "fact-table", "qname" : "report-schemas:fact-table", "signature" : "($schema as item(), $archives as item()*) as array()", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a schema or its RID,
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs.
    " } ], "returns" : { "type" : "array()", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "fact-table", "qname" : "report-schemas:fact-table", "signature" : "($schema as item(), $archives as item()*, $options as object()?) as array()", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a schema or its RID,
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $report-schemas:ALL_ARCHIVES for no filtering.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "array()", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts", "qname" : "report-schemas:facts", "signature" : "($schema as item(), $archives as item()*) as object()*", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a report schema or its RID,
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $report-schemas:ALL_ARCHIVES for no filtering.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "facts", "qname" : "report-schemas:facts", "signature" : "($schema as item(), $archives as item()*, $options as object()?) as object()*", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied schema, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
     a report schema or its RID,
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $report-schemas:ALL_ARCHIVES for no filtering.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "populate-with-facts", "qname" : "report-schemas:populate-with-facts", "signature" : "($schema as item(), $archives as item()*) as object()*", "description" : " 
    Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema. Default dimension values are added to the facts\n when missing.
    \n", "summary" : "
      Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
    .
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $report-schemas:ALL_ARCHIVES for no filtering.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "populate-with-facts", "qname" : "report-schemas:populate-with-facts", "signature" : "($schema as item(), $archives as item()*, $options as object()?) as object()*", "description" : " 
    Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema. Default dimension values are added to the facts\n when missing.
    \n", "summary" : "
      Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied schema.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schema", "type" : "item()", "occurrence" : null, "description" : "
    .
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $report-schemas:ALL_ARCHIVES for no filtering.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "report-schemas", "qname" : "report-schemas:report-schemas", "signature" : "() as object()*", "description" : " 
    Retrieves all report schemas.
    \n", "summary" : "
      Retrieves all report schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "all report schemas." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "report-schemas", "qname" : "report-schemas:report-schemas", "signature" : "($report-schemas-or-ids as item()*) as object()*", "description" : " 
    Return the report schemas with the given names (RIDs).
    \n", "summary" : "
      Return the report schemas with the given names (RIDs).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "report-schemas-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the ids of the report schemas (RIDs) or the report schemas themselves.
    " } ], "returns" : { "type" : "object()*", "description" : "the report schemas with the given RIDs or the empty sequence if no report schema was found or the input is an empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "rid", "qname" : "report-schemas:rid", "signature" : "($report-schema-or-id as item()) as atomic", "description" : " 
    Converts the input to a normalized report schema identifier (RID). The input\n can be either a pure RID, or a report schema object which contains an RID.
    \n", "summary" : "
      Converts the input to a normalized report schema identifier (RID).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "report-schema-or-id", "type" : "item()", "occurrence" : null, "description" : "
     a report schema identifier (RID)) or a report schema object.
    " } ], "returns" : { "type" : "atomic", "description" : "the normalized RID." }, "errors" : [ "report-schemas:INVALID_PARAMETER if the RID or report schema is not valid" ] }, { "isDocumented" : true, "arity" : 1, "name" : "update", "qname" : "report-schemas:update", "signature" : "($report-schema as object()) as empty-sequence()", "description" : " 
    Updates a report schema.
    \n 
    Replaces a report schema in the database with the given schema.\n The schema to be replaced is identified by the value of the _id\n field of the given schema (RID).
    \n", "summary" : "
      Updates a report schema.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "report-schema", "type" : "object()", "occurrence" : null, "description" : "
     the new report schema
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the empty sequence" }, "errors" : [ "report-schemas:DOES-NOT-EXIST if a report schema with the given name does not exist." ] } ], "variables" : [ { "name" : "report-schemas:col", "type" : "string", "description" : " Name of the collection the report schemas are stored in.\n" }, { "name" : "report-schemas:ALL_ARCHIVES", "type" : "boolean", "description" : " Joker for all archives.\n" } ] }, "http://zorba.io/modules/store/static/integrity-constraints/ddl" : { "ns" : "http://zorba.io/modules/store/static/integrity-constraints/ddl", "description" : " This module defines a set of functions to manage integrity constraints\n that are declared in the prolog of a module.\n For example, it provides functions to activate or deactivate integrity\n constraints.\n 
    \n This module is part of\n Zorba's XQuery Data Definition Facility.\n All the integrity constraints managed by this module have to be pre-declared\n in the prolog of a module.\n Please refer to the\n general documentation\n for more information and examples.\n", "sees" : [ "Data Lifecycle", "XQuery Data Definition Facility", "http://zorba.io/modules/store/static/collections/dml", "http://zorba.io/modules/store/static/collections/ddl", "http://zorba.io/modules/store/static/indexes/ddl", "http://zorba.io/modules/store/static/indexes/dml", "http://zorba.io/modules/store/static/integrity-constraints/dml", "http://zorba.io/errors" ], "authors" : [ "Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/store/static/integrity-constraints/ddl", "prefix" : "icddl" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "activate", "qname" : "icddl:activate", "signature" : "($name as xs:QName) external", "description" : " Activates an integrity constraint in the dynamic context.\n", "summary" : "
     Activates an integrity constraint in the dynamic context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the integrity constraint to activate.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that consists of a upd:activateIntegrityConstraint($name) update primitive." }, "errors" : [ "zerr:ZDDY0031 if the integrity constraint does not exist in the static context." ] }, { "isDocumented" : true, "arity" : 0, "name" : "activated-integrity-constraints", "qname" : "icddl:activated-integrity-constraints", "signature" : "() as xs:QName* external", "description" : " Gets the integrity constraints that are activated, if any.\n", "summary" : "
     Gets the integrity constraints that are activated, if any.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each activated integrity constraint, or an empty sequence if none." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "deactivate", "qname" : "icddl:deactivate", "signature" : "($name as xs:QName) external", "description" : " Deactivates the integrity constraint.\n", "summary" : "
     Deactivates the integrity constraint.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the integrity constraint to deactivate.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deactivates the integrity constraint." }, "errors" : [ "zerr:ZDDY0032 if the integrity constraint was not declared in the the static context.", "zerr:ZDDY0032 if the integrity constraints is not activated." ] }, { "isDocumented" : true, "arity" : 0, "name" : "declared-integrity-constraints", "qname" : "icddl:declared-integrity-constraints", "signature" : "() as xs:QName* external", "description" : " Gets the sequence of QNames representing the integrity constraints that have\n been declared in the prolog of the static context.\n", "summary" : "
     Gets the sequence of QNames representing the integrity constraints that have\n been declared in the prolog of the static context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:QName*", "description" : "A sequence of QNames, one for each created integrity constraints, or an emtpy sequence if none." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-activated-integrity-constraint", "qname" : "icddl:is-activated-integrity-constraint", "signature" : "($name as xs:QName) as xs:boolean external", "description" : " Gets whether an integrity constraints is activated.\n", "summary" : "
     Gets whether an integrity constraints is activated.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the constraint to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the integrity constraint is activated; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-declared-integrity-constraint", "qname" : "icddl:is-declared-integrity-constraint", "signature" : "($name as xs:QName) as xs:boolean external", "description" : " Gets whether an integrity constraint is declared in the prolog of the static\n context.\n", "summary" : "
     Gets whether an integrity constraint is declared in the prolog of the static\n context.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the constraint to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the constraint is declared; false otherwise." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.functx.com" : { "ns" : "http://www.functx.com", "description" : " --------------------------------\n The FunctX XQuery Function Library\n --------------------------------\n Copyright (C) 2007 Datypic\n This library is free software; you can redistribute it and/or\n modify it under the terms of the GNU Lesser General Public\n License as published by the Free Software Foundation; either\n version 2.1 of the License.\n This library is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n Lesser General Public License for more details.\n You should have received a copy of the GNU Lesser General Public\n License along with this library; if not, write to the Free Software\n Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA\n For more information on the FunctX XQuery library, contact contrib@functx.com.\n", "sees" : [ "http://www.xqueryfunctions.com" ], "authors" : [  ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.functx.com", "prefix" : "functx" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "add-attributes", "qname" : "functx:add-attributes", "signature" : "($elements as element(*)*, $attrNames as xs:QName*, $attrValues as xs:anyAtomicType*) as element(*)?", "description" : " Adds attributes to XML elements\n", "summary" : "
     Adds attributes to XML elements\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the element(s) to which you wish to add the attribute
    " }, { "name" : "attrNames", "type" : "xs:QName", "occurrence" : "*", "description" : "
     the name(s) of the attribute(s) to add
    " }, { "name" : "attrValues", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the value(s) of the attribute(s) to add
    " } ], "returns" : { "type" : "element(*)?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "add-months", "qname" : "functx:add-months", "signature" : "($date as xs:anyAtomicType?, $months as xs:integer) as xs:date?", "description" : " Adds months to a date\n", "summary" : "
     Adds months to a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " }, { "name" : "months", "type" : "xs:integer", "occurrence" : null, "description" : "
     the number of months to add
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "add-or-update-attributes", "qname" : "functx:add-or-update-attributes", "signature" : "($elements as element(*)*, $attrNames as xs:QName*, $attrValues as xs:anyAtomicType*) as element(*)?", "description" : " Adds attributes to XML elements\n", "summary" : "
     Adds attributes to XML elements\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the element(s) to which you wish to add the attribute
    " }, { "name" : "attrNames", "type" : "xs:QName", "occurrence" : "*", "description" : "
     the name(s) of the attribute(s) to add
    " }, { "name" : "attrValues", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the value(s) of the attribute(s) to add
    " } ], "returns" : { "type" : "element(*)?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "all-whitespace", "qname" : "functx:all-whitespace", "signature" : "($arg as xs:string?) as xs:boolean", "description" : " Whether a value is all whitespace or a zero-length string\n", "summary" : "
     Whether a value is all whitespace or a zero-length string\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string (or node) to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "are-distinct-values", "qname" : "functx:are-distinct-values", "signature" : "($seq as xs:anyAtomicType*) as xs:boolean", "description" : " Whether all the values in a sequence are distinct\n", "summary" : "
     Whether all the values in a sequence are distinct\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of values
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "atomic-type", "qname" : "functx:atomic-type", "signature" : "($values as xs:anyAtomicType*) as xs:string*", "description" : " The built-in type of an atomic value\n", "summary" : "
     The built-in type of an atomic value\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "values", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the value(s) whose type you want to determine
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "avg-empty-is-zero", "qname" : "functx:avg-empty-is-zero", "signature" : "($values as xs:anyAtomicType*, $allNodes as node()*) as xs:double", "description" : " The average, counting \"empty\" values as zero\n", "summary" : "
     The average, counting \"empty\" values as zero\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "values", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the values to be averaged
    " }, { "name" : "allNodes", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of all nodes to find the average over
    " } ], "returns" : { "type" : "xs:double", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "between-exclusive", "qname" : "functx:between-exclusive", "signature" : "($value as xs:anyAtomicType?, $minValue as xs:anyAtomicType, $maxValue as xs:anyAtomicType) as xs:boolean", "description" : " Whether a value is between two provided values\n", "summary" : "
     Whether a value is between two provided values\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value to be tested
    " }, { "name" : "minValue", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the minimum value
    " }, { "name" : "maxValue", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the maximum value
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "between-inclusive", "qname" : "functx:between-inclusive", "signature" : "($value as xs:anyAtomicType?, $minValue as xs:anyAtomicType, $maxValue as xs:anyAtomicType) as xs:boolean", "description" : " Whether a value is between two provided values, or equal to one of them\n", "summary" : "
     Whether a value is between two provided values, or equal to one of them\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value to be tested
    " }, { "name" : "minValue", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the minimum value
    " }, { "name" : "maxValue", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the maximum value
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "camel-case-to-words", "qname" : "functx:camel-case-to-words", "signature" : "($arg as xs:string?, $delim as xs:string) as xs:string", "description" : " Turns a camelCase string into space-separated words\n", "summary" : "
     Turns a camelCase string into space-separated words\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to modify
    " }, { "name" : "delim", "type" : "xs:string", "occurrence" : null, "description" : "
     the delimiter for the words (e.g. a space)
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "capitalize-first", "qname" : "functx:capitalize-first", "signature" : "($arg as xs:string?) as xs:string?", "description" : " Capitalizes the first character of a string\n", "summary" : "
     Capitalizes the first character of a string\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the word or phrase to capitalize
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "change-element-names-deep", "qname" : "functx:change-element-names-deep", "signature" : "($nodes as node()*, $oldNames as xs:QName*, $newNames as xs:QName*) as node()*", "description" : " Changes the names of elements in an XML fragment\n", "summary" : "
     Changes the names of elements in an XML fragment\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the element(s) to change
    " }, { "name" : "oldNames", "type" : "xs:QName", "occurrence" : "*", "description" : "
     the sequence of names to change from
    " }, { "name" : "newNames", "type" : "xs:QName", "occurrence" : "*", "description" : "
     the sequence of names to change to
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "change-element-ns-deep", "qname" : "functx:change-element-ns-deep", "signature" : "($nodes as node()*, $newns as xs:string, $prefix as xs:string) as node()*", "description" : " Changes the namespace of XML elements and its descendants\n", "summary" : "
     Changes the namespace of XML elements and its descendants\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the nodes to change
    " }, { "name" : "newns", "type" : "xs:string", "occurrence" : null, "description" : "
     the new namespace
    " }, { "name" : "prefix", "type" : "xs:string", "occurrence" : null, "description" : "
     the prefix to use for the new namespace
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "change-element-ns", "qname" : "functx:change-element-ns", "signature" : "($elements as element(*)*, $newns as xs:string, $prefix as xs:string) as element(*)?", "description" : " Changes the namespace of XML elements\n", "summary" : "
     Changes the namespace of XML elements\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the elements to change
    " }, { "name" : "newns", "type" : "xs:string", "occurrence" : null, "description" : "
     the new namespace
    " }, { "name" : "prefix", "type" : "xs:string", "occurrence" : null, "description" : "
     the prefix to use for the new namespace
    " } ], "returns" : { "type" : "element(*)?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "chars", "qname" : "functx:chars", "signature" : "($arg as xs:string?) as xs:string*", "description" : " Converts a string to a sequence of characters\n", "summary" : "
     Converts a string to a sequence of characters\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to split
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "contains-any-of", "qname" : "functx:contains-any-of", "signature" : "($arg as xs:string?, $searchStrings as xs:string*) as xs:boolean", "description" : " Whether a string contains any of a sequence of strings\n", "summary" : "
     Whether a string contains any of a sequence of strings\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to test
    " }, { "name" : "searchStrings", "type" : "xs:string", "occurrence" : "*", "description" : "
     the strings to look for
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "contains-case-insensitive", "qname" : "functx:contains-case-insensitive", "signature" : "($arg as xs:string?, $substring as xs:string) as xs:boolean?", "description" : " Whether one string contains another, without regard to case\n", "summary" : "
     Whether one string contains another, without regard to case\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to search
    " }, { "name" : "substring", "type" : "xs:string", "occurrence" : null, "description" : "
     the substring to find
    " } ], "returns" : { "type" : "xs:boolean?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "contains-word", "qname" : "functx:contains-word", "signature" : "($arg as xs:string?, $word as xs:string) as xs:boolean", "description" : " Whether one string contains another, as a separate word\n", "summary" : "
     Whether one string contains another, as a separate word\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to search
    " }, { "name" : "word", "type" : "xs:string", "occurrence" : null, "description" : "
     the word to find
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "copy-attributes", "qname" : "functx:copy-attributes", "signature" : "($copyTo as element(*), $copyFrom as element(*)) as element(*)", "description" : " Copies attributes from one element to another\n", "summary" : "
     Copies attributes from one element to another\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "copyTo", "type" : "element(*)", "occurrence" : null, "description" : "
     the element to copy attributes to
    " }, { "name" : "copyFrom", "type" : "element(*)", "occurrence" : null, "description" : "
     the element to copy attributes from
    " } ], "returns" : { "type" : "element(*)", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "date", "qname" : "functx:date", "signature" : "($year as xs:anyAtomicType, $month as xs:anyAtomicType, $day as xs:anyAtomicType) as xs:date", "description" : " Construct a date from a year, month and day\n", "summary" : "
     Construct a date from a year, month and day\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "year", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the year
    " }, { "name" : "month", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the month
    " }, { "name" : "day", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the day
    " } ], "returns" : { "type" : "xs:date", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "dateTime", "qname" : "functx:dateTime", "signature" : "($year as xs:anyAtomicType, $month as xs:anyAtomicType, $day as xs:anyAtomicType, $hour as xs:anyAtomicType, $minute as xs:anyAtomicType, $second as xs:anyAtomicType) as xs:dateTime", "description" : " Construct a date/time from individual components\n", "summary" : "
     Construct a date/time from individual components\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "year", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the year
    " }, { "name" : "month", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the month
    " }, { "name" : "day", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the day
    " }, { "name" : "hour", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the hour
    " }, { "name" : "minute", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the minute
    " }, { "name" : "second", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the second
    " } ], "returns" : { "type" : "xs:dateTime", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day-in-year", "qname" : "functx:day-in-year", "signature" : "($date as xs:anyAtomicType?) as xs:integer?", "description" : " The day of the year (a number between 1 and 366)\n", "summary" : "
     The day of the year (a number between 1 and 366)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day-of-week-abbrev-en", "qname" : "functx:day-of-week-abbrev-en", "signature" : "($date as xs:anyAtomicType?) as xs:string?", "description" : " The abbreviated day of the week, from a date, in English\n", "summary" : "
     The abbreviated day of the week, from a date, in English\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day-of-week-name-en", "qname" : "functx:day-of-week-name-en", "signature" : "($date as xs:anyAtomicType?) as xs:string?", "description" : " The name of the day of the week, from a date, in English\n", "summary" : "
     The name of the day of the week, from a date, in English\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "day-of-week", "qname" : "functx:day-of-week", "signature" : "($date as xs:anyAtomicType?) as xs:integer?", "description" : " The day of the week, from a date\n", "summary" : "
     The day of the week, from a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "dayTimeDuration", "qname" : "functx:dayTimeDuration", "signature" : "($days as xs:decimal?, $hours as xs:decimal?, $minutes as xs:decimal?, $seconds as xs:decimal?) as xs:dayTimeDuration", "description" : " Construct a dayTimeDuration from a number of days, hours, etc.\n", "summary" : "
     Construct a dayTimeDuration from a number of days, hours, etc.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "days", "type" : "xs:decimal", "occurrence" : "?", "description" : "
     the number of days
    " }, { "name" : "hours", "type" : "xs:decimal", "occurrence" : "?", "description" : "
     the number of hours
    " }, { "name" : "minutes", "type" : "xs:decimal", "occurrence" : "?", "description" : "
     the number of minutes
    " }, { "name" : "seconds", "type" : "xs:decimal", "occurrence" : "?", "description" : "
     the number of seconds
    " } ], "returns" : { "type" : "xs:dayTimeDuration", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "days-in-month", "qname" : "functx:days-in-month", "signature" : "($date as xs:anyAtomicType?) as xs:integer?", "description" : " Number of days in the month\n", "summary" : "
     Number of days in the month\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "depth-of-node", "qname" : "functx:depth-of-node", "signature" : "($node as node()?) as xs:integer", "description" : " The depth (level) of a node in an XML tree\n", "summary" : "
     The depth (level) of a node in an XML tree\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node to check
    " } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct-attribute-names", "qname" : "functx:distinct-attribute-names", "signature" : "($nodes as node()*) as xs:string*", "description" : " The distinct names of all attributes in an XML fragment\n", "summary" : "
     The distinct names of all attributes in an XML fragment\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the root to start from
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct-deep", "qname" : "functx:distinct-deep", "signature" : "($nodes as node()*) as node()*", "description" : " The XML nodes with distinct values, taking into account attributes and descendants\n", "summary" : "
     The XML nodes with distinct values, taking into account attributes and descendants\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to test
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct-element-names", "qname" : "functx:distinct-element-names", "signature" : "($nodes as node()*) as xs:string*", "description" : " The distinct names of all elements in an XML fragment\n", "summary" : "
     The distinct names of all elements in an XML fragment\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the root(s) to start from
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct-element-paths", "qname" : "functx:distinct-element-paths", "signature" : "($nodes as node()*) as xs:string*", "description" : " The distinct paths of all descendant elements in an XML fragment\n", "summary" : "
     The distinct paths of all descendant elements in an XML fragment\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the root(s) to start from
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct-nodes", "qname" : "functx:distinct-nodes", "signature" : "($nodes as node()*) as node()*", "description" : " The distinct XML nodes in a sequence (by node identity)\n", "summary" : "
     The distinct XML nodes in a sequence (by node identity)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the node sequence
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "duration-from-timezone", "qname" : "functx:duration-from-timezone", "signature" : "($timezone as xs:string) as xs:dayTimeDuration", "description" : " Converts a timezone like \"-05:00\" or \"Z\" into xs:dayTimeDuration\n", "summary" : "
     Converts a timezone like \"-05:00\" or \"Z\" into xs:dayTimeDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "timezone", "type" : "xs:string", "occurrence" : null, "description" : "
     the time zone, in (+|-)HH:MM format
    " } ], "returns" : { "type" : "xs:dayTimeDuration", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "dynamic-path", "qname" : "functx:dynamic-path", "signature" : "($parent as node(), $path as xs:string) as item()*", "description" : " Dynamically evaluates a simple XPath path\n", "summary" : "
     Dynamically evaluates a simple XPath path\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "parent", "type" : "node()", "occurrence" : null, "description" : "
     the root to start from
    " }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "
     the path expression
    " } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "escape-for-regex", "qname" : "functx:escape-for-regex", "signature" : "($arg as xs:string?) as xs:string", "description" : " Escapes regex special characters\n", "summary" : "
     Escapes regex special characters\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to escape
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "exclusive-or", "qname" : "functx:exclusive-or", "signature" : "($arg1 as xs:boolean?, $arg2 as xs:boolean?) as xs:boolean?", "description" : " Whether one (and only one) of two boolean values is true\n", "summary" : "
     Whether one (and only one) of two boolean values is true\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     the first boolean value
    " }, { "name" : "arg2", "type" : "xs:boolean", "occurrence" : "?", "description" : "
     the second boolean value
    " } ], "returns" : { "type" : "xs:boolean?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "first-day-of-month", "qname" : "functx:first-day-of-month", "signature" : "($date as xs:anyAtomicType?) as xs:date?", "description" : " The first day of the month of a date\n", "summary" : "
     The first day of the month of a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "first-day-of-year", "qname" : "functx:first-day-of-year", "signature" : "($date as xs:anyAtomicType?) as xs:date?", "description" : " The first day of the year of a date\n", "summary" : "
     The first day of the year of a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "first-node", "qname" : "functx:first-node", "signature" : "($nodes as node()*) as node()?", "description" : " The XML node in a sequence that appears first in document order\n", "summary" : "
     The XML node in a sequence that appears first in document order\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes
    " } ], "returns" : { "type" : "node()?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "follows-not-descendant", "qname" : "functx:follows-not-descendant", "signature" : "($a as node()?, $b as node()?) as xs:boolean", "description" : " Whether an XML node follows another without being its descendant\n", "summary" : "
     Whether an XML node follows another without being its descendant\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "a", "type" : "node()", "occurrence" : "?", "description" : "
     the first node
    " }, { "name" : "b", "type" : "node()", "occurrence" : "?", "description" : "
     the second node
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "format-as-title-en", "qname" : "functx:format-as-title-en", "signature" : "($titles as xs:string*) as xs:string*", "description" : " Moves title words like \"the\" and \"a\" to the end of strings\n", "summary" : "
     Moves title words like \"the\" and \"a\" to the end of strings\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "titles", "type" : "xs:string", "occurrence" : "*", "description" : "
     the titles to format
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "fragment-from-uri", "qname" : "functx:fragment-from-uri", "signature" : "($uri as xs:string?) as xs:string?", "description" : " Returns the fragment from a URI\n", "summary" : "
     Returns the fragment from a URI\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : "?", "description" : "
     the URI
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "get-matches-and-non-matches", "qname" : "functx:get-matches-and-non-matches", "signature" : "($string as xs:string?, $regex as xs:string) as element(*)*", "description" : " Splits a string into matching and non-matching regions\n", "summary" : "
     Splits a string into matching and non-matching regions\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to split
    " }, { "name" : "regex", "type" : "xs:string", "occurrence" : null, "description" : "
     the pattern
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "get-matches", "qname" : "functx:get-matches", "signature" : "($string as xs:string?, $regex as xs:string) as xs:string*", "description" : " Return the matching regions of a string\n", "summary" : "
     Return the matching regions of a string\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to split
    " }, { "name" : "regex", "type" : "xs:string", "occurrence" : null, "description" : "
     the pattern
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "has-element-only-content", "qname" : "functx:has-element-only-content", "signature" : "($element as element(*)) as xs:boolean", "description" : " Whether an element has element-only content\n", "summary" : "
     Whether an element has element-only content\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "
     the XML element to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "has-empty-content", "qname" : "functx:has-empty-content", "signature" : "($element as element(*)) as xs:boolean", "description" : " Whether an element has empty content\n", "summary" : "
     Whether an element has empty content\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "
     the XML element to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "has-mixed-content", "qname" : "functx:has-mixed-content", "signature" : "($element as element(*)) as xs:boolean", "description" : " Whether an element has mixed content\n", "summary" : "
     Whether an element has mixed content\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "
     the XML element to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "has-simple-content", "qname" : "functx:has-simple-content", "signature" : "($element as element(*)) as xs:boolean", "description" : " Whether an element has simple content\n", "summary" : "
     Whether an element has simple content\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : null, "description" : "
     the XML element to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "id-from-element", "qname" : "functx:id-from-element", "signature" : "($element as element(*)?) as xs:string?", "description" : " Gets the ID of an XML element\n", "summary" : "
     Gets the ID of an XML element\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : "?", "description" : "
     the element
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "id-untyped", "qname" : "functx:id-untyped", "signature" : "($node as node()*, $id as xs:anyAtomicType) as element(*)*", "description" : " Gets XML element(s) that have an attribute with a particular value\n", "summary" : "
     Gets XML element(s) that have an attribute with a particular value\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "*", "description" : "
     the root node(s) to start from
    " }, { "name" : "id", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the \"id\" to find
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "if-absent", "qname" : "functx:if-absent", "signature" : "($arg as item()*, $value as item()*) as item()*", "description" : " The first argument if it is not empty, otherwise the second argument\n", "summary" : "
     The first argument if it is not empty, otherwise the second argument\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "*", "description" : "
     the item(s) that may be absent
    " }, { "name" : "value", "type" : "item()", "occurrence" : "*", "description" : "
     the item(s) to use if the item is absent
    " } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "if-empty", "qname" : "functx:if-empty", "signature" : "($arg as item()?, $value as item()*) as item()*", "description" : " The first argument if it is not blank, otherwise the second argument\n", "summary" : "
     The first argument if it is not blank, otherwise the second argument\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : "?", "description" : "
     the node that may be empty
    " }, { "name" : "value", "type" : "item()", "occurrence" : "*", "description" : "
     the item(s) to use if the node is empty
    " } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of-deep-equal-node", "qname" : "functx:index-of-deep-equal-node", "signature" : "($nodes as node()*, $nodeToFind as node()) as xs:integer*", "description" : " The position of a node in a sequence, based on contents and attributes\n", "summary" : "
     The position of a node in a sequence, based on contents and attributes\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the node sequence
    " }, { "name" : "nodeToFind", "type" : "node()", "occurrence" : null, "description" : "
     the node to find in the sequence
    " } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of-match-first", "qname" : "functx:index-of-match-first", "signature" : "($arg as xs:string?, $pattern as xs:string) as xs:integer?", "description" : " The first position of a matching substring\n", "summary" : "
     The first position of a matching substring\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     the pattern to match
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of-node", "qname" : "functx:index-of-node", "signature" : "($nodes as node()*, $nodeToFind as node()) as xs:integer*", "description" : " The position of a node in a sequence, based on node identity\n", "summary" : "
     The position of a node in a sequence, based on node identity\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the node sequence
    " }, { "name" : "nodeToFind", "type" : "node()", "occurrence" : null, "description" : "
     the node to find in the sequence
    " } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of-string-first", "qname" : "functx:index-of-string-first", "signature" : "($arg as xs:string?, $substring as xs:string) as xs:integer?", "description" : " The first position of a substring\n", "summary" : "
     The first position of a substring\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string
    " }, { "name" : "substring", "type" : "xs:string", "occurrence" : null, "description" : "
     the substring to find
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of-string-last", "qname" : "functx:index-of-string-last", "signature" : "($arg as xs:string?, $substring as xs:string) as xs:integer?", "description" : " The last position of a substring\n", "summary" : "
     The last position of a substring\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string
    " }, { "name" : "substring", "type" : "xs:string", "occurrence" : null, "description" : "
     the substring to find
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "index-of-string", "qname" : "functx:index-of-string", "signature" : "($arg as xs:string?, $substring as xs:string) as xs:integer*", "description" : " The position(s) of a substring\n", "summary" : "
     The position(s) of a substring\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string
    " }, { "name" : "substring", "type" : "xs:string", "occurrence" : null, "description" : "
     the substring to find
    " } ], "returns" : { "type" : "xs:integer*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "insert-string", "qname" : "functx:insert-string", "signature" : "($originalString as xs:string?, $stringToInsert as xs:string?, $pos as xs:integer) as xs:string", "description" : " Inserts a string at a specified position\n", "summary" : "
     Inserts a string at a specified position\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "originalString", "type" : "xs:string", "occurrence" : "?", "description" : "
     the original string to insert into
    " }, { "name" : "stringToInsert", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to insert
    " }, { "name" : "pos", "type" : "xs:integer", "occurrence" : null, "description" : "
     the position
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-a-number", "qname" : "functx:is-a-number", "signature" : "($value as xs:anyAtomicType?) as xs:boolean", "description" : " Whether a value is numeric\n", "summary" : "
     Whether a value is numeric\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the value to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-absolute-uri", "qname" : "functx:is-absolute-uri", "signature" : "($uri as xs:string?) as xs:boolean", "description" : " Whether a URI is absolute\n", "summary" : "
     Whether a URI is absolute\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : "?", "description" : "
     the URI to test
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-ancestor", "qname" : "functx:is-ancestor", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean", "description" : " Whether an XML node is an ancestor of another node\n", "summary" : "
     Whether an XML node is an ancestor of another node\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the first node
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the second node
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-descendant", "qname" : "functx:is-descendant", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean", "description" : " Whether an XML node is a descendant of another node\n", "summary" : "
     Whether an XML node is a descendant of another node\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the first node
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the second node
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-leap-year", "qname" : "functx:is-leap-year", "signature" : "($date as xs:anyAtomicType?) as xs:boolean", "description" : " Whether a date falls in a leap year\n", "summary" : "
     Whether a date falls in a leap year\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date or year
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-node-among-descendants-deep-equal", "qname" : "functx:is-node-among-descendants-deep-equal", "signature" : "($node as node()?, $seq as node()*) as xs:boolean", "description" : " Whether an XML node is among the descendants of a sequence, based on contents and attributes\n", "summary" : "
     Whether an XML node is among the descendants of a sequence, based on contents and attributes\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node to test
    " }, { "name" : "seq", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to search
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-node-among-descendants", "qname" : "functx:is-node-among-descendants", "signature" : "($node as node()?, $seq as node()*) as xs:boolean", "description" : " Whether an XML node is among the descendants of a sequence, based on node identity\n", "summary" : "
     Whether an XML node is among the descendants of a sequence, based on node identity\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node to test
    " }, { "name" : "seq", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to search
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-node-in-sequence-deep-equal", "qname" : "functx:is-node-in-sequence-deep-equal", "signature" : "($node as node()?, $seq as node()*) as xs:boolean", "description" : " Whether an XML node is in a sequence, based on contents and attributes\n", "summary" : "
     Whether an XML node is in a sequence, based on contents and attributes\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node to test
    " }, { "name" : "seq", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to search
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-node-in-sequence", "qname" : "functx:is-node-in-sequence", "signature" : "($node as node()?, $seq as node()*) as xs:boolean", "description" : " Whether an XML node is in a sequence, based on node identity\n", "summary" : "
     Whether an XML node is in a sequence, based on node identity\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node to test
    " }, { "name" : "seq", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to search
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-value-in-sequence", "qname" : "functx:is-value-in-sequence", "signature" : "($value as xs:anyAtomicType?, $seq as xs:anyAtomicType*) as xs:boolean", "description" : " Whether an atomic value appears in a sequence\n", "summary" : "
     Whether an atomic value appears in a sequence\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the atomic value to test
    " }, { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of values to search
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "last-day-of-month", "qname" : "functx:last-day-of-month", "signature" : "($date as xs:anyAtomicType?) as xs:date?", "description" : " The last day of the month of a date\n", "summary" : "
     The last day of the month of a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "last-day-of-year", "qname" : "functx:last-day-of-year", "signature" : "($date as xs:anyAtomicType?) as xs:date?", "description" : " The last day of the month of a date\n", "summary" : "
     The last day of the month of a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "last-node", "qname" : "functx:last-node", "signature" : "($nodes as node()*) as node()?", "description" : " The XML node in a sequence that is last in document order\n", "summary" : "
     The XML node in a sequence that is last in document order\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes
    " } ], "returns" : { "type" : "node()?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "leaf-elements", "qname" : "functx:leaf-elements", "signature" : "($root as node()?) as element(*)*", "description" : " All XML elements that don't have any child elements\n", "summary" : "
     All XML elements that don't have any child elements\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "root", "type" : "node()", "occurrence" : "?", "description" : "
     the root
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "left-trim", "qname" : "functx:left-trim", "signature" : "($arg as xs:string?) as xs:string", "description" : " Trims leading whitespace\n", "summary" : "
     Trims leading whitespace\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to trim
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "line-count", "qname" : "functx:line-count", "signature" : "($arg as xs:string?) as xs:integer", "description" : " The number of lines\n", "summary" : "
     The number of lines\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to test
    " } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "lines", "qname" : "functx:lines", "signature" : "($arg as xs:string?) as xs:string*", "description" : " Split a string into separate lines\n", "summary" : "
     Split a string into separate lines\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to split
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "max-depth", "qname" : "functx:max-depth", "signature" : "($root as node()?) as xs:integer?", "description" : " The maximum depth of elements in an XML tree\n", "summary" : "
     The maximum depth of elements in an XML tree\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "root", "type" : "node()", "occurrence" : "?", "description" : "
     the root to start from
    " } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "max-determine-type", "qname" : "functx:max-determine-type", "signature" : "($seq as xs:anyAtomicType*) as xs:anyAtomicType?", "description" : " The maximum value in a sequence, figuring out its type (numeric or string)\n", "summary" : "
     The maximum value in a sequence, figuring out its type (numeric or string)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of values to test
    " } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "max-line-length", "qname" : "functx:max-line-length", "signature" : "($arg as xs:string?) as xs:integer", "description" : " The maximum line length\n", "summary" : "
     The maximum line length\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to test
    " } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "max-node", "qname" : "functx:max-node", "signature" : "($nodes as node()*) as node()*", "description" : " The XML node whose typed value is the maximum\n", "summary" : "
     The XML node whose typed value is the maximum\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to test
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "max-string", "qname" : "functx:max-string", "signature" : "($strings as xs:anyAtomicType*) as xs:string?", "description" : " The maximum of a sequence of values, treating them like strings\n", "summary" : "
     The maximum of a sequence of values, treating them like strings\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "strings", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of values
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "min-determine-type", "qname" : "functx:min-determine-type", "signature" : "($seq as xs:anyAtomicType*) as xs:anyAtomicType?", "description" : " The minimum value in a sequence, figuring out its type (numeric or string)\n", "summary" : "
     The minimum value in a sequence, figuring out its type (numeric or string)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of values to test
    " } ], "returns" : { "type" : "xs:anyAtomicType?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "min-node", "qname" : "functx:min-node", "signature" : "($nodes as node()*) as node()*", "description" : " The XML node whose typed value is the minimum\n", "summary" : "
     The XML node whose typed value is the minimum\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence of nodes to test
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "min-non-empty-string", "qname" : "functx:min-non-empty-string", "signature" : "($strings as xs:string*) as xs:string?", "description" : " The minimum of a sequence of strings, ignoring \"empty\" values\n", "summary" : "
     The minimum of a sequence of strings, ignoring \"empty\" values\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "strings", "type" : "xs:string", "occurrence" : "*", "description" : "
     the sequence of strings to search
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "min-string", "qname" : "functx:min-string", "signature" : "($strings as xs:anyAtomicType*) as xs:string?", "description" : " The minimum of a sequence of values, treating them like strings\n", "summary" : "
     The minimum of a sequence of values, treating them like strings\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "strings", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of strings
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "mmddyyyy-to-date", "qname" : "functx:mmddyyyy-to-date", "signature" : "($dateString as xs:string?) as xs:date?", "description" : " Converts a string with format MMDDYYYY (with any delimiters) to a date\n", "summary" : "
     Converts a string with format MMDDYYYY (with any delimiters) to a date\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dateString", "type" : "xs:string", "occurrence" : "?", "description" : "
     the MMDDYYYY string
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "month-abbrev-en", "qname" : "functx:month-abbrev-en", "signature" : "($date as xs:anyAtomicType?) as xs:string?", "description" : " The month of a date as an abbreviated word (Jan, Feb, etc.)\n", "summary" : "
     The month of a date as an abbreviated word (Jan, Feb, etc.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "month-name-en", "qname" : "functx:month-name-en", "signature" : "($date as xs:anyAtomicType?) as xs:string?", "description" : " The month of a date as a word (January, February, etc.)\n", "summary" : "
     The month of a date as a word (January, February, etc.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "name-test", "qname" : "functx:name-test", "signature" : "($testname as xs:string?, $names as xs:string*) as xs:boolean", "description" : " Whether a name matches a list of names or name wildcards\n", "summary" : "
     Whether a name matches a list of names or name wildcards\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "testname", "type" : "xs:string", "occurrence" : "?", "description" : "
     the name to test
    " }, { "name" : "names", "type" : "xs:string", "occurrence" : "*", "description" : "
     the list of names or name wildcards
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "namespaces-in-use", "qname" : "functx:namespaces-in-use", "signature" : "($root as node()?) as xs:anyURI*", "description" : " A list of namespaces used in element/attribute names in an XML fragment\n", "summary" : "
     A list of namespaces used in element/attribute names in an XML fragment\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "root", "type" : "node()", "occurrence" : "?", "description" : "
     the root node to start from
    " } ], "returns" : { "type" : "xs:anyURI*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "next-day", "qname" : "functx:next-day", "signature" : "($date as xs:anyAtomicType?) as xs:date?", "description" : " The next day\n", "summary" : "
     The next day\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "node-kind", "qname" : "functx:node-kind", "signature" : "($nodes as node()*) as xs:string*", "description" : " The XML node kind (element, attribute, text, etc.)\n", "summary" : "
     The XML node kind (element, attribute, text, etc.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the node(s) whose kind you want to determine
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "non-distinct-values", "qname" : "functx:non-distinct-values", "signature" : "($seq as xs:anyAtomicType*) as xs:anyAtomicType*", "description" : " Returns any values that appear more than once in a sequence\n", "summary" : "
     Returns any values that appear more than once in a sequence\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the sequence of values
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "number-of-matches", "qname" : "functx:number-of-matches", "signature" : "($arg as xs:string?, $pattern as xs:string) as xs:integer", "description" : " The number of regions that match a pattern\n", "summary" : "
     The number of regions that match a pattern\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to test
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     the regular expression
    " } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "ordinal-number-en", "qname" : "functx:ordinal-number-en", "signature" : "($num as xs:integer?) as xs:string", "description" : " Reformats a number as an ordinal number, e.g. 1st, 2nd, 3rd.\n", "summary" : "
     Reformats a number as an ordinal number, e.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "num", "type" : "xs:integer", "occurrence" : "?", "description" : "
     the number
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "pad-integer-to-length", "qname" : "functx:pad-integer-to-length", "signature" : "($integerToPad as xs:anyAtomicType?, $length as xs:integer) as xs:string", "description" : " Pads an integer to a desired length by adding leading zeros\n", "summary" : "
     Pads an integer to a desired length by adding leading zeros\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "integerToPad", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the integer to pad
    " }, { "name" : "length", "type" : "xs:integer", "occurrence" : null, "description" : "
     the desired length
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "pad-string-to-length", "qname" : "functx:pad-string-to-length", "signature" : "($stringToPad as xs:string?, $padChar as xs:string, $length as xs:integer) as xs:string", "description" : " Pads a string to a desired length\n", "summary" : "
     Pads a string to a desired length\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "stringToPad", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to pad
    " }, { "name" : "padChar", "type" : "xs:string", "occurrence" : null, "description" : "
     the character(s) to use as padding
    " }, { "name" : "length", "type" : "xs:integer", "occurrence" : null, "description" : "
     the desired length
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "path-to-node-with-pos", "qname" : "functx:path-to-node-with-pos", "signature" : "($node as node()?) as xs:string", "description" : " A unique path to an XML node (or sequence of nodes)\n", "summary" : "
     A unique path to an XML node (or sequence of nodes)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node sequence
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "path-to-node", "qname" : "functx:path-to-node", "signature" : "($nodes as node()*) as xs:string*", "description" : " A path to an XML node (or sequence of nodes)\n", "summary" : "
     A path to an XML node (or sequence of nodes)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the node sequence
    " } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "precedes-not-ancestor", "qname" : "functx:precedes-not-ancestor", "signature" : "($a as node()?, $b as node()?) as xs:boolean", "description" : " Whether an XML node precedes another without being its ancestor\n", "summary" : "
     Whether an XML node precedes another without being its ancestor\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "a", "type" : "node()", "occurrence" : "?", "description" : "
     the first node
    " }, { "name" : "b", "type" : "node()", "occurrence" : "?", "description" : "
     the second node
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "previous-day", "qname" : "functx:previous-day", "signature" : "($date as xs:anyAtomicType?) as xs:date?", "description" : " The previous day\n", "summary" : "
     The previous day\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "date", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "
     the date
    " } ], "returns" : { "type" : "xs:date?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove-attributes-deep", "qname" : "functx:remove-attributes-deep", "signature" : "($nodes as node()*, $names as xs:string*) as node()*", "description" : " Removes attributes from an XML fragment, based on name\n", "summary" : "
     Removes attributes from an XML fragment, based on name\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the root(s) to start from
    " }, { "name" : "names", "type" : "xs:string", "occurrence" : "*", "description" : "
     the names of the attributes to remove, or * for all attributes
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove-attributes", "qname" : "functx:remove-attributes", "signature" : "($elements as element(*)*, $names as xs:string*) as element(*)", "description" : " Removes attributes from an XML element, based on name\n", "summary" : "
     Removes attributes from an XML element, based on name\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the element(s) from which to remove the attributes
    " }, { "name" : "names", "type" : "xs:string", "occurrence" : "*", "description" : "
     the names of the attributes to remove, or * for all attributes
    " } ], "returns" : { "type" : "element(*)", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove-elements-deep", "qname" : "functx:remove-elements-deep", "signature" : "($nodes as node()*, $names as xs:string*) as node()*", "description" : " Removes descendant elements from an XML node, based on name\n", "summary" : "
     Removes descendant elements from an XML node, based on name\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     root(s) to start from
    " }, { "name" : "names", "type" : "xs:string", "occurrence" : "*", "description" : "
     the names of the elements to remove
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove-elements-not-contents", "qname" : "functx:remove-elements-not-contents", "signature" : "($nodes as node()*, $names as xs:string*) as node()*", "description" : " Removes descendant XML elements but keeps their content\n", "summary" : "
     Removes descendant XML elements but keeps their content\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : "node()", "occurrence" : "*", "description" : "
     the root(s) to start from
    " }, { "name" : "names", "type" : "xs:string", "occurrence" : "*", "description" : "
     the names of the elements to remove
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "remove-elements", "qname" : "functx:remove-elements", "signature" : "($elements as element(*)*, $names as xs:string*) as element(*)*", "description" : " Removes child elements from an XML node, based on name\n", "summary" : "
     Removes child elements from an XML node, based on name\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the element(s) from which you wish to remove the children
    " }, { "name" : "names", "type" : "xs:string", "occurrence" : "*", "description" : "
     the names of the child elements to remove
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "repeat-string", "qname" : "functx:repeat-string", "signature" : "($stringToRepeat as xs:string?, $count as xs:integer) as xs:string", "description" : " Repeats a string a given number of times\n", "summary" : "
     Repeats a string a given number of times\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "stringToRepeat", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to repeat
    " }, { "name" : "count", "type" : "xs:integer", "occurrence" : null, "description" : "
     the desired number of copies
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "replace-beginning", "qname" : "functx:replace-beginning", "signature" : "($arg as xs:string?, $pattern as xs:string, $replacement as xs:string) as xs:string", "description" : " Replaces the beginning of a string, up to a matched pattern\n", "summary" : "
     Replaces the beginning of a string, up to a matched pattern\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the entire string to change
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     the pattern of characters to replace up to
    " }, { "name" : "replacement", "type" : "xs:string", "occurrence" : null, "description" : "
     the replacement string
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "replace-element-values", "qname" : "functx:replace-element-values", "signature" : "($elements as element(*)*, $values as xs:anyAtomicType*) as element(*)*", "description" : " Updates the content of one or more elements\n", "summary" : "
     Updates the content of one or more elements\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the elements whose content you wish to replace
    " }, { "name" : "values", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the replacement values
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "replace-first", "qname" : "functx:replace-first", "signature" : "($arg as xs:string?, $pattern as xs:string, $replacement as xs:string) as xs:string", "description" : " Replaces the first match of a pattern\n", "summary" : "
     Replaces the first match of a pattern\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the entire string to change
    " }, { "name" : "pattern", "type" : "xs:string", "occurrence" : null, "description" : "
     the pattern of characters to replace
    " }, { "name" : "replacement", "type" : "xs:string", "occurrence" : null, "description" : "
     the replacement string
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "replace-multi", "qname" : "functx:replace-multi", "signature" : "($arg as xs:string?, $changeFrom as xs:string*, $changeTo as xs:string*) as xs:string?", "description" : " Performs multiple replacements, using pairs of replace parameters\n", "summary" : "
     Performs multiple replacements, using pairs of replace parameters\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to manipulate
    " }, { "name" : "changeFrom", "type" : "xs:string", "occurrence" : "*", "description" : "
     the sequence of strings or patterns to change from
    " }, { "name" : "changeTo", "type" : "xs:string", "occurrence" : "*", "description" : "
     the sequence of strings to change to
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "reverse-string", "qname" : "functx:reverse-string", "signature" : "($arg as xs:string?) as xs:string", "description" : " Reverses the order of characters\n", "summary" : "
     Reverses the order of characters\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to reverse
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "right-trim", "qname" : "functx:right-trim", "signature" : "($arg as xs:string?) as xs:string", "description" : " Trims trailing whitespace\n", "summary" : "
     Trims trailing whitespace\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to trim
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "scheme-from-uri", "qname" : "functx:scheme-from-uri", "signature" : "($uri as xs:string?) as xs:string?", "description" : " Returns the scheme from a URI\n", "summary" : "
     Returns the scheme from a URI\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : "?", "description" : "
     the URI
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "sequence-deep-equal", "qname" : "functx:sequence-deep-equal", "signature" : "($seq1 as item()*, $seq2 as item()*) as xs:boolean", "description" : " Whether two sequences have the same XML node content and/or values\n", "summary" : "
     Whether two sequences have the same XML node content and/or values\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "item()", "occurrence" : "*", "description" : "
     the first sequence
    " }, { "name" : "seq2", "type" : "item()", "occurrence" : "*", "description" : "
     the second sequence
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "sequence-node-equal-any-order", "qname" : "functx:sequence-node-equal-any-order", "signature" : "($seq1 as node()*, $seq2 as node()*) as xs:boolean", "description" : " Whether two sequences contain the same XML nodes, regardless of order\n", "summary" : "
     Whether two sequences contain the same XML nodes, regardless of order\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "node()", "occurrence" : "*", "description" : "
     the first sequence of nodes
    " }, { "name" : "seq2", "type" : "node()", "occurrence" : "*", "description" : "
     the second sequence of nodes
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "sequence-node-equal", "qname" : "functx:sequence-node-equal", "signature" : "($seq1 as node()*, $seq2 as node()*) as xs:boolean", "description" : " Whether two sequences contain the same XML nodes, in the same order\n", "summary" : "
     Whether two sequences contain the same XML nodes, in the same order\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq1", "type" : "node()", "occurrence" : "*", "description" : "
     the first sequence of nodes
    " }, { "name" : "seq2", "type" : "node()", "occurrence" : "*", "description" : "
     the second sequence of nodes
    " } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sequence-type", "qname" : "functx:sequence-type", "signature" : "($items as item()*) as xs:string", "description" : " The sequence type that represents a sequence of nodes or values\n", "summary" : "
     The sequence type that represents a sequence of nodes or values\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "items", "type" : "item()", "occurrence" : "*", "description" : "
     the items whose sequence type you want to determine
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "siblings-same-name", "qname" : "functx:siblings-same-name", "signature" : "($element as element(*)?) as element(*)*", "description" : " The siblings of an XML element that have the same name\n", "summary" : "
     The siblings of an XML element that have the same name\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "element", "type" : "element(*)", "occurrence" : "?", "description" : "
     the node
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "siblings", "qname" : "functx:siblings", "signature" : "($node as node()?) as node()*", "description" : " The siblings of an XML node\n", "summary" : "
     The siblings of an XML node\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : "?", "description" : "
     the node
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sort-as-numeric", "qname" : "functx:sort-as-numeric", "signature" : "($seq as item()*) as item()*", "description" : " Sorts a sequence of numeric values or nodes\n", "summary" : "
     Sorts a sequence of numeric values or nodes\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "
     the sequence to sort
    " } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sort-case-insensitive", "qname" : "functx:sort-case-insensitive", "signature" : "($seq as item()*) as item()*", "description" : " Sorts a sequence of values or nodes regardless of capitalization\n", "summary" : "
     Sorts a sequence of values or nodes regardless of capitalization\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "
     the sequence to sort
    " } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sort-document-order", "qname" : "functx:sort-document-order", "signature" : "($seq as node()*) as node()*", "description" : " Sorts a sequence of nodes in document order\n", "summary" : "
     Sorts a sequence of nodes in document order\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "node()", "occurrence" : "*", "description" : "
     the sequence to sort
    " } ], "returns" : { "type" : "node()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "sort", "qname" : "functx:sort", "signature" : "($seq as item()*) as item()*", "description" : " Sorts a sequence of values or nodes\n", "summary" : "
     Sorts a sequence of values or nodes\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "seq", "type" : "item()", "occurrence" : "*", "description" : "
     the sequence to sort
    " } ], "returns" : { "type" : "item()*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-after-if-contains", "qname" : "functx:substring-after-if-contains", "signature" : "($arg as xs:string?, $delim as xs:string) as xs:string?", "description" : " Performs substring-after, returning the entire string if it does not contain the delimiter\n", "summary" : "
     Performs substring-after, returning the entire string if it does not contain the delimiter\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "delim", "type" : "xs:string", "occurrence" : null, "description" : "
     the delimiter
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-after-last-match", "qname" : "functx:substring-after-last-match", "signature" : "($arg as xs:string?, $regex as xs:string) as xs:string", "description" : " The substring after the last text that matches a regex\n", "summary" : "
     The substring after the last text that matches a regex\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "regex", "type" : "xs:string", "occurrence" : null, "description" : "
     the regular expression
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-after-last", "qname" : "functx:substring-after-last", "signature" : "($arg as xs:string?, $delim as xs:string) as xs:string", "description" : " The substring after the last occurrence of a delimiter\n", "summary" : "
     The substring after the last occurrence of a delimiter\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "delim", "type" : "xs:string", "occurrence" : null, "description" : "
     the delimiter
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-after-match", "qname" : "functx:substring-after-match", "signature" : "($arg as xs:string?, $regex as xs:string) as xs:string?", "description" : " The substring after the first text that matches a regex\n", "summary" : "
     The substring after the first text that matches a regex\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "regex", "type" : "xs:string", "occurrence" : null, "description" : "
     the regular expression
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-before-if-contains", "qname" : "functx:substring-before-if-contains", "signature" : "($arg as xs:string?, $delim as xs:string) as xs:string?", "description" : " Performs substring-before, returning the entire string if it does not contain the delimiter\n", "summary" : "
     Performs substring-before, returning the entire string if it does not contain the delimiter\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "delim", "type" : "xs:string", "occurrence" : null, "description" : "
     the delimiter
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-before-last-match", "qname" : "functx:substring-before-last-match", "signature" : "($arg as xs:string?, $regex as xs:string) as xs:string?", "description" : " The substring after the first text that matches a regex\n", "summary" : "
     The substring after the first text that matches a regex\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "regex", "type" : "xs:string", "occurrence" : null, "description" : "
     the regular expression
    " } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-before-last", "qname" : "functx:substring-before-last", "signature" : "($arg as xs:string?, $delim as xs:string) as xs:string", "description" : " The substring before the last occurrence of a delimiter\n", "summary" : "
     The substring before the last occurrence of a delimiter\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "delim", "type" : "xs:string", "occurrence" : null, "description" : "
     the delimiter
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "substring-before-match", "qname" : "functx:substring-before-match", "signature" : "($arg as xs:string?, $regex as xs:string) as xs:string", "description" : " The substring before the last text that matches a regex\n", "summary" : "
     The substring before the last text that matches a regex\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to substring
    " }, { "name" : "regex", "type" : "xs:string", "occurrence" : null, "description" : "
     the regular expression
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "time", "qname" : "functx:time", "signature" : "($hour as xs:anyAtomicType, $minute as xs:anyAtomicType, $second as xs:anyAtomicType) as xs:time", "description" : " Construct a time from an hour, minute and second\n", "summary" : "
     Construct a time from an hour, minute and second\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "hour", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the hour
    " }, { "name" : "minute", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the minute
    " }, { "name" : "second", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     the second
    " } ], "returns" : { "type" : "xs:time", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "timezone-from-duration", "qname" : "functx:timezone-from-duration", "signature" : "($duration as xs:dayTimeDuration) as xs:string", "description" : " Converts an xs:dayTimeDuration into a timezone like \"-05:00\" or \"Z\"\n", "summary" : "
     Converts an xs:dayTimeDuration into a timezone like \"-05:00\" or \"Z\"\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:dayTimeDuration", "occurrence" : null, "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "total-days-from-duration", "qname" : "functx:total-days-from-duration", "signature" : "($duration as xs:dayTimeDuration?) as xs:decimal?", "description" : " The total number of days in a dayTimeDuration\n", "summary" : "
     The total number of days in a dayTimeDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:dayTimeDuration", "occurrence" : "?", "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "total-hours-from-duration", "qname" : "functx:total-hours-from-duration", "signature" : "($duration as xs:dayTimeDuration?) as xs:decimal?", "description" : " The total number of hours in a dayTimeDuration\n", "summary" : "
     The total number of hours in a dayTimeDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:dayTimeDuration", "occurrence" : "?", "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "total-minutes-from-duration", "qname" : "functx:total-minutes-from-duration", "signature" : "($duration as xs:dayTimeDuration?) as xs:decimal?", "description" : " The total number of minutes in a dayTimeDuration\n", "summary" : "
     The total number of minutes in a dayTimeDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:dayTimeDuration", "occurrence" : "?", "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "total-months-from-duration", "qname" : "functx:total-months-from-duration", "signature" : "($duration as xs:yearMonthDuration?) as xs:decimal?", "description" : " The total number of months in a yearMonthDuration\n", "summary" : "
     The total number of months in a yearMonthDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:yearMonthDuration", "occurrence" : "?", "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "total-seconds-from-duration", "qname" : "functx:total-seconds-from-duration", "signature" : "($duration as xs:dayTimeDuration?) as xs:decimal?", "description" : " The total number of seconds in a dayTimeDuration\n", "summary" : "
     The total number of seconds in a dayTimeDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:dayTimeDuration", "occurrence" : "?", "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "total-years-from-duration", "qname" : "functx:total-years-from-duration", "signature" : "($duration as xs:yearMonthDuration?) as xs:decimal?", "description" : " The total number of years in a yearMonthDuration\n", "summary" : "
     The total number of years in a yearMonthDuration\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "duration", "type" : "xs:yearMonthDuration", "occurrence" : "?", "description" : "
     the duration
    " } ], "returns" : { "type" : "xs:decimal?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "trim", "qname" : "functx:trim", "signature" : "($arg as xs:string?) as xs:string", "description" : " Trims leading and trailing whitespace\n", "summary" : "
     Trims leading and trailing whitespace\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to trim
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "update-attributes", "qname" : "functx:update-attributes", "signature" : "($elements as element(*)*, $attrNames as xs:QName*, $attrValues as xs:anyAtomicType*) as element(*)?", "description" : " Updates the attribute value of an XML element\n", "summary" : "
     Updates the attribute value of an XML element\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "elements", "type" : "element(*)", "occurrence" : "*", "description" : "
     the element(s) for which you wish to update the attribute
    " }, { "name" : "attrNames", "type" : "xs:QName", "occurrence" : "*", "description" : "
     the name(s) of the attribute(s) to add
    " }, { "name" : "attrValues", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the value(s) of the attribute(s) to add
    " } ], "returns" : { "type" : "element(*)?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "value-except", "qname" : "functx:value-except", "signature" : "($arg1 as xs:anyAtomicType*, $arg2 as xs:anyAtomicType*) as xs:anyAtomicType*", "description" : " The values in one sequence that aren't in another sequence\n", "summary" : "
     The values in one sequence that aren't in another sequence\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the first sequence
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the second sequence
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "value-intersect", "qname" : "functx:value-intersect", "signature" : "($arg1 as xs:anyAtomicType*, $arg2 as xs:anyAtomicType*) as xs:anyAtomicType*", "description" : " The intersection of two sequences of values\n", "summary" : "
     The intersection of two sequences of values\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the first sequence
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the second sequence
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "value-union", "qname" : "functx:value-union", "signature" : "($arg1 as xs:anyAtomicType*, $arg2 as xs:anyAtomicType*) as xs:anyAtomicType*", "description" : " The union of two sequences of values\n", "summary" : "
     The union of two sequences of values\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg1", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the first sequence
    " }, { "name" : "arg2", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the second sequence
    " } ], "returns" : { "type" : "xs:anyAtomicType*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "word-count", "qname" : "functx:word-count", "signature" : "($arg as xs:string?) as xs:integer", "description" : " The number of words\n", "summary" : "
     The number of words\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to measure
    " } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "words-to-camel-case", "qname" : "functx:words-to-camel-case", "signature" : "($arg as xs:string?) as xs:string", "description" : " Turns a string of words into camelCase\n", "summary" : "
     Turns a string of words into camelCase\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "xs:string", "occurrence" : "?", "description" : "
     the string to modify
    " } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "wrap-values-in-elements", "qname" : "functx:wrap-values-in-elements", "signature" : "($values as xs:anyAtomicType*, $elementName as xs:QName) as element(*)*", "description" : " Wraps a sequence of atomic values in XML elements\n", "summary" : "
     Wraps a sequence of atomic values in XML elements\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "values", "type" : "xs:anyAtomicType", "occurrence" : "*", "description" : "
     the values to wrap in elements
    " }, { "name" : "elementName", "type" : "xs:QName", "occurrence" : null, "description" : "
     the name of the elements to construct
    " } ], "returns" : { "type" : "element(*)*", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "yearMonthDuration", "qname" : "functx:yearMonthDuration", "signature" : "($years as xs:decimal?, $months as xs:integer?) as xs:yearMonthDuration", "description" : " Construct a yearMonthDuration from a number of years and months\n", "summary" : "
     Construct a yearMonthDuration from a number of years and months\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "years", "type" : "xs:decimal", "occurrence" : "?", "description" : "
     the number of years
    " }, { "name" : "months", "type" : "xs:integer", "occurrence" : "?", "description" : "
     the number of months
    " } ], "returns" : { "type" : "xs:yearMonthDuration", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/zorba-query" : { "ns" : "http://zorba.io/modules/zorba-query", "description" : " This module contains functions to compile and evaluate queries\n written in either JSONiq or XQuery. Also, it contains function that\n allow to parameterize the static or dynamic evaluation phase.\n", "sees" : [  ], "authors" : [ "Juan Zacarias" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/features", "prefix" : "f" }, { "uri" : "http://zorba.io/options/features", "prefix" : "op" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/modules/zorba-query", "prefix" : "zq" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "bind-context-item", "qname" : "zq:bind-context-item", "signature" : "($query-key as xs:anyURI, $dot as item()) as empty-sequence() external", "description" : " 
    This function binds the context-item of the prepared query\n identified by the given key to the $dot argument.
    \n", "summary" : "
      This function binds the context-item of the prepared query\n identified by the given key to the $dot argument.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " }, { "name" : "dot", "type" : "item()", "occurrence" : null, "description" : "
     the context item to bind
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function has side effects and returns the empty sequence." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared." ] }, { "isDocumented" : true, "arity" : 3, "name" : "bind-variable", "qname" : "zq:bind-variable", "signature" : "($query-key as xs:anyURI, $var as xs:QName, $value as item()*) as empty-sequence() external", "description" : " 
    This function binds the variable with name $name of\n the prepared query identified by $query-key to the given sequence.
    \n", "summary" : "
      This function binds the variable with name $name of\n the prepared query identified by $query-key to the given sequence.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " }, { "name" : "var", "type" : "xs:QName", "occurrence" : null, "description" : "" }, { "name" : "value", "type" : "item()", "occurrence" : "*", "description" : "
     the sequence to which the external variable $name should be bound
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function has side effects and returns the empty sequence." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:UNDECLARED_VARIABLE if the given variable is not declared in the query." ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete-query", "qname" : "zq:delete-query", "signature" : "($query-key as xs:anyURI) as empty-sequence() external", "description" : " 
    Deletes the prepared query associated with the given identifier.
    \n 
    After the query is deleted, the corresponding identifier should\n not be used as argument to any of the functions of this module.
    \n", "summary" : "
      Deletes the prepared query associated with the given identifier.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function has side effects and returns the empty sequence." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared." ] }, { "isDocumented" : true, "arity" : 1, "name" : "evaluate-sequential", "qname" : "zq:evaluate-sequential", "signature" : "($query-key as xs:string) as item()* external", "description" : " 
    Evaluates the given prepared query and returns the result\n of the evaluation. The query must be sequential.
    \n", "summary" : "
      Evaluates the given prepared query and returns the result\n of the evaluation.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "item()*", "description" : "the result of evaluating the query." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:QUERY_NOT_SEQUENTIAL if the query is not sequential.", "zq:QUERY_IS_UPDATING if the query is an updating query.", "any dynamic error that is raised by evaluating the given query." ] }, { "isDocumented" : true, "arity" : 1, "name" : "evaluate-updating", "qname" : "zq:evaluate-updating", "signature" : "($query-key as xs:anyURI) external", "description" : " 
    Evaluates the given prepared query and applies the updates\n computed by this query. The query must be an updating query.
    \n", "summary" : "
      Evaluates the given prepared query and applies the updates\n computed by this query.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : null, "description" : "the function has side effects because it applies the updates of the query. It returns the empty sequence." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:QUERY_NOT_UPDATING if the query is not an updating query.", "zq:QUERY_IS_SEQUENTIAL if the query is sequential.", "any dynamic error that is raised by evaluating the given query or applying its updates." ] }, { "isDocumented" : true, "arity" : 1, "name" : "evaluate", "qname" : "zq:evaluate", "signature" : "($query-key as xs:anyURI) as item()* external", "description" : " 
    Evaluates the given prepared query and returns the result\n of the evaluation. The query must not be sequential or\n updating.
    \n", "summary" : "
      Evaluates the given prepared query and returns the result\n of the evaluation.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "item()*", "description" : "the result of evaluating the given query" }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:QUERY_IS_UPDATING if the query is an updating query.", "zq:QUERY_IS_SEQUENTIAL if the query is sequential.", "any dynamic error that is raised by evaluating the given query." ] }, { "isDocumented" : true, "arity" : 1, "name" : "external-variables", "qname" : "zq:external-variables", "signature" : "($query-key as xs:anyURI) as xs:QName* external", "description" : " 
    The function returns the names of the external variables that\n are declared in the given query (either in the main module or\n in any of the imported library modules).
    \n", "summary" : "
      The function returns the names of the external variables that\n are declared in the given query (either in the main module or\n in any of the imported library modules).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "xs:QName*", "description" : "the sequence of names of the said external variables." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-bound-context-item", "qname" : "zq:is-bound-context-item", "signature" : "($query-key as xs:anyURI) as xs:boolean external", "description" : " 
    The function tests if the context-item is bound for the\n execution of the query referred to by the given query identifier.
    \n", "summary" : "
      The function tests if the context-item is bound for the\n execution of the query referred to by the given query identifier.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the context-item is bound, false otherwise." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared." ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-bound-variable", "qname" : "zq:is-bound-variable", "signature" : "($query-key as xs:anyURI, $var-name as xs:QName) as xs:boolean external", "description" : " 
    The function tests if the given variable is bound for the\n execution of the query referred to by the given query identifier.
    \n", "summary" : "
      The function tests if the given variable is bound for the\n execution of the query referred to by the given query identifier.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " }, { "name" : "var-name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the name of the variable
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the variable is bound, false otherwise." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:UNDECLARED_VARIABLE if the given variable is not declared in the query." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-sequential", "qname" : "zq:is-sequential", "signature" : "($query-key as xs:anyURI) as xs:boolean external", "description" : " 
    The function tests if the query identified by the given key\n is sequential query.
    \n", "summary" : "
      The function tests if the query identified by the given key\n is sequential query.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the query is a sequential, false otherwise." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-updating", "qname" : "zq:is-updating", "signature" : "($query-key as xs:anyURI) as xs:boolean external", "description" : " 
    The function tests if the query identified by the given key\n is an updating query.
    \n", "summary" : "
      The function tests if the query identified by the given key\n is an updating query.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier for a compiled query
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the query is an updating query, false otherwise." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared." ] }, { "isDocumented" : true, "arity" : 1, "name" : "load-from-query-plan", "qname" : "zq:load-from-query-plan", "signature" : "($plan as xs:base64Binary) as xs:anyURI external", "description" : " 
    The function loads a given query for execution from a\n xs:base64Binary query plan, obtained through the zq:query-plan function.
    \n 
    If the query was successfully loaded, the function returns an\n identifier as xs:anyURI. This URI can be passed to other functions\n of this module (e.g. to actually evaluate the query). The URI\n is opaque and its lifetime is bound by the lifetime of the query\n that invoked this function. Further reference or uses\n of the identifier lead to unexpected results.
    \n 
    \n 
    Successfully prepared queries need to be deleted by passing the resulting\n identifier to the zq:delete-query function of this module.
    \n", "summary" : "
      The function loads a given query for execution from a\n xs:base64Binary query plan, obtained through the zq:query-plan function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "plan", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the binary query plan.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "an identifier for the compiled query that can be passed as arguments to other functions of this module." }, "errors" : [ "any (static or type) error that may be raised during the compilation of the query. For example, err:XPST0003 if the given query could not be parsed." ] }, { "isDocumented" : true, "arity" : 3, "name" : "load-from-query-plan", "qname" : "zq:load-from-query-plan", "signature" : "($plan as xs:base64Binary, $resolver as item()?, $mapper as item()?) as xs:anyURI external", "description" : " 
    The function loads a given query for execution from a\n xs:base64Binary query plan, obtained through the zq:query-plan function.
    \n 
    If the query was successfully loaded, the function returns an\n identifier as xs:anyURI. This URI can be passed to other functions\n of this module (e.g. to actually evaluate the query). The URI\n is opaque and its lilfetime is bound by the lifetime of the query\n that invoked this function. Further reference or uses\n of the identifier lead to unexpected results.
    \n 
    \n 
    For important notes regarding the second and third parameters of the\n function, review the comments in zq:prepare-main-module#3.
    \n 
    \n 
    Successfully prepared queries need to be deleted by passing the resulting\n identifier to the zq:delete-query function of this module.
    \n", "summary" : "
      The function loads a given query for execution from a\n xs:base64Binary query plan, obtained through the zq:query-plan function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "plan", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the binary query plan.
    " }, { "name" : "resolver", "type" : "item()", "occurrence" : "?", "description" : "
     the URL resolver function.
    " }, { "name" : "mapper", "type" : "item()", "occurrence" : "?", "description" : "
     the URI mapper function.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "an identifier for the compiled query that can be passed as arguments to other functions of this module." }, "errors" : [ "any (static or type) error that may be raised during the compilation of the query. For example, err:XPST0003 if the given query could not be parsed." ] }, { "isDocumented" : true, "arity" : 1, "name" : "prepare-library-module", "qname" : "zq:prepare-library-module", "signature" : "($library-module-text as xs:string) as empty-sequence() external", "description" : " 
    This function compiles a given XQuery or JSONiq library module.\n It can be used to compile-check a module.
    \n", "summary" : "
      This function compiles a given XQuery or JSONiq library module.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "library-module-text", "type" : "xs:string", "occurrence" : null, "description" : "
     the library module that should be prepared.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the empty-sequence." }, "errors" : [ "any (static or type) error that may be raised during the compilation of the library module. For example, err:XPST0003 if the given library module could not be parsed." ] }, { "isDocumented" : true, "arity" : 1, "name" : "prepare-main-module", "qname" : "zq:prepare-main-module", "signature" : "($main-module-text as xs:string) as xs:anyURI external", "description" : " 
    The function prepares a given a query for execution.
    \n 
    If the query was successfully compiled, the function returns an\n identifier as xs:anyURI. This URI can be passed to other functions\n of this module (e.g. to actually evaluate the query). The URI\n is opaque and its lifetime is bound by the lifetime of the query\n that invoked this function. Further reference or uses\n of the identifier lead to unexpected results.
    \n 
    \n 
    Successfully prepared queries need to be deleted by passing the resulting\n identifier to the zq:delete-query function of this module.
    \n", "summary" : "
      The function prepares a given a query for execution.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "main-module-text", "type" : "xs:string", "occurrence" : null, "description" : "
     the query that should be prepared. The query needs to be a XQuery or JSONiq main module.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "an identifier for the compiled query that can be passed as arguments to other functions of this module." }, "errors" : [ "any (static or type) error that may be raised during the compilation of the query. For example, err:XPST0003 if the given query could not be parsed." ] }, { "isDocumented" : true, "arity" : 3, "name" : "prepare-main-module", "qname" : "zq:prepare-main-module", "signature" : "($main-module-text as xs:string, $resolver as function (xs:string, xs:string) as item()??, $mapper as function (xs:string, xs:string) as xs:string*?) as xs:anyURI external", "description" : " 
    The function prepares a given query for execution.
    \n 
    If the query was successfully compiled, the function returns an\n identifier as xs:anyURI. This URI can be passed to other functions\n of this module (e.g. to actually evaluate the query). The URI\n is opaque and its lifetime is bound by the lifetime of the query\n that invoked this function. Further reference or uses\n of the identifier lead to unexpected results.
    \n 
    \n 
    Important notes regarding the second and third parameters of the function:
    \n 
    --------------------------------------------------------------------------
    \n 
    \n 
    These parameters allow you to specify a URL resolver and a URI mapper\n for Zorba to use when executing this query. See\n here
    \n 
    \n 
      The second parameter is a function item for a URL\n resolver. The URL resolver function must recive 2 parameters:\n 
    • A $namespace as xs:string that will contain the url to be resolved.
      • \n 
    • A $entity as xs:string that will contain the type of resolving needed.\n   This can be one of two values: \"module\" or \"schema\".
      • \n 
    \n 
    The function must return the empty sequence when the specified $namespace\n or $entity are not the ones to be resolved.
    \n 
    \n 
    Example:
    \n 
    \n 
    declare function mymod:url-resolver($namespace as xs:string, $entity as xs:string) as item()?\n {\n  if($namespace = 'http://test.xq')\n  then \"module namespace test = 'http://test'; declare function test:foo(){'foo'};\"\n  else ()\n };
    \n 
    \n 
    The URL resolver function's namespace, name, and parameter naming are\n not restricted by ZQ.
    \n 
    \n 
    The URL resolver function's return type is not restricted, it could be a string, a sequence,\n a node, etc. All the outputs types are to be serialized as a string.
    \n 
    \n 
    The third parameter is a function item for a URI mapper.
    \n 
      The URI mapper function, just like the URL resolver, receives 2 parameters:\n 
    • A $namespace as xs:string that will contain the URI to be mapped.
      • \n 
    • A $entity as xs:string that will contain the type of resolving needed.\n   This can be one of two values: \"module\" or \"schema\".
      • \n 
    \n 
    The URI mapper must return an empty sequence when the specified $namesapce or $entity\n are not to be mapped. Unlike the URL resolver this function must return a sequence of strings.
    \n 
    \n 
    Example:
    \n 
    \n 
    declare function mymod:uri-mapper($namespace as xs:string, $entity as xs:string)\n {\n  if($namespace = 'http://test')\n  then (\"http://zorba.io/test\", \"http://foo.com/schema/test\")\n  else ()\n };
    \n 
    \n 
    The URI mapper function's namespace, name, and parameter naming are\n not restricted by ZQ.
    \n 
    \n 
    In order to pass the above URL resolver and URI mapper to this function,\n use the following syntax:
    \n 
    \n   
    variable $queryID := zq:prepare-main-module(\"..query text..\",\n      mymod:url-resolver#2, mymod:uri-mapper#2);
    \n 
    \n 
    That is, the QName of the function followed by \"#2\". This is XQuery\n \"higher-order function\" syntax, meaning the function with the specified\n QName which takes two arguments. Since URL resolvers and URI mappers\n must take two arguments, both will always be specified with \"#2\".
    \n 
    \n 
    Both the URL resolver and URI mapper functions are optional, meaning you\n may pass the empty-sequence () for either.
    \n 
    \n 
    Successfully prepared queries need to be deleted by passing the resulting\n identifier to the zq:delete-query function of this module.
    \n", "summary" : "
      The function prepares a given query for execution.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "main-module-text", "type" : "xs:string", "occurrence" : null, "description" : "
     the query that should be prepared. The query needs to be a XQuery or JSONiq main module.
    " }, { "name" : "resolver", "type" : "function (xs:string, xs:string) as item()?", "occurrence" : "?", "description" : "
     the URL resolver function.
    " }, { "name" : "mapper", "type" : "function (xs:string, xs:string) as xs:string*", "occurrence" : "?", "description" : "
     the URI mapper function.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "an identifier for the compiled query that can be passed as arguments to other functions of this module." }, "errors" : [ "any (static or type) error that may be raised during the compilation of the query. For example, err:XPST0003 if the given query could not be parsed." ] }, { "isDocumented" : true, "arity" : 1, "name" : "query-plan", "qname" : "zq:query-plan", "signature" : "($query-key as xs:anyURI) as xs:base64Binary external", "description" : " 
    Returns the compiled query identified by the given query-key\n as binary data.
    \n", "summary" : "
      Returns the compiled query identified by the given query-key\n as binary data.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier of a compiled query.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the query as xs:base64Binary." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:NO_QUERY_PLAN if there is an error serializing the query." ] }, { "isDocumented" : true, "arity" : 2, "name" : "variable-value", "qname" : "zq:variable-value", "signature" : "($query-key as xs:anyURI, $var-name as xs:QName) as item()* external", "description" : " 
    This function returns the value of a variable that is bound in the\n given query.
    \n", "summary" : "
      This function returns the value of a variable that is bound in the\n given query.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "query-key", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     the identifier of a compiled query.
    " }, { "name" : "var-name", "type" : "xs:QName", "occurrence" : null, "description" : "
     the name of the variable whose value should be returned.
    " } ], "returns" : { "type" : "item()*", "description" : "the value bound to the given variable." }, "errors" : [ "zq:NO_QUERY_MATCH if no query with the given identifier was prepared.", "zq:UNDECLARED_VARIABLE if the given variable is not declared in the query.", "zq:UNBOUND_VARIABLE if the given variable doesn't have a value." ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/hypercubes" : { "ns" : "http://xbrl.io/modules/bizql/hypercubes", "description" : " 
    This module provides functionality for manipulating hypercubes.
    \n 
    A hypercube provides a multi-dimensional structure to organize facts.
    \n 
    The dimensions of a hypercube correspond to XBRL aspects (concepts, entities, periods,\n units, further XBRL dimensions). An XBRL hypercube only is made of XBRL dimensions, however\n including the other aspects as well is very useful in the context of NOLAP, so that xbrl.io\n does so.
    \n 
    xbrl.io introduces the notion of default hypercube. A default hypercube is implicitly added\n to each component, and only contains the concept, entity, period and unit aspects.\n In other words, the default hypercube\n of a component contains all these facts that do not have any XBRL dimensions.
    \n 
    With this module, you can retrieve all hypercubes contained in a component. You can\n retrieve all facts contained in a hypercube (default dimension values are processed automatically),\n either in raw form, or organized as a (2D) fact table. You can also populate a network (for example,\n a presentation network) with the facts contained in a hypercube.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/concept-maps", "prefix" : "concept-maps" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/hypercubes", "prefix" : "hypercubes" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "dimensionless-hypercube", "qname" : "hypercubes:dimensionless-hypercube", "signature" : "() as object()", "description" : " 
    Returns an instantiation of a dimensionless Hypercube containing only the basic\n    characteristics (xbrl:Concept, xbrl:Period, xbrl:Entity, and xbrl:Unit).\n    For each of those included aspects the value space is not limited.
    \n", "summary" : "
      Returns an instantiation of a dimensionless Hypercube containing only the basic\n    characteristics (xbrl:Concept, xbrl:Period, xbrl:Entity, and xbrl:Unit).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "dimensionless hypercube instantiation." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "dimensionless-hypercube", "qname" : "hypercubes:dimensionless-hypercube", "signature" : "($options as object()?) as object()", "description" : " 
    Returns an instantiation of a dimensionless Hypercube containing only the basic\n    characteristics (xbrl:Concept, xbrl:Period, xbrl:Entity, and xbrl:Unit).\n    For each of those included aspects the value space is not limited.
    \n", "summary" : "
      Returns an instantiation of a dimensionless Hypercube containing only the basic\n    characteristics (xbrl:Concept, xbrl:Period, xbrl:Entity, and xbrl:Unit).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
    : additional options among which: - Concepts: an array of concept names to include in the hypercube. - Periods: an array of periods to include in the hypercube. - Entities: an array of EIDs to include in the hypercube. - Units: an array of units to include in the hypercube.
    " } ], "returns" : { "type" : "object()", "description" : "dimensionless hypercube instantiation." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "fact-table-for-hypercube", "qname" : "hypercubes:fact-table-for-hypercube", "signature" : "($hypercube as object(), $archives as item()*) as array()", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "hypercube", "type" : "object()", "occurrence" : null, "description" : "
     a hypercube.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $hypercubes:ALL_ARCHIVES for no filtering.
    " } ], "returns" : { "type" : "array()", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "fact-table-for-hypercube", "qname" : "hypercubes:fact-table-for-hypercube", "signature" : "($hypercube as object(), $archives as item()*, $options as object()?) as array()", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "hypercube", "type" : "object()", "occurrence" : null, "description" : "
     a hypercube.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "array()", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "facts-for-hypercube", "qname" : "hypercubes:facts-for-hypercube", "signature" : "($hypercube as object(), $archives as item()*) as item()*", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "hypercube", "type" : "object()", "occurrence" : null, "description" : "
     a hypercube.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $hypercubes:ALL_ARCHIVES for no filtering.
    " } ], "returns" : { "type" : "item()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "facts-for-hypercube", "qname" : "hypercubes:facts-for-hypercube", "signature" : "($hypercube as object(), $archives as item()*, $options as object()?) as item()*", "description" : " 
    Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    \n", "summary" : "
      Retrieves all facts from the supplied archives, that are relevant to the\n supplied hypercube, and populates them with the default dimension values\n when missing.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "hypercube", "type" : "object()", "occurrence" : null, "description" : "
     a hypercube.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $hypercubes:ALL_ARCHIVES for no filtering.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "item()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "hypercubes-for-components", "qname" : "hypercubes:hypercubes-for-components", "signature" : "($components as object()*) as object()*", "description" : " 
    Retrieves all hypercubes in the supplied components.
    \n", "summary" : "
      Retrieves all hypercubes in the supplied components.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "components", "type" : "object()", "occurrence" : "*", "description" : "
     a sequence of components.
    " } ], "returns" : { "type" : "object()*", "description" : "all hypercubes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "hypercubes-for-components", "qname" : "hypercubes:hypercubes-for-components", "signature" : "($components as object()*, $names as string*) as object()*", "description" : " 
    Retrieves all hypercubes in the supplied components and\n with the given names.
    \n", "summary" : "
      Retrieves all hypercubes in the supplied components and\n with the given names.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "components", "type" : "object()", "occurrence" : "*", "description" : "
     a sequence of components.
    " }, { "name" : "names", "type" : "string", "occurrence" : "*", "description" : "
     a sequence of names.
    " } ], "returns" : { "type" : "object()*", "description" : "all hypercubes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "populate-networks-with-facts", "qname" : "hypercubes:populate-networks-with-facts", "signature" : "($networks as object()*, $hypercube as object(), $archives as item()*) as object()*", "description" : " 
    Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied hypercube. Default dimension values are added to the facts\n when missing.
    \n", "summary" : "
      Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied hypercube.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "networks", "type" : "object()", "occurrence" : "*", "description" : "
     networks.
    " }, { "name" : "hypercube", "type" : "object()", "occurrence" : null, "description" : "
     a hypercube.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs or $hypercubes:ALL_ARCHIVES for no filtering.
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "populate-networks-with-facts", "qname" : "hypercubes:populate-networks-with-facts", "signature" : "($networks as object()*, $hypercube as object(), $archives as item()*, $options as object()?) as object()*", "description" : " 
    Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied hypercube. Default dimension values are added to the facts\n when missing.
    \n", "summary" : "
      Populates a concept-tree network with all facts from the supplied archives,\n that are relevant to the\n supplied hypercube.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "networks", "type" : "object()", "occurrence" : "*", "description" : "
     networks.
    " }, { "name" : "hypercube", "type" : "object()", "occurrence" : null, "description" : "
     a hypercube.
    " }, { "name" : "archives", "type" : "item()", "occurrence" : "*", "description" : "
     a sequence of archives or their AIDs.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "a sequence of facts with populated dimension values." }, "errors" : [  ] } ], "variables" : [ { "name" : "hypercubes:ALL_ARCHIVES", "type" : "boolean", "description" : " Joker for all archives.\n" } ] }, "http://www.zorba-xquery.com/modules/xqdoc/batch" : { "ns" : "http://www.zorba-xquery.com/modules/xqdoc/batch", "description" : " Process XQDoc batches.\n This module generates XQDoc HTML documentation from multiple\n XQuery modules.\n", "sees" : [  ], "authors" : [ "William Candillon wcandillon at gmail dot com" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.zorba-xquery.com/modules/xqdoc/batch", "prefix" : "batch" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://expath.org/ns/file", "prefix" : "file" }, { "uri" : "http://www.functx.com", "prefix" : "functx" }, { "uri" : "http://www.w3.org/1999/xhtml", "prefix" : "h" }, { "uri" : "http://www.zorba-xquery.com/modules/xqdoc/html", "prefix" : "html" }, { "uri" : "http://www.zorba-xquery.com/modules/xqdoc/menu", "prefix" : "menu" }, { "uri" : "http://www.w3.org/2010/xslt-xquery-serialization", "prefix" : "out" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://www.xqdoc.org/1.0", "prefix" : "xq" }, { "uri" : "http://zorba.io/modules/xqdoc", "prefix" : "xqdoc" } ], "functions" : [ { "isDocumented" : false, "arity" : 2, "name" : "add-predeclared-namespaces", "qname" : "batch:add-predeclared-namespaces", "signature" : "($xqdoc as element(xq:xqdoc), $namespaces as element(namespace)*) as element(xq:xqdoc)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xqdoc", "type" : "element(xq:xqdoc)", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : "element(namespace)", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "element(xq:xqdoc)", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "add-trailing-slash", "qname" : "batch:add-trailing-slash", "signature" : "($path as xs:string) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "build-xqdoc", "qname" : "batch:build-xqdoc", "signature" : "($output-folder as xs:string, $static-folders as xs:string*, $template as element(*), $modules as element(modules))", "description" : " Run an XQDoc batch.\n", "summary" : "
     Run an XQDoc batch.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "output-folder", "type" : "xs:string", "occurrence" : null, "description" : "
     Where to write the generated files.
    " }, { "name" : "static-folders", "type" : "xs:string", "occurrence" : "*", "description" : "
     Where to copy the static files from.
    " }, { "name" : "template", "type" : "element(*)", "occurrence" : null, "description" : "
     HTML layout of the generated files. The layount can contains different variables. For instance: 
     is a valid example. Three variable names are available: page, title, and menu.
    " }, { "name" : "modules", "type" : "element(modules)", "occurrence" : null, "description" : "
     Document describing the documentation project. For instance: 
       
       
          
    " } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "copy-static-folders", "qname" : "batch:copy-static-folders", "signature" : "($output-folder as xs:string, $static-folders as xs:string*)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "output-folder", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "static-folders", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "create-page", "qname" : "batch:create-page", "signature" : "($output-folder as xs:string, $page-name as xs:string, $page as element(h:html))", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "output-folder", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "page-name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "page", "type" : "element(h:html)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "create-xml-folder", "qname" : "batch:create-xml-folder", "signature" : "($folder as xs:string)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "folder", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "page", "qname" : "batch:page", "signature" : "($template as element(*), $menu as element(ul), $section as element(*)) as element(h:html)", "description" : "", "summary" : "", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "template", "type" : "element(*)", "occurrence" : null, "description" : "" }, { "name" : "menu", "type" : "element(ul)", "occurrence" : null, "description" : "" }, { "name" : "section", "type" : "element(*)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(h:html)", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "save-xml", "qname" : "batch:save-xml", "signature" : "($output-file, $page)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "output-file", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "page", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "section", "qname" : "batch:section", "signature" : "($sections as element(section)+) as element(section)+", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sections", "type" : "element(section)", "occurrence" : "+", "description" : "" } ], "returns" : { "type" : "element(section)+", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "section", "qname" : "batch:section", "signature" : "($sections as element(section)+, $level as xs:integer) as element(section)+", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "sections", "type" : "element(section)", "occurrence" : "+", "description" : "" }, { "name" : "level", "type" : "xs:integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(section)+", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "xqdoc", "qname" : "batch:xqdoc", "signature" : "($module as element(module)) as element(xq:xqdoc)", "description" : "", "summary" : "", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "module", "type" : "element(module)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(xq:xqdoc)", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/data-cleaning/hybrid-string-similarity" : { "ns" : "http://zorba.io/modules/data-cleaning/hybrid-string-similarity", "description" : " 
    This library module provides hybrid string similarity functions, combining the properties of\n character-based string similarity functions and token-based string similarity functions.
    \n 
    \n 
    The logic contained in this module is not specific to any particular XQuery implementation,\n although the module requires the trigonometic functions of XQuery 3.0 or a math extension\n function such as sqrt($x as numeric) for computing the square root.
    \n", "sees" : [  ], "authors" : [ "Bruno Martins and Diogo Simões" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xpath-functions/math", "prefix" : "math" }, { "uri" : "http://zorba.io/modules/data-cleaning/set-similarity", "prefix" : "set" }, { "uri" : "http://zorba.io/modules/data-cleaning/character-based-string-similarity", "prefix" : "simc" }, { "uri" : "http://zorba.io/modules/data-cleaning/hybrid-string-similarity", "prefix" : "simh" }, { "uri" : "http://zorba.io/modules/data-cleaning/phonetic-string-similarity", "prefix" : "simp" }, { "uri" : "http://zorba.io/modules/data-cleaning/token-based-string-similarity", "prefix" : "simt" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 4, "name" : "monge-elkan-jaro-winkler", "qname" : "simh:monge-elkan-jaro-winkler", "signature" : "($s1 as xs:string, $s2 as xs:string, $prefix as xs:integer, $fact as xs:double) as xs:double", "description" : " 
    Returns the Monge-Elkan similarity coefficient between two strings, using the Jaro-Winkler
    \n 
    similarity function to discover token identity.
    \n 
    \n 
    Example usage : 
     monge-elkan-jaro-winkler(\"Comput. Sci. and Eng. Dept., University of California, San Diego\", \"Department of Computer Scinece, Univ. Calif., San Diego\", 4, 0.1) 
    \n 
    \n 
    The function invocation in the example above returns : 
     0.992 
    \n", "summary" : "
      Returns the Monge-Elkan similarity coefficient between two strings, using the Jaro-Winkler \n  similarity function to discover token identity.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : "xs:string", "occurrence" : null, "description" : "
     The first string.
    " }, { "name" : "s2", "type" : "xs:string", "occurrence" : null, "description" : "
     The second string.
    " }, { "name" : "prefix", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of characters to consider when testing for equal prefixes with the Jaro-Winkler metric.
    " }, { "name" : "fact", "type" : "xs:double", "occurrence" : null, "description" : "
     The weighting factor to consider when the input strings have equal prefixes with the Jaro-Winkler metric.
    " } ], "returns" : { "type" : "xs:double", "description" : "The Monge-Elkan similarity coefficient between the two strings." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "soft-cosine-tokens-edit-distance", "qname" : "simh:soft-cosine-tokens-edit-distance", "signature" : "($s1 as xs:string, $s2 as xs:string, $r as xs:string, $t as xs:integer) as xs:double", "description" : " 
    Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    \n 
    The tokens from each string are weighted according to their occurence frequency (i.e., weighted according to the\n term-frequency heuristic from Information Retrieval).
    \n 
    The Edit Distance similarity function is used to discover token identity, and tokens having an edit distance\n bellow a given threshold are considered as matching tokens.
    \n 
    \n 
    Example usage : 
     soft-cosine-tokens-edit-distance(\"The FLWOR Foundation\", \"FLWOR Found.\", \" +\", 0 ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     0.408248290463863 
    \n", "summary" : "
      Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : "xs:string", "occurrence" : null, "description" : "
     The first string.
    " }, { "name" : "s2", "type" : "xs:string", "occurrence" : null, "description" : "
     The second string.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " }, { "name" : "t", "type" : "xs:integer", "occurrence" : null, "description" : "
     A threshold for the similarity function used to discover token identity.
    " } ], "returns" : { "type" : "xs:double", "description" : "The cosine similarity coefficient between the sets tokens extracted from the two strings." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 6, "name" : "soft-cosine-tokens-jaro-winkler", "qname" : "simh:soft-cosine-tokens-jaro-winkler", "signature" : "($s1 as xs:string, $s2 as xs:string, $r as xs:string, $t as xs:double, $prefix as xs:integer?, $fact as xs:double?) as xs:double", "description" : " 
    Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    \n 
    The tokens from each string are weighted according to their occurence frequency (i.e., weighted according to the\n term-frequency heuristic from Information Retrieval).
    \n 
    The Jaro-Winkler similarity function is used to discover token identity, and tokens having a Jaro-Winkler\n similarity above a given threshold are considered as matching tokens.
    \n 
    \n 
    Example usage : 
     soft-cosine-tokens-jaro-winkler(\"The FLWOR Foundation\", \"FLWOR Found.\", \" +\", 1, 4, 0.1 ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     0.45 
    \n", "summary" : "
      Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : "xs:string", "occurrence" : null, "description" : "
     The first string.
    " }, { "name" : "s2", "type" : "xs:string", "occurrence" : null, "description" : "
     The second string.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " }, { "name" : "t", "type" : "xs:double", "occurrence" : null, "description" : "
     A threshold for the similarity function used to discover token identity.
    " }, { "name" : "prefix", "type" : "xs:integer", "occurrence" : "?", "description" : "
     The number of characters to consider when testing for equal prefixes with the Jaro-Winkler metric.
    " }, { "name" : "fact", "type" : "xs:double", "occurrence" : "?", "description" : "
     The weighting factor to consider when the input strings have equal prefixes with the Jaro-Winkler metric.
    " } ], "returns" : { "type" : "xs:double", "description" : "The cosine similarity coefficient between the sets tokens extracted from the two strings." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "soft-cosine-tokens-jaro", "qname" : "simh:soft-cosine-tokens-jaro", "signature" : "($s1 as xs:string, $s2 as xs:string, $r as xs:string, $t as xs:double) as xs:double", "description" : " 
    Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    \n 
    The tokens from each string are weighted according to their occurence frequency (i.e., weighted according to the\n term-frequency heuristic from Information Retrieval).
    \n 
    The Jaro similarity function is used to discover token identity, and tokens having a Jaro similarity above\n a given threshold are considered as matching tokens.
    \n 
    \n 
    Example usage : 
     soft-cosine-tokens-jaro(\"The FLWOR Foundation\", \"FLWOR Found.\", \" +\", 1 ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     0.5 
    \n", "summary" : "
      Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : "xs:string", "occurrence" : null, "description" : "
     The first string.
    " }, { "name" : "s2", "type" : "xs:string", "occurrence" : null, "description" : "
     The second string.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " }, { "name" : "t", "type" : "xs:double", "occurrence" : null, "description" : "
     A threshold for the similarity function used to discover token identity.
    " } ], "returns" : { "type" : "xs:double", "description" : "The cosine similarity coefficient between the sets tokens extracted from the two strings." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "soft-cosine-tokens-metaphone", "qname" : "simh:soft-cosine-tokens-metaphone", "signature" : "($s1 as xs:string, $s2 as xs:string, $r as xs:string) as xs:double", "description" : " 
    Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    \n 
    The tokens from each string are weighted according to their occurence frequency (i.e., weighted according to the\n term-frequency heuristic from Information Retrieval).
    \n 
    The Metaphone phonetic similarity function is used to discover token identity, which is equivalent to saying that\n this function returns the cosine similarity coefficient between sets of Metaphone keys.
    \n 
    \n 
    Example usage : 
     soft-cosine-tokens-metaphone(\"ALEKSANDER SMITH\", \"ALEXANDER SMYTH\", \" +\" ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     1.0 
    \n", "summary" : "
      Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : "xs:string", "occurrence" : null, "description" : "
     The first string.
    " }, { "name" : "s2", "type" : "xs:string", "occurrence" : null, "description" : "
     The second string.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " } ], "returns" : { "type" : "xs:double", "description" : "The cosine similarity coefficient between the sets Metaphone keys extracted from the two strings." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "soft-cosine-tokens-soundex", "qname" : "simh:soft-cosine-tokens-soundex", "signature" : "($s1 as xs:string, $s2 as xs:string, $r as xs:string) as xs:double", "description" : " 
    Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    \n 
    \n 
    The tokens from each string are weighted according to their occurence frequency (i.e., weighted according to the\n term-frequency heuristic from Information Retrieval).
    \n 
    The Soundex phonetic similarity function is used to discover token identity, which is equivalent to saying that\n this function returns the cosine similarity coefficient between sets of Soundex keys.
    \n 
    \n 
    Example usage : 
     soft-cosine-tokens-soundex(\"ALEKSANDER SMITH\", \"ALEXANDER SMYTH\", \" +\") 
    \n 
    \n 
    The function invocation in the example above returns : 
     1.0 
    \n", "summary" : "
      Returns the cosine similarity coefficient between sets of tokens extracted from two strings.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : "xs:string", "occurrence" : null, "description" : "
     The first string.
    " }, { "name" : "s2", "type" : "xs:string", "occurrence" : null, "description" : "
     The second string.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " } ], "returns" : { "type" : "xs:double", "description" : "The cosine similarity coefficient between the sets of Soundex keys extracted from the two strings." }, "errors" : [  ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/rules" : { "ns" : "http://xbrl.io/modules/bizql/rules", "description" : " 
    This module provides functions for storing, retrieving, and modifying\n rules. Rules can be used in BizQL queries to:
    \n 
      \n   
    • Impute Facts that were not reported within an instance, yet can be\n       derived from reported facts.
      • \n   
    • Compute arbitrary new Facts (Ratios, Calculated Facts, Facts from different\n       Datasources/Instances, etc.).
      • \n   
    • Run validation and/or verification rules
      • \n 
    \n 
    A Rule is an object containing a BizQL fomula to execute if a condition is met.\n For example if a user queries for a certain concept and a rule exists for this\n concept then the rule is applied to get the fact.
    \n 
    With this module, you can retrieve the rules associated with each report\n schema. You can also query for facts by making implicitly use of the mapping.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://xbrl.io/modules/bizql/archives", "prefix" : "archives" }, { "uri" : "http://xbrl.io/modules/bizql/facts", "prefix" : "facts" }, { "uri" : "http://xbrl.io/modules/bizql/networks", "prefix" : "networks" }, { "uri" : "http://xbrl.io/modules/bizql/report-schemas", "prefix" : "report-schemas" }, { "uri" : "http://xbrl.io/modules/bizql/rules", "prefix" : "rules" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 7, "name" : "create-computed-fact", "qname" : "rules:create-computed-fact", "signature" : "($template-fact as object(), $concept-name-or-aspects as item(), $value as item(), $rule as object(), $audit-trail-message as string, $source-facts as object()*, $options as object()?) as object()", "description" : " 
    Helper function to create a new fact within a rule.
    \n", "summary" : "
      Helper function to create a new fact within a rule.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "template-fact", "type" : "object()", "occurrence" : null, "description" : "
     a fact object that will be used as a template for the newly created fact
    " }, { "name" : "concept-name-or-aspects", "type" : "item()", "occurrence" : null, "description" : "
     either a name of the concept for the newly created fact or a complete aspects object to be used in the new fact.
    " }, { "name" : "value", "type" : "item()", "occurrence" : null, "description" : "
     a value for the newly created fact
    " }, { "name" : "rule", "type" : "object()", "occurrence" : null, "description" : "
     the rule in which this fact has been created
    " }, { "name" : "audit-trail-message", "type" : "string", "occurrence" : null, "description" : "
     a verbose string message explaining how and why this fact has been created
    " }, { "name" : "source-facts", "type" : "object()", "occurrence" : "*", "description" : "
     sequence of facts that have been used to compute the new fact (this will only be added to the AuditTrails if the audit-trail option is set to \"debug\")
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "object()", "description" : "the decimal value of the fact or 0." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "fact-trail", "qname" : "rules:fact-trail", "signature" : "($fact as object()?) as string", "description" : " 
    Serializes a fact to a simple string format that can be used in\n    audit trail messages to trail the value of the fact.
    \n 
    The returned string follows the pattern: fact-concept-name[fact-value]
    \n", "summary" : "
      Serializes a fact to a simple string format that can be used in\n    audit trail messages to trail the value of the fact.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact", "type" : "object()", "occurrence" : "?", "description" : "
     a single fact to serialize to a simple informative string
    " } ], "returns" : { "type" : "string", "description" : "the string with key information about the fact." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "fact-trail", "qname" : "rules:fact-trail", "signature" : "($fact as object()?, $name as string) as string", "description" : " 
    Serializes a fact to a simple string format that can be used in\n    audit trail messages to trail the value of the fact.
    \n 
    The returned string follows the pattern: fact-concept-name[fact-value]
    \n", "summary" : "
      Serializes a fact to a simple string format that can be used in\n    audit trail messages to trail the value of the fact.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "fact", "type" : "object()", "occurrence" : "?", "description" : "
     an empty-sequence or a single fact to serialize to a simple informative string
    " }, { "name" : "name", "type" : "string", "occurrence" : null, "description" : "
     an alternative name to use if the $fact is an empty-sequence otherwise the name will be taken from the fact
    " } ], "returns" : { "type" : "string", "description" : "the string with key information about the fact." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "rules", "qname" : "rules:rules", "signature" : "() as object()*", "description" : " 
    Retrieves all rules from all report schemas.
    \n", "summary" : "
      Retrieves all rules from all report schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "all rules." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "rules", "qname" : "rules:rules", "signature" : "($report-schemas-or-ids as item()*) as object()*", "description" : " 
    Return the rules from the given report schemas.
    \n", "summary" : "
      Return the rules from the given report schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "report-schemas-or-ids", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "object()*", "description" : "the rules from the report schemas." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/lock" : { "ns" : "http://www.28msec.com/modules/lock", "description" : " Sausalito provides a an application level locking mechanism that can be\n used e.g. to ensure exclusive access to data.\n As the store ensures atomicity of of single document updates, atomic\n updates to multiple documents are implemented using this mechanism.\n Locks can be acquired and re-acquired at any time during a request and\n are released at the end of the request.\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/lock", "prefix" : "lock" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "try-acquire", "qname" : "lock:try-acquire", "signature" : "($lock-name as xs:string) as xs:boolean external", "description" : " Tries to acquire a lock.\n This operation is non-blocking if the lock cannot be acquired immediately.\n To check and modify the stock of a product wihtout interference from\n concurrent requests a lock could be used like this:\n 
    \n if (lock:try-acquire(\"stock-update\"))\n then\n   if (stock:check($product-id))\n   then\n     {\n       order:finalize($order-id);\n       stock:decrement($product-id);\n     }\n   else\n     order:hold($order-id);\n else\n   ...\n 
    \n", "summary" : "
     Tries to acquire a lock.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "lock-name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the lock.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the lock could be acquired, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "try-acquire", "qname" : "lock:try-acquire", "signature" : "($lock-name as xs:string, $reason as xs:string) as xs:boolean external", "description" : " tries to acquire a lock\n", "summary" : "
     tries to acquire a lock\n
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "lock-name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the lock.
    " }, { "name" : "reason", "type" : "xs:string", "occurrence" : null, "description" : "
     a reason for the acquisition of the lock that can be used for
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the lock could be acquired, false otherwise." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/xqdoc/html" : { "ns" : "http://www.zorba-xquery.com/modules/xqdoc/html", "description" : " Convert an XQDoc document into an HTML document.\n This module contains a single convert() function\n that transform an XQDoc document into an HTML document.\n Usage:\n 
    \n let $xqdoc := xqdoc:xqdoc(\"http://expath.org/ns/file\")\n return html:convert($xqdoc)\n 
    \n", "sees" : [  ], "authors" : [ "William Candillon wcandillon at gmail dot com" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.zorba-xquery.com/modules/xqdoc/html", "prefix" : "html" }, { "uri" : "http://www.w3.org/2010/xslt-xquery-serialization", "prefix" : "o" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://www.xqdoc.org/1.0", "prefix" : "xq" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "convert", "qname" : "html:convert", "signature" : "($xqdoc as element(xq:xqdoc)) as element(div)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "xqdoc", "type" : "element(xq:xqdoc)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "element(div)", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/model" : { "ns" : "http://api.28.io/model", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/store/static/collections/ddl", "prefix" : "cddl" }, { "uri" : "http://zorba.io/modules/store/static/collections/dml", "prefix" : "cdml" }, { "uri" : "http://zorba.io/modules/store/static/indexes/ddl", "prefix" : "iddl" }, { "uri" : "http://zorba.io/modules/store/static/indexes/dml", "prefix" : "idml" }, { "uri" : "http://api.28.io/model", "prefix" : "model" }, { "uri" : "http://www.zorba-xquery.com/schemas/pul", "prefix" : "pul" }, { "uri" : "http://zorba.io/modules/reference", "prefix" : "ref" }, { "uri" : "http://www.zorba-xquery.com/schemas/xdm", "prefix" : "xdm" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "applyPUL", "qname" : "model:applyPUL", "signature" : "($pul as schema-element(pul:pending-update-list))", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "pul", "type" : "schema-element(pul:pending-update-list)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "applyPULOp", "qname" : "model:applyPULOp", "signature" : "($pul)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "pul", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "build-nodes", "qname" : "model:build-nodes", "signature" : "($definition)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "definition", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "collection-qname", "qname" : "model:collection-qname", "signature" : "($name as xs:string) as xs:QName", "description" : " Returns the QName for a collection. Returns the empty sequence if no collection with the given name exists.\n", "summary" : "
     Returns the QName for a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the collection as string
    " } ], "returns" : { "type" : "xs:QName", "description" : "the QName for the collection or the empty sequence" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "delete-node-collection", "qname" : "model:delete-node-collection", "signature" : "($collection as xs:QName, $noderef as xs:anyURI?)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "collection", "type" : "xs:QName", "occurrence" : null, "description" : "" }, { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "delete-node", "qname" : "model:delete-node", "signature" : "($noderef as xs:anyURI)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "element-node", "qname" : "model:element-node", "signature" : "($definition as schema-element(xdm:element))", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "definition", "type" : "schema-element(xdm:element)", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "find-keys", "qname" : "model:find-keys", "signature" : "($collection)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "collection", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "get-collection-names", "qname" : "model:get-collection-names", "signature" : "() as xs:string*", "description" : " Returns all collection names\n", "summary" : "
     Returns all collection names\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "collection names as a sequence of strings" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "get-collection-size", "qname" : "model:get-collection-size", "signature" : "($name as xs:string) as xs:integer", "description" : " Returns the size of a collection\n", "summary" : "
     Returns the size of a collection\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the collection as string
    " } ], "returns" : { "type" : "xs:integer", "description" : "the size of the collection" }, "errors" : [ "if the collection chosen by $name does not exist" ] }, { "isDocumented" : true, "arity" : 1, "name" : "get-collection", "qname" : "model:get-collection", "signature" : "($name as xs:string) as node()*", "description" : " Returns the whole collection with a given name\n", "summary" : "
     Returns the whole collection with a given name\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     name of collection to return
    " } ], "returns" : { "type" : "node()*", "description" : "sequence of nodes of the collection" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "get-collection", "qname" : "model:get-collection", "signature" : "($name as xs:string, $first-noderef as xs:anyURI?, $offset as xs:integer?, $limit as xs:integer)", "description" : " Returns \"a page\" of the collection (a part)\n", "summary" : "
     Returns \"a page\" of the collection (a part)\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the collection as string
    " }, { "name" : "first-noderef", "type" : "xs:anyURI", "occurrence" : "?", "description" : "" }, { "name" : "offset", "type" : "xs:integer", "occurrence" : "?", "description" : "" }, { "name" : "limit", "type" : "xs:integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "a sequence of nodes from the collection" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 4, "name" : "get-column-id", "qname" : "model:get-column-id", "signature" : "($basepath as xs:string?, $name as xs:string, $isattribute as xs:boolean, $columns) as xs:integer", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "basepath", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "isattribute", "type" : "xs:boolean", "occurrence" : null, "description" : "" }, { "name" : "columns", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:integer", "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "get-index-names", "qname" : "model:get-index-names", "signature" : "() as xs:string*", "description" : " Returns all index names\n", "summary" : "
     Returns all index names\n
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "index names as a sequence of strings" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "get-index-point", "qname" : "model:get-index-point", "signature" : "($index-name as xs:string, $index-key)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "index-name", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "index-key", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "get-node-group", "qname" : "model:get-node-group", "signature" : "($noderef as xs:anyURI)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "get-node-path", "qname" : "model:get-node-path", "signature" : "($node)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "get-node", "qname" : "model:get-node", "signature" : "($noderef as xs:anyURI)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "index-qname", "qname" : "model:index-qname", "signature" : "($name as xs:string) as xs:QName", "description" : " Returns the QName for an index. Returns the empty sequence if no index with the given name exists.\n", "summary" : "
     Returns the QName for an index.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the index as string
    " } ], "returns" : { "type" : "xs:QName", "description" : "the QName for the index or the empty sequence" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "insert-attribute", "qname" : "model:insert-attribute", "signature" : "($noderef as xs:anyURI, $attribute as xs:string, $value)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" }, { "name" : "attribute", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "value", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 4, "name" : "insert-node-collection-ordered", "qname" : "model:insert-node-collection-ordered", "signature" : "($collection as xs:QName, $noderef as xs:anyURI?, $position as xs:string, $nodes)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "collection", "type" : "xs:QName", "occurrence" : null, "description" : "" }, { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : "?", "description" : "" }, { "name" : "position", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 4, "name" : "insert-node-collection", "qname" : "model:insert-node-collection", "signature" : "($collection as xs:QName, $noderef as xs:anyURI?, $position as xs:string, $nodes)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "collection", "type" : "xs:QName", "occurrence" : null, "description" : "" }, { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : "?", "description" : "" }, { "name" : "position", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 5, "name" : "insert-node-collection", "qname" : "model:insert-node-collection", "signature" : "($collection as xs:QName, $noderef as xs:anyURI?, $position as xs:string, $nodes, $validate as xs:boolean)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "collection", "type" : "xs:QName", "occurrence" : null, "description" : "" }, { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : "?", "description" : "" }, { "name" : "position", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "validate", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "insert-node", "qname" : "model:insert-node", "signature" : "($noderef as xs:anyURI, $position as xs:string, $newnodes)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" }, { "name" : "position", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "newnodes", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 4, "name" : "make-table-row", "qname" : "model:make-table-row", "signature" : "($idx, $node, $columns, $namespaces)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "idx", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "node", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "columns", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 5, "name" : "make-table-row", "qname" : "model:make-table-row", "signature" : "($node, $path as xs:string?, $row, $columns, $namespaces)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : "?", "description" : "" }, { "name" : "row", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "columns", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "make-table", "qname" : "model:make-table", "signature" : "($nodes, $namespaces)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "node-name", "qname" : "model:node-name", "signature" : "($node as element(*), $namespaces) as xs:string", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "element(*)", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "node-path-index", "qname" : "model:node-path-index", "signature" : "($node as node(), $parent as node()) as xs:integer?", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "" }, { "name" : "parent", "type" : "node()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:integer?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "node-prefix", "qname" : "model:node-prefix", "signature" : "($node as element(*), $namespaces) as xs:string?", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "element(*)", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "node-reference", "qname" : "model:node-reference", "signature" : "($node) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "node", "qname" : "model:node", "signature" : "($definition)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "definition", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "rename-node", "qname" : "model:rename-node", "signature" : "($noderef as xs:anyURI, $name as xs:QName)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" }, { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "replace-node", "qname" : "model:replace-node", "signature" : "($noderef as xs:anyURI, $nodes)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" }, { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "replace-value", "qname" : "model:replace-value", "signature" : "($noderef as xs:anyURI, $value)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "noderef", "type" : "xs:anyURI", "occurrence" : null, "description" : "" }, { "name" : "value", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "resolve-qname", "qname" : "model:resolve-qname", "signature" : "($name as xs:QName, $namespaces) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "type-save", "qname" : "model:type-save", "signature" : "($val) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "val", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "type", "qname" : "model:type", "signature" : "($val as xs:anyAtomicType?) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "val", "type" : "xs:anyAtomicType", "occurrence" : "?", "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "unused-prefix", "qname" : "model:unused-prefix", "signature" : "($namespaces) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/validation" : { "ns" : "http://api.28.io/validation", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "http://zorba.io/modules/reflection", "prefix" : "reflection" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "resp" }, { "uri" : "http://api.28.io/validation", "prefix" : "validate" } ], "functions" : [ { "isDocumented" : false, "arity" : 3, "name" : "by-schema-array", "qname" : "validate:by-schema-array", "signature" : "($obj, $schema as array(), $path as xs:string)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "obj", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "schema", "type" : "array()", "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "by-schema-obj", "qname" : "validate:by-schema-obj", "signature" : "($obj as object(), $schema as object(), $path as xs:string)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "obj", "type" : "object()", "occurrence" : null, "description" : "" }, { "name" : "schema", "type" : "object()", "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "by-schema-primitive", "qname" : "validate:by-schema-primitive", "signature" : "($obj, $schema-type as xs:string, $path)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "obj", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "schema-type", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "path", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "by-schema", "qname" : "validate:by-schema", "signature" : "($obj as object(), $schema as object())", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "obj", "type" : "object()", "occurrence" : null, "description" : "" }, { "name" : "schema", "type" : "object()", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "expression", "qname" : "validate:expression", "signature" : "($expression as xs:string, $is-domain-expr as xs:boolean) as xs:boolean", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "expression", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "is-domain-expr", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "type", "qname" : "validate:type", "signature" : "($type as xs:string) as xs:boolean", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/sandbox" : { "ns" : "http://api.28.io/sandbox", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "http://zorba.io/modules/reference", "prefix" : "ref" }, { "uri" : "http://zorba.io/modules/reflection", "prefix" : "reflection" }, { "uri" : "http://api.28.io/sandbox", "prefix" : "sandbox" } ], "functions" : [ { "isDocumented" : false, "arity" : 3, "name" : "filter", "qname" : "sandbox:filter", "signature" : "($nodes, $xpath as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "xpath", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "get-names", "qname" : "sandbox:get-names", "signature" : "($nodes, $path as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "get-values", "qname" : "sandbox:get-values", "signature" : "($nodes, $path as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "key-constraint", "qname" : "sandbox:key-constraint", "signature" : "($nodes, $condition as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "condition", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "ns-declarations", "qname" : "sandbox:ns-declarations", "signature" : "($namespaces) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 4, "name" : "order", "qname" : "sandbox:order", "signature" : "($nodes, $path as xs:string, $descending as xs:boolean, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "path", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "descending", "type" : "xs:boolean", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 3, "name" : "tuple-constraint", "qname" : "sandbox:tuple-constraint", "signature" : "($nodes, $condition as xs:string, $namespaces)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "condition", "type" : "xs:string", "occurrence" : null, "description" : "" }, { "name" : "namespaces", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/store/static/collections/dml" : { "ns" : "http://zorba.io/modules/store/static/collections/dml", "description" : " This modules provides a set of functions to modify a collection\n and retrieve the items contained in a particular collection.\n 
    \n This module is part of\n Zorba's XQuery Data Definition Facility.\n All the collections managed by this module have to be pre-declared in the\n prolog of a module.\n Please refer to the\n general documentation\n for more information and examples.\n", "sees" : [ "Data Lifecycle", "XQuery Data Definition Facility", "http://zorba.io/modules/store/static/collections/ddl", "http://zorba.io/modules/store/static/indexes/ddl", "http://zorba.io/modules/store/static/indexes/dml", "http://zorba.io/modules/store/static/integrity-constraints/ddl", "http://zorba.io/modules/store/static/integrity-constraints/dml", "http://zorba.io/errors" ], "authors" : [ "Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/store/static/collections/dml", "prefix" : "cdml" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 3, "name" : "apply-insert-after", "qname" : "cdml:apply-insert-after", "signature" : "($name as xs:QName, $pos as item(), $content as item()*) as item()* external", "description" : " This function does the same thing as the insert-after()\n function except it immediately applies the resulting pending updates and\n returns the items that have been inserted.\n", "summary" : "
     This function does the same thing as the  insert-after() \n function except it immediately applies the resulting pending updates and\n returns the items that have been inserted.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "pos", "type" : "item()", "occurrence" : null, "description" : "" }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : "item()*", "description" : "The sequence of items that have been inserted." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const, append-only, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching.", "zerr:ZDDY0011 if $target is not in the collection." ] }, { "isDocumented" : true, "arity" : 3, "name" : "apply-insert-before", "qname" : "cdml:apply-insert-before", "signature" : "($name as xs:QName, $target as item(), $content as item()*) as item()* external", "description" : " This function does the same thing as insert-before() except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.\n", "summary" : "
     This function does the same thing as  insert-before()  except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "target", "type" : "item()", "occurrence" : null, "description" : "
     The item in the collection before which $content will be inserted.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : "item()*", "description" : "The sequence of items that have been inserted." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection $name is const, append-only, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching.", "zerr:ZDDY0011 if $target is not an item that is contained in the collection." ] }, { "isDocumented" : true, "arity" : 2, "name" : "apply-insert-first", "qname" : "cdml:apply-insert-first", "signature" : "($name as xs:QName, $content as item()*) as item()* external", "description" : " This function does the same thing as insert-first() except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.\n", "summary" : "
     This function does the same thing as  insert-first()  except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : "item()*", "description" : "The Sequence of items that have been inserted." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection $name is append-only, const, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 2, "name" : "apply-insert-last", "qname" : "cdml:apply-insert-last", "signature" : "($name as xs:QName, $content as item()*) as item()* external", "description" : " This function does the same thing as insert-last() except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.\n", "summary" : "
     This function does the same thing as  insert-last()  except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : "item()*", "description" : "The sequence of items that have been inserted." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 2, "name" : "apply-insert", "qname" : "cdml:apply-insert", "signature" : "($name as xs:QName, $content as item()*) as item()* external", "description" : " This function does the same thing as insert() except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.\n", "summary" : "
     This function does the same thing as  insert()  except it\n immediately applies the resulting pending updates and returns the items that\n have been inserted.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : "item()*", "description" : "The sequence of items that have been inserted." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is append-only, const, or queue.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 1, "name" : "collection-name", "qname" : "cdml:collection-name", "signature" : "($item as item()) as xs:QName external", "description" : " Gets the name of the collection the given item (node or JSON item) belongs\n to.\n", "summary" : "
     Gets the name of the collection the given item (node or JSON item) belongs\n to.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "item()", "occurrence" : null, "description" : "
     The item for which to get the name of its collection.
    " } ], "returns" : { "type" : "xs:QName", "description" : "The name of the collection to which the given item belongs." }, "errors" : [ "zerr:ZDDY0011 if $item does not belong to a collection." ] }, { "isDocumented" : true, "arity" : 1, "name" : "collection", "qname" : "cdml:collection", "signature" : "($name as xs:QName) as item()* external", "description" : " Gets the sequence of nodes or JSON items from a collection.\n", "summary" : "
     Gets the sequence of nodes or JSON items from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection.
    " } ], "returns" : { "type" : "item()*", "description" : "The seqnence of items from the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available." ] }, { "isDocumented" : true, "arity" : 2, "name" : "collection", "qname" : "cdml:collection", "signature" : "($name as xs:QName, $skip as xs:integer) as item()* external", "description" : " Gets the sequence of nodes or JSON items from a collection.\n", "summary" : "
     Gets the sequence of nodes or JSON items from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection.
    " }, { "name" : "skip", "type" : "xs:integer", "occurrence" : null, "description" : "
     The initial number of items to skip.
    " } ], "returns" : { "type" : "item()*", "description" : "The (sub)sequence of items from the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available." ] }, { "isDocumented" : true, "arity" : 3, "name" : "collection", "qname" : "cdml:collection", "signature" : "($name as xs:QName, $start as xs:anyURI, $skip as xs:integer) as item()* external", "description" : " Gets the sequence of items (nodes or JSON items) from a collection.\n The parameters $start and $skip can be used to\n skip over some items at the beginning of the collection.\n If both are given, both are applied:\n first $start to skip to the referenced item\n and then $skip to skip that additional number of items.\n", "summary" : "
     Gets the sequence of items (nodes or JSON items) from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection.
    " }, { "name" : "start", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The reference to the first item to return.
    " }, { "name" : "skip", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of additional items to skip.
    " } ], "returns" : { "type" : "item()*", "description" : "The sub-sequence from the collection." }, "errors" : [ "zerr:ZAPI0028 If the given URI is not a valid node position computed by the np:node-position function.", "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZSTR0066 if $start does not reference a node from the collection." ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete-first", "qname" : "cdml:delete-first", "signature" : "($name as xs:QName) external", "description" : " Deletes the first item from a collection.\n", "summary" : "
     Deletes the first item from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to delete from.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the first item from the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const or append-only.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDDY0011 if the collection is empty." ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete-first", "qname" : "cdml:delete-first", "signature" : "($name as xs:QName, $number as xs:integer) external", "description" : " Deletes the first N items from a collection.\n", "summary" : "
     Deletes the first  N  items from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to delete from.
    " }, { "name" : "number", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of items to delete.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the items from the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const or append-only.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDDY0011 if the collection contains less than $number items." ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete-last", "qname" : "cdml:delete-last", "signature" : "($name as xs:QName) external", "description" : " Deletes the last item from a collection.\n", "summary" : "
     Deletes the last item from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to delete from.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the last item from the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const, append-only, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDDY0011 if the collection is empty." ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete-last", "qname" : "cdml:delete-last", "signature" : "($name as xs:QName, $number as xs:integer) external", "description" : " Deletes the last N items from a collection.\n", "summary" : "
     Deletes the last  N  items from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to delete from.
    " }, { "name" : "number", "type" : "xs:integer", "occurrence" : null, "description" : "
     The number of items to delete.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the items." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDDY0011 if the collection contains less than $number items." ] }, { "isDocumented" : true, "arity" : 1, "name" : "delete", "qname" : "cdml:delete", "signature" : "($items as item()*) external", "description" : " Deletes items (nodes or JSON items) from a collection.\n", "summary" : "
     Deletes items (nodes or JSON items) from a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "items", "type" : "item()", "occurrence" : "*", "description" : "
     The items in the collection to delete.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the items from their collections." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const, append-only, or queue.", "zerr:ZDDY0011 if any item in $items is not a member of a collection or not all items belong to the same collection." ] }, { "isDocumented" : true, "arity" : 2, "name" : "edit", "qname" : "cdml:edit", "signature" : "($target as item(), $content as item()) external", "description" : " Edits the first supplied item so as to make it look exactly like a copy of\n the second supplied item while retaining its original identity.\n", "summary" : "
     Edits the first supplied item so as to make it look exactly like a copy of\n the second supplied item while retaining its original identity.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "target", "type" : "item()", "occurrence" : null, "description" : "
     The target item to be edited.
    " }, { "name" : "content", "type" : "item()", "occurrence" : null, "description" : "
     The item that serves as an edit goal.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, performs the edit." }, "errors" : [ "zerr:ZDDY0001 if the collection to which $target belongs is not declared.", "zerr:ZDDY0003 if the collection to which $target belongs is not available.", "zerr:ZDDY0006 if the collection to which $target belongs is append-only, const, or queue.", "zerr:ZDDY0017 if $target is not a member of a collection.", "zerr:ZDDY0037 if the collection is append-only.", "zerr:ZDDY0038 if the collection is a queue.", "zerr:ZDDY0039 if $target is not a root.", "zerr:ZDDY0040 if $target cannot be updated to match the content (for example, because the target is a node and the content is an object).", "zerr:ZDTY0001 if $content does not match the expected type (as specified in the collection declaration) according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 1, "name" : "index-of", "qname" : "cdml:index-of", "signature" : "($item as item()) as xs:integer external", "description" : " Gets the position of the given item (node or JSON item) within its\n collection.\n", "summary" : "
     Gets the position of the given item (node or JSON item) within its\n collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "item", "type" : "item()", "occurrence" : null, "description" : "
     The item to get the index of.
    " } ], "returns" : { "type" : "xs:integer", "description" : "The position of $item in its collection." }, "errors" : [ "zerr:ZDDY0011 if $item does not belong to a collection.", "zerr:ZDDY0012 if the collection is unordered." ] }, { "isDocumented" : true, "arity" : 3, "name" : "insert-after", "qname" : "cdml:insert-after", "signature" : "($name as xs:QName, $target as item(), $content as item()*) external", "description" : " The insert-after function is an updating function that inserts copies of the\n given items (nodes or JSON items) into a collection at the position\n directly following the given target item.\n", "summary" : "
     The insert-after function is an updating function that inserts copies of the\n given items (nodes or JSON items) into a collection at the position\n directly following the given target item.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "target", "type" : "item()", "occurrence" : null, "description" : "
     The item in the collection after which $content will be inserted.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, inserts the items into the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const, append-only, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching.", "zerr:ZDDY0011 if $target is not a node that is contained in the collection." ] }, { "isDocumented" : true, "arity" : 3, "name" : "insert-before", "qname" : "cdml:insert-before", "signature" : "($name as xs:QName, $target as item(), $content as item()*) external", "description" : " Inserts copies of the given items (nodes or JSON items) into a collection at\n the position directly preceding the given target item.\n", "summary" : "
     Inserts copies of the given items (nodes or JSON items) into a collection at\n the position directly preceding the given target item.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "target", "type" : "item()", "occurrence" : null, "description" : "
     The item in the collection before which $content will be inserted.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, inserts the items into the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const, append-only, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching.", "zerr:ZDDY0011 if $target is not an item that is contained in the collection." ] }, { "isDocumented" : true, "arity" : 2, "name" : "insert-first", "qname" : "cdml:insert-first", "signature" : "($name as xs:QName, $content as item()*) external", "description" : " Inserts copies of the given items (nodes or JSON items) at the beginning of\n a collection.\n", "summary" : "
     Inserts copies of the given items (nodes or JSON items) at the beginning of\n a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, inserts the items into the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is append-only, const, or queue.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 2, "name" : "insert-last", "qname" : "cdml:insert-last", "signature" : "($name as xs:QName, $content as item()*) external", "description" : " Inserts copies of the given items (nodes or JSON items) at the end of a\n collection.\n", "summary" : "
     Inserts copies of the given items (nodes or JSON items) at the end of a\n collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of itemss whose copies to insert.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, inserts the items into the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is const.", "zerr:ZDDY0012 if the collection is unordered.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 2, "name" : "insert", "qname" : "cdml:insert", "signature" : "($name as xs:QName, $content as item()*) external", "description" : " Inserts copies of the given items (nodes or JSON items) into a collection.\n Note that the insertion position of the items in the collection is not\n defined.\n", "summary" : "
     Inserts copies of the given items (nodes or JSON items) into a collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection to insert into.
    " }, { "name" : "content", "type" : "item()", "occurrence" : "*", "description" : "
     The sequence of items whose copies to insert.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, inserts the items into the collection." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available.", "zerr:ZDDY0006 if the collection is append-only, const, or queue.", "zerr:ZDTY0001 if $content does not match the expected type as specified in the collection declaration according to the rules for SequenceType Matching." ] }, { "isDocumented" : true, "arity" : 1, "name" : "truncate", "qname" : "cdml:truncate", "signature" : "($name as xs:QName) external", "description" : " Deletes the entire contents of collection.\n Please note that applying this function can not be undone in case\n an error happens during the application of the containing PUL.\n", "summary" : "
     Deletes the entire contents of collection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : true, "parameters" : [ { "name" : "name", "type" : "xs:QName", "occurrence" : null, "description" : "
     The name of the collection whose content to delete.
    " } ], "returns" : { "type" : null, "description" : "An empty XDM instance and a pending update list that, once applied, deletes the nodes." }, "errors" : [ "zerr:ZDDY0001 if the collection is not declared.", "zerr:ZDDY0003 if the collection is not available." ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/http-request" : { "ns" : "http://www.28msec.com/modules/http-request", "description" : " The request module provides functions for accessing\n information contained in the HTTP request used to evaluate the current\n query. For example, the param-names function can be used to\n retrieve all the names of the parameters contained in a request.\n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://www.28msec.com/modules/http/request#2.0", "prefix" : "req" }, { "uri" : "http://www.28msec.com/modules/http-request", "prefix" : "request" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "binary-content", "qname" : "request:binary-content", "signature" : "() as xs:base64Binary", "description" : " 
    Returns the content of the request as base64Binary.
    \n", "summary" : "
      Returns the content of the request as base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:base64Binary", "description" : "The content of the request as base64Binary." }, "errors" : [ "request:no-binary-content if the content contained in the body of the request cannot be treated as binary because it is a request with multipart or url-encoded content." ] }, { "isDocumented" : true, "arity" : 1, "name" : "binary-part", "qname" : "request:binary-part", "signature" : "($ref as xs:string) as xs:base64Binary", "description" : " 
    Returns the value of a part as base64Binary.
    \n 
    A part is identified by a reference that is the value of a\n src field returned by the request:parts function.
    \n", "summary" : "
      Returns the value of a part as base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "ref", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the part
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the value of the part as base64Binary" }, "errors" : [ "request:invalid-part if the part with the given name ($ref) does not exist", "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 0, "name" : "content-length", "qname" : "request:content-length", "signature" : "() as xs:integer?", "description" : " 
    Returns the length of the content in bytes.
    \n 
    The value returned corresponds to the value of the HTTP\n content-length header. The function returns an empty sequence\n if this header does not exist in the request or its value\n could not be converted to item of type xs:integer
    .\n", "summary" : "
      Returns the length of the content in bytes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:integer?", "description" : "The content-length in bytes of the content sent with this request or the empty sequence if the content-length header does not exist in the request." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "content-type", "qname" : "request:content-type", "signature" : "() as xs:string?", "description" : " 
    Returns the content-type of the data sent with this request.
    \n 
    Note that the content-type is only set for PUT and POST requests.
    \n", "summary" : "
      Returns the content-type of the data sent with this request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string?", "description" : "The content-type of the request if it is a PUT or POST request. Otherwise, it returns the empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "header-accept", "qname" : "request:header-accept", "signature" : "() as object()*", "description" : " 
    Returns the values of the HTTP ACCEPT header.
    \n 
    The data is returned as a sequence of objects\n as shown in the following example.
    \n 
    \n {\n   \"type\" : \"text\",\n   \"subtype\" : \"html\",\n   \"quality\" : 1\n }\n 
    \n", "summary" : "
      Returns the values of the HTTP ACCEPT header.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "The header values of the header ACCEPT or the empty sequence if the header is not contained in the request. The order of the returned objects reflects the order of the components in the header." }, "errors" : [ "request:invalid-header if the accept header cannot be parsed" ] }, { "isDocumented" : true, "arity" : 0, "name" : "header-names", "qname" : "request:header-names", "signature" : "() as xs:string*", "description" : " 
    Returns the names of all the HTTP headers in this request.
    \n 
    Header fields are colon-separated name-value pairs, terminated\n by a carriage return (CR) and line feed (LF) character sequence. The\n names and values of each header are allowed to consist of US-ASCII\n characters only.
    \n 
    The names of the headers are returned using upper-case letters.\n If a header with the same name is contained multiple times in a request,\n its name is only returned once. The order of the names in the resulting\n sequence does not reflect the order of the headers in the request. If\n a header does not have a value, it is as if the header does not exist\n in the request.
    \n 
    Note that the header names user-agent and content-type are not\n returned by this function. They are returned by the corresponding\n functions of this module module\n (e.g. user-agent).
    \n", "summary" : "
      Returns the names of all the HTTP headers in this request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "The names of the headers of this request or the empty sequence if no headers are contained in the request." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "header-value", "qname" : "request:header-value", "signature" : "($name as xs:string) as xs:string?", "description" : " 
    Returns the value of the HTTP header with the given name.
    \n 
    Header fields are colon-separated name-value pairs, terminated\n by a carriage return (CR) and line feed (LF) character sequence. The\n names and values of each header are allowed to consist of US-ASCII\n characters only.
    \n 
    Please note that header names are considered case-insensitive.\n Also note, that only one value is returned if multiple headers with the\n same names exist in the request. This value is a comma-separated list\n of the values of the headers in the order in which the headers appeared\n in the request.
    \n 
    All headers having a name that starts with SAUSALITO_ are reserved\n and will not be returned by this function.
    \n", "summary" : "
      Returns the value of the HTTP header with the given name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The header name for which the value should be returned.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The header value of the header with the $name argument or the empty sequence if no header with that name is contained in the request." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "headers", "qname" : "request:headers", "signature" : "() as object()", "description" : " 
    Returns an object containing the request's HTTP header names and\n values.
    \n 
    Header fields are colon-separated name-value pairs, terminated\n by a carriage return (CR) and line feed (LF) character sequence. The\n names and values of each header are allowed to consist of US-ASCII\n characters only.
    \n 
    The structure of the object is as shown in the following example:\n 
    \n 
    \n 
    \n 
    All headers having a name that starts with SAUSALITO_ are reserved\n and will not be returned by this function.
    \n", "summary" : "
      Returns an object containing the request's HTTP header names and\n values.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "The header value of the header with the $name argument or the empty sequence if no header with that name is contained in the request." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method-delete", "qname" : "request:method-delete", "signature" : "() as xs:boolean", "description" : " Returns true if the HTTP method of this request is DELETE.\n", "summary" : "
     Returns true if the HTTP method of this request is DELETE.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "true if the HTTP method of this request is DELETE, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method-get", "qname" : "request:method-get", "signature" : "() as xs:boolean", "description" : " Returns true if the HTTP method of this request is GET.\n", "summary" : "
     Returns true if the HTTP method of this request is GET.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "true if the HTTP method of this request is GET, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method-head", "qname" : "request:method-head", "signature" : "() as xs:boolean", "description" : " Returns true if the HTTP method of this request is HEAD.\n", "summary" : "
     Returns true if the HTTP method of this request is HEAD.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "true if the HTTP method of this request is HEAD, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method-options", "qname" : "request:method-options", "signature" : "() as xs:boolean", "description" : " Returns true if the HTTP method of this request is OPTION.\n", "summary" : "
     Returns true if the HTTP method of this request is OPTION.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "true if the HTTP method of this request is OPTION, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method-post", "qname" : "request:method-post", "signature" : "() as xs:boolean", "description" : " Returns true if the HTTP method of this request is POST.\n", "summary" : "
     Returns true if the HTTP method of this request is POST.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "true if the HTTP method of this request is POST, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method-put", "qname" : "request:method-put", "signature" : "() as xs:boolean", "description" : " Returns true if the HTTP method of this request is PUT.\n", "summary" : "
     Returns true if the HTTP method of this request is PUT.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "true if the HTTP method of this request is PUT, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "method", "qname" : "request:method", "signature" : "() as xs:string", "description" : " 
    Returns the name of the HTTP method used to make this request.
    \n", "summary" : "
      Returns the name of the HTTP method used to make this request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The request method used to make this request (i.e. GET, POST, PUT, DELETE or HEAD)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "param-names", "qname" : "request:param-names", "signature" : "() as xs:string*", "description" : " 
    Returns the names of the parameters contained in the current request.
    \n 
    Parameters are name-value pairs contained in the query string of the URL\n used to make this request. As defined in RFC 1738, the query string of a\n URL starts with a \"?\" character and ends with the character (if any).\n Additionally, such name-value pairs may be part of the request's body if\n it is a PUT or POST request and the content-type of the request is\n \"application/x-www-form-urlencoded\". Name-value pairs are separated\n using either the \"&\" or the \";\" character.
    \n 
    In general, the names and the values  are precent-encoded. This function\n does the decoding of the parameters, i.e. it returns the values being\n not percent-encoded.
    \n 
    Also, the names of each parameter (after being precent-decoded) are\n treated as UTF-8. Please see the http:param-names#1 function\n for retrieving parameter names submitted using a encoding other than UTF-8.\n 
    \n", "summary" : "
      Returns the names of the parameters contained in the current request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string*", "description" : "The names of all parameters in this request. The empty sequence is returned if there are none." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "param-names", "qname" : "request:param-names", "signature" : "($encoding as xs:string) as xs:string*", "description" : " 
    Returns the names of the parameters contained in the current request.
    \n 
    This function is similar to the request:param-names#0 function.\n However, the names are treated (after precent-decoding) using the\n given encoding supplied as parameter. For example, parameters might\n be encoded using the ISO-8859-1 encoding.
    \n", "summary" : "
      Returns the names of the parameters contained in the current request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "
     The encoding of the parameters in the request (e.g. ISO-8859-1).
    " } ], "returns" : { "type" : "xs:string*", "description" : "The names of all parameters in this request. The empty sequence is returned if there are none." }, "errors" : [ "request:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "param-values", "qname" : "request:param-values", "signature" : "($name as xs:string) as xs:string*", "description" : " 
    Returns a sequence of parameter values for the given parameter name\n which are contained in the URL's query string or the body of a POST or PUT\n request.
    \n 
    Parameters are name-value pairs contained in the query string of the URL\n used to make this request. As defined in RFC 1738, the query string of a\n URL starts with a \"?\" character and ends with the character (if any).\n Additionally, such name-value pairs may be part of the request's body if\n it is a PUT or POST request and the content-type of the request is\n \"application/x-www-form-urlencoded\". Name-value pairs are separated\n using either the \"&\" or the \";\" character.
    \n 
    In general, the names and the values  are precent-encoded. This function\n does the decoding of the parameters, i.e. it returns the values being\n not percent-encoded.
    \n 
    Also, the names and the values of each parameter (after being precent-decoded)\n are treated as UTF-8. Please see the http:param-values#3 function\n for retrieving parameters submitted using a encoding other than UTF-8.
    \n 
    This function returns the empty-sequence if no parameter with the\n given name exists in this request. If you want the function to return\n a default value other than the empty sequence, use the\n http:param-values#2 function.
    \n 
    A URL could contain the following query string:\n name1=value1&name2=value2;name1=value3&name3.\n name1=value1&name2=value2&name1=value3&name3.\n The name value pairs in this query string are\n 
      \n   
    •  name: name1; values: value1 and value3
      • \n   
    •  name: name2; value: value2
      • \n   
    •  name: name3; value: 
      • \n 
    \n 
    \n", "summary" : "
      Returns a sequence of parameter values for the given parameter name\n which are contained in the URL's query string or the body of a POST or PUT\n request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the parameter whose value(s) should be returned.
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of values for the parameter with the given name. The empty sequence is returned if no parameter exists with the given name." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "param-values", "qname" : "request:param-values", "signature" : "($name as xs:string, $default-values as xs:string*) as xs:string*", "description" : " 
    Returns a sequence of parameter values for the given parameter name\n which are contained in the URL's query string or the body of a POST or PUT\n request.
    \n 
    This function is similar to the request:param-values#1 function.\n However, instead of returning the empty-sequence as a default value it returns\n the given default-values sequence if no parameter with the given name is found\n in this request.
    \n", "summary" : "
      Returns a sequence of parameter values for the given parameter name\n which are contained in the URL's query string or the body of a POST or PUT\n request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the parameter whose value(s) should be returned.
    " }, { "name" : "default-values", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of values for the parameter with the given name. The sequence given as $default-values parameter is returned if no parameter exists with the given name." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 3, "name" : "param-values", "qname" : "request:param-values", "signature" : "($name as xs:string, $default-values as xs:string*, $encoding as xs:string) as xs:string*", "description" : " 
    Returns a sequence of parameter values for the given parameter name\n which are contained in the URL's query string or the body of a POST or PUT\n request.
    \n 
    This function is similar to the request:param-values#2 function.\n However, the names and values are treated (after precent-decoding) using the\n given encoding supplied as third parameter. For example, parameters might\n be encoded using the ISO-8859-1 encoding.
    \n", "summary" : "
      Returns a sequence of parameter values for the given parameter name\n which are contained in the URL's query string or the body of a POST or PUT\n request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of the parameter whose value(s) should be returned.
    " }, { "name" : "default-values", "type" : "xs:string", "occurrence" : "*", "description" : "" }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "
     The encoding of the parameters in the request (e.g. ISO-8859-1)
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of values for the parameter with the given name. The sequence given as $default-values parameter is returned if no parameter exists with the given name." }, "errors" : [ "request:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 0, "name" : "params", "qname" : "request:params", "signature" : "() as object()", "description" : " 
    Returns an object containg the parameter names and values contained\n in the URL's query string or the body of a POST or PUT\n request.
    \n 
    The structure of the object for the query string\n \"param1=value1;param2&param2=value2\"\n 
    \n {\n   \"param1\" : \"value1\",\n   \"param2\" : [ \"\", \"value2\" ]\n }\n 
    \n 
    \n 
    Parameters are name-value pairs contained in the query string of the URL\n used to make this request. As defined in RFC 1738, the query string of a\n URL starts with a \"?\" character and ends with the character (if any).\n Additionally, such name-value pairs may be part of the request's body if\n it is a PUT or POST request and the content-type of the request is\n \"application/x-www-form-urlencoded\". Name-value pairs are separated\n using either the \"&\" or the \";\" character.
    \n 
    In general, the names and the values  are precent-encoded. This function\n does the decoding of the parameters, i.e. it returns the values being\n not percent-encoded.
    \n 
    Also, the names and the values of each parameter (after being precent-decoded)\n are treated as UTF-8. Please see the http:params#1 function\n for retrieving parameters submitted using a encoding other than UTF-8.
    \n", "summary" : "
      Returns an object containg the parameter names and values contained\n in the URL's query string or the body of a POST or PUT\n request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "An object containing all the parameter names and values. An empty object is returned if the request doesn't contain any parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "params", "qname" : "request:params", "signature" : "($encoding as xs:string) as object()", "description" : " 
    Returns an object containg the parameter names and values contained\n in the URL's query string or the body of a POST or PUT\n request.
    \n 
    The structure of the object for the query string\n \"param1=value1;param2&param2=value2\"\n 
    \n {\n   \"param1\" : \"value1\",\n   \"param2\" : [ \"\", \"value2\" ]\n }\n 
    \n 
    \n 
    Parameters are name-value pairs contained in the query string of the URL\n used to make this request. As defined in RFC 1738, the query string of a\n URL starts with a \"?\" character and ends with the character (if any).\n Additionally, such name-value pairs may be part of the request's body if\n it is a PUT or POST request and the content-type of the request is\n \"application/x-www-form-urlencoded\". Name-value pairs are separated\n using either the \"&\" or the \";\" character.
    \n 
    In general, the names and the values  are precent-encoded. This function\n does the decoding of the parameters, i.e. it returns the values being\n not percent-encoded.
    \n 
    The name and value of each parameter (after being percent-decoded) are treated\n in the encoding given by the $encoding paramter.
    \n", "summary" : "
      Returns an object containg the parameter names and values contained\n in the URL's query string or the body of a POST or PUT\n request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "
     The encoding of the parameters in the request (e.g. ISO-8859-1)
    " } ], "returns" : { "type" : "object()", "description" : "An object containing all the parameter names and values. An empty object is returned if the request doesn't contain any parameters." }, "errors" : [ "request:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 0, "name" : "parts", "qname" : "request:parts", "signature" : "() as object()?", "description" : " 
    Returns the metadata of all parts contained in a multipart request.
    \n 
    The metadata is returned as an object\n as shown in the following example.
    \n 
    \n {\n   \"media-type\" : \"multipart/form-data; boundary=----------------------------93298e7a66a4\",\n   \"parts\" : [ {\n     \"headers\" : {\n       \"Content-Disposition\" : \"form-data; name=\\\"upload\\\"; filename=\\\"tmp.txt\\\"\",\n       \"Content-Type\" : \"text/plain\"\n     },\n     \"filename\" : \"tmp.txt\",\n     \"name\" : \"upload\",\n     \"src\" : \"urn:uuid:09be48d1-da0e-42c1-a115-a697e1779c45\",\n     \"size\" : \"153\"\n   }, {\n     \"headers\" : {\n       \"Content-Disposition\" : \"form-data; name=\\\"press\\\"\"\n     },\n     \"name\" : \"press\",\n     \"src\" : \"urn:uuid:c80e0609-b703-4d47-9171-441eb397a562\",\n     \"size\" : \"2\"\n   } ]\n }\n 
    \n 
    The media-type field describes the content-type as given in the\n request. Specifically, its value is equal to the value returned by\n request:header-values(\"Content-Type\")).
    \n 
    Each of the array members of the parts field represents one\n part of the multipart request. Each such part contains a header field\n containing one field for each headers belonging to that part.\n The value of the src field can be used to retrieve the actual value\n of the part by passing it to the http:text-part or\n http:binary-part functions. The remaining fields represent a\n parameter of the Content-Disposition header as described in RFC 2183\n (e.g. filename, name, creation-date).
    \n 
    Please note that recursive multipart content is not supported.
    \n", "summary" : "
      Returns the metadata of all parts contained in a multipart request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()?", "description" : "an object representing the metadata of the multipart content or an empty sequence if there is no content." }, "errors" : [ "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 0, "name" : "path", "qname" : "request:path", "signature" : "() as xs:string", "description" : " Return the path component of the request URI. The path starts after the\n host and ends before the query string starts.\n", "summary" : "
     Return the path component of the request URI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The path component of the request URI" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "query", "qname" : "request:query", "signature" : "() as xs:string", "description" : " 
    Returns the query string that was used to make this request.
    \n 
    The query string contains the part of the request URL that\n starts with the '?' character to the end or the starting of the\n fragment (i.e. the '#' character).
    \n", "summary" : "
      Returns the query string that was used to make this request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The query string part of the request's URL" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "remote-addr", "qname" : "request:remote-addr", "signature" : "() as xs:string", "description" : " 
    Returns the IP address of the client to which this request\n is connected.
    \n", "summary" : "
      Returns the IP address of the client to which this request\n is connected.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The IP address on the client side to which this request is connected." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "remote-port", "qname" : "request:remote-port", "signature" : "() as xs:int", "description" : " 
    Returns the port of the client to which this request is connected.
    \n", "summary" : "
      Returns the port of the client to which this request is connected.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:int", "description" : "The port on the client side to which this request is connected." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "server-name", "qname" : "request:server-name", "signature" : "() as xs:string", "description" : " 
    Returns the server name of the server running the application.
    \n 
    The web server's hostname or IP address.
    \n", "summary" : "
      Returns the server name of the server running the application.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The name of the server that runs the application accepting this request." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "server-port", "qname" : "request:server-port", "signature" : "() as xs:int", "description" : " 
    Returns the sever port to which the client making the current request\n is connected.
    \n", "summary" : "
      Returns the sever port to which the client making the current request\n is connected.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:int", "description" : "The server port to which the client is connected." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "text-content", "qname" : "request:text-content", "signature" : "() as xs:string", "description" : " 
    Returns the content of the request as string.
    \n 
    The function returns the content of the request only\n if the content-type refers to a type that can be treated\n as text (e.g. text/* or application/xml). The function raises\n an error if the content cannot be treated as text.
    \n 
    The text content is interpreted using the encoding/charset\n that is specified in the Content-Type header of the request. If\n no charset is specified, the default ISO-8859-1 is used. If a encoding\n other than the specified or default one should be used, the\n request:text-content#1 function should be used.
    \n", "summary" : "
      Returns the content of the request as string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The content of the request as a string." }, "errors" : [ "request:invalid-encoding if the encoding specified in the Content-Type header is invalid or not supported.", "request:no-text-content if the content contained in the body of the request cannot be treated as text." ] }, { "isDocumented" : true, "arity" : 1, "name" : "text-content", "qname" : "request:text-content", "signature" : "($overwrite-encoding as xs:string) as xs:string", "description" : " 
    Returns the content of the request as string interpreting\n it with the given encoding.
    \n 
    The function returns the content of the request only\n if the content-type refers to a type that can be treated\n as text (e.g. text/* or application/xml). The function raises\n an error if the content cannot be treated as text.
    \n 
    The text content is interpreted using the given encoding/charset.\n That is, the charset specified in the Content-Type header of the request\n is ignored. An error is raised if the given encoding is invalid\n or not supported.
    \n", "summary" : "
      Returns the content of the request as string interpreting\n it with the given encoding.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "overwrite-encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "The content of the request as a string." }, "errors" : [ "request:invalid-encoding if the encoding specified in the Content-Type header or the $overwrite-encoding parameter is invalid or not supported.", "request:no-text-content if the content contained in the body of the request cannot be treated as text." ] }, { "isDocumented" : true, "arity" : 1, "name" : "text-part", "qname" : "request:text-part", "signature" : "($ref as xs:string) as xs:string", "description" : " 
    Returns the value of a part as string
    \n 
    A part is identified by a reference that is the value of a\n src field returned by the request:parts function.
    \n 
    The value of the text part is interpreted using the encoding/charset\n given in the headers of the part. If no encoding is given, the default\n US-ASCII is assumed.
    \n", "summary" : "
      Returns the value of a part as string \n  A part is identified by a reference that is the value of a\n  src  field returned by the  request:parts  function.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "ref", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the part
    " } ], "returns" : { "type" : "xs:string", "description" : "the value of the part as string" }, "errors" : [ "request:invalid-encoding if the encoding given in the headers of the part is invalid or not supported.", "request:no-text-content if the value of the part cannot be treated as text", "request:invalid-part if the part with the given name ($ref) does not exist", "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 2, "name" : "text-part", "qname" : "request:text-part", "signature" : "($ref as xs:string, $overwrite-encoding as xs:string) as xs:string", "description" : " 
    Returns the value of a part as string interpreting\n it with the given encoding.
    \n 
    A part is identified by a reference that is the value of a\n src field returned by the request:parts function.
    \n", "summary" : "
      Returns the value of a part as string interpreting\n it with the given encoding.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "ref", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the part
    " }, { "name" : "overwrite-encoding", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "the value of the part as string" }, "errors" : [ "request:invalid-encoding if the encoding given using the $overwrite-encoding parameter is invalid or not supported.", "request:no-text-content if the value of the part cannot be treated as text", "request:invalid-part if the part with the given name ($ref) does not exist", "request:non-multipart if the current request does not contain multipart content", "request:invalid-multipart if the multipart content is invalid (e.g. the boundary is missing)" ] }, { "isDocumented" : true, "arity" : 0, "name" : "uri", "qname" : "request:uri", "signature" : "() as xs:string", "description" : " 
    Returns the URI that was used to make this request.
    \n 
    The value returned contains the part of the URL starting\n from the path to the end or the starting of the fragment (i.e.\n the '#' character).
    \n", "summary" : "
      Returns the URI that was used to make this request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string", "description" : "The path and query string part of the request's URL" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "user-agent", "qname" : "request:user-agent", "signature" : "() as xs:string?", "description" : " 
    Returns the user agent that made to perform the current request.
    \n 
    This function returns the value of the User-Agent header\n contained in the current request.
    \n", "summary" : "
      Returns the user agent that made to perform the current request.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:string?", "description" : "The user agent used to perform this request of the empty sequence if there was no User-Agent header in the request." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/physical-reference" : { "ns" : "http://www.28msec.com/modules/physical-reference", "description" : " The module provides functions to compute an immutable and opaque reference\n for nodes, objects, or arrays and to retrieve such items given their\n identifier, respectively.\n The identifiers are immutable, i.e. a identifier does not change\n during the items lifetime and cannot be reused for another item after the\n original item gets deleted.\n Identifiers are unique, in that, two different items will never have the same\n identifier. A item, at any time during its lifetime, can be retrieved by its\n identifier. Identifiers can only be computed for items stored in a MongoDB\n collection.\n 
    Please see the data lifecycle\n documentation about details on storing items.
    \n", "sees" : [ "Data Lifecycle" ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.28msec.com/modules/physical-reference", "prefix" : "ref" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "dereference", "qname" : "ref:dereference", "signature" : "($arg as object()) as item()? external", "description" : " 
    Returns the node, object, or array identified by the given reference.
    \n 
    The function returns the empty sequence if the item\n that is referenced does not exist.
    \n", "summary" : "
      Returns the node, object, or array identified by the given reference.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "object()", "occurrence" : null, "description" : "
     the identifier of the item to retrieve.
    " } ], "returns" : { "type" : "item()?", "description" : "the item identified by the identifier passed as parameter or the empty-sequence if no item with that URI is found." }, "errors" : [ "ref::REFERENCE is if the given identifier is invalid." ] }, { "isDocumented" : true, "arity" : 1, "name" : "reference", "qname" : "ref:reference", "signature" : "($arg as item()) as object() external", "description" : " 
    Returns an immutable and opaque reference (with type xs:anyURI) for\n a given node, object, or array.
    \n 
    The generated identifier is immutable, i.e. a identifier does not\n change during the item's lifetime and cannot be reused for another node after\n the original item gets deleted.
    \n 
    Identifiers are also unique, in that, two different items will never\n have the same identifier.
    \n A item, at any time during its lifetime, can be retrieved by its\n identifier, using the ref:dereference function.\n Please note that a reference can only be retrieved for a JSON object or JSON\n array if the item is a member of a collection.\n", "summary" : "
      Returns an immutable and opaque reference (with type xs:anyURI) for\n a given node, object, or array.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "arg", "type" : "item()", "occurrence" : null, "description" : "
     the node, object, or array for which the URI should be computed
    " } ], "returns" : { "type" : "object()", "description" : "the opaque URI of the item." }, "errors" : [ "ref::COLLECTION is raised if the object or array passed as argument is not a member of a collection." ] } ], "variables" : [  ] }, "http://zorba.io/modules/data-cleaning/conversion" : { "ns" : "http://zorba.io/modules/data-cleaning/conversion", "description" : " 
    This library module provides data conversion functions for processing calendar dates,\n temporal values, currency values, units of measurement, location names and postal addresses.
    \n 
    \n 
    The logic contained in this module is not specific to any particular XQuery implementation.
    \n", "sees" : [  ], "authors" : [ "Bruno Martins and Diogo Simões" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/data-cleaning/conversion", "prefix" : "conversion" }, { "uri" : "http://www.ecb.int/vocabulary/2002-08-01/eurofxref", "prefix" : "exref" }, { "uri" : "http://www.zorba-xquery.com/modules/http-client", "prefix" : "http" }, { "uri" : "http://zorba.io/modules/reflection", "prefix" : "reflection" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://api.whitepages.com/schema/", "prefix" : "wp" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "address-from-domain", "qname" : "conversion:address-from-domain", "signature" : "($domain as xs:string) as xs:string*", "description" : " 
    Uses a whois service to discover information about a given domain name, returning a sequence of strings\n for the addresses associated to the name.
    \n", "summary" : "
      Uses a whois service to discover information about a given domain name, returning a sequence of strings\n for the addresses associated to the name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "domain", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the addresses associated to the domain name. 
     Attention : This function is still not implemented. 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "address-from-geocode", "qname" : "conversion:address-from-geocode", "signature" : "($lat as xs:double, $lon as xs:double) as xs:string*", "description" : " 
    Geospatial coordinates to placename converter, acting as a wrapper over the Yahoo! reverse geocoder service.
    \n", "summary" : "
      Geospatial coordinates to placename converter, acting as a wrapper over the Yahoo! reverse geocoder service.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "lat", "type" : "xs:double", "occurrence" : null, "description" : "
     Geospatial latitude.
    " }, { "name" : "lon", "type" : "xs:double", "occurrence" : null, "description" : "
     Geospatial longitude.
    " } ], "returns" : { "type" : "xs:string*", "description" : "The sequence of strings corresponding to the different components (e.g., street, city, country, etc.) of the place name that corresponds to the input geospatial coordinates." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "address-from-phone", "qname" : "conversion:address-from-phone", "signature" : "($phone-number as xs:string) as xs:string*", "description" : " 
    Uses a White-pages Web service to discover information about a given phone number,\n returning a string for the address associated to the phone number.
    \n", "summary" : "
      Uses a White-pages Web service to discover information about a given phone number,\n returning a string for the address associated to the phone number.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "phone-number", "type" : "xs:string", "occurrence" : null, "description" : "
     A string with 10 digits corresponding to the phone number.
    " } ], "returns" : { "type" : "xs:string*", "description" : "A string for the addresses associated to the phone number." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "address-from-user", "qname" : "conversion:address-from-user", "signature" : "($name as xs:string) as xs:string*", "description" : " 
    Uses a White-pages Web service to discover information about a given name,\n returning a sequence of strings for the addresses associated to the name.
    \n", "summary" : "
      Uses a White-pages Web service to discover information about a given name,\n returning a sequence of strings for the addresses associated to the name.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of person or organization.
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the addresses associated to the name." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "currency-convert", "qname" : "conversion:currency-convert", "signature" : "($v as xs:double, $m1 as xs:string, $m2 as xs:string, $date as xs:string) as xs:double", "description" : " 
    Currency conversion function, acting as a wrapper over the WebService from the European Central Bank.
    \n 
    \n 
    WebService documentation at http://www.ecb.int/stats/exchange/eurofxref/html/index.en.html
    \n", "summary" : "
      Currency conversion function, acting as a wrapper over the WebService from the European Central Bank.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "v", "type" : "xs:double", "occurrence" : null, "description" : "
     The amount we wish to convert.
    " }, { "name" : "m1", "type" : "xs:string", "occurrence" : null, "description" : "
     The source currency (e.g., \"EUR\").
    " }, { "name" : "m2", "type" : "xs:string", "occurrence" : null, "description" : "
     The target currency (e.g., \"USD\").
    " }, { "name" : "date", "type" : "xs:string", "occurrence" : null, "description" : "
     The reference date.
    " } ], "returns" : { "type" : "xs:double", "description" : "The value resulting from the conversion." }, "errors" : [ "conversion:NOTSUPPORTED if the date, the source currency type or the target currency type are not known to the service." ] }, { "isDocumented" : true, "arity" : 1, "name" : "geocode-from-address", "qname" : "conversion:geocode-from-address", "signature" : "($q as xs:string*) as xs:double*", "description" : " 
    Placename to geospatial coordinates converter, acting as a wrapper over the Yahoo! geocoder service.
    \n", "summary" : "
      Placename to geospatial coordinates converter, acting as a wrapper over the Yahoo! geocoder service.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "q", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings corresponding to the different components (e.g., street, city, country, etc.) of the place name.
    " } ], "returns" : { "type" : "xs:double*", "description" : "The pair of latitude and longitude coordinates associated with the input address." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "name-from-domain", "qname" : "conversion:name-from-domain", "signature" : "($domain as xs:string) as xs:string*", "description" : " 
    Uses a whois service to discover information about a given domain name, returning a sequence of strings\n for the person or organization names associated to the name.
    \n", "summary" : "
      Uses a whois service to discover information about a given domain name, returning a sequence of strings\n for the person or organization names associated to the name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "domain", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the person or organization names associated to the domain name. 
     Attention : This function is still not implemented. 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "phone-from-address", "qname" : "conversion:phone-from-address", "signature" : "($address as xs:string) as xs:string*", "description" : " 
    Uses a White-pages Web service to discover information about a given address,\n returning a sequence of strings for the phone number associated to the address.
    \n", "summary" : "
      Uses a White-pages Web service to discover information about a given address,\n returning a sequence of strings for the phone number associated to the address.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "address", "type" : "xs:string", "occurrence" : null, "description" : "
     A string corresponding to the address (ex: 5655 E Gaskill Rd, Willcox, AZ, US).
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the phone number or organization's names associated to the address." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "phone-from-domain", "qname" : "conversion:phone-from-domain", "signature" : "($domain as xs:string) as xs:string*", "description" : " 
    Uses a whois service to discover information about a given domain name, returning a sequence of strings\n for the phone numbers associated to the name.
    \n", "summary" : "
      Uses a whois service to discover information about a given domain name, returning a sequence of strings\n for the phone numbers associated to the name.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "domain", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the phone numbers associated to the domain name. 
     Attention : This function is still not implemented. 
    " }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "phone-from-user", "qname" : "conversion:phone-from-user", "signature" : "($name as xs:string) as xs:string*", "description" : " 
    Uses a White-pages Web service to discover information about a given name,\n returning a sequence of strings for the phone numbers associated to the name.
    \n", "summary" : "
      Uses a White-pages Web service to discover information about a given name,\n returning a sequence of strings for the phone numbers associated to the name.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     The name of person or organization.
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the phone numbers associated to the name." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 4, "name" : "unit-convert", "qname" : "conversion:unit-convert", "signature" : "($v as xs:double, $t as xs:string, $m1 as xs:string, $m2 as xs:string) as xs:double", "description" : " 
    Conversion function for units of measurement, acting as a wrapper over the CuppaIT WebService.
    \n", "summary" : "
      Conversion function for units of measurement, acting as a wrapper over the CuppaIT WebService.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "v", "type" : "xs:double", "occurrence" : null, "description" : "
     The amount we wish to convert.
    " }, { "name" : "t", "type" : "xs:string", "occurrence" : null, "description" : "
     The type of metric (e.g., \"Distance\")
    " }, { "name" : "m1", "type" : "xs:string", "occurrence" : null, "description" : "
     The source measurement unit metric (e.g., \"meter\")
    " }, { "name" : "m2", "type" : "xs:string", "occurrence" : null, "description" : "
     The target measurement unit metric (e.g., \"mile\")
    " } ], "returns" : { "type" : "xs:double", "description" : "The value resulting from the conversion" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "user-from-address", "qname" : "conversion:user-from-address", "signature" : "($address as xs:string) as xs:string*", "description" : " 
    Uses a White-pages Web service to discover information about a given address,\n returning a sequence of strings for the names associated to the address.
    \n", "summary" : "
      Uses a White-pages Web service to discover information about a given address,\n returning a sequence of strings for the names associated to the address.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "address", "type" : "xs:string", "occurrence" : null, "description" : "
     A string corresponding to the address (ex: 5655 E Gaskill Rd, Willcox, AZ, US).
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the person or organization's names associated to the address." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "user-from-phone", "qname" : "conversion:user-from-phone", "signature" : "($phone-number as xs:string) as xs:string*", "description" : " 
    Uses a White-pages Web service to discover information about a given phone number,\n returning a sequence of strings for the name associated to the phone number.
    \n", "summary" : "
      Uses a White-pages Web service to discover information about a given phone number,\n returning a sequence of strings for the name associated to the phone number.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "phone-number", "type" : "xs:string", "occurrence" : null, "description" : "
     A string with 10 digits corresponding to the phone number.
    " } ], "returns" : { "type" : "xs:string*", "description" : "A sequence of strings for the person or organization's name associated to the phone number." }, "errors" : [  ] } ], "variables" : [ { "name" : "conversion:key", "type" : "item()*", "description" : " 
    The key to be used when accessing the White Pages Web service
    \n" } ] }, "http://www.28msec.com/modules/jdbc" : { "ns" : "http://www.28msec.com/modules/jdbc", "description" : " This module allows connecting, querying, and updating JDBC datasources.\n 
    The results of a query are returned as a sequence of objects:\n  { column: value } .\n The type of the value depends on the type of the column in the database:\n \n   \n   \n   \n   \n   \n   \n 
    JDBC TypesJSONiq Type
    integer, bigint, smallint, tinyintinteger
    decimal, double, float, numeric, realdouble
    boolean, bitboolean
    char, blob, longvarchar, longnvarchar, nchar, nclob, nvarchar,\n  varchar, sqlxml, date, time, timestampstring
    binary, blob, longvarbinary, varbinary, array, datalink,\n  java_object, other, refbase64Binary
    \n 
    \n 
    \n If the value of a column is null, it is mapped to the JSONiq null value.\n 
    \n 
    Connecting to a JDBC source requires the following options:\n 
      \n   
    • url: the JDBC connection URI (mandatory)
      • \n   
    • user: the user used for connecting (optional)
      • \n   
    • password: the password used for connecting (optional)
      • \n 
    \n 
    Examples:\n 
      \n  
    • \n {\n   \"url\" : \"jdbc:mysql://localhost/testdb\",\n   \"user\" : \"root\",\n   \"password\" : \"\"\n }
      • \n  
    • \n {\n   \"url\" : \"jdbc:sqlserver://192.168.1.1;databaseName=testdb\",\n   \"user\" : \"sa\",\n   \"password\" : \"\"\n }
      • \n  
    • \n {\n   \"url\" : \"jdbc:postgresql://localhost/testdb\",\n   \"user\" : \"root\",\n   \"password\" : \"\"\n }
      • \n 
    \n 
    Currently, the 28.io platform supports connections to\n 
      \n   
    • MySQL using the mariadb-java-client.jar version 1.1.2,
      • \n   
    • PostgreSQL using postgresql.jar version 9.2, and 
      • \n   
    • Microsoft SQL Server using sqljdbc4.jar version 4.0.
      • \n 
    \n 
    \n 
    If you are interested in connecting to other JDBC datasources,\n please contact us at support@28.io.
    \n 
    Important Notice Regarding Function Determinism
    \n 
    The non side-effecting functions:\n 
    \n are declared deterministic, which means that their results could be cached\n when invoked multiple times with the same arguments in the same query execution.
    \n 
    To not use cached results you can use the following alternative functions:\n 
    \n which have been declared as being non deterministic.
    \n", "sees" : [  ], "authors" : [ "Cristi Dumitru", "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://www.28msec.com/modules/jdbc", "prefix" : "jdbc" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://www.zorba-xquery.com/modules/jdbc", "prefix" : "zjdbc" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "affected-rows", "qname" : "jdbc:affected-rows", "signature" : "($dataset as anyURI) as integer", "description" : " Return the number of affected rows of an updating DataSet.\n", "summary" : "
     Return the number of affected rows of an updating DataSet.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dataset", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the DataSet.
    " } ], "returns" : { "type" : "integer", "description" : "the number of affected rows." }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "clear-params", "qname" : "jdbc:clear-params", "signature" : "($prepared-statement as anyURI) as empty-sequence()", "description" : " Clear all the parameters of the statement.\n", "summary" : "
     Clear all the parameters of the statement.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "commit", "qname" : "jdbc:commit", "signature" : "($conn as anyURI) as empty-sequence()", "description" : " Commit current transaction from an active connection.\n", "summary" : "
     Commit current transaction from an active connection.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the connection with a transaction to be commited.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL08000 Connection is closed", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 0, "name" : "connect-nondeterministic", "qname" : "jdbc:connect-nondeterministic", "signature" : "() as anyURI", "description" : " Open a connection to a database using the default credentials.\n 
    This function has the same semantics as\n connect#0,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Open a connection to a database using the default credentials.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "anyURI", "description" : "an identifier that represents the connection to the server." }, "errors" : [ "NOT-FOUND The default credentials not found.", "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "connect-nondeterministic", "qname" : "jdbc:connect-nondeterministic", "signature" : "($connection-config as item()) as anyURI", "description" : " Open a connection to a database.\n 
    This function has the same semantics as\n connect#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Open a connection to a database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "item()", "occurrence" : null, "description" : "
     object containing the configuration information.
    " } ], "returns" : { "type" : "anyURI", "description" : "an identifier that represents the connection to the server." }, "errors" : [ "NOT-FOUND The specified credentials have not been found.", "NOT-VALID Invalid connection information.", "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "connect-nondeterministic", "qname" : "jdbc:connect-nondeterministic", "signature" : "($connection-config as item(), $options as object()?) as anyURI", "description" : " Open a connection to a database.\n 
    This function has the same semantics as\n connect#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Open a connection to a database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "item()", "occurrence" : null, "description" : "
     object containing the configuration information.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     object to specify additional connection options.
    " } ], "returns" : { "type" : "anyURI", "description" : "an identifier that represents the connection to the server." }, "errors" : [ "NOT-FOUND The specified credentials have not been found.", "NOT-VALID Invalid connection information.", "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 0, "name" : "connect", "qname" : "jdbc:connect", "signature" : "() as anyURI", "description" : " Open a connection to a database using the default credentials.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The function returns an opaque URI that can represents the connection.\n This URI has to be passed to other functions of this module that require\n the $conn parameter as a first argument.
    \n", "summary" : "
     Open a connection to a database using the default credentials.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "anyURI", "description" : "an identifier that represents the connection to the server." }, "errors" : [ "NOT-FOUND The default credentials not found.", "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "connect", "qname" : "jdbc:connect", "signature" : "($connection-config as item()) as anyURI", "description" : " Open a connection to a database.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The input to the function contains the connection information.\n If a string is used, then the function will interpret it as credential name\n and will connect using the JDBC credentials with the specified name.\n If an object is used, then the function will open a connection using it.\n The object's required structure is described in the module's description.
    \n 
    The function returns an opaque URI that can represents the connection.\n This URI has to be passed to other functions of this module that require\n the $conn parameter as a first argument.
    \n", "summary" : "
     Open a connection to a database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "item()", "occurrence" : null, "description" : "
     object containing the configuration information.
    " } ], "returns" : { "type" : "anyURI", "description" : "an identifier that represents the connection to the server." }, "errors" : [ "NOT-FOUND The specified credentials have not been found.", "NOT-VALID Invalid connection information.", "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "connect", "qname" : "jdbc:connect", "signature" : "($connection-config as item(), $options as object()?) as anyURI", "description" : " Open a connection to a database.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    The input to the function contains the connection information.\n If a string is used, then the function will interpret it as credential name\n and will connect using the JDBC credentials with the specified name.\n If an object is used, then the function will open a connection using it.\n The object's required structure is described in the module's description.
    \n 
    In addition to the connection configuration, the function allows to\n specify several options:\n 
      \n   
    • autocommit: true/false turn on/off auto commit\n (default: true)
      • \n   
    • readonly: true/false configure readonly/write on this\n connection (default: false)
      • \n   
    • isolation-level: configure the isolation level for this connection\n     
        \n       
      • READ-COMMITTED: set the isolation level read-committed
        • \n       
      • READ-UNCOMMITTED: set the isolation level read-uncommitted
        • \n       
      • READ-REPEATABLE: set the isolation level repeatable-read
        • \n       
      • SERIALIZABLE: set the isolation level serializable
        • \n     
      \n   If no isolation level is provided by the user the connection will be created\n   with the default isolation level of the database.
      • \n 
    \n 
    The function returns an opaque URI that represents the connection.\n This URI has to be passed to other functions of this module that require\n the $conn parameter as a first argument.
    \n", "summary" : "
     Open a connection to a database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "item()", "occurrence" : null, "description" : "
     object containing the configuration information.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     object to specify additional connection options.
    " } ], "returns" : { "type" : "anyURI", "description" : "an identifier that represents the connection to the server." }, "errors" : [ "NOT-FOUND The specified credentials have not been found.", "NOT-VALID Invalid connection information.", "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "connection-options", "qname" : "jdbc:connection-options", "signature" : "($conn as anyURI) as object()", "description" : " Return a set with options for a specified connection.\n The returned options are equal to the options specified in function jdbc:connect.\n Consequently, the options are specified as follows:\n 
      \n   
    • autocommit: true/false shows auto commit
      • \n   
    • readonly: true/false shows if the connection is readonly/write
      • \n   
    • isolation-level: shows the isolation level for this connection\n     
        \n       
      • READ-COMMITTED: isolation level is read-committed
        • \n       
      • READ-UNCOMMITTED: isolation level is read-uncommitted
        • \n       
      • READ-REPEATABLE: isolation level is repeatable-read
        • \n       
      • SERIALIZABLE: isolation level is serializable
        • \n     
      • \n 
    \n", "summary" : "
     Return a set with options for a specified connection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the connection.
    " } ], "returns" : { "type" : "object()", "description" : "an object with the connection options." }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL08000 Connection is closed", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-prepared", "qname" : "jdbc:execute-prepared", "signature" : "($prepared-statement as anyURI) as anyURI", "description" : " Execute SQL statements prepared with jdbc:prepare-statement,\n after setting the parameters values accordingly and returns an identifier to\n a Dataset.\n", "summary" : "
     Execute SQL statements prepared with jdbc:prepare-statement,\n after setting the parameters values accordingly and returns an identifier to\n a Dataset.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " } ], "returns" : { "type" : "anyURI", "description" : "the identifier of a DataSet." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute-query-nondeterministic", "qname" : "jdbc:execute-query-nondeterministic", "signature" : "($conn as anyURI, $sql as string) as object()*", "description" : " Execute non-updating SQL statements.\n 
    This function has the same semantics as\n execute-query#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Execute non-updating SQL statements.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the active connection.
    " }, { "name" : "sql", "type" : "string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with the result data rows from the query provided." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL005 The statement is Updating type.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-query-prepared-nondeterministic", "qname" : "jdbc:execute-query-prepared-nondeterministic", "signature" : "($prepared-statement as anyURI) as object()*", "description" : " Execute non-updating SQL statements prepared with jdbc:prepare-statement,\n after setting the parameters values accordingly.\n 
    This function has the same semantics as\n execute-query-prepared#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Execute non-updating SQL statements prepared with jdbc:prepare-statement,\n after setting the parameters values accordingly.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with the result data rows from the query processed with the parameters provided." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL005 The prepared statement is an updating query.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-query-prepared", "qname" : "jdbc:execute-query-prepared", "signature" : "($prepared-statement as anyURI) as object()*", "description" : " Execute non-updating SQL statements prepared with jdbc:prepare-statement,\n after setting the parameters values accordingly.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    Every row is represented by an object of column-value representation, as\n in the module description.
    \n", "summary" : "
     Execute non-updating SQL statements prepared with jdbc:prepare-statement,\n after setting the parameters values accordingly.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with the result data rows from the query processed with the parameters provided." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL005 The prepared statement is an updating query.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute-query", "qname" : "jdbc:execute-query", "signature" : "($conn as anyURI, $sql as string) as object()*", "description" : " Execute non-updating SQL statements.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    Every row is represented by an object of column-value representation, as in\n the module description.
    \n", "summary" : "
     Execute non-updating SQL statements.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the active connection.
    " }, { "name" : "sql", "type" : "string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with the result data rows from the query provided." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL005 The statement is Updating type.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-update-prepared", "qname" : "jdbc:execute-update-prepared", "signature" : "($prepared-statement as anyURI) as integer", "description" : " Execute updating SQL statements prepared with jdbc:prepare-statement.\n", "summary" : "
     Execute updating SQL statements prepared with jdbc:prepare-statement.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " } ], "returns" : { "type" : "integer", "description" : "the number of affected rows." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL006 The prepared statement is a non-updating query.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute-update", "qname" : "jdbc:execute-update", "signature" : "($conn as anyURI, $sql as string) as integer", "description" : " Execute updating SQL statements.\n", "summary" : "
     Execute updating SQL statements.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the active connection.
    " }, { "name" : "sql", "type" : "string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "integer", "description" : "the number of affected rows." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL005 The statement is Read-only type.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute", "qname" : "jdbc:execute", "signature" : "($conn as anyURI, $sql as string) as anyURI", "description" : " Execute any kind of SQL statement.\n", "summary" : "
     Execute any kind of SQL statement.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the active connection.
    " }, { "name" : "sql", "type" : "string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "anyURI", "description" : "an identifier of a DataSet." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-connected", "qname" : "jdbc:is-connected", "signature" : "($conn as anyURI) as boolean", "description" : " Verify if a connection is still active.\n", "summary" : "
     Verify if a connection is still active.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the connection to be verified.
    " } ], "returns" : { "type" : "boolean", "description" : "true if connected, false otherwise" }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 1, "name" : "metadata", "qname" : "jdbc:metadata", "signature" : "($dataset as anyURI) as object()", "description" : " Return the metadata of the result of a DataSet.\n 
    \n More in detail, it returns information about column names, types, and whether\n a column can contain a null value.\n The metadata information can only be returned for DataSets that have been\n executed explicitly using the jdbc:execute function.\n The metadata node returned has the following structure:\n 
    {\n   \"columns\": [ {\n       \"name\": string,\n       \"type\": string,\n       \"autoincrement\"? = boolean,\n       \"nillable\"? = boolean } * ]\n }
    \n 
    \n 
    \n If the query is an updating query, then the result object will return the\n number of affected rows like:\n 
    { \"affectedrows\": integer }
    \n 
    \n", "summary" : "
     Return the metadata of the result of a DataSet.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dataset", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the DataSet.
    " } ], "returns" : { "type" : "object()", "description" : "the metadata associated with an executed DataSet." }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "parameter-metadata", "qname" : "jdbc:parameter-metadata", "signature" : "($prepared-statement as anyURI) as object()", "description" : " Retrieve the names and types of the prepared statement parameters.\n The metadata returned has the following structure:\n 
      {\n     columns: [{\n       \"name\": string,\n       \"type\": string\n       }]\n   } 
    \n", "summary" : "
     Retrieve the names and types of the prepared statement parameters.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " } ], "returns" : { "type" : "object()", "description" : "parameters metadata (name and type) associated with a prepared statement." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "prepare-statement", "qname" : "jdbc:prepare-statement", "signature" : "($conn as anyURI, $sql as string) as anyURI", "description" : " Create a prepared statement for multiple executions with diferent parameters.\n Example:\n 
    \n jdbc:prepare-statement($connection, \"SELECT * FROM users WHERE id=? AND age>?\")\n 
    \n", "summary" : "
     Create a prepared statement for multiple executions with diferent parameters.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the active connection.
    " }, { "name" : "sql", "type" : "string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "anyURI", "description" : "the identifier of the prepared statement." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "result-set", "qname" : "jdbc:result-set", "signature" : "($dataset as anyURI) as object()*", "description" : " Extract the data rows from a non-updating DataSet.\n Every row is represented by an object of column-value representation, as in\n the module description.\n", "summary" : "
     Extract the data rows from a non-updating DataSet.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dataset", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the DataSet.
    " } ], "returns" : { "type" : "object()*", "description" : "an object with the result data rows from the DataSet provided." }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "rollback", "qname" : "jdbc:rollback", "signature" : "($conn as anyURI) as empty-sequence()", "description" : " Rollback the current transaction of a connection.\n", "summary" : "
     Rollback the current transaction of a connection.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the connection with a transaction to be rollbacked.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL08000 Connection is closed", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-boolean", "qname" : "jdbc:set-boolean", "signature" : "($prepared-statement as anyURI, $parameter-index as integer, $value as boolean) as empty-sequence()", "description" : " Set the value of the designated parameter with a boolean value.\n", "summary" : "
     Set the value of the designated parameter with a  boolean  value.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " }, { "name" : "parameter-index", "type" : "integer", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "boolean", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "set-null", "qname" : "jdbc:set-null", "signature" : "($prepared-statement as anyURI, $parameter-index as integer) as empty-sequence()", "description" : " Set the value of the designated parameter with a NULL value.\n", "summary" : "
     Set the value of the designated parameter with a  NULL  value.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " }, { "name" : "parameter-index", "type" : "integer", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-numeric", "qname" : "jdbc:set-numeric", "signature" : "($prepared-statement as anyURI, $parameter-index as decimal, $value as anyAtomicType) as empty-sequence()", "description" : " Set the value of the designated parameter with a numeric value.\n", "summary" : "
     Set the value of the designated parameter with a  numeric  value.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " }, { "name" : "parameter-index", "type" : "decimal", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "anyAtomicType", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-string", "qname" : "jdbc:set-string", "signature" : "($prepared-statement as anyURI, $parameter-index as integer, $value as string) as empty-sequence()", "description" : " Set the value of the designated parameter with a string value.\n", "summary" : "
     Set the value of the designated parameter with a  string  value.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " }, { "name" : "parameter-index", "type" : "integer", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "string", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-value", "qname" : "jdbc:set-value", "signature" : "($prepared-statement as anyURI, $parameter-index as decimal, $value as anyAtomicType) as empty-sequence()", "description" : " Set the value of the designated parameter with the given value.\n The function will try to cast the value to the correct data type and assign\n it to the parameter.\n", "summary" : "
     Set the value of the designated parameter with the given value.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier of the prepared statement.
    " }, { "name" : "parameter-index", "type" : "decimal", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "anyAtomicType", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tables-nondeterministic", "qname" : "jdbc:tables-nondeterministic", "signature" : "($conn as anyURI) as object()*", "description" : " Return the list of tables from a connection.\n 
    This function has the same semantics as\n tables#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Return the list of tables from a connection.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 4, "name" : "tables-nondeterministic", "qname" : "jdbc:tables-nondeterministic", "signature" : "($conn as anyURI, $catalog as string?, $schema as string?, $table as string?) as object()*", "description" : " Return the list of tables from a connection.\n 
    This function has the same semantics as tables#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Return the list of tables from a connection.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " }, { "name" : "catalog", "type" : "string", "occurrence" : "?", "description" : "
     A filter of the catalog name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "schema", "type" : "string", "occurrence" : "?", "description" : "
     A filter of the schema name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "table", "type" : "string", "occurrence" : "?", "description" : "
     A filter of the name of the tables. Send empty-sequence for all tables.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tables", "qname" : "jdbc:tables", "signature" : "($conn as anyURI) as object()*", "description" : " Return the list of tables from a connection.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n", "summary" : "
     Return the list of tables from a connection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 4, "name" : "tables", "qname" : "jdbc:tables", "signature" : "($conn as anyURI, $catalog as string?, $schema as string?, $table as string?) as object()*", "description" : " Return the list of tables from a connection.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n", "summary" : "
     Return the list of tables from a connection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "conn", "type" : "anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " }, { "name" : "catalog", "type" : "string", "occurrence" : "?", "description" : "
     A filter of the catalog name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "schema", "type" : "string", "occurrence" : "?", "description" : "
     A filter of the schema name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "table", "type" : "string", "occurrence" : "?", "description" : "
     A filter of the name of the tables. Send empty-sequence for all tables.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] } ], "variables" : [ { "name" : "jdbc:READ-COMMITTED", "type" : "item()*", "description" : " This variable represents the READ-COMMITTED Isolation Level.\n" }, { "name" : "jdbc:READ-UNCOMMITTED", "type" : "item()*", "description" : " This variable represents the READ-UNCOMMITTED Isolation Level.\n" }, { "name" : "jdbc:REPEATABLE-READ", "type" : "item()*", "description" : " This variable represents the REPEATABLE-READ Isolation Levels.\n" }, { "name" : "jdbc:SERIALIZABLE", "type" : "item()*", "description" : " This variable represents the SERIALIZABLE Isolation Levels.\n" }, { "name" : "jdbc:CREDENTIALS-CATEGORY", "type" : "item()*", "description" : " This variable represents the category for the credentials used.\n" } ] }, "http://zorba.io/modules/full-text" : { "ns" : "http://zorba.io/modules/full-text", "description" : " This module provides an XQuery API to full-text functions.\n For general information about this implementation of the\n XQuery and XPath Full Text 1.0 specification\n as well as instructions for building an installing a thesaurus,\n see the Full Text Thesaurus documentation.\n 
    Notes on languages
    \n To refer to particular human languages,\n uses either the\n ISO 639-1\n or\n ISO 639-2\n languages codes.\n Note that only a subset of the\n complete list of language codes\n are supported and not every function supports the same subset.\n 
    \n Most functions in this module take a language as a parameter\n using the\n xs:language\n XML schema data type.\n 
    Notes on stemming
    \n The stem() functions return the\n stem\n of a word.\n The stem of a word itself, however, is not guaranteed to be a word.\n It is best to consider a stem as an opaque byte sequence.\n All that is guaranteed about a stem is that,\n for a given word,\n the stem of that word will always be the same byte sequence.\n Hence,\n you should never compare the result of one of the stem()\n functions against a non-stemmed string,\n for example:\n 
    \n  if ( ft:stem( \"apples\" ) eq \"apple\" )             ** WRONG **\n 
    \n Instead do:\n 
    \n  if ( ft:stem( \"apples\" ) eq ft:stem( \"apple\" ) )  ** CORRECT **\n 
    \n 
    Notes on the thesaurus
    \n The thesaurus-lookup() functions have \"levels\"\n and \"relationship\" parameters.\n The values for these are implementation-defined.\n The default implementation uses the\n WordNet lexical database,\n version 3.0.\n 
    \n In WordNet,\n the number of \"levels\" that two phrases are apart\n are how many hierarchical meanings apart they are.\n For example,\n \"canary\" is 5 levels away from \"vertebrate\"\n (carary > finch > oscine > passerine > bird > vertebrate).\n 
    \n When using the WordNet implementation,\n all of the relationships (and their abbreviations)\n specified by\n ISO 2788\n and\n ANSI/NISO Z39.19-2005\n with the exceptions of \"HN\" (history note)\n and \"X SN\" (see scope note for) are supported.\n These relationships are:\n  \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n    \n      \n      \n      \n    \n  
    Rel.MeaningWordNet Rel.
    BTbroader termhypernym
    BTGbroader term generichypernym
    BTIbroader term instanceinstance hypernym
    BTPbroader term partitivepart meronym
    NTnarrower termhyponym
    NTGnarrower term generichyponym
    NTInarrower term instanceinstance hyponym
    NTPnarrower term partitivepart holonym
    RTrelated termalso see
    SNscope noten/a
    TTtop termhypernym
    UFnon-preferred termn/a
    USEpreferred termn/a
    \n Note that you can specify relationships\n either by their abbreviation\n or their meaning.\n Relationships are case-insensitive.\n In addition to the\n ISO 2788\n and\n ANSI/NISO Z39.19-2005\n relationships,\n All of the relationships offered by WordNet are also supported.\n These relationships are:\n  \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n    \n      \n      \n    \n  
    RelationshipMeaning
    also see\n        A word that is related to another,\n        e.g., for \"varnished\" (furniture)\n        one should also see \"finished.\"\n      
    antonym\n        A word opposite in meaning to another,\n        e.g., \"light\" is an antonym for \"heavy.\"\n      
    attribute\n        A noun for which adjectives express values,\n        e.g., \"weight\" is an attribute\n        for which the adjectives \"light\" and \"heavy\"\n        express values.\n      
    cause\n        A verb that causes another,\n        e.g., \"show\" is a cause of \"see.\"\n      
    derivationally related form\n        A word that is derived from a root word,\n        e.g., \"metric\" is a derivationally related form of \"meter.\"\n      
    derived from adjective\n        An adverb that is derived from an adjective,\n        e.g., \"correctly\" is derived from the adjective \"correct.\"\n      
    entailment\n        A verb that presupposes another,\n        e.g., \"snoring\" entails \"sleeping.\"\n      
    hypernym\n        A word with a broad meaning that more specific words fall under,\n        e.g., \"meal\" is a hypernym of \"breakfast.\"\n      
    hyponym\n        A word of more specific meaning than a general term applicable to it,\n        e.g., \"breakfast\" is a hyponym of \"meal.\"\n      
    instance hypernym\n        A word that denotes a category of some specific instance,\n        e.g., \"author\" is an instance hypernym of \"Asimov.\"\n      
    instance hyponym\n        A term that donotes a specific instance of some general category,\n        e.g., \"Asimov\" is an instance hyponym of \"author.\"\n      
    member holonym\n        A word that denotes a collection of individuals,\n        e.g., \"faculty\" is a member holonym of \"professor.\"\n      
    member meronym\n        A word that denotes a member of a larger group,\n        e.g., a \"person\" is a member meronym of a \"crowd.\"\n      
    part holonym\n        A word that denotes a larger whole comprised of some part,\n        e.g., \"car\" is a part holonym of \"engine.\"\n      
    part meronym\n        A word that denotes a part of a larger whole,\n        e.g., an \"engine\" is part meronym of a \"car.\"\n      
    participle of verb\n        An adjective that is the participle of some verb,\n        e.g., \"breaking\" is the participle of the verb \"break.\"\n      
    pertainym\n        An adjective that classifies its noun,\n        e.g., \"musical\" is a pertainym in \"musical instrument.\"\n      
    similar to\n        Similar, though not necessarily interchangeable, adjectives.\n        For example, \"shiny\" is similar to \"bright\",\n        but they have subtle differences.\n      
    substance holonym\n        A word that denotes a larger whole containing some constituent\n        substance, e.g., \"bread\" is a substance holonym of \"flour.\"\n      
    substance meronym\n        A word that denotes a constituant substance of some larger whole,\n        e.g., \"flour\" is a substance meronym of \"bread.\"\n      
    verb group\n        A verb that is a member of a group of similar verbs,\n        e.g., \"live\" is in the verb group\n        of \"dwell\", \"live\", \"inhabit\", etc.\n      
    \n 
    Notes on tokenization
    \n For general information about the implementation of tokenization,\n including what constitutes a token,\n see the Full Text Tokenizer documentation.\n", "sees" : [  ], "authors" : [ "Paul J. Lucas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/full-text", "prefix" : "ft" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "current-compare-options", "qname" : "ft:current-compare-options", "signature" : "() as object() external", "description" : " Gets the current compare options.\n", "summary" : "
     Gets the current compare options.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "said compare options." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "current-lang", "qname" : "ft:current-lang", "signature" : "() as xs:language external", "description" : " Gets the current\n language:\n either the language specified by the\n declare ft-option using\n language\n statement (if any)\n or the one returned by ft:host-lang() (if none).\n", "summary" : "
     Gets the current\n  language :\n either the language specified by the\n  declare ft-option using \n  language \n statement (if any)\n or the one returned by  ft:host-lang()  (if none).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:language", "description" : "said language." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "host-lang", "qname" : "ft:host-lang", "signature" : "() as xs:language external", "description" : " Gets the host's current\n language.\n The \"host\" is the computer on which the software is running.\n The host's current language is obtained as follows:\n  
      \n    
    • \n      For *nix systems:\n      
        \n        
      1. \n          If setlocale(3) returns non-null,\n          the language corresponding to that locale is used.\n        
        2. \n        
      2. \n          Else, if the LANG environment variable is set,\n          that language is ued.\n        
        3. \n        
      3. \n          Otherwise, there is no default language.\n        
        4. \n      
      \n    
      • \n    
    • \n      For Windows systems,\n      the language corresponding to the locale returned by the\n      GetLocaleInfo()\n      function is used.\n    
      • \n  
    \n", "summary" : "
     Gets the host's current\n  language .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:language", "description" : "said language." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-stem-lang-supported", "qname" : "ft:is-stem-lang-supported", "signature" : "($lang as xs:language) as xs:boolean external", "description" : " Checks whether the given\n language\n is supported for stemming.\n", "summary" : "
     Checks whether the given\n  language \n is supported for stemming.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-stop-word-lang-supported", "qname" : "ft:is-stop-word-lang-supported", "signature" : "($lang as xs:language) as xs:boolean external", "description" : " Checks whether the given\n language\n is supported for stop words.\n", "summary" : "
     Checks whether the given\n  language \n is supported for stop words.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-stop-word", "qname" : "ft:is-stop-word", "signature" : "($word as xs:string) as xs:boolean external", "description" : " Checks whether the given word is a stop-word.\n", "summary" : "
     Checks whether the given word is a stop-word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurrence" : null, "description" : "
     The word to check. The word's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if $word is a stop-word." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-stop-word", "qname" : "ft:is-stop-word", "signature" : "($word as xs:string, $lang as xs:language) as xs:boolean external", "description" : " Checks whether the given word is a stop-word.\n", "summary" : "
     Checks whether the given word is a stop-word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurrence" : null, "description" : "
     The word to check.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of $word.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if $word is a stop-word." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-thesaurus-lang-supported", "qname" : "ft:is-thesaurus-lang-supported", "signature" : "($lang as xs:language) as xs:boolean external", "description" : " Checks whether the given\n language\n is supported for look-up using the default thesaurus.\n", "summary" : "
     Checks whether the given\n  language \n is supported for look-up using the default thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "is-thesaurus-lang-supported", "qname" : "ft:is-thesaurus-lang-supported", "signature" : "($uri as xs:string, $lang as xs:language) as xs:boolean external", "description" : " Checks whether the given\n language\n is supported for look-up using the thesaurus specified by the given URI.\n", "summary" : "
     Checks whether the given\n  language \n is supported for look-up using the thesaurus specified by the given URI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The URI specifying the thesaurus to use.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if the language is supported." }, "errors" : [ "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-tokenizer-lang-supported", "qname" : "ft:is-tokenizer-lang-supported", "signature" : "($lang as xs:language) as xs:boolean external", "description" : " Checks whether the given\n language\n is supported for tokenization.\n", "summary" : "
     Checks whether the given\n  language \n is supported for tokenization.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language to check.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true only if the language is supported." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "stem", "qname" : "ft:stem", "signature" : "($word as xs:string) as xs:string external", "description" : " Stems the given word.\n", "summary" : "
     Stems the given word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurrence" : null, "description" : "
     The word to stem. The word's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "xs:string", "description" : "the stem of $word." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "stem", "qname" : "ft:stem", "signature" : "($word as xs:string, $lang as xs:language) as xs:string external", "description" : " Stems the given word.\n", "summary" : "
     Stems the given word.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurrence" : null, "description" : "
     The word to stem.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of $word.
    " } ], "returns" : { "type" : "xs:string", "description" : "the stem of $word." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "strip-diacritics", "qname" : "ft:strip-diacritics", "signature" : "($string as xs:string) as xs:string external", "description" : " Strips all diacritical marks from all characters.\n", "summary" : "
     Strips all diacritical marks from all characters.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurrence" : null, "description" : "
     The string to strip diacritical marks from.
    " } ], "returns" : { "type" : "xs:string", "description" : "$string with diacritical marks stripped." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($phrase as xs:string) as xs:string* external", "description" : " Looks-up the given phrase in the default thesaurus.\n", "summary" : "
     Looks-up the given phrase in the default thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "phrase", "type" : "xs:string", "occurrence" : null, "description" : "
     The phrase to look up. The phrase's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data." ] }, { "isDocumented" : true, "arity" : 2, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($uri as xs:string, $phrase as xs:string) as xs:string* external", "description" : " Looks-up the given phrase in a thesaurus.\n", "summary" : "
     Looks-up the given phrase in a thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The URI specifying the thesaurus to use.
    " }, { "name" : "phrase", "type" : "xs:string", "occurrence" : null, "description" : "
     The phrase to look up. The phrase's language is assumed to be the one the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FTST0009 if ft:current-lang() is unsupported.", "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri.", "zerr:ZOSE0001 if the thesaurus data file could not be found.", "zerr:ZOSE0002 if the thesaurus data file is not a plain file.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data file." ] }, { "isDocumented" : true, "arity" : 3, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($uri as xs:string, $phrase as xs:string, $lang as xs:language) as xs:string* external", "description" : " Looks-up the given phrase in the thesaurus specified by the given URI.\n", "summary" : "
     Looks-up the given phrase in the thesaurus specified by the given URI.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The URI specifying the thesaurus to use.
    " }, { "name" : "phrase", "type" : "xs:string", "occurrence" : null, "description" : "
     The phrase to look up.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of $phrase.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FTST0009 if $lang is not supported.", "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri.", "zerr:ZOSE0001 if the thesaurus data file could not be found.", "zerr:ZOSE0002 if the thesaurus data file is not a plain file.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data file." ] }, { "isDocumented" : true, "arity" : 4, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($uri as xs:string, $phrase as xs:string, $lang as xs:language, $relationship as xs:string) as xs:string* external", "description" : " Looks-up the given phrase in a thesaurus.\n", "summary" : "
     Looks-up the given phrase in a thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The URI specifying the thesaurus to use.
    " }, { "name" : "phrase", "type" : "xs:string", "occurrence" : null, "description" : "
     The phrase to look up.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of $phrase.
    " }, { "name" : "relationship", "type" : "xs:string", "occurrence" : null, "description" : "
     The relationship the results are to have to $phrase.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri.", "err:FTST0009 if $lang is not supported.", "zerr:ZOSE0001 if the thesaurus data file could not be found.", "zerr:ZOSE0002 if the thesaurus data file is not a plain file.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data file." ] }, { "isDocumented" : true, "arity" : 6, "name" : "thesaurus-lookup", "qname" : "ft:thesaurus-lookup", "signature" : "($uri as xs:string, $phrase as xs:string, $lang as xs:language, $relationship as xs:string, $level-least as xs:integer, $level-most as xs:integer) as xs:string* external", "description" : " Looks-up the given phrase in a thesaurus.\n", "summary" : "
     Looks-up the given phrase in a thesaurus.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurrence" : null, "description" : "
     The URI specifying the thesaurus to use.
    " }, { "name" : "phrase", "type" : "xs:string", "occurrence" : null, "description" : "
     The phrase to look up.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of $phrase.
    " }, { "name" : "relationship", "type" : "xs:string", "occurrence" : null, "description" : "
     The relationship the results are to have to $phrase.
    " }, { "name" : "level-least", "type" : "xs:integer", "occurrence" : null, "description" : "
     The minimum number of levels within the thesaurus to be traversed.
    " }, { "name" : "level-most", "type" : "xs:integer", "occurrence" : null, "description" : "
     The maximum number of levels within the thesaurus to be traversed.
    " } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if $phrase is found in the thesaurus or the empty sequence if not." }, "errors" : [ "err:FOCA0003 if either $level-least or $level-most is either negative or too large.", "err:FTST0018 if $uri refers to a thesaurus that is not found in the statically known thesauri.", "err:FTST0009 if $lang is not supported.", "zerr:ZOSE0001 if the thesaurus data file could not be found.", "zerr:ZOSE0002 if the thesaurus data file is not a plain file.", "zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.", "zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.", "zerr:ZXQP8403 if there was an error reading the thesaurus data file." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tokenize-node", "qname" : "ft:tokenize-node", "signature" : "($node as node()) as object()* external", "description" : " Tokenizes the given node and all of its descendants.\n", "summary" : "
     Tokenizes the given node and all of its descendants.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "
     The node to tokenize. The node's default language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "tokenize-node", "qname" : "ft:tokenize-node", "signature" : "($node as node(), $lang as xs:language) as object()* external", "description" : " Tokenizes the given node and all of its decendants.\n", "summary" : "
     Tokenizes the given node and all of its decendants.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "
     The node to tokenize.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The default language of $node.
    " } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "tokenize-nodes", "qname" : "ft:tokenize-nodes", "signature" : "($includes as node()+, $excludes as node()*) as object()* external", "description" : " Tokenizes the set of nodes comprising $includes (and all of its\n descendants) but excluding $excludes (and all of its\n descendants), if any.\n", "summary" : "
     Tokenizes the set of nodes comprising  $includes  (and all of its\n descendants) but excluding  $excludes  (and all of its\n descendants), if any.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "includes", "type" : "node()", "occurrence" : "+", "description" : "
     The set of nodes (and its descendants) to include. The default language is assumed to be the one returned by ft:current-lang().
    " }, { "name" : "excludes", "type" : "node()", "occurrence" : "*", "description" : "
     The set of nodes (and its descendants) to exclude.
    " } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 3, "name" : "tokenize-nodes", "qname" : "ft:tokenize-nodes", "signature" : "($includes as node()+, $excludes as node()*, $lang as xs:language) as object()* external", "description" : " Tokenizes the set of nodes comprising $includes (and all of its\n descendants) but excluding $excludes (and all of its\n descendants), if any.\n", "summary" : "
     Tokenizes the set of nodes comprising  $includes  (and all of its\n descendants) but excluding  $excludes  (and all of its\n descendants), if any.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "includes", "type" : "node()", "occurrence" : "+", "description" : "
     The set of nodes (and its descendants) to include.
    " }, { "name" : "excludes", "type" : "node()", "occurrence" : "*", "description" : "
     The set of nodes (and its descendants) to exclude.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The default language for nodes.
    " } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tokenize-string", "qname" : "ft:tokenize-string", "signature" : "($string as xs:string) as xs:string* external", "description" : " Tokenizes the given string.\n", "summary" : "
     Tokenizes the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurrence" : null, "description" : "
     The string to tokenize. The string's language is assumed to be the one returned by ft:current-lang().
    " } ], "returns" : { "type" : "xs:string*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "tokenize-string", "qname" : "ft:tokenize-string", "signature" : "($string as xs:string, $lang as xs:language) as xs:string* external", "description" : " Tokenizes the given string.\n", "summary" : "
     Tokenizes the given string.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurrence" : null, "description" : "
     The string to tokenize.
    " }, { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of $string.
    " } ], "returns" : { "type" : "xs:string*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "err:FTST0009 if $lang is not supported." ] }, { "isDocumented" : true, "arity" : 0, "name" : "tokenizer-properties", "qname" : "ft:tokenizer-properties", "signature" : "() as object() external", "description" : " Gets properties of the tokenizer for the\n language\n returned by ft:current-lang().\n", "summary" : "
     Gets properties of the tokenizer for the\n  language \n returned by  ft:current-lang() .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "said properties." }, "errors" : [ "err:FTST0009 if ft:current-lang() is not supported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tokenizer-properties", "qname" : "ft:tokenizer-properties", "signature" : "($lang as xs:language) as object() external", "description" : " Gets properties of the tokenizer for the given\n language.\n", "summary" : "
     Gets properties of the tokenizer for the given\n  language .
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurrence" : null, "description" : "
     The language of the tokenizer to get the properties of.
    " } ], "returns" : { "type" : "object()", "description" : "said properties." }, "errors" : [ "err:FTST0009 if $lang is not supported. tokenization specifically." ] } ], "variables" : [ { "name" : "ft:LANG-DA", "type" : "xs:language", "description" : " Predeclared constant for the Danish\n xs:language.\n" }, { "name" : "ft:LANG-DE", "type" : "xs:language", "description" : " Predeclared constant for the German\n xs:language.\n" }, { "name" : "ft:LANG-EN", "type" : "xs:language", "description" : " Predeclared constant for the English\n xs:language.\n" }, { "name" : "ft:LANG-ES", "type" : "xs:language", "description" : " Predeclared constant for the Spanish\n xs:language.\n" }, { "name" : "ft:LANG-FI", "type" : "xs:language", "description" : " Predeclared constant for the Finnish\n xs:language.\n" }, { "name" : "ft:LANG-FR", "type" : "xs:language", "description" : " Predeclared constant for the French\n xs:language.\n" }, { "name" : "ft:LANG-HU", "type" : "xs:language", "description" : " Predeclared constant for the Hungarian\n xs:language.\n" }, { "name" : "ft:LANG-IT", "type" : "xs:language", "description" : " Predeclared constant for the Italian\n xs:language.\n" }, { "name" : "ft:LANG-NL", "type" : "xs:language", "description" : " Predeclared constant for the Dutch\n xs:language.\n" }, { "name" : "ft:LANG-NO", "type" : "xs:language", "description" : " Predeclared constant for the Norwegian\n xs:language.\n" }, { "name" : "ft:LANG-PT", "type" : "xs:language", "description" : " Predeclared constant for the Portuguese\n xs:language.\n" }, { "name" : "ft:LANG-RO", "type" : "xs:language", "description" : " Predeclared constant for the Romanian\n xs:language.\n" }, { "name" : "ft:LANG-RU", "type" : "xs:language", "description" : " Predeclared constant for the Russian\n xs:language.\n" }, { "name" : "ft:LANG-SV", "type" : "xs:language", "description" : " Predeclared constant for the Swedish\n xs:language.\n" }, { "name" : "ft:LANG-TR", "type" : "xs:language", "description" : " Predeclared constant for the Turkish\n xs:language.\n" } ] }, "http://www.zorba-xquery.com/modules/jdbc" : { "ns" : "http://www.zorba-xquery.com/modules/jdbc", "description" : " This module contains functions to connect to any JDBC datasource\n using jvm-util module to handle Java interaction.\n 
    Important Notice Regarding Function Determinism
    \n 
    The non side-effecting functions:\n 
    \n are declared deterministic, which means that their results could be cached\n when invoked multiple times with the same arguments in the same query execution.
    \n 
    To not use cached results you can use the following alternative functions:\n 
    \n which have been declared as being non deterministic.
    \n", "sees" : [  ], "authors" : [ "Rodolfo Ochoa", "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://www.zorba-xquery.com/modules/jdbc", "prefix" : "jdbc" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "affected-rows", "qname" : "jdbc:affected-rows", "signature" : "($dataset-id as xs:anyURI) as xs:integer external", "description" : " Return the number of affected rows of a particular DataSet.\n", "summary" : "
     Return the number of affected rows of a particular DataSet.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dataset-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a DataSet.
    " } ], "returns" : { "type" : "xs:integer", "description" : "Returns an xs:integer with the number of affected rows." }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "clear-params", "qname" : "jdbc:clear-params", "signature" : "($prepared-statement as xs:anyURI) as empty-sequence() external", "description" : " Clears the current parameter values immediately.\n", "summary" : "
     Clears the current parameter values immediately.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "close-dataset", "qname" : "jdbc:close-dataset", "signature" : "($dataset-id as xs:anyURI) as empty-sequence() external", "description" : " Closes and free resources from a particular DataSet.\n", "summary" : "
     Closes and free resources from a particular DataSet.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "dataset-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a DataSet.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "close-prepared", "qname" : "jdbc:close-prepared", "signature" : "($prepared-statement as xs:anyURI) as empty-sequence() external", "description" : " Closes and frees from memory any prepared SQL statement created with jdbc:prepare-statement\n", "summary" : "
     Closes and frees from memory any prepared SQL statement created with jdbc:prepare-statement\n
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "commit", "qname" : "jdbc:commit", "signature" : "($connection-id as xs:anyURI) as empty-sequence() external", "description" : " Commit current transaction from an active connection.\n", "summary" : "
     Commit current transaction from an active connection.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to the connection to be commited.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL08000 Connection is closed", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 1, "name" : "connect-nondeterministic", "qname" : "jdbc:connect-nondeterministic", "signature" : "($connection-config as object()) as xs:anyURI external", "description" : " Opens a connection to a database.\n 
    This function has the same semantics as connect#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Opens a connection to a database.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "object()", "occurrence" : null, "description" : "
     json object that has the host and user informations.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents the connection to the server." }, "errors" : [ "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "connect-nondeterministic", "qname" : "jdbc:connect-nondeterministic", "signature" : "($connection-config as object(), $options as object()?) as xs:anyURI external", "description" : " Opens a connection to a database with specified options.\n 
    This function has the same semantics as connect#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Opens a connection to a database with specified options.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "object()", "occurrence" : null, "description" : "
     json object that has the host and user informations.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     json object that specifies the connection options.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents the connection to the server." }, "errors" : [ "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "connect", "qname" : "jdbc:connect", "signature" : "($connection-config as object()) as xs:anyURI external", "description" : " Opens a connection to a database.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    Returns a URI identifying the connection that has been opened. The\n implementing code determines from the $connection-config either explicitly\n (interpreting the driver attribute) or implicitly (using the type attribute)\n which driver it has to load.
    \n", "summary" : "
     Opens a connection to a database.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "object()", "occurrence" : null, "description" : "
     json object that has the host and user informations.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents the connection to the server. Connection coonfiguration example: { \"url\" : \"jdbc:mysql://localhost/\", \"user\" : \"root\", \"password\" : \"\" }" }, "errors" : [ "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "connect", "qname" : "jdbc:connect", "signature" : "($connection-config as object(), $options as object()?) as xs:anyURI external", "description" : " Opens a connection to a database with specified options.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n 
    Returns a URI identifying the connection that has been opened. The\n implementing code determines from the $connection-config either explicitly\n (interpreting the driver attribute) or implicitly (using the type attribute)\n which driver it has to load.
    \n", "summary" : "
     Opens a connection to a database with specified options.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-config", "type" : "object()", "occurrence" : null, "description" : "
     json object that has the host and user informations.
    " }, { "name" : "options", "type" : "object()", "occurrence" : "?", "description" : "
     json object that specifies the connection options.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents the connection to the server. Connection options example: { \"autocommit\" : false, \"readonly\"? : true, \"isolation-level\"? : $jdbc:READ-COMMITTED }" }, "errors" : [ "SQL28000 Authentication failed.", "SQL08001 Connection error.", "SQL40003 Isolation level not supported.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "connection-options", "qname" : "jdbc:connection-options", "signature" : "($connection-id as xs:anyURI) as object() external", "description" : " Returns a set with options for a specified connection.\n", "summary" : "
     Returns a set with options for a specified connection.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to the connection to be verify.
    " } ], "returns" : { "type" : "object()", "description" : "Returns and object with the connection options. The returned options are equal to the options specified in function jdbc:connect. Consequently, the options are specified as follows: { \"autocommit\" : xs:boolean, \"readonly\" : xs:boolean, \"isolation-level\" : xs:string }" }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL08000 Connection is closed", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-prepared", "qname" : "jdbc:execute-prepared", "signature" : "($prepared-statement as xs:anyURI) as xs:anyURI external", "description" : " Executes SQL statements prepared with 5.1 jsql:prepare-statement with values set\n and returns an identifier to a Dataset.\n", "summary" : "
     Executes SQL statements prepared with 5.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents a DataSet." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute-query-nondeterministic", "qname" : "jdbc:execute-query-nondeterministic", "signature" : "($connection-id as xs:anyURI, $sql as xs:string) as object()* external", "description" : " Executes non-updating SQL statements.\n 
    This function has the same semantics as\n execute-query#2,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Executes non-updating SQL statements.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to an active connection.
    " }, { "name" : "sql", "type" : "xs:string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL005 The statement is Updating type.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-query-prepared-nondeterministic", "qname" : "jdbc:execute-query-prepared-nondeterministic", "signature" : "($prepared-statement as xs:anyURI) as object()* external", "description" : " Executes a non-updating SQL statement prepared with 5.1 jsql:prepare-statement.\n 
    This function has the same semantics as\n execute-query-prepared#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Executes a non-updating SQL statement prepared with 5.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query processed with the parameter values provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL005 The prepared statement is an updating query.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-query-prepared", "qname" : "jdbc:execute-query-prepared", "signature" : "($prepared-statement as xs:anyURI) as object()* external", "description" : " Executes a non-updating SQL statement prepared with 5.1 jsql:prepare-statement.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n", "summary" : "
     Executes a non-updating SQL statement prepared with 5.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query processed with the parameter values provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL005 The prepared statement is an updating query.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute-query", "qname" : "jdbc:execute-query", "signature" : "($connection-id as xs:anyURI, $sql as xs:string) as object()* external", "description" : " Executes non-updating SQL statements.\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n", "summary" : "
     Executes non-updating SQL statements.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to an active connection.
    " }, { "name" : "sql", "type" : "xs:string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL005 The statement is Updating type.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "execute-update-prepared", "qname" : "jdbc:execute-update-prepared", "signature" : "($prepared-statement as xs:anyURI) as xs:integer external", "description" : " Executes an updating SQL statement prepared with 5.1 jsql:prepare-statement.\n", "summary" : "
     Executes an updating SQL statement prepared with 5.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "xs:integer", "description" : "Returns an xs:integer with the number of affected rows." }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL006 The prepared statement is a non-updating query.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute-update", "qname" : "jdbc:execute-update", "signature" : "($connection-id as xs:anyURI, $sql as xs:string) as xs:integer external", "description" : " Executes updating SQL statements.\n", "summary" : "
     Executes updating SQL statements.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to an active connection.
    " }, { "name" : "sql", "type" : "xs:string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "xs:integer", "description" : "Returns an xs:integer with the number of affected rows." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL005 The statement is Read-only type.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "execute", "qname" : "jdbc:execute", "signature" : "($connection-id as xs:anyURI, $sql as xs:string) as xs:anyURI external", "description" : " Executes any kind of SQL statement.\n", "summary" : "
     Executes any kind of SQL statement.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to an active connection.
    " }, { "name" : "sql", "type" : "xs:string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents a DataSet." }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "is-connected", "qname" : "jdbc:is-connected", "signature" : "($connection-id as xs:anyURI) as xs:boolean external", "description" : " Verify if a connection is still active.\n", "summary" : "
     Verify if a connection is still active.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to the connection to be verify.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "Returns true if connected." }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 1, "name" : "metadata", "qname" : "jdbc:metadata", "signature" : "($dataset-id as xs:anyURI) as object() external", "description" : " Return the metadata of the result of a particular DataSet.\n", "summary" : "
     Return the metadata of the result of a particular DataSet.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dataset-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a DataSet.
    " } ], "returns" : { "type" : "object()", "description" : "This function returns the metadata associated with an executed DataSet. More in detail, it returns information about column names, types, and whether a column can contain a null value. The metadata information can only be returned for DataSets that have been executed explicitly using the jsql:execute function. The metadata node returned by this function is defined as follows: { \"columns\": [ { \"name\": xs:string, \"type\": xs:string, \"autoincrement\"? = xs:boolean, \"nillable\"? = xs:boolean } * ] }" }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "parameter-metadata", "qname" : "jdbc:parameter-metadata", "signature" : "($prepared-statement as xs:anyURI) as object() external", "description" : " Retrieves the number, types and properties of the prepared statement parameters.\n", "summary" : "
     Retrieves the number, types and properties of the prepared statement parameters.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " } ], "returns" : { "type" : "object()", "description" : "This function returns the parameters metadata associated with a prepared statement. In other words, it returns information about the column name associated with the parameter, the type, etc. The metadata node returned by this function is defined as follows: { columns: [{ \"name\": xs:string, \"type\": xs:string }] }" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "prepare-statement", "qname" : "jdbc:prepare-statement", "signature" : "($connection-id as xs:anyURI, $sql as xs:string) as xs:anyURI external", "description" : "  Creates a prepared statement for multiple executions with diferent values.\n", "summary" : "
      Creates a prepared statement for multiple executions with diferent values.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to an active connection.
    " }, { "name" : "sql", "type" : "xs:string", "occurrence" : null, "description" : "
     The query string to be executed.
    " } ], "returns" : { "type" : "xs:anyURI", "description" : "Return an identifier that represents the prepared statement. Example: jsql:prepare-statement($connection, \"SELECT * FROM users WHERE id=? AND age>?\")" }, "errors" : [ "SQL08003 Connection doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "result-set", "qname" : "jdbc:result-set", "signature" : "($dataset-id as xs:anyURI) as object()* external", "description" : " This function returns a sequence of objects representing the rows of data from a non-updating query.\n", "summary" : "
     This function returns a sequence of objects representing the rows of data from a non-updating query.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "dataset-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a DataSet.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the DataSet provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL008 DataSet doesn't exist.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "rollback", "qname" : "jdbc:rollback", "signature" : "($connection-id as xs:anyURI) as empty-sequence() external", "description" : " Rollback the current transaction of a connection.\n", "summary" : "
     Rollback the current transaction of a connection.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to the connection to be rollbacked.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL08003 Connection doesn't exist", "SQL08000 Connection is closed", "SQL001 Descriptive error, see error in attached message" ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-boolean", "qname" : "jdbc:set-boolean", "signature" : "($prepared-statement as xs:anyURI, $parameter-index as xs:integer, $value as xs:boolean) as empty-sequence() external", "description" : " Set the value of the designated parameter with the given value, this function will assign only boolean values.\n", "summary" : "
     Set the value of the designated parameter with the given value, this function will assign only boolean values.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " }, { "name" : "parameter-index", "type" : "xs:integer", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "xs:boolean", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 2, "name" : "set-null", "qname" : "jdbc:set-null", "signature" : "($prepared-statement as xs:anyURI, $parameter-index as xs:integer) as empty-sequence() external", "description" : " Set the value of the designated parameter with the given value, this function\n will assign only null values if possible.\n", "summary" : "
     Set the value of the designated parameter with the given value, this function\n will assign only null values if possible.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " }, { "name" : "parameter-index", "type" : "xs:integer", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-numeric", "qname" : "jdbc:set-numeric", "signature" : "($prepared-statement as xs:anyURI, $parameter-index as xs:decimal, $value as xs:anyAtomicType) as empty-sequence() external", "description" : " Set the value of the designated parameter with the given value, this function will assign only numeric values.\n", "summary" : "
     Set the value of the designated parameter with the given value, this function will assign only numeric values.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " }, { "name" : "parameter-index", "type" : "xs:decimal", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-string", "qname" : "jdbc:set-string", "signature" : "($prepared-statement as xs:anyURI, $parameter-index as xs:integer, $value as xs:string) as empty-sequence() external", "description" : " Set the value of the designated parameter with the given value, this function will assign only string values.\n", "summary" : "
     Set the value of the designated parameter with the given value, this function will assign only string values.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " }, { "name" : "parameter-index", "type" : "xs:integer", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 3, "name" : "set-value", "qname" : "jdbc:set-value", "signature" : "($prepared-statement as xs:anyURI, $parameter-index as xs:decimal, $value as xs:anyAtomicType) as empty-sequence() external", "description" : " Set the value of the designated parameter with the given value,\n this function will assign any value you send\n and it will try to cast to the correct type.\n", "summary" : "
     Set the value of the designated parameter with the given value,\n this function will assign any value you send\n and it will try to cast to the correct type.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "prepared-statement", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a prepared statement.
    " }, { "name" : "parameter-index", "type" : "xs:decimal", "occurrence" : null, "description" : "
     The index from the parameter to be set.
    " }, { "name" : "value", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     The value to be set.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "This function returns an empty-sequence()" }, "errors" : [ "SQL003 Prepared statement doesn't exist.", "SQL007 Parameter casting error.", "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tables-nondeterministic", "qname" : "jdbc:tables-nondeterministic", "signature" : "($connection-id as xs:anyURI) as object()*", "description" : " Return the list of tables from a connection\n 
    This function has the same semantics as tables#1,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Return the list of tables from a connection\n  This function has the same semantics as  tables#1 ,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 4, "name" : "tables-nondeterministic", "qname" : "jdbc:tables-nondeterministic", "signature" : "($connection-id as xs:anyURI, $catalog as xs:string?, $schema as xs:string?, $table as xs:string?) as object()* external", "description" : " Return the list of tables from a connection.\n 
    This function has the same semantics as tables#4,\n but is declared as being non deterministic and thus should only be used when\n result caching is not desired.
    \n", "summary" : "
     Return the list of tables from a connection.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " }, { "name" : "catalog", "type" : "xs:string", "occurrence" : "?", "description" : "
     A filter of the catalog name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "schema", "type" : "xs:string", "occurrence" : "?", "description" : "
     A filter of the schema name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "table", "type" : "xs:string", "occurrence" : "?", "description" : "
     A filter of the name of the tables. Send empty-sequence for all tables.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 1, "name" : "tables", "qname" : "jdbc:tables", "signature" : "($connection-id as xs:anyURI) as object()*", "description" : " Return the list of tables from a connection\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n", "summary" : "
     Return the list of tables from a connection\n  This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] }, { "isDocumented" : true, "arity" : 4, "name" : "tables", "qname" : "jdbc:tables", "signature" : "($connection-id as xs:anyURI, $catalog as xs:string?, $schema as xs:string?, $table as xs:string?) as object()* external", "description" : " Return the list of tables from a connection\n 
    This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    \n", "summary" : "
     Return the list of tables from a connection\n  This function is declared as deterministic and should be used whenever result\n caching is acceptable.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "connection-id", "type" : "xs:anyURI", "occurrence" : null, "description" : "
     The identifier to a connection.
    " }, { "name" : "catalog", "type" : "xs:string", "occurrence" : "?", "description" : "
     A filter of the catalog name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "schema", "type" : "xs:string", "occurrence" : "?", "description" : "
     A filter of the schema name of the tables. Send empty-sequence for all tables.
    " }, { "name" : "table", "type" : "xs:string", "occurrence" : "?", "description" : "
     A filter of the name of the tables. Send empty-sequence for all tables.
    " } ], "returns" : { "type" : "object()*", "description" : "Return an object with the result data rows from the query provided, the data rows are defined as follows: { column:value* }* Every row is represented by an object of column-value representation of the returned SQL result." }, "errors" : [ "SQL08000 Connection is closed.", "SQL001 Descriptive error, see error in attached message." ] } ], "variables" : [ { "name" : "jdbc:NOT-SUPPORTED", "type" : "item()*", "description" : " This variable represents the NOT-SUPPORTED level for Isolation Levels in $options for 2.2 connect function.\n" }, { "name" : "jdbc:READ-COMMITTED", "type" : "item()*", "description" : " This variable represents the READ-COMMITTED level for Isolation Levels in $options for 2.2 connect function.\n" }, { "name" : "jdbc:READ-UNCOMMITTED", "type" : "item()*", "description" : " This variable represents the READ-UNCOMMITTED level for Isolation Levels in $options for 2.2 connect function.\n" }, { "name" : "jdbc:REPEATABLE-READ", "type" : "item()*", "description" : " This variable represents the REPEATABLE-READ level for Isolation Levels in $options for 2.2 connect function.\n" }, { "name" : "jdbc:SERIALIZABLE", "type" : "item()*", "description" : " This variable represents the SERIALIZABLE level for Isolation Levels in $options for 2.2 connect function.\n" } ] }, "http://www.28msec.com/modules/http-response" : { "ns" : "http://www.28msec.com/modules/http-response", "description" : " The response module can be used to modify the HTTP response\n that will be send as a result. For example, the\n content-type function can be used to set the\n Content-Type header and determine the encoding of data in the\n response.\n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/http-response", "prefix" : "http" }, { "uri" : "http://www.w3.org/2010/xslt-xquery-serialization", "prefix" : "output" }, { "uri" : "http://www.28msec.com/modules/http/response#2.0", "prefix" : "res" }, { "uri" : "http://www.28msec.com/modules/http-response", "prefix" : "resp" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "code-for-status", "qname" : "resp:code-for-status", "signature" : "($status as xs:string) as xs:integer", "description" : " Convert between the name of the HTTP status code and\n the integer value of that status code.\n", "summary" : "
     Convert between the name of the HTTP status code and\n the integer value of that status code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:integer", "description" : "the integer value of the given status code." }, "errors" : [ "http:invalid-status if the given name does not represent a valid http status code" ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-binary", "qname" : "resp:content-type-binary", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a binary content-type. A\n content-type is considered to be binary if it's not a text\n content-type.
    \n", "summary" : "
      Test if a given content-type is a binary content-type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a binary content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-html", "qname" : "resp:content-type-html", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a HTML content-type, i.e.\n the content-type is the string \"text/html\".
    \n", "summary" : "
      Test if a given content-type is a HTML content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is the HTML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-json", "qname" : "resp:content-type-json", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a JSON content-type, i.e.\n the content-type is the string \"application/json\".
    \n", "summary" : "
      Test if a given content-type is a JSON content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is the JSON content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-mixed-json-xml", "qname" : "resp:content-type-mixed-json-xml", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a mixed JSON-XML content-type, i.e.\n the content-type is the string \"application/mixed-json-xml\".
    \n", "summary" : "
      Test if a given content-type is a mixed JSON-XML content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a mixed JSON-XML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-text", "qname" : "resp:content-type-text", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a text content-type.
    \n 
    A text content-type starts with \"text/\" or contains either of\n the strings \"xml\" or \"json\".
    \n", "summary" : "
      Test if a given content-type is a text content-type.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a text content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-xhtml", "qname" : "resp:content-type-xhtml", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a XHTML content-type, i.e.\n the content-type is the string \"application/xhtml+xml\".
    \n", "summary" : "
      Test if a given content-type is a XHTML content-type, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is the XHTML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type-xml", "qname" : "resp:content-type-xml", "signature" : "($type as xs:string) as xs:boolean", "description" : " 
    Test if a given content-type is a XML content-type
    \n 
    A XML content-type is a content-type that is \"application/xml\"\n or ends : with the string \"+xml\".
    \n", "summary" : "
      Test if a given content-type is a XML content-type \n  A XML content-type is a content-type that is \"application/xml\"\n or ends : with the string \"+xml\".
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to test.
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given content-type is a XML content-type, false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "content-type", "qname" : "resp:content-type", "signature" : "($type as xs:string) as empty-sequence()", "description" : " 
    Sets the Content-Type header for the response.
    \n 
    \n For example,\n resp:content-type(\"text/plain\") will cause the\n header\n Content-Type: text/plain to be added for the response.
    \n 
    In addtion to setting the Content-Type header, the function also\n sets the serialization parameters to the default values for serialization\n method for the given content-type. For example, if the content-type is set to\n text/plain, the default serialization parameters for the text\n serialization method will be used.
    \n 
    The functions resp:content-type-text/xml/html/xhtml/binary may be used\n to figure out which serialization method will be used for a specific\n content-type.
    \n 
    If the given content-type contains a charset declaration (e.g.\n resp:content-type(\"text/plain;charset=ISO-8859-1\")), the\n content of the response will be transcoded to the given encoding.
    \n 
    The default serialization parameters set by this function can\n be overwritten using the resp:serialization-parameters() function.
    \n", "summary" : "
      Sets the Content-Type header for the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to be set
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [ "http:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "content-type", "qname" : "resp:content-type", "signature" : "($type as xs:string, $params as object()) as empty-sequence()", "description" : " 
    Sets the Content-Type header for the response.
    \n 
    For example,\n resp:content-type(\"text/plain\") will cause the\n header\n Content-Type: text/plain to be added for the response.
    \n 
    In addition to the content-type, the function also allows to\n specify the serialization method and parameters that will be used\n for serializing the result. For details about this parameter, please\n refer to resp:serialization-parameters#1.
    \n 
    If the content-type suggest using a binary serialization,\n resp:decode-binary#1 will be called and set to true except if\n the serialization method is specified at the same time. In this\n case, the serialization method will be used as specified.
    \n 
    If the given content-type contains a charset declaration (e.g.\n resp:content-type(\"text/plain;charset=ISO-8859-1\")), the\n content of the response will be transcoded to the given encoding.\n If the serialization parameters also contain a charset declaration,\n the charset contained in the content-type will be used. to transcode\n the result.
    \n", "summary" : "
      Sets the Content-Type header for the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "type", "type" : "xs:string", "occurrence" : null, "description" : "
     the content-type to be set
    " }, { "name" : "params", "type" : "object()", "occurrence" : null, "description" : "
     the serialization parameters that will be used for serialization the result.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [ "http:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 0, "name" : "decode-binary", "qname" : "resp:decode-binary", "signature" : "() as xs:boolean", "description" : " 
    Returns the boolean indiciating whether base64Binary returned by\n this request will be decoded.
    \n 
    The default if not modified using resp:decode-binary is false.
    \n", "summary" : "
      Returns the boolean indiciating whether base64Binary returned by\n this request will be decoded.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:boolean", "description" : "the said boolean value" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "decode-binary", "qname" : "resp:decode-binary", "signature" : "($decode as xs:boolean) as empty-sequence()", "description" : " 
    If this function is invoked with true, the result of the request\n will not be serialized. Instead, the result will be the binary values\n of any item that is of type base64Binary. The values of all other\n items will not be part of the result.
    \n 
    Please note that all serialization parameters which have been set using\n resp:serialization-parameters will be ignored. Also, the output encoding\n is ignored for binaries.
    \n", "summary" : "
      If this function is invoked with true, the result of the request\n will not be serialized.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "decode", "type" : "xs:boolean", "occurrence" : null, "description" : "
     boolean value indicating whether base64Binary should be decoded.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "encoding", "qname" : "resp:encoding", "signature" : "($encoding as xs:string) as empty-sequence()", "description" : " 
    The function sets the output encoding that will be\n used for the payload of the response.
    \n 
    For example,\n resp:encoding(\"ISO-8859-1\") will cause the\n content in the response to be encoded using ISO-8859-1.
    \n 
    Please note that the encoding only applies to textual data.\n It is not used if the function decode-binary()\n was invoked passing true as parameter.
    \n", "summary" : "
      The function sets the output encoding that will be\n used for the payload of the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "
     the encoding to be used for the payload of the response.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and returns the empty sequence" }, "errors" : [ "http:invalid-encoding if the given encoding is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "header", "qname" : "resp:header", "signature" : "($name as xs:string, $value as xs:string) as xs:string?", "description" : " 
    Set a HTTP header in the response.
    \n 
    If a header with the same name was already set, the\n value is overwritten and the function returns the old value. As defined\n in the HTTP specification, multiple headers with the same name\n can be combined into one header whose value is a comma-separated\n list of the values.
    \n 
    The following headers must not be set using this function.\n Instead, other functions of this module should be used in order\n to implemented the required semantics:\n 
      \n   
    • Status: use status() instead
      • \n   
    • Content-Type: use content-type() instead
      • \n 
    \n 
    \n", "summary" : "
      Set a HTTP header in the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "name", "type" : "xs:string", "occurrence" : null, "description" : "
     the name of the header to set
    " }, { "name" : "value", "type" : "xs:string", "occurrence" : null, "description" : "
     the value of the header to set `
    " } ], "returns" : { "type" : "xs:string?", "description" : "the value of the header previously set or the empty sequence if no header has been set with the same name." }, "errors" : [ "resp:invalid-header-name if an invalid name is used for the header." ] }, { "isDocumented" : true, "arity" : 1, "name" : "message-for-status", "qname" : "resp:message-for-status", "signature" : "($status as xs:string) as xs:string", "description" : " Convert between the HTTP status code as string and\n the name/message of that status code.\n", "summary" : "
     Convert between the HTTP status code as string and\n the name/message of that status code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "the message for the given name" }, "errors" : [ "http:invalid-status if the given name does not represent a valid http status code" ] }, { "isDocumented" : true, "arity" : 1, "name" : "redirect", "qname" : "resp:redirect", "signature" : "($url as xs:string) as empty-sequence()", "description" : " This function sets the HTTP 302 redirect status code in the response. As\n a result, a redirect to the URL given as parameter will be made.\n", "summary" : "
     This function sets the HTTP 302 redirect status code in the response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "url", "type" : "xs:string", "occurrence" : null, "description" : "
     The URL to which the redirect will be made.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The empty-sequence is returned." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serialization-parameters", "qname" : "resp:serialization-parameters", "signature" : "() as object()", "description" : " 
    Returns the serialization parameters that are currently\n active, i.e. the ones that will be used to serialize the result\n of this request.
    \n 
    This will either be the default, the defaults set when\n calling resp:content-type(), or the ones set by\n resp:serialization-parameters().
    \n", "summary" : "
      Returns the serialization parameters that are currently\n active, i.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "the said serialization parameters" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "serialization-parameters", "qname" : "resp:serialization-parameters", "signature" : "($params as object()) as empty-sequence()", "description" : " 
    Set the serialization parameters used for serializing the result\n of the request.
    \n 
    The following example shows how to set several options\n for the JSON serialization method.\n 
    \n {\n   \"method\" : \"json\",\n   \"indent\" : false,\n   \"encoding\" : \"UTF-16\"\n }\n 
    \n 
    \n 
    Please note that serialization options set by this function can\n be overwritten by a subsequent call to resp:content-type. In this\n case, the options will be reset to the default for the given\n content-type. Also note, that the output encoding can be overwritten\n by subsequently calling the resp:encoding function.
    \n", "summary" : "
      Set the serialization parameters used for serializing the result\n of the request.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "params", "type" : "object()", "occurrence" : null, "description" : "
     the serialization parameters that will be used to serialize the result of the request
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the function is sequential and, on success, returns the empty sequence." }, "errors" : [ "err:XQDY0027 if the input is not valid", "http:invalid-encoding if the encoding specified in the serialization options is invalid or not supported." ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-html", "qname" : "resp:serializer-defaults-html", "signature" : "() as object()", "description" : " 
    Returns an object that can be used to specify the\n settings of serialization parameters for the HTML serialization\n method.
    \n 
    The defaults are\n 
    \n {\n   \"encoding\" : \"UTF-8\",\n   \"indent\" : true,\n   \"method\" : \"html\",\n   \"version\" : \"4.01\",\n   \"doctype-system\" : \"http://www.w3.org/TR/html4/loose.dtd\",\n   \"doctype-public\" : \"-//W3C//DTD HTML 4.01 Transitional//EN\"\n }\n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some HTML content-type (i.e. text/html).
    \n", "summary" : "
      Returns an object that can be used to specify the\n settings of serialization parameters for the HTML serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "an object that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-json-xml-hybrid", "qname" : "resp:serializer-defaults-json-xml-hybrid", "signature" : "() as object()", "description" : " 
    Returns an object that can be used to specify the\n settings of serialization parameters for the json\n serialization method.
    \n 
    The defaults are\n 
    \n {\n   \"encoding\" : \"UTF-8\",\n   \"indent\" : \"yes\",\n   \"method\" : \"json\"\n }\n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some XML content-type (e.g. application/atom+xml).
    \n", "summary" : "
      Returns an object that can be used to specify the\n settings of serialization parameters for the json\n serialization method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "an object that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-json", "qname" : "resp:serializer-defaults-json", "signature" : "() as object()", "description" : " 
    Returns an object that can be used to specify the\n settings of serialization parameters for the json-xml hybrid\n serialization method.
    \n 
    The defaults are\n 
    \n {\n   \"encoding\" : \"UTF-8\",\n   \"indent\" : \"yes\",\n   \"method\" : \"json\"\n }\n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to application/mixed-json-xml.
    \n", "summary" : "
      Returns an object that can be used to specify the\n settings of serialization parameters for the json-xml hybrid\n serialization method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "an object that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-text", "qname" : "resp:serializer-defaults-text", "signature" : "() as object()", "description" : " 
    Returns an object that can be used to specify the\n settings of serialization parameters for the text serialization\n method.
    \n 
    The only default used is\n 
    \n {\n  \"method\" : \"text\",\n  \"encoding\" : \"UTF-8\",\n }\n 
    \n 
    \n 
    For example, this default is used when setting\n the content-type to some text content-type (e.g. text/plain).
    \n", "summary" : "
      Returns an object that can be used to specify the\n settings of serialization parameters for the text serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "an object that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-xhtml", "qname" : "resp:serializer-defaults-xhtml", "signature" : "() as object()", "description" : " 
    Returns an object that can be used to specify the\n settings of serialization parameters for the XHTML serialization\n method.
    \n 
    The defaults are\n 
    \n {\n   \"encoding\" : \"UTF-8\",\n   \"indent\" : true,\n   \"method\" : \"xhtml\",\n   \"omit-xml-declaration\" : true,\n   \"version\" : \"1.0\",\n   \"doctype-system\" : \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\",\n   \"doctype-public\" : \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n }\n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some XHTML content-type (i.e. application/xhtml+xml).
    \n", "summary" : "
      Returns an object that can be used to specify the\n settings of serialization parameters for the XHTML serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "an object that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "serializer-defaults-xml", "qname" : "resp:serializer-defaults-xml", "signature" : "() as object()", "description" : " 
    Returns an object that can be used to specify the\n settings of serialization parameters for the XML serialization\n method.
    \n 
    The defaults are\n 
    \n {\n  \"method\" : \"xml\",\n  \"encoding\" : \"UTF-8\",\n  \"indent\" : true,\n  \"omit-xml-declaration\" : true,\n  \"version\" : \"1.0\"\n }\n 
    \n 
    \n 
    For example, those defaults are used when setting\n the content-type to some XML content-type (e.g. application/atom+xml).
    \n", "summary" : "
      Returns an object that can be used to specify the\n settings of serialization parameters for the XML serialization\n method.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "an object that can be used to specify the above serialization parameters." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "status-code", "qname" : "resp:status-code", "signature" : "($status as xs:integer) as empty-sequence()", "description" : " 
    Sets the status code of the HTTP response to the integer given as\n parameter.
    \n For example,\n resp:status(204)\n will result in \"HTTP/1.1 204 No Content\".\n", "summary" : "
      Sets the status code of the HTTP response to the integer given as\n parameter.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:integer", "occurrence" : null, "description" : "
     The status code of the HTTP response as integer.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "On success, the empty-sequence is returned" }, "errors" : [ "http:invalid-status-code if the given integer does not reflect a valid HTTP status code" ] }, { "isDocumented" : true, "arity" : 1, "name" : "status", "qname" : "resp:status", "signature" : "($status as xs:string) as empty-sequence()", "description" : " 
    Sets the status code of the HTTP response to code associated\n with the given string.
    \n 
    For example,\n resp:status($http:no-content)\n will result in \"HTTP/1.1 204 No Content\".
    \n", "summary" : "
      Sets the status code of the HTTP response to code associated\n with the given string.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "
     The status code of the HTTP response as a string (e.g. $http:no-content)
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "On success, the empty-sequence is returned" }, "errors" : [ "http:invalid-status if the given string does not represent a valid HTTP status code;" ] }, { "isDocumented" : true, "arity" : 1, "name" : "valid-status", "qname" : "resp:valid-status", "signature" : "($status as xs:string) as xs:boolean", "description" : " Test whether the given name refers to a valid HTTP status code.\n", "summary" : "
     Test whether the given name refers to a valid HTTP status code.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "status", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:boolean", "description" : "true if the given name refers to a valid HTTP status code, false otherwise." }, "errors" : [  ] } ], "variables" : [ { "name" : "http:precondition-required", "type" : "item()*", "description" : " A string representing the HTTP Status Code 428 Precondition Required (RFC 6585)\n" }, { "name" : "http:gone", "type" : "item()*", "description" : " A string representing the HTTP Status Code 410 GONE\n" }, { "name" : "http:length-required", "type" : "item()*", "description" : " A string representing the HTTP Status Code 411 Length Required\n" }, { "name" : "http:precondition-failed", "type" : "item()*", "description" : " A string representing the HTTP Status Code 412 Precondition Failed\n" }, { "name" : "http:request-entity-too-large", "type" : "item()*", "description" : " A string representing the HTTP Status Code 413 Request Entity Too Large\n" }, { "name" : "http:request-entity-too-long", "type" : "item()*", "description" : " A string representing the HTTP Status Code 414 Request Entity Too Long\n" }, { "name" : "http:unsupported-media-type", "type" : "item()*", "description" : " A string representing the HTTP Status Code 415 Unsupported Media Type\n" }, { "name" : "http:request-range-not-satisfiable", "type" : "item()*", "description" : " A string representing the HTTP Status Code 416 Request Range Not Satisfiable\n" }, { "name" : "http:expectation-failed", "type" : "item()*", "description" : " A string representing the HTTP Status Code 417 Expectation Failed\n" }, { "name" : "http:im-a-teapot", "type" : "item()*", "description" : " A string representing the HTTP Status Code 418 I'm a teapot (RFC 2324)\n" }, { "name" : "http:enhance-your-calm", "type" : "item()*", "description" : " A string representing the HTTP Status Code 420 Enhance Your Calm\n" }, { "name" : "http:unprocessable-entity", "type" : "item()*", "description" : " A string representing the HTTP Status Code 422 Unprocessable Entity (WebDAV; RFC 4918)\n" }, { "name" : "http:locked", "type" : "item()*", "description" : " A string representing the HTTP Status Code 423 Locked (WebDAV; RFC 4918)\n" }, { "name" : "http:failed-dependency", "type" : "item()*", "description" : " A string representing the HTTP Status Code 424 Failed Dependency (WebDAV; RFC 4918)\n" }, { "name" : "http:unordered-collection", "type" : "item()*", "description" : " A string representing the HTTP Status Code 425 Unordered Collection\n" }, { "name" : "http:upgrade-required", "type" : "item()*", "description" : " A string representing the HTTP Status Code 426 Upgrade Required\n" }, { "name" : "http:conflict", "type" : "item()*", "description" : " A string representing the HTTP Status Code 409 Conflict\n" }, { "name" : "http:too-many-requests", "type" : "item()*", "description" : " A string representing the HTTP Status Code 429 Too Many Requests (RFC 6585)\n" }, { "name" : "http:request-header-fields-too-large", "type" : "item()*", "description" : " A string representing the HTTP Status Code 431 Request Header Fields Too Large (RFC 6585)\n" }, { "name" : "http:internal-server-error", "type" : "item()*", "description" : " A string representing the HTTP Status Code 500 Internal Server Error\n" }, { "name" : "http:not-implemented", "type" : "item()*", "description" : " A string representing the HTTP Status Code 501 Not Implemented\n" }, { "name" : "http:bad-gateway", "type" : "item()*", "description" : " A string representing the HTTP Status Code 502 Bad Gateway\n" }, { "name" : "http:service-unavailable", "type" : "item()*", "description" : " A string representing the HTTP Status Code 503 Service Unavailable\n" }, { "name" : "http:gateway-timeout", "type" : "item()*", "description" : " A string representing the HTTP Status Code 504 Gateway Timeout\n" }, { "name" : "http:http-version-not-supported", "type" : "item()*", "description" : " A string representing the HTTP Status Code 505 HTTP Version Not Supported\n" }, { "name" : "http:variant-also-negotiates", "type" : "item()*", "description" : " A string representing the HTTP Status Code 506 Variant Also Negotiates (RFC 2295)\n" }, { "name" : "http:insufficient-storage", "type" : "item()*", "description" : " A string representing the HTTP Status Code 507 Insufficient Storage (WebDAV; RFC 4918)\n" }, { "name" : "http:loop-detected", "type" : "item()*", "description" : " A string representing the HTTP status code 508 Loop Detected (webdav; rfc 5842)\n" }, { "name" : "http:not-extended", "type" : "item()*", "description" : " A string representing the HTTP status code 510 Not Extended (RFC 2774)\n" }, { "name" : "http:network-authentication-required", "type" : "item()*", "description" : " A string representing the HTTP status code 511 Network Authentication Required (RFC 6585)\n" }, { "name" : "resp:status-info", "type" : "object()", "description" : " Variable containing a description for all the HTTP Status Codes\n" }, { "name" : "http:see-other", "type" : "item()*", "description" : " A string representing the HTTP Status Code 303 See Other\n" }, { "name" : "http:switching-protocols", "type" : "item()*", "description" : " A string representing the HTTP Status Code 101 Switching Protocols\n" }, { "name" : "http:processing", "type" : "item()*", "description" : " A string representing the HTTP Status Code 102 Processing (Web; RFC 2518)\n" }, { "name" : "http:ok", "type" : "item()*", "description" : " A string representing the HTTP Status Code 200 OK\n" }, { "name" : "http:created", "type" : "item()*", "description" : " A string representing the HTTP Status Code 201 Created\n" }, { "name" : "http:accepted", "type" : "item()*", "description" : " A string representing the HTTP Status Code 202 Accepted\n" }, { "name" : "http:non-authoritative", "type" : "item()*", "description" : " A string representing the HTTP Status Code 203 Non-Authoritative\n" }, { "name" : "http:no-content", "type" : "item()*", "description" : " A string representing the HTTP Status Code 204 No Content\n" }, { "name" : "http:reset-content", "type" : "item()*", "description" : " A string representing the HTTP Status Code 205 Reset Content\n" }, { "name" : "http:partial-content", "type" : "item()*", "description" : " A string representing the HTTP Status Code 206 Partial Content\n" }, { "name" : "http:multi-status", "type" : "item()*", "description" : " A string representing the HTTP Status Code 207 Multi-Status (WebDAV; RFC 5842)\n" }, { "name" : "http:already-reported", "type" : "item()*", "description" : " A string representing the HTTP Status Code 208 Already Reported (WebDAV; RFC 5842)\n" }, { "name" : "http:im-used", "type" : "item()*", "description" : " A string representing the HTTP Status Code 226 IM Used (RFC 3229)\n" }, { "name" : "http:multiple-choices", "type" : "item()*", "description" : " A string representing the HTTP Status Code 300 Multiple Choices\n" }, { "name" : "http:moved-permanently", "type" : "item()*", "description" : " A string representing the HTTP Status Code 301 Moved Permantently\n" }, { "name" : "http:found", "type" : "item()*", "description" : " A string representing the HTTP Status Code 302 Found\n" }, { "name" : "http:continue", "type" : "item()*", "description" : " A string representing the HTTP Status Code 100 Continue\n" }, { "name" : "http:not-modified", "type" : "item()*", "description" : " A string representing the HTTP Status Code 304 Not Modified\n" }, { "name" : "http:use-proxy", "type" : "item()*", "description" : " A string representing the HTTP Status Code 305 Use Proxy\n" }, { "name" : "http:switch-proxy", "type" : "item()*", "description" : " A string representing the HTTP Status Code 306 Switch Proxy\n" }, { "name" : "http:temporary-redirect", "type" : "item()*", "description" : " A string representing the HTTP Status Code 307 Temporary Redirect\n" }, { "name" : "http:permanent-redirect", "type" : "item()*", "description" : " A string representing the HTTP Status Code 308 Permanent Redirect (http://tools.ietf.org/html/draft-reschke-http-status-308-07)\n" }, { "name" : "http:bad-request", "type" : "item()*", "description" : " A string representing the HTTP Status Code 400 Bad Request\n" }, { "name" : "http:unauthorized", "type" : "item()*", "description" : " A string representing the HTTP Status Code 401 Unauthorized\n" }, { "name" : "http:payment-required", "type" : "item()*", "description" : " A string representing the HTTP Status Code 402 Payment Required\n" }, { "name" : "http:forbidden", "type" : "item()*", "description" : " A string representing the HTTP Status Code 403 Forbidden\n" }, { "name" : "http:not-found", "type" : "item()*", "description" : " A string representing the HTTP Status Code 404 Not Found\n" }, { "name" : "http:not-allowed", "type" : "item()*", "description" : " A string representing the HTTP Status Code 405 Not Allowed\n" }, { "name" : "http:not-acceptable", "type" : "item()*", "description" : " A string representing the HTTP Status Code 406 Not Acceptable\n" }, { "name" : "http:proxy-authentication-required", "type" : "item()*", "description" : " A string representing the HTTP Status Code 407 Proxy Authentication Required\n" }, { "name" : "http:request-timeout", "type" : "item()*", "description" : " A string representing the HTTP Status Code 408 Request Timeout\n" } ] }, "http://www.zorba-xquery.com/modules/email/smtp" : { "ns" : "http://www.zorba-xquery.com/modules/email/smtp", "description" : " This module can be used for sending emails.\n The SMTP module contains only one public function that receives two parameters.\n The SMTP server access information passed as an hostInfo element\n and the email message representation as a message element.\n For a quick start see the examples associates with the send(...)\n function. For a complete specification read, the description and the\n documentation associated with this function.\n", "sees" : [ "c-client Library part of UW IMAP toolkit" ], "authors" : [ "Sorin Nasoi, Daniel Thomas" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.zorba-xquery.com/modules/email", "prefix" : "email" }, { "uri" : "http://www.zorba-xquery.com/modules/email/smtp", "prefix" : "smtp" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "send", "qname" : "smtp:send", "signature" : "($host-info as element(email:hostInfo), $message as element(email:message)) as empty-sequence()", "description" : " This function sends an email message from the specified account.\n The hostName child element of $host-info must have the form:\n remote_system_name [\":\" port] [flags]. This syntax is part of the\n Remote names\n syntax defined in the UW IMAP toolkit. The remote_system_name and\n flags fragments are explained in the section III of this document.\n For example the hostName could look like:\n 
      \n   
    • <hostName>smtp.gmail.com:587/tls/novalidate-cert<hostName>
      • \n   
    • <hostName>[209.85.129.111]:587/tls/novalidate-cert<hostName>
      • \n 
    \n The $host-info parameter could then look like this:\n 
    \n <hostInfo>\n   <hostName>smtp.gmail.com:587/tls/novalidate-cert</hostName>\n   <userName>username</userName>\n   <password>password</password>\n </hostInfo>\n 
    \n For a complete of the structure of an email message, see the imported email\n schema: http://www.zorba-xquery.com/modules/email\n All the data passed to this function does not need to be validated.\n The only requirement is that they have a valid format and are in the\n correct namespace according to the schema:\n http://www.zorba-xquery.com/modules/email.\n", "summary" : "
     This function sends an email message from the specified account.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "host-info", "type" : "element(email:hostInfo)", "occurrence" : null, "description" : "
     The SMTP host, user name, and password.
    " }, { "name" : "message", "type" : "element(email:message)", "occurrence" : null, "description" : "
     The message to send as defined in the email XML schema.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "The function is declared as sequential and has side-effects. It returns the empty sequence." }, "errors" : [ "smtp:SMTP0001 The message format is invalid.", "smtp:SMTP0002 The message has no recipient.", "smtp:SMTP0003 The message could not be sent.", "smtp:SMTP9999 If any other error occurs.", "err:XQDY0027 If the values of the arguments are not not valid according to the email schema: http://www.zorba-xquery.com/modules/email" ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/project" : { "ns" : "http://www.28msec.com/modules/project", "description" : " This module contains functions to introspect a project.\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://zorba.io/modules/base64", "prefix" : "base64" }, { "uri" : "http://zorba.io/modules/hmac", "prefix" : "hmac" }, { "uri" : "http://www.28msec.com/modules/project", "prefix" : "project" }, { "uri" : "http://zorba.io/modules/random", "prefix" : "random" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "create-seed", "qname" : "project:create-seed", "signature" : "() as string", "description" : " Creates and return new random project seed.\n", "summary" : "
     Creates and return new random project seed.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "the project seed" }, "errors" : [ "project:SEED-EXISTS the project already has a seed file", "project:SEED-FILE error writing the seed file", "project:SEED the specified seed is not at least 8 characters long" ] }, { "isDocumented" : true, "arity" : 1, "name" : "create-seed", "qname" : "project:create-seed", "signature" : "($seed as string) as empty-sequence()", "description" : " Creates a new project seed.\n The specified seed must be at least 8 characters long.\n", "summary" : "
     Creates a new project seed.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "seed", "type" : "string", "occurrence" : null, "description" : "
     The new project seed.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the empty sequence" }, "errors" : [ "project:SEED-EXISTS the project already has a seed file", "project:SEED-FILE error writing the seed file" ] }, { "isDocumented" : true, "arity" : 0, "name" : "has-seed", "qname" : "project:has-seed", "signature" : "() as boolean external", "description" : " Checks if the project has a seed file.\n", "summary" : "
     Checks if the project has a seed file.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "boolean", "description" : "whether the project has a seed file or not" }, "errors" : [ "project:SEED-FILE error accessing the seed file" ] }, { "isDocumented" : true, "arity" : 0, "name" : "name", "qname" : "project:name", "signature" : "() as string external", "description" : " Returns the name of the project.\n", "summary" : "
     Returns the name of the project.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "the said name" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "read-or-create-seed", "qname" : "project:read-or-create-seed", "signature" : "() as string", "description" : " Returns the project seed. If the project has no seed a new random one is created.\n", "summary" : "
     Returns the project seed.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "the project seed" }, "errors" : [ "project:SEED-FILE error reading or writing the seed file" ] }, { "isDocumented" : true, "arity" : 0, "name" : "scheduler-host", "qname" : "project:scheduler-host", "signature" : "() as string external", "description" : " Returns the host of the scheduler.\n", "summary" : "
     Returns the host of the scheduler.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "the scheduler host." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 0, "name" : "seed", "qname" : "project:seed", "signature" : "() as string external", "description" : " Returns the project seed.\n", "summary" : "
     Returns the project seed.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "the project seed" }, "errors" : [ "project:NO-SEED the project seed file cannot be found", "project:SEED-FILE error reading the seed file" ] }, { "isDocumented" : true, "arity" : 0, "name" : "set-seed", "qname" : "project:set-seed", "signature" : "() as string", "description" : " Sets a new random project seed.\n", "summary" : "
     Sets a new random project seed.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "string", "description" : "the project seed" }, "errors" : [ "project:SEED-FILE error reading or writing the seed file" ] }, { "isDocumented" : true, "arity" : 1, "name" : "set-seed", "qname" : "project:set-seed", "signature" : "($seed as string) as empty-sequence()", "description" : " Sets the project seed.\n The specified seed must be at least 8 characters long.\n", "summary" : "
     Sets the project seed.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "seed", "type" : "string", "occurrence" : null, "description" : "
     The new project seed.
    " } ], "returns" : { "type" : "empty-sequence()", "description" : "the project seed" }, "errors" : [ "project:SEED-FILE error reading or writing the seed file", "project:SEED the specified seed is not at least 8 characters long" ] }, { "isDocumented" : true, "arity" : 0, "name" : "token", "qname" : "project:token", "signature" : "() as xs:base64Binary", "description" : " Creates a new project token, that expires after 12 hours.\n", "summary" : "
     Creates a new project token, that expires after 12 hours.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:base64Binary", "description" : "the project token" }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "token", "qname" : "project:token", "signature" : "($expiration as xs:anyAtomicType) as xs:base64Binary", "description" : " Creates a new project token, that expires at the desired date.\n The input to the function contains the expiration information.\n If a duration is used, then the function will create a token expiring after the specified duration.\n If a dateTime is used, then the function will create a token expiring that date.\n If an integer is used, then the function will create a token expiring after the specified number of seconds.\n", "summary" : "
     Creates a new project token, that expires at the desired date.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "expiration", "type" : "xs:anyAtomicType", "occurrence" : null, "description" : "
     describes the expiration date of the token.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the new project token" }, "errors" : [ "project:INVALID-PARAMETER expiration information is invalid (not a duration, date or number of seconds)" ] } ], "variables" : [  ] }, "http://zorba.io/modules/http-client" : { "ns" : "http://zorba.io/modules/http-client", "description" : " 
    \n This module provides functions for performing HTTP requests.\n 
    \n 
    A simple GET request using the get#1 convenience function
    \n 
    \n import module namespace http=\"http://zorba.io/modules/http-client\";\n http:get(\"http://www.example.com\")\n 
    \n 
    \n This example makes a GET request to example.com and returns the server's response\n as a JSON object.\n 
    \n 
    \n {\n   \"status\" : 200,\n   \"message\" : \"OK\",\n   \"headers\" : {\n     \"Content-Length\" : \"1270\",\n     \"Date\" : \"Tue, 11 Jun 2013 22:27:10 GMT\",\n     ...\n   },\n   \"body\" : {\n     \"media-type\" : \"text/html\",\n     \"content\" : \"...\"\n   }\n }\n 
    \n 
    Response format
    \n 
    Most functions in this module (all except options#1)\n return a single JSON item, describing the server's response, as in the previous\n example.\n The server status (integer) and message (string) fields are always present.\n If the server replied sending one or more headers, they are reported\n in an optional headers object. Each header is represented as a single (string)\n field.
    \n 
    For non-multipart responses, as in the previous example, the response body,\n if any, is reported as a body object. This object contains both the (string)\n media-type returned by the server and its content.\n The type of the content field is determined by the media-type returned by the\n server. If the media-type indicates that the body content is textual,\n then the content has type string, base64Binary otherwise.\n Specifically, the body content is considered textual only if the MIME-type specified in\n the media-type is one of:\n 
      \n   
    • \"application/json\"
      • \n   
    • \"application/x-javascript\"
      • \n   
    • \"application/xml\"
      • \n   
    • \"application/xml-external-parsed-entity\"
      • \n 
    \n or if the MIME-type starts with \"text/\" or ends with \"+xml\".
    \n 
    For multipart responses, multiple bodies are returned, as in the following example: 
    \n 
    \n {\n   \"status\" : 200,\n   \"message\" : \"OK\",\n   \"headers\" : {\n     \"Date\" : \"Tue, 11 Jun 2013 22:34:13 GMT\",\n     ...\n   },\n   \"multipart\" : {\n     \"boundary\": \"--AaB03x\",\n     \"parts\": [\n       {\n         \"headers\" : {\n            \"Content Disposition: file\",\n            ...\n         },\n         \"body\": {\n           \"media-type\" : \"image/gif\",\n           \"content\" : \"...\"\n         }\n       },\n       {\n         \"body\" : {\n           \"media-type\" : \"text/html\",\n           \"content\" : \"...\"\n         }\n       }\n    ]\n }\n 
    \n 
    The multipart field contains both the boundary used to separate parts\n and an array containing all parts. Each part contains its specific headers,\n if any, and the corresponding body.
    \n 
    Important Notice Regarding Nondeterministic Functions
    \n 
    \n The following functions in this module -\n get#1,\n get-text#1,\n get-binary#1,\n send-nondeterministic-request-1,\n head#1, and\n options#1\n are declared to be nondeterministic, which means that their results\n will not be cached.\n However, they are not declared to be\n sequential, which means that they may be re-ordered during query optimization.\n According to the HTTP RFC, GET, HEAD an OPTIONS requests should not have any side-effects.\n However, in practice it is not uncommon, especially for GET requests, to have side-effects.\n If your application depends on the ordering of side-effects from requests issued through\n these functions, you should either use the send-request()\n function (which is declared sequential), or alternatively\n wrap each call to get() in your own sequential function, to ensure\n that the requests are not reordered.\n Conversely, if you want their results to be cached you can use the\n send-deterministic-request()\n function (which is declared deterministic).\n 
    \n 
    $href Arguments to Functions
    \n 
    Several functions in this module accept a URL argument named $href. In\n all cases, the value passed to $href must be a valid anyURI.\n However, all functions declare $href to be of type string. This\n is for convenience, since you can pass a string literal value (that\n is, a URL in double-quotes spelled out explicitly in your query)\n to an string parameter.
    \n 
    Relation to the EXPath http-client module
    \n 
    EXPath defines its own http-client\n module, which is available separately.\n There are two primary differences between EXPath's http-client and\n this module:\n 
      \n   
    1. EXPath does not include the simpler get(), post(), put(), delete(),\n head(), options() and patch() functions defined by this module.
      2. \n 
    2. EXPath uses XML to represent request for its send-request() function,\n whereas this module uses JSON.
      3. \n 
    3. EXPath specifies that all XML content returned by an HTTP server\n will be parsed and returned as an XML document, whereas all HTML content\n will be tidied up into valid XML, and then parsed into an element.\n This module returns any textual content as string and any binary content\n as base6Binary.
      4. \n 
    4. EXPath accepts XML nodes as body in the send-request() function and\n automatically serializes them into a string. The send-request() function\n defined in this module only allows string, base64Binary, and hexBinary\n as body types.\n 
      5. \n 
    \n 
    \n 
    \n See the full spec\n of the EXPath http-client module for more information.\n 
    \n", "sees" : [ "XQuery 1.1: Function Declaration" ], "authors" : [ "Federico Cavalieri" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/http-client", "prefix" : "http" }, { "uri" : "http://jsoniq.org/function-library", "prefix" : "libjn" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "delete", "qname" : "http:delete", "signature" : "($href as string) as object()", "description" : " 
    \n This function makes an HTTP DELETE request to a given URL.\n 
    \n", "summary" : "
      \n This function makes an HTTP DELETE request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 1, "name" : "get-binary", "qname" : "http:get-binary", "signature" : "($href as string) as object()", "description" : " 
    \n This function makes a GET request on a given URL. All returned bodies\n are forced to be interpreted as binary data, and will be returned\n as base64Binary items.\n 
    \n", "summary" : "
      \n This function makes a GET request on a given URL.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified href is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 1, "name" : "get-text", "qname" : "http:get-text", "signature" : "($href as string) as object()", "description" : " 
    \n This function makes a GET request to a given URL. All returned bodies\n are forced to be interpreted as textual, with a UTF-8 charset and will\n be returned as string items.\n 
    \n", "summary" : "
      \n This function makes a GET request to a given URL.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified href is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 1, "name" : "get", "qname" : "http:get", "signature" : "($href as string) as object()", "description" : " 
    \n This function makes a GET request to a given URL.\n 
    \n", "summary" : "
      \n This function makes a GET request to a given URL.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified href is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 1, "name" : "head", "qname" : "http:head", "signature" : "($href as string) as object()", "description" : " 
    \n This function makes an HTTP HEAD request on a given URL.\n 
    \n", "summary" : "
      \n This function makes an HTTP HEAD request on a given URL.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified href is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 1, "name" : "options", "qname" : "http:options", "signature" : "($href as string) as string*", "description" : " 
    \n This function makes an HTTP OPTIONS request, which asks the server\n which operations it supports.\n 
    \n", "summary" : "
      \n This function makes an HTTP OPTIONS request, which asks the server\n which operations it supports.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " } ], "returns" : { "type" : "string*", "description" : "A sequence of string values of the allowed operations." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified href is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 2, "name" : "patch", "qname" : "http:patch", "signature" : "($href as string, $body as atomic) as object()", "description" : " 
    \n This function makes an HTTP PATCH request to a given URL.\n 
    \n 
    \n The body passed to this function must be either a string, a base64Binary or\n an hexBinary.\n If it is a string, the Content-Type sent to the server will be \"text/plain\",\n \"application/octet-stream\" otherwise.\n 
    \n", "summary" : "
      \n This function makes an HTTP PATCH request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " }, { "name" : "body", "type" : "atomic", "occurrence" : null, "description" : "
     The body which will be sent to the server.
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 3, "name" : "patch", "qname" : "http:patch", "signature" : "($href as string, $body as atomic, $content-type as string) as object()", "description" : " 
    \n This function makes an HTTP PATCH request to a given URL.\n 
    \n 
    \n The body passed to this function must be either a string, a base64Binary, or\n an hexBinary.\n In any case, Content-Type of the request sent to the server will\n be $content-type.\n 
    \n", "summary" : "
      \n This function makes an HTTP PATCH request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " }, { "name" : "body", "type" : "atomic", "occurrence" : null, "description" : "
     The body which will be sent to the server.
    " }, { "name" : "content-type", "type" : "string", "occurrence" : null, "description" : "
     The content type of $body to send to the server.
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response.", "http:CHARSET The specified charset is unsupported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "post", "qname" : "http:post", "signature" : "($href as string, $body as atomic) as object()", "description" : " 
    \n This function makes an HTTP POST request to a given URL.\n 
    \n 
    \n The body passed to this function must be either a string, a base64Binary, or an\n hexBinary.\n If it is a string, the Content-Type sent to the server will be \"text/plain\",\n \"application/octet-stream\" otherwise.\n 
    \n", "summary" : "
      \n This function makes an HTTP POST request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " }, { "name" : "body", "type" : "atomic", "occurrence" : null, "description" : "
     The body which will be sent to the server.
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 3, "name" : "post", "qname" : "http:post", "signature" : "($href as string, $body as atomic, $content-type as string) as object()", "description" : " 
    \n This function makes an HTTP POST request to a given URL.\n 
    \n 
    \n The body passed to this function must be either a string, a base64Binary,\n or an hexBinary.\n In any case, Content-Type of the request sent to the server will\n be $content-type.\n 
    \n", "summary" : "
      \n This function makes an HTTP POST request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " }, { "name" : "body", "type" : "atomic", "occurrence" : null, "description" : "
     The body which will be sent to the server
    " }, { "name" : "content-type", "type" : "string", "occurrence" : null, "description" : "
     The content type of the body as described above.
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response.", "http:CHARSET The specified charset is unsupported." ] }, { "isDocumented" : true, "arity" : 2, "name" : "put", "qname" : "http:put", "signature" : "($href as string, $body as atomic) as object()", "description" : " 
    \n This function makes an HTTP PUT request to a given URL.\n 
    \n 
    \n The body passed to this function must be either a string, a base64Binary or\n an hexBinary.\n If it is a string, the Content-Type sent to the server will be \"text/plain\",\n \"application/octet-stream\" otherwise.\n 
    \n", "summary" : "
      \n This function makes an HTTP PUT request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " }, { "name" : "body", "type" : "atomic", "occurrence" : null, "description" : "
     The body which will be sent to the server.
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response." ] }, { "isDocumented" : true, "arity" : 3, "name" : "put", "qname" : "http:put", "signature" : "($href as string, $body as atomic, $content-type as string) as object()", "description" : " 
    \n This function makes an HTTP PUT request to a given URL.\n 
    \n 
    \n The body passed to this function must be either a string, a base64Binary, or\n an hexBinary.\n In any case, Content-Type of the request sent to the server will\n be $content-type.\n 
    \n", "summary" : "
      \n This function makes an HTTP PUT request to a given URL.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "href", "type" : "string", "occurrence" : null, "description" : "
     The URL to which the request will be made (see note above).
    " }, { "name" : "body", "type" : "atomic", "occurrence" : null, "description" : "
     The body which will be sent to the server.
    " }, { "name" : "content-type", "type" : "string", "occurrence" : null, "description" : "
     The content type of $body to send to the server.
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response.", "http:CHARSET The specified charset is unsupported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "send-deterministic-request", "qname" : "http:send-deterministic-request", "signature" : "($request as object()) as object()", "description" : " 
    \n This function sends an HTTP request and returns the corresponding response.\n 
    \n 
    \n This function has the same semantics as send-request-1,\n but is declared as deterministic and thus should only be used when\n the request has no side-effects and behaves deterministic as required by the\n application.\n 
    \n", "summary" : "
      \n This function sends an HTTP request and returns the corresponding response.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "request", "type" : "object()", "occurrence" : null, "description" : "
     see request parameter of send-request#1
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response.", "http:FOLLOW Cannot follow a redirect of a POST, PUT, or DELETE request.", "http:CHARSET The specified charset is unsupported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "send-nondeterministic-request", "qname" : "http:send-nondeterministic-request", "signature" : "($request as object()) as object()", "description" : " 
    \n This function sends an HTTP request and returns the corresponding response.\n 
    \n 
    \n This function has the same semantics as send-request-1,\n but is declared as being non deterministic and thus should only be used when\n the request has no side-effects.\n 
    \n", "summary" : "
      \n This function sends an HTTP request and returns the corresponding response.
    ", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "request", "type" : "object()", "occurrence" : null, "description" : "
     see request parameter of send-request#1
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response.", "http:FOLLOW Cannot follow a redirect of a POST, PUT, or DELETE request.", "http:CHARSET The specified charset is unsupported." ] }, { "isDocumented" : true, "arity" : 1, "name" : "send-request", "qname" : "http:send-request", "signature" : "($request as object()) as object()", "description" : " 
    \n This function sends an HTTP request and returns the corresponding response.\n 
    \n 
    \n This function is declared as sequential and should be used whenever the\n request may have side-effects.\n 
    \n 
    \n The request parameters are specified in the $request JSON object, which\n has the following minimal structure:\n 
    \n   {\n     \"href\": \"http://www.example.com\"\n   }\n 
    \n 
    \n 
    This object specifies a GET request of the URI \"http://www.example.com\"
    \n 
    Additional optional parameters can be specified when issuing a request,\n using the following structure:
    \n 
    \n  {\n    \"method\": \"POST\",\n    \"href\": \"http://www.example.com\",\n    \"authentication\":\n    {\n      \"username\" : \"user\",\n      \"password\" : \"pass\",\n      \"auth-method\" : \"Basic\"\n    },\n    \"options\":\n    {\n      \"status-only\": true,\n      \"override-media-type\": \"text/plain\",\n      \"follow-redirect\": false,\n      \"timeout\": 30,\n      \"user-agent\": \"Mozilla/5.0\",\n      \"retry\":\n      {\n        \"delay\": [1000, 2000, 5000],\n        \"on-connection-error\": false,\n        \"on-statuses\": [500, 501]\n      }\n    },\n    \"headers\":\n    {\n      \"name\": \"value\",\n      ...\n    },\n    \"body\":\n    {\n      \"media-type\": \"text/plain\",\n      \"content\": \"...\"\n    }\n  }\n
    \n 
    \n The method field (string) defines the HTTP verb to use in the HTTP request (i.e., GET, HEAD, OPTIONS,\n POST, PUT, DELETE). If not specified GET will be used.\n The authentication field can be used to specify the credentials and authentication method\n used when issuing a request (e.g, Basic). If the authentication field is specified, all its (string)\n subfields must be specified. If an authentication object is provided, it overrides any\n Authorization header specified in the request.\n Additionally, the following options can be specified:\n 
      \n    
    • status-only. If true, the response body contents are omitted from the response object.
      • \n    
    • override-media-type. Is a MIME type that will override the Content-Type header returned\n        by the server. It affects the type of the result body content.
      • \n    
    • follow-redirect. Control whether an http redirect is automatically followed or not. If\n        it is false, the http redirect is returned as the response. If it is\n        true (the default) the function tries to follow the redirect, by\n        sending the same request to the new address (including body, headers,\n         and authentication credentials.) Maximum one redirect is followed\n        (there is no attempt to follow a redirect in response to following a\n          first redirect).
      • \n    
    • timeout. Is the maximum number of seconds to wait for the server to respond.\n         If no response is received withing this time duration, an error is thrown.
      • \n    
    • user-agent. The user agent sent to the server when issuing the request.\n        If not specified libcurl-agent/1.0 is used.
      • \n    
    • retry. The request will be automatically retried in case of connection error\n        following mandatory suboptions:\n        
        \n            
      • delay: an array specifying the milliseconds of wait before each retry.
        • \n            
      • on-connection-error: whether to retry the request if a connection to the\n                server cannot be estabilished
        • \n            
      • on-statuses: an array containing the statuses which will trigger a retry
        • \n        
      • \n 
    \n 
    \n 
    One or more headers can be sent to the server, specifying them in an optional headers object.\n Each header is represented as a single (string) field. These headers are overridden if the corresponding\n option/authentication has been specified in the request.
    \n 
    For non-multipart request a body object can be specified.\n This object must contain both the desired (string) media-type and its content.\n The type of the content field must be either string, base64Binary, or hexBinary. 
    \n 
    For multipart requests, multipart object can be specified in place of the body object.\n The multipart object has the following structure: 
    \n 
    \n  \"multipart\" : {\n    \"boundary\": \"--AaB03x\",\n    \"parts\": [\n      {\n        \"headers\" : {\n           \"Content Disposition: file\",\n           ...\n        },\n        \"body\": {\n          \"media-type\" : \"image/gif\",\n          \"content\" : \"...\"\n        }\n      },\n      {\n        \"body\" : {\n          \"media-type\" : \"text/html\",\n          \"content\" : \"...\"\n        }\n      }\n   ]\n }\n 
    \n 
    The multipart field contains an optional (string) field which specifies\n the boundary used to separate each part and an array containing all parts.\n Each part contains its specific headers, if any, and the corresponding body.\n 
    \n", "summary" : "
      \n This function sends an HTTP request and returns the corresponding response.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "request", "type" : "object()", "occurrence" : null, "description" : "
     a JSON http-client request object
    " } ], "returns" : { "type" : "object()", "description" : "standard http-client return type." }, "errors" : [ "http:HTTP An HTTP error occurred.", "http:REQUEST The specified request is not valid.", "http:TIMEOUT A timeout occurred waiting for the response.", "http:FOLLOW Cannot follow a redirect of a POST, PUT, or DELETE request.", "http:CHARSET The specified charset is unsupported." ] } ], "variables" : [  ] }, "http://zorba.io/modules/data-cleaning/consolidation" : { "ns" : "http://zorba.io/modules/data-cleaning/consolidation", "description" : " 
    This library module provides data consolidation functions that generally take as input a sequence of XML nodes\n and apply some rule in order do decide which node is better suited to represent the entire sequence.
    \n 
    \n 
    The logic contained in this module is not specific to any particular XQuery implementation,\n although the consolidation functions based on matching sequences against XPath expressions require\n some form of dynamic evaluation for XPath expressions.
    \n", "sees" : [  ], "authors" : [ "Bruno Martins" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/data-cleaning/consolidation", "prefix" : "con" }, { "uri" : "http://zorba.io/modules/data-cleaning/set-similarity", "prefix" : "set" }, { "uri" : "http://zorba.io/modules/data-cleaning/character-based-string-similarity", "prefix" : "simc" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "all-xpaths", "qname" : "con:all-xpaths", "signature" : "($s as element(*)*, $paths as xs:string*) as element(*)*", "description" : " 
    Returns the elements from an input sequence of elements that, when matched to a given set of XPath expressions,\n produce a non-empty set of nodes in all the cases.
    \n 
    \n 
    Example usage : 
     all-xpaths( ( <a><b/></a>, <c><d/></c>, <d/>), (\".//b\") ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (<a><b/></a>) 
    \n", "summary" : "
      Returns the elements from an input sequence of elements that, when matched to a given set of XPath expressions,\n produce a non-empty set of nodes in all the cases.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "element(*)", "occurrence" : "*", "description" : "
     A sequence of elements.
    " }, { "name" : "paths", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings denoting XPath expressions.
    " } ], "returns" : { "type" : "element(*)*", "description" : "The elements that, when matched to the given set of XPath expressions, always return a non-empty set of nodes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-attributes", "qname" : "con:least-attributes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the smallest number of descending attributes (attributes at any given depth)\n in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    least-attributes( ( <a att1=\"a1\" att2=\"a2\"/>, <b att1=\"a1\" />, <c/> ) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<c/>)
    \n", "summary" : "
      Returns the single node having the smallest number of descending attributes (attributes at any given depth)\n in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the smallest number of descending attributes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-distinct-attributes", "qname" : "con:least-distinct-attributes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the smallest number of distinct descending attributes (attributes at any\n given depth) in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
     least-distinct-attributes( ( <a att1=\"a1\" att2=\"a2\"/>, <b att1=\"a1\" />, <c/> ) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (<c/>) 
    \n", "summary" : "
      Returns the single node having the smallest number of distinct descending attributes (attributes at any\n given depth) in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the smallest number of distinct descending attributes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-distinct-elements", "qname" : "con:least-distinct-elements", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the smallest number of distinct descending elements (sub-elements at any\n given depth) in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
     least-distinct-elements( ( <a><b/></a>, <b><c/></b>, <d/>) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (<d/>) 
    \n", "summary" : "
      Returns the single node having the smallest number of distinct descending elements (sub-elements at any\n given depth) in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the smallest number of distinct descending elements in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-distinct-nodes", "qname" : "con:least-distinct-nodes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the smallest number of distinct descending nodes (sub-nodes at any given depth)\n in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
     least-distinct-nodes( ( <a><b/></a>, <b><c/></b>, <d/>) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (<d/>) 
    \n", "summary" : "
      Returns the single node having the smallest number of distinct descending nodes (sub-nodes at any given depth)\n in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the smallest number of distinct descending nodes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-elements", "qname" : "con:least-elements", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the smallest number of descending elements (sub-elements at any given depth)\n in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    least-elements( ( <a><b/></a>, <b><c/></b>, <d/>) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<d/>)
    \n", "summary" : "
      Returns the single node having the smallest number of descending elements (sub-elements at any given depth)\n in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the smallest number of descending elements in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-frequent", "qname" : "con:least-frequent", "signature" : "($s) as item()", "description" : " 
    Returns the single less frequent node in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    least-frequent( ( \"a\", \"a\", \"b\") )
    \n 
    \n 
    The function invocation in the example above returns : 
    (\"b\")
    \n", "summary" : "
      Returns the single less frequent node in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "item()", "description" : "The least frequent node in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "least-nodes", "qname" : "con:least-nodes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the smallest number of descending nodes (sub-nodes at any given depth)\n in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    least-nodes( ( <a><b/></a>, <b><c/></b>, <d/>) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<d/>)
    \n", "summary" : "
      Returns the single node having the smallest number of descending nodes (sub-nodes at any given depth)\n in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the smallest number of descending nodes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "least-similar-edit-distance", "qname" : "con:least-similar-edit-distance", "signature" : "($s as xs:string*, $m as xs:string) as xs:string?", "description" : " 
    Returns the single least similar string, in terms of the edit distance metric towards an input string,\n in a sequence of strings provided as input. If more than one string has a minimum similarity (a maximum\n value for the edit distance metric), return the first string according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    least-similar-edit-distance( ( \"aaabbbccc\", \"aaabbb\", \"eeefff\" ), \"aaab\" )
    \n 
    \n 
    The function invocation in the example above returns : 
    ( \"eeefff\" )
    \n", "summary" : "
      Returns the single least similar string, in terms of the edit distance metric towards an input string,\n in a sequence of strings provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " }, { "name" : "m", "type" : "xs:string", "occurrence" : null, "description" : "
     The string towards which we want to measure the edit distance.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The least similar string in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "least-tokens", "qname" : "con:least-tokens", "signature" : "($s as xs:string*, $r as xs:string) as xs:string?", "description" : " 
    Returns the single shortest string, in terms of the number of tokens, in a sequence of strings provided as input.
    \n 
    If more then one answer is possible, return the first string according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    least-tokens( ( \"a b c\", \"a b\", \"a\"), \" +\" )
    \n 
    \n 
    The function invocation in the example above returns : 
    (\"a\")
    \n", "summary" : "
      Returns the single shortest string, in terms of the number of tokens, in a sequence of strings provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The shortest string in the input sequence, in terms of the number of tokens." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "least-xpaths", "qname" : "con:least-xpaths", "signature" : "($s as element(*)*, $paths as xs:string*) as element(*)*", "description" : " 
    Returns the single element from an input sequence of elements that matches the smallest number of\n XPath expressions from a given set, producing a non-empty set of nodes.
    \n 
    If more then one answer is possible, return the first element according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
     least-xpaths( ( <a><b/></a>, <d><c/><b/></d>, <d/>) , (\".//b\", \".//c\") ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     ( $lt;d/> ) 
    \n", "summary" : "
      Returns the single element from an input sequence of elements that matches the smallest number of\n XPath expressions from a given set, producing a non-empty set of nodes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "element(*)", "occurrence" : "*", "description" : "
     A sequence of elements.
    " }, { "name" : "paths", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings denoting XPath expressions.
    " } ], "returns" : { "type" : "element(*)*", "description" : "The element that matches the smallest number of XPath expressions producing a non-empty set of nodes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "longest", "qname" : "con:longest", "signature" : "($s as xs:string*) as xs:string?", "description" : " 
    Returns the single longest string, in terms of the number of characters, in a sequence of strings provided as input.
    \n 
    If more then one answer is possible, return the first string according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    con:longest( ( \"a\", \"aa\", \"aaa\") )
    \n 
    \n 
    The function invocation in the example above returns : 
    (\"aaa\")
    \n", "summary" : "
      Returns the single longest string, in terms of the number of characters, in a sequence of strings provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The longest string in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "matching", "qname" : "con:matching", "signature" : "($s as xs:string*, $r as xs:string) as xs:string*", "description" : " 
    Returns the strings from an input sequence of strings that match a particular regular expression.
    \n 
    \n 
    Example usage : 
    matching( ( \"a A b\", \"c AAA d\", \"e BB f\"), \"A+\" )
    \n 
    \n 
    The function invocation in the example above returns : 
    ( \"a A b\", \"c AAA d\")
    \n", "summary" : "
      Returns the strings from an input sequence of strings that match a particular regular expression.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     The regular expression to be used in the matching.
    " } ], "returns" : { "type" : "xs:string*", "description" : "The strings in the input sequence that match the input regular expression." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-attributes", "qname" : "con:most-attributes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the largest number of descending attributes (attributes at any given depth)\n in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-attributes( ( <a att1=\"a1\" att2=\"a2\"/>, <b att1=\"a1\" />, <c/> ) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<a att1=\"a1\" att2=\"a2\"/>)
    \n", "summary" : "
      Returns the single node having the largest number of descending attributes (attributes at any given depth)\n in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the largest number of descending attributes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-distinct-attributes", "qname" : "con:most-distinct-attributes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the largest number of distinct descending attributes (attributes at any\n given depth) in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-distinct-attributes( ( <a att1=\"a1\" att2=\"a2\" att3=\"a3\"/>, <a att1=\"a1\" att2=\"a2\"><b att2=\"a2\" /></a>, <c/> ) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<a att1=\"a1\" att2=\"a2\" att3=\"a3\"/>)
    \n", "summary" : "
      Returns the single node having the largest number of distinct descending attributes (attributes at any\n given depth) in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the largest number of distinct descending attributes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-distinct-elements", "qname" : "con:most-distinct-elements", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the largest number of distinct descending elements (sub-elements at any\n given depth) in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-distinct-elements( ( <a><b/><c/><d/></a>, <a><b/><b/><c/></a>, <a/> ) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<a><b/><c/><d/></a>)
    \n", "summary" : "
      Returns the single node having the largest number of distinct descending elements (sub-elements at any\n given depth) in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the largest number of distinct descending elements in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-distinct-nodes", "qname" : "con:most-distinct-nodes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the largest number of distinct descending nodes (sub-nodes at any given depth) in\n a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-distinct-nodes( ( <a><b/></a>, <a><a/></a>, <b/>) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<a><b/></a>)
    \n", "summary" : "
      Returns the single node having the largest number of distinct descending nodes (sub-nodes at any given depth) in\n a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the largest number of distinct descending nodes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-elements", "qname" : "con:most-elements", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the largest number of descending elements (sub-elements at any given depth)\n in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-elements( ( <a><b/></a>, <a/>, <b/>) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<a><b/></a>)
    \n", "summary" : "
      Returns the single node having the largest number of descending elements (sub-elements at any given depth)\n in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the largest number of descending elements in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-frequent", "qname" : "con:most-frequent", "signature" : "($s) as item()", "description" : " 
    Returns the single most frequent node in a sequence of nodes provided as input.
    \n 
    If more then one answer is possible, returns the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-frequent( ( \"a\", \"a\", \"b\") )
    \n 
    \n 
    The function invocation in the example above returns : 
    (\"a\")
    \n", "summary" : "
      Returns the single most frequent node in a sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "item()", "description" : "The most frequent node in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "most-nodes", "qname" : "con:most-nodes", "signature" : "($s) as element(*)", "description" : " 
    Returns the single node having the largest number of descending nodes (sub-nodes at any given depth) in a\n sequence of nodes provided as input.
    \n 
    If more then one answer is possible, return the first node according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-nodes( ( <a><b/></a>, <a/>, <b/>) )
    \n 
    \n 
    The function invocation in the example above returns : 
    (<a><b/></a>)
    \n", "summary" : "
      Returns the single node having the largest number of descending nodes (sub-nodes at any given depth) in a\n sequence of nodes provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A sequence of nodes.
    " } ], "returns" : { "type" : "element(*)", "description" : "The node having the largest number of descending nodes in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "most-similar-edit-distance", "qname" : "con:most-similar-edit-distance", "signature" : "($s as xs:string*, $m as xs:string) as xs:string?", "description" : " 
    Returns the single most similar string, in terms of the edit distance metric towards an input string,\n in a sequence of strings provided as input. If more than one string has a maximum similarity (a minimum\n value for the edit distance metric), the function return the first string according to the order of the\n input sequence.
    \n 
    \n 
    Example usage : 
    most-similar-edit-distance( ( \"aaabbbccc\", \"aaabbb\", \"eeefff\" ), \"aaab\" )
    \n 
    \n 
    The function invocation in the example above returns : 
    ( \"aaabbb\" )
    \n", "summary" : "
      Returns the single most similar string, in terms of the edit distance metric towards an input string,\n in a sequence of strings provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " }, { "name" : "m", "type" : "xs:string", "occurrence" : null, "description" : "
     The string towards which we want to measure the edit distance.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The most similar string in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "most-tokens", "qname" : "con:most-tokens", "signature" : "($s as xs:string*, $r as xs:string) as xs:string?", "description" : " 
    Returns the single longest string, in terms of the number of tokens, in a sequence of strings provided as input.
    \n 
    If more then one answer is possible, return the first string according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    most-tokens( ( \"a b c\", \"a b\", \"a\"), \" +\" )
    \n 
    \n 
    The function invocation in the example above returns : 
    (\"a b c\")
    \n", "summary" : "
      Returns the single longest string, in terms of the number of tokens, in a sequence of strings provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " }, { "name" : "r", "type" : "xs:string", "occurrence" : null, "description" : "
     A regular expression forming the delimiter character(s) which mark the boundaries between adjacent tokens.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The longest string in the input sequence, in terms of the number of tokens." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "most-xpaths", "qname" : "con:most-xpaths", "signature" : "($s as element(*)*, $paths as xs:string*) as element(*)*", "description" : " 
    Returns the single element from an input sequence of elements that matches the largest number of\n XPath expressions from a given set, producing a non-empty set of nodes.
    \n 
    If more then one answer is possible, return the first element according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
     most-xpaths( ( <a><b/></a>, <d><c/><b/></d>, <d/>) , (\".//b\", \".//c\") ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     ( <d><c/><b/></d> ) 
    \n", "summary" : "
      Returns the single element from an input sequence of elements that matches the largest number of\n XPath expressions from a given set, producing a non-empty set of nodes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "element(*)", "occurrence" : "*", "description" : "
     A sequence of elements.
    " }, { "name" : "paths", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings denoting XPath expressions.
    " } ], "returns" : { "type" : "element(*)*", "description" : "The element that matches the largest number of XPath expressions producing a non-empty set of nodes." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "shortest", "qname" : "con:shortest", "signature" : "($s as xs:string*) as xs:string?", "description" : " 
    Returns the single shortest string, in terms of the number of characters, in a sequence of strings provided as input.
    \n 
    If more then one answer is possible, return the first string according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    shortest( ( \"a\", \"aa\", \"aaa\") )
    \n 
    \n 
    The function invocation in the example above returns : 
    (\"a\")
    \n", "summary" : "
      Returns the single shortest string, in terms of the number of characters, in a sequence of strings provided as input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The shortest string in the input sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "some-xpaths", "qname" : "con:some-xpaths", "signature" : "($s as element(*)*, $paths as xs:string*) as element(*)*", "description" : " 
    Returns the elements from a sequence of elements that, when matched to a given set of XPath expressions,\n produce a non-empty set of nodes for some of the cases.
    \n 
    \n 
    Example usage : 
     some-xpaths( ( <a><b/></a>, <d><c/></d>, <d/>), (\".//b\", \".//c\") ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     ( <a><b/></a> , <d><c/></d> ) 
    \n", "summary" : "
      Returns the elements from a sequence of elements that, when matched to a given set of XPath expressions,\n produce a non-empty set of nodes for some of the cases.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "element(*)", "occurrence" : "*", "description" : "
     A sequence of elements.
    " }, { "name" : "paths", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings denoting XPath expressions.
    " } ], "returns" : { "type" : "element(*)*", "description" : "The elements that, when matched to the given set of XPath expressions, return a non-empty set of nodes for at least one of the cases." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "superstring", "qname" : "con:superstring", "signature" : "($s as xs:string*) as xs:string?", "description" : " 
    Returns the single string, from an input sequence of strings, that appears more frequently as part\n of the other strings in the sequence. If no such string exists, the function returns an empty sequence.
    \n 
    If more then one answer is possible, the function returns the first string according to the order of the input sequence.
    \n 
    \n 
    Example usage : 
    super-string( ( \"aaa bbb ccc\", \"aaa bbb\", \"aaa ddd\", \"eee fff\" ) )
    \n 
    \n 
    The function invocation in the example above returns : 
    ( \"aaa bbb\" )
    \n", "summary" : "
      Returns the single string, from an input sequence of strings, that appears more frequently as part\n of the other strings in the sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "xs:string", "occurrence" : "*", "description" : "
     A sequence of strings.
    " } ], "returns" : { "type" : "xs:string?", "description" : "The string that appears more frequently as part of the other strings in the sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "validating-schema", "qname" : "con:validating-schema", "signature" : "($s as element(*)*, $schema as element(*)) as element(*)*", "description" : " 
    Returns the nodes from an input sequence of nodes that validate against a given XML Schema.
    \n 
    \n 
    Example usage : 
     validating-schema ( ( <a/> , <b/> ), <xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\"><xs:element name=\"a\" /></xs:schema> ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     ( <a/> ) 
    \n", "summary" : "
      Returns the nodes from an input sequence of nodes that validate against a given XML Schema.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : "element(*)", "occurrence" : "*", "description" : "
     A sequence of elements.
    " }, { "name" : "schema", "type" : "element(*)", "occurrence" : null, "description" : "
     An element encoding an XML Schema.
    " } ], "returns" : { "type" : "element(*)*", "description" : "The nodes that validate against the XML Schema.  Attention : This function is still not implemented. " }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/node" : { "ns" : "http://zorba.io/modules/node", "description" : " This module defines a set of function which can be used\n to determine (1) the relationship between two nodes (e.g. if one\n is the ancestor if another) and (2) properties of given\n nodes (e.g. their level in the tree).\n The same functionality can be achieved with simple XPath expressions.\n However, please note that using the functions in this modules instead\n of path expressions guarantees better performance.\n", "sees" : [  ], "authors" : [ "Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/node", "prefix" : "node" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "ancestor-of", "qname" : "node:ancestor-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is an\n ancestor of the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is an\n ancestor of the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential descendant
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential ancestor
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is an ancestor of $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "child-of", "qname" : "node:child-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is a\n child of the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is a\n child of the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential parent
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential child
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is a child of $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "copy", "qname" : "node:copy", "signature" : "($input as node()*) as node()* external", "description" : " Return a deep copy of every given node according to the properties\n specified in the static context of the invoking module.
    \n Please note that a copy of a node is parentless.\n", "summary" : "
     Return a deep copy of every given node according to the properties\n specified in the static context of the invoking module.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "input", "type" : "node()", "occurrence" : "*", "description" : "
     the node to copy
    " } ], "returns" : { "type" : "node()*", "description" : "a deep copy of every node in the input sequence or the empty sequence if $input is the empty sequence." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "descendant-of", "qname" : "node:descendant-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is a\n descendant of the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is a\n descendant of the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential ancestor
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential descendant
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is a descendant of $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "following-of", "qname" : "node:following-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is\n following the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is\n following the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential preceding node
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential following node
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is following the node $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "following-sibling-of", "qname" : "node:following-sibling-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is a\n following-sibling of the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is a\n following-sibling of the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential preceding-sibling
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential following-sibling
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is a following-sibling of $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "least-common-ancestor", "qname" : "node:least-common-ancestor", "signature" : "($node1 as node(), $node2 as node()) as node()? external", "description" : " Computes the least common ancestor of two given nodes in\n the tree.\n", "summary" : "
     Computes the least common ancestor of two given nodes in\n the tree.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the first node
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the second node
    " } ], "returns" : { "type" : "node()?", "description" : "the least common ancestor of the two given nodes or the empty sequence if the two nodes are not part of the same tree." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "level", "qname" : "node:level", "signature" : "($node as node()) as xs:integer external", "description" : " Computes the level of a given node in the tree.\n Note: The first level has the number one.\n", "summary" : "
     Computes the level of a given node in the tree.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurrence" : null, "description" : "
     the node for which the level should be computed
    " } ], "returns" : { "type" : "xs:integer", "description" : "The level as xs:integer of the given node in the tree." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "parent-of", "qname" : "node:parent-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is a\n parent of the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is a\n parent of the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential child
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential parent
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is a parent of $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "preceding-of", "qname" : "node:preceding-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is\n preceding the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is\n preceding the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential following node
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential preceding node
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is preceding the node $node1; false otherwise." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "preceding-sibling-of", "qname" : "node:preceding-sibling-of", "signature" : "($node1 as node(), $node2 as node()) as xs:boolean external", "description" : " Determines whether the node given as second argument is a\n preceding-sibling of the node given as first argument.\n", "summary" : "
     Determines whether the node given as second argument is a\n preceding-sibling of the node given as first argument.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node1", "type" : "node()", "occurrence" : null, "description" : "
     the potential following-sibling
    " }, { "name" : "node2", "type" : "node()", "occurrence" : null, "description" : "
     the potential preceding-sibling
    " } ], "returns" : { "type" : "xs:boolean", "description" : "true if $node2 is a preceding-sibling of $node1; false otherwise." }, "errors" : [  ] } ], "variables" : [  ] }, "http://zorba.io/modules/archive" : { "ns" : "http://zorba.io/modules/archive", "description" : " This module provides functionality to work with (possibly compressed)\n archives. For example, it provides functions to retrieve the names or\n extract the values of several entries in a ZIP archive. Moreover,\n there exist functions that allow to create or update archives.
    \n The following archive formats and compression algorithms are supported:\n 
      \n   
    • ZIP (with compression DEFLATE or STORE)
      • \n   
    • TAR (with compression GZIP)
      • \n 
    \n 
    \n", "sees" : [  ], "authors" : [ "Luis Rodgriguez, Juan Zacarias, and Matthias Brantner" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/archive", "prefix" : "a" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "create", "qname" : "a:create", "signature" : "($entries as item()*, $contents as item()*) as xs:base64Binary external", "description" : " Creates a new ZIP archive out of the given entries and contents. 
    \n All entries are compressed with the DEFLATE compression algorithm.
    \n The parameters $entries and $contents have the same meaning as for\n the function a:create with three arguments.
    \n Entry entries can include a type element, this element can have one\n of two possible values: \"regular\" or \"directory\". If \"regular\" is\n specified then the entry will be created as a regular file; if \"directory\"\n is specified then the entry will be created as a directory, no contents\n will be read from $contents in this case. If no value is specified for type\n then it will be set to \"regular\". 
    \n Example:\n 
    \n $zip-file := a:create(\n    ({ \"encoding\" : \"ISO-8859-1\", \"type\" : \"directory\", \"name\" : \"dir1\" }, \"dir1/file1\"),\n    (\"file contents\"))\n 
    \n 
    \n", "summary" : "
     Creates a new ZIP archive out of the given entries and contents.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entries", "type" : "item()", "occurrence" : "*", "description" : "
     the meta data for the entries in the archive. Each entry can be of type xs:string or a JSON oibject describing the entry.
    " }, { "name" : "contents", "type" : "item()", "occurrence" : "*", "description" : "
     the content for the archive. Each item in the sequence can be of type xs:string or xs:base64Binary.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the generated archive as xs:base64Binary" }, "errors" : [ "a:ENTRY-COUNT-MISMATCH if the number of entries that don't describe directories differs from the number of items in the $contents sequence: count($non-directory-entries) ne count($contents)", "a:INVALID-ENTRY-VALS if a values in an entry object are invalid", "a:INVALID-ENCODING if a given encoding is invalid or not supported", "err:FORG0006 if an item in the contents sequence is not of type xs:string or xs:base64Binary" ] }, { "isDocumented" : true, "arity" : 3, "name" : "create", "qname" : "a:create", "signature" : "($entries as item()*, $contents as item()*, $options as object()) as xs:base64Binary external", "description" : " Creates a new archive out of the given entries and contents. 
    \n The $entries arguments provides meta data for each entry in the archive.\n For example, the name of the entry (mandatory) or the last-modified date\n (optional). An entry can either be of type xs:string to describe the entry\n name or of type xs:base64Binary to provide additional meta data.
    \n The $contents sequence provides the data (xs:string or xs:base64Binary) for\n the entries that should be included in the archive. Its length needs to\n match the length of the entries in the $entries sequence that don't describe\n directory entries (a:ARCH0001). All items of type xs:base64Binary are decoded\n before being added to the archive.
    \n For each entry, the name, last-modified date and time, and compression\n can be specified. In addition, an encoding can be specified which is used to\n store entries of type xs:string. If no last-modified attribute is given, the\n default is the current date and time. The compression is useful if various\n entries in a ZIP archive are compressed using different compression\n algorithms (i.e. store or deflate).
    \n For example, the following sequence may be used to describe an archive\n containing two elements: 
    \n 
    {\n   \"last-modified\" : \"{fn:current-dateTime()}\"\n   \"name\" : \"myfile.txt\"\n },\n {\n   \"encoding\" : \"ISO-8859-1\",\n   \"compression\" : \"store\",\n   \"name\" : \"dir/myfile.xml\"\n }\n 
    \n 
    \n The $options argument may be used to describe general options for the\n archive.  For example, the following options can be used to create a ZIP\n archive in which all entries are compressed with the DEFLATE compression\n algorithm: 
    \n 
    {\n   \"format\" : \"ZIP\",\n   \"compression\" : \"DEFLATE\"\n }\n 
    \n 
    \n The result of the function is the generated archive as a item of type\n xs:base64Binary.
    \n", "summary" : "
     Creates a new archive out of the given entries and contents.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entries", "type" : "item()", "occurrence" : "*", "description" : "
     the meta data for the entries in the archive. Each entry can be of type xs:string or an JSON object describing the entry.
    " }, { "name" : "contents", "type" : "item()", "occurrence" : "*", "description" : "
     the content for the archive. Each item in the sequence can be of type xs:string or xs:base64Binary.
    " }, { "name" : "options", "type" : "object()", "occurrence" : null, "description" : "
     the options used to generate the archive.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the generated archive as xs:base64Binary" }, "errors" : [ "a:ENTRY-COUNT-MISMATCH if the number of entries describing non-directories differs from the number of items in the $contents sequence: count($non-directoy-entries) ne count($contents)", "a:INVALID-OPTIONS if the options argument contains invalid values", "a:INVALID-ENTRY-VALS if any values in an entry are invalid", "a:INVALID-ENCODING if a given encoding is invalid or not supported", "a:DIFFERENT-COMPRESSIONS-NOT-SUPPORTED if different compression algorithms were selected but the actual version of libarchive doesn't support it.", "err:FORG0006 if an item in the contents sequence is not of type xs:string or xs:base64Binary" ] }, { "isDocumented" : true, "arity" : 2, "name" : "delete", "qname" : "a:delete", "signature" : "($archive as xs:base64Binary, $entry-names as xs:string*) as xs:base64Binary external", "description" : " Deletes entries from an archive. 
    \n", "summary" : "
     Deletes entries from an archive.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to extract the entries from as xs:base64Binary
    " }, { "name" : "entry-names", "type" : "xs:string", "occurrence" : "*", "description" : "
     a sequence of names for entries which should be deleted
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the updated base64Binary" }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted" ] }, { "isDocumented" : true, "arity" : 1, "name" : "entries", "qname" : "a:entries", "signature" : "($archive as xs:base64Binary) as object()* external", "description" : " Returns the header information of all entries in the given archive as a JSON\n objects sequence. 
    \n Such information includes the name of the entry, the uncompressed size,\n as well as the last-modified timestamp. Note that not all values are\n available in every archive.
    \n", "summary" : "
     Returns the header information of all entries in the given archive as a JSON\n objects sequence.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to list the entries from as xs:base64Binary
    " } ], "returns" : { "type" : "object()*", "description" : "a sequence of strings, one for each entry in the archive" }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted" ] }, { "isDocumented" : true, "arity" : 1, "name" : "extract-binary", "qname" : "a:extract-binary", "signature" : "($archive as xs:base64Binary) as xs:base64Binary* external", "description" : " Returns the entries identified by the given paths from the archive\n as base64Binary. 
    \n", "summary" : "
     Returns the entries identified by the given paths from the archive\n as base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to extract the entries from as xs:base64Binary
    " } ], "returns" : { "type" : "xs:base64Binary*", "description" : "one xs:base64Binary item for the contents of each entry in the archive" }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted" ] }, { "isDocumented" : true, "arity" : 2, "name" : "extract-binary", "qname" : "a:extract-binary", "signature" : "($archive as xs:base64Binary, $entry-names as xs:string*) as xs:base64Binary* external", "description" : " Returns the entries identified by the given paths from the archive\n as base64Binary. 
    \n", "summary" : "
     Returns the entries identified by the given paths from the archive\n as base64Binary.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to extract the entries from as xs:base64Binary
    " }, { "name" : "entry-names", "type" : "xs:string", "occurrence" : "*", "description" : "
     a sequence of names for entries which should be extracted
    " } ], "returns" : { "type" : "xs:base64Binary*", "description" : "a sequence of xs:base64Binary itmes for the given sequence of names or the empty sequence if no entries match the given names." }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted" ] }, { "isDocumented" : true, "arity" : 1, "name" : "extract-text", "qname" : "a:extract-text", "signature" : "($archive as xs:base64Binary) as xs:string* external", "description" : " Extracts the contents of all entries in the given archive as text\n using UTF-8 as default encoding. 
    \n", "summary" : "
     Extracts the contents of all entries in the given archive as text\n using UTF-8 as default encoding.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to extract the entries from as xs:base64Binary
    " } ], "returns" : { "type" : "xs:string*", "description" : "one string for the contents of each entry in the archive" }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted", "err:FOCH0001 if any of the entries contains invalid utf-8 characters" ] }, { "isDocumented" : true, "arity" : 2, "name" : "extract-text", "qname" : "a:extract-text", "signature" : "($archive as xs:base64Binary, $entry-names as xs:string*) as xs:string* external", "description" : " Extracts the contets of the entries identified by a given sequence of\n names as text.\n The default encoding used to read the string is UTF-8. 
    \n", "summary" : "
     Extracts the contets of the entries identified by a given sequence of\n names as text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to extract the entries from as xs:base64Binary
    " }, { "name" : "entry-names", "type" : "xs:string", "occurrence" : "*", "description" : "
     a sequence of names for entries which should be extracted
    " } ], "returns" : { "type" : "xs:string*", "description" : "a sequence of strings for the given sequence of names or the empty sequence if no entries match the given names." }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted", "err:FOCH0001 if any of the entries requested contains invalid utf-8 characters" ] }, { "isDocumented" : true, "arity" : 3, "name" : "extract-text", "qname" : "a:extract-text", "signature" : "($archive as xs:base64Binary, $entry-names as xs:string*, $encoding as xs:string) as xs:string* external", "description" : " Extracts the contets of the entries identified by a given sequence of\n names as text. Each entry is treated with the given encoding. 
    \n", "summary" : "
     Extracts the contets of the entries identified by a given sequence of\n names as text.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to extract the entries from as xs:base64Binary
    " }, { "name" : "entry-names", "type" : "xs:string", "occurrence" : "*", "description" : "
     a sequence of entry names that should be extracted
    " }, { "name" : "encoding", "type" : "xs:string", "occurrence" : null, "description" : "
     a encoding for transcoding each of the extracted entries
    " } ], "returns" : { "type" : "xs:string*", "description" : "a sequence of strings for the given sequence of names or the empty sequence if no entries match the given names." }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted", "a:INVALID-ENCODING if the given $encoding is invalid or not supported", "err:FOCH0001 if a transcoding error happens" ] }, { "isDocumented" : true, "arity" : 1, "name" : "options", "qname" : "a:options", "signature" : "($archive as xs:base64Binary) as object() external", "description" : " Returns the algorithm and format options as a JSON object for a given archive.\n For example, for a ZIP archive, the following options element\n would be returned: 
    \n 
    {\n   \"format\" : \"ZIP\",\n   \"compression\" : \"DEFLATE\"\n }\n 
    \n 
    \n", "summary" : "
     Returns the algorithm and format options as a JSON object for a given archive.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive as xs:base64Binary
    " } ], "returns" : { "type" : "object()", "description" : "the algorithm and format options as a JSON object" }, "errors" : [ "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted" ] }, { "isDocumented" : true, "arity" : 3, "name" : "update", "qname" : "a:update", "signature" : "($archive as xs:base64Binary, $entries as item()*, $contents as item()*) as xs:base64Binary external", "description" : " Adds and replaces entries in an archive according to\n the given spec. The contents can be string and base64Binary items. 
    \n The parameters $entries and $contents have the same meaning as for\n the function a:create with three arguments.
    \n", "summary" : "
     Adds and replaces entries in an archive according to\n the given spec.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "archive", "type" : "xs:base64Binary", "occurrence" : null, "description" : "
     the archive to add or replace content
    " }, { "name" : "entries", "type" : "item()", "occurrence" : "*", "description" : "
     the meta data for the entries in the archive. Each entry can be of type xs:string or a JSON object. For mandatory fields in the JSON object see create function.
    " }, { "name" : "contents", "type" : "item()", "occurrence" : "*", "description" : "
     the content for the archive. Each item in the sequence can be of type xs:string or xs:base64Binary.
    " } ], "returns" : { "type" : "xs:base64Binary", "description" : "the updated xs:base64Binary" }, "errors" : [ "a:ENTRY-COUNT-MISMATCH if the number of entry elements differs from the number of items in the $contents sequence: count($non-directory-entries) ne count($contents)", "a:INVALID-ENTRY-VALS if a value for an entry element is invalid", "a:INVALID-ENCODING if a given encoding is invalid or not supported", "a:DIFFERENT-COMPRESSIONS-NOT-SUPPORTED if different compression algorithms were selected but the actual version of libarchive doesn't support it.", "err:FORG0006 if an item in the contents sequence is not of type xs:string or xs:base64Binary", "a:CORRUPTED-ARCHIVE if $archive is not an archive or corrupted" ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/converters/html" : { "ns" : "http://www.zorba-xquery.com/modules/converters/html", "description" : " 
    \n This module provides functions to tidy a HTML document. 
    \n The functions in this module take an HTML document (a string) as parameter,\n tidy it in order to result in valid XHTML, and return this XHTML document as a document-node.\n 
    \n", "sees" : [  ], "authors" : [ "Sorin Nasoi" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://ww.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://www.zorba-xquery.com/modules/converters/html", "prefix" : "html" }, { "uri" : "http://www.zorba-xquery.com/modules/converters/html-options", "prefix" : "html-options" }, { "uri" : "http://zorba.io/modules/schema", "prefix" : "schema" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "parse", "qname" : "html:parse", "signature" : "($html as xs:string) as document()", "description" : " 
    This function tidies the given HTML string and returns\n a valid XHTML document node.
    \n 
    This functions automatically sets the following tidying parameters:\n   
      \n    
    • output-xml=yes
      • \n    
    • doctype=omit
      • \n    
    • quote-nbsp=no
      • \n    
    • char-encoding=utf8
      • \n    
    • newline=LF
      • \n    
    • tidy-mark=no
      • \n   
    \n 
    \n", "summary" : "
      This function tidies the given HTML string and returns\n a valid XHTML document node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "html", "type" : "xs:string", "occurrence" : null, "description" : "
     the HTML string to tidy
    " } ], "returns" : { "type" : "document()", "description" : "the tidied XML document" }, "errors" : [ "html:InternalError if an internal error occurred while tidying the string." ] }, { "isDocumented" : true, "arity" : 2, "name" : "parse", "qname" : "html:parse", "signature" : "($html as xs:string, $options as element(html-options:options)) as document()", "description" : " 
    This function tidies the given HTML string and returns\n a valid XHTML document node.
    \n 
    The second parameter allows to specify options that\n configure the tidy process. This parameter is a sequence\n of name=value pairs. Allowed parameter names and values\n are documented at \n http://tidy.sourceforge.net/docs/quickref.html.
    \n", "summary" : "
      This function tidies the given HTML string and returns\n a valid XHTML document node.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "html", "type" : "xs:string", "occurrence" : null, "description" : "
     the HTML string to tidy
    " }, { "name" : "options", "type" : "element(html-options:options)", "occurrence" : null, "description" : "
     a set of name and value pairs that provide options to configure the tidy process that have to be validated against the \"http://www.zorba-xquery.com/modules/converters/html-options\" schema.
    " } ], "returns" : { "type" : "document()", "description" : "the tidied XHTML document node" }, "errors" : [ "err:XQDY0027 if $options can not be validated against the html-options schema", "html:TidyOption if there was an error with one of the options in the $options parameter that couldn't have been caught by validating against the schema", "html:InternalError if an internal error occurred while tidying the string." ] } ], "variables" : [  ] }, "http://zorba.io/modules/data-cleaning/set-similarity" : { "ns" : "http://zorba.io/modules/data-cleaning/set-similarity", "description" : " 
    This library module provides similarity functions for comparing sets of XML\n nodes (e.g., sets of XML elements, attributes or atomic values).
    \n 
    \n 
    These functions are particularly useful for matching near duplicate sets of XML nodes.
    \n 
    \n 
    The logic contained in this module is not specific to any particular XQuery implementation.
    \n", "sees" : [  ], "authors" : [ "Bruno Martins" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/modules/data-cleaning/set-similarity", "prefix" : "set" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "deep-intersect", "qname" : "set:deep-intersect", "signature" : "($s1, $s2) as item()*", "description" : " 
    Returns the intersection between two sets, using the deep-equal() function to compare the XML nodes from the sets.
    \n 
    \n 
    Example usage : 
     deep-intersect ( ( \"a\", \"b\", \"c\") , ( \"a\", \"a\",  ) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (\"a\") 
    \n", "summary" : "
      Returns the intersection between two sets, using the deep-equal() function to compare the XML nodes from the sets.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : null, "occurrence" : null, "description" : "
     The first set.
    " }, { "name" : "s2", "type" : null, "occurrence" : null, "description" : "
     The second set.
    " } ], "returns" : { "type" : "item()*", "description" : "The intersection of both sets." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "deep-union", "qname" : "set:deep-union", "signature" : "($s1, $s2) as item()*", "description" : " 
    Returns the union between two sets, using the deep-equal() function to compare the XML nodes from the sets.
    \n 
    \n 
    Example usage : 
     deep-union ( ( \"a\", \"b\", \"c\") , ( \"a\", \"a\",  ) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (\"a\", \"b\", \"c\",  ) 
    \n", "summary" : "
      Returns the union between two sets, using the deep-equal() function to compare the XML nodes from the sets.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : null, "occurrence" : null, "description" : "
     The first set.
    " }, { "name" : "s2", "type" : null, "occurrence" : null, "description" : "
     The second set.
    " } ], "returns" : { "type" : "item()*", "description" : "The union of both sets." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "dice", "qname" : "set:dice", "signature" : "($s1, $s2) as xs:double", "description" : " 
    Returns the Dice similarity coefficient between two sets of XML nodes.
    \n 
    The Dice coefficient is defined as defined as twice the shared information between the input sets\n (i.e., the size of the intersection) over the sum of the cardinalities for the input sets.
    \n 
    \n 
    Example usage : 
     dice ( ( \"a\", \"b\",  ) , ( \"a\", \"a\", \"d\") ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     0.4 
    \n", "summary" : "
      Returns the Dice similarity coefficient between two sets of XML nodes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : null, "occurrence" : null, "description" : "
     The first set.
    " }, { "name" : "s2", "type" : null, "occurrence" : null, "description" : "
     The second set.
    " } ], "returns" : { "type" : "xs:double", "description" : "The Dice similarity coefficient between the two sets." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "distinct", "qname" : "set:distinct", "signature" : "($s) as item()*", "description" : " 
    Removes exact duplicates from a set, using the deep-equal() function to compare the XML nodes from the sets.
    \n 
    \n 
    Example usage : 
     distinct ( ( \"a\", \"a\",  ) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     (\"a\",  ) 
    \n", "summary" : "
      Removes exact duplicates from a set, using the deep-equal() function to compare the XML nodes from the sets.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s", "type" : null, "occurrence" : null, "description" : "
     A set.
    " } ], "returns" : { "type" : "item()*", "description" : "The set provided as input without the exact duplicates (i.e., returns the distinct nodes from the set provided as input)." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "jaccard", "qname" : "set:jaccard", "signature" : "($s1, $s2) as xs:double", "description" : " 
    Returns the Jaccard similarity coefficient between two sets of XML nodes.
    \n 
    The Jaccard coefficient is defined as the size of the intersection divided by the size of the\n union of the input sets.
    \n 
    \n 
    Example usage : 
     jaccard ( ( \"a\", \"b\",  ) , ( \"a\", \"a\", \"d\") ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     0.25 
    \n", "summary" : "
      Returns the Jaccard similarity coefficient between two sets of XML nodes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : null, "occurrence" : null, "description" : "
     The first set.
    " }, { "name" : "s2", "type" : null, "occurrence" : null, "description" : "
     The second set.
    " } ], "returns" : { "type" : "xs:double", "description" : "The Jaccard similarity coefficient between the two sets." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 2, "name" : "overlap", "qname" : "set:overlap", "signature" : "($s1, $s2) as xs:double", "description" : " 
    Returns the overlap coefficient between two sets of XML nodes.
    \n 
    The overlap coefficient is defined as the shared information between the input sets\n (i.e., the size of the intersection) over the size of the smallest input set.
    \n 
    \n 
    Example usage : 
     overlap ( ( \"a\", \"b\",  ) , ( \"a\", \"a\", \"b\" ) ) 
    \n 
    \n 
    The function invocation in the example above returns : 
     1.0 
    \n", "summary" : "
      Returns the overlap coefficient between two sets of XML nodes.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "s1", "type" : null, "occurrence" : null, "description" : "
     The first set.
    " }, { "name" : "s2", "type" : null, "occurrence" : null, "description" : "
     The second set.
    " } ], "returns" : { "type" : "xs:double", "description" : "The overlap coefficient between the two sets." }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.28msec.com/modules/http/util/cache" : { "ns" : "http://www.28msec.com/modules/http/util/cache", "description" : " This module contains a collection of convenience functions to help\n developers work with HTTP caching options.\n", "sees" : [  ], "authors" : [ "28msec" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.28msec.com/modules/http/util/cache", "prefix" : "cache" }, { "uri" : "http://www.28msec.com/modules/http/response", "prefix" : "resp" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 0, "name" : "no-cache", "qname" : "cache:no-cache", "signature" : "() as empty-sequence()", "description" : " 
    Forces a client not to cache the response by setting the appropriate\n HTTP headers.
    \n In detail, the following HTTP headers will be set in the response:\n 
      \n   
    • Cache-Control: no-cache
      • \n   
    • Pragma: no-cache
      • \n   
    • Expires: 0
      • \n 
    \n", "summary" : "
      Forces a client not to cache the response by setting the appropriate\n HTTP headers.
    ", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "empty-sequence()", "description" : "On success, the empty-sequence is returned" }, "errors" : [  ] } ], "variables" : [  ] }, "http://www.zorba-xquery.com/modules/schema-tools" : { "ns" : "http://www.zorba-xquery.com/modules/schema-tools", "description" : " This module provides funtionality to get sample XMLSchema from XML instances\n and sample XML instances from XMLSchema.\n Apache XMLBeans library is used to implement\n inst2xsd and xsd2inst functions.\n 
    \n 
    \n Note: Since this module has a Java library dependency a JVM required\n to be installed on the system. For Windows: jvm.dll is required on the system\n path ( usually located in \"C:\\Program Files\\Java\\jre6\\bin\\client\".\n", "sees" : [ "http://xmlbeans.apache.org/", "http://xmlbeans.apache.org" ], "authors" : [ "Cezar Andrei" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/schema", "prefix" : "schema-options" }, { "uri" : "http://www.zorba-xquery.com/modules/schema-tools", "prefix" : "schema-tools" }, { "uri" : "http://www.zorba-xquery.com/modules/schema-tools/schema-tools-options", "prefix" : "st-options" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "inst2xsd", "qname" : "schema-tools:inst2xsd", "signature" : "($instances as element(*)+, $options as element(st-options:inst2xsd-options)?) as document()*", "description" : " The inst2xsd function takes a set of sample XML instance elements as input and\n generates a set of sample XMLSchema documents that define\n the content of the given input.\n 
    \n Please consult the\n official documentation for further\n information.\n 
    \n Example:
    \n  import module namespace st = \"http://www.zorba-xquery.com/modules/schema-tools\";\n  declare namespace sto =\n      \"http://www.zorba-xquery.com/modules/schema-tools/schema-tools-options\";\n  let $instances := (<a><b/><c/></a>, <b/>, <c>ccc</c>)\n  let $options  :=\n     <sto:inst2xsd-options xmlns:sto=\n       \"http://www.zorba-xquery.com/modules/schema-tools/schema-tools-options\">\n       <sto:design>vbd</sto:design>\n       <sto:simple-content-types>smart</sto:simple-content-types>\n       <sto:use-enumeration>10</sto:use-enumeration>\n     </sto:inst2xsd-options>\n  return\n      st:inst2xsd($instances, $options)\n 
    \n 
    \n", "summary" : "
     The inst2xsd function takes a set of sample XML instance elements as input and\n generates a set of sample XMLSchema documents that define\n the content of the given input.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "instances", "type" : "element(*)", "occurrence" : "+", "description" : "
     The input XML instance elements
    " }, { "name" : "options", "type" : "element(st-options:inst2xsd-options)", "occurrence" : "?", "description" : "
     Options:
     
       
    • design: Choose the generated schema design
       - rdd: Russian Doll Design - local elements and local types
       - ssd: Salami Slice Design - global elements and local types
       - vbd (default): Venetian Blind Design - local elements and global complex types
      •  
    • simple-content-types: type of leaf nodes
       - smart (default): try to find the right simple XMLSchema type
       - always-string: use xsd:string for all simple types
      •  
    • use-enumeration: - when there are multiple valid values in a list
       - 1: never use enumeration
       - 2 or more (default 10): use enumeration if less than this number of occurrences - number option
      •  
    • verbose: - stdout verbose info
       - true: - output type holder information
       - false (default): no output
    " } ], "returns" : { "type" : "document()*", "description" : "The generated XMLSchema documents." }, "errors" : [ "schema-tools:VM001 If Zorba was unable to start the JVM.", "schema-tools:JAVA-EXCEPTION If Apache XMLBeans throws an exception." ] }, { "isDocumented" : true, "arity" : 3, "name" : "xsd2inst", "qname" : "schema-tools:xsd2inst", "signature" : "($schemas as element(*)+, $rootElementName as xs:string, $options as element(st-options:xsd2inst-options)?) as document()", "description" : " The xsd2inst function takes a set of XML Schema elements as input and the\n local name of the root element and\n generates a document that represents one sample XML instance of the given\n input schemas. The local name is searched in schema global element definitions\n in the order of schemas parameter.\n 
    \n Please consult the\n official documentation for further\n   information.\n 
    \n Example: 
    \n  import module namespace st = \"http://www.zorba-xquery.com/modules/schema-tools\";\n  declare namespace sto =\n      \"http://www.zorba-xquery.com/modules/schema-tools/schema-tools-options\";\n  let $xsds  :=\n     ( <xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\"\n           attributeFormDefault=\"unqualified\"\n           elementFormDefault=\"qualified\">\n         <xs:element name=\"a\" type=\"aType\"/>\n         <xs:complexType name=\"aType\">\n           <xs:sequence>\n             <xs:element type=\"xs:string\" name=\"b\"/>\n             <xs:element type=\"xs:string\" name=\"c\"/>\n           </xs:sequence>\n         </xs:complexType>\n       </xs:schema> )\n  let $options :=\n    <sto:xsd2inst-options xmlns:sto=\n      \"http://www.zorba-xquery.com/modules/schema-tools/schema-tools-options\">\n      <sto:network-downloads>false</sto:network-downloads>\n      <sto:no-pvr>false</sto:no-pvr>\n      <sto:no-upa>false</sto:no-upa>\n    </sto:xsd2inst-options>\n  return\n      st:xsd2inst($xsds, \"a\", $options)\n 

    \n", "summary" : "
     The xsd2inst function takes a set of XML Schema elements as input and the\n local name of the root element and\n generates a document that represents one sample XML instance of the given\n input schemas.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "schemas", "type" : "element(*)", "occurrence" : "+", "description" : "
     elements representing XMLSchema definitions
    " }, { "name" : "rootElementName", "type" : "xs:string", "occurrence" : null, "description" : "
     The local name of the instance root element. If multiple target namespaces are used, first one found - using the sequence order - will be used.
    " }, { "name" : "options", "type" : "element(st-options:xsd2inst-options)", "occurrence" : "?", "description" : "
     Options:
       
    • network-downloads: boolean (default false)
       - true allows XMLBeans to use network when resolving schema imports and includes
      •  
    • no-pvr: boolean (default false)
       - true to disable particle valid (restriction) rule, false otherwise
      •  
    • no-upa: boolean (default false)
       - true to disable unique particle attribution rule, false otherwise
    " } ], "returns" : { "type" : "document()", "description" : "The generated output document, representing a sample XML instance." }, "errors" : [ "schema-tools:VM001 If Zorba was unable to start the JVM.", "schema-tools:JAVA-EXCEPTION If Apache XMLBeans throws an exception." ] } ], "variables" : [  ] }, "http://xbrl.io/modules/bizql/entities" : { "ns" : "http://xbrl.io/modules/bizql/entities", "description" : " 
    This module provides functions for retrieving information about entities.\n Entities submit archives (see archives module),\n for example, to a reporting authority. Entities\n are identified with an EID (Entity ID).
    \n 
    With this module, you can retrieve all entities, or a certain number of entities\n with their EIDs, or obtain the EID of entities you already have.
    \n 
    Entities are stored in a MongoDB datasource called xbrl.
    \n 
    Each entity can be associated with a set of tags that makes it easier\n to manage them. The e:entities#1 function\n allows to retrieve all entities with a given tag.
    \n", "sees" : [  ], "authors" : [ "Charles Hoffman", "Matthias Brantner", "Dennis Knochenwefel", "Ghislain Fourny" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.28msec.com/modules/credentials", "prefix" : "credentials" }, { "uri" : "http://xbrl.io/modules/bizql/entities", "prefix" : "entities" }, { "uri" : "http://www.28msec.com/modules/mongodb", "prefix" : "mongo" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 1, "name" : "eid", "qname" : "entities:eid", "signature" : "($entities-or-ids as item()*) as atomic*", "description" : " 
    Converts the input to a normalized entity identifier (EID). The input\n can be either an EID, or an entity object which contains an _id.
    \n", "summary" : "
      Converts the input to a normalized entity identifier (EID).
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entities-or-ids", "type" : "item()", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : "atomic*", "description" : "the normalized EIDs." }, "errors" : [ "entities:INVALID_PARAMETER if the EID or entity is not valid." ] }, { "isDocumented" : true, "arity" : 0, "name" : "entities", "qname" : "entities:entities", "signature" : "() as object()*", "description" : " 
    Return all entities.
    \n", "summary" : "
      Return all entities.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()*", "description" : "all entities." }, "errors" : [  ] }, { "isDocumented" : true, "arity" : 1, "name" : "entities", "qname" : "entities:entities", "signature" : "($entities-or-ids as item()*) as object()*", "description" : " 
    Return the entities with the given EIDs.
    \n", "summary" : "
      Return the entities with the given EIDs.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entities-or-ids", "type" : "item()", "occurrence" : "*", "description" : "
     the ids of the entities (EIDs) or the entities themselves.
    " } ], "returns" : { "type" : "object()*", "description" : "the entities with the given EIDs the empty sequence if no entity was found or if the input is an empty sequence." }, "errors" : [  ] } ], "variables" : [ { "name" : "entities:col", "type" : "string", "description" : " Name of the collection the entities are stored in.\n" } ] }, "http://www.zorba-xquery.com/modules/cryptography/hmac" : { "ns" : "http://www.zorba-xquery.com/modules/cryptography/hmac", "description" : " This module provides a function to generate hash-based\n message authentication codes (HMAC) involving a cryptographic\n hash function (e.g. SHA1).\n", "sees" : [  ], "authors" : [ "William Candillon" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://www.zorba-xquery.com/modules/cryptography/hmac", "prefix" : "hmac" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" } ], "functions" : [ { "isDocumented" : true, "arity" : 2, "name" : "sha1", "qname" : "hmac:sha1", "signature" : "($message as xs:string, $secret-key as xs:string) as xs:string external", "description" : " This function provides hash-based message authentication code using\n the SHA1 algorithm.\n", "summary" : "
     This function provides hash-based message authentication code using\n the SHA1 algorithm.
    ", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "message", "type" : "xs:string", "occurrence" : null, "description" : "
     the message to be authenticated
    " }, { "name" : "secret-key", "type" : "xs:string", "occurrence" : null, "description" : "
     the secret key used for calculating the authentication
    " } ], "returns" : { "type" : "xs:string", "description" : "hash-based base64 encoded message authentication code" }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/csvview" : { "ns" : "http://api.28.io/csvview", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "", "prefix" : "an" }, { "uri" : "http://api.28.io/csvview", "prefix" : "csvview" }, { "uri" : "http://api.28.io/model", "prefix" : "model" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "column", "qname" : "csvview:column", "signature" : "($data) as xs:string", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "data", "type" : null, "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "line", "qname" : "csvview:line", "signature" : "($entries as xs:string*)", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "entries", "type" : "xs:string", "occurrence" : "*", "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 2, "name" : "show-nodes", "qname" : "csvview:show-nodes", "signature" : "($nodes, $show-headers as xs:boolean)", "description" : "", "summary" : "", "annotation_str" : " %an:sequential", "annotations" : [ { "prefix" : "an", "ns" : "", "name" : "sequential", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "nodes", "type" : null, "occurrence" : null, "description" : "" }, { "name" : "show-headers", "type" : "xs:boolean", "occurrence" : null, "description" : "" } ], "returns" : { "type" : null, "description" : "" }, "errors" : [  ] } ], "variables" : [  ] }, "http://api.28.io/util" : { "ns" : "http://api.28.io/util", "description" : "", "sees" : [  ], "authors" : [  ], "version" : null, "encoding" : null, "namespaces" : [ { "uri" : "http://www.28msec.com/modules/http/request", "prefix" : "req" }, { "uri" : "http://api.28.io/util", "prefix" : "util" } ], "functions" : [ { "isDocumented" : false, "arity" : 1, "name" : "param-or-body", "qname" : "util:param-or-body", "signature" : "($param-name as xs:string) as xs:string?", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "param-name", "type" : "xs:string", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string?", "description" : "" }, "errors" : [  ] }, { "isDocumented" : false, "arity" : 1, "name" : "path", "qname" : "util:path", "signature" : "($from as xs:integer) as xs:string*", "description" : "", "summary" : "", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "from", "type" : "xs:integer", "occurrence" : null, "description" : "" } ], "returns" : { "type" : "xs:string*", "description" : "" }, "errors" : [  ] } ], "variables" : [ { "name" : "util:collection-namespace", "type" : "item()*", "description" : "" } ] } };
-});
diff --git a/lib/ace/mode/xquery/xqlint.js b/lib/ace/mode/xquery/xqlint.js
index c7887aae..bfb18c1e 100644
--- a/lib/ace/mode/xquery/xqlint.js
+++ b/lib/ace/mode/xquery/xqlint.js
@@ -1,6 +1,6 @@
 define(function(require, exports, module) {
-module.exports = (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o
 // REx command line: JSONiqParser.ebnf -ll 2 -backtrack -tree -javascript -a xqlint
 
@@ -44140,7 +44140,7 @@ JSONiqParser.TOKEN =
 
 },
 {}],
-10:[function(_dereq_,module,exports){
+10:[function(require,module,exports){
 // This file was generated on Thu Jul 24, 2014 15:00 (UTC+01) by REx v5.30 which is Copyright (c) 1979-2014 by Gunther Rademacher 
 // REx command line: XQueryParser.ebnf -ll 2 -backtrack -tree -javascript -a xqlint
 
@@ -78693,7 +78693,7 @@ XQueryParser.TOKEN =
 
 },
 {}],
-11:[function(_dereq_,module,exports){
+11:[function(require,module,exports){
 'use strict';
 
 exports.TreeOps = {
@@ -78786,18 +78786,18 @@ exports.TreeOps = {
 };
 },
 {}],
-12:[function(_dereq_,module,exports){
+12:[function(require,module,exports){
 'use strict';
 
-var JSONiqParser = _dereq_('./parsers/JSONiqParser').JSONiqParser;
-var XQueryParser = _dereq_('./parsers/XQueryParser').XQueryParser;
-var JSONParseTreeHandler = _dereq_('./parsers/JSONParseTreeHandler').JSONParseTreeHandler;
-var Translator = _dereq_('./compiler/translator').Translator;
-var StyleChecker = _dereq_('./formatter/style_checker').StyleChecker;
-var completer = _dereq_('../lib/completion/completer');
+var JSONiqParser = require('./parsers/JSONiqParser').JSONiqParser;
+var XQueryParser = require('./parsers/XQueryParser').XQueryParser;
+var JSONParseTreeHandler = require('./parsers/JSONParseTreeHandler').JSONParseTreeHandler;
+var Translator = require('./compiler/translator').Translator;
+var StyleChecker = require('./formatter/style_checker').StyleChecker;
+var completer = require('../lib/completion/completer');
     
 var createStaticContext = exports.createStaticContext = function(){
-    var StaticContext = _dereq_('./compiler/static_context').StaticContext;
+    var StaticContext = require('./compiler/static_context').StaticContext;
     return new StaticContext();
 };
 
@@ -78906,7 +78906,6 @@ exports.XQLint = function (source, opts) {
 };
 
 },
-{"../lib/completion/completer":6,"./compiler/static_context":4,"./compiler/translator":5,"./formatter/style_checker":7,"./parsers/JSONParseTreeHandler":8,"./parsers/JSONiqParser":9,"./parsers/XQueryParser":10}]},{},[12])
-(12)
+{"../lib/completion/completer":6,"./compiler/static_context":4,"./compiler/translator":5,"./formatter/style_checker":7,"./parsers/JSONParseTreeHandler":8,"./parsers/JSONiqParser":9,"./parsers/XQueryParser":10}]},{},[12])(12)
 
 });
\ No newline at end of file
diff --git a/lib/ace/mode/xquery_worker.js b/lib/ace/mode/xquery_worker.js
index 6a8432b3..2ca32fe5 100644
--- a/lib/ace/mode/xquery_worker.js
+++ b/lib/ace/mode/xquery_worker.js
@@ -35,7 +35,6 @@ var oop = require("../lib/oop");
 var Mirror = require("../worker/mirror").Mirror;
 var XQLintLib = require("./xquery/xqlint");
 var XQLint =  XQLintLib.XQLint;
-var Modules = require("./xquery/modules").Modules;
 
 var getModuleResolverFromModules = function(modules){
     return function(uri){
@@ -68,8 +67,8 @@ var XQueryWorker = exports.XQueryWorker = function(sender) {
     this.opts = {
         styleCheck: false
     };
-    this.availableModuleNamespaces = Object.keys(Modules);
-    this.moduleResolver = getModuleResolverFromModules(Modules);
+    //this.availableModuleNamespaces = Object.keys(Modules);
+    //this.moduleResolver; = getModuleResolverFromModules(Modules);
     var that = this;
 
     this.sender.on("complete", function(e){
@@ -105,7 +104,7 @@ oop.inherits(XQueryWorker, Mirror);
         }
         var opts = {
             styleCheck: this.styleCheck,
-            staticContext: sctx,
+            staticContext: sctx
         };
         this.xqlint = new XQLint(value, opts);
         this.sender.emit("markers", this.xqlint.getMarkers());
diff --git a/lib/ace/mouse/default_handlers.js b/lib/ace/mouse/default_handlers.js
index bbd85484..a48d1097 100644
--- a/lib/ace/mouse/default_handlers.js
+++ b/lib/ace/mouse/default_handlers.js
@@ -70,10 +70,10 @@ function DefaultHandlers(mouseHandler) {
         if (button !== 0) {
             var selectionRange = editor.getSelectionRange();
             var selectionEmpty = selectionRange.isEmpty();
-
+            editor.$blockScrolling++;
             if (selectionEmpty)
                 editor.selection.moveToPosition(pos);
-
+            editor.$blockScrolling--;
             // 2: contextmenu, 1: linux paste
             editor.textInput.onContextMenu(ev.domEvent);
             return; // stopping event here breaks contextmenu on ff mac
@@ -100,7 +100,7 @@ function DefaultHandlers(mouseHandler) {
         pos = pos || this.editor.renderer.screenToTextCoordinates(this.x, this.y);
         var editor = this.editor;
         // allow double/triple click handlers to change selection
-        
+        editor.$blockScrolling++;
         if (this.mousedownEvent.getShiftKey())
             editor.selection.selectToPosition(pos);
         else if (!waitForClickSelection)
@@ -112,12 +112,13 @@ function DefaultHandlers(mouseHandler) {
         }
         editor.setStyle("ace_selecting");
         this.setState("select");
+        editor.$blockScrolling--;
     };
 
     this.select = function() {
         var anchor, editor = this.editor;
         var cursor = editor.renderer.screenToTextCoordinates(this.x, this.y);
-
+        editor.$blockScrolling++;
         if (this.$clickSelection) {
             var cmp = this.$clickSelection.comparePoint(cursor);
 
@@ -133,7 +134,7 @@ function DefaultHandlers(mouseHandler) {
             editor.selection.setSelectionAnchor(anchor.row, anchor.column);
         }
         editor.selection.selectToPosition(cursor);
-
+        editor.$blockScrolling--;
         editor.renderer.scrollCursorIntoView();
     };
 
@@ -141,7 +142,7 @@ function DefaultHandlers(mouseHandler) {
         var anchor, editor = this.editor;
         var cursor = editor.renderer.screenToTextCoordinates(this.x, this.y);
         var range = editor.selection[unitName](cursor.row, cursor.column);
-
+        editor.$blockScrolling++;
         if (this.$clickSelection) {
             var cmpStart = this.$clickSelection.comparePoint(range.start);
             var cmpEnd = this.$clickSelection.comparePoint(range.end);
@@ -165,7 +166,7 @@ function DefaultHandlers(mouseHandler) {
             editor.selection.setSelectionAnchor(anchor.row, anchor.column);
         }
         editor.selection.selectToPosition(cursor);
-
+        editor.$blockScrolling--;
         editor.renderer.scrollCursorIntoView();
     };
 
diff --git a/lib/ace/mouse/mouse_handler.js b/lib/ace/mouse/mouse_handler.js
index 9cf26721..26985862 100644
--- a/lib/ace/mouse/mouse_handler.js
+++ b/lib/ace/mouse/mouse_handler.js
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2010, Ajax.org B.V.
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *     * Redistributions of source code must retain the above copyright
@@ -14,7 +14,7 @@
  *     * Neither the name of Ajax.org B.V. nor the
  *       names of its contributors may be used to endorse or promote products
  *       derived from this software without specific prior written permission.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -46,13 +46,15 @@ var MouseHandler = function(editor) {
     new DefaultHandlers(this);
     new DefaultGutterHandler(this);
     new DragdropHandler(this);
-    
-    var focusEditor = function(e) { 
-        if (!editor.isFocused() && editor.textInput)
-            editor.textInput.moveToMouse(e);
-        editor.focus() 
+
+    var focusEditor = function(e) {
+        // because we have to call event.preventDefault() any window on ie and iframes
+        // on other browsers do not get focus, so we have to call window.focus() here
+        if (!document.hasFocus || !document.hasFocus())
+            window.focus();
+        editor.focus();
     };
-    
+
     var mouseTarget = editor.renderer.getMouseEventTarget();
     event.addListener(mouseTarget, "click", this.onMouseEvent.bind(this, "click"));
     event.addListener(mouseTarget, "mousemove", this.onMouseMove.bind(this, "mousemove"));
@@ -62,7 +64,7 @@ var MouseHandler = function(editor) {
         event.addMultiMouseDownListener(editor.renderer.scrollBarH.inner, [400, 300, 250], this, "onMouseEvent");
         if (useragent.isIE) {
             event.addListener(editor.renderer.scrollBarV.element, "mousedown", focusEditor);
-            event.addListener(editor.renderer.scrollBarH.element, "mousemove", focusEditor);
+            event.addListener(editor.renderer.scrollBarH.element, "mousedown", focusEditor);
         }
     }
     event.addMouseWheelListener(editor.container, this.onMouseWheel.bind(this, "mousewheel"));
@@ -83,12 +85,12 @@ var MouseHandler = function(editor) {
     editor.on("mousemove", function(e){
         if (_self.state || _self.$dragDelay || !_self.$dragEnabled)
             return;
-        
-        var char = editor.renderer.screenToTextCoordinates(e.x, e.y);
+
+        var character = editor.renderer.screenToTextCoordinates(e.x, e.y);
         var range = editor.session.selection.getRange();
         var renderer = editor.renderer;
 
-        if (!range.isEmpty() && range.insideStart(char.row, char.column)) {
+        if (!range.isEmpty() && range.insideStart(character.row, character.column)) {
             renderer.setCursorStyle("default");
         } else {
             renderer.setCursorStyle("");
diff --git a/lib/ace/mouse/multi_select_handler.js b/lib/ace/mouse/multi_select_handler.js
index 8d6af6b5..649043fa 100644
--- a/lib/ace/mouse/multi_select_handler.js
+++ b/lib/ace/mouse/multi_select_handler.js
@@ -83,15 +83,15 @@ function onMouseDown(e) {
     var selectionMode;
     if (editor.$mouseHandler.$enableJumpToDef) {
         if (ctrl && alt || accel && alt)
-            selectionMode = "add";
-        else if (alt)
+            selectionMode = shift ? "block" : "add";
+        else if (alt && editor.$blockSelectEnabled)
             selectionMode = "block";
     } else {
         if (accel && !alt) {
             selectionMode = "add";
             if (!isMultiSelect && shift)
                 return;
-        } else if (alt) {
+        } else if (alt && editor.$blockSelectEnabled) {
             selectionMode = "block";
         }
     }
@@ -117,7 +117,7 @@ function onMouseDown(e) {
         
         if (shift) {
             oldRange = null;
-            range = selection.ranges[0];
+            range = selection.ranges[0] || range;
             editor.removeSelectionMarker(range);
         }
         editor.once("mouseup", function() {
@@ -150,7 +150,8 @@ function onMouseDown(e) {
             if (isSamePoint(screenCursor, newCursor) && isSamePoint(cursor, selection.lead))
                 return;
             screenCursor = newCursor;
-
+            
+            editor.$blockScrolling++;
             editor.selection.moveToPosition(cursor);
             editor.renderer.scrollCursorIntoView();
 
@@ -160,8 +161,9 @@ function onMouseDown(e) {
                 rectSel[0] = editor.$mouseHandler.$clickSelection.clone();
             rectSel.forEach(editor.addSelectionMarker, editor);
             editor.updateSelectionMarkers();
+            editor.$blockScrolling--;
         };
-        
+        editor.$blockScrolling++;
         if (isMultiSelect && !accel) {
             selection.toSingleRange();
         } else if (!isMultiSelect && accel) {
@@ -173,6 +175,7 @@ function onMouseDown(e) {
             screenAnchor = session.documentToScreenPosition(selection.lead);            
         else
             selection.moveToPosition(pos);
+        editor.$blockScrolling--;
         
         screenCursor = {row: -1, column: -1};
 
diff --git a/lib/ace/multi_select.js b/lib/ace/multi_select.js
index f393012e..1d0b69e7 100644
--- a/lib/ace/multi_select.js
+++ b/lib/ace/multi_select.js
@@ -552,38 +552,12 @@ var Editor = require("./editor").Editor;
             var pos = anchor == this.multiSelect.anchor
                 ? range.cursor == range.start ? range.end : range.start
                 : range.cursor;
-            if (!isSamePoint(pos, anchor))
+            if (pos.row != anchor.row 
+                || this.session.$clipPositionToDocument(pos.row, pos.column).column != anchor.column)
                 this.multiSelect.toSingleRange(this.multiSelect.toOrientedRange());
         }
     };
 
-    // todo this should change when paste becomes a command
-    this.onPaste = function(text) {
-        if (this.$readOnly)
-            return;
-
-
-        var e = {text: text};
-        this._signal("paste", e);
-        text = e.text;
-        if (!this.inMultiSelectMode || this.inVirtualSelectionMode)
-            return this.insert(text);
-
-        var lines = text.split(/\r\n|\r|\n/);
-        var ranges = this.selection.rangeList.ranges;
-
-        if (lines.length > ranges.length || lines.length < 2 || !lines[1])
-            return this.commands.exec("insertstring", this, text);
-
-        for (var i = ranges.length; i--;) {
-            var range = ranges[i];
-            if (!range.isEmpty())
-                this.session.remove(range);
-
-            this.session.insert(range.start, lines[i]);
-        }
-    };
-
     /**
      * Finds and selects all the occurences of `needle`.
      * @param {String} The text to find
@@ -780,9 +754,9 @@ var Editor = require("./editor").Editor;
                 if (fr < 0) fr = 0;
                 if (lr >= max) lr = max - 1;
             }
-            var lines = this.session.doc.removeLines(fr, lr);
+            var lines = this.session.removeFullLines(fr, lr);
             lines = this.$reAlignText(lines, guessRange);
-            this.session.doc.insert({row: fr, column: 0}, lines.join("\n") + "\n");
+            this.session.insert({row: fr, column: 0}, lines.join("\n") + "\n");
             if (!guessRange) {
                 range.start.column = 0;
                 range.end.column = lines[lines.length - 1].length;
@@ -950,7 +924,8 @@ function addAltCursorListeners(editor){
     var el = editor.textInput.getElement();
     var altCursor = false;
     event.addListener(el, "keydown", function(e) {
-        if (e.keyCode == 18 && !(e.ctrlKey || e.shiftKey || e.metaKey)) {
+        var altDown = e.keyCode == 18 && !(e.ctrlKey || e.shiftKey || e.metaKey);
+        if (editor.$blockSelectEnabled && altDown) {
             if (!altCursor) {
                 editor.renderer.setMouseCursor("crosshair");
                 altCursor = true;
@@ -988,6 +963,12 @@ require("./config").defineOptions(Editor.prototype, "editor", {
             }
         },
         value: true
+    },
+    enableBlockSelect: {
+        set: function(val) {
+            this.$blockSelectEnabled = val;
+        },
+        value: true
     }
 });
 
diff --git a/lib/ace/multi_select_test.js b/lib/ace/multi_select_test.js
index 45ab4965..7fd504fb 100644
--- a/lib/ace/multi_select_test.js
+++ b/lib/ace/multi_select_test.js
@@ -30,26 +30,67 @@
 
 if (typeof process !== "undefined") {
     require("amd-loader");
+    require("./test/mockdom");
 }
 
 define(function(require, exports, module) {
 "use strict";
 
-var EditSession = require("./edit_session").EditSession;
-var Editor = require("./editor").Editor;
-var MockRenderer = require("./test/mockrenderer").MockRenderer;
-var Range = require("./range").Range;
+require("./multi_select");
 var assert = require("./test/assertions");
-var MultiSelect = require("./multi_select").MultiSelect;
+var Range = require("./range").Range;
+var Editor = require("./editor").Editor;
+var EditSession = require("./edit_session").EditSession;
+var MockRenderer = require("./test/mockrenderer").MockRenderer;
+var UndoManager = require("./undomanager").UndoManager;
 
 var editor;
 var exec = function(name, times, args) {
     do {
         editor.commands.exec(name, editor, args);
-    } while(times --> 1)
+    } while(times --> 1);
 };
 var testRanges = function(str) {
     assert.equal(editor.selection.getAllRanges() + "", str + "");
+};
+function getSelection(editor) {
+    var data = editor.multiSelect.toJSON();
+    if (!data.length) data = [data];
+    data = data.map(function(x) {
+        var a, c;
+        if (x.isBackwards) {
+            a = x.end;
+            c = x.start;
+        } else {
+            c = x.end;
+            a = x.start;
+        }
+        return Range.comparePoints(a, c) 
+            ? [a.row, a.column, c.row, c.column]
+            : [a.row, a.column];
+    });
+    return data.length > 1 ? data : data[0];
+}
+function testSelection(editor, data) {
+    assert.equal(getSelection(editor) + "", data + "");
+}
+function setSelection(editor, data) {
+    if (typeof data[0] == "number")
+        data = [data];
+    editor.selection.fromJSON(data.map(function(x) {
+        var start = {row: x[0], column: x[1]};
+        var end = x.length == 2 ? start : {row: x[2], column: x[3]};
+        var isBackwards = Range.comparePoints(start, end) > 0;
+        return isBackwards ? {
+            start: end,
+            end: start,
+            isBackwards: isBackwards
+        } : {
+            start: start,
+            end: end,
+            isBackwards: isBackwards
+        };
+    }));
 }
 
 module.exports = {
@@ -63,7 +104,6 @@ module.exports = {
             "    wtt.w"
         ]);
         editor = new Editor(new MockRenderer(), doc);
-        MultiSelect(editor);
 
         editor.navigateFileEnd();
         exec("selectMoreBefore", 3);
@@ -90,7 +130,6 @@ module.exports = {
             "    wtt.we"
         ]);
         editor = new Editor(new MockRenderer(), doc);
-        MultiSelect(editor);
 
         editor.selectMoreLines(1);
         testRanges("Range: [0/0] -> [0/0],Range: [1/0] -> [1/0]");
@@ -113,9 +152,8 @@ module.exports = {
             "    wtt.w"
         ]);
         editor = new Editor(new MockRenderer(), doc);
-        MultiSelect(editor);
 
-        editor.selectMoreLines(1)
+        editor.selectMoreLines(1);
         testRanges("Range: [0/0] -> [0/0],Range: [1/0] -> [1/0]");
         assert.ok(editor.inMultiSelectMode);
 
@@ -134,7 +172,6 @@ module.exports = {
             "    wtt.w"
         ]);
         editor = new Editor(new MockRenderer(), doc);
-        MultiSelect(editor);
         var selection = editor.selection;
 
         var range1 = new Range(0, 2, 0, 4);
@@ -158,7 +195,6 @@ module.exports = {
     "test: onPaste in command with multiselect": function() {
         var doc = new EditSession(["l1", "l2"]);
         editor = new Editor(new MockRenderer(), doc);
-        MultiSelect(editor);
         editor.commands.addCommand({
             name: 'insertfoo',
             exec: function(ed) { ed.onPaste('foo'); },
@@ -167,23 +203,53 @@ module.exports = {
         var selection = editor.selection;
         var range1 = new Range(0,2,0,2);
         var range2 = new Range(1,2,1,2);
-        selection.fromOrientedRange(range1)
+        selection.fromOrientedRange(range1);
         selection.addRange(range2);
         editor.execCommand('insertfoo');
         assert.equal('l1foo\nl2foo', editor.getValue());
     },
+    
+    "test multiselect move lines": function() {
+        editor = new Editor(new MockRenderer());
+        
+        editor.setValue("l1\nl2\nl3\nl4", -1);
+        setSelection(editor, [[0,2],[1,2],[2,2],[3,2]]);
+        
+        exec("copylinesdown");
+        assert.equal(editor.getValue(),"l1\nl1\nl2\nl2\nl3\nl3\nl4\nl4");
+        testSelection(editor, [[1,2],[3,2],[5,2],[7,2]]);
+        exec("copylinesup");
+        assert.equal(editor.getValue(),"l1\nl1\nl1\nl2\nl2\nl2\nl3\nl3\nl3\nl4\nl4\nl4");
+        testSelection(editor, [[1,2],[4,2],[7,2],[10,2]]);
+        exec("removeline");
+        assert.equal(editor.getValue(),"l1\nl1\nl2\nl2\nl3\nl3\nl4\nl4");
+        testSelection(editor, [[1,0],[3,0],[5,0],[7,0]]);
+        
+        setSelection(editor, [[1,2],[1,1,1,0],[3,0,3,1],[5,0,5,1],[7,0,7,1]]);
+        exec("copylinesdown");
+        exec("copylinesup");
+        assert.equal(editor.getValue(),"l1\nl1\nl1\nl1\nl2\nl2\nl2\nl2\nl3\nl3\nl3\nl3\nl4\nl4\nl4\nl4");
+        testSelection(editor, [[2,2],[2,1,2,0],[6,0,6,1],[10,0,10,1],[14,0,14,1]]);
+        
+        exec("movelinesdown", 12);
+        assert.equal(editor.getValue(),"l1\nl1\nl1\nl2\nl2\nl2\nl3\nl3\nl3\nl4\nl4\nl4\nl1\nl2\nl3\nl4");
+        testSelection(editor, [[12,2],[12,1,12,0],[13,0,13,1],[14,0,14,1],[15,0,15,1]]);
+        
+        exec("movelinesup", 12);
+        assert.equal(editor.getValue(),"l1\nl2\nl3\nl4\nl1\nl1\nl1\nl2\nl2\nl2\nl3\nl3\nl3\nl4\nl4\nl4");
+        testSelection(editor, [[0,2],[0,1,0,0],[1,0,1,1],[2,0,2,1],[3,0,3,1]]);
+    },
 
     "test multiselect fromJSON/toJSON": function() {
         var doc = new EditSession(["l1", "l2"]);
         editor = new Editor(new MockRenderer(), doc);
-        MultiSelect(editor);
         var selection = editor.selection;
         
         var before = selection.toJSON();
         
         var range1 = new Range(0,2,0,2);
         var range2 = new Range(1,2,1,2);
-        selection.fromOrientedRange(range1)
+        selection.fromOrientedRange(range1);
         selection.addRange(range2);
         
         var after = selection.toJSON();
@@ -195,11 +261,25 @@ module.exports = {
         selection.fromJSON(after);
         assert.ok(!selection.isEqual(before));
         assert.ok(selection.isEqual(after));
+    },
+    
+    "test multiselect align": function() {
+        var doc = new EditSession(["l1", "l2", "l3"]);
+        doc.setUndoManager(new UndoManager());
+        editor = new Editor(new MockRenderer(), doc);
+        var selection = editor.selection;
+        selection.addRange(new Range(1,0,1,0))
+        selection.addRange(new Range(2,2,2,2))
+        editor.execCommand("alignCursors");
+        assert.equal('  l1\n  l2\nl3', editor.getValue());
+        doc.markUndoGroup();
+        editor.execCommand("undo");
+        assert.equal('l1\nl2\nl3', editor.getValue());
     }
 };
 
 });
 
 if (typeof module !== "undefined" && module === require.main) {
-    require("asyncjs").test.testcase(module.exports).exec()
+    require("asyncjs").test.testcase(module.exports).exec();
 }
diff --git a/lib/ace/placeholder.js b/lib/ace/placeholder.js
index 582e2c2b..0e299594 100644
--- a/lib/ace/placeholder.js
+++ b/lib/ace/placeholder.js
@@ -150,28 +150,27 @@ var PlaceHolder = function(session, length, pos, others, mainClass, othersClass)
      * Emitted when the place holder updates.
      *
      **/
-    this.onUpdate = function(event) {
-        var delta = event.data;
-        var range = delta.range;
+    this.onUpdate = function(delta) {
+        var range = delta;
         if(range.start.row !== range.end.row) return;
         if(range.start.row !== this.pos.row) return;
         if (this.$updating) return;
         this.$updating = true;
-        var lengthDiff = delta.action === "insertText" ? range.end.column - range.start.column : range.start.column - range.end.column;
+        var lengthDiff = delta.action === "insert" ? range.end.column - range.start.column : range.start.column - range.end.column;
         
         if(range.start.column >= this.pos.column && range.start.column <= this.pos.column + this.length + 1) {
             var distanceFromStart = range.start.column - this.pos.column;
             this.length += lengthDiff;
             if(!this.session.$fromUndo) {
-                if(delta.action === "insertText") {
+                if(delta.action === 'insert') {
                     for (var i = this.others.length - 1; i >= 0; i--) {
                         var otherPos = this.others[i];
                         var newPos = {row: otherPos.row, column: otherPos.column + distanceFromStart};
                         if(otherPos.row === range.start.row && range.start.column < otherPos.column)
                             newPos.column += lengthDiff;
-                        this.doc.insert(newPos, delta.text);
+                        this.doc.insertMergedLines(newPos, delta.lines);
                     }
-                } else if(delta.action === "removeText") {
+                } else if(delta.action === 'remove') {
                     for (var i = this.others.length - 1; i >= 0; i--) {
                         var otherPos = this.others[i];
                         var newPos = {row: otherPos.row, column: otherPos.column + distanceFromStart};
@@ -181,7 +180,7 @@ var PlaceHolder = function(session, length, pos, others, mainClass, othersClass)
                     }
                 }
                 // Special case: insert in beginning
-                if(range.start.column === this.pos.column && delta.action === "insertText") {
+                if(range.start.column === this.pos.column && delta.action === 'insert') {
                     setTimeout(function() {
                         this.pos.setPosition(this.pos.row, this.pos.column - lengthDiff);
                         for (var i = 0; i < this.others.length; i++) {
@@ -193,7 +192,7 @@ var PlaceHolder = function(session, length, pos, others, mainClass, othersClass)
                         }
                     }.bind(this), 0);
                 }
-                else if(range.start.column === this.pos.column && delta.action === "removeText") {
+                else if(range.start.column === this.pos.column && delta.action === 'remove') {
                     setTimeout(function() {
                         for (var i = 0; i < this.others.length; i++) {
                             var other = this.others[i];
diff --git a/lib/ace/placeholder_test.js b/lib/ace/placeholder_test.js
index 97e561fd..f674ccff 100644
--- a/lib/ace/placeholder_test.js
+++ b/lib/ace/placeholder_test.js
@@ -43,6 +43,7 @@ var assert = require("./test/assertions");
 var JavaScriptMode = require("./mode/javascript").Mode;
 var PlaceHolder = require("./placeholder").PlaceHolder;
 var UndoManager = require("./undomanager").UndoManager;
+require("./multi_select")
 
 module.exports = {
 
@@ -89,7 +90,7 @@ module.exports = {
             editor.insert('v');
             assert.equal(session.doc.getValue(), "var v$a = 10;\nconsole.log(v$a, v$a);");
             next();
-        }, 10);
+        }, 20);
     },
 
    "test: detaching placeholder" : function() {
diff --git a/lib/ace/range_list.js b/lib/ace/range_list.js
index 0cbcc394..326bc41b 100644
--- a/lib/ace/range_list.js
+++ b/lib/ace/range_list.js
@@ -180,14 +180,13 @@ var RangeList = function() {
         this.session = null;
     };
 
-    this.$onChange = function(e) {
-        var changeRange = e.data.range;
-        if (e.data.action[0] == "i"){
-            var start = changeRange.start;
-            var end = changeRange.end;
+    this.$onChange = function(delta) {
+        if (delta.action == "insert"){
+            var start = delta.start;
+            var end = delta.end;
         } else {
-            var end = changeRange.start;
-            var start = changeRange.end;
+            var end = delta.start;
+            var start = delta.end;
         }
         var startRow = start.row;
         var endRow = end.row;
diff --git a/lib/ace/scrollbar.js b/lib/ace/scrollbar.js
index 28f41fe4..466d1af1 100644
--- a/lib/ace/scrollbar.js
+++ b/lib/ace/scrollbar.js
@@ -156,9 +156,9 @@ oop.inherits(VScrollBar, ScrollBar);
      * Sets the scroll top of the scroll bar.
      * @param {Number} scrollTop The new scroll top
      **/
-    // on chrome 17+ for small zoom levels after calling this function
-    // this.element.scrollTop != scrollTop which makes page to scroll up.
     this.setScrollTop = function(scrollTop) {
+        // on chrome 17+ for small zoom levels after calling this function
+        // this.element.scrollTop != scrollTop which makes page to scroll up.
         if (this.scrollTop != scrollTop) {
             this.skipEvent = true;
             this.scrollTop = this.element.scrollTop = scrollTop;
@@ -249,9 +249,9 @@ oop.inherits(HScrollBar, ScrollBar);
      * Sets the scroll left of the scroll bar.
      * @param {Number} scrollTop The new scroll left
      **/
-    // on chrome 17+ for small zoom levels after calling this function
-    // this.element.scrollTop != scrollTop which makes page to scroll up.
     this.setScrollLeft = function(scrollLeft) {
+        // on chrome 17+ for small zoom levels after calling this function
+        // this.element.scrollTop != scrollTop which makes page to scroll up.
         if (this.scrollLeft != scrollLeft) {
             this.skipEvent = true;
             this.scrollLeft = this.element.scrollLeft = scrollLeft;
diff --git a/lib/ace/search.js b/lib/ace/search.js
index c5119319..2785640b 100644
--- a/lib/ace/search.js
+++ b/lib/ace/search.js
@@ -102,8 +102,8 @@ var Search = function() {
      * @returns {Range}
     **/
     this.find = function(session) {
-        var iterator = this.$matchIterator(session, this.$options);
-
+        var options = this.$options;
+        var iterator = this.$matchIterator(session, options);
         if (!iterator)
             return false;
 
@@ -111,7 +111,13 @@ var Search = function() {
         iterator.forEach(function(range, row, offset) {
             if (!range.start) {
                 var column = range.offset + (offset || 0);
-                firstRange = new Range(row, column, row, column+range.length);
+                firstRange = new Range(row, column, row, column + range.length);
+                if (!range.length && options.start && options.start.start
+                    && options.skipCurrent != false && firstRange.isEqual(options.start)
+                ) {
+                    firstRange = null;
+                    return false;
+                }
             } else
                 firstRange = range;
             return true;
@@ -240,8 +246,7 @@ var Search = function() {
         if (!re)
             return false;
 
-        var self = this, callback, backwards = options.backwards;
-
+        var callback;
         if (options.$isMultiLine) {
             var len = re.length;
             var matchIterator = function(line, row, offset) {
@@ -266,7 +271,7 @@ var Search = function() {
                 if (callback(range))
                     return true;
             };
-        } else if (backwards) {
+        } else if (options.backwards) {
             var matchIterator = function(line, row, startIndex) {
                 var matches = lang.getMatchOffsets(line, re);
                 for (var i = matches.length-1; i >= 0; i--)
@@ -281,11 +286,13 @@ var Search = function() {
                         return true;
             };
         }
+        
+        var lineIterator = this.$lineIterator(session, options);
 
         return {
             forEach: function(_callback) {
                 callback = _callback;
-                self.$lineIterator(session, options).forEach(matchIterator);
+                lineIterator.forEach(matchIterator);
             }
         };
     };
diff --git a/lib/ace/search_test.js b/lib/ace/search_test.js
index 6e12a53e..3c27c4d8 100644
--- a/lib/ace/search_test.js
+++ b/lib/ace/search_test.js
@@ -36,6 +36,8 @@ define(function(require, exports, module) {
 "use strict";
 
 var EditSession = require("./edit_session").EditSession;
+var MockRenderer = require("./test/mockrenderer").MockRenderer;
+var Editor = require("./editor").Editor;
 var Search = require("./search").Search;
 var assert = require("./test/assertions");
 
@@ -451,6 +453,37 @@ module.exports = {
         assert.position(ranges[1].end, 0, 11);
         assert.position(ranges[0].start, 0, 0);
         assert.position(ranges[0].end, 0, 3);
+    },
+
+    "test: find next empty range" : function() {
+        var session = new EditSession("foo foobar foo");
+        var editor = new Editor(new MockRenderer(), session);
+        
+        var options = {
+            needle: "o*",
+            wrap: true,
+            regExp: true,
+            backwards: false
+        };
+        var positions = [4, 5.2, 7, 8, 9, 10, 11, 12.2, 14, 0, 1.2, 3];
+        
+        session.selection.moveCursorTo(0, 3);
+        for (var i = 0; i < 12; i++) {
+            editor.find(options)
+            var range = editor.selection.getRange();
+            var start = range.start.column;
+            var len = range.end.column - start;
+            assert.equal(start + 0.1 * len, positions[i])
+        }
+        options.backwards = true;
+        positions = [1.2, 1, 0, 14, 12.2, 12, 11, 10, 9, 8, 7, 5.2, 5, 4, 3];
+        for (var i = 0; i < 16; i++) {
+            editor.find(options);
+            var range = editor.selection.getRange();
+            var start = range.start.column;
+            var len = range.end.column - start;
+            console.log(start + 0.1 * len)
+        }
     }
 };
 
diff --git a/lib/ace/selection.js b/lib/ace/selection.js
index b712fc6b..ed57682f 100644
--- a/lib/ace/selection.js
+++ b/lib/ace/selection.js
@@ -923,7 +923,7 @@ var Selection = function(session) {
                 this.toSingleRange(data[0]);
                 for (var i = data.length; i--; ) {
                     var r = Range.fromPoints(data[i].start, data[i].end);
-                    if (data.isBackwards)
+                    if (data[i].isBackwards)
                         r.cursor = r.start;
                     this.addRange(r, true);
                 }
diff --git a/lib/ace/snippets.js b/lib/ace/snippets.js
index 10c34bf0..699cd6e9 100644
--- a/lib/ace/snippets.js
+++ b/lib/ace/snippets.js
@@ -667,11 +667,11 @@ var TabstopManager = function(editor) {
         this.editor = null;
     };
 
-    this.onChange = function(e) {
-        var changeRange = e.data.range;
-        var isRemove = e.data.action[0] == "r";
-        var start = changeRange.start;
-        var end = changeRange.end;
+    this.onChange = function(delta) {
+        var changeRange = delta;
+        var isRemove = delta.action[0] == "r";
+        var start = delta.start;
+        var end = delta.end;
         var startRow = start.row;
         var endRow = end.row;
         var lineDif = endRow - startRow;
diff --git a/lib/ace/snippets/abc.js b/lib/ace/snippets/abc.js
new file mode 100644
index 00000000..da0448ef
--- /dev/null
+++ b/lib/ace/snippets/abc.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./abc.snippets");
+exports.scope = "abc";
+
+});
diff --git a/lib/ace/snippets/abc.snippets b/lib/ace/snippets/abc.snippets
new file mode 100644
index 00000000..5c3cd677
--- /dev/null
+++ b/lib/ace/snippets/abc.snippets
@@ -0,0 +1,31 @@
+
+snippet zupfnoter.print
+	%%%%hn.print {"startpos": ${1:pos_y}, "t":"${2:title}", "v":[${3:voices}], "s":[[${4:syncvoices}1,2]], "f":[${5:flowlines}],  "sf":[${6:subflowlines}], "j":[${7:jumplines}]}
+
+snippet zupfnoter.note
+	%%%%hn.note {"pos": [${1:pos_x},${2:pos_y}], "text": "${3:text}", "style": "${4:style}"}
+
+snippet zupfnoter.annotation
+	%%%%hn.annotation {"id": "${1:id}", "pos": [${2:pos}], "text": "${3:text}"}
+
+snippet zupfnoter.lyrics
+	%%%%hn.lyrics {"pos": [${1:x_pos},${2:y_pos}]}
+
+snippet zupfnoter.legend
+	%%%%hn.legend {"pos": [${1:x_pos},${2:y_pos}]}
+
+
+
+snippet zupfnoter.target
+	"^:${1:target}"
+
+snippet zupfnoter.goto
+	"^@${1:target}@${2:distance}"
+
+snippet zupfnoter.annotationref
+	"^#${1:target}"
+
+snippet zupfnoter.annotation
+	"^!${1:text}@${2:x_offset},${3:y_offset}"
+
+
diff --git a/lib/ace/snippets/dockerfile.js b/lib/ace/snippets/dockerfile.js
new file mode 100644
index 00000000..057347fb
--- /dev/null
+++ b/lib/ace/snippets/dockerfile.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./dockerfile.snippets");
+exports.scope = "dockerfile";
+
+});
diff --git a/lib/ace/snippets/dockerfile.snippets b/lib/ace/snippets/dockerfile.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/dummy.js b/lib/ace/snippets/dummy.js
new file mode 100644
index 00000000..359d9103
--- /dev/null
+++ b/lib/ace/snippets/dummy.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./.snippets");
+exports.scope = "";
+
+});
diff --git a/lib/ace/snippets/dummy_syntax.js b/lib/ace/snippets/dummy_syntax.js
new file mode 100644
index 00000000..359d9103
--- /dev/null
+++ b/lib/ace/snippets/dummy_syntax.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./.snippets");
+exports.scope = "";
+
+});
diff --git a/lib/ace/snippets/eiffel.js b/lib/ace/snippets/eiffel.js
new file mode 100644
index 00000000..04f4c5a9
--- /dev/null
+++ b/lib/ace/snippets/eiffel.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./eiffel.snippets");
+exports.scope = "eiffel";
+
+});
diff --git a/lib/ace/snippets/eiffel.snippets b/lib/ace/snippets/eiffel.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/elixir.js b/lib/ace/snippets/elixir.js
new file mode 100644
index 00000000..359d9103
--- /dev/null
+++ b/lib/ace/snippets/elixir.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./.snippets");
+exports.scope = "";
+
+});
diff --git a/lib/ace/snippets/elixir.snippets b/lib/ace/snippets/elixir.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/elm.js b/lib/ace/snippets/elm.js
new file mode 100644
index 00000000..44f18c11
--- /dev/null
+++ b/lib/ace/snippets/elm.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./elm.snippets");
+exports.scope = "elm";
+
+});
diff --git a/lib/ace/snippets/elm.snippets b/lib/ace/snippets/elm.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/io.snippets b/lib/ace/snippets/io.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/lean.js b/lib/ace/snippets/lean.js
new file mode 100644
index 00000000..a3c01639
--- /dev/null
+++ b/lib/ace/snippets/lean.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./lean.snippets");
+exports.scope = "lean";
+
+});
diff --git a/lib/ace/snippets/lean.snippets b/lib/ace/snippets/lean.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/mask.js b/lib/ace/snippets/mask.js
new file mode 100644
index 00000000..7fbca678
--- /dev/null
+++ b/lib/ace/snippets/mask.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./mask.snippets");
+exports.scope = "mask";
+
+});
diff --git a/lib/ace/snippets/mask.snippets b/lib/ace/snippets/mask.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/snippets/nim.js b/lib/ace/snippets/nim.js
new file mode 100644
index 00000000..6e6d02bb
--- /dev/null
+++ b/lib/ace/snippets/nim.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./nim.snippets");
+exports.scope = "nim";
+
+});
diff --git a/lib/ace/snippets/nim.snippets b/lib/ace/snippets/nim.snippets
new file mode 100644
index 00000000..a8a20a00
--- /dev/null
+++ b/lib/ace/snippets/nim.snippets
@@ -0,0 +1,130 @@
+snippet #!
+	#!/usr/bin/env nim
+snippet imp
+	import ${1:module}
+snippet from
+	from ${1:package} import ${2:module}
+# Module Docstring
+snippet docs
+	## File: ${1:FILENAME:file_name}
+	## Author: ${2:author}
+	## Description: ${3}
+snippet wh
+	while ${1:condition}:
+		${2:# TODO: write code...}
+# dowh - does the same as do...while in other languages
+snippet dowh
+	while true:
+		${1:# TODO: write code...}
+		if ${2:condition}:
+			break
+snippet with
+	with ${1:expr} as ${2:var}:
+		${3:# TODO: write code...}
+# New Function
+snippet proc
+	proc ${1:fname}(${2:`indent('.') ? 'self' : ''`}): ${3: return type} =
+		##${4:docstring for $1}
+		${5:# TODO: write code...}
+snippet deff
+	def ${1:fname}(${2:`indent('.') ? 'self' : ''`}):
+		${3:# TODO: write code...}
+# New Method
+snippet defs
+	def ${1:mname}(self, ${2:arg}):
+		${3:# TODO: write code...}
+# New Property
+snippet property
+	def ${1:foo}():
+		doc = "${2:The $1 property.}"
+		def fget(self):
+			${3:return self._$1}
+		def fset(self, value):
+			${4:self._$1 = value}
+# Ifs
+snippet if
+	if ${1:condition}:
+		${2:# TODO: write code...}
+snippet el
+	else:
+		${1:# TODO: write code...}
+snippet ei
+	elif ${1:condition}:
+		${2:# TODO: write code...}
+# For
+snippet for
+	for ${1:item} in ${2:items}:
+		${3:# TODO: write code...}
+# Encodes
+snippet cutf8
+	# -*- coding: utf-8 -*-
+snippet clatin1
+	# -*- coding: latin-1 -*-
+snippet cascii
+	# -*- coding: ascii -*-
+# Lambda
+snippet ld
+	${1:var} = lambda ${2:vars} : ${3:action}
+snippet .
+	self.
+snippet try Try/Except
+	try:
+		${1:# TODO: write code...}
+	except ${2:Exception}, ${3:e}:
+		${4:raise $3}
+snippet try Try/Except/Else
+	try:
+		${1:# TODO: write code...}
+	except ${2:Exception}, ${3:e}:
+		${4:raise $3}
+	else:
+		${5:# TODO: write code...}
+snippet try Try/Except/Finally
+	try:
+		${1:# TODO: write code...}
+	except ${2:Exception}, ${3:e}:
+		${4:raise $3}
+	finally:
+		${5:# TODO: write code...}
+snippet try Try/Except/Else/Finally
+	try:
+		${1:# TODO: write code...}
+	except ${2:Exception}, ${3:e}:
+		${4:raise $3}
+	else:
+		${5:# TODO: write code...}
+	finally:
+		${6:# TODO: write code...}
+# if __name__ == '__main__':
+snippet ifmain
+	if isMainModule:
+		${1:main()}
+snippet "
+	## ${1:doc}
+# test function/method
+snippet test
+	def test_${1:description}(${2:self}):
+		${3:# TODO: write code...}
+# test case
+snippet testcase
+	class ${1:ExampleCase}(unittest.TestCase):
+		
+		def test_${2:description}(self):
+			${3:# TODO: write code...}
+#getopt
+snippet getopt
+	try:
+		# Short option syntax: "hv:"
+		# Long option syntax: "help" or "verbose="
+		opts, args = getopt.getopt(sys.argv[1:], "${1:short_options}", [${2:long_options}])
+	
+	except getopt.GetoptError, err:
+		# Print debug info
+		print str(err)
+		${3:error_action}
+
+	for option, argument in opts:
+		if option in ("-h", "--help"):
+			${4}
+		elif option in ("-v", "--verbose"):
+			verbose = argument
diff --git a/lib/ace/snippets/r.snippets b/lib/ace/snippets/r.snippets
index cfe482bc..948542f5 100644
--- a/lib/ace/snippets/r.snippets
+++ b/lib/ace/snippets/r.snippets
@@ -47,7 +47,7 @@ snippet apply
 snippet lapply
 	lapply(${1:list}, ${2:function})
 snippet sapply
-	lapply(${1:list}, ${2:function})
+	sapply(${1:list}, ${2:function})
 snippet vapply
 	vapply(${1:list}, ${2:function}, ${3:type})
 snippet mapply
diff --git a/lib/ace/snippets/sqlserver.js b/lib/ace/snippets/sqlserver.js
new file mode 100644
index 00000000..f84694dc
--- /dev/null
+++ b/lib/ace/snippets/sqlserver.js
@@ -0,0 +1,7 @@
+define(function(require, exports, module) {
+"use strict";
+
+exports.snippetText = require("../requirejs/text!./sqlserver.snippets");
+exports.scope = "sqlserver";
+
+});
diff --git a/lib/ace/snippets/sqlserver.snippets b/lib/ace/snippets/sqlserver.snippets
new file mode 100644
index 00000000..403bd6bc
--- /dev/null
+++ b/lib/ace/snippets/sqlserver.snippets
@@ -0,0 +1,70 @@
+# ISNULL
+snippet isnull
+	ISNULL(${1:check_expression}, ${2:replacement_value})
+# FORMAT
+snippet format
+	FORMAT(${1:value}, ${2:format})
+# CAST
+snippet cast
+	CAST(${1:expression} AS ${2:data_type})
+# CONVERT
+snippet convert
+	CONVERT(${1:data_type}, ${2:expression})
+# DATEPART
+snippet datepart
+	DATEPART(${1:datepart}, ${2:date})
+# DATEDIFF
+snippet datediff
+	DATEDIFF(${1:datepart}, ${2:startdate}, ${3:enddate})
+# DATEADD
+snippet dateadd
+	DATEADD(${1:datepart}, ${2:number}, ${3:date})
+# DATEFROMPARTS 
+snippet datefromparts
+	DATEFROMPARTS(${1:year}, ${2:month}, ${3:day})
+# OBJECT_DEFINITION
+snippet objectdef
+	SELECT OBJECT_DEFINITION(OBJECT_ID('${1:sys.server_permissions /*object name*/}'))
+# STUFF XML
+snippet stuffxml
+	STUFF((SELECT ', ' + ${1:ColumnName}
+		FROM ${2:TableName}
+		WHERE ${3:WhereClause}
+		FOR XML PATH('')), 1, 1, '') AS ${4:Alias}
+	${5:/*https://msdn.microsoft.com/en-us/library/ms188043.aspx*/}
+# Create Procedure
+snippet createproc
+	-- =============================================
+	-- Author:		${1:Author}
+	-- Create date: ${2:Date}
+	-- Description:	${3:Description}
+	-- =============================================
+	CREATE PROCEDURE ${4:Procedure_Name}
+		${5:/*Add the parameters for the stored procedure here*/}
+	AS
+	BEGIN
+		-- SET NOCOUNT ON added to prevent extra result sets from interfering with SELECT statements.
+		SET NOCOUNT ON;
+		
+		${6:/*Add the T-SQL statements to compute the return value here*/}
+		
+	END
+	GO
+# Create Scalar Function
+snippet createfn
+	-- =============================================
+	-- Author:		${1:Author}
+	-- Create date: ${2:Date}
+	-- Description:	${3:Description}
+	-- =============================================
+	CREATE FUNCTION ${4:Scalar_Function_Name}
+		-- Add the parameters for the function here
+	RETURNS ${5:Function_Data_Type}
+	AS
+	BEGIN
+		DECLARE @Result ${5:Function_Data_Type}
+		
+		${6:/*Add the T-SQL statements to compute the return value here*/}
+		
+	END
+	GO
\ No newline at end of file
diff --git a/lib/ace/snippets/vala.snippets b/lib/ace/snippets/vala.snippets
new file mode 100644
index 00000000..e69de29b
diff --git a/lib/ace/test/all_browser.js b/lib/ace/test/all_browser.js
index 3b7bf5d9..7ac5092e 100644
--- a/lib/ace/test/all_browser.js
+++ b/lib/ace/test/all_browser.js
@@ -43,9 +43,11 @@ var testNames = [
     "ace/mode/folding/pythonic_test",
     "ace/mode/folding/xml_test",
     "ace/mode/folding/coffee_test",
+    "ace/mode/behaviour/behaviour_test",
     "ace/multi_select_test",
     "ace/mouse/mouse_handler_test",
     "ace/occur_test",
+    "ace/placeholder_test",
     "ace/range_test",
     "ace/range_list_test",
     "ace/search_test",
@@ -70,6 +72,8 @@ document.body.appendChild(nav);
 if (location.search)
     testNames = location.search.substr(1).split(",")
 
+var filter = location.hash.substr(1);
+
 require(testNames, function() {
     var tests = testNames.map(function(x) {
         var module = require(x);
@@ -79,6 +83,12 @@ require(testNames, function() {
 
     async.list(tests)
         .expand(function(test) {
+            if (filter) {
+                Object.keys(test).forEach(function(method) {
+                    if (method.match(/^>?test/) && !method.match(filter))
+                        test[method] = undefined;
+                });
+            }
             return AsyncTest.testcase(test)
         }, AsyncTest.TestGenerator)
         .run()
diff --git a/lib/ace/theme/clouds.css b/lib/ace/theme/clouds.css
index e3884e02..c11308d4 100644
--- a/lib/ace/theme/clouds.css
+++ b/lib/ace/theme/clouds.css
@@ -23,7 +23,6 @@
 
 .ace-clouds.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #FFFFFF;
-  border-radius: 2px
 }
 
 .ace-clouds .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/clouds_midnight.css b/lib/ace/theme/clouds_midnight.css
index 8d23bcbe..08ee089d 100644
--- a/lib/ace/theme/clouds_midnight.css
+++ b/lib/ace/theme/clouds_midnight.css
@@ -23,7 +23,6 @@
 
 .ace-clouds-midnight.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #191919;
-  border-radius: 2px
 }
 
 .ace-clouds-midnight .ace_marker-layer .ace_step {
@@ -48,7 +47,7 @@
 }
 
 .ace-clouds-midnight .ace_invisible {
-  color: #BFBFBF
+  color: #666
 }
 
 .ace-clouds-midnight .ace_keyword,
diff --git a/lib/ace/theme/cobalt.css b/lib/ace/theme/cobalt.css
index 16568fc3..b883ba97 100644
--- a/lib/ace/theme/cobalt.css
+++ b/lib/ace/theme/cobalt.css
@@ -5,7 +5,7 @@
 
 .ace-cobalt .ace_print-margin {
   width: 1px;
-  background: #011e3a
+  background: #555555
 }
 
 .ace-cobalt {
@@ -23,7 +23,6 @@
 
 .ace-cobalt.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #002240;
-  border-radius: 2px
 }
 
 .ace-cobalt .ace_marker-layer .ace_step {
@@ -131,4 +130,4 @@
 
 .ace-cobalt .ace_indent-guide {
   background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAAEklEQVQImWNgYGBgYHCLSvkPAAP3AgSDTRd4AAAAAElFTkSuQmCC) right repeat-y
-}
\ No newline at end of file
+}
diff --git a/lib/ace/theme/dawn.css b/lib/ace/theme/dawn.css
index 719f4877..3c2884e1 100644
--- a/lib/ace/theme/dawn.css
+++ b/lib/ace/theme/dawn.css
@@ -23,7 +23,6 @@
 
 .ace-dawn.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #F9F9F9;
-  border-radius: 2px
 }
 
 .ace-dawn .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/github.css b/lib/ace/theme/github.css
index f496f6ee..213d3fd3 100644
--- a/lib/ace/theme/github.css
+++ b/lib/ace/theme/github.css
@@ -68,9 +68,12 @@
   color: black;
 }
 
-.ace-github .ace_marker-layer .ace_active-line {
+.ace-github.ace_focus .ace_marker-layer .ace_active-line {
   background: rgb(255, 255, 204);
 }
+.ace-github .ace_marker-layer .ace_active-line {
+  background: rgb(245, 245, 245);
+}
 
 .ace-github .ace_marker-layer .ace_selection {
   background: rgb(181, 213, 255);
@@ -106,7 +109,10 @@
 .ace-github .ace_marker-layer .ace_selected-word {
   background: rgb(250, 250, 255);
   border: 1px solid rgb(200, 200, 250);
+}
 
+.ace-github .ace_invisible {
+  color: #BFBFBF
 }
 
 .ace-github .ace_print-margin {
diff --git a/lib/ace/theme/idle_fingers.css b/lib/ace/theme/idle_fingers.css
index f507ec10..b5e1bff2 100644
--- a/lib/ace/theme/idle_fingers.css
+++ b/lib/ace/theme/idle_fingers.css
@@ -23,7 +23,6 @@
 
 .ace-idle-fingers.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #323232;
-  border-radius: 2px
 }
 
 .ace-idle-fingers .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/iplastic.css b/lib/ace/theme/iplastic.css
new file mode 100644
index 00000000..b07dc8f9
--- /dev/null
+++ b/lib/ace/theme/iplastic.css
@@ -0,0 +1,140 @@
+.ace-iplastic .ace_gutter {
+  background: #dddddd;
+  color: #666666
+}
+
+.ace-iplastic .ace_print-margin {
+  width: 1px;
+  background: #bbbbbb
+}
+
+.ace-iplastic {
+  background-color: #eeeeee;
+  color: #333333
+}
+
+.ace-iplastic .ace_cursor {
+  color: #333
+}
+
+.ace-iplastic .ace_marker-layer .ace_selection {
+  background: #BAD6FD;
+}
+
+.ace-iplastic.ace_multiselect .ace_selection.ace_start {
+  border-radius: 4px
+}
+
+.ace-iplastic .ace_marker-layer .ace_step {
+  background: #444444
+}
+
+.ace-iplastic .ace_marker-layer .ace_bracket {
+  margin: -1px 0 0 -1px;
+  border: 1px solid #49483E;
+  background: #FFF799
+}
+
+.ace-iplastic .ace_marker-layer .ace_active-line {
+  background: #e5e5e5
+}
+
+.ace-iplastic .ace_gutter-active-line {
+  background-color: #eeeeee
+}
+
+.ace-iplastic .ace_marker-layer .ace_selected-word {
+  border: 1px solid #555555;
+  border-radius:4px
+}
+
+.ace-iplastic .ace_invisible {
+  color: #999999
+}
+
+.ace-iplastic .ace_entity.ace_name.ace_tag,
+.ace-iplastic .ace_keyword,
+.ace-iplastic .ace_meta.ace_tag,
+.ace-iplastic .ace_storage {
+  color: #0000FF
+}
+
+.ace-iplastic .ace_punctuation,
+.ace-iplastic .ace_punctuation.ace_tag {
+  color: #000
+}
+
+.ace-iplastic .ace_constant {
+  color: #333333;
+  font-weight: 700
+}
+
+.ace-iplastic .ace_constant.ace_character,
+.ace-iplastic .ace_constant.ace_language,
+.ace-iplastic .ace_constant.ace_numeric,
+.ace-iplastic .ace_constant.ace_other {
+  color: #0066FF;
+  font-weight: 700
+}
+
+.ace-iplastic .ace_constant.ace_numeric{
+  font-weight: 100
+}
+
+.ace-iplastic .ace_invalid {
+  color: #F8F8F0;
+  background-color: #F92672
+}
+
+.ace-iplastic .ace_invalid.ace_deprecated {
+  color: #F8F8F0;
+  background-color: #AE81FF
+}
+
+.ace-iplastic .ace_support.ace_constant,
+.ace-iplastic .ace_support.ace_function {
+  color: #333333;
+  font-weight: 700
+}
+
+.ace-iplastic .ace_fold {
+  background-color: #464646;
+  border-color: #F8F8F2
+}
+
+.ace-iplastic .ace_storage.ace_type,
+.ace-iplastic .ace_support.ace_class,
+.ace-iplastic .ace_support.ace_type {
+  color: #3333fc;
+  font-weight: 700
+}
+
+.ace-iplastic .ace_entity.ace_name.ace_function,
+.ace-iplastic .ace_entity.ace_other,
+.ace-iplastic .ace_entity.ace_other.ace_attribute-name,
+.ace-iplastic .ace_variable {
+  color: #3366cc;
+  font-style: italic
+}
+
+.ace-iplastic .ace_variable.ace_parameter {
+  font-style: italic;
+  color: #2469E0
+}
+
+.ace-iplastic .ace_string {
+  color: #a55f03
+}
+
+.ace-iplastic .ace_comment {
+  color: #777777;
+  font-style: italic
+}
+
+.ace-iplastic .ace_fold-widget {
+  background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAANElEQVR42mWKsQ0AMAzC8ixLlrzQjzmBiEjp0A6WwBCSPgKAXoLkqSot7nN3yMwR7pZ32NzpKkVoDBUxKAAAAABJRU5ErkJggg==);
+}
+
+.ace-iplastic .ace_indent-guide {
+  background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAABlJREFUeNpi+P//PwMzMzPzfwAAAAD//wMAGRsECSML/RIAAAAASUVORK5CYII=) right repeat-y
+}
\ No newline at end of file
diff --git a/lib/ace/theme/iplastic.js b/lib/ace/theme/iplastic.js
new file mode 100644
index 00000000..ff784196
--- /dev/null
+++ b/lib/ace/theme/iplastic.js
@@ -0,0 +1,40 @@
+
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+
+exports.isDark = false;
+exports.cssClass = "ace-iplastic";
+exports.cssText = require("../requirejs/text!./iplastic.css");
+
+var dom = require("../lib/dom");
+dom.importCssString(exports.cssText, exports.cssClass);
+});
diff --git a/lib/ace/theme/katzenmilch.css b/lib/ace/theme/katzenmilch.css
index e2526b93..bf1569fb 100644
--- a/lib/ace/theme/katzenmilch.css
+++ b/lib/ace/theme/katzenmilch.css
@@ -31,7 +31,6 @@
 
 .ace-katzenmilch.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #f3f2f3;
-  border-radius: 2px
 }
 
 .ace-katzenmilch .ace_marker-layer .ace_step {
@@ -55,6 +54,10 @@
   border: 1px solid rgba(100, 5, 208, 0.27)
 }
 
+.ace-katzenmilch .ace_invisible {
+  color: #BFBFBF
+}
+
 .ace-katzenmilch .ace_fold {
   background-color: rgba(2, 95, 73, 0.97);
   border-color: rgba(15, 0, 9, 1.0)
diff --git a/lib/ace/theme/kr_theme.css b/lib/ace/theme/kr_theme.css
index 339786ad..e232de47 100644
--- a/lib/ace/theme/kr_theme.css
+++ b/lib/ace/theme/kr_theme.css
@@ -23,7 +23,6 @@
 
 .ace-kr-theme.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #0B0A09;
-  border-radius: 2px
 }
 
 .ace-kr-theme .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/kuroir.css b/lib/ace/theme/kuroir.css
index 9c0ba6a8..5e987abc 100644
--- a/lib/ace/theme/kuroir.css
+++ b/lib/ace/theme/kuroir.css
@@ -49,6 +49,10 @@
   border: 1px solid rgba(245, 170, 0, 0.57);
 }
 
+.ace-kuroir .ace_invisible {
+  color: #BFBFBF
+}
+
 .ace-kuroir .ace_fold {
   border-color: #363636;
 }
diff --git a/lib/ace/theme/merbivore.css b/lib/ace/theme/merbivore.css
index a84ec3a6..9be25c66 100644
--- a/lib/ace/theme/merbivore.css
+++ b/lib/ace/theme/merbivore.css
@@ -23,7 +23,6 @@
 
 .ace-merbivore.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #161616;
-  border-radius: 2px
 }
 
 .ace-merbivore .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/merbivore_soft.css b/lib/ace/theme/merbivore_soft.css
index f0ad0bac..0d615376 100644
--- a/lib/ace/theme/merbivore_soft.css
+++ b/lib/ace/theme/merbivore_soft.css
@@ -23,7 +23,6 @@
 
 .ace-merbivore-soft.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #1C1C1C;
-  border-radius: 2px
 }
 
 .ace-merbivore-soft .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/mono_industrial.css b/lib/ace/theme/mono_industrial.css
index 7e40a3b9..6630e4a2 100644
--- a/lib/ace/theme/mono_industrial.css
+++ b/lib/ace/theme/mono_industrial.css
@@ -23,7 +23,6 @@
 
 .ace-mono-industrial.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #222C28;
-  border-radius: 2px
 }
 
 .ace-mono-industrial .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/monokai.css b/lib/ace/theme/monokai.css
index a3a063df..bcc26ef4 100644
--- a/lib/ace/theme/monokai.css
+++ b/lib/ace/theme/monokai.css
@@ -23,7 +23,6 @@
 
 .ace-monokai.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #272822;
-  border-radius: 2px
 }
 
 .ace-monokai .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/pastel_on_dark.css b/lib/ace/theme/pastel_on_dark.css
index 8cab16a1..0b637174 100644
--- a/lib/ace/theme/pastel_on_dark.css
+++ b/lib/ace/theme/pastel_on_dark.css
@@ -23,7 +23,6 @@
 
 .ace-pastel-on-dark.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #2C2828;
-  border-radius: 2px
 }
 
 .ace-pastel-on-dark .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/solarized_dark.css b/lib/ace/theme/solarized_dark.css
index ea8ec8aa..09740e69 100644
--- a/lib/ace/theme/solarized_dark.css
+++ b/lib/ace/theme/solarized_dark.css
@@ -30,7 +30,6 @@
 
 .ace-solarized-dark.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #002B36;
-  border-radius: 2px
 }
 
 .ace-solarized-dark .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/solarized_light.css b/lib/ace/theme/solarized_light.css
index 64c4bac9..65399fda 100644
--- a/lib/ace/theme/solarized_light.css
+++ b/lib/ace/theme/solarized_light.css
@@ -23,7 +23,6 @@
 
 .ace-solarized-light.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #FDF6E3;
-  border-radius: 2px
 }
 
 .ace-solarized-light .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/sqlserver.css b/lib/ace/theme/sqlserver.css
new file mode 100644
index 00000000..ff6d1e1c
--- /dev/null
+++ b/lib/ace/theme/sqlserver.css
@@ -0,0 +1,171 @@
+.ace_line {
+    font-family: Consolas;
+}
+
+.ace-sqlserver .ace_gutter {
+    background: #ebebeb;
+    color: #333;
+    overflow: hidden;
+}
+
+.ace-sqlserver .ace_print-margin {
+    width: 1px;
+    background: #e8e8e8;
+}
+
+.ace-sqlserver {
+    background-color: #FFFFFF;
+    color: black;
+}
+
+.ace-sqlserver .ace_identifier {
+    color: black;
+}
+
+.ace-sqlserver .ace_keyword {
+    color: #0000FF;
+}
+
+.ace-sqlserver .ace_numeric {
+    color: black;
+}
+
+.ace-sqlserver .ace_storage {
+    color: #11B7BE;
+}
+
+.ace-sqlserver .ace_keyword.ace_operator,
+.ace-sqlserver .ace_lparen,
+.ace-sqlserver .ace_rparen,
+.ace-sqlserver .ace_punctuation {
+    color: #808080;
+}
+
+.ace-sqlserver .ace_set.ace_statement {
+    color: #0000FF;
+    text-decoration: underline;
+}
+
+.ace-sqlserver .ace_cursor {
+    color: black;
+}
+
+.ace-sqlserver .ace_invisible {
+    color: rgb(191, 191, 191);
+}
+
+.ace-sqlserver .ace_constant.ace_buildin {
+    color: rgb(88, 72, 246);
+}
+
+.ace-sqlserver .ace_constant.ace_language {
+    color: #979797;
+}
+
+.ace-sqlserver .ace_constant.ace_library {
+    color: rgb(6, 150, 14);
+}
+
+.ace-sqlserver .ace_invalid {
+    background-color: rgb(153, 0, 0);
+    color: white;
+}
+
+.ace-sqlserver .ace_support.ace_function {
+    color: #FF00FF;
+}
+
+.ace-sqlserver .ace_support.ace_constant {
+    color: rgb(6, 150, 14);
+}
+
+.ace-sqlserver .ace_class {
+    color: #008080;
+}
+
+.ace-sqlserver .ace_support.ace_other {
+    color: #6D79DE;
+}
+
+.ace-sqlserver .ace_variable.ace_parameter {
+    font-style: italic;
+    color: #FD971F;
+}
+
+.ace-sqlserver .ace_comment {
+    color: #008000;
+}
+
+.ace-sqlserver .ace_constant.ace_numeric {
+    color: black;
+}
+
+.ace-sqlserver .ace_variable {
+    color: rgb(49, 132, 149);
+}
+
+.ace-sqlserver .ace_xml-pe {
+    color: rgb(104, 104, 91);
+}
+
+.ace-sqlserver .ace_support.ace_storedprocedure {
+    color: #800000;
+}
+
+.ace-sqlserver .ace_heading {
+    color: rgb(12, 7, 255);
+}
+
+.ace-sqlserver .ace_list {
+    color: rgb(185, 6, 144);
+}
+
+.ace-sqlserver .ace_marker-layer .ace_selection {
+    background: rgb(181, 213, 255);
+}
+
+.ace-sqlserver .ace_marker-layer .ace_step {
+    background: rgb(252, 255, 0);
+}
+
+.ace-sqlserver .ace_marker-layer .ace_stack {
+    background: rgb(164, 229, 101);
+}
+
+.ace-sqlserver .ace_marker-layer .ace_bracket {
+    margin: -1px 0 0 -1px;
+    border: 1px solid rgb(192, 192, 192);
+}
+
+.ace-sqlserver .ace_marker-layer .ace_active-line {
+    background: rgba(0, 0, 0, 0.07);
+}
+
+.ace-sqlserver .ace_gutter-active-line {
+    background-color: #dcdcdc;
+}
+
+.ace-sqlserver .ace_marker-layer .ace_selected-word {
+    background: rgb(250, 250, 255);
+    border: 1px solid rgb(200, 200, 250);
+}
+
+.ace-sqlserver .ace_meta.ace_tag {
+    color: #0000FF;
+}
+
+.ace-sqlserver .ace_string.ace_regex {
+    color: #FF0000;
+}
+
+.ace-sqlserver .ace_string {
+    color: #FF0000;
+}
+
+.ace-sqlserver .ace_entity.ace_other.ace_attribute-name {
+    color: #994409;
+}
+
+.ace-sqlserver .ace_indent-guide {
+    background: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAAE0lEQVQImWP4////f4bLly//BwAmVgd1/w11/gAAAABJRU5ErkJggg==") right repeat-y;
+}
diff --git a/lib/ace/keyboard/vim/registers.js b/lib/ace/theme/sqlserver.js
similarity index 89%
rename from lib/ace/keyboard/vim/registers.js
rename to lib/ace/theme/sqlserver.js
index ef929a35..ab657483 100644
--- a/lib/ace/keyboard/vim/registers.js
+++ b/lib/ace/theme/sqlserver.js
@@ -30,13 +30,10 @@
 
 define(function(require, exports, module) {
 
-"never use strict";
-
-module.exports = {
-    _default: {
-        text: "",
-        isLine: false
-    }
-};
+exports.isDark = false;
+exports.cssClass = "ace-sqlserver";
+exports.cssText = require("../requirejs/text!./sqlserver.css");
 
+var dom = require("../lib/dom");
+dom.importCssString(exports.cssText, exports.cssClass);
 });
diff --git a/lib/ace/theme/terminal.css b/lib/ace/theme/terminal.css
index 3636a03d..f23a9ad6 100644
--- a/lib/ace/theme/terminal.css
+++ b/lib/ace/theme/terminal.css
@@ -23,7 +23,6 @@
 
 .ace-terminal-theme.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px black;
-  border-radius: 2px
 }
 
 .ace-terminal-theme .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/textmate.css b/lib/ace/theme/textmate.css
index 6cb159ba..18e2b4ee 100644
--- a/lib/ace/theme/textmate.css
+++ b/lib/ace/theme/textmate.css
@@ -122,7 +122,6 @@
 }
 .ace-tm.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px white;
-  border-radius: 2px;
 }
 .ace-tm .ace_marker-layer .ace_step {
   background: rgb(252, 255, 0);
diff --git a/lib/ace/theme/the_night_after_tomorrow.css b/lib/ace/theme/the_night_after_tomorrow.css
new file mode 100644
index 00000000..48d2602c
--- /dev/null
+++ b/lib/ace/theme/the_night_after_tomorrow.css
@@ -0,0 +1,139 @@
+.ace-tomorrow-night .ace_gutter {
+  background: #25282c;
+  color: #C5C8C6
+}
+
+.ace-tomorrow-night .ace_print-margin {
+  width: 1px;
+  background: #25282c
+}
+
+.ace-tomorrow-night {
+  background-color: #1D1F21;
+  color: #C5C8C6
+}
+
+.ace-tomorrow-night .ace_cursor {
+  color: #FFFFFF
+}
+
+.ace-tomorrow-night .ace_marker-layer .ace_selection {
+  background: #373B41
+}
+
+.ace-tomorrow-night.ace_multiselect .ace_selection.ace_start {
+  box-shadow: 0 0 3px 0px #1D1F21;
+  border-radius: 2px
+}
+
+.ace-tomorrow-night .ace_marker-layer .ace_step {
+  background: rgb(102, 82, 0)
+}
+
+.ace-tomorrow-night .ace_marker-layer .ace_bracket {
+  margin: -1px 0 0 -1px;
+  border: 1px solid #4B4E55
+}
+
+.ace-tomorrow-night .ace_marker-layer .ace_active-line {
+  background: #282A2E
+}
+
+.ace-tomorrow-night .ace_gutter-active-line {
+  background-color: #282A2E
+}
+
+.ace-tomorrow-night .ace_marker-layer .ace_selected-word {
+  border: 1px solid #373B41
+}
+
+.ace-tomorrow-night .ace_invisible {
+  color: #4B4E55
+}
+
+.ace-tomorrow-night .ace_keyword,
+.ace-tomorrow-night .ace_meta,
+.ace-tomorrow-night .ace_support.ace_type {
+  color: #C4A400
+}
+
+.ace-tomorrow-night .ace_storage,
+.ace-tomorrow-night .ace_storage.ace_type {
+    color: #327FD7
+}
+
+.ace-tomorrow-night .ace_keyword.ace_operator {
+  color: #8ABEB7
+}
+
+.ace-tomorrow-night .ace_constant.ace_language{
+    color: #934B9F
+}
+
+.ace-tomorrow-night .ace_constant.ace_character,
+.ace-tomorrow-night .ace_constant.ace_numeric,
+.ace-tomorrow-night .ace_keyword.ace_other.ace_unit,
+.ace-tomorrow-night .ace_support.ace_constant,
+.ace-tomorrow-night .ace_variable.ace_parameter {
+  color: #37BC9B
+}
+
+.ace-tomorrow-night .ace_constant.ace_other {
+  color: #CED1CF
+}
+
+.ace-tomorrow-night .ace_invalid {
+  color: #CED2CF;
+  background-color: #DF5F5F
+}
+
+.ace-tomorrow-night .ace_invalid.ace_deprecated {
+  color: #CED2CF;
+  background-color: #B798BF
+}
+
+.ace-tomorrow-night .ace_fold {
+  background-color: #62A5D6;
+  border-color: #C5C8C6
+}
+
+.ace-tomorrow-night .ace_entity.ace_name.ace_function,
+.ace-tomorrow-night .ace_support.ace_function,
+.ace-tomorrow-night .ace_variable {
+  color: #62A5D6
+}
+
+.ace-tomorrow-night .ace_support.ace_class,
+.ace-tomorrow-night .ace_support.ace_type {
+  color: #F0C674
+}
+
+.ace-tomorrow-night .ace_heading,
+.ace-tomorrow-night .ace_markup.ace_heading,
+.ace-tomorrow-night .ace_string {
+  color: #CD0000
+}
+
+.ace-tomorrow-night .ace_proc_name {
+  color: #04939A
+}
+
+.ace-tomorrow-night .ace_backtick {
+  color: #1DAA49
+}
+
+.ace-tomorrow-night .ace_entity.ace_name.ace_tag,
+.ace-tomorrow-night .ace_entity.ace_other.ace_attribute-name,
+.ace-tomorrow-night .ace_meta.ace_tag,
+.ace-tomorrow-night .ace_string.ace_regexp,
+.ace-tomorrow-night .ace_variable {
+  color: #FFFFFF
+}
+
+.ace-tomorrow-night .ace_comment {
+  color: #3465A4
+}
+
+.ace-tomorrow-night .ace_indent-guide {
+  background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAAEklEQVQImWNgYGBgYHB3d/8PAAOIAdULw8qMAAAAAElFTkSuQmCC) right repeat-y
+}
diff --git a/lib/ace/theme/the_night_after_tomorrow.js b/lib/ace/theme/the_night_after_tomorrow.js
new file mode 100644
index 00000000..3108e2a9
--- /dev/null
+++ b/lib/ace/theme/the_night_after_tomorrow.js
@@ -0,0 +1,39 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
+ *
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+define(function(require, exports, module) {
+
+exports.isDark = true;
+exports.cssClass = "ace-tomorrow-night";
+exports.cssText = require("../requirejs/text!./the_night_after_tomorrow.css");
+
+var dom = require("../lib/dom");
+dom.importCssString(exports.cssText, exports.cssClass);
+});
diff --git a/lib/ace/theme/tomorrow.css b/lib/ace/theme/tomorrow.css
index 20975004..77407e66 100644
--- a/lib/ace/theme/tomorrow.css
+++ b/lib/ace/theme/tomorrow.css
@@ -23,7 +23,6 @@
 
 .ace-tomorrow.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #FFFFFF;
-  border-radius: 2px
 }
 
 .ace-tomorrow .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/tomorrow_night.css b/lib/ace/theme/tomorrow_night.css
index aafceab6..e98a6580 100644
--- a/lib/ace/theme/tomorrow_night.css
+++ b/lib/ace/theme/tomorrow_night.css
@@ -23,7 +23,6 @@
 
 .ace-tomorrow-night.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #1D1F21;
-  border-radius: 2px
 }
 
 .ace-tomorrow-night .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/tomorrow_night_blue.css b/lib/ace/theme/tomorrow_night_blue.css
index e717be0a..907eef35 100644
--- a/lib/ace/theme/tomorrow_night_blue.css
+++ b/lib/ace/theme/tomorrow_night_blue.css
@@ -24,7 +24,6 @@
 
 .ace-tomorrow-night-blue.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #002451;
-  border-radius: 2px
 }
 
 .ace-tomorrow-night-blue .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/tomorrow_night_bright.css b/lib/ace/theme/tomorrow_night_bright.css
index 5c896fb9..c0c33739 100644
--- a/lib/ace/theme/tomorrow_night_bright.css
+++ b/lib/ace/theme/tomorrow_night_bright.css
@@ -23,7 +23,6 @@
 
 .ace-tomorrow-night-bright.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #000000;
-  border-radius: 2px
 }
 
 .ace-tomorrow-night-bright .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/tomorrow_night_eighties.css b/lib/ace/theme/tomorrow_night_eighties.css
index 85d7b089..69277fb1 100644
--- a/lib/ace/theme/tomorrow_night_eighties.css
+++ b/lib/ace/theme/tomorrow_night_eighties.css
@@ -24,7 +24,6 @@
 
 .ace-tomorrow-night-eighties.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #2D2D2D;
-  border-radius: 2px
 }
 
 .ace-tomorrow-night-eighties .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/twilight.css b/lib/ace/theme/twilight.css
index 0ca694fb..ae353dae 100644
--- a/lib/ace/theme/twilight.css
+++ b/lib/ace/theme/twilight.css
@@ -23,7 +23,6 @@
 
 .ace-twilight.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #141414;
-  border-radius: 2px
 }
 
 .ace-twilight .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/vibrant_ink.css b/lib/ace/theme/vibrant_ink.css
index e2901156..a3a89402 100644
--- a/lib/ace/theme/vibrant_ink.css
+++ b/lib/ace/theme/vibrant_ink.css
@@ -23,7 +23,6 @@
 
 .ace-vibrant-ink.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #0F0F0F;
-  border-radius: 2px
 }
 
 .ace-vibrant-ink .ace_marker-layer .ace_step {
diff --git a/lib/ace/theme/xcode.css b/lib/ace/theme/xcode.css
index 56eb9a89..a22bd169 100644
--- a/lib/ace/theme/xcode.css
+++ b/lib/ace/theme/xcode.css
@@ -25,7 +25,6 @@
 
 .ace-xcode.ace_multiselect .ace_selection.ace_start {
   box-shadow: 0 0 3px 0px #FFFFFF;
-  border-radius: 2px
 }
 
 .ace-xcode .ace_marker-layer .ace_step {
diff --git a/lib/ace/tokenizer.js b/lib/ace/tokenizer.js
index e947a130..72490fbb 100644
--- a/lib/ace/tokenizer.js
+++ b/lib/ace/tokenizer.js
@@ -31,8 +31,9 @@
 define(function(require, exports, module) {
 "use strict";
 
+var config = require("./config");
 // tokenizing lines longer than this makes editor very slow
-var MAX_TOKEN_COUNT = 1000;
+var MAX_TOKEN_COUNT = 2000;
 /**
  * This class takes a set of highlighting rules, and creates a tokenizer out of them. For more information, see [the wiki on extending highlighters](https://github.com/ajaxorg/ace/wiki/Creating-or-Extending-an-Edit-Mode#wiki-extendingTheHighlighter).
  * @class Tokenizer
@@ -77,9 +78,11 @@ var Tokenizer = function(rules) {
                 if (rule.token.length == 1 || matchcount == 1) {
                     rule.token = rule.token[0];
                 } else if (matchcount - 1 != rule.token.length) {
-                    throw new Error("number of classes and regexp groups in '" + 
-                        rule.token + "'\n'" + rule.regex +  "' doesn't match\n"
-                        + (matchcount - 1) + "!=" + rule.token.length);
+                    this.reportError("number of classes and regexp groups doesn't match", { 
+                        rule: rule,
+                        groupCount: matchcount - 1
+                    });
+                    rule.token = rule.token[0];
                 } else {
                     rule.tokenArray = rule.token;
                     rule.token = null;
@@ -240,6 +243,7 @@ var Tokenizer = function(rules) {
 
         var match, tokens = [];
         var lastIndex = 0;
+        var matchAttempts = 0;
 
         var token = {type: null, value: ""};
 
@@ -280,7 +284,7 @@ var Tokenizer = function(rules) {
                     
                     state = this.states[currentState];
                     if (!state) {
-                        window.console && console.error && console.error(currentState, "doesn't exist");
+                        this.reportError("state doesn't exist", currentState);
                         currentState = "start";
                         state = this.states[currentState];
                     }
@@ -293,7 +297,7 @@ var Tokenizer = function(rules) {
             }
 
             if (value) {
-                if (typeof type == "string") {
+                if (typeof type === "string") {
                     if ((!rule || rule.merge !== false) && token.type === type) {
                         token.value += value;
                     } else {
@@ -315,7 +319,13 @@ var Tokenizer = function(rules) {
 
             lastIndex = index;
 
-            if (tokens.length > MAX_TOKEN_COUNT) {
+            if (matchAttempts++ > MAX_TOKEN_COUNT) {
+                if (matchAttempts > 2 * line.length) {
+                    this.reportError("infinite loop with in ace tokenizer", {
+                        startState: startState,
+                        line: line
+                    });
+                }
                 // chrome doens't show contents of text nodes with very long text
                 while (lastIndex < line.length) {
                     if (token.type)
@@ -343,7 +353,9 @@ var Tokenizer = function(rules) {
             state : stack.length ? stack : currentState
         };
     };
-
+    
+    this.reportError = config.reportError;
+    
 }).call(Tokenizer.prototype);
 
 exports.Tokenizer = Tokenizer;
diff --git a/lib/ace/tokenizer_test.js b/lib/ace/tokenizer_test.js
index 281f58b3..41bf01c8 100644
--- a/lib/ace/tokenizer_test.js
+++ b/lib/ace/tokenizer_test.js
@@ -29,7 +29,7 @@
  * ***** END LICENSE BLOCK ***** */
 
  if (typeof process !== "undefined") {
-     require("amd-loader");
+    require("amd-loader");
  }
 
 define(function(require, exports, module) {
@@ -59,7 +59,35 @@ module.exports = {
         var t = new Tokenizer({});
         var re = t.removeCapturingGroups("(ax(by))[()]");
         assert.equal(re, "(?:ax(?:by))[()]");
-    }
+    },
+    
+    "test: broken highlight rules": function() {
+        var t = new Tokenizer({
+            start: [{ 
+                token: 's',
+                regex: '&&&|^^^' 
+            }, {
+                defaultToken: "def"
+            }],
+            state1: [{ 
+                token: 'x',
+                regex: /\b([\w]*)(\s*)((?::)?)/
+            }]
+        });
+        var errorReports = 0;
+        t.reportError = function() { errorReports++; };
+        var tokens = t.getLineTokens("x|", "start");
+        assert.deepEqual(tokens, {
+            tokens: [{value: 'x|', type: 'overflow'}],
+            state: 'start'
+        });
+        var tokens = t.getLineTokens("x|", "state1");
+        assert.deepEqual(tokens, {
+            tokens: [{value: 'x', type: 'x'}, {value: '|', type: 'overflow'}],
+            state: 'start'
+        });
+        assert.equal(errorReports, 2);
+    }, 
 };
 
 });
diff --git a/lib/ace/undomanager.js b/lib/ace/undomanager.js
index 4411ae8b..6da50a8b 100644
--- a/lib/ace/undomanager.js
+++ b/lib/ace/undomanager.js
@@ -61,15 +61,19 @@ var UndoManager = function() {
      *
      **/
     this.execute = function(options) {
-        var deltas = options.args[0];
+        // Normalize deltas for storage.
+        // var deltaSets = this.$serializeDeltas(options.args[0]);
+        var deltaSets = options.args[0];
+        // Add deltas to undo stack.
         this.$doc  = options.args[1];
         if (options.merge && this.hasUndo()){
             this.dirtyCounter--;
-            deltas = this.$undoStack.pop().concat(deltas);
+            deltaSets = this.$undoStack.pop().concat(deltaSets);
         }
-        this.$undoStack.push(deltas);
+        this.$undoStack.push(deltaSets);
+        
+        // Reset redo stack.
         this.$redoStack = [];
-
         if (this.dirtyCounter < 0) {
             // The user has made a change after undoing past the last clean state.
             // We can never get back to a clean state now until markClean() is called.
@@ -86,12 +90,11 @@ var UndoManager = function() {
      * @returns {Range} The range of the undo.
      **/
     this.undo = function(dontSelect) {
-        var deltas = this.$undoStack.pop();
+        var deltaSets = this.$undoStack.pop();
         var undoSelectionRange = null;
-        if (deltas) {
-            undoSelectionRange =
-                this.$doc.undoChanges(deltas, dontSelect);
-            this.$redoStack.push(deltas);
+        if (deltaSets) {
+            undoSelectionRange = this.$doc.undoChanges(this.$deserializeDeltas(deltaSets), dontSelect);
+            this.$redoStack.push(deltaSets);
             this.dirtyCounter--;
         }
 
@@ -105,15 +108,14 @@ var UndoManager = function() {
      * 
      **/
     this.redo = function(dontSelect) {
-        var deltas = this.$redoStack.pop();
+        var deltaSets = this.$redoStack.pop();
         var redoSelectionRange = null;
-        if (deltas) {
+        if (deltaSets) {
             redoSelectionRange =
-                this.$doc.redoChanges(deltas, dontSelect);
-            this.$undoStack.push(deltas);
+                this.$doc.redoChanges(this.$deserializeDeltas(deltaSets), dontSelect);
+            this.$undoStack.push(deltaSets);
             this.dirtyCounter++;
         }
-
         return redoSelectionRange;
     };
 
@@ -161,7 +163,52 @@ var UndoManager = function() {
     this.isClean = function() {
         return this.dirtyCounter === 0;
     };
-
+    
+    // Serializes deltaSets to reduce memory usage.
+    this.$serializeDeltas = function(deltaSets) {
+        return cloneDeltaSetsObj(deltaSets, $serializeDelta);
+    };
+    
+    // Deserializes deltaSets to allow application to the document.
+    this.$deserializeDeltas = function(deltaSets) {
+        return cloneDeltaSetsObj(deltaSets, $deserializeDelta);
+    };
+    
+    function $serializeDelta(delta){
+        return {
+            action: delta.action,
+            start: delta.start,
+            end: delta.end,
+            lines: delta.lines.length == 1 ? null : delta.lines,
+            text: delta.lines.length == 1 ? delta.lines[0] : null,
+        };
+    }
+        
+    function $deserializeDelta(delta) {
+        return {
+            action: delta.action,
+            start: delta.start,
+            end: delta.end,
+            lines: delta.lines || [delta.text]
+        };
+    }
+    
+    function cloneDeltaSetsObj(deltaSets_old, fnGetModifiedDelta) {
+        var deltaSets_new = new Array(deltaSets_old.length);
+        for (var i = 0; i < deltaSets_old.length; i++) {
+            var deltaSet_old = deltaSets_old[i];
+            var deltaSet_new = { group: deltaSet_old.group, deltas: new Array(deltaSet_old.length)};
+            
+            for (var j = 0; j < deltaSet_old.deltas.length; j++) {
+                var delta_old = deltaSet_old.deltas[j];
+                deltaSet_new.deltas[j] = fnGetModifiedDelta(delta_old);
+            }
+            
+            deltaSets_new[i] = deltaSet_new;
+        }
+        return deltaSets_new;
+    }
+    
 }).call(UndoManager.prototype);
 
 exports.UndoManager = UndoManager;
diff --git a/lib/ace/virtual_renderer.js b/lib/ace/virtual_renderer.js
index 87c3fa90..45226a1d 100644
--- a/lib/ace/virtual_renderer.js
+++ b/lib/ace/virtual_renderer.js
@@ -46,7 +46,7 @@ var FontMetrics = require("./layer/font_metrics").FontMetrics;
 var EventEmitter = require("./lib/event_emitter").EventEmitter;
 var editorCss = require("./requirejs/text!./css/editor.css");
 
-dom.importCssString(editorCss, "ace_editor");
+dom.importCssString(editorCss, "ace_editor.css");
 
 /**
  * The class that is responsible for drawing everything you see on the screen!
@@ -375,6 +375,9 @@ var VirtualRenderer = function(container, theme) {
 
         if (this.resizing)
             this.resizing = 0;
+        // reset cached values on scrollbars, needs to be removed when switching to non-native scrollbars
+        // see https://github.com/ajaxorg/ace/issues/2195
+        this.scrollBarV.scrollLeft = this.scrollBarV.scrollTop = null;
     };
     
     this.$updateCachedSize = function(force, gutterWidth, width, height) {
@@ -612,7 +615,7 @@ var VirtualRenderer = function(container, theme) {
     * @returns {DOMElement}
     **/
     this.getMouseEventTarget = function() {
-        return this.content;
+        return this.scroller;
     };
 
     /**
@@ -634,9 +637,12 @@ var VirtualRenderer = function(container, theme) {
         var posLeft = this.$cursorLayer.$pixelPos.left;
         posTop -= config.offset;
 
+        var style = this.textarea.style;
         var h = this.lineHeight;
-        if (posTop < 0 || posTop > config.height - h)
+        if (posTop < 0 || posTop > config.height - h) {
+            style.top = style.left = "0";
             return;
+        }
 
         var w = this.characterWidth;
         if (this.$composition) {
@@ -649,11 +655,10 @@ var VirtualRenderer = function(container, theme) {
             posLeft = this.$size.scrollerWidth - w;
 
         posLeft += this.gutterWidth;
-
-        this.textarea.style.height = h + "px";
-        this.textarea.style.width = w + "px";
-        this.textarea.style.left = Math.min(posLeft, this.$size.scrollerWidth - w) + "px";
-        this.textarea.style.top = Math.min(posTop, this.$size.height - h) + "px";
+        style.height = h + "px";
+        style.width = w + "px";
+        style.left = Math.min(posLeft, this.$size.scrollerWidth - w) + "px";
+        style.top = Math.min(posTop, this.$size.height - h) + "px";
     };
 
     /**
@@ -745,7 +750,7 @@ var VirtualRenderer = function(container, theme) {
      * @returns {Boolean}
      **/
     this.getVScrollBarAlwaysVisible = function() {
-        return this.$hScrollBarAlwaysVisible;
+        return this.$vScrollBarAlwaysVisible;
     };
 
     /**
@@ -914,6 +919,8 @@ var VirtualRenderer = function(container, theme) {
             (this.$minLines||1) * this.lineHeight,
             Math.min(maxHeight, height)
         ) + this.scrollMargin.v + (this.$extraHeight || 0);
+        if (this.$horizScroll)
+            desiredHeight += this.scrollBarH.getHeight();
         var vScroll = height > maxHeight;
         
         if (desiredHeight != this.desiredHeight ||
@@ -934,9 +941,6 @@ var VirtualRenderer = function(container, theme) {
     };
     
     this.$computeLayerConfig = function() {
-        if (this.$maxLines && this.lineHeight > 1)
-            this.$autosize();
-
         var session = this.session;
         var size = this.$size;
         
@@ -944,9 +948,6 @@ var VirtualRenderer = function(container, theme) {
         var screenLines = this.session.getScreenLength();
         var maxHeight = screenLines * this.lineHeight;
 
-        var offset = this.scrollTop % this.lineHeight;
-        var minHeight = size.scrollerHeight + this.lineHeight;
-
         var longestLine = this.$getLongestLine();
         
         var horizScroll = !hideScrollbars && (this.$hScrollBarAlwaysVisible ||
@@ -957,24 +958,32 @@ var VirtualRenderer = function(container, theme) {
             this.$horizScroll = horizScroll;
             this.scrollBarH.setVisible(horizScroll);
         }
+        // autoresize only after updating hscroll to include scrollbar height in desired height
+        if (this.$maxLines && this.lineHeight > 1)
+            this.$autosize();
+
+        var offset = this.scrollTop % this.lineHeight;
+        var minHeight = size.scrollerHeight + this.lineHeight;
         
-        if (!this.$maxLines && this.$scrollPastEnd) {
-            maxHeight += (size.scrollerHeight - this.lineHeight) * this.$scrollPastEnd;
-        }
+        var scrollPastEnd = !this.$maxLines && this.$scrollPastEnd
+            ? (size.scrollerHeight - this.lineHeight) * this.$scrollPastEnd
+            : 0;
+        maxHeight += scrollPastEnd;
+        
+        var sm = this.scrollMargin;
+        this.session.setScrollTop(Math.max(-sm.top,
+            Math.min(this.scrollTop, maxHeight - size.scrollerHeight + sm.bottom)));
+
+        this.session.setScrollLeft(Math.max(-sm.left, Math.min(this.scrollLeft, 
+            longestLine + 2 * this.$padding - size.scrollerWidth + sm.right)));
         
         var vScroll = !hideScrollbars && (this.$vScrollBarAlwaysVisible ||
-            size.scrollerHeight - maxHeight < 0);
+            size.scrollerHeight - maxHeight + scrollPastEnd < 0 || this.scrollTop > sm.top);
         var vScrollChanged = this.$vScroll !== vScroll;
         if (vScrollChanged) {
             this.$vScroll = vScroll;
             this.scrollBarV.setVisible(vScroll);
         }
-        
-        this.session.setScrollTop(Math.max(-this.scrollMargin.top,
-            Math.min(this.scrollTop, maxHeight - size.scrollerHeight + this.scrollMargin.bottom)));
-
-        this.session.setScrollLeft(Math.max(-this.scrollMargin.left, Math.min(this.scrollLeft, 
-            longestLine + 2 * this.$padding - size.scrollerWidth + this.scrollMargin.right)));
 
         var lineCount = Math.ceil(minHeight / this.lineHeight) - 1;
         var firstRow = Math.max(0, Math.round((this.scrollTop - offset) / this.lineHeight));
diff --git a/lib/ace/virtual_renderer_test.js b/lib/ace/virtual_renderer_test.js
index e8a8fcbd..9b1ed866 100644
--- a/lib/ace/virtual_renderer_test.js
+++ b/lib/ace/virtual_renderer_test.js
@@ -36,26 +36,40 @@ if (typeof process !== "undefined") {
 define(function(require, exports, module) {
 "use strict";
 
+var Editor = require("./edit_session").Editor;
 var EditSession = require("./edit_session").EditSession;
 var VirtualRenderer = require("./virtual_renderer").VirtualRenderer;
 var assert = require("./test/assertions");
 
+var editor = null;
 module.exports = {
-    "test: screen2text the column should be rounded to the next character edge" : function() {
+    setUp: function() {
+        if (editor)
+            editor.destroy()
         var el = document.createElement("div");
-
         if (!el.getBoundingClientRect) {
             console.log("Skipping test: This test only runs in the browser");
             return;
         }
-
         el.style.left = "20px";
         el.style.top = "30px";
         el.style.width = "300px";
         el.style.height = "100px";
         document.body.appendChild(el);
-
         var renderer = new VirtualRenderer(el);
+        var editor = new Editor(renderer);
+        editor.on("destroy", function() {
+            document.body.removeChild(el);
+        });
+    },
+    tearDown: function() {
+        editor && editor.destroy();
+        editor = null;
+    },
+    "test: screen2text the column should be rounded to the next character edge" : function(done) {
+        if (!editor) return done();
+        var renderer = editor.renderer;
+
         renderer.setPadding(0);
         renderer.setSession(new EditSession("1234"));
 
@@ -73,7 +87,23 @@ module.exports = {
         testPixelToText(10, 0, 0, 1);
         testPixelToText(14, 0, 0, 1);
         testPixelToText(15, 0, 0, 2);
-        document.body.removeChild(el);
+        done();
+    },
+    
+    "test scrollmargin + autosize": function(done) {
+        if (!editor) return done();
+        editor.setOptions({
+            maxLines: 100,
+            useWrapMode: true
+        });        
+        editor.renderer.setScrollMargin(10, 10);
+        editor.setValue("\n\n");
+        editor.setValue("\n\n\n\n");
+        editor.renderer.once("afterRender", function() {
+            setTimeout(function() {
+                done();
+            }, 0);
+        });
     }
 
     // change tab size after setDocument (for text layer)
diff --git a/lib/ace/worker/mirror.js b/lib/ace/worker/mirror.js
index 7a3318fb..ef6e2aa3 100644
--- a/lib/ace/worker/mirror.js
+++ b/lib/ace/worker/mirror.js
@@ -1,6 +1,7 @@
 define(function(require, exports, module) {
 "use strict";
 
+var Range = require("../range").Range;
 var Document = require("../document").Document;
 var lang = require("../lib/lang");
     
@@ -12,7 +13,19 @@ var Mirror = exports.Mirror = function(sender) {
     
     var _self = this;
     sender.on("change", function(e) {
-        doc.applyDeltas(e.data);
+        var data = e.data;
+        if (data[0].start) {
+            doc.applyDeltas(data);
+        } else {
+            for (var i = 0; i < data.length; i += 2) {
+                if (Array.isArray(data[i+1])) {
+                    var d = {action: "insert", start: data[i], lines: data[i+1]};
+                } else {
+                    var d = {action: "remove", start: data[i], end: data[i+1]};
+                }
+                doc.applyDelta(d, true);
+            }
+        }
         if (_self.$timeout)
             return deferredUpdate.schedule(_self.$timeout);
         _self.onUpdate();
diff --git a/lib/ace/worker/worker.js b/lib/ace/worker/worker.js
index 928000dd..28fc0fe2 100644
--- a/lib/ace/worker/worker.js
+++ b/lib/ace/worker/worker.js
@@ -1,8 +1,9 @@
 "no use strict";
 ;(function(window) {
-if (typeof window.window != "undefined" && window.document) {
+if (typeof window.window != "undefined" && window.document)
+    return;
+if (window.require && window.define)
     return;
-}
 
 window.console = function() {
     var msgs = Array.prototype.slice.call(arguments, 0);
@@ -19,6 +20,7 @@ window.ace = window;
 window.onerror = function(message, file, line, col, err) {
     postMessage({type: "error", data: {
         message: message,
+        data: err.data,
         file: file,
         line: line, 
         col: col,
@@ -37,7 +39,7 @@ window.normalizeModule = function(parentId, moduleName) {
         var base = parentId.split("/").slice(0, -1).join("/");
         moduleName = (base ? base + "/" : "") + moduleName;
         
-        while(moduleName.indexOf(".") !== -1 && previous != moduleName) {
+        while (moduleName.indexOf(".") !== -1 && previous != moduleName) {
             var previous = moduleName;
             moduleName = moduleName.replace(/^\.\//, "").replace(/\/\.\//, "/").replace(/[^\/]+\/\.\.\//, "");
         }
@@ -46,7 +48,7 @@ window.normalizeModule = function(parentId, moduleName) {
     return moduleName;
 };
 
-window.require = function(parentId, id) {
+window.require = function require(parentId, id) {
     if (!id) {
         id = parentId;
         parentId = null;
@@ -64,17 +66,36 @@ window.require = function(parentId, id) {
         }
         return module.exports;
     }
-    
-    var chunks = id.split("/");
+   
     if (!window.require.tlns)
         return console.log("unable to load " + id);
-    chunks[0] = window.require.tlns[chunks[0]] || chunks[0];
-    var path = chunks.join("/") + ".js";
+    
+    var path = resolveModuleId(id, window.require.tlns);
+    if (path.slice(-3) != ".js") path += ".js";
     
     window.require.id = id;
+    window.require.modules[id] = {}; // prevent infinite loop on broken modules
     importScripts(path);
     return window.require(parentId, id);
 };
+function resolveModuleId(id, paths) {
+    var testPath = id, tail = "";
+    while (testPath) {
+        var alias = paths[testPath];
+        if (typeof alias == "string") {
+            return alias + tail;
+        } else if (alias) {
+            return  alias.location.replace(/\/*$/, "/") + (tail || alias.main || alias.name);
+        } else if (alias === false) {
+            return "";
+        }
+        var i = testPath.lastIndexOf("/");
+        if (i === -1) break;
+        tail = testPath.substr(i) + tail;
+        testPath = testPath.slice(0, i);
+    }
+    return id;
+}
 window.require.modules = {};
 window.require.tlns = {};
 
@@ -100,9 +121,9 @@ window.define = function(id, deps, factory) {
     }
 
     if (!deps.length)
-        // If there is no dependencies, we inject 'require', 'exports' and
-        // 'module' as dependencies, to provide CommonJS compatibility.
-        deps = ['require', 'exports', 'module'];
+        // If there is no dependencies, we inject "require", "exports" and
+        // "module" as dependencies, to provide CommonJS compatibility.
+        deps = ["require", "exports", "module"];
 
     var req = function(childId) {
         return window.require(id, childId);
@@ -113,16 +134,16 @@ window.define = function(id, deps, factory) {
         factory: function() {
             var module = this;
             var returnExports = factory.apply(this, deps.map(function(dep) {
-              switch(dep) {
-                  // Because 'require', 'exports' and 'module' aren't actual
-                  // dependencies, we must handle them seperately.
-                  case 'require': return req;
-                  case 'exports': return module.exports;
-                  case 'module':  return module;
-                  // But for all other dependencies, we can just go ahead and
-                  // require them.
-                  default:        return req(dep);
-              }
+                switch (dep) {
+                    // Because "require", "exports" and "module" aren't actual
+                    // dependencies, we must handle them seperately.
+                    case "require": return req;
+                    case "exports": return module.exports;
+                    case "module":  return module;
+                    // But for all other dependencies, we can just go ahead and
+                    // require them.
+                    default:        return req(dep);
+                }
             }));
             if (returnExports)
                 module.exports = returnExports;
@@ -131,9 +152,10 @@ window.define = function(id, deps, factory) {
     };
 };
 window.define.amd = {};
-
+require.tlns = {};
 window.initBaseUrls  = function initBaseUrls(topLevelNamespaces) {
-    require.tlns = topLevelNamespaces;
+    for (var i in topLevelNamespaces)
+        require.tlns[i] = topLevelNamespaces[i];
 };
 
 window.initSender = function initSender() {
@@ -173,21 +195,23 @@ var sender = window.sender = null;
 
 window.onmessage = function(e) {
     var msg = e.data;
-    if (msg.command) {
+    if (msg.event && sender) {
+        sender._signal(msg.event, msg.data);
+    }
+    else if (msg.command) {
         if (main[msg.command])
             main[msg.command].apply(main, msg.args);
+        else if (window[msg.command])
+            window[msg.command].apply(window, msg.args);
         else
             throw new Error("Unknown command:" + msg.command);
     }
-    else if (msg.init) {        
-        initBaseUrls(msg.tlns);
+    else if (msg.init) {
+        window.initBaseUrls(msg.tlns);
         require("ace/lib/es5-shim");
-        sender = window.sender = initSender();
+        sender = window.sender = window.initSender();
         var clazz = require(msg.module)[msg.classname];
         main = window.main = new clazz(sender);
-    } 
-    else if (msg.event && sender) {
-        sender._signal(msg.event, msg.data);
     }
 };
 })(this);
\ No newline at end of file
diff --git a/lib/ace/worker/worker_client.js b/lib/ace/worker/worker_client.js
index ad445287..ba4f20a0 100644
--- a/lib/ace/worker/worker_client.js
+++ b/lib/ace/worker/worker_client.js
@@ -162,19 +162,22 @@ var WorkerClient = function(topLevelNamespaces, mod, classname, workerUrl) {
         doc.on("change", this.changeListener);
     };
 
-    this.changeListener = function(e) {
+    this.changeListener = function(delta) {
         if (!this.deltaQueue) {
-            this.deltaQueue = [e.data];
+            this.deltaQueue = [];
             setTimeout(this.$sendDeltaQueue, 0);
-        } else
-            this.deltaQueue.push(e.data);
+        }
+        if (delta.action == "insert")
+            this.deltaQueue.push(delta.start, delta.lines);
+        else
+            this.deltaQueue.push(delta.start, delta.end);
     };
 
     this.$sendDeltaQueue = function() {
         var q = this.deltaQueue;
         if (!q) return;
         this.deltaQueue = null;
-        if (q.length > 20 && q.length > this.$doc.getLength() >> 1) {
+        if (q.length > 50 && q.length > this.$doc.getLength() >> 1) {
             this.call("setValue", [this.$doc.getValue()]);
         } else
             this.emit("change", {data: q});
diff --git a/package.json b/package.json
index 31a4dec9..41c40fce 100644
--- a/package.json
+++ b/package.json
@@ -1,14 +1,14 @@
 {
     "name": "ace",
     "description": "Ajax.org Code Editor is a full featured source code highlighting editor that powers the Cloud9 IDE",
-    "version": "1.0.0",
-    "homepage" : "http://github.com/ajaxorg/ace",
+    "version": "1.1.9",
+    "homepage": "http://github.com/ajaxorg/ace",
     "engines": {"node": ">= 0.6.0"},
     "author": "Fabian Jakobs ",
     "main": "lib/ace",
-    "repository" : {
-        "type" : "git",
-         "url" : "http://github.com/ajaxorg/ace.git"
+    "repository": {
+        "type": "git",
+         "url": "http://github.com/ajaxorg/ace.git"
     },
     "dependencies": {
         "mime": "1.2.x"
@@ -18,7 +18,7 @@
         "jsdom": "0.2.x",
         "amd-loader": "~0.0.4",
         "dryice": "0.4.11",
-        "architect-build": "https://github.com/c9/architect-build/tarball/42723e152bb"
+        "architect-build": "https://github.com/c9/architect-build/tarball/a3bad51808"
     },
     "mappings": {
         "ace": "."
diff --git a/static.js b/static.js
index 4f7e7248..3b75c2b6 100755
--- a/static.js
+++ b/static.js
@@ -10,37 +10,101 @@ var http = require("http")
 
 // compatibility with node 0.6
 if (!fs.exists)
-  fs.exists = path.exists;
+    fs.exists = path.exists;
 
-http.createServer(function(request, response) {
+var allowSave = process.argv.indexOf("--allow-save") != -1;
 
-  var uri = url.parse(request.url).pathname
-    , filename = path.join(process.cwd(), uri);
-  
-  fs.exists(filename, function(exists) {
-    if(!exists) {
-      response.writeHead(404, {"Content-Type": "text/plain"});
-      response.write("404 Not Found\n");
-      response.end();
-      return;
+http.createServer(function(req, res) {
+    var uri = url.parse(req.url).pathname
+      , filename = path.join(process.cwd(), uri);
+
+    if (req.method == "PUT") {
+        if (!allowSave)
+            return error(res, 404, "Saving not allowed pass --allow-save to enable");
+        return save(req, res, filename);
     }
 
-    if (fs.statSync(filename).isDirectory()) filename += '/index.html';
+    fs.exists(filename, function(exists) {
+        if (!exists)
+            return error(res, 404, "404 Not Found\n");
 
-    fs.readFile(filename, "binary", function(err, file) {
-      if(err) {        
-        response.writeHead(500, {"Content-Type": "text/plain"});
-        response.write(err + "\n");
-        response.end();
-        return;
-      }
+        if (fs.statSync(filename).isDirectory()) {
+            var files = fs.readdirSync(filename);
+            res.writeHead(200, {"Content-Type": "text/html"});
+            
+            files.push(".", "..");
+            var html = files.map(function(name) {
+                var href = uri + "/" + name;
+                href = href.replace(/[\/\\]+/g, "/").replace(/\/$/g, "");
+                if (fs.statSync(filename + "/" + name + "/").isDirectory())
+                    href += "/";
+                return "" + name + "
    ";
+            });
 
-      var contentType = mime.lookup(filename) || "text/plain";
-      response.writeHead(200, {"Content-Type": contentType});
-      response.write(file, "binary");
-      response.end();
+            res._hasBody && res.write(html.join(""));
+            res.end();
+            return;
+        }
+
+        fs.readFile(filename, "binary", function(err, file) {
+            if (err) {
+                res.writeHead(500, { "Content-Type": "text/plain" });
+                res.write(err + "\n");
+                res.end();
+                return;
+            }
+
+            var contentType = mime.lookup(filename) || "text/plain";
+            res.writeHead(200, { "Content-Type": contentType });
+            res.write(file, "binary");
+            res.end();
+        });
     });
-  });
 }).listen(port, ip);
 
-console.log("http://localhost:" + port);
+function error(res, status, message, error) {
+    console.error(error || message);
+    res.writeHead(status, { "Content-Type": "text/plain" });
+    res.write(message);
+    res.end();
+}
+
+function save(req, res, filePath) {
+    var data = "";
+    req.on("data", function(chunk) {
+        data += chunk;
+    });
+    req.on("error", function() {
+        error(res, 404, "Could't save file");
+    });
+    req.on("end", function() {
+        try {
+            fs.writeFileSync(filePath, data);
+        }
+        catch (e) {
+            return error(res, 404, "Could't save file", e);
+        }
+        res.statusCode = 200;
+        res.end("OK");
+        console.log("saved ", filePath);
+    });
+}
+
+function getLocalIps() {
+    var os = require("os");
+
+    var interfaces = os.networkInterfaces ? os.networkInterfaces() : {};
+    var addresses = [];
+    for (var k in interfaces) {
+        for (var k2 in interfaces[k]) {
+            var address = interfaces[k][k2];
+            if (address.family === "IPv4" && !address.internal) {
+                addresses.push(address.address);
+            }
+        }
+    }
+    return addresses;
+}
+
+console.log("http://" + (ip == "0.0.0.0" ? getLocalIps()[0] : ip) + ":" + port);
+
diff --git a/static.py b/static.py
index eb864596..7a2faf91 100755
--- a/static.py
+++ b/static.py
@@ -32,7 +32,9 @@ import time
 import string
 import sys
 from os import path, stat, getcwd
+from fnmatch import fnmatch
 from wsgiref import util
+from wsgiref.validate import validator
 from wsgiref.headers import Headers
 from wsgiref.simple_server import make_server
 from optparse import OptionParser
@@ -84,6 +86,8 @@ class Cling(object):
     not_modified = StatusApp('304 Not Modified', "")
     moved_permanently = StatusApp('301 Moved Permanently')
     method_not_allowed = StatusApp('405 Method Not Allowed')
+    success_no_content = StatusApp('204 No Content', "")
+    server_error = StatusApp('500 Internal Server Error')
 
     def __init__(self, root, **kw):
         """Just set the root and any other attribs passes via **kw."""
@@ -93,9 +97,6 @@ class Cling(object):
 
     def __call__(self, environ, start_response):
         """Respond to a request when called in the usual WSGI way."""
-        if environ['REQUEST_METHOD'] not in ('GET', 'HEAD'):
-            headers = [('Allow', 'GET, HEAD')]
-            return self.method_not_allowed(environ, start_response, headers)
         path_info = environ.get('PATH_INFO', '')
         full_path = self._full_path(path_info)
         if not self._is_under_root(full_path):
@@ -109,6 +110,23 @@ class Cling(object):
                 return self.moved_permanently(environ, start_response, headers)
             else:
                 full_path = self._full_path(path_info + self.index_file)
+        try:
+            sz = int(environ['CONTENT_LENGTH'])
+        except:
+            sz = 0
+        if environ['REQUEST_METHOD'] == 'PUT' and sz > 0:
+            for putglob in self.puttable:
+                if fnmatch(path_info, putglob):
+                    data = environ['wsgi.input'].read(sz)
+                    try:
+                        with open(full_path, "wb") as f: f.write(data)
+                        return self.success_no_content(environ, start_response)
+                    except:
+                        print sys.exc_info()[1]
+                        return self.server_error(environ, start_response)
+        if environ['REQUEST_METHOD'] not in ('GET', 'HEAD'):
+            headers = [('Allow', 'GET, HEAD')]
+            return self.method_not_allowed(environ, start_response, headers)
         content_type = self._guess_type(full_path)
         try:
             etag, last_modified = self._conditions(full_path, environ)
@@ -191,52 +209,90 @@ def cling_wrap(package_name, dir_name, **kw):
 
 
 def command():
-    parser = OptionParser(usage="%prog DIR [HOST][:][PORT]",
-                          version="static 0.3.6")
+    usage = "%prog [--help] [-d DIR] [-l [HOST][:PORT]] [-p GLOB[,GLOB...]]"
+    parser = OptionParser(usage=usage, version="static 0.3.6")
+    parser.add_option("-d", "--dir", dest="rootdir", default=".",
+        help="Root directory to serve. Defaults to '.' .", metavar="DIR")
+    parser.add_option("-l", "--listen", dest="listen", default="127.0.0.1:8888",
+        help="Listen on this interface (given by its hostname or IP) and port."+
+             " HOST defaults to 127.0.0.1. PORT defaults to 8888. "+
+             "Leave HOST empty to listen on all interfaces (INSECURE!).",
+             metavar="[HOST][:PORT]")
+    parser.add_option("-p", "--puttable", dest="puttable", default="",
+             help="Comma or space-separated list of request paths for which to"+
+                  " permit PUT requests. Each path is a glob pattern that may "+
+                  "contain wildcard characters '*' and/or '?'. "+
+                  "'*' matches any sequence of characters, including the empty"+
+                  " string. '?' matches exactly 1 arbitrary character. "+
+                  "NOTE: Both '*' and '?' match slashes and dots. "+
+                  "I.e. --puttable=* makes every file under DIR writable!",
+                  metavar="GLOB[,GLOB...]")
+    parser.add_option("--validate", dest="validate", action="store_true",
+                  default=False,
+                  help="Enable HTTP validation. You don't need this unless "+
+                       "you're developing static.py itself.")
+
     options, args = parser.parse_args()
-    if len(args) in (1, 2):
-        if len(args) == 2:
-            parts = args[1].split(":")
-            if len(parts) == 1:
-                host = parts[0]
-                port = None
-            elif len(parts) == 2:
-                host, port = parts
-            else:
-                sys.exit("Invalid host:port specification.")
-        elif len(args) == 1:
-            host, port = None, None
-        if not host:
-            host = '0.0.0.0'
-        if not port:
-            port = 8888
-        try:
-            port = int(port)
-        except:
-            sys.exit("Invalid host:port specification.")
-        app = Cling(args[0])
-        try:
-            make_server(host, port, app).serve_forever()
-        except KeyboardInterrupt, ki:
-            print "Cio, baby!"
-        except:
-            sys.exit("Problem initializing server.")
-    else:
+    if len(args) > 0:
         parser.print_help(sys.stderr)
         sys.exit(1)
 
+    parts = options.listen.split(":")
+    if len(parts) == 1:
+        try: # if the the listen argument consists only of a port number
+            port = int(parts[0])
+            host = None
+        except: # could not parse as port number => must be a host IP or name
+            host = parts[0]
+            port = None
+    elif len(parts) == 2:
+        host, port = parts
+    else:
+        sys.exit("Invalid host:port specification.")
 
-def test():
-    from wsgiref.validate import validator
-    app = Cling(getcwd())
+    if not host:
+        host = '0.0.0.0'
+    if not port:
+        port = 8888
     try:
-        print "Serving " + getcwd() + " to http://localhost:8888"
-        make_server('0.0.0.0', 8888, validator(app)).serve_forever()
+        port = int(port)
+        if port <= 0 or port > 65535: raise ValueError
+    except:
+        sys.exit("Invalid host:port specification.")
+
+    puttable = set(path.abspath(p) for p in
+                                     options.puttable.replace(","," ").split())
+    if puttable and host not in ('127.0.0.1', 'localhost'):
+        print("Permitting PUT access for non-localhost connections may be unwise.")
+
+    options.rootdir = path.abspath(options.rootdir)
+
+    for p in puttable:
+        if not p.startswith(options.rootdir):
+            sys.exit("puttable path '%s' not under root '%s'" % (p, options.rootdir))
+
+    # cut off root prefix from puttable paths
+    puttable = set(p[len(options.rootdir):] for p in puttable)
+
+    app = Cling(options.rootdir, puttable=puttable)
+
+    if options.validate:
+        app = validator(app)
+
+    try:
+        print "Serving %s to http://%s:%d" % (options.rootdir, host, port)
+        if puttable:
+            print("The following paths (relative to server root) may be "+
+                  "OVERWRITTEN via HTTP PUT.")
+            for p in puttable:
+                print p
+        make_server(host, port, app).serve_forever()
     except KeyboardInterrupt, ki:
-        print ""
         print "Ciao, baby!"
+    except:
+        sys.exit("Problem initializing server: %s" % sys.exc_info()[1])
 
 
 if __name__ == '__main__':
-    test()
+    command()
 
diff --git a/tool/add_mode.js b/tool/add_mode.js
index 2f70a14a..879b9204 100644
--- a/tool/add_mode.js
+++ b/tool/add_mode.js
@@ -9,7 +9,7 @@ function main(displayName, extRe) {
     var demoFileExt = extRe.split("|")[0] || name;
     var demoFileName = demoFileExt[0] == "^" ? demoFileExt.substr(1) : name + "." + demoFileExt;
     var demoFilePath = lib.AceRoot + "demo/kitchen-sink/docs/" + demoFileName;
-    fs.writeFileSync(demoFilePath, "TODO add a nice demo!", "utf8");
+    fs.writeFileSync(demoFilePath, "TODO add a nice demo!\nTry to keep it short!", "utf8");
     console.log("Created demo file at: " + path.normalize(demoFilePath));
 
     /** mode **/
diff --git a/tool/lib.js b/tool/lib.js
index e72194d7..3d57b6e0 100644
--- a/tool/lib.js
+++ b/tool/lib.js
@@ -1,6 +1,7 @@
 var plist = require("plist");
 var util = require("util");
 var url = require("url");
+var cson = require("cson");
 
 var https = require("https");
 var http = require("http");
@@ -12,17 +13,120 @@ exports.parsePlist = function(xmlOrJSON, callback) {
             json = result[0];
         });
     } else {
-        xmlOrJSON = xmlOrJSON.replace(/^\s*\/\/.*/gm, "");
-        json = JSON.parse(xmlOrJSON)
+        try {
+            xmlOrJSON = xmlOrJSON.replace(
+                /("(?:\\.|[^"])*")|(?:,\s*)+([\]\}])|(\w+)\s*:|([\]\}]\s*[\[\{])|(\/\/.*|\/\*(?:[^\*]|\*(?=[^\/]))*?\*\/)/g,
+                function(_, str, extraComma, noQuote, missingComma, comment) {
+                    if (comment)
+                        return "";
+                    if (missingComma)
+                        return missingComma[0] + "," + missingComma.slice(1);
+                    return str || extraComma || '"' + noQuote + '":';
+            });
+            json = JSON.parse(xmlOrJSON);
+        } catch(e) {
+            json = cson.parse(xmlOrJSON);
+        }
     }
     callback && callback(json);
     return json;
 };
 
+
 exports.formatJSON = function(object, initialIndent) {
-    return util.inspect(object, false, 40).replace(/^/gm, initialIndent||"");
+    return JSON.stringify(object, null, 4).replace(/^/gm, initialIndent||"");
 };
 
+exports.formatJS = function(object, initialIndent) {
+    return formatJS(object, 4, initialIndent);
+};
+
+function formatJS(object, indent, initialIndent) {
+    if (typeof  indent == "number")
+        indent = Array(indent + 1).join(" ");
+    
+    function $format(buffer, totalIndent, state, o) {
+        if (typeof o != "object" || !o) {
+            if (typeof o == "string")
+                buffer.push(JSON.stringify(o));
+            else
+                buffer.push("" + o);
+        }
+        else if (Array.isArray(o)) {
+            buffer.push("[")
+            
+            var len = totalIndent.length
+            var oneLine = true;
+            for (var i = 0; i < o.length; i++) {
+                if (typeof o[i] == "string") {
+                    len += o[i].length + 2
+                } else if (!o[i]) {
+                    len += (o[i] + "").length
+                } else {
+                    oneLine = false;
+                    break;
+                }
+                len += 2;
+                if (len > 60) {
+                    oneLine = false;
+                    break;
+                }
+            }
+            
+            for (var i = 0; i < o.length; i++) {
+                if (o[i] && typeof o[i] == "object") {
+                    $format(buffer, totalIndent, state, o[i]);
+                    if (i < o.length - 1)
+                        buffer.push(", ");
+                } else {
+                    if (oneLine)
+                        i && buffer.push(" ");
+                    else
+                        buffer.push("\n", totalIndent + indent)
+                    $format(buffer, totalIndent + indent, state, o[i]);
+                    if (i < o.length - 1)
+                        buffer.push(",");
+                }
+                
+            }
+            if (!oneLine && buffer[buffer.length - 1] != "}")
+                buffer.push("\n" + totalIndent)
+            buffer.push("]")
+        }
+        else {
+            var keys = Object.keys(o);
+            buffer.push("{", "\n");
+            for (var i = 0; i < keys.length; i++) {
+                buffer.push(totalIndent + indent);
+                if (/^\w+$/.test(keys[i]))
+                    buffer.push(keys[i]);
+                else
+                    buffer.push(JSON.stringify(keys[i]));
+                buffer.push(": ")
+
+                if (keys[i] == "regex" && typeof o[keys[i]] == "string") {
+                    try {
+                        var re = new RegExp(o[keys[i]]);
+                        buffer.push("/" + re.source.replace(/\\.|\//g, function(f) {
+                            return f.length == 1 ? "\\" + f : f;
+                        }) + "/");
+                    } catch(e) {
+                        $format(buffer, totalIndent + indent, state, o[keys[i]]);
+                    }
+                } else {
+                    $format(buffer, totalIndent + indent, state, o[keys[i]]);
+                }
+                
+                if (i < keys.length - 1)
+                    buffer.push(",", "\n");
+            }
+            buffer.push("\n", totalIndent, "}");
+        }
+    }
+    var buffer = [];
+    $format(buffer, initialIndent || "", {}, object);
+    return buffer.join("");
+}
 
 exports.fillTemplate = function(template, replacements) {
     return template.replace(/%(.+?)%/g, function(str, m) {
diff --git a/tool/mode_creator.html b/tool/mode_creator.html
index e2db56af..259ba64e 100644
--- a/tool/mode_creator.html
+++ b/tool/mode_creator.html
@@ -19,7 +19,7 @@
             border-bottom: solid 1px;
         }
         .separator-h {
-            padding: 0 20px;
+            padding: 0 10px;
         }
         #closeBtn {
             background: rgba(245, 146, 146, 0.5);
@@ -59,6 +59,7 @@
     
     
     
+    
     
     
     
@@ -70,6 +71,7 @@
         
         
         
+        
         
         
     
diff --git a/tool/mode_creator.js b/tool/mode_creator.js
index 6b1122cd..44aa67d0 100644
--- a/tool/mode_creator.js
+++ b/tool/mode_creator.js
@@ -53,6 +53,7 @@ util.bindDropdown("doc", function(value) {
     doclist.loadDoc(value, function(session) {
         if (session) {
             editor2.setSession(session);
+            updateSaveButtonState(null, editor2);
         }
     });
 });
@@ -60,6 +61,7 @@ util.bindDropdown("doc", function(value) {
 var modeEl = document.getElementById("modeEl");
 util.fillDropdown(modeEl, modelist.modes);
 var modeSessions = {};
+
 util.bindDropdown(modeEl, function(value) {
     if (modeSessions[value]) {
         editor1.setSession(modeSessions[value]);
@@ -68,14 +70,17 @@ util.bindDropdown(modeEl, function(value) {
     }
     var hp = "./lib/ace/mode/" + value + "_highlight_rules.js";
     net.get(hp, function(text) {
-        text = util.stripLeadingComments(text);
-
         var session = new EditSession(text);
         session.setUndoManager(new UndoManager());
+
         modeSessions[value] = session;
-        session.setMode("ace/mode/javascript");
+        session.setMode("ace/mode/javascript", function() {
+            if (session.getLine(0).match(/^\s*\//))
+                session.toggleFoldWidget(0); // fold licence comment
+        });
 
         editor1.setSession(modeSessions[value]);
+        updateSaveButtonState(null, editor1);
         schedule();
     });
 });
@@ -85,6 +90,50 @@ document.getElementById("syncToMode").onclick = function() {
     docEl.onchange();
     run();
 };
+
+editor1.saveButton = document.getElementById("saveButton1");
+editor2.saveButton = document.getElementById("saveButton2");
+editor1.saveButton.editor = editor1;
+editor2.saveButton.editor = editor2;
+
+editor1.saveButton.onclick = function() {
+    doclist.saveDoc({
+        path: "./lib/ace/mode/" + modeEl.value + "_highlight_rules.js",
+        session: editor1.session
+    }, function(err) {
+        handleSaveResult(err, editor1);
+    });
+};
+editor1.commands.bindKey({
+    win: "Ctrl-S", mac: "Cmd-s"
+}, editor1.saveButton.onclick);
+editor2.saveButton.onclick = function() {
+    doclist.saveDoc(docEl.value, function(err) {
+        handleSaveResult(err, editor2);
+    });
+};
+editor2.commands.bindKey({
+    win: "Ctrl-S", mac: "Cmd-s"
+}, editor2.saveButton.onclick);
+function updateSaveButtonState(e, editor){
+    editor.saveButton.disabled = editor.session.getUndoManager().isClean();
+}
+editor1.on("input", updateSaveButtonState);
+editor2.on("input", updateSaveButtonState);
+
+function handleSaveResult(err, editor) {
+    if (err) {
+        return log(
+            "Write access to this file is disabled.\n"+
+            "To enable saving your changes to disk, clone the Ace repository\n"+
+            "and run the included web server with the --allow-save option\n"+
+            "`node static.js --allow-save` or `static.py --puttable=*`"
+        );
+    }
+    editor.session.getUndoManager().markClean();
+    updateSaveButtonState(null, editor);
+}
+
 document.getElementById("perfTest").onclick = function() {
     var lines = editor2.session.doc.getAllLines();
     if (!lines.length)
diff --git a/tool/package.json b/tool/package.json
index 2d33713a..974673c6 100644
--- a/tool/package.json
+++ b/tool/package.json
@@ -1,9 +1,10 @@
 {
-    "name": "ace-tools",
-    "version": "0.1.0",
-    "dependencies": {
-        "plist": "",
-        "css-parse": "1.0.3",
-        "css-stringify": "1.0.3"
-    }
+  "name": "ace-tools",
+  "version": "0.1.0",
+  "dependencies": {
+    "cson": "^3.0.1",
+    "css-parse": "1.0.3",
+    "css-stringify": "1.0.3",
+    "plist": ""
+  }
 }
diff --git a/tool/release.sh b/tool/release.sh
new file mode 100644
index 00000000..52376914
--- /dev/null
+++ b/tool/release.sh
@@ -0,0 +1,79 @@
+pause() {
+    while true; do
+        read -p "$1 " yn
+        case $yn in
+            [Yy]* ) break;;
+            [Nn]* ) exit;;
+            * ) echo "Please answer yes or no.";;
+        esac
+    done
+}
+
+
+
+cd `dirname $0`/..
+SOURCE=`pwd`
+
+CUR_VERSION=`node -e 'console.log(require("./package.json").version)'`
+git --no-pager log --first-parent --oneline v$CUR_VERSION..master
+echo "current version is $CUR_VERSION"
+read -p "enter version number for the build " VERSION_NUM
+
+node -e "
+    var fs = require('fs');
+    var version = '$VERSION_NUM';
+    function replaceVersion(str) {
+        return str.replace(/(['\"]?version['\"]?\s*[:=]\s*['\"])[\\d.\\w\\-]+(['\"])/, function(_, m1, m2) {
+            return m1 + version + m2;
+        });
+    }
+    function update(path, replace) {
+        var pkg = fs.readFileSync(path, 'utf8');
+        pkg = (replace || replaceVersion)(pkg);
+        fs.writeFileSync(path, pkg, 'utf8');
+    }
+    update('package.json');
+    update('build/package.json');
+    update('./lib/ace/ext/menu_tools/generate_settings_menu.js');
+    update('ChangeLog.txt', function(str) {
+        var date='"`date +%Y.%m.%d`"';
+        return date + ' Version ' + version + '\n' + str.replace(/^\d+.*/, '').replace(/^\n/, '');
+    });
+"
+
+pause "versions updated. do you want to start build script? [y/n]"
+
+node Makefile.dryice.js full
+cd build
+git add .
+git commit --all -m "package `date +%d.%m.%y`"
+
+
+echo "build task completed."
+pause "continue creating the tag for v$VERSION_NUM [y/n]"
+if [[ ${VERSION_NUM} != *"-"* ]]; then
+    git tag "v"$VERSION_NUM
+fi
+
+pause "continue pushing to github? [y/n]"
+
+git push --progress --tags "origin" HEAD:gh-pages HEAD:master
+
+echo "build repository updated"
+
+pause "continue update ace repo? [y/n]"
+cd ..
+
+
+echo "new commit added"
+pause "continue creating the tag for v$VERSION_NUM [y/n]"
+if [[ ${VERSION_NUM} != *"-"* ]]; then
+    git tag "v"$VERSION_NUM
+fi
+
+pause "continue pushing to github? [y/n]"
+
+git push --progress --tags "origin" HEAD:gh-pages HEAD:master
+echo "All done!"
+pause "May I go now? [y/n]"
+
diff --git a/tool/tmlanguage.js b/tool/tmlanguage.js
index d3e42141..b5d8b851 100644
--- a/tool/tmlanguage.js
+++ b/tool/tmlanguage.js
@@ -107,7 +107,7 @@ function convertToNonCapturingGroups(str) {
 
 function simplifyNonCapturingGroups(str) {
     var tokens = tokenize(str);
-    var t = tokens[0];
+    var t = tokens[0] || {};
     if (t.type == "group.start" && t.value == "(?:"
         && t.end == last(tokens)) {
         t.value = t.end.value = "";
@@ -662,10 +662,10 @@ function convertTmLanguage(name, langStr) {
 
         var languageHighlightRules = lib.fillTemplate(modeHighlightTemplate, {
             language: languageNameSanitized,
-            languageTokens: lib.formatJSON(patterns, "    ").trim(),
+            languageTokens: lib.formatJS(patterns, "    ").trim(),
             uuid: language.uuid,
             name: name,
-            metaData: lib.formatJSON(language, "    ").trim()
+            metaData: lib.formatJS(language, "").trim()
         });
 
         if (devMode) {
@@ -684,13 +684,14 @@ function convertTmLanguage(name, langStr) {
 
 if (!module.parent) {
     var args = process.argv.splice(2);
-    var tmLanguageFile  = args[0];
-    var devMode = args[1];
-    if (tmLanguageFile === undefined) {
-        console.error("Usage: node tmlanguage.js path/or/url/to/syntax.file");
+    var devMode = args[0] == "--dev";
+    if (devMode)
+        args.shift();
+    if (args.length < 1) {
+        console.error("Usage: node tmlanguage.js [--dev] path/or/url/to/syntax.file ...");
         process.exit(1);
     }
-    fetchAndConvert(tmLanguageFile);
+    args.forEach(fetchAndConvert);
 } else {
     exports.fetchAndConvert = fetchAndConvert;
 }
diff --git a/tool/tmtheme.js b/tool/tmtheme.js
index 02d9542e..c784eec7 100755
--- a/tool/tmtheme.js
+++ b/tool/tmtheme.js
@@ -106,7 +106,7 @@ function extractStyles(theme) {
 
     for (var i=1; i.css rules,
         // (because some exist, for collab1 and ace_indentation_guide
         try {
-            var outThemeCss = fs.readFileSync(__dirname + "/../lib/ace/theme/" + name + ".css");
+            var outThemeCss = fs.readFileSync(outputDirectory + "/" + name + ".css");
             var oldRules = cssParse(outThemeCss).stylesheet.rules;
             var newRules = cssParse(css).stylesheet.rules;
 
@@ -333,6 +337,7 @@ function convertTheme(name) {
             css = cssStringify({stylesheet: {rules: oldRules}}, { compress: false });
         } catch(e) {
             console.log("Creating new file: " +  name + ".css")
+            css = cssStringify(cssParse(css), { compress: false });
         }
         
         var js = fillTemplate(jsTemplate, {
@@ -342,13 +347,25 @@ function convertTheme(name) {
             isDark: styles.isDark
         });
 
-        fs.writeFileSync(__dirname + "/../lib/ace/theme/" + name + ".js", js);
-        fs.writeFileSync(__dirname + "/../lib/ace/theme/" + name + ".css", css);
+        fs.writeFileSync(outputDirectory + "/" + name + ".js", js);
+        fs.writeFileSync(outputDirectory + "/" + name + ".css", css);
     })
 }
 
-for (var name in themes) {
-    convertTheme(name);
+if (process.argv.length > 1) {
+    var args = process.argv.splice(2);
+    if (args.length < 3) {
+        console.error("Usage: node tmtheme.js [theme_name, path/to/theme.tmTheme path/to/output/directory]");
+        process.exit(1);
+    }
+    var name = args[0];
+    var themePath = args[1];
+    var outputDirectory = args[2];
+    convertTheme(name, themePath, outputDirectory);
+} else {
+    for (var name in themes) {
+        convertBuiltinTheme(name);
+    }
 }
 
 var sortedUnsupportedScopes = {};
diff --git a/tool/update_deps.js b/tool/update_deps.js
index 4b340ec2..c3648d9c 100644
--- a/tool/update_deps.js
+++ b/tool/update_deps.js
@@ -1,7 +1,7 @@
-var https = require("https")
-  , http = require("http")
-  , url = require("url")
-  , fs = require("fs");
+var https = require("https");
+var http = require("http");
+var url = require("url");
+var fs = require("fs");
 
 var Path = require("path");
 var spawn = require("child_process").spawn;
@@ -119,6 +119,26 @@ var deps = {
             });
         }
     },
+    vim: {
+        fetch: function(){
+            var rootHref = "https://raw.githubusercontent.com/codemirror/CodeMirror/master/"
+            var fileMap = {"keymap/vim.js": "keyboard/vim.js", "test/vim_test.js": "keyboard/vim_test.js"};
+            async.forEach(Object.keys(fileMap), function(x, next) {
+                download(rootHref + x, function(e, d) {
+                    d = d.replace(/^\(function.*{[^{}]+^}[^{}]+{/m, "define(function(require, exports, module) {");
+                    d = d.replace(/^\s*return vimApi;\s*};/gm, "  //};")
+                        .replace("var Vim = function() {", "$& return vimApi; } //{")
+                    fs.writeFile(rootDir + fileMap[x], d, next)
+                })
+            }, function() {
+                console.log("done")
+            });
+        }
+    },
+    liveScript: {
+        path: "mode/livescript.js",
+        url: "https://raw.githubusercontent.com/gkz/LiveScript/master/lib/mode-ls.js"        
+    },
     coffee: {
         fetch: function(){
             var rootHref = "https://raw.github.com/jashkenas/coffee-script/master/";
@@ -184,7 +204,24 @@ var deps = {
                 });
             }
         }
-    }
+    },
+    xmldom: {
+        fetch: function() {
+            var rootHref = "https://raw.githubusercontent.com/iDeBugger/xmldom/master/"
+            var fileMap = {
+               "sax.js": "mode/xml/sax.js",
+               "dom-parser.js": "mode/xml/dom-parser.js",
+               "dom.js": "mode/xml/dom.js"
+            };
+            async.forEach(Object.keys(fileMap), function(x, next) {
+                download(rootHref + x, function(e, d) {
+                    fs.writeFile(rootDir + fileMap[x], d, next)
+                })
+            }, function() {
+                console.log("XmlDOM updating done")
+            });
+        }
+    },
 };
 
 var download = function(href, callback) {
diff --git a/version.js b/version.js
index dce117ae..eaf1e5fe 100755
--- a/version.js
+++ b/version.js
@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 var x;
-eval("x= " + require("fs").readFileSync(__dirname + "/package.json"))
-console.log(x.version)
\ No newline at end of file
+x = require('./package');
+console.log(x.version)