* Bug 13796 fixed: tbx_generate_pofile() failed
[scilab.git] / scilab / modules / modules_manager / help / en_US / utils / tbx_generate_pofile.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) INRIA
5  * Copyright (C) 2016 - Samuel GOUGEON
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:ns5="http://www.w3.org/1999/xhtml"
19           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
20           xmlns:scilab="http://www.scilab.org" xml:id="tbx_generate_pofile" xml:lang="en">
21     <refnamediv>
22         <refname>tbx_generate_pofile</refname>
23         <refpurpose>Extract localized strings from toolbox sources (toolbox compilation process)</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Syntax</title>
27         <synopsis>
28             pofile = tbx_generate_pofile()
29             pofile = tbx_generate_pofile(tbx_path)
30             pofile = tbx_generate_pofile(tbx_name)             // obsolete
31             pofile = tbx_generate_pofile(tbx_name, tbx_path)   // obsolete
32         </synopsis>
33     </refsynopsisdiv>
34     <refsection role="parameters">
35         <title>Arguments</title>
36         <variablelist>
37             <varlistentry>
38                 <term>tbx_path</term>
39                 <listitem>
40                     <para>path of the toolbox, use to locate files to compile.</para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>tbx_name (obsolete)</term>
45                 <listitem>
46                     <para>name of the toolbox, use to name localization files and domain.</para>
47                     <warning>
48                        <varname>tbx_name</varname> is now retrieved as the basename of the file
49                        <literal>tbx_path/etc/*.start</literal>. This file must exist, even if it is empty.
50                     </warning>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>pofile</term>
55                 <listitem>
56                     <para>return the generated po file path.</para>
57                 </listitem>
58             </varlistentry>
59         </variablelist>
60     </refsection>
61     <refsection role="examples">
62         <title>Examples</title>
63         <programlisting role="example"><![CDATA[
64 path = TMPDIR + "/example";
65 copyfile(SCI+"/contrib/toolbox_skeleton", path);
66 mdelete(path+"/locales/*");
67
68 tbx_generate_pofile(path);
69 edit(path+"/locales/en_US.po")
70  ]]></programlisting>
71     </refsection>
72     <refsection role="see also">
73         <title>See also</title>
74         <simplelist type="inline">
75             <member>
76                 <link linkend="tbx_build_localization">tbx_build_localization</link>
77             </member>
78             <member>
79                 <link linkend="addlocalizationdomain">addlocalizationdomain</link>
80             </member>
81         </simplelist>
82     </refsection>
83     <refsection role="history">
84         <title>History</title>
85         <revhistory>
86             <revision>
87                 <revnumber>5.5.0</revnumber>
88                 <revdescription>Function tbx_generate_pofile added.</revdescription>
89             </revision>
90             <revision>
91                 <revnumber>6.0.0</revnumber>
92                 <revdescription>tbx_name declared obsolete. It is no longer required.</revdescription>
93             </revision>
94             <revision>
95                 <revnumber>6.0.1</revnumber>
96                 <revdescription>
97                     <para>_() and gettext() references are now detected.</para>
98                     <para>Litteral double '' are now simplified in the msgid.</para>
99                     <para>Files paths in comments are no longer absolute and refer to the toolbox root.</para>
100                 </revdescription>
101             </revision>
102         </revhistory>
103     </refsection>
104 </refentry>