[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / development_tools / help / ja_JP / example_run.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) 2012 - Scilab Enterprises - Vincent COUVERT
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
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">
17     <refnamediv>
18         <refname>example_run</refname>
19         <refpurpose>ヘルプページで見つかった例を実行.</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>
24             example_run()
25             example_run(moduleNames)
26             example_run(moduleNames, functionNames)
27             example_run(moduleNames, functionNames, language)
28             example_run(moduleNames, functionNames, language, testrunOptions, testrunExportToFile)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>引数</title>
33         <variablelist>
34             <varlistentry>
35                 <term>moduleNames</term>
36                 <listitem>
37                     <para>
38                         文字列または文字列ベクトル: テストを行うモジュールの名前.
39                         デフォルト値は
40                         <link linkend="getmodules">getmodules()</link>で返された値です.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>functionNames</term>
46                 <listitem>
47                     <para>文字列または文字列ベクトル:
48                         テストする関数の名前. 指定されないアバイ,
49                         モジュールの全てのヘルプページがテストされます.
50                     </para>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>language</term>
55                 <listitem>
56                     <para>文字列: テストするヘルプページの言語. デフォルト値は "en_US"です.</para>
57                 </listitem>
58             </varlistentry>
59             <varlistentry>
60                 <term>testrunOptions</term>
61                 <listitem>
62                     <para>
63                         <link linkend="test_run">test_run</link>の第3引数として使用.
64                     </para>
65                 </listitem>
66             </varlistentry>
67             <varlistentry>
68                 <term>testrunExportToFile</term>
69                 <listitem>
70                     <para>
71                         <link linkend="test_run">test_run</link>の第4引数として使用.
72                     </para>
73                 </listitem>
74             </varlistentry>
75         </variablelist>
76     </refsection>
77     <refsection>
78         <title>説明</title>
79         <para>
80             この巻数は,ヘルプページで指定した例を展開し,
81             <link linkend="test_run">test_run</link>により実行します.
82         </para>
83     </refsection>
84     <refsection>
85         <title>例</title>
86         <programlisting role="example"><![CDATA[
87 if ~isempty(ls("SCI/modules/xml/help/en_US/*.xml")) then // この例のXMLソースが存在する必要があります
88     example_run("xml")
89     example_run("elementary_functions", "insertion")
90     example_run("elementary_functions", ["insertion"; "extraction"])
91     example_run("elementary_functions", "insertion", "en_US")
92 end
93  ]]></programlisting>
94     </refsection>
95     <refsection role="see also">
96         <title>参照</title>
97         <simplelist type="inline">
98             <member>
99                 <link linkend="test_run">test_run</link>
100             </member>
101         </simplelist>
102     </refsection>
103     <refsection>
104         <title>履歴</title>
105         <revhistory>
106             <revision>
107                 <revnumber>5.4.0</revnumber>
108                 <revremark>関数example_runが導入されました.</revremark>
109             </revision>
110         </revhistory>
111     </refsection>
112 </refentry>