home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / share / gnome / help / gnome-doc-xslt / C / gettext.xml < prev    next >
Encoding:
Text File  |  2006-08-07  |  14.0 KB  |  570 lines
  1. <section id="section-gettext">
  2.   <title>Gettext</title>
  3.   <variablelist>
  4.     <title>Parameters</title>
  5.     <varlistentry>
  6.       <term>
  7.         <link linkend="param_l10n.locale">
  8.           <parameter>l10n.locale</parameter>
  9.         </link>
  10.       </term>
  11.       <listitem>
  12.         <para>
  13.     The top-level locale of the document
  14.   </para>
  15.       </listitem>
  16.     </varlistentry>
  17.     <varlistentry>
  18.       <term>
  19.         <link linkend="param_l10n.language">
  20.           <parameter>l10n.language</parameter>
  21.         </link>
  22.       </term>
  23.       <listitem>
  24.         <para>
  25.     The language part of the top-level locale of the document
  26.   </para>
  27.       </listitem>
  28.     </varlistentry>
  29.     <varlistentry>
  30.       <term>
  31.         <link linkend="param_l10n.region">
  32.           <parameter>l10n.region</parameter>
  33.         </link>
  34.       </term>
  35.       <listitem>
  36.         <para>
  37.     The region part of the top-level locale of the document
  38.   </para>
  39.       </listitem>
  40.     </varlistentry>
  41.     <varlistentry>
  42.       <term>
  43.         <link linkend="param_l10n.variant">
  44.           <parameter>l10n.variant</parameter>
  45.         </link>
  46.       </term>
  47.       <listitem>
  48.         <para>
  49.     The variant part of the top-level locale of the document
  50.   </para>
  51.       </listitem>
  52.     </varlistentry>
  53.     <varlistentry>
  54.       <term>
  55.         <link linkend="param_l10n.charset">
  56.           <parameter>l10n.charset</parameter>
  57.         </link>
  58.       </term>
  59.       <listitem>
  60.         <para>
  61.     The charset part of the top-level locale of the document
  62.   </para>
  63.       </listitem>
  64.     </varlistentry>
  65.   </variablelist>
  66.   <variablelist>
  67.     <title>Templates</title>
  68.     <varlistentry>
  69.       <term>
  70.         <link linkend="template_l10n.gettext">
  71.           <function role="template">l10n.gettext</function>
  72.         </link>
  73.       </term>
  74.       <listitem>
  75.         <para>
  76.     Look up a translated string
  77.   </para>
  78.       </listitem>
  79.     </varlistentry>
  80.     <varlistentry>
  81.       <term>
  82.         <link linkend="template_l10n.plural.form">
  83.           <function role="template">l10n.plural.form</function>
  84.         </link>
  85.       </term>
  86.       <listitem>
  87.         <para>
  88.     Extract the plural form string for a cardinality
  89.   </para>
  90.       </listitem>
  91.     </varlistentry>
  92.     <varlistentry>
  93.       <term>
  94.         <link linkend="template_l10n.direction">
  95.           <function role="template">l10n.direction</function>
  96.         </link>
  97.       </term>
  98.       <listitem>
  99.         <para>
  100.     Determine the text direction for the language of the document
  101.   </para>
  102.       </listitem>
  103.     </varlistentry>
  104.     <varlistentry>
  105.       <term>
  106.         <link linkend="template_l10n.language">
  107.           <function role="template">l10n.language</function>
  108.         </link>
  109.       </term>
  110.       <listitem>
  111.         <para>
  112.     Extract the language part of a locale
  113.   </para>
  114.       </listitem>
  115.     </varlistentry>
  116.     <varlistentry>
  117.       <term>
  118.         <link linkend="template_l10n.region">
  119.           <function role="template">l10n.region</function>
  120.         </link>
  121.       </term>
  122.       <listitem>
  123.         <para>
  124.     Extract the region part of a locale
  125.   </para>
  126.       </listitem>
  127.     </varlistentry>
  128.     <varlistentry>
  129.       <term>
  130.         <link linkend="template_l10n.variant">
  131.           <function role="template">l10n.variant</function>
  132.         </link>
  133.       </term>
  134.       <listitem>
  135.         <para>
  136.     Extract the variant part of a locale
  137.   </para>
  138.       </listitem>
  139.     </varlistentry>
  140.     <varlistentry>
  141.       <term>
  142.         <link linkend="template_l10n.charset">
  143.           <function role="template">l10n.charset</function>
  144.         </link>
  145.       </term>
  146.       <listitem>
  147.         <para>
  148.     Extract the charset part of a locale
  149.   </para>
  150.       </listitem>
  151.     </varlistentry>
  152.   </variablelist>
  153.   <refentry id="param_l10n.locale">
  154.     <indexterm>
  155.       <primary>l10n.locale</primary>
  156.     </indexterm>
  157.     <refnamediv>
  158.       <refname>l10n.locale</refname>
  159.       <refpurpose>
  160.     The top-level locale of the document
  161.   </refpurpose>
  162.     </refnamediv>
  163.     <refsection>
  164.       <title>Description</title>
  165.       <para>This parameter has no description</para>
  166.     </refsection>
  167.   </refentry>
  168.   <refentry id="param_l10n.language">
  169.     <indexterm>
  170.       <primary>l10n.language</primary>
  171.     </indexterm>
  172.     <refnamediv>
  173.       <refname>l10n.language</refname>
  174.       <refpurpose>
  175.     The language part of the top-level locale of the document
  176.   </refpurpose>
  177.     </refnamediv>
  178.     <refsection>
  179.       <title>Description</title>
  180.       <para>This parameter has no description</para>
  181.     </refsection>
  182.   </refentry>
  183.   <refentry id="param_l10n.region">
  184.     <indexterm>
  185.       <primary>l10n.region</primary>
  186.     </indexterm>
  187.     <refnamediv>
  188.       <refname>l10n.region</refname>
  189.       <refpurpose>
  190.     The region part of the top-level locale of the document
  191.   </refpurpose>
  192.     </refnamediv>
  193.     <refsection>
  194.       <title>Description</title>
  195.       <para>This parameter has no description</para>
  196.     </refsection>
  197.   </refentry>
  198.   <refentry id="param_l10n.variant">
  199.     <indexterm>
  200.       <primary>l10n.variant</primary>
  201.     </indexterm>
  202.     <refnamediv>
  203.       <refname>l10n.variant</refname>
  204.       <refpurpose>
  205.     The variant part of the top-level locale of the document
  206.   </refpurpose>
  207.     </refnamediv>
  208.     <refsection>
  209.       <title>Description</title>
  210.       <para>This parameter has no description</para>
  211.     </refsection>
  212.   </refentry>
  213.   <refentry id="param_l10n.charset">
  214.     <indexterm>
  215.       <primary>l10n.charset</primary>
  216.     </indexterm>
  217.     <refnamediv>
  218.       <refname>l10n.charset</refname>
  219.       <refpurpose>
  220.     The charset part of the top-level locale of the document
  221.   </refpurpose>
  222.     </refnamediv>
  223.     <refsection>
  224.       <title>Description</title>
  225.       <para>This parameter has no description</para>
  226.     </refsection>
  227.   </refentry>
  228.   <refentry id="template_l10n.gettext">
  229.     <indexterm>
  230.       <primary>l10n.gettext</primary>
  231.     </indexterm>
  232.     <refnamediv>
  233.       <refname>l10n.gettext</refname>
  234.       <refpurpose>
  235.     Look up a translated string
  236.   </refpurpose>
  237.     </refnamediv>
  238.     <refsection>
  239.       <title>Parameters</title>
  240.       <variablelist>
  241.         <varlistentry>
  242.           <term>
  243.             <parameter>msgid</parameter>
  244.           </term>
  245.           <listitem>
  246.             <para>
  247.       The id of the string to look up, usually the string in the C locale
  248.     </para>
  249.           </listitem>
  250.         </varlistentry>
  251.         <varlistentry>
  252.           <term>
  253.             <parameter>lang</parameter>
  254.           </term>
  255.           <listitem>
  256.             <para>
  257.       The locale to use when looking up the translated string
  258.     </para>
  259.           </listitem>
  260.         </varlistentry>
  261.         <varlistentry>
  262.           <term>
  263.             <parameter>lang_language</parameter>
  264.           </term>
  265.           <listitem>
  266.             <para>
  267.       The language portion of the locale to use
  268.     </para>
  269.           </listitem>
  270.         </varlistentry>
  271.         <varlistentry>
  272.           <term>
  273.             <parameter>lang_region</parameter>
  274.           </term>
  275.           <listitem>
  276.             <para>
  277.       The region portion of the locale to use
  278.     </para>
  279.           </listitem>
  280.         </varlistentry>
  281.         <varlistentry>
  282.           <term>
  283.             <parameter>lang_variant</parameter>
  284.           </term>
  285.           <listitem>
  286.             <para>
  287.       The variant portion of the locale to use
  288.     </para>
  289.           </listitem>
  290.         </varlistentry>
  291.         <varlistentry>
  292.           <term>
  293.             <parameter>lang_charset</parameter>
  294.           </term>
  295.           <listitem>
  296.             <para>
  297.       The charset portion of the locale to use
  298.     </para>
  299.           </listitem>
  300.         </varlistentry>
  301.         <varlistentry>
  302.           <term>
  303.             <parameter>number</parameter>
  304.           </term>
  305.           <listitem>
  306.             <para>
  307.       The cardinality for plural-form lookups
  308.     </para>
  309.           </listitem>
  310.         </varlistentry>
  311.         <varlistentry>
  312.           <term>
  313.             <parameter>form</parameter>
  314.           </term>
  315.           <listitem>
  316.             <para>
  317.       The form name for plural-form lookups
  318.     </para>
  319.           </listitem>
  320.         </varlistentry>
  321.       </variablelist>
  322.     </refsection>
  323.   </refentry>
  324.   <refentry id="template_l10n.plural.form">
  325.     <indexterm>
  326.       <primary>l10n.plural.form</primary>
  327.     </indexterm>
  328.     <refnamediv>
  329.       <refname>l10n.plural.form</refname>
  330.       <refpurpose>
  331.     Extract the plural form string for a cardinality
  332.   </refpurpose>
  333.     </refnamediv>
  334.     <refsection>
  335.       <title>Parameters</title>
  336.       <variablelist>
  337.         <varlistentry>
  338.           <term>
  339.             <parameter>number</parameter>
  340.           </term>
  341.           <listitem>
  342.             <para>
  343.       The cardinality of plural form
  344.     </para>
  345.           </listitem>
  346.         </varlistentry>
  347.         <varlistentry>
  348.           <term>
  349.             <parameter>lang</parameter>
  350.           </term>
  351.           <listitem>
  352.             <para>
  353.       The locale to use when looking up the translated string
  354.     </para>
  355.           </listitem>
  356.         </varlistentry>
  357.         <varlistentry>
  358.           <term>
  359.             <parameter>lang_language</parameter>
  360.           </term>
  361.           <listitem>
  362.             <para>
  363.       The language portion of the locale to use
  364.     </para>
  365.           </listitem>
  366.         </varlistentry>
  367.         <varlistentry>
  368.           <term>
  369.             <parameter>lang_region</parameter>
  370.           </term>
  371.           <listitem>
  372.             <para>
  373.       The region portion of the locale to use
  374.     </para>
  375.           </listitem>
  376.         </varlistentry>
  377.         <varlistentry>
  378.           <term>
  379.             <parameter>lang_variant</parameter>
  380.           </term>
  381.           <listitem>
  382.             <para>
  383.       The variant portion of the locale to use
  384.     </para>
  385.           </listitem>
  386.         </varlistentry>
  387.         <varlistentry>
  388.           <term>
  389.             <parameter>lang_charset</parameter>
  390.           </term>
  391.           <listitem>
  392.             <para>
  393.       The charset portion of the locale to use
  394.     </para>
  395.           </listitem>
  396.         </varlistentry>
  397.       </variablelist>
  398.     </refsection>
  399.   </refentry>
  400.   <refentry id="template_l10n.direction">
  401.     <indexterm>
  402.       <primary>l10n.direction</primary>
  403.     </indexterm>
  404.     <refnamediv>
  405.       <refname>l10n.direction</refname>
  406.       <refpurpose>
  407.     Determine the text direction for the language of the document
  408.   </refpurpose>
  409.     </refnamediv>
  410.     <refsection>
  411.       <title>Parameters</title>
  412.       <variablelist>
  413.         <varlistentry>
  414.           <term>
  415.             <parameter>lang</parameter>
  416.           </term>
  417.           <listitem>
  418.             <para>
  419.       The locale to use when determining the direction
  420.     </para>
  421.           </listitem>
  422.         </varlistentry>
  423.         <varlistentry>
  424.           <term>
  425.             <parameter>lang_language</parameter>
  426.           </term>
  427.           <listitem>
  428.             <para>
  429.       The language portion of the locale to use
  430.     </para>
  431.           </listitem>
  432.         </varlistentry>
  433.         <varlistentry>
  434.           <term>
  435.             <parameter>lang_region</parameter>
  436.           </term>
  437.           <listitem>
  438.             <para>
  439.       The region portion of the locale to use
  440.     </para>
  441.           </listitem>
  442.         </varlistentry>
  443.         <varlistentry>
  444.           <term>
  445.             <parameter>lang_variant</parameter>
  446.           </term>
  447.           <listitem>
  448.             <para>
  449.       The variant portion of the locale to use
  450.     </para>
  451.           </listitem>
  452.         </varlistentry>
  453.         <varlistentry>
  454.           <term>
  455.             <parameter>lang_charset</parameter>
  456.           </term>
  457.           <listitem>
  458.             <para>
  459.       The charset portion of the locale to use
  460.     </para>
  461.           </listitem>
  462.         </varlistentry>
  463.       </variablelist>
  464.     </refsection>
  465.   </refentry>
  466.   <refentry id="template_l10n.language">
  467.     <indexterm>
  468.       <primary>l10n.language</primary>
  469.     </indexterm>
  470.     <refnamediv>
  471.       <refname>l10n.language</refname>
  472.       <refpurpose>
  473.     Extract the language part of a locale
  474.   </refpurpose>
  475.     </refnamediv>
  476.     <refsection>
  477.       <title>Parameters</title>
  478.       <variablelist>
  479.         <varlistentry>
  480.           <term>
  481.             <parameter>lang</parameter>
  482.           </term>
  483.           <listitem>
  484.             <para>
  485.       The locale string from which to extract the language string
  486.     </para>
  487.           </listitem>
  488.         </varlistentry>
  489.       </variablelist>
  490.     </refsection>
  491.   </refentry>
  492.   <refentry id="template_l10n.region">
  493.     <indexterm>
  494.       <primary>l10n.region</primary>
  495.     </indexterm>
  496.     <refnamediv>
  497.       <refname>l10n.region</refname>
  498.       <refpurpose>
  499.     Extract the region part of a locale
  500.   </refpurpose>
  501.     </refnamediv>
  502.     <refsection>
  503.       <title>Parameters</title>
  504.       <variablelist>
  505.         <varlistentry>
  506.           <term>
  507.             <parameter>lang</parameter>
  508.           </term>
  509.           <listitem>
  510.             <para>
  511.       The locale string from which to extract the region string
  512.     </para>
  513.           </listitem>
  514.         </varlistentry>
  515.       </variablelist>
  516.     </refsection>
  517.   </refentry>
  518.   <refentry id="template_l10n.variant">
  519.     <indexterm>
  520.       <primary>l10n.variant</primary>
  521.     </indexterm>
  522.     <refnamediv>
  523.       <refname>l10n.variant</refname>
  524.       <refpurpose>
  525.     Extract the variant part of a locale
  526.   </refpurpose>
  527.     </refnamediv>
  528.     <refsection>
  529.       <title>Parameters</title>
  530.       <variablelist>
  531.         <varlistentry>
  532.           <term>
  533.             <parameter>lang</parameter>
  534.           </term>
  535.           <listitem>
  536.             <para>
  537.       The locale string from which to extract the variant string
  538.     </para>
  539.           </listitem>
  540.         </varlistentry>
  541.       </variablelist>
  542.     </refsection>
  543.   </refentry>
  544.   <refentry id="template_l10n.charset">
  545.     <indexterm>
  546.       <primary>l10n.charset</primary>
  547.     </indexterm>
  548.     <refnamediv>
  549.       <refname>l10n.charset</refname>
  550.       <refpurpose>
  551.     Extract the charset part of a locale
  552.   </refpurpose>
  553.     </refnamediv>
  554.     <refsection>
  555.       <title>Parameters</title>
  556.       <variablelist>
  557.         <varlistentry>
  558.           <term>
  559.             <parameter>lang</parameter>
  560.           </term>
  561.           <listitem>
  562.             <para>
  563.       The locale string from which to extract the charset string
  564.     </para>
  565.           </listitem>
  566.         </varlistentry>
  567.       </variablelist>
  568.     </refsection>
  569.   </refentry>
  570. </section>