R‚daction pour le systŠme d'aide HTML :
Les contributions sont plus que bienvenues. Si vous souhaitez faire une
contribution au systŠme d'aide HTML, veuillez contacter le mainteneur :
fritzdotmuelleratmaildotcom
La structure du r‚pertoire \help :
\help\index.htm
Liste les langues d'aide install‚es sur le systŠme.
Charg‚ automatiquement si LANG n'est pas d‚fini en une langue
disponible et si l'anglais (EN) n'est pas install‚.
\help\%LANG%\index.htm
HELP chargera ceci par d‚faut. %LANG% est la langue s‚lectionn‚e
en d‚finissant la variable d'environnement LANG. Si LANG n'est pas
d‚fini, EN est suppos‚.
\help\%LANG%\help.htm
HELP chargera ceci lorsque l'utilisateur appuie sur F1 ou clique
sur "Aide sur l'aide".
\help\docinfo\bi\nls\%LANG%.bi
Stocke les fichiers de rayons de bibliothŠque, pour ˆtre utilis‚s
avec l'outil bookshlf d'Aitor afin de cr‚er l'indexe de la langue
(\help\index.htm).
Cr‚ation de fichiers d'aide compress‚s :
Pour votre jeu de fichiers compress‚s, vous devriez utiliser un nom
comme :
\help\...\[nom]\[nom].zip
Si vous voulez compresser vos fichiers d'aide, ils devraient ˆtre au
format zip. Ils devraient avoir le mˆme nom de fichier que le
r‚pertoire dans lequel ils sont stock‚s, et l'extension zip.
Par exemple :
\help\en\monaide\monaide.zip
Le fichier index.htm peut ˆtre dans le fichier zip, mais l'aide et
le bookshlf fonctionneront tous deux mieux s'il ne l'est pas.
Les structures de r‚pertoire sont autoris‚es dans le fichier zip.
Cependant le cryptage et certaines des anciennes m‚thodes de
compression ne sont pas prises en charge.
Cr‚ation des versions modifi‚es des fichiers d'aide :
Utilisez un titre diff‚rent sur la page de titre (souvent index.htm)
dans les versions modifi‚es. Le but est d'‚viter les confusions ou
conflits, et plus important encore, cela est n‚cessaire selon la
partie 4A de la licence de documentation libre GNU 1.1.
En plus de changer le titre, veuillez mettre … jour l'historique,
la liste des auteurs etc., conform‚ment … la section 4 de
la licence de documentation libre GNU 1.1.
Si le jeu de fichiers a pour but de d‚crire un paquet modifi‚ ou
nouveau, ou si le jeu de fichiers subit des modifications fondamentales
(par ex. traduction), alors il vaut mieux ajouter un nom de
sous-dossier diff‚rent comme expliqu‚ dans "la structure du dossier
\help " ci-dessus. Il s'agit de faire une recherche et un remplacement
du nom de sous-dossier dans index.htm et cela en vaut bien la peine.
Par exemple, une version simplifi‚e du jeu de fichiers "hhstndrd"
pourrait ˆtre appel‚ "hhmicro". Cela serait le nom du sous-dossier
et le titre dans index.htm pourrait ˆtre :
FreeDOS Hilfe (hhmicro 1.0)
Il est raisonnable de modifier seulement le num‚ro de version (plut“t
que le nom et le dossier "hhmicro") lors des publications de mises
… jour.
Cr‚ation ou ajout de nouveaux fichiers :
Il est conseill‚ de mettre le message de licence suivant … la fin de
tout nouveau fichier d'aide (sauf s'il sera un fichier seul, non
inclus dans le jeu de fichiers d'aide) :
...
<hr>
<address>
<b>Copyright © 2008
<a href="mailto:monemail@adresse.com">Mon nom</a></b><br>
Ce fichier fait partie de la documentation d'aide HTML de FreeDOS,
et est sujet … ses conditions de licence, cf. :
<a href="../index.htm">index.htm</a>
</address>
</body>
</html>
Fournir un e-mail est totalement optionnel, si vous mettez vos
fichiers d'aide sur un site web alors les adresses e-mails pourraient
ˆtre spamm‚s. La licence est la licence de documentation libre GNU 1.1.
dition d'un fichier stock‚ dans un zip :
Vous pourriez vouloir d‚zipper les fichiers html pour qu'ils soient
lisibles avec un autre navigateur ou pour les ‚diter. Les fichiers
Zip ont d'habitude la priorit‚ sur les fichiers non compress‚s ;
si vous voulez ˆtre s–r que l'aide lira une version ‚dit‚e et non
compress‚e d'un fichier, vous devriez remplacer ou effacer la version
originale dans ce zip.
Test des fichiers d'aide :
Les navigateurs de r‚f‚rence pour tester les fichiers d'aide sont :
* Le visionneur d'aide HTML de FreeDOS (help.exe)
* Navigateur d‚riv‚ de Chromium.
Cr‚ation de tableaux :
Malheureusement, l'aide ne prend pas en charge les balises table.
Utilisez les balises de pr‚formatage <pre> </pre> pour
les tableaux d'info.
Conseils g‚n‚raux :
Appuyez sur F5 ou Ctrl+R pour rafraŒchir le fichier affich‚ par l'aide.
Les modifications de l'aide seront visibles imm‚diatement. C'est
utile lors de l'‚dition des fichiers d'aide dans un environnement
Windows. Pour l'utilisation du visionneur d'aide HTML afin de
visualiser des fichiers qui ne sont pas encore int‚gr‚s au jeu de
fichiers, le commutateur de d‚rogation du chemin d'aide peut ˆtre
utilis‚ :
help /O[lecteur:][chemin]nomdefichier[.htm]
ou si relatif au dossier /HELP :
help /L[sousdossiers]nomdefichier[.htm]
Voir ‚galement :
Balises prises en charge par l'aide HTML
Ressources de cr‚ation
Copyright © 2003-4 Robert Platt, mis … jour en 2008 par W. Spiegl
Traduit en 2020 par Berki Yenign.
Ce fichier fait partie de la documentation d'aide HTML de FreeDOS et
est sujet … ses conditions de licence : cf. index.htm