* Bug 16365 fixed: median(m,'r'|'c') was wrong after 5dc990
[scilab.git] / scilab / modules / core / help / en_US / configuration / with_module.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="with_module">
3     <refnamediv>
4         <refname>with_module</refname>
5         <refpurpose>Checks if a Scilab module is
6             installed
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Syntax</title>
11         <synopsis>r = with_module(module_name)</synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>r</term>
18                 <listitem>
19                     <para>a boolean</para>
20                 </listitem>
21             </varlistentry>
22             <varlistentry>
23                 <term>module_name</term>
24                 <listitem>
25                     <para>
26                         a string, for example : <literal>'core'</literal>
27                     </para>
28                 </listitem>
29             </varlistentry>
30         </variablelist>
31     </refsection>
32     <refsection>
33         <title>Description</title>
34         <para>
35             Returns <constant>%t</constant> if a Scilab module <literal>module_name</literal> is installed or <constant>%f</constant> if not.
36         </para>
37     </refsection>
38     <refsection>
39         <title>Examples</title>
40         <programlisting role="example"><![CDATA[
41 withXML = with_module("xml");
42 if withXML == %t then
43    disp("XML module enabled");
44 else
45    disp("XML module disabled");
46 end
47  ]]></programlisting>
48     </refsection>
49
50     <refsection role="see also">
51         <title>See also</title>
52         <simplelist type="inline">
53             <member>
54                 <link linkend="getmodules">getmodules</link>
55             </member>
56         </simplelist>
57     </refsection>
58 </refentry>