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

« back to all changes in this revision

Viewing changes to modules/atoms/help/en_US/atomsAutoload.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:
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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="atomsAutoload">
14
 
  <refnamediv>
15
 
    <refname>atomsAutoload</refname>
16
 
    <refpurpose>Load the modules marked as "autoload"</refpurpose>
17
 
  </refnamediv>
18
 
  <!-- ===================================================================== -->
19
 
  <!-- Calling Sequence -->
20
 
  <!-- ===================================================================== -->
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>
24
 
      modules = atomsAutoload()
25
 
    </synopsis>
26
 
  </refsynopsisdiv>
27
 
  <!-- ===================================================================== -->
28
 
  <!-- Parameters -->
29
 
  <!-- ===================================================================== -->
30
 
  <refsection>
31
 
    <title>Arguments</title>
32
 
    <variablelist>
33
 
      <varlistentry>
34
 
        <term>modules</term>
35
 
        <listitem>
36
 
          <para>
37
 
            4xn character string matrix:
38
 
          </para>
39
 
          <informaltable border="1">
40
 
            <!-- Module's technical name -->
41
 
            <tr>
42
 
              <td>
43
 
                <emphasis>1st Col.</emphasis>
44
 
              </td>
45
 
              <td>
46
 
                <emphasis role="strong">Module's technical name</emphasis>
47
 
              </td>
48
 
            </tr>
49
 
            <!-- Module's version -->
50
 
            <tr>
51
 
              <td>
52
 
                <emphasis>2nd Col.</emphasis>
53
 
              </td>
54
 
              <td>
55
 
                <emphasis role="strong">Module's version</emphasis>
56
 
              </td>
57
 
            </tr>
58
 
            <!-- Module's Installed Section -->
59
 
            <tr>
60
 
              <td>
61
 
                <emphasis>3rd Col.</emphasis>
62
 
              </td>
63
 
              <td>
64
 
                <emphasis role="strong">Module's installed section</emphasis>
65
 
              </td>
66
 
            </tr>
67
 
            <!-- Autoload Installation Path -->
68
 
            <tr>
69
 
              <td>
70
 
                <emphasis>4th Col.</emphasis>
71
 
              </td>
72
 
              <td>
73
 
                <emphasis role="strong">Module's installation path</emphasis>
74
 
              </td>
75
 
            </tr>
76
 
          </informaltable>
77
 
        </listitem>
78
 
      </varlistentry>
79
 
    </variablelist>
80
 
  </refsection>
81
 
  <!-- ===================================================================== -->
82
 
  <!-- Description -->
83
 
  <!-- ===================================================================== -->
84
 
  <refsection>
85
 
    <title>Description</title>
86
 
    <para>
87
 
      <literal>atomsAutoload</literal> returns the list of modules registered to autoload
88
 
    </para>
89
 
  </refsection>
90
 
  <!-- ===================================================================== -->
91
 
  <!-- Examples -->
92
 
  <!-- ===================================================================== -->
93
 
  <refsection>
94
 
    <title>Examples</title>
95
 
    <programlisting role="example"><![CDATA[
 
14
    <refnamediv>
 
15
        <refname>atomsAutoload</refname>
 
16
        <refpurpose>Load the modules marked as "autoload"</refpurpose>
 
17
    </refnamediv>
 
18
    <!-- ===================================================================== -->
 
19
    <!-- Calling Sequence -->
 
20
    <!-- ===================================================================== -->
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>
 
24
            modules = atomsAutoload()
 
25
        </synopsis>
 
26
    </refsynopsisdiv>
 
27
    <!-- ===================================================================== -->
 
28
    <!-- Parameters -->
 
29
    <!-- ===================================================================== -->
 
30
    <refsection>
 
31
        <title>Arguments</title>
 
32
        <variablelist>
 
33
            <varlistentry>
 
34
                <term>modules</term>
 
35
                <listitem>
 
36
                    <para>
 
37
                        4xn character string matrix:
 
38
                    </para>
 
39
                    <informaltable border="1">
 
40
                        <!-- Module's technical name -->
 
41
                        <tr>
 
42
                            <td>
 
43
                                <emphasis>1st Col.</emphasis>
 
44
                            </td>
 
45
                            <td>
 
46
                                <emphasis role="strong">Module's technical name</emphasis>
 
47
                            </td>
 
48
                        </tr>
 
49
                        <!-- Module's version -->
 
50
                        <tr>
 
51
                            <td>
 
52
                                <emphasis>2nd Col.</emphasis>
 
53
                            </td>
 
54
                            <td>
 
55
                                <emphasis role="strong">Module's version</emphasis>
 
56
                            </td>
 
57
                        </tr>
 
58
                        <!-- Module's Installed Section -->
 
59
                        <tr>
 
60
                            <td>
 
61
                                <emphasis>3rd Col.</emphasis>
 
62
                            </td>
 
63
                            <td>
 
64
                                <emphasis role="strong">Module's installed section</emphasis>
 
65
                            </td>
 
66
                        </tr>
 
67
                        <!-- Autoload Installation Path -->
 
68
                        <tr>
 
69
                            <td>
 
70
                                <emphasis>4th Col.</emphasis>
 
71
                            </td>
 
72
                            <td>
 
73
                                <emphasis role="strong">Module's installation path</emphasis>
 
74
                            </td>
 
75
                        </tr>
 
76
                    </informaltable>
 
77
                </listitem>
 
78
            </varlistentry>
 
79
        </variablelist>
 
80
    </refsection>
 
81
    <!-- ===================================================================== -->
 
82
    <!-- Description -->
 
83
    <!-- ===================================================================== -->
 
84
    <refsection>
 
85
        <title>Description</title>
 
86
        <para>
 
87
            <literal>atomsAutoload</literal> returns the list of modules registered to autoload
 
88
        </para>
 
89
    </refsection>
 
90
    <!-- ===================================================================== -->
 
91
    <!-- Examples -->
 
92
    <!-- ===================================================================== -->
 
93
    <refsection>
 
94
        <title>Examples</title>
 
95
        <programlisting role="example"><![CDATA[
96
96
atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
97
97
atomsInstall("toolbox_1");
98
98
 
99
99
atomsAutoload()
100
100
 ]]></programlisting>
101
 
  </refsection>
102
 
  <!-- ===================================================================== -->
103
 
  <!-- See also -->
104
 
  <!-- ===================================================================== -->
105
 
  <refsection role="see also">
106
 
    <title>See Also</title>
107
 
    <simplelist type="inline">
108
 
      <member>
109
 
        <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
110
 
      </member>
111
 
      <member>
112
 
        <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
113
 
      </member>
114
 
    </simplelist>
115
 
  </refsection>
116
 
  <!-- ===================================================================== -->
117
 
  <!-- Authors -->
118
 
  <!-- ===================================================================== -->
 
101
    </refsection>
 
102
    <!-- ===================================================================== -->
 
103
    <!-- See also -->
 
104
    <!-- ===================================================================== -->
 
105
    <refsection role="see also">
 
106
        <title>See Also</title>
 
107
        <simplelist type="inline">
 
108
            <member>
 
109
                <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
 
110
            </member>
 
111
            <member>
 
112
                <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
 
113
            </member>
 
114
        </simplelist>
 
115
    </refsection>
 
116
    <!-- ===================================================================== -->
 
117
    <!-- Authors -->
 
118
    <!-- ===================================================================== -->
119
119
</refentry>