language agnostic - Fichiers d'aide Windows

Translate

À l'époque, l'aide n'était pas simple mais possible: générez un fichier .rtf génial avec des balises spéciales, exécutez-le via un compilateur, et vous avez un fichier WinHelp (.hlp) qui fonctionne vraiment 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 peut-être bien, 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» qui est causé par des restrictions de sécurité.

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

Bottom Line: Je trouve CHM absolument inutilisable. Mais avec WinHelp n'étant plus une option non plus, je me demande quelles sont les alternatives, surtout quand il s'agit d'intégrer avec mon Application (c'est à dire pour WinHelp et CHM il y a des fonctions qui vous permettent de passer directement à un sujet)?

Le format 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 vu que c'est un peu standard de nos jours, mais pouvez-vous lui dire de manière fiable de sauter à une page / ancre donnée?

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

Éditer: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 fois dans le passé parce que beaucoup de mes utilisateurs l'exécuteront hors du réseau, ce qui cause exactement ce problème.

Je recherche donc un moyen plus robuste et à l'épreuve du temps 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 ce Security Stuff le rend inutilisable, car un système d'aide est censé fournir une aide à l'utilisateur, pas générer encore plus de problèmes.

This question and all comments follow the "Attribution Required."

Toutes les réponses

Translate

HTML serait le prochain meilleur choix, UNIQUEMENT SI vous les serviriez à 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 ...))) donneraient à CHM l'apparence d'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, un autre piège concernant les fichiers CHM: même si vous essayez d'ouvrir un fichier CHM sur unlocaldisque, vous pouvez heurter le bloc de sécurité si vous l'avez initialement téléchargé de quelque part, car le fichier pourrait être marqué comme «provenant d'une source externe» lorsqu'il a été obtenu.

La source
Translate

Je n'aime pas l'option html et je suis en fait passé du simple HTML 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 la petite casse constante des personnes qui le mettaient sur le réseau (profondeur d'imbrication limitée, effets de verrouillage étranges), l'antivirus mort dans des répertoires contenant 30000 fichiers html et 20 minutes de décompression lors de l'installation sur un système plus ancien, des zones de sécurité du navigateur et fonctionnalités, erreurs de calcul de l'espace nécessaire dans l'installateur, etc.

Et puis je n'inclut 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 continuaient à se reproduire dans un nombre impressionnant de variétés et c'était assez. Nous avons trouvé chmlib et avons décidé que nous pourrions utiliser pour toujours quelque chose basé sur celui-ci comme échappatoire avec un simple lecteur externe, si le système d'exploitation fourni cessait de fonctionner et basculait.

En attendant, nous avons également un propre compilateur, donc nous sommes à l'épreuve du futur sans MS. Cela ne veut pas dire que nous ne changerons jamais (les solutions avec des serveurs Web locaux semblent préférées de nos jours), mais au moins nous avons le choix.

La source
Translate

Notre logiciel est à la fois distribué localement aux clients et servi à partir d'un partage réseau. Nous avons opté pour la génération à la fois d'un fichier CHM et d'un ensemble de fichiers HTML à diffuser à partir du réseau. Les utilisateurs qui démarrent le programme localement utilisent le fichier CHM, et les utilisateurs qui reçoivent leur programme depuis un partage réseau doivent utiliser les fichiers HTML.

Nous utilisonsAide et manuelet peut ainsi facilement produire les deux types de sortie à partir du même projet source. Les fichiers HTML contiennent également des capacités de recherche et ne nécessitent pas de serveur Web, donc bien que ce ne soit pas une solution optimale, cela fonctionne 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 cela fonctionne vraiment bien
  • Microsoft Help 2 (HXS) - cela semble fonctionner jusqu'au moment où ce n'est pas le cas, index corrompus ou similaires, ceci est utilisé par Visual Studio 2005 et supérieur, à titre d'exemple
La source
Translate

Si vous ne souhaitez pas utiliser un 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 revenir à WinHelp? Vista n'inclut pas WinHlp32.exe hors de la boîte, mais il estdisponible gratuitement en téléchargementpour Vista et Server 2008.

La source
Translate

Cela dépend de la façon dont la documentation en ligne est importée dans votre produit, une bonne infrastructure de documentation peut être complexe à mettre en place mais une fois réalisée, elle est payante. Voici comment nous procédons -

  • Source d'aideDITAXML compilant, stocké dans SCC (ClearCase).
  • Aide à l'éditionXMetal
  • Compilation d'aide, personnaliséeOuvrir la boîte à outils DITA, avec pré-traitement Perl / Java personnalisé
  • La source d'aide fait des références croisées aux ressources des applications au moment de la compilation, aux fichiers .RC, etc.
  • Livrables d'aide à partir d'une seule source, PDF, CHMAide 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 faire le mappage de l'aide pour résoudre la demande en une URL, puis lancer l'URL vers le wrapper d'aide Eclipse ou un navigateur.

La source
Translate

La question est 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. L'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 Crimson. Ainsi, lorsque j'appuie sur F1, il charge le CHM et effectue une recherche du mot sur lequel se trouve le curseur (idéal pour une référence rapide aux fonctions).

La source
Translate

Si vous faites "simplement extraire et exécuter", vous allez exécuter 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 d'empaqueter vos applications dans un programme d'installation? L'utilisation d'un programme d'installation atténuerait le problème de «source externe». Vous pourrez utiliser les fichiers .chm sans aucun problème.

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

La source
Translate

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

j'utiliseFoxit Readersur 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 obstrue votre dossier de documents.

La source
Translate

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

Ce que je prévois est d'avoir le contenu chargé 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'aspect et la convivialité à ce dont il a besoin. Il se peut que nous devions être en mesure d'afficher uniquement l'aide pour des versions particulières de notre produit, ce qui peut être fait en filtrant les éléments du XSLT.

La source
Dave Lee
Translate

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, windows help, xml, xhtml et quelques autres dont je n'ai jamais entendu parler (est-ce que dita vous dit quelque chose?). C'est 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 par rapport à la question du choix de chm ou html ou autre, c'est que si vous l'utilisez, vous n'êtes pas verrouillé 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 ne vaudra pas la peine, mais si vous avez une documentation à gérer, c'est le meilleur à ma connaissance. Leur soutien est également très utile.

La source