language agnostic - Windows-Hilfedateien

Translate

Früher war Hilfe nicht trivial, aber möglich: Generieren Sie eine funky .rtf-Datei mit speziellen Tags, führen Sie sie über einen Compiler aus, und Sie erhalten eine WinHelp-Datei (.hlp), die wirklich gut funktioniert.

Dann entschied Microsoft, dass WinHelp nicht mehr hip und cool war, und wechselte zu CHM, bis zu dem Punkt, an dem WinHelp tatsächlich von Vista gestrichen wurde.

Nun, CHM ist vielleicht nett, aber jeder, der versucht hat, eine .chm-Datei im Netzwerk zu öffnen, kennt den schönen Bildschirm "Navigation zur Webseite wurde abgebrochen", der durch Sicherheitsbeschränkungen verursacht wird.

Es gibt zwar Möglichkeiten, CHM außerhalb des Netzwerks zum Laufen zu bringen, dies ist jedoch kaum eine gute Wahl, da ein Benutzer, wenn er die Hilfetaste drückt, Hilfe benötigt und keine funky Einstellungen vornehmen muss.

Fazit: Ich finde CHM absolut unbrauchbar. Da WinHelp auch keine Option mehr ist, frage ich mich, welche Alternativen es gibt, insbesondere wenn es um die Integration in meine Anwendung geht (dh für WinHelp und CHM gibt es Funktionen, mit denen Sie direkt zu einem Thema springen können).

PDF hat den Nachteil, dass der Adobe Reader erforderlich ist (oder einer der leichteren, die nicht viele Benutzer verwenden). Ich könnte damit leben, da dies heutzutage eine Art Standard ist, aber können Sie es zuverlässig sagen, zu einer bestimmten Seite / einem bestimmten Anker zu springen?

HTML-Dateien scheinen die beste Wahl zu sein, dann müssen Sie sich nur noch mit verschiedenen Browsern (CSS und so) befassen.

Bearbeiten:Ich möchte meine eigenen Hilfedateien erstellen. Da ich ein Fan der Philosophie "Kein Setup, nur Extrahieren und Ausführen" bin, hatte ich dieses Problem in der Vergangenheit oft, weil viele meiner Benutzer es über das Netzwerk ausführen, was genau dieses Problem verursacht.

Daher suche ich nach einer robusteren und zukunftssicheren Möglichkeit, meinen Benutzern Hilfe zu bieten, ohne für jede von mir erstellte Anwendung ein anderes Hilfesystem codieren zu müssen.

CHM ist ein wirklich schönes Format, aber dieses Sicherheitsmaterial macht es unbrauchbar, da ein Hilfesystem dem Benutzer helfen soll, nicht noch mehr Probleme zu erzeugen.

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

Alle Antworten

Translate

HTML wäre die nächstbeste Wahl, NUR WENN Sie sie von einem öffentlichen Webserver aus bereitstellen würden. Wenn Sie versuchen würden, es mit Ihrer App zu bündeln, würden alle Dateien (und Bilder (und Stylesheets (und ...))) CHM wie ein Geschenk von Göttern aussehen lassen.

Das heißt, als ich tatsächlich im Installationspaket gebündelt war (anstatt über das Netzwerk bereitgestellt zu werden), fand ich, dass die CHM-Dateien gut funktionieren.

OTOH, eine weitere Gefahr bei CHM-Dateien: Auch wenn Sie versuchen, eine CHM-Datei auf einem zu öffnenlokalAuf der Festplatte können Sie auf den Sicherheitsblock stoßen, wenn Sie ihn ursprünglich von irgendwoher heruntergeladen haben, da die Datei beim Abrufen als "von einer externen Quelle stammend" markiert werden könnte.

Quelle
Translate

Ich mag die HTML-Option nicht und bin tatsächlich von einfachem HTML zu CHM gewechselt, indem ich sie komprimiert und indiziert habe. Verwenden Sie sie sogar für eine Handvoll Nicht-Windows-Kunden. Es löste einfach den ständigen kleinen Bruch von Leuten, die es in das Netzwerk stellten (Verschachtelungstiefe begrenzt, seltsame Sperreffekte), Antivirus, der in Verzeichnissen mit 30000 HTML-Dateien starb, und 20 Minuten Dekomprimierungszeit während der Installation auf einem älteren System, Browsersicherheitszonen und Funktionen, Fehleinschätzungen des benötigten Speicherplatzes im Installationsprogramm usw.

Und dann schließe ich nicht einmal die Leute ein, die anfangen, sie zu "korrigieren", Produkte von Drittanbietern mit fehlerhaften "Integrations" -Versuchen usw., Beschwerden über Langsamkeit (Browser-Start)

Wir hatten alle Jahre darauf gewartet, dass die Probleme behoben wurden, da sich Betriebssysteme und Hardware verbesserten, aber die Probleme traten immer wieder in einer erstaunlichen Anzahl von Varianten auf und genug war genug. Wir fanden chmlib und beschlossen, dass wir etwas, das darauf basiert, für immer als Flucht mit einem einfachen externen Lesegerät verwenden könnten, wenn das bereitgestellte Betriebssystem nicht mehr funktioniert und wechselt.

Mittlerweile haben wir auch einen eigenen Compiler, so dass wir MS-frei zukunftssicher sind. Das bedeutet nicht, dass wir uns nie ändern werden (Lösungen mit lokalen Webservern scheinen heutzutage die Favoriten zu sein), aber zumindest haben wir die Wahl.

Quelle
Translate

Unsere Software wird sowohl lokal an die Kunden verteilt als auch von einer Netzwerkfreigabe aus bereitgestellt. Wir haben uns dafür entschieden, sowohl eine CHM-Datei als auch eine Reihe von HTML-Dateien für die Bereitstellung aus dem Netzwerk zu generieren. Benutzer, die das Programm lokal starten, verwenden die CHM-Datei, und Benutzer, die ihr Programm von einer Netzwerkfreigabe bereitstellen, müssen die HTML-Dateien verwenden.

Wir gebrauchenHilfe und Handbuchund kann somit leicht beide Arten von Ausgaben aus demselben Quellprojekt erzeugen. Die HTML-Dateien enthalten auch Suchfunktionen und erfordern keinen Webserver. Obwohl dies keine optimale Lösung ist, funktioniert es einwandfrei.

Bisher scheinen alle Einzeldateitypen für Windows auf die eine oder andere Weise fehlerhaft zu sein:

  • WinHelp - veraltet
  • HtmlHelp (CHM) - veraltet unter Vista, funktioniert nicht über die Netzwerkfreigabe, ansonsten funktioniert das sehr gut
  • Microsoft Help 2 (HXS) - Dies scheint bis zu dem Zeitpunkt zu funktionieren, an dem dies nicht der Fall ist. Beschädigte Indizes oder ähnliches werden beispielsweise von Visual Studio 2005 und höher verwendet
Quelle
Translate

Wenn Sie kein Installationsprogramm verwenden möchten und der Benutzer keine zusätzlichen Schritte ausführen soll, um CHM-Dateien über das Netzwerk zuzulassen, können Sie auf WinHelp zurückgreifen. Vista enthält WinHlp32.exe nicht standardmäßig, ist es aberfrei verfügbar als Downloadfür Vista und Server 2008.

Quelle
Translate

Es hängt davon ab, wie wichtig die Online-Dokumentation für Ihr Produkt ist. Die Einrichtung einer guten Dokumentationsinfrastruktur kann komplex sein, zahlt sich jedoch aus. So machen wir das -

  • HilfequelleDITACompilant XML, gespeichert in SCC (ClearCase).
  • Hilfe beim BearbeitenXMetal
  • Hilfe beim Zusammenstellen, angepasstÖffnen Sie das DITA Toolkitmit benutzerdefinierter Perl / Java-Vorverarbeitung
  • Helfen Sie der Quelle, beim Kompilieren auf Anwendungsressourcen, .RC-Dateien usw. Zu verweisen
  • Hilfeleistungen aus einer Hand, PDF, CHM,Eclipse-Hilfe, HTML.
  • Das Single-Source-Repository bietet Hilfe für mehrere Produkte ab 10 Jahren mit Tausenden von gemeinsam genutzten Themen.

Nach dem, was Sie beschreiben, würde ich mir die Eclipse-Hilfe ansehen, die nicht einfach in .NET- oder MFC-Anwendungen zu integrieren ist. Grundsätzlich müssen Sie die Hilfezuordnung durchführen, um die Anforderung in eine URL aufzulösen, und dann die URL zum Eclipse-Hilfe-Wrapper oder einem Browser auslösen.

Quelle
Translate

Ist die Frage, wie Sie Ihre eigenen Hilfedateien generieren oder welches das beste Hilfedateiformat ist?

Ich persönlich finde CHM ausgezeichnet. Eines der ersten Dinge, die ich beim Einrichten eines Computers mache, ist das Herunterladen des PHP-Handbuchs im CHM-Format (http://www.php.net/download-docs.php) und fügen Sie einen Hotkey hinzuPurpurroter Editor. Wenn ich also F1 drücke, wird das CHM geladen und nach dem Wort gesucht, auf dem sich mein Cursor befindet (ideal für eine schnelle Funktionsreferenz).

Quelle
Translate

Wenn Sie "nur extrahieren und ausführen" ausführen, treten Sicherheitsprobleme auf. Dies gilt insbesondere dann, wenn Benutzer Vista (oder höher) ausführen. Gibt es einen Grund, warum Sie vermeiden wollten, Ihre Anwendungen in einem Installationsprogramm zu verpacken? Die Verwendung eines Installationsprogramms würde das Problem der "externen Quelle" verringern. Sie können problemlos .chm-Dateien verwenden.

Wir gebrauchenInstallAwareum unsere Installationspakete zu erstellen. Es ist nicht billig, aber sehr gut. Wenn die Kosten Ihr Anliegen sind,WIXist Open Source und ziemlich robust. WIX hat eine Lernkurve, aber es ist einfach, damit zu arbeiten.

Quelle
Translate

PDF hat den Nachteil, dass der Adobe Reader erforderlich ist

ich benutzeFoxit Readerunter Windows zu Hause und bei der Arbeit. Viel kleiner und sehr schnell zu öffnen. Sehr praktisch, wenn Sie sich fragen, was genau a80000326.pdf ist und warum es Ihren Dokumentenordner verstopft.

Quelle
Translate

Ich denke, die Lösung, die wir für unsere Anwendung finden werden, besteht darin, die Hilfedateien selbst zu hosten. Dies gibt uns sofortigen Zugriff auf die Dateien und die Möglichkeit, sie auf dem neuesten Stand zu halten.

Ich plane, den Inhalt in eine große Reihe von XML-Dateien zu laden, von denen jede Hilfe für ein bestimmtes Element enthält. Dieses XML würde Links zu anderen XML-Dateien enthalten. Wir würden XSLT verwenden, um den Inhalt nach Bedarf anzuzeigen.

Abhängig von der Lizenzierung erstellen wir möglicherweise eine clientspezifische XSLT-Datei, um das Erscheinungsbild an die Anforderungen anzupassen. Möglicherweise müssen wir nur für bestimmte Versionen unseres Produkts Hilfe anzeigen können. Dies kann durch Herausfiltern von Inhalten im XSLT erfolgen.

Quelle
Dave Lee
Translate

Ich verwende ein kommerzielles Paket namens AuthorIT, das eine Reihe verschiedener Formate generieren kann, wie z. B. chm, html, pdf, word, Windows-Hilfe, xml, xhtml und einige andere, von denen ich noch nie gehört habe (läutet dita eine Glocke?). Es ist ein Content-Management-System, das auf die Bedürfnisse von Autoren technischer Dokumentationen ausgerichtet ist. Der Vorteil besteht darin, dass Sie denselben Inhalt verwenden und wiederverwenden können, um eine Reihe von Handbüchern zu erstellen und diese dann in verschiedenen Formaten zu generieren.

Das Fazit in Bezug auf die Frage der Auswahl von chm oder html oder was auch immer ist, dass Sie, wenn Sie dies verwenden, nicht an ein bestimmtes Format gebunden sind, sondern mehrere angeben können, aus denen der Benutzer auswählen kann, und Sie können sogar weitere Formate hinzufügen wie Sie gehen, ohne zusätzliche Kosten.

Wenn Sie nur einen Leitfaden zum Erstellen haben, lohnt es sich nicht, aber wenn Sie eine Dokumentation verwalten müssen, ist dies meines Wissens das Beste. Ihre Unterstützung ist auch sehr hilfreich.

Quelle