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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="tbx_generate_pofile" xml:lang="en">
  18     <refnamediv>
  19         <refname>tbx_generate_pofile</refname>
  20         <refpurpose>Extract localized strings from toolbox sources (toolbox compilation process)</refpurpose>
  21     </refnamediv>
  22     <refsynopsisdiv>
  23         <title>Syntax</title>
  24         <synopsis>
  25             pofile = tbx_generate_pofile()
  26             pofile = tbx_generate_pofile(tbx_path)
  27             pofile = tbx_generate_pofile(tbx_name)             // obsolete
  28             pofile = tbx_generate_pofile(tbx_name, tbx_path)   // obsolete
  29         </synopsis>
  30     </refsynopsisdiv>
  31     <refsection role="parameters">
  32         <title>Arguments</title>
  33         <variablelist>
  34             <varlistentry>
  35                 <term>tbx_path</term>
  36                 <listitem>
  37                     <para>path of the toolbox, use to locate files to compile.</para>
  38                 </listitem>
  39             </varlistentry>
  40             <varlistentry>
  41                 <term>tbx_name (obsolete)</term>
  42                 <listitem>
  43                     <para>name of the toolbox, use to name localization files and domain.</para>
  44                     <warning>
  45                        <varname>tbx_name</varname> is now retrieved as the basename of the file
  46                        <literal>tbx_path/etc/*.start</literal>. This file must exist, even if it is empty.
  47                     </warning>
  48                 </listitem>
  49             </varlistentry>
  50             <varlistentry>
  51                 <term>pofile</term>
  52                 <listitem>
  53                     <para>return the generated po file path.</para>
  54                 </listitem>
  55             </varlistentry>
  56         </variablelist>
  57     </refsection>
  58     <refsection role="examples">
  59         <title>Examples</title>
  60         <programlisting role="example"><![CDATA[
  61 tbx_generate_pofile("SCI/contrib/toolbox_skeleton")
  62  ]]></programlisting>
  63     </refsection>
  64     <refsection role="see also">
  65         <title>See also</title>
  66         <simplelist type="inline">
  67             <member>
  68                 <link linkend="tbx_build_localization">tbx_build_localization</link>
  69             </member>
  70         </simplelist>
  71     </refsection>
  72     <refsection role="history">
  73         <title>History</title>
  74         <revhistory>
  75             <revision>
  76                 <revnumber>5.5.0</revnumber>
  77                 <revdescription>Function tbx_generate_pofile added.</revdescription>
  78             </revision>
  79             <revision>
  80                 <revnumber>6.0.0</revnumber>
  81                 <revdescription>tbx_name declared obsolete. It is no longer required.</revdescription>
  82             </revision>
  83         </revhistory>
  84     </refsection>
  85 </refentry>