{ "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xpath-full-text-10/\">XQuery and XPath Full Text 1.0 specification</a>\n as well as instructions for building an installing a thesaurus,\n see the <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://zorba.io/documentation/latest/zorba/architecture/ft_intro\">Full Text Thesaurus documentation</a>.\n <h2 xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">Notes on languages</h2>\n To refer to particular human languages,\n uses either the\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://en.wikipedia.org/wiki/ISO_639-1\">ISO 639-1</a>\n or\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://en.wikipedia.org/wiki/ISO_639-2\">ISO 639-2</a>\n languages codes.\n Note that only a subset of the\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">complete list of language codes</a>\n are supported and not every function supports the same subset.\n <p xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"/>\n Most functions in this module take a language as a parameter\n using the\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>\n XML schema data type.\n <h2 xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">Notes on stemming</h2>\n The <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">stem()</code> functions return the\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://en.wikipedia.org/wiki/Word_stem\">stem</a>\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 <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">stem()</code>\n functions against a non-stemmed string,\n for example:\n <pre xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n  if ( ft:stem( \"apples\" ) eq \"apple\" )             ** WRONG **\n </pre>\n Instead do:\n <pre xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n  if ( ft:stem( \"apples\" ) eq ft:stem( \"apple\" ) )  ** CORRECT **\n </pre>\n <h2 xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">Notes on the thesaurus</h2>\n The <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">thesaurus-lookup()</code> functions have \"levels\"\n and \"relationship\" parameters.\n The values for these are implementation-defined.\n The default implementation uses the\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://wordnet.princeton.edu/\">WordNet lexical database</a>,\n version 3.0.\n <p xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"/>\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 &gt; finch &gt; oscine &gt; passerine &gt; bird &gt; vertebrate).\n <p xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"/>\n When using the WordNet implementation,\n all of the relationships (and their abbreviations)\n specified by\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=7776\">ISO 2788</a>\n and\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.niso.org/kst/reports/standards?step=2&amp;gid=&amp;project_key=7cc9b583cb5a62e8c15d3099e0bb46bbae9cf38a\">ANSI/NISO Z39.19-2005</a>\n with the exceptions of \"HN\" (history note)\n and \"X SN\" (see scope note for) are supported.\n These relationships are:\n  <table xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n    <tr>\n      <th>Rel.</th>\n      <th>Meaning</th>\n      <th>WordNet Rel.</th>\n    </tr>\n    <tr>\n      <td>BT</td>\n      <td>broader term</td>\n      <td>hypernym</td>\n    </tr>\n    <tr>\n      <td>BTG</td>\n      <td>broader term generic</td>\n      <td>hypernym</td>\n    </tr>\n    <tr>\n      <td>BTI</td>\n      <td>broader term instance</td>\n      <td>instance hypernym</td>\n    </tr>\n    <tr>\n      <td>BTP</td>\n      <td>broader term partitive</td>\n      <td>part meronym</td>\n    </tr>\n    <tr>\n      <td>NT</td>\n      <td>narrower term</td>\n      <td>hyponym</td>\n    </tr>\n    <tr>\n      <td>NTG</td>\n      <td>narrower term generic</td>\n      <td>hyponym</td>\n    </tr>\n    <tr>\n      <td>NTI</td>\n      <td>narrower term instance</td>\n      <td>instance hyponym</td>\n    </tr>\n    <tr>\n      <td>NTP</td>\n      <td>narrower term partitive</td>\n      <td>part holonym</td>\n    </tr>\n    <tr>\n      <td>RT</td>\n      <td>related term</td>\n      <td>also see</td>\n    </tr>\n    <tr>\n      <td>SN</td>\n      <td>scope note</td>\n      <td>n/a</td>\n    </tr>\n    <tr>\n      <td>TT</td>\n      <td>top term</td>\n      <td>hypernym</td>\n    </tr>\n    <tr>\n      <td>UF</td>\n      <td>non-preferred term</td>\n      <td>n/a</td>\n    </tr>\n    <tr>\n      <td>USE</td>\n      <td>preferred term</td>\n      <td>n/a</td>\n    </tr>\n  </table>\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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=7776\">ISO 2788</a>\n and\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.niso.org/kst/reports/standards?step=2&amp;gid=&amp;project_key=7cc9b583cb5a62e8c15d3099e0bb46bbae9cf38a\">ANSI/NISO Z39.19-2005</a>\n relationships,\n All of the relationships offered by WordNet are also supported.\n These relationships are:\n  <table xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" class=\"ft_rels\">\n    <tr>\n      <th>Relationship</th>\n      <th>Meaning</th>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">also see</td>\n      <td>\n        A word that is related to another,\n        e.g., for \"varnished\" (furniture)\n        one should <em>also see</em> \"finished.\"\n      </td>\n    </tr>\n    <tr>\n      <td>antonym</td>\n      <td>\n        A word opposite in meaning to another,\n        e.g., \"light\" is an <em>antonym</em> for \"heavy.\"\n      </td>\n    </tr>\n    <tr>\n      <td>attribute</td>\n      <td>\n        A noun for which adjectives express values,\n        e.g., \"weight\" is an <em>attribute</em>\n        for which the adjectives \"light\" and \"heavy\"\n        express values.\n      </td>\n    </tr>\n    <tr>\n      <td>cause</td>\n      <td>\n        A verb that causes another,\n        e.g., \"show\" is a <em>cause</em> of \"see.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">derivationally related form</td>\n      <td>\n        A word that is derived from a root word,\n        e.g., \"metric\" is a <em>derivationally related form</em> of \"meter.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">derived from adjective</td>\n      <td>\n        An adverb that is derived from an adjective,\n        e.g., \"correctly\" is <em>derived from the adjective</em> \"correct.\"\n      </td>\n    </tr>\n    <tr>\n      <td>entailment</td>\n      <td>\n        A verb that presupposes another,\n        e.g., \"snoring\" <em>entails</em> \"sleeping.\"\n      </td>\n    </tr>\n    <tr>\n      <td>hypernym</td>\n      <td>\n        A word with a broad meaning that more specific words fall under,\n        e.g., \"meal\" is a <em>hypernym</em> of \"breakfast.\"\n      </td>\n    </tr>\n    <tr>\n      <td>hyponym</td>\n      <td>\n        A word of more specific meaning than a general term applicable to it,\n        e.g., \"breakfast\" is a <em>hyponym</em> of \"meal.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">instance hypernym</td>\n      <td>\n        A word that denotes a category of some specific instance,\n        e.g., \"author\" is an <em>instance hypernym</em> of \"Asimov.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">instance hyponym</td>\n      <td>\n        A term that donotes a specific instance of some general category,\n        e.g., \"Asimov\" is an <em>instance hyponym</em> of \"author.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">member holonym</td>\n      <td>\n        A word that denotes a collection of individuals,\n        e.g., \"faculty\" is a <em>member holonym</em> of \"professor.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">member meronym</td>\n      <td>\n        A word that denotes a member of a larger group,\n        e.g., a \"person\" is a <em>member meronym</em> of a \"crowd.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">part holonym</td>\n      <td>\n        A word that denotes a larger whole comprised of some part,\n        e.g., \"car\" is a <em>part holonym</em> of \"engine.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">part meronym</td>\n      <td>\n        A word that denotes a part of a larger whole,\n        e.g., an \"engine\" is <em>part meronym</em> of a \"car.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">participle of verb</td>\n      <td>\n        An adjective that is the participle of some verb,\n        e.g., \"breaking\" is the <em>participle of the verb</em> \"break.\"\n      </td>\n    </tr>\n    <tr>\n      <td>pertainym</td>\n      <td>\n        An adjective that classifies its noun,\n        e.g., \"musical\" is a <em>pertainym</em> in \"musical instrument.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">similar to</td>\n      <td>\n        Similar, though not necessarily interchangeable, adjectives.\n        For example, \"shiny\" is <em>similar to</em> \"bright\",\n        but they have subtle differences.\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">substance holonym</td>\n      <td>\n        A word that denotes a larger whole containing some constituent\n        substance, e.g., \"bread\" is a <em>substance holonym</em> of \"flour.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">substance meronym</td>\n      <td>\n        A word that denotes a constituant substance of some larger whole,\n        e.g., \"flour\" is a <em>substance meronym</em> of \"bread.\"\n      </td>\n    </tr>\n    <tr>\n      <td nowrap=\"nowrap\">verb group</td>\n      <td>\n        A verb that is a member of a group of similar verbs,\n        e.g., \"live\" is in the <em>verb group</em>\n        of \"dwell\", \"live\", \"inhabit\", etc.\n      </td>\n    </tr>\n  </table>\n <h2 xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">Notes on tokenization</h2>\n For general information about the implementation of tokenization,\n including what constitutes a token,\n see the <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://zorba.io/pages/3.0/zorba/ft_tokenizer\">Full Text Tokenizer</a> documentation.\n", "sees" : [  ], "authors" : [ "<xqdoc:author xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">Paul J. Lucas</xqdoc:author>" ], "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" : [ { "arity" : 0, "name" : "current-compare-options", "qname" : "ft:current-compare-options", "signature" : "() as object() external", "description" : " Gets the current compare options.\n", "summary" : "<p> Gets the current compare options.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "said compare options." }, "errors" : [  ] }, { "arity" : 0, "name" : "current-lang", "qname" : "ft:current-lang", "signature" : "() as xs:language external", "description" : " Gets the current\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>:\n either the language specified by the\n <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"><a href=\"http://www.w3.org/TR/xpath-full-text-10/#doc-xquery10-FTOptionDecl\">declare ft-option using</a>\n <a href=\"http://www.w3.org/TR/xpath-full-text-10/#ftlanguageoption\">language</a></code>\n statement (if any)\n or the one returned by <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">ft:host-lang()</code> (if none).\n", "summary" : "<p> 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).</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:language", "description" : "said language." }, "errors" : [  ] }, { "arity" : 0, "name" : "host-lang", "qname" : "ft:host-lang", "signature" : "() as xs:language external", "description" : " Gets the host's current\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>.\n The \"host\" is the computer on which the software is running.\n The host's current language is obtained as follows:\n  <ul xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n    <li>\n      For *nix systems:\n      <ol>\n        <li>\n          If <a ref=\"http://www.cplusplus.com/reference/clibrary/clocale/setlocale/\"><code>setlocale</code>(3)</a> returns non-null,\n          the language corresponding to that locale is used.\n        </li>\n        <li>\n          Else, if the <code>LANG</code> environment variable is set,\n          that language is ued.\n        </li>\n        <li>\n          Otherwise, there is no default language.\n        </li>\n      </ol>\n    </li>\n    <li>\n      For Windows systems,\n      the language corresponding to the locale returned by the\n      <a href=\"http://msdn.microsoft.com/en-us/library/windows/desktop/dd318101(v=vs.85).aspx\"><code>GetLocaleInfo()</code></a>\n      function is used.\n    </li>\n  </ul>\n", "summary" : "<p> Gets the host's current\n  language .</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "xs:language", "description" : "said language." }, "errors" : [  ] }, { "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>\n is supported for stemming.\n", "summary" : "<p> Checks whether the given\n  language \n is supported for stemming.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The language to check.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if the language is supported." }, "errors" : [  ] }, { "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>\n is supported for stop words.\n", "summary" : "<p> Checks whether the given\n  language \n is supported for stop words.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The language to check.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if the language is supported." }, "errors" : [  ] }, { "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" : "<p> Checks whether the given word is a stop-word.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The word to check. The word's <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one returned by <code>ft:current-lang()</code>.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$word</code> is a stop-word." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>" ] }, { "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" : "<p> Checks whether the given word is a stop-word.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The word to check.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$word</code>.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$word</code> is a stop-word." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>" ] }, { "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>\n is supported for look-up using the default thesaurus.\n", "summary" : "<p> Checks whether the given\n  language \n is supported for look-up using the default thesaurus.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The language to check.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if the language is supported." }, "errors" : [  ] }, { "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>\n is supported for look-up using the thesaurus specified by the given URI.\n", "summary" : "<p> Checks whether the given\n  language \n is supported for look-up using the thesaurus specified by the given URI.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URI specifying the thesaurus to use.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The language to check.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if the language is supported." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0018 if <code>$uri</code> refers to a thesaurus that is not found in the statically known thesauri.</xqdoc:error>" ] }, { "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>\n is supported for tokenization.\n", "summary" : "<p> Checks whether the given\n  language \n is supported for tokenization.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The language to check.</div>" } ], "returns" : { "type" : "xs:boolean", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">true</code> only if the language is supported." }, "errors" : [  ] }, { "arity" : 1, "name" : "stem", "qname" : "ft:stem", "signature" : "($word as xs:string) as xs:string external", "description" : " Stems the given word.\n", "summary" : "<p> Stems the given word.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The word to stem. The word's <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one returned by <code>ft:current-lang()</code>.</div>" } ], "returns" : { "type" : "xs:string", "description" : "the stem of <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$word</code>." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>" ] }, { "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" : "<p> Stems the given word.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "word", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The word to stem.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$word</code>.</div>" } ], "returns" : { "type" : "xs:string", "description" : "the stem of <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$word</code>." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>" ] }, { "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" : "<p> Strips all diacritical marks from all characters.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The string to strip diacritical marks from.</div>" } ], "returns" : { "type" : "xs:string", "description" : "<code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$string</code> with diacritical marks stripped." }, "errors" : [  ] }, { "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" : "<p> Looks-up the given phrase in the default thesaurus.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "phrase", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The phrase to look up. The phrase's <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one returned by <code>ft:current-lang()</code>.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$phrase</code> is found in the thesaurus or the empty sequence if not." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8403 if there was an error reading the thesaurus data.</xqdoc:error>" ] }, { "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" : "<p> Looks-up the given phrase in a thesaurus.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URI specifying the thesaurus to use.</div>" }, { "name" : "phrase", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The phrase to look up. The phrase's <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one the one returned by <code>ft:current-lang()</code>.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$phrase</code> is found in the thesaurus or the empty sequence if not." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is unsupported.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0018 if <code>$uri</code> refers to a thesaurus that is not found in the statically known thesauri.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0001 if the thesaurus data file could not be found.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0002 if the thesaurus data file is not a plain file.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8403 if there was an error reading the thesaurus data file.</xqdoc:error>" ] }, { "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" : "<p> Looks-up the given phrase in the thesaurus specified by the given URI.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URI specifying the thesaurus to use.</div>" }, { "name" : "phrase", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The phrase to look up.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$phrase</code>.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$phrase</code> is found in the thesaurus or the empty sequence if not." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0018 if <code>$uri</code> refers to a thesaurus that is not found in the statically known thesauri.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0001 if the thesaurus data file could not be found.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0002 if the thesaurus data file is not a plain file.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8403 if there was an error reading the thesaurus data file.</xqdoc:error>" ] }, { "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" : "<p> Looks-up the given phrase in a thesaurus.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URI specifying the thesaurus to use.</div>" }, { "name" : "phrase", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The phrase to look up.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$phrase</code>.</div>" }, { "name" : "relationship", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The relationship the results are to have to <code>$phrase</code>.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$phrase</code> is found in the thesaurus or the empty sequence if not." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0018 if <code>$uri</code> refers to a thesaurus that is not found in the statically known thesauri.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0001 if the thesaurus data file could not be found.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0002 if the thesaurus data file is not a plain file.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8403 if there was an error reading the thesaurus data file.</xqdoc:error>" ] }, { "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" : "<p> Looks-up the given phrase in a thesaurus.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URI specifying the thesaurus to use.</div>" }, { "name" : "phrase", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The phrase to look up.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$phrase</code>.</div>" }, { "name" : "relationship", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The relationship the results are to have to <code>$phrase</code>.</div>" }, { "name" : "level-least", "type" : "xs:integer", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The minimum number of levels within the thesaurus to be traversed.</div>" }, { "name" : "level-most", "type" : "xs:integer", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The maximum number of levels within the thesaurus to be traversed.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "the related phrases if <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$phrase</code> is found in the thesaurus or the empty sequence if not." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FOCA0003 if either <code>$level-least</code> or <code>$level-most</code> is either negative or too large.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0018 if <code>$uri</code> refers to a thesaurus that is not found in the statically known thesauri.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0001 if the thesaurus data file could not be found.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZOSE0002 if the thesaurus data file is not a plain file.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8401 if the thesaurus data file's version is not supported by the currently running version of the software.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8402 if the thesaurus data file's endianness does not match that of the CPU on which the software is currently running.</xqdoc:error>", "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr:ZXQP8403 if there was an error reading the thesaurus data file.</xqdoc:error>" ] }, { "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" : "<p> Tokenizes the given node and all of its descendants.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The node to tokenize. The node's default <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one returned by <code>ft:current-lang()</code>.</div>" } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>" ] }, { "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" : "<p> Tokenizes the given node and all of its decendants.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "node", "type" : "node()", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The node to tokenize.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The default <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$node</code>.</div>" } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>" ] }, { "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 <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$includes</code> (and all of its\n descendants) but excluding <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$excludes</code> (and all of its\n descendants), if any.\n", "summary" : "<p> Tokenizes the set of nodes comprising  $includes  (and all of its\n descendants) but excluding  $excludes  (and all of its\n descendants), if any.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "includes", "type" : "node()", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The set of nodes (and its descendants) to include. The default <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one returned by <code>ft:current-lang()</code>.</div>" }, { "name" : "excludes", "type" : "node()", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The set of nodes (and its descendants) to exclude.</div>" } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>" ] }, { "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 <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$includes</code> (and all of its\n descendants) but excluding <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">$excludes</code> (and all of its\n descendants), if any.\n", "summary" : "<p> Tokenizes the set of nodes comprising  $includes  (and all of its\n descendants) but excluding  $excludes  (and all of its\n descendants), if any.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "includes", "type" : "node()", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The set of nodes (and its descendants) to include.</div>" }, { "name" : "excludes", "type" : "node()", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The set of nodes (and its descendants) to exclude.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The default <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> for nodes.</div>" } ], "returns" : { "type" : "object()*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>" ] }, { "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" : "<p> Tokenizes the given string.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The string to tokenize. The string's <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> is assumed to be the one returned by <code>ft:current-lang()</code>.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>" ] }, { "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" : "<p> Tokenizes the given string.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "string", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The string to tokenize.</div>" }, { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The <a href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a> of <code>$string</code>.</div>" } ], "returns" : { "type" : "xs:string*", "description" : "a (possibly empty) sequence of tokens." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported.</xqdoc:error>" ] }, { "arity" : 0, "name" : "tokenizer-properties", "qname" : "ft:tokenizer-properties", "signature" : "() as object() external", "description" : " Gets properties of the tokenizer for the\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>\n returned by <code xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">ft:current-lang()</code>.\n", "summary" : "<p> Gets properties of the tokenizer for the\n  language \n returned by  ft:current-lang() .</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [  ], "returns" : { "type" : "object()", "description" : "said properties." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>ft:current-lang()</code> is not supported.</xqdoc:error>" ] }, { "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 <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\">language</a>.\n", "summary" : "<p> Gets properties of the tokenizer for the given\n  language .</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "lang", "type" : "xs:language", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The language of the tokenizer to get the properties of.</div>" } ], "returns" : { "type" : "object()", "description" : "said properties." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">err:FTST0009 if <code>$lang</code> is not supported. tokenization specifically.</xqdoc:error>" ] } ], "variables" : [ { "name" : "ft:LANG-DA", "type" : "xs:language", "description" : " Predeclared constant for the Danish\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-DE", "type" : "xs:language", "description" : " Predeclared constant for the German\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-EN", "type" : "xs:language", "description" : " Predeclared constant for the English\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-ES", "type" : "xs:language", "description" : " Predeclared constant for the Spanish\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-FI", "type" : "xs:language", "description" : " Predeclared constant for the Finnish\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-FR", "type" : "xs:language", "description" : " Predeclared constant for the French\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-HU", "type" : "xs:language", "description" : " Predeclared constant for the Hungarian\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-IT", "type" : "xs:language", "description" : " Predeclared constant for the Italian\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-NL", "type" : "xs:language", "description" : " Predeclared constant for the Dutch\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-NO", "type" : "xs:language", "description" : " Predeclared constant for the Norwegian\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-PT", "type" : "xs:language", "description" : " Predeclared constant for the Portuguese\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-RO", "type" : "xs:language", "description" : " Predeclared constant for the Romanian\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-RU", "type" : "xs:language", "description" : " Predeclared constant for the Russian\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-SV", "type" : "xs:language", "description" : " Predeclared constant for the Swedish\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" }, { "name" : "ft:LANG-TR", "type" : "xs:language", "description" : " Predeclared constant for the Turkish\n <a xmlns:xqdoc=\"http://www.xqdoc.org/1.0\" href=\"http://www.w3.org/TR/xmlschema-2/#language\"><code>xs:language</code></a>.\n" } ] }