<html>
<head>
<meta content="text/html; charset=windows-1252"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div class="moz-cite-prefix">Bonjour,<br>
<br>
Le 20/04/2017 à 09:59, Vincent Flutet a écrit :<br>
</div>
<blockquote
cite="mid:2e58fca0eeb947d7bdbad1d301b18fad@VM-MAILS.velan.fr"
type="cite">
<pre wrap="">Bonjour,
J'ai écrit un grand nombre de fonctions et j'ai du mal à comprendre comment les documenter.
Si je comprends bien, help_from_sci crée un fichier .xml à partir des commentaires d'en-tête de chacune des fonction d'un fichier .sci. Mais cela ne semble fonctionner qu'en anglais.
Par contre help_skeleton peut prendre en compte le français mais le fichier .xml créé est vierge et il faut appeler help_skeleton pour chaque fonction.
Existe-t-il un moyen d'écrire un fichier .xml en français à partir des commentaires d'en-tête des fonctions d'un fichier .sci ?
Une fois le .xml créé, comment l'intégrer à l'aide de scilab ?</pre>
</blockquote>
<br>
Il est possible -- voire préférable -- de rédiger les pages d'aides
directement en XML.<br>
Pour ma part, je n'utilise pas du tout help_from_sci().<br>
<br>
En téléchargeant le code source de Scilab, vous avez accès à tous
les fichiers sources<br>
XML des pages d'aide de Scilab, lesquels constituent autant
d'exemples qui peuvent<br>
être de bons points de départ ou de dépannage : si vous repérez une
page d'aide<br>
avec un élément qui vous intéresse mais que vous ne savez pas
formater en XML,<br>
il suffit d'éditer le fichier source XML correspondant pour voir
comment faire.<br>
Apprendre en prenant exemple, imitant et testant, est très efficace.<br>
<br>
Si "./" représente la racine de votre module,<br>
<ul>
<li>les fichiers sources XML en version anglaise doivent être
stockés dans le dossier ./help/en_US/</li>
<li>les fichiers sources XML en version française doivent être
stockés dans le dossier ./help/fr_FR/</li>
</ul>
<p>Par ailleurs,</p>
<ul>
<li>Toutes les versions linguistiques d'une page doivent avoir
exactement le même nom de fichier source. Exemple : la page
d'aide en français de la fonction linspace() est écrite dans le
fichier linspace.xml. Sa version anglaise est écrite dans un
fichier source obligatoirement nommé linspace.xml, mais stocké
dans ./help/en_US/ au lieu de ./help/fr_FR/<br>
Si cette contrainte n'est pas respectée, les pages ne seront pas
(toutes) compilées.<br>
<br>
</li>
<li>Il faut a minima que le fichier existe dans ./help/en_US. Si
vous ne souhaitez pas traduire vos pages en anglais, il faudra
par exemple copier le fichier en français dans ./help/en_US/
((en plus de l'avoir dans ./help/fr_FR).<br>
</li>
</ul>
Scinotes n'est pas adapté pour éditer et modifier les fichiers XML.
Pour ma part, j'utilise Notepad++ et son module XML externe (lequel
aide beaucoup).<br>
<br>
En espérant que ces quelques indications vous aideront,<br>
<br>
Cordialement<br>
Samuel Gougeon<br>
<br>
</body>
</html>