69b8f520c6dd005628903be87d72bef3b1d17780
[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>Variable defining the path of help directories</refpurpose>
21     </refnamediv>
22     <refsection>
23         <title>Description</title>
24         <para>BEWARE: This variable must NOT be modified by users.</para>
25         <para>
26             The global variable <literal>%helps</literal> is an N x 2 matrix of strings.
27             The kth row of <literal>%helps</literal>, <literal>%helps(k,:)</literal> represents
28             the kth chapter of the manual and is made of two strings:
29         </para>
30         <para>
31             <literal>%helps(k,1)</literal> is the absolute pathname for a help directory.
32         </para>
33         <para>
34             <literal>%helps(k,2)</literal> is a title for this help directory.
35         </para>
36         <para>
37             To add a new help directory, the user should use <literal>add_help_chapter</literal>.
38         </para>
39     </refsection>
40     <refsection role="see also">
41         <title>See also</title>
42         <simplelist type="inline">
43             <member>
44                 <link linkend="add_help_chapter">add_help_chapter</link>
45             </member>
46             <member>
47                 <link linkend="help">help</link>
48             </member>
49         </simplelist>
50     </refsection>
51 </refentry>