Windows-Hilfedateien - was sind die Optionen?

stimmen
34

Zurück in den alten Tagen, war Hilfe nicht trivial, aber möglich: Eine flippige .rtf-Datei mit speziellen Tags erzeugen, ist es durch einen Compiler laufen, und Sie haben eine WinHelp-Datei (HLP), die tatsächlich funktioniert wirklich gut.

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

Nun, CHM vielleicht nett, aber jeder, der eine CHM-Datei auf dem Netzwerk zu öffnen versucht, wird wissen, das schöne „wurde die Navigation auf der Webseite abgebrochen“ Bildschirm, der von Sicherheitseinschränkungen verursacht wird.

Zwar gibt es Möglichkeiten gibt, CHM das Netzwerk abarbeiten zu machen, ist dies kaum eine gute Wahl, denn wenn ein Benutzer die Hilfe-Taste drückt, muss er will helfen, und nicht einige flippigen Einstellungen vornehmen.

Fazit: Ich finde CHM absolut unbrauchbar. Aber mit WinHelp auch nicht mehr eine Option zu sein, frage ich mich, was die Alternativen sind, vor allem, wenn es darum geht, mit meiner Anwendung zu integrieren (dh für WinHelp und CHM gibt es Funktionen, die es Ihnen ermöglichen, direkt zu einem Thema zu springen)?

PDF hat den Nachteil, dass ich den Adobe Reader (oder eine der leichter diejenigen, die nicht viele Menschen nutzen). Ich konnte mit diesem Sehen leben, wie diese Art von Standard heutzutage ist, aber kann man sagen, es zuverlässig auf eine bestimmte Seite / Anker zu springen?

HTML-Dateien scheinen die beste Wahl zu sein, müssen Sie dann nur mit verschiedenen Browsern (CSS und Sachen) beschäftigen.

Edit: Ich freue mich auf meine eigenen Hilfedateien zu erstellen. Da ich ein Fan von bin „kein Setup, Just Extract and Run“ Philosophie, hatte ich das Problem , das viele Male in der Vergangenheit , weil viele meiner Benutzer es das Netzwerk laufen ab, die genau dieses Problem verursacht.

Also ich bin auf der Suche für einen robustere und zukunftssichere Weg, um Hilfe zu meinen Benutzern zu schaffen, ohne ein anderes Hilfesystem für jede Anwendung zu codieren, die ich mache.

CHM ist ein wirklich schönes Format, aber das Sicherheits Stuff macht es unbrauchbar, da ein Hilfesystem Hilfe für den Benutzer zur Verfügung zu stellen sollte, nicht noch mehr Probleme zu erzeugen.

Veröffentlicht am 04/08/2008 um 11:43
quelle vom benutzer
In anderen Sprachen...                            


10 antworten

stimmen
15

HTML wäre die nächste beste Wahl sein, nur, wenn Sie sie von einem öffentlichen Web-Server dienen. Wenn Sie versucht, es mit Ihrer App zu bündeln, werden alle Dateien (und Bilder (und Stylesheets (und ...))) würde CHM wie ein Geschenk von den Göttern suchen.

Das heißt, wenn tatsächlich im Installationspaket gebündelt, (anstatt über das Netzwerk bedient wird), fand ich die CHM-Dateien gut zu funktionieren.

OTOH, eine andere pitfall über CHM - Dateien: Auch wenn Sie eine CHM - Datei auf einem zu öffnen versuchen, lokale Festplatte, können Sie in den Sicherheitsblock stoßen , wenn Sie es zunächst von irgendwo heruntergeladen haben , da die Datei markiert werden könnte als „von einer externen Quelle kam“ wenn es erhalten.

Beantwortet am 04/08/2008 um 11:51
quelle vom benutzer

stimmen
5

Ich mag es nicht, die HTML-Option, und tatsächlich aus einfachem HTML zu CHM bewegt durch Komprimieren und indizieren sie. nutzen sie auch auf eine Handvoll von Nicht-Windows-Kunden selbst. Es löste einfach die Konstante wenig Bruch von Menschen auf dem Netzwerk (Schachtelungstiefe begrenzt, seltsame Sperreffekte) setzen, Anti-Virus, die in den Verzeichnissen mit 30000 HTML-Dateien gestorben waren, und 20 Minuten Nullzeit, während auf einem älteres System, Browser-Sicherheitszonen Installation und Funktionen, Fehlkalkulationen des benötigten Platzes im Installer usw.

Und dann füge ich nicht einmal die Leute, die „Korrektur“, um sie, 3rd-Party-Produkt mit fehlerhaften „Integration“ Versuchen, etc, Beschwerden über Langsamkeit (Browser-Start-up) beginnen

Wir hatten alle gewartet Jahren für die Probleme wie OSes und Hardware verbessert gehen weg, aber die Probleme gehalten in einer bedazzling Anzahl von Sorten wiederkehrende und genug ist genug. Wir fanden chmlib und entschieden wir uns für immer etwas auf dieser Grundlage als Flucht mit einem einfachen externen Leser, wenn die OS bereitgestellt diejenigen, funktionieren nicht mehr benutzen konnten und umgeschaltet.

Inzwischen haben wir auch einen eigenen Compiler, also sind wir MS frei zukunftssicher. Das bedeutet nicht, wir werden nie ändern (Lösungen mit lokalem Web-Server scheinen Lieblinge heute), aber zumindest haben wir eine Wahl.

Beantwortet am 06/09/2009 um 01:03
quelle vom benutzer

stimmen
3

Es hängt davon ab, wie importieren die Online-Dokumentation zu Ihrem Produkt ist, kann eine gute Dokumentation Infrastruktur komplex zu etablieren, aber einmal getan, um es zahlt sich aus. Hier ist, wie wir es tun -

  • Hilfe Quelle DITA compilant XML, gespeichert in SCC (Clearcase).
  • Hilfe Bearbeitung XMetal
  • Hilfe Kompilation, besonders angefertigt Öffnen DITA - Toolkit , mit benutzerdefinierten Perl / Java Vorverarbeitung
  • Hilfe Quelle Querverweis Anwendungen Ressourcen zum Zeitpunkt der Kompilierung, .RC Dateien usw.
  • Hilfe zu erbringenden Leistungen aus einer Hand, PDF, CHM, Eclipse Help , HTML.
  • Single Source-Repository erzeugt für mehrere Produkte 10+ mit Tausenden von gemeinsamen Themen helfen.

Von dem, was Sie beschreiben, ich Eclipse Help aussehen würde, es ist nicht in .NET oder MFC-Anwendungen zu integrieren, einfach, haben Sie grundsätzlich die Hilfe Zuordnung zu tun, um die Anforderung an eine URL dann feuern die URL zu lösen Hilfe Wrapper oder einen Browser an Eclipse.

Beantwortet am 21/09/2008 um 01:11
quelle vom benutzer

stimmen
3

Wenn Sie nicht möchten , dass ein Installationsprogramm verwenden und Sie nicht möchten , dass der Benutzer keine zusätzlichen Schritte ausführen CHM - Dateien über das Netzwerk zu ermöglichen, warum nicht zurück zu WinHelp fallen? Vista nicht enthalten WinHlp32.exe aus der Box, aber es ist frei verfügbar als Download für beide Vista und Server 2008.

Beantwortet am 04/08/2008 um 14:48
quelle vom benutzer

stimmen
3

Unsere Software ist sowohl lokal an die Clients verteilt und serviert von einer Netzwerkfreigabe. Wir entschieden uns für beide eine CHM-Datei zu erzeugen und eine Reihe von HTML-Dateien für aus dem Netz dienen. Benutzer das Programm lokal starten verwenden Sie die CHM-Datei, und die Benutzer ihr Programm immer serviert von einer Netzwerkfreigabe haben die HTML-Dateien zu verwenden.

Wir verwenden Hilfe und Handbuch und kann somit leicht , beide Arten von Ausgabe aus der gleichen Quelle Projekt produzieren. Die HTML - Dateien enthalten auch Suchfunktionen und keinen Web - Server benötigen, so ist jedoch keine optimale Lösung ist, funktioniert gut.

Bisher alle Single-Dateitypen für Windows scheint in der einen oder anderen gebrochen:

  • WinHelp - veraltete
  • Htmlhelp (CHM) - auf Vista veralteten funktioniert nicht von Netzwerkfreigabe, anders als das funktioniert wirklich schön
  • Microsoft Help 2 (HXS) - dies scheint, bis der Punkt bis zu arbeiten, wenn es nicht, beschädigter Indizes oder ähnliches, das von Visual Studio 2005 verwendet wird und oben als Beispiel
Beantwortet am 04/08/2008 um 12:02
quelle vom benutzer

stimmen
3

Ist die Frage, wie Sie Ihre eigenen Hilfedateien zu erzeugen, oder was ist das beste Hilfe-Datei-Format?

Ich persönlich CHM finden ausgezeichnet. Eines der ersten Dinge , die ich tun , wenn eine Maschine die Einrichtung ist , die PHP Manual in CHM - Format (zum Download http://www.php.net/download-docs.php ) und fügen Sie einen Hotkey , um es in Crimson Editor . Also , wenn ich F1 drücken lädt es die CHM und führt eine Suche nach dem Wort meiner Cursor auf (ideal für schnelle Funktionsreferenz) sind.

Beantwortet am 04/08/2008 um 11:52
quelle vom benutzer

stimmen
2

Ich denke, die Lösung werden wir am Ende geht für unsere Anwendung der Hilfedateien selbst gehostet wird. Dies gibt uns sofortigen Zugriff auf die Dateien und die Fähigkeit, sie auf dem neuesten Stand zu halten.

Was ich plane, ist der Inhalt in eine große Reihe von XML-Dateien, die jeweils eine, die Hilfe für ein bestimmtes Element geladen zu haben. Diese XML würden Links zu anderen XML-Dateien enthalten. Wir würden XSLT verwenden, um die Inhalte bei Bedarf angezeigt werden soll.

Je nach Lizenzierung, können wir eine kundenspezifische XSLT-Datei aufbauen, um das Aussehen anpassen und fühlen, was sie brauchen. Wir müssen möglicherweise in der Lage sein, nur helfen, als auch für bestimmte Versionen unserer Produkte zu zeigen, und das kann durch Ausfiltern Sachen in der XSLT erfolgen.

Beantwortet am 27/11/2008 um 21:39
quelle vom benutzer

stimmen
2

PDF hat den Nachteil, dass der Adobe Reader

Ich benutze Foxit Reader unter Windows zu Hause und bei der Arbeit. Viele kleinere und sehr schnell zu öffnen. Sehr praktisch , wenn Sie sich fragen , was genau a80000326.pdf ist und warum es Ihre Dokumente - Ordner zu verstopfen.

Beantwortet am 05/08/2008 um 19:55
quelle vom benutzer

stimmen
2

Wenn Sie tun, „nur extrahieren und ausführen“, werden Sie in Sicherheitsfragen laufen. Dies gilt insbesondere, wenn Sie Benutzer mit Windows Vista (oder höher). gibt es einen Grund, warum Sie wollten Verpacken Sie Ihre Anwendungen in einer Installation vermeiden? ein Installationsprogramm mit dem „externen“ Problem würde lindern. Sie wäre in der Lage sein, Dateien verwenden CHM ohne Probleme.

Wir verwenden InstallAware unsere erstellen Pakete installieren. Es ist nicht billig, aber es ist sehr gut. Wenn die Kosten ist Ihre Sorge, WIX ist Open Source und ziemlich robust. WIX hat eine Lernkurve, aber es ist leicht zu verarbeiten.

Beantwortet am 04/08/2008 um 13:11
quelle vom benutzer

stimmen
1

Ich benutze ein kommerzielles Paket AuthorIT genannt, die eine Reihe von verschiedenen Formaten, wie chm generieren kann, html, pdf, Wort, Windows-Hilfe, XML, XHTML, und einige andere, die ich noch nie gehört haben (tut DITA eine Glocke läuten?). Es ist ein Content-Management-System orientiert sich an den Bedürfnissen der technischen Dokumentation Autoren. Der Vorteil ist, dass Sie verwenden können, und wieder verwenden den gleichen Inhalt eine Reihe von Anleitungen zu bauen und sie dann in verschiedenen Formaten erzeugen.

Unterm Strich also in Bezug auf die Frage der Wahl chm oder HTML oder was auch immer ist, wenn Sie diese verwenden, sind Sie nicht in einem bestimmten Format gesperrt, aber Sie können, unter denen mehrere zur Verfügung stellen kann der Benutzer auswählen, und Sie können noch mehr Formate hinzufügen wie Sie gehen entlang, ohne zusätzliche Kosten.

Wenn Sie nur eine Anleitung zum Erstellen es nicht die Mühe wert sein, aber wenn Sie eine Dokumentation festgelegt haben zu verwalten, dann ist es das Beste meines Wissens. Ihre Unterstützung ist auch sehr hilfreich.

Beantwortet am 18/09/2008 um 15:47
quelle vom benutzer

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more