Nous utilisons actuellement un système appelé AsciiDoc qui nous permet de créer de la documentation dans un simple balisage de texte. À partir de cela, nous pouvons générer plusieurs formats de sortie. Nous utilisons uniquement les formats de sortie pdf et de sortie chm.
Je me demandais s'il y avait une alternative à chm? Ce que je recherche, c'est quelque chose qui peut être utilisé hors ligne (c'est important parce que bon nombre de nos utilisateurs sont dans des endroits très éloignés) avec notre logiciel. Il doit avoir un index (il peut être aussi simple qu'une page html avec des termes hyperliens), il doit être consultable et il doit avoir un mécanisme qui permet d'appeler des entrées spécifiques à partir du code (similaire à l'aide contextuelle).
Les deux choses qui sont contre PDF dans ce cas sont:
- L'aide contextuelle n'est pas une option
- Généralement, le document est assez volumineux
- Le PDF est plus adapté à la documentation imprimée qu'à l'aide contextuelle
Ce que je voudrais, c'est utiliser du HTML. Le seul problème avec html est que je n'arrive pas à comprendre comment fournir automatiquement une recherche par mot-clé (autre que la fonctionnalité ctrl + f des navigateurs - je voudrais quelque chose de plus apparent). Je n'arrive pas non plus à trouver une méthode pour générer automatiquement un index hyperlien de mots clés. L'aide contextuelle serait simple à cause des balises de section - je pourrais simplement passer l'url de la page et de la section qui m'intéressent dans le navigateur par défaut et cette page devrait se charger dans la bonne section.
Mes exigences ressemblent énormément à chm - elles le font. J'ai modélisé mes besoins sur chm. La seule raison pour laquelle je n'aime pas chm est la façon dont le code interagit avec lui à l'aide de mapids et autres. Je préfère de loin utiliser stocker une liste de texte brut (qui est automatiquement générée pour moi) que mon code peut utiliser pour accéder à la partie contextuelle de la documentation.
J'imagine un script qui passerait par les fichiers de sortie html et générerait une page d'index qui contient simplement une liste de mots clés qu'il a trouvés. évidemment, il devrait y avoir un mécanisme d'exclusion de mots pour ignorer les mots comme: le, il, est, etc. Cette partie serait relativement facile à écrire. La deuxième partie aurait besoin d'un script quelconque pour constituer une base de données de mots-clés et leur emplacement dans le texte html. Je pense que ce serait la partie délicate avec la fourniture du mécanisme de recherche dans le navigateur.
Toute idée d'alternative serait appréciée. J'aimerais utiliser un wiki ou un ensemble de pages html statiques hébergées sur un serveur Web quelque part, mais nous avons une exigence critique d'utilisation hors ligne. Le simple fait de placer le code HTML sur le disque local ne nous fournit pas les exigences de recherche dont nous avons besoin.
ÉDITER:
Je conçois des logiciels utilisés par l'industrie minière. De nombreuses mines sont très éloignées et n'ont pas accès à Internet de manière significative. Il n'y a rien de mal avec pdf, html ou chm (sauf qu'il vieillit). Si je pouvais afficher un fichier pdf au bon endroit (c'est-à-dire une aide contextuelle), je l'utiliserais. Je suis presque tenté d'écrire le mien - en gros, ce serait un wiki portable. En parlant de cela, si vous proposez un wiki portable - vous devez penser à l'utilisateur final qui n'a peut-être aucune expérience de l'utilisation de tels outils. Il faut que ce soit simple. C'était la beauté de chm, c'est difficile de travailler avec mais les utilisateurs finaux aiment ça.