Fichiers d'aide de Windows - quelles sont les options?

à l'époque, L'aide N'était pas insignifiante mais possible: générer un peu de funky .fichier rtf avec des balises spéciales, le lancer à travers un compilateur, et vous avez un fichier WinHelp (.hlp) cela fonctionne vraiment très bien.

alors, Microsoft a décidé que WinHelp n'était plus branché et cool et est passé à CHM, jusqu'au point où ils ont réellement supprimé WinHelp de Vista.

maintenant, CHM peut-être gentil, mais tous ceux qui ont essayé d'ouvrir un .chm fichier sur le réseau connaîtra la belle " Navigation à la page Web a été annulé" écran qui est causée par des restrictions de sécurité.

bien qu'il y ait des façons de faire fonctionner CHM hors du réseau, ce n'est pas un bon choix, parce que quand un utilisateur appuie sur le bouton D'aide il veut de l'AIDE et ne pas avoir à faire quelques réglages funky.

conclusion: je trouve le 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 (i.e. pour WinHelp et CHM il y a des fonctions qui vous permettent de passer directement à un sujet)?

PDF A l'inconvénient d'exiger le lecteur Adobe (ou L'un des plus légers que peu de gens utilisent). Je pourrais vivre avec cela, vu que c'est un peu la norme de nos jours, mais pouvez-vous lui dire de façon fiable de sauter à une page/ancre donnée?

les fichiers HTML semblent être le meilleur choix, vous avez alors juste à traiter avec différents navigateurs (CSS et truc.)

Edit: je cherche à créer mes propres Fichiers d'Aide. Comme je suis un fan de la philosophie "No Setup, Just Extract and Run", j'ai eu ce problème plusieurs fois dans le passé parce que beaucoup de mes utilisateurs vont l'exécuter hors du réseau, ce qui cause exactement ce problème.

Je cherche donc une façon plus robuste et plus sûre de fournir de l'aide à mes utilisateurs sans avoir à coder un système d'aide différent pour chaque application que je fais.

CHM est vraiment un beau format, mais ce truc de sécurité le rend inutilisable, comme un système D'aide est censé fournir de l'aide à l'Utilisateur, pas pour générer encore plus de problèmes.

34
demandé sur Rais Alam 2008-08-04 14:43:05

10 réponses

HTML serait le meilleur choix, seulement si vous les serviez à partir d'un serveur web public. Si vous avez essayé de l'empaqueter avec votre application, tous les fichiers (et les images (et les feuilles de style (et ...) ) ) CHM ressembler à un cadeau des dieux.

cela dit, lorsqu'il est réellement inclus dans le paquet d'installation (au lieu d'être servi sur le réseau), j'ai trouvé que les fichiers CHM fonctionnaient bien.

OTOH, un autre piège à propos des fichiers CHM: même si vous essayez d'ouvrir un fichier CHM sur un disque, vous pouvez entrer dans le bloc de sécurité si vous l'avez initialement téléchargé à partir de quelque part, parce que le fichier pourrait être marqué comme "provenait de source externe" quand il a été obtenu.

14
répondu Ishmaeel 2008-08-04 10:51:39

Je n'aime pas l'option html, et je suis passé du HTML simple au CHM en les compressant et en les indexant. Même les utiliser sur une poignée de clients Non-Windows même. Il a simplement résolu le petit Bris constant de personnes le mettant sur le réseau (profondeur de nidification limitée, étranges effets de verrouillage), antivirus qui est mort dans les répertoires avec 30000 fichiers html, et 20 minutes de temps de décompression lors de l'installation sur un système plus ancien, les zones de sécurité du navigateur et les fonctionnalités, les mauvais calculs de nécessaire place dans l'installateur etc.

Et puis je ne comprend même pas les gens qui commencent la "correction", 3e partie du produit défectueux "l'intégration" des tentatives etc, les plaintes concernant slowliness (démarrage du navigateur)

nous avions tous attendu pendant des années que les problèmes disparaissent à mesure que les os et le matériel s'amélioraient, mais les problèmes continuaient de se répéter dans un nombre éblouissant de variétés et assez était suffisant. Nous avons trouvé chmlib, et avons décidé que nous pourrions utiliser pour toujours quelque chose basé sur ce comme s'échapper avec un simple lecteur externe,si L'OS fourni a cessé de fonctionner et commuté.

en attendant nous avons aussi un propre compilateur,donc nous sommes à l'épreuve du futur DE MS free. 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.

5
répondu Marco van de Voort 2014-01-16 17:01:50

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

Nous utilisons Aide et Manuel et peut donc facilement produire les deux types de résultats à partir du même projet source. Les fichiers HTML contiennent aussi les capacités de recherche et ne nécessite pas un serveur web, donc bien que ce ne soit pas une solution optimale, fonctionne très bien.

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

  • WinHelp - rendu obsolète
  • HtmlHelp (CHM) - obsolète sur Vista, ne fonctionne pas à partir du partage de réseau, Autre que cela fonctionne vraiment bien
  • Microsoft Help 2 (HXS) - cela semble fonctionner jusqu'au point où il n'est pas, index corrompus ou similaire, Ceci est utilisé par Visual Studio 2005 et ci-dessus, comme exemple
3
répondu Lasse Vågsæther Karlsen 2008-08-04 11:07:08

si vous ne voulez pas utiliser un installateur et que vous ne voulez 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 c'est disponible gratuitement en téléchargement pour Vista et Server 2008.

3
répondu Chris Miller 2008-08-04 13:48:02

cela dépend de comment importer la documentation en ligne est à votre produit, une bonne infrastructure de documentation peut être complexe à établir, mais une fois fait, il paie. Voici comment nous le faisons -

  • sources de l'Aide DITA compilant XML, stocké dans SCC (ClearCase).
  • aide à éditer XMetal
  • Aider à la compilation, personnalisé Open DITA Toolkit, avec prétraitement Perl/Java personnalisé
  • sources de l'Aide de la croix références demandes de ressources au moment de la compilation .Les fichiers RC etc
  • aide produits livrables à partir d'une seule source, PDF, CHM,Eclipse Help, HTML.
  • le dépôt source unique produit de l'aide pour plusieurs produits 10+ avec des milliers de sujets partagés.

à partir de ce que vous décrivez, je regarderais L'aide Eclipse, ce n'est pas simple à intégrer dans les applications .NET ou MFC, vous avez essentiellement à faire la cartographie d'aide pour résoudre la demande à une URL alors Lancez L'URL de L'enveloppe D'aide Eclipse ou d'un navigateur.

3
répondu titanae 2008-09-21 00:11:04

Est la question de savoir comment générer vos propres fichiers d'aide, ou quel est le meilleur format de fichier d'aide?

personnellement, je trouve le 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 ajouter un raccourci clavier dans Crimson Editor. Ainsi, lorsque j'appuie sur F1, il charge le CHM et effectue une recherche pour le mot sur lequel mon curseur est activé (idéal pour une fonction de référence rapide).

3
répondu Kevin 2008-08-04 10:52:26

si vous faites "just extract and run", vous allez avoir des problèmes de sécurité. Ceci est particulièrement vrai si vous êtes des utilisateurs qui exécutent Vista (ou plus tard). y a-t-il une raison pour laquelle vous vouliez éviter d'empaqueter vos applications dans un installateur? L'utilisation d'un installateur soulagerait le problème des "sources externes". Vous serez en mesure d'utiliser .fichiers chm sans aucun problème.

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

2
répondu Chris Miller 2008-08-04 12:11:47

PDF A l'inconvénient d'exiger le lecteur Adobe

j'utilise Foxit Reader sur les fenêtres à la maison et au travail. Beaucoup plus petit et très rapide à ouvrir. Très pratique lorsque vous vous demandez ce qui exactement a80000326.pdf est et pourquoi il bloque votre dossier de documents.

2
répondu graham.reeds 2008-08-05 18:55:00

je pense que la solution que nous allons trouver pour notre application est d'héberger les fichiers d'aide nous-mêmes. 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 au besoin.

en Fonction de la licence, nous pouvons créer un fichier XSLT spécifique au client afin d'adapter l'apparence et la sensation à ce dont ils ont besoin. Nous pouvons avoir besoin de montrer l'aide seulement pour des versions particulières de notre produit aussi bien et cela peut être fait en filtrant des trucs dans le XSLT.

2
répondu Michael Beck 2008-11-27 20:39:16

J'utilise un paquet 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 (dita sonne-t-il une cloche?). Il s'agit d'un système de gestion du contenu orienté vers les besoins des rédacteurs de documentation technique. L'avantage est que vous pouvez utiliser et de réutiliser le même contenu pour créer un ensemble de guides et de générer dans différents formats.

donc le résultat relatif à la question de choisir chm ou html ou quoi que ce soit est que si vous utilisez ce que vous n'êtes pas verrouillé dans un format donné, mais vous pouvez 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, il n'en vaudra pas la peine, mais si vous avez un ensemble de documentation à gérer, alors c'est le meilleur à ma connaissance. Leur soutien est également très utile.

1
répondu 2008-09-18 14:47:16