add CDATA + role in the helptools module
[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  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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" version="5.0-subset Scilab" xml:lang="fr" xml:id="helps">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>%helps</refname>
19     <refpurpose> variable contenant les noms des répertoires des chapitres d'aide  </refpurpose>
20   </refnamediv>
21   <refsection>
22     <title>Description</title>
23     <para><literal>%helps</literal> est une matrice de chaînes de caractères à deux colonnes. Chaque ligne est formée comme ceci
24   </para>
25     <programlisting><![CDATA[ 
26 répertoire_du_chapitre    titre_du_chapitre
27  ]]></programlisting>
28     <para>
29     Par exemple, nous avons le chapitre "graphics". 
30     <literal>%helps(2,:)</literal>.
31   </para>
32     <para>
33     La valeur par défaut de <literal>%helps</literal> est initialisée dans le fichier <literal>SCI+"scilab.start"</literal>.
34   </para>
35     <para>
36     Pour ajouter de nouveaux chapitres d'aide il suffit d'ajouter des lignes à la variable <literal>%helps</literal>, par exemple dans le fichier utilisateur de démarrage <literal>SCIHOME/.scilab</literal> ou <literal>SCIHOME/scilab.ini</literal>.
37   </para>
38     <para>
39     Par exemple, 
40     <literal>%helps=[%helps; "répertoire_du_chapitre",  "titre_du_chapitre"];</literal>
41   </para>
42     <para>
43     "titre_du_chapitre" devient le titre d'un nouveau chapitre.
44   </para>
45     <para>
46     Chaque répertoire d'aide contient des fichiers <literal>*.html</literal>,
47     généralement généré à partir d'un fichier XML, et un fichier
48     <literal>whatis.html</literal> contenant une ligne pour chaque mot-clé documenté
49     dans le chapitre correspondant. Chaque ligne doit avoir le format :
50   </para>
51     <para>
52   </para>
53     <programlisting><![CDATA[ 
54 <BR><A HREF="item.html">item</A> - description rapide
55  ]]></programlisting>
56     <para><literal>item</literal> est l'article de la liste d'aide, c'est-à-dire que la commande <literal>help item</literal> affiche le contenu du fichier <literal>item.html</literal>.
57   </para>
58     <para>
59       
60     La commande <literal>apropos mot-clé</literal> renvoie les lignes de tous les fichiers
61     <literal>whatis</literal> dans lesquels <literal>mot-clé</literal> apparaît.
62   </para>
63     <para>
64   </para>
65     <para>
66     Sur les plates-formes Linux, Scilab dispose d'un Makefile pour transformer les fichiers <literal>.xml</literal> en <literal>.html</literal> (voir SCIDIR/examples/man-examples).
67   </para>
68     <para>
69   </para>
70   </refsection>
71   <refsection>
72     <title>Voir Aussi</title>
73     <simplelist type="inline">
74       <member>
75         <link linkend="help">help</link>
76       </member>
77       <member>
78         <link linkend="apropos">apropos</link>
79       </member>
80     </simplelist>
81   </refsection>
82 </refentry>