Un Index pour les Fonctions d'Allegro

 

Introduction

Dans la documentation Allegro (au format html ou tex), je pense qu'il n'y a pas assez de liens html pour couvrir tous mes besoins. Je rêve d'une documentation complète, où l'on pourrait naviguer d'une fonction à une autre ayant le même thème, simplement en cliquant sur son nom. En plus, il est bien fait mention d'un index dans le fichier allegro._tx, mais on dirait qu'il ne sert pas à grand choses (en tout cas pas pour la sortie html).

Comme cela fait maintenant 2 ans que je programme avec Allegro, je me sens désormais à l'aise, et j'aurais nettement moins besoin d'une telle documentation aujourd'hui. Mais je continue de penser qu'elle aurait dû être faite ainsi dès le départ, quand je n'étais encore qu'un complet novice. Voici donc ma première tentative d'aide à d'autre programmeurs Allegro débutants.

 

Comment ça marche

Ce programme vraiment très simple examine tous les fichiers alleg0*.html (dans le répertoire allegro/docs) et génère en conséquence le fichier index.html. Vous devez avoir Djgpp et Allegro déjà installés sur votre ordinateur, évidement. Vous pouvez trouver ici le code source. Il n'est pas vraiment écrit dans un bon style de programmation (et en plus j'utilise un truc horrible pour trier les données), mais il marche bien. Dans le cas contraire, écrivez-moi à paul.siramy@free.fr et je verrai ce que je peux faire pour vous.

Lisez l'en-tête du fichier pour voir comment l'installer (c'est assez simple je pense, mais en anglais), ou alors consultez juste ici le résultat. Placez ensuite ce fichier avec les autres (dans c:/djgpp/allegro/docs sans doutes). Vous devriez aussi éditer le ficher allegro.html pour créer un lien vers ce nouveau fichier. Ajoutez juste la ligne suivante quelque part dans le début du fichier allegro.html :

    <li><a href="index.html">Index of functions and global variables</a>

et c'est fini.

 

Télécharger

  • makidx.c génère le fichier d'index
  • index.html le fichier d'index produit

  • allegro.html est ma version personnelle de la page html principale d'Allegro wip 3.9.35, qui inclu une référence au fichier index.html, et qui trie aussi par thèmes tous les autres liens, ce que je considère bien plus facile d'utilisation que le fichier d'origine.

 

Conclusion

Peut être un jour aurais-je le courage de faire un programme qui modifiera chaque fichier html de la documentation, en remplaçant le nom de chaque fonction par un lien vers cette fonction. La meilleure chose à faire serait de réecrire le fichier allegro._tx, plutôt que les fichiers . De cette façon on pourrait bénéficier de ces liens même dans Rhide. Ce programme est en cours de développement. Pas encore très intéressant malheureusement.

D'ici là, je vais continuer de repasser sous Windows quand j'aurai besoin de consulter la documentation d'Allegro (j'aime tellement utiliser mon index et ma page personnalisée de documentation d'Allegro ;)