Bug Fix #12431 - Updated %helps help page
[scilab.git] / scilab / modules / helptools / help / en_US / percenthelps.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) 2008 - INRIA
5  * Copyright (C) 2010 - DIGITEO - Allan CORNET
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <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="percenthelps">
18     <refnamediv>
19         <refname>%helps</refname>
20         <refpurpose>
21             global variable: paths to help directories of loaded external modules
22         </refpurpose>
23     </refnamediv>
24     <refsection role="description">
25         <title>Description</title>
26         <para>
27             The global variable <literal>%helps</literal> is an N x 2 matrix of strings.
28             Each row refers to the help chapter of a loaded external module:
29             <itemizedlist>
30                <listitem>
31                    <literal>%helps(k,1)</literal> is the absolute pathname to its help directory.
32                </listitem>
33                <listitem>
34                    <literal>%helps(k,2)</literal> is the title of its help chapter.
35                </listitem>
36             </itemizedlist>
37         </para>
38         <warning>
39           This variable must NOT be modified by hand. <literal>add_help_chapter</literal>
40           must be used to add a new help chapter and update <literal>%helps</literal>.
41         </warning>
42     </refsection>
43     <refsection role="examples">
44        <title>Examples</title>
45         <programlisting role="example"><![CDATA[
46 global %helps  // This instruction creates a local %helps variable connected to the global one
47 %helps
48 if %helps==[]                    // No help chapter is registered for any external module
49     if atomsGetInstalled()==[]   // If no external module is installed
50         atomsInstall uman;       //  we install the "uman" one (available for all plateforms)
51     end
52     atomsLoad(atomsGetInstalled()(1));  // We load the first module, included its help pages
53     %helps                       // Now the external chapter should be registered
54 end
55       ]]></programlisting>
56     </refsection>
57     <refsection role="see also">
58         <title>See also</title>
59         <simplelist type="inline">
60             <member>
61                 <link linkend="add_help_chapter">add_help_chapter</link>
62             </member>
63             <member>
64                 <link linkend="help">help</link>
65             </member>
66         </simplelist>
67     </refsection>
68 </refentry>