outils de création de bout-help utilisateur multi-plateforme
https://stackoverflow.com/questions/2977398
-
24-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianQuestion
Quels sont les bons outils de création pour la création de fichiers d'aide multi-plateforme pour les utilisateurs finaux? (Notre application utilise le framework Qt, si cela fait une différence.)
Note: Je ne suis pas intéressé dans la documentation API interne - en utilisant doxygen pour cela.
Idéalement, une solution:
- nous permettent de gérer tout le contenu de l'aide (texte, table des matières, des images, etc.) dans un seul endroit.
- Sortie aux formats d'aide natifs. (CHM pour Windows - ou au moins quelque chose que nous pourrions alimenter directement dans l'API d'aide HTML,. Ne sais pas ce que les autres plates-formes formats d'aide « standard » sont)
- Prise en charge WYSIWYG décent. Poignée entrée de texte commun, des images, des références croisées, etc. facilement, mais nous pouvons modifier le code HTML lorsque nous devons
- à base de texte format de fichier pour le projet d'aide (XML, etc.) afin qu'il puisse être dans Subversion versionné.
- Les crochets qui aident à maintenir en phase avec la base de code actuel serait génial. (Peut-être en quelque sorte une rubrique d'aide est associée à un fichier de code, et peut vérifier Subversion pour voir si des modifications ont été apportées et le drapeau d'un sujet comme « peut-être démodés » ... je suis en train de rêver?)
- contenu de l'aide peut être localisé.
- Pas opposé au produit commercial, mais une option gratuite serait bien.
Je vais aller de l'avant et de faire ce wiki et commencer par quelques exemples. Vote « em up ou vers le bas si vous avez de l'expérience avec eux, et laisser des commentaires. Ajouter des outils additionnels.
La solution
Je viens de découvrir Sphinx ; Je pense que je suis amoureux.
- Mieux que WYSIWYG HTML sur: reStructuredText
- Sorties à QtHelp (entre autres), ainsi sera facilement distribuer (et intégrer) dans notre application.
- Vous ne savez pas sur la localisation, mais nous allons traverser ce pont quand nous devons.
- était facile à mettre en place et « fonctionne »; apparence professionnelle.
Autres conseils
Je l'ai utilisé pendant des années robohelp.
Il est très bien, mais la technologie de base est très vieux maintenant. Aussi la façon dont ils verrouillent les versions Word est un PITA totale (et m'a obligé d'éviter les mises à jour de MS Office à plusieurs reprises).
Nous allons à écervelé flare http://www.madcapsoftware.com/products /flare/robohelp.aspx
Je pense que adresses DocBook vous tous les besoins, sauf éventuellement les crochets de synchronisation, que je vais y réfléchir un peu plus loin sur. Il est essentiellement un sous-ensemble de XML conçu pour créer des documents, et est libre et open source. Il est juste un format et un ensemble de transformations de sortie qui convertissent XSL DocBook en plus de formats utiles (HTML et donc CHM, JavaHelp, PDF via XML-FO ou Tex).
Cela signifie que vous avez encore besoin de choisir un outil de création XML pour modifier réellement si des choses comme WYSIWYG dépendra des caractéristiques de votre logiciel de création XML. Nous utilisons Syntext Serna comme il a un bon support pour WYSIWYG et l'édition en ligne de #includes XML (personne ne semble d'autre à soutenir celle-ci). Vous pouvez trouver d'autres outils de création XML mieux répondre à vos besoins -. Serna est une offre commerciale raisonnablement cher
DocBook offre beaucoup de flexibilité par profilage, ce qui vous permet d'inclure / exclure des éléments XML en fonction de leurs attributs. Exemple de cas d'utilisation serait d'avoir un peu différent de sortie d'aide pour OS = OS de Windows que Linux =. La localisation est également pris en charge par le biais de profils et d'autres mécanismes.
Une assez bonne introduction à DocBook se trouvent .
Nous utilisons DocBook pour notre format d'aide, et compiler les fichiers CHM qui contiennent l'aide uniquement pour les caractéristiques pertinentes à un produit spécifique (c.-à-Enterprise Edition a des caractéristiques qui ne sont pas dans les versions standard ou de démonstration). Les étapes pertinentes sont:
- Exécuter les modèles de profils sur la XSL Source XML (en utilisant par exemple XSLTProc).
- Exécuter les modèles XSL HTML-Aide sur la sortie 1.
- Compile les fichiers HTML de sortie à l'aide HTML Help compilateur de Microsoft (HHC).
Le seul que je connais est latex, l'un des convertisseurs LaTeX2HTML, puis quelques adaptation pour rendre le html résultant prêt pour le CHM archiveur.
- texte, html, CHM, pdf, ps aucun problème.
- Conversion vers Word via RTF utilisé pour être une catastrophe, ne savent pas l'état actuel.
- latex 2 convertisseurs html, tandis que plusieurs, ont tous leurs propres problèmes.
- Les pdfs regarder absolument génial.
- WYSIWYM (via LyX) possible.
Cette archive a un tas de CHM cette façon (notamment les prog, pièces ref et l'utilisateur, le reste (rtl, FCL, lcl) sont générés par notre propre équivalent doxygen, fpdoc)
http://www.stack.nl/~marcov/doc-chm .zip
Notez que l'ECMS ci-dessus sont faites avec notre propre (portable) compilateur CHM. Oui, plus atelier.
Un document Lyx au format PDF et html:
