← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/modules_manager/help/en_US/tbx_builder_help_lang.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/modules_manager/help/en_US/tbx_builder_help_lang.xml
11
11
 *
12
12
 -->
13
13
<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" version="5.0-subset Scilab" xml:id="tbx_builder_help_lang" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>tbx_builder_help_lang</refname>
16
 
    <refpurpose>Run build_help.sce script if it exists (toolbox compilation process)</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>
21
 
      tbx_builder_help_lang(lang)
22
 
      tbx_builder_help_lang(lang, help_path)
23
 
    </synopsis>
24
 
  </refsynopsisdiv>
25
 
  <refsection>
26
 
    <title>Arguments</title>
27
 
    <variablelist>
28
 
      <varlistentry>
29
 
        <term>lang</term>
30
 
        <listitem>
31
 
          <para>Language of help files to use ; the build_help.sce script will be searched in the subdirectory lang (e.g. en_US) of the help_path directory</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>help_path</term>
36
 
        <listitem>
37
 
          <para>Path to help directory ; in a normal toolbox it should be the directory containing the builder_help.sce script (which should be the script calling this function). Default is current directory.</para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
    </variablelist>
41
 
  </refsection>
42
 
  <refsection>
43
 
    <title>Examples</title>
44
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>tbx_builder_help_lang</refname>
 
16
        <refpurpose>Run build_help.sce script if it exists (toolbox compilation process)</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>
 
21
            tbx_builder_help_lang(lang)
 
22
            tbx_builder_help_lang(lang, help_path)
 
23
        </synopsis>
 
24
    </refsynopsisdiv>
 
25
    <refsection>
 
26
        <title>Arguments</title>
 
27
        <variablelist>
 
28
            <varlistentry>
 
29
                <term>lang</term>
 
30
                <listitem>
 
31
                    <para>Language of help files to use ; the build_help.sce script will be searched in the subdirectory lang (e.g. en_US) of the help_path directory</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>help_path</term>
 
36
                <listitem>
 
37
                    <para>Path to help directory ; in a normal toolbox it should be the directory containing the builder_help.sce script (which should be the script calling this function). Default is current directory.</para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
        </variablelist>
 
41
    </refsection>
 
42
    <refsection>
 
43
        <title>Examples</title>
 
44
        <programlisting role="example"><![CDATA[ 
45
45
// Recommended usage
46
46
tbx_builder_help_lang("en_US", get_absolute_file_path('builder_help.sce'))
47
47
 ]]></programlisting>
48
 
  </refsection>
49
 
  <refsection role="see also">
50
 
    <title>See Also</title>
51
 
    <simplelist type="inline">
52
 
      <member>
53
 
        <link linkend="tbx_builder_help">tbx_builder_help</link>
54
 
      </member>
55
 
      <member>
56
 
        <link linkend="tbx_build_help_loader">tbx_build_help_loader</link>
57
 
      </member>
58
 
      <member>
59
 
        <link linkend="tbx_build_help">tbx_build_help</link>
60
 
      </member>
61
 
    </simplelist>
62
 
  </refsection>
 
48
    </refsection>
 
49
    <refsection role="see also">
 
50
        <title>See Also</title>
 
51
        <simplelist type="inline">
 
52
            <member>
 
53
                <link linkend="tbx_builder_help">tbx_builder_help</link>
 
54
            </member>
 
55
            <member>
 
56
                <link linkend="tbx_build_help_loader">tbx_build_help_loader</link>
 
57
            </member>
 
58
            <member>
 
59
                <link linkend="tbx_build_help">tbx_build_help</link>
 
60
            </member>
 
61
        </simplelist>
 
62
    </refsection>
63
63
</refentry>