Quels sont les bons outils pour créer des fichiers d'aide HTML compilés (.chm) ?

Question

J'ai vu récemment un certain nombre d'endroits qui proposent une documentation en ligne sur l'API HTML ainsi que des fichiers d'aide téléchargeables (généralement au format .chm).

J'aime beaucoup utiliser les fichiers d'aide .chm, principalement en raison de l'arbre d'indexation sur la gauche.

Quels sont les outils permettant de créer ces types de fichiers ?

Answer 1

FAR est un très bon outil pour créer des fichiers CHM. Il suffit de lui envoyer un tas de fichiers html et vous aurez un fichier CHM prêt en quelques secondes.

http://www.helpware.net/FAR/

Answer 2

J'ai eu assez de chance avec hhc (Html Help Workshop). Le truc, c'est de l'intégrer en amont avec des outils appropriés pour que le compilateur ait le contenu nécessaire pour faire de beaux fichiers d'aide. Vous pourriez vouloir vérifier la chaîne d'outils docbook pour la création de htmlhelp si vous cherchez quelque chose de gratuit. Voir le section d'aide html de la DocBook XSL : le guide complet pour avoir quelques idées.

Cela dit, je ne dirais pas que l'apprentissage du flux de travail de docbook sous Windows peut être qualifié de " non stimulant ", alors prenez-le pour ce qu'il est. Je pense que la plupart des auteurs d'aide Windows utilisent des outils comme RoboHelp .

Answer 3

Nous sommes satisfaits de Doxygen à cette fin :

Doxygen est un système de documentation pour C++, C, Java, Objective-C, Python, IDL (saveurs Corba et Microsoft), Fortran, VHDL, PHP, C#, et dans une certaine mesure D.

Answer 4

Pauldoo a indiqué Doxygen, mais il utilise en fait le HTML Help Workshop de Microsoft pour compiler le fichier.

Je doute que vous trouviez un outil Unix pour cela, puisque CHM est propriétaire de Microsoft, et probablement non documenté. Bien que les programmeurs puissent faire des merveilles (voir les lecteurs XLS, par exemple), mais il pourrait y avoir un manque d'intérêt pour ce format. Vous pouvez utiliser Wine, je suppose. Ou Mono pour les outils .Net.

J'ai jeté un bref coup d'oeil à la page de Sandcastle, cela ressemble à un Doxygen pour .Net. Intéressant mais je ne sais pas si c'est utilisable pour du HTML générique (comme les docs utilisateurs).

Answer 5

Je suis très satisfait de Doc-to-Help. Je crée un manuel d'utilisation dans Word, j'utilise Adobe Acrobat pour créer un magnifique PDF, puis j'utilise Doc-to-Help pour créer un fichier CHM à partir du document Word. Lorsque des révisions sont nécessaires, je les fais dans Word, puis je refais le PDF, puis j'ouvre mon projet Doc-to-Help et il suffit de cliquer sur un bouton pour régénérer le fichier CHM.