summaryrefslogtreecommitdiffstats
path: root/scilab/modules/development_tools
diff options
context:
space:
mode:
Diffstat (limited to 'scilab/modules/development_tools')
-rw-r--r--scilab/modules/development_tools/Makefile.in2
-rw-r--r--scilab/modules/development_tools/help/en_US/example_run.xml54
-rw-r--r--scilab/modules/development_tools/help/ja_JP/example_run.xml48
3 files changed, 96 insertions, 8 deletions
diff --git a/scilab/modules/development_tools/Makefile.in b/scilab/modules/development_tools/Makefile.in
index d04b3c0..0dae153 100644
--- a/scilab/modules/development_tools/Makefile.in
+++ b/scilab/modules/development_tools/Makefile.in
@@ -345,9 +345,11 @@ NMEDIT = @NMEDIT@
345OBJDUMP = @OBJDUMP@ 345OBJDUMP = @OBJDUMP@
346OBJEXT = @OBJEXT@ 346OBJEXT = @OBJEXT@
347OCAMLC = @OCAMLC@ 347OCAMLC = @OCAMLC@
348OCAMLCFLAGS = @OCAMLCFLAGS@
348OCAMLDEP = @OCAMLDEP@ 349OCAMLDEP = @OCAMLDEP@
349OCAMLLEX = @OCAMLLEX@ 350OCAMLLEX = @OCAMLLEX@
350OCAMLOPT = @OCAMLOPT@ 351OCAMLOPT = @OCAMLOPT@
352OCAMLOPTFLAGS = @OCAMLOPTFLAGS@
351OCAMLYACC = @OCAMLYACC@ 353OCAMLYACC = @OCAMLYACC@
352OPENMPI_CC = @OPENMPI_CC@ 354OPENMPI_CC = @OPENMPI_CC@
353OPENMPI_CFLAGS = @OPENMPI_CFLAGS@ 355OPENMPI_CFLAGS = @OPENMPI_CFLAGS@
diff --git a/scilab/modules/development_tools/help/en_US/example_run.xml b/scilab/modules/development_tools/help/en_US/example_run.xml
index fd04e5a..7c67bdf 100644
--- a/scilab/modules/development_tools/help/en_US/example_run.xml
+++ b/scilab/modules/development_tools/help/en_US/example_run.xml
@@ -13,7 +13,10 @@
13 * along with this program. 13 * along with this program.
14 * 14 *
15 --> 15 -->
16<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="example_run" xml:lang="en"> 16<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17 xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19 xmlns:scilab="http://www.scilab.org" xml:id="example_run" xml:lang="en">
17 <refnamediv> 20 <refnamediv>
18 <refname>example_run</refname> 21 <refname>example_run</refname>
19 <refpurpose>Launch the examples found in help pages.</refpurpose> 22 <refpurpose>Launch the examples found in help pages.</refpurpose>
@@ -35,14 +38,40 @@
35 <term>moduleNames</term> 38 <term>moduleNames</term>
36 <listitem> 39 <listitem>
37 <para> 40 <para>
38 a string or a string vector: the name(s) of the modules to test. Default value is the value returned by <link linkend="getmodules">getmodules()</link>. 41 a string or a vector of strings: references of the modules to test.
42 Each reference can be either of
43 <itemizedlist>
44 <listitem>
45 the technical name of a Scilab internal module, that is the name
46 of the root directory of the module.
47 </listitem>
48 <listitem>
49 the relative or absolute path of the root directory of the module.
50 This must be used for installed ATOMS modules or other external modules.
51 </listitem>
52 </itemizedlist>
53 By default, all Scilab internal modules are considered, as returned by
54 <link linkend="getmodules">getmodules()</link>.
55 </para>
56 <para>
57 The root directory of each targeted module must have a
58 <literal>./help</literal> subdirectory containing the XML source files of
59 help pages where examples to test are provided, gathered by languages as
60 in the source package of any standard module.
61 Example of the template toolbox_skeleton module:
62 <programlisting role="example">
63unix_w("dir /b /s """ + WSCI + "/contrib/toolbox_skeleton/help""")
64 </programlisting>
39 </para> 65 </para>
40 </listitem> 66 </listitem>
41 </varlistentry> 67 </varlistentry>
42 <varlistentry> 68 <varlistentry>
43 <term>functionNames</term> 69 <term>functionNames</term>
44 <listitem> 70 <listitem>
45 <para>a string or a string vector: the name(s) of the functions to test. If not given, all help pages of the module(s) will be tested.</para> 71 <para>
72 a string or a string vector: the name(s) of the functions to test.
73 If not given, all help pages of the module(s) will be tested.
74 </para>
46 </listitem> 75 </listitem>
47 </varlistentry> 76 </varlistentry>
48 <varlistentry> 77 <varlistentry>
@@ -72,7 +101,15 @@
72 <refsection> 101 <refsection>
73 <title>Description</title> 102 <title>Description</title>
74 <para> 103 <para>
75 This function extracts the examples given in help pages and run them using <link linkend="test_run">test_run</link>. 104 This function extracts the examples given in help pages and run them using
105 <link linkend="test_run">test_run</link>.
106 </para>
107 <para>
108 <warning>
109 When testing examples of any external module, it is mandatory to autoload the module
110 at Scilab startup. This can be achieved either by setting the ATOMS module as
111 autoloaded, or by loading the module through the user's startup file.
112 </warning>
76 </para> 113 </para>
77 </refsection> 114 </refsection>
78 <refsection> 115 <refsection>
@@ -92,6 +129,15 @@ end
92 <member> 129 <member>
93 <link linkend="test_run">test_run</link> 130 <link linkend="test_run">test_run</link>
94 </member> 131 </member>
132 <member>
133 <link linkend="bench_run">bench_run</link>
134 </member>
135 <member>
136 <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
137 </member>
138 <member>
139 <link linkend="startup">startup</link>
140 </member>
95 </simplelist> 141 </simplelist>
96 </refsection> 142 </refsection>
97 <refsection> 143 <refsection>
diff --git a/scilab/modules/development_tools/help/ja_JP/example_run.xml b/scilab/modules/development_tools/help/ja_JP/example_run.xml
index fd5ce31..fc4bb1e 100644
--- a/scilab/modules/development_tools/help/ja_JP/example_run.xml
+++ b/scilab/modules/development_tools/help/ja_JP/example_run.xml
@@ -13,7 +13,10 @@
13 * along with this program. 13 * along with this program.
14 * 14 *
15 --> 15 -->
16<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="example_run" xml:lang="ja"> 16<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17 xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19 xmlns:scilab="http://www.scilab.org" xml:id="example_run" xml:lang="ja">
17 <refnamediv> 20 <refnamediv>
18 <refname>example_run</refname> 21 <refname>example_run</refname>
19 <refpurpose>ヘルプページで見つかった例を実行.</refpurpose> 22 <refpurpose>ヘルプページで見つかった例を実行.</refpurpose>
@@ -35,9 +38,30 @@
35 <term>moduleNames</term> 38 <term>moduleNames</term>
36 <listitem> 39 <listitem>
37 <para> 40 <para>
38 文字列または文字列ベクトル: テストを行うモジュールの名前. 41 a string or a vector of strings: references of the modules to test.
39 デフォルト値は 42 Each reference can be either of
40 <link linkend="getmodules">getmodules()</link>で返された値です. 43 <itemizedlist>
44 <listitem>
45 the technical name of a Scilab internal module, that is the name
46 of the root directory of the module.
47 </listitem>
48 <listitem>
49 the relative or absolute path of the root directory of the module.
50 This must be used for installed ATOMS modules or other external modules.
51 </listitem>
52 </itemizedlist>
53 By default, all Scilab internal modules are considered, as returned by
54 <link linkend="getmodules">getmodules()</link>.
55 </para>
56 <para>
57 The root directory of each targeted module must have a
58 <literal>./help</literal> subdirectory containing the XML source files of
59 help pages where examples to test are provided, gathered by languages as
60 in the source package of any standard module.
61 Example of the template toolbox_skeleton module:
62 <programlisting role="example">
63unix_w("dir /b /s """ + WSCI + "/contrib/toolbox_skeleton/help""")
64 </programlisting>
41 </para> 65 </para>
42 </listitem> 66 </listitem>
43 </varlistentry> 67 </varlistentry>
@@ -80,6 +104,13 @@
80 この巻数は,ヘルプページで指定した例を展開し, 104 この巻数は,ヘルプページで指定した例を展開し,
81 <link linkend="test_run">test_run</link>により実行します. 105 <link linkend="test_run">test_run</link>により実行します.
82 </para> 106 </para>
107 <para>
108 <warning>
109 When testing examples of any external module, it is mandatory to autoload the module
110 at Scilab startup. This can be achieved either by setting the ATOMS module as
111 autoloaded, or by loading the module through the user's startup file.
112 </warning>
113 </para>
83 </refsection> 114 </refsection>
84 <refsection> 115 <refsection>
85 <title>例</title> 116 <title>例</title>
@@ -98,6 +129,15 @@ end
98 <member> 129 <member>
99 <link linkend="test_run">test_run</link> 130 <link linkend="test_run">test_run</link>
100 </member> 131 </member>
132 <member>
133 <link linkend="bench_run">bench_run</link>
134 </member>
135 <member>
136 <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
137 </member>
138 <member>
139 <link linkend="startup">startup</link>
140 </member>
101 </simplelist> 141 </simplelist>
102 </refsection> 142 </refsection>
103 <refsection> 143 <refsection>