Bug Fix #12431 - Updated %helps help page
[scilab.git] / scilab / modules / helptools / help / fr_FR / percenthelps.xml
index 1aef6aa..00c3ec3 100644 (file)
 <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">
     <refnamediv>
         <refname>%helps</refname>
-        <refpurpose>variable contenant les noms des répertoires des chapitres d'aide  </refpurpose>
+        <refpurpose>
+            variable globale : chemins des répertoires d'aide des modules externes chargés en session
+        </refpurpose>
     </refnamediv>
-    <refsection>
+    <refsection role="description">
         <title>Description</title>
-        <para>ATTENTION: Cette variable ne doit pas être modifiée manuellement par l'utilisateur.</para>
         <para>
-            <literal>%helps</literal> est une matrice de chaînes de caractères à deux colonnes. Chaque ligne est formée comme ceci
-        </para>
-        <programlisting role="no-scilab-exec"><![CDATA[
-répertoire_du_chapitre    titre_du_chapitre
- ]]></programlisting>
-        <para>
-            Pour ajouter de nouveaux chapitres d'aide, il faut utiliser la fonction <literal>add_help_chapter</literal>.
+            La variable globale <literal>%helps</literal> est une matrice texte à 2 colonnes.
+            Chaque ligne référence le chapitre d'aide d'un module externe chargé en session :
+            <itemizedlist>
+               <listitem>
+                   <literal>%helps(k,1)</literal> est le chemin absolu du répertoire d'aide du module.
+               </listitem>
+               <listitem>
+                   <literal>%helps(k,2)</literal> est le titre du chapitre d'aide.
+               </listitem>
+            </itemizedlist>
         </para>
+        <warning>
+          Cette variable ne doit PAS être modifiée manuellement. <literal>add_help_chapter</literal>
+          doit être utilisée pour ajouter au navigateur d'aide (à redémarrer) le chapitre relatif
+          à un module externe chargé, et pour actualiser <literal>%helps</literal>.
+        </warning>
+    </refsection>
+    <refsection role="examples">
+       <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+global %helps  // Création de la variable locale %helps connectée à sa version globale
+%helps
+if %helps==[]                    // Aucun chapitre d'aide n'est déclaré pour aucun module externe
+    if atomsGetInstalled()==[]   // Si aucun module externe n'est installé,
+        atomsInstall uman;       //  on installe le module "uman" (disponible pour Windows, Linux et MacOS)
+    end
+    atomsLoad(atomsGetInstalled()(1));  // On charge le 1er module installé, pages d'aide incluses
+    %helps                       // Le chapitre d'aide correspondant est maintenant indexé dans %helps
+end
+      ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
@@ -38,6 +61,9 @@ répertoire_du_chapitre    titre_du_chapitre
             <member>
                 <link linkend="add_help_chapter">add_help_chapter</link>
             </member>
+            <member>
+                <link linkend="help">help</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>