1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="xpf_lang">
<refmeta>
<refentrytitle>lang</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>lang</refname>
<refpurpose>Returns true if the language of context node matches given language name.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_lang">
<funcprototype id="xpf_proto_lang">
<funcdef>boolean <function>lang</function></funcdef>
<paramdef><parameter>lang_name</parameter> string</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_lang"><title>Description</title>
<para>
The lang function returns true or false depending on whether the language of
the context node as specified by xml:lang attributes is the same as or is a
sublanguage of the language specified by the argument string.
The language of the context node is determined by the value of the xml:lang
attribute on the context node, or,
if the context node has no xml:lang attribute,
by the value of the xml:lang attribute on the nearest ancestor of the context node that has an xml:lang attribute.
If there is no such attribute, then lang returns false.
If there is such an attribute, then lang returns true
if the attribute value is equal to the argument ignoring case,
or if there is some suffix starting with "-" such that the attribute value is equal to the argument ignoring that suffix of the attribute value and ignoring case.
</para></refsect1>
<refsect1 id="xpf_params_lang"><title>Parameters</title>
<refsect2><title>lang_name</title>
<para>Name of the language</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_lang"><title>Return Types</title><para>Boolean</para></refsect1>
<refsect1 id="xpf_examples_lang"><title>Examples</title>
<example id="xpf_ex_lang"><title></title>
<para>The expression lang("en") would return true if the context node is any of these five elements:</para>
<screen>
<para xml:lang="en"/>
<div xml:lang="en"><para/></div>
<para xml:lang="EN"/>
<para xml:lang="en-us"/>
</screen>
</example>
</refsect1>
<refsect1 id="xpf_seealso_lang"><title>See Also</title>
<para></para>
</refsect1>
</refentry>
|