<?xml version="1.0" encoding="utf-8"?>
<section id="S__gettext">
  <title>Localized Strings</title>
  <remark>This needs documentation</remark>
  <variablelist>
    <title>Parameters</title>
    <varlistentry>
      <term>
        <link linkend="P__l10n_locale">
          <parameter>l10n.locale</parameter>
        </link>
      </term>
      <listitem>
        <para>The top-level locale of the document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__l10n_language">
          <parameter>l10n.language</parameter>
        </link>
      </term>
      <listitem>
        <para>The language part of the top-level locale of the document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__l10n_region">
          <parameter>l10n.region</parameter>
        </link>
      </term>
      <listitem>
        <para>The region part of the top-level locale of the document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__l10n_variant">
          <parameter>l10n.variant</parameter>
        </link>
      </term>
      <listitem>
        <para>The variant part of the top-level locale of the document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__l10n_charset">
          <parameter>l10n.charset</parameter>
        </link>
      </term>
      <listitem>
        <para>The charset part of the top-level locale of the document</para>
      </listitem>
    </varlistentry>
  </variablelist>
  <variablelist>
    <title>Modes</title>
    <varlistentry>
      <term>
        <link linkend="M__l10n_format_mode">
          <function>l10n.format.mode</function>
        </link>
      </term>
      <listitem>
        <para>FIXME</para>
      </listitem>
    </varlistentry>
  </variablelist>
  <variablelist>
    <title>Templates</title>
    <varlistentry>
      <term>
        <link linkend="T__l10n_gettext">
          <function>l10n.gettext</function>
        </link>
      </term>
      <listitem>
        <para>Looks up the translation for a string</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_plural_form">
          <function>l10n.plural.form</function>
        </link>
      </term>
      <listitem>
        <para>Extracts he plural form string for a given cardinality</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_direction">
          <function>l10n.direction</function>
        </link>
      </term>
      <listitem>
        <para>Determines the text direction for the language of the document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_align_start">
          <function>l10n.align.start</function>
        </link>
      </term>
      <listitem>
        <para>Determines the start alignment</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_align_end">
          <function>l10n.align.end</function>
        </link>
      </term>
      <listitem>
        <para>Determines the end alignment</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_arrow_previous">
          <function>l10n.arrow.previous</function>
        </link>
      </term>
      <listitem>
        <para>FIXME</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_arrow_next">
          <function>l10n.arrow.next</function>
        </link>
      </term>
      <listitem>
        <para>FIXME</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_language">
          <function>l10n.language</function>
        </link>
      </term>
      <listitem>
        <para>Extracts the langauge portion of a locale</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_region">
          <function>l10n.region</function>
        </link>
      </term>
      <listitem>
        <para>Extracts the region portion of a locale</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_variant">
          <function>l10n.variant</function>
        </link>
      </term>
      <listitem>
        <para>Extracts the variant portion of a locale</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__l10n_charset">
          <function>l10n.charset</function>
        </link>
      </term>
      <listitem>
        <para>Extracts the charset portion of a locale</para>
      </listitem>
    </varlistentry>
  </variablelist>
  <refentry id="P__l10n_locale">
    <indexterm>
      <primary>l10n.locale</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>l10n.locale</parameter>
      </refname>
      <refpurpose>The top-level locale of the document</refpurpose>
    </refnamediv>
    <refsection>
      <title>Description</title>
      <remark>This needs documentation</remark>
    </refsection>
  </refentry>
  <refentry id="P__l10n_language">
    <indexterm>
      <primary>l10n.language</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>l10n.language</parameter>
      </refname>
      <refpurpose>The language part of the top-level locale of the document</refpurpose>
    </refnamediv>
    <refsection>
      <title>Description</title>
      <remark>This needs documentation</remark>
    </refsection>
  </refentry>
  <refentry id="P__l10n_region">
    <indexterm>
      <primary>l10n.region</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>l10n.region</parameter>
      </refname>
      <refpurpose>The region part of the top-level locale of the document</refpurpose>
    </refnamediv>
    <refsection>
      <title>Description</title>
      <remark>This needs documentation</remark>
    </refsection>
  </refentry>
  <refentry id="P__l10n_variant">
    <indexterm>
      <primary>l10n.variant</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>l10n.variant</parameter>
      </refname>
      <refpurpose>The variant part of the top-level locale of the document</refpurpose>
    </refnamediv>
    <refsection>
      <title>Description</title>
      <remark>This needs documentation</remark>
    </refsection>
  </refentry>
  <refentry id="P__l10n_charset">
    <indexterm>
      <primary>l10n.charset</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>l10n.charset</parameter>
      </refname>
      <refpurpose>The charset part of the top-level locale of the document</refpurpose>
    </refnamediv>
    <refsection>
      <title>Description</title>
      <remark>This needs documentation</remark>
    </refsection>
  </refentry>
  <refentry id="M__l10n_format_mode">
    <indexterm>
      <primary>l10n.format.mode</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.format.mode</function>
      </refname>
      <refpurpose>FIXME</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>node</parameter>
          </term>
          <listitem>
            <para>The node being processed in the original document</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>string</parameter>
          </term>
          <listitem>
            <para>String content to use for certain message format nodes</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots and lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_gettext">
    <indexterm>
      <primary>l10n.gettext</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.gettext</function>
      </refname>
      <refpurpose>Looks up the translation for a string</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>msgid</parameter>
          </term>
          <listitem>
            <para>The id of the string to look up, often the string in the C locale</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to use when looking up the translated string</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_language</parameter>
          </term>
          <listitem>
            <para>The language portion of the <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_region</parameter>
          </term>
          <listitem>
            <para>The region portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_variant</parameter>
          </term>
          <listitem>
            <para>The variant portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_charset</parameter>
          </term>
          <listitem>
            <para>The charset portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>number</parameter>
          </term>
          <listitem>
            <para>The cardinality for plural-form lookups</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>form</parameter>
          </term>
          <listitem>
            <para>The form name for plural-form lookups</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_plural_form">
    <indexterm>
      <primary>l10n.plural.form</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.plural.form</function>
      </refname>
      <refpurpose>Extracts he plural form string for a given cardinality</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>number</parameter>
          </term>
          <listitem>
            <para>The cardinality of the plural form</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to use when looking up the translated string</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_language</parameter>
          </term>
          <listitem>
            <para>The language portion of the <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_region</parameter>
          </term>
          <listitem>
            <para>The region portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_variant</parameter>
          </term>
          <listitem>
            <para>The variant portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_charset</parameter>
          </term>
          <listitem>
            <para>The charset portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_direction">
    <indexterm>
      <primary>l10n.direction</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.direction</function>
      </refname>
      <refpurpose>Determines the text direction for the language of the document</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to use to determine the text direction</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_language</parameter>
          </term>
          <listitem>
            <para>The language portion of the <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_region</parameter>
          </term>
          <listitem>
            <para>The region portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_variant</parameter>
          </term>
          <listitem>
            <para>The variant portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <parameter>lang_charset</parameter>
          </term>
          <listitem>
            <para>The charset portion of <parameter>lang</parameter></para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_align_start">
    <indexterm>
      <primary>l10n.align.start</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.align.start</function>
      </refname>
      <refpurpose>Determines the start alignment</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>direction</parameter>
          </term>
          <listitem>
            <para>The text direction</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_align_end">
    <indexterm>
      <primary>l10n.align.end</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.align.end</function>
      </refname>
      <refpurpose>Determines the end alignment</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>direction</parameter>
          </term>
          <listitem>
            <para>The text direction</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_arrow_previous">
    <indexterm>
      <primary>l10n.arrow.previous</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.arrow.previous</function>
      </refname>
      <refpurpose>FIXME</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>direction</parameter>
          </term>
          <listitem>
            <para>The text direction</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_arrow_next">
    <indexterm>
      <primary>l10n.arrow.next</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.arrow.next</function>
      </refname>
      <refpurpose>FIXME</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>direction</parameter>
          </term>
          <listitem>
            <para>The text direction</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_language">
    <indexterm>
      <primary>l10n.language</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.language</function>
      </refname>
      <refpurpose>Extracts the langauge portion of a locale</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to extract the language from</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_region">
    <indexterm>
      <primary>l10n.region</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.region</function>
      </refname>
      <refpurpose>Extracts the region portion of a locale</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to extract the region from</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_variant">
    <indexterm>
      <primary>l10n.variant</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.variant</function>
      </refname>
      <refpurpose>Extracts the variant portion of a locale</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to extract the variant from</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
  <refentry id="T__l10n_charset">
    <indexterm>
      <primary>l10n.charset</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>l10n.charset</function>
      </refname>
      <refpurpose>Extracts the charset portion of a locale</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>lang</parameter>
          </term>
          <listitem>
            <para>The locale to extract the charset from</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Lots of documentation is needed</remark>
  </refsection>
  </refentry>
</section>
