2008-12-29 14 views
19

Es scheint, dass CHM-Hilfedateien nicht länger das Hilfedateiformat der Wahl sind.Die zukünftige Richtung der Hilfedateiformate

WinHelp
- veraltet

Htmlhelp (CHM)
- nicht auf Vista unterstützt standardmäßig
- funktioniert nicht gut auf einer Netzwerkfreigabe

Hilfe 2 (HXS)
- I Versteht diese wird Hilfe für die Anzeige von

in VS2005 + verwendet

Web Based
- könnte schwierig sein, für mehrere Versionen zu verwalten

Welches Hilfedateiformat würden Sie in einer neuen (C#) Anwendung verwenden, die mehrere Versionen derselben Codebasis bereitstellt? jemand beschäftigen HXS für ihre Hilfedateien

Wir möchten jedoch CHM-Hilfe zu verwenden, es scheint nicht, die Richtung zu sein, dass Microsoft uns will sich bewegen.

Hat?

Feeback geschätzt


aktualisieren, basierend auf lassevk Kommentare;

Sieht aus, als ob HXS-Hilfe nicht für normale Hilfeprojekte verwendet werden soll.


Antwort

4
this.Mode = Modes.Rant; 

Es gibt enorme Probleme mit fast allen Hilfedateiformate, weil die Hersteller (in der Regel Microsoft für nicht wenige von ihnen) nicht scheinen zu wollen, einen Job mehr als nur etwas zu tun gut genug für den eigenen Gebrauch.

Ich kann Ihnen nicht sagen, wie oft das neue HXS-Format meine Visual Studio-Hilfe vollständig abgespritzt hat, wenn Dritte sich integrieren. Man könnte sagen, dass dies der Fehler der Installationstools von Drittanbietern ist, aber seit einiger Zeit gab es keine Dokumentation darüber, wie dies zu tun ist, also mussten sie zwischen Reverse-Engineering wählen (und es manchmal falsch machen) oder nicht Integration überhaupt. Ich weiß immer noch nicht, ob die Integration funktioniert, aber in diesen Tagen wechsele ich nur noch zu Visual Studio, um die Online-Hilfe zu verwenden. Es funktioniert meistens, während die integrierte Hilfe immer auf den Fortschrittsbalken fällt, der Visual Studio nur sperrt, bis es die Hilfedatei neu erstellt hat, außer dass es nicht funktioniert, weil die Dateien jetzt beschädigt sind F1, Visual Studio wird nur gesperrt, wenn ich das DEXPLORE-Programm nicht beliebig oft abbringe.

Wie dies endete als eine Lösung für jedes Problem, ich weiß es immer noch nicht.

Zweitens müssen die Werkzeuge vorhanden sein. CHM-Viewer ist auf der Vor-Vista-Version vorhanden, nicht auf Vista, aber die Tools, die zur Anzeige von HXS benötigt werden, sind nicht auf der Vor-Vista-Version vorhanden, aber ich nehme an, dass sie sich auf Vista befinden. Nun, ich habe jetzt die Wahl zwischen einem Format, das auf dem Computer des Benutzers angepasst werden muss, oder ... ähm, einem anderen, das auf anderen Computern benutzerdefiniert installiert werden muss. Recht.

this.Mode = Modes.JustTicked; 

Wo ich arbeiten wir versenden CHM-Dateien und eine dateibasierte HTML-Version für diejenigen, die ihre Anwendungen über eine Netzwerkfreigabe bereitstellen. Was Vista angeht, haben wir noch nicht viel davon gesehen, aber die HTML-Version würde auch dort funktionieren.

Ich hätte lieber eine glänzende Hilfe Datei obwohl.

Ein nettes Ergebnis der HTML-Version ist, dass wir in den gleichen Dateien im Web-Modul, das unserem Produkt folgt, verlinken können. So würde es nur eine Version geben, die der Kunde braucht.

Wir sind auf der Suche nach einem Upgrade des Tools, das wir bei der Arbeit verwenden, so auf meinem Zeitplan für diese Woche, schön und ruhig bei der Arbeit, werde ich auf die verschiedenen Arten von Ausgabe, die unter anderem HXS produzieren kann.


bearbeiten: Hmm, ein kurzer Blick auf den Hilfeseiten für Hilfe und Handbuch, das Produkt, das wir verwenden, hat this to say about HXS:

Visual Studio Hilfe auch als MS Help 2.0 bekannt ist. Ursprünglich sollte dieses Hilfeformat der Nachfolger der HTML-Hilfe sein. Microsoft hat die Veröffentlichung jedoch auf unbestimmte Zeit verschoben, und es ist jetzt klar, dass es niemals als Hilfeformat für normale Benutzeranwendungen veröffentlicht wird.

Beachten Sie, dass dies ein spezielles Hilfeformat ist, das nur zum Dokumentieren von Programmierkomponenten von Drittanbietern verwendet wird, die für die Integration in Visual Studio .NET entwickelt wurden. Es ist für keinen anderen Zweck geeignet und kann nicht für normale Hilfeprojekte für Anwendungsprogramme verwendet werden!

Ich denke, HXS ist dann komplett vom Tisch.


Hinweis: Webbasierte würde bedeuten nicht unbedingt, dass Sie einen Web-Server , brauchen nur, dass Sie einen Web Browser. Ob Sie es in Ihre App integrieren, eine Webbrowser-Komponente verwenden oder nur den Standardbrowser des Benutzers starten, das wäre eine Wahl, die Sie treffen müssten, aber die meisten webbasierten Hilfeausgaben, die ich gesehen habe, benötigen keine Server-Setup überhaupt.

+0

dank ... sieht aus wie HXS völlig tabu ist. – Helios

+0

Vielleicht müssen wir nur auf Windows 7 warten, um herauszufinden, was sie dort machen werden. Und dann wieder in Windows 8. ...: D –

4

Für mich ist CHM immer noch die Antwort. Ich baue CHM-Dateien mit der Sandcastle Help File Builder tool, die auf Codeplex verfügbar ist.

Die Bedenken bezüglich der Zugänglichkeit von CHM sind gültig. Um das zu beheben, habe ich ziemlich einfach einen CHM-zu-Web-Konverter erstellt, mit einigen IStorage-Hacking, einem Text-Suchen-und-Ersetzen und einer XSL-Transformation. This page ist eine Website, die in etwa 8 Sekunden automatisch erstellt wurde. Es hat eine Baumstruktur zum Erweitern/Reduzieren auf der linken Seite. Frames basierend (nicht sehr URL freundlich), aber es funktioniert gut genug.

2

Die einzige nützliche Hilfedokumentation, die ich je gesehen habe, war reines HTML. Die meisten, wenn nicht alle Open-Source-Projekte, die ich gesehen habe, haben HTML-Hilfeseiten (für APIs und Referenzdokumente). Alles, was ein proprietäres Format verwendet oder ein proprietäres Lesegerät benötigt, läuft Gefahr, obsolet (CHM) zu werden oder Probleme mit der Kompatibilität oder Aufblähung (PDFs) zu haben.

Aus irgendeinem Grund ist Microsoft nur schlecht in Hilfedateien.Die Online-Hilfe für Visual Studio/SQL Studio/Office ist schrecklich, MSDN ist ein Chaos, CHMs sind klobig, und die Microsoft-Suche gibt nie die Ergebnisse zurück, die Sie wirklich wollen. (Nur meine Meinung :)

+2

CHMs sind nur HTML, das indiziert und komprimiert ist. Es gibt Open-Source-Viewer und (de) Kompressoren –

1

Adobe RoboHelp kann verwendet werden, um Hilfeinhalte zu verfassen, die Inhalt/Index/Suche/Glossar haben und in einem Browser wie HTML-generierte funktioniert. Unterstützt 35 Sprachen.

Wir haben eine Flex-basierte Web-App, die dies zur Verwaltung des Hilfeinhalts der App verwendet. Die Flex App und ihr Hilfesystem funktionieren auf den meisten Browsern unter Windows/MacOSX/Linux.

10

Was genau denken Sie, es gibt keine Standard-.chm-Viewer unter Windows Vista? (Es ist sicherlich ein auf meinem Computer, als auch auf meiner Win7-Box)

Sie könnten verwirren CHM mit HLP (Microsoft tatsächlich Unterstützung in Vista fiel HLP, dann wieder sie schließlich in einem Windows-Update)

Fazit: CHM-Dateien scheinen immer noch auf allen Windows-Version unterstützt zu werden, und die einzige echte Alternative Dateien zu CHM ich kenne, .html ist

Verwandte Themen