[doc] misc. fix & improvements
[scilab.git] / scilab / modules / localization / help / en_US / dgettext.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2007 - INRIA - Allan CORNET
5  * Copyright (C) 2007 - INRIA - Sylvestre LEDRU
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18         xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
19         xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
20         xml:lang="en" xml:id="dgettext">
21     <refnamediv>
22         <refname>dgettext</refname>
23         <refpurpose>
24             get text translated into the current locale and a specific domain
25             <emphasis role="bold">(obsolete)</emphasis>
26         </refpurpose>
27     </refnamediv>
28     <refsynopsisdiv>
29         <title>Syntax</title>
30         <synopsis>msg=dgettext(domain, myString)</synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Arguments</title>
34         <variablelist>
35             <varlistentry>
36                 <term>domain</term>
37                 <listitem>
38                     <para>a string, the name of the message domain</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>myString</term>
43                 <listitem>
44                     <para>a string, the message to be translated</para>
45                 </listitem>
46             </varlistentry>
47         </variablelist>
48     </refsection>
49     <refsection>
50         <title>Description</title>
51         <warning>
52             This function is obsolete and will be removed from Scilab 6.1.
53             Please use <literal>gettext(domain, string)</literal> instead.
54         </warning>
55         <para>
56             <literal>dgettext</literal> gets the translation of a string <literal>myString</literal>
57             to the current locale in a specified message domain <literal>domain</literal>.
58         </para>
59     </refsection>
60     <refsection>
61         <title>Examples</title>
62         <programlisting role="example"><![CDATA[
63 dgettext('scilab','Startup execution:')
64  ]]></programlisting>
65     </refsection>
66     <refsection role="see also">
67         <title>See also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="gettext">gettext</link>
71             </member>
72             <member>
73                 <link linkend="_">_</link>
74             </member>
75         </simplelist>
76     </refsection>
77     <refsection role="history">
78         <title>History</title>
79         <revhistory>
80             <revision>
81                 <revnumber>6.0.1</revnumber>
82                 <revdescription>
83                     dgettext() is declared obsolete, for removal from Scilab 6.1.
84                 </revdescription>
85             </revision>
86         </revhistory>
87     </refsection>
88 </refentry>