summaryrefslogtreecommitdiff
path: root/modules/atoms/help/en_US/atomsLoad.xml
blob: 468ea8f2886abe731d7f218bc5d311a5f4bbb73b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 * Copyright (C) DIGITEO - 2012 - Allan CORNET
 *
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="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="atomsLoad" xml:lang="en">
    <refnamediv>
        <refname>atomsLoad</refname>
        <refpurpose>Load one or several external modules</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>
            result = atomsLoad(name)
            result = atomsLoad(name, version)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>name</term>
                <listitem>
                    <para>Matrix of strings: External module name</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>version</term>
                <listitem>
                    <para>Matrix of strings: External module version. This is an
                        optional parameter. If it's not defined, the most recent version of
                        the module is used.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>result</term>
                <listitem>
                    <para>4xn character string matrix:</para>
                    <informaltable border="1">
                        <!-- Technical name -->
                        <tr>
                            <td>
                                <emphasis>1st Col.</emphasis>
                            </td>
                            <td>
                                <emphasis role="strong">Technical name</emphasis>
                            </td>
                            <td/>
                        </tr>
                        <!-- Version -->
                        <tr>
                            <td>
                                <emphasis>2nd Col.</emphasis>
                            </td>
                            <td>
                                <emphasis role="strong">Version</emphasis>
                            </td>
                            <td/>
                        </tr>
                        <!-- Section -->
                        <tr>
                            <td>
                                <emphasis>3rd Col.</emphasis>
                            </td>
                            <td>
                                <emphasis role="strong">Installation section</emphasis>
                            </td>
                            <td>this parameter determines whether the module has been
                                installed for all users or only for the current user.
                            </td>
                        </tr>
                        <!-- Installation path -->
                        <tr>
                            <td>
                                <emphasis>4th Col.</emphasis>
                            </td>
                            <td>
                                <emphasis role="strong">Installation path</emphasis>
                            </td>
                            <td/>
                        </tr>
                    </informaltable>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>atomsLoad</literal> load one or more external
            modules.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example">atomsSetConfig("Verbose","True");
            atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
            atomsInstall(["toolbox_2" "1.0"]);
            atomsInstall(["toolbox_2" "2.0"]);
            
            atomsLoad(["toolbox_2" "1.0"]);
            t2_version()
            t2_function1()
            
            atomsRemove("toolbox_2"); 
        </programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="atomsIsLoaded">atomsIsLoaded</link>
            </member>
            <member>
                <link linkend="atomsGetLoaded">atomsGetLoaded</link>
            </member>
            <member>
                <link linkend="atomsGetLoaded">atomsInstall</link>
            </member>
        </simplelist>
    </refsection>
</refentry>