Fichiers d'aide Windows : quelles sont les options ?

Question

Autrefois, l’aide n’était pas anodine mais possible :générez un fichier .rtf génial avec des balises spéciales, exécutez-le via un compilateur et vous obtenez un fichier WinHelp (.hlp) qui fonctionne vraiment très bien.

Ensuite, Microsoft a décidé que WinHelp n'était plus branché et cool et est passé à CHM, au point de supprimer WinHelp de Vista.

Maintenant, CHM est peut-être sympa, mais tous ceux qui ont essayé d'ouvrir un fichier .chm sur le réseau connaîtront le bel écran "La navigation vers la page Web a été annulée" provoqué par des restrictions de sécurité.

Bien qu'il existe des moyens de faire fonctionner CHM hors du réseau, ce n'est pas un bon choix, car lorsqu'un utilisateur appuie sur le bouton Aide, il souhaite obtenir de l'aide et ne pas avoir à effectuer des réglages géniaux.

Conclusion :Je trouve CHM absolument inutilisable.Mais comme WinHelp n'est plus une option non plus, je me demande quelles sont les alternatives, surtout lorsqu'il s'agit d'intégrer mon application (c'est-à-direpour WinHelp et CHM, il existe des fonctions qui vous permettent d'accéder directement à un sujet) ?

Le PDF a l'inconvénient de nécessiter Adobe Reader (ou l'un des plus légers que peu de gens utilisent).Je pourrais vivre avec cela étant donné que c'est une sorte de standard de nos jours, mais pouvez-vous lui dire de manière fiable de passer à une page/une ancre donnée ?

Les fichiers HTML semblent être le meilleur choix, il suffit alors de gérer différents navigateurs (CSS et autres).

Modifier: Je cherche à créer mes propres fichiers d'aide.Comme je suis fan de la philosophie « Pas de configuration, il suffit d'extraire et d'exécuter », j'ai eu ce problème à plusieurs reprises dans le passé, car beaucoup de mes utilisateurs l'exécuteront hors du réseau, ce qui provoque exactement ce problème.

Je recherche donc un moyen plus robuste et évolutif de fournir de l'aide à mes utilisateurs sans avoir à coder un système d'aide différent pour chaque application que je crée.

CHM est un format vraiment sympa, mais ces éléments de sécurité le rendent inutilisable, car un système d'aide est censé fournir une aide à l'utilisateur, pas générer encore plus de problèmes.

Answer 1

HTML serait le deuxième meilleur choix, SEULEMENT SI vous les servez à partir d'un serveur Web public.Si vous essayiez de le regrouper avec votre application, tous les fichiers (et images (et feuilles de style (et ...) )) feraient ressembler CHM à un cadeau des dieux.

Cela dit, lorsqu'ils sont réellement regroupés dans le package d'installation (au lieu d'être servis sur le réseau), j'ai trouvé que les fichiers CHM fonctionnaient bien.

OTOH, autre écueil sur les fichiers CHM :Même si vous essayez d'ouvrir un fichier CHM sur un locale disque, vous pouvez tomber sur le bloc de sécurité si vous l'avez initialement téléchargé quelque part, car le fichier pourrait être marqué comme "provenant d'une source externe" lors de son obtention.

Answer 2

Je n'aime pas l'option HTML et je suis en fait passé du HTML simple au CHM en les compressant et en les indexant.Utilisez-les même sur une poignée de clients non Windows.Il a simplement résolu le petit problème constant des personnes qui le mettaient sur le réseau (profondeur d'imbrication limitée, effets de verrouillage étranges), l'antivirus qui mourait dans des répertoires contenant 30 000 fichiers HTML et le temps de décompression de 20 minutes lors de l'installation sur un système plus ancien, les zones de sécurité du navigateur et fonctionnalités, erreurs de calcul de l'espace nécessaire dans le programme d'installation, etc.

Et puis je n'inclus même pas les personnes qui commencent à les "corriger", les produits tiers avec des tentatives "d'intégration" défectueuses, etc., les plaintes concernant la lenteur (démarrage du navigateur)

Nous avions tous attendu des années que les problèmes disparaissent à mesure que les systèmes d'exploitation et le matériel s'amélioraient, mais les problèmes revenaient sans cesse dans un nombre éblouissant de variétés et cela suffisait.Nous avons trouvé chmlib et avons décidé que nous pourrions toujours utiliser quelque chose basé sur cela comme évasion avec un simple lecteur externe, si le système d'exploitation fourni par ceux fournis cessait de fonctionner et changeait.

Entre-temps, nous disposons également de notre propre compilateur, ce qui nous permet d'être à l'épreuve du temps sans MS.Cela ne veut pas dire que nous ne changerons jamais (les solutions avec des serveurs Web locaux semblent privilégiées de nos jours), mais au moins nous avons le choix.

Answer 3

Notre logiciel est à la fois distribué localement aux clients et servi à partir d'un partage réseau.Nous avons choisi de générer à la fois un fichier CHM et un ensemble de fichiers HTML à diffuser depuis le réseau.Les utilisateurs démarrant le programme localement utilisent le fichier CHM, et les utilisateurs dont le programme est servi à partir d'un partage réseau doivent utiliser les fichiers HTML.

Nous utilisons Aide et manuel et peut ainsi facilement produire les deux types de sorties à partir du même projet source.Les fichiers HTML contiennent également des fonctionnalités de recherche et ne nécessitent pas de serveur Web, donc même si ce n'est pas une solution optimale, ils fonctionnent bien.

Jusqu'à présent, tous les types de fichiers uniques pour Windows semblent défectueux d'une manière ou d'une autre :

• WinHelp - obsolète
• HtmlHelp (CHM) - obsolète sur Vista, ne fonctionne pas à partir du partage réseau, à part ça, ça marche vraiment bien
• Microsoft Help 2 (HXS) - cela semble fonctionner jusqu'au moment où ce n'est pas le cas, index corrompus ou similaire, ceci est utilisé par Visual Studio 2005 et supérieur, à titre d'exemple

Answer 4

Si vous ne souhaitez pas utiliser de programme d'installation et que vous ne souhaitez pas que l'utilisateur effectue des étapes supplémentaires pour autoriser les fichiers CHM sur le réseau, pourquoi ne pas recourir à WinHelp ?Vista n'inclut pas WinHlp32.exe prêt à l'emploi, mais il est disponible gratuitement en téléchargement pour Vista et Server 2008.

Answer 5

Cela dépend de la manière dont la documentation en ligne est importée dans votre produit. Une bonne infrastructure de documentation peut être complexe à établir, mais une fois réalisée, elle s'avère payante.Voici comment nous procédons -

• Source d'aide DITA XML compilant, stocké dans SCC (ClearCase).
• Aide à l'édition XMétal
• Compilation d'aide, personnalisée Ouvrir la boîte à outils DITA, avec prétraitement Perl/Java personnalisé
• La source d'aide fait référence aux ressources des applications au moment de la compilation, aux fichiers .RC, etc.
• Aide aux livrables provenant d'une source unique, PDF, CHM, Aide Eclipse, HTML.
• Le référentiel source unique produit de l'aide pour plusieurs produits 10+ avec des milliers de sujets partagés.

D'après ce que vous décrivez, je regarderais l'aide d'Eclipse, ce n'est pas simple à intégrer dans les applications .NET ou MFC, vous devez essentiellement effectuer le mappage d'aide pour résoudre la demande en une URL, puis lancer l'URL vers le wrapper d'aide d'Eclipse ou un navigateur.

Answer 6

La question est-elle de savoir comment générer vos propres fichiers d'aide ou quel est le meilleur format de fichier d'aide ?

Personnellement, je trouve CHM excellent.Une des premières choses que je fais lors de la configuration d'une machine est de télécharger le manuel PHP au format CHM (http://www.php.net/download-docs.php) et ajoutez-y un raccourci clavier dans Éditeur cramoisi.Ainsi, lorsque j'appuie sur F1, il charge le CHM et effectue une recherche du mot sur lequel se trouve mon curseur (idéal pour une référence rapide des fonctions).

Answer 7

Si vous faites "il suffit d'extraire et d'exécuter", vous allez rencontrer des problèmes de sécurité.Cela est particulièrement vrai si vous utilisez Vista (ou une version ultérieure).y a-t-il une raison pour laquelle vous vouliez éviter de regrouper vos applications dans un programme d'installation ?L'utilisation d'un programme d'installation réduirait le problème de la « source externe ».Vous pourrez utiliser les fichiers .chm sans aucun problème.

Nous utilisons InstallAware pour créer nos packages d'installation.Ce n'est pas bon marché, mais c'est très bon.Si le coût vous préoccupe, WIX est open source et assez robuste.WIX a une courbe d'apprentissage, mais il est facile de travailler avec.

Answer 8

Le PDF a l'inconvénient de nécessiter Adobe Reader

j'utilise Lecteur Foxit sous Windows à la maison et au travail.Beaucoup plus petit et très rapide à ouvrir.Très pratique lorsque vous vous demandez ce qu'est exactement a80000326.pdf et pourquoi il encombre votre dossier de documents.

Answer 9

Je pense que la solution que nous allons adopter pour notre application consiste à héberger nous-mêmes les fichiers d'aide.Cela nous donne un accès immédiat aux fichiers et la possibilité de les tenir à jour.

Ce que je prévois, c'est de charger le contenu dans une énorme série de fichiers XML, chacun contenant de l'aide pour un élément spécifique.Ce XML contiendrait des liens vers d'autres fichiers XML.Nous utiliserions XSLT pour afficher le contenu si nécessaire.

En fonction de la licence, nous pouvons créer un fichier XSLT spécifique au client afin d'adapter l'apparence à ses besoins.Nous devrons peut-être également pouvoir afficher l'aide uniquement pour des versions particulières de notre produit et cela peut être fait en filtrant les éléments dans le XSLT.

Answer 10

J'utilise un package commercial appelé AuthorIT qui peut générer un certain nombre de formats différents, tels que chm, html, pdf, word, aide Windows, xml, xhtml et quelques autres dont je n'ai jamais entendu parler (dita vous dit-il quelque chose ?).Il s'agit d'un système de gestion de contenu orienté vers les besoins des rédacteurs de documentation technique.L’avantage est que vous pouvez utiliser et réutiliser le même contenu pour créer un ensemble de guides, puis les générer dans différents formats.

Donc, l'essentiel concernant la question du choix de chm ou html ou autre est que si vous l'utilisez, vous n'êtes pas enfermé dans un format donné, mais vous pouvez en fournir plusieurs parmi lesquels l'utilisateur peut choisir, et vous pouvez même ajouter plus de formats. au fur et à mesure, sans frais supplémentaires.

Si vous n'avez qu'un seul guide à créer, cela n'en vaudra pas la peine, mais si vous avez un ensemble de documentation à gérer, c'est le meilleur à ma connaissance.Leur soutien est également très utile.