Bug Fix #12431 - Updated %helps help page
[scilab.git] / scilab / modules / helptools / help / fr_FR / 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="fr" xml:id="percenthelps">
18     <refnamediv>
19         <refname>%helps</refname>
20         <refpurpose>
21             variable globale : chemins des répertoires d'aide des modules externes chargés en session
22         </refpurpose>
23     </refnamediv>
24     <refsection role="description">
25         <title>Description</title>
26         <para>
27             La variable globale <literal>%helps</literal> est une matrice texte à 2 colonnes.
28             Chaque ligne référence le chapitre d'aide d'un module externe chargé en session :
29             <itemizedlist>
30                <listitem>
31                    <literal>%helps(k,1)</literal> est le chemin absolu du répertoire d'aide du module.
32                </listitem>
33                <listitem>
34                    <literal>%helps(k,2)</literal> est le titre du chapitre d'aide.
35                </listitem>
36             </itemizedlist>
37         </para>
38         <warning>
39           Cette variable ne doit PAS être modifiée manuellement. <literal>add_help_chapter</literal>
40           doit être utilisée pour ajouter au navigateur d'aide (à redémarrer) le chapitre relatif
41           à un module externe chargé, et pour actualiser <literal>%helps</literal>.
42         </warning>
43     </refsection>
44     <refsection role="examples">
45        <title>Exemples</title>
46         <programlisting role="example"><![CDATA[
47 global %helps  // Création de la variable locale %helps connectée à sa version globale
48 %helps
49 if %helps==[]                    // Aucun chapitre d'aide n'est déclaré pour aucun module externe
50     if atomsGetInstalled()==[]   // Si aucun module externe n'est installé,
51         atomsInstall uman;       //  on installe le module "uman" (disponible pour Windows, Linux et MacOS)
52     end
53     atomsLoad(atomsGetInstalled()(1));  // On charge le 1er module installé, pages d'aide incluses
54     %helps                       // Le chapitre d'aide correspondant est maintenant indexé dans %helps
55 end
56       ]]></programlisting>
57     </refsection>
58     <refsection role="see also">
59         <title>Voir aussi</title>
60         <simplelist type="inline">
61             <member>
62                 <link linkend="add_help_chapter">add_help_chapter</link>
63             </member>
64             <member>
65                 <link linkend="help">help</link>
66             </member>
67         </simplelist>
68     </refsection>
69 </refentry>