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 &copy; 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 Yenigün.

  Ce fichier fait partie de la documentation d'aide HTML de FreeDOS et
  est sujet à ses conditions de licence : cf. index.htm