Description

%helps est une matrice de chaînes de caractères à deux colonnes. Chaque ligne est formée comme ceci

 
répertoire_du_chapitre    titre_du_chapitre
 

Par exemple, nous avons le chapitre "graphics". %helps(2,:).

La valeur par défaut de %helps est initialisée dans le fichier SCI+"scilab.start".

Pour ajouter de nouveaux chapitres d'aide il suffit d'ajouter des lignes à la variable %helps, par exemple dans le fichier utilisateur de démarrage SCIHOME/.scilab ou SCIHOME/scilab.ini.

Par exemple, %helps=[%helps; "répertoire_du_chapitre", "titre_du_chapitre"];

"titre_du_chapitre" devient le titre d'un nouveau chapitre.

Chaque répertoire d'aide contient des fichiers *.html, généralement généré à partir d'un fichier XML, et un fichier whatis.html contenant une ligne pour chaque mot-clé documenté dans le chapitre correspondant. Chaque ligne doit avoir le format :

 
<BR><A href="item.html">item</a> - description rapide
 

item est l'article de la liste d'aide, c'est-à-dire que la commande help item affiche le contenu du fichier item.html.

La commande apropos mot-clé renvoie les lignes de tous les fichiers whatis dans lesquels mot-clé apparaît.

Sur les plates-formes Linux, Scilab dispose d'un Makefile pour transformer les fichiers .xml en .html (voir SCIDIR/examples/man-examples).

Voir Aussi