Schreiben von HTML-Hilfedateien

Schreiben von HTML-Hilfedateien

Schreiben von HTML-Hilfedateien : Mehreren tausend Tipps, um Ihr Leben einfacher machen.

Gewusst wie: Schreiben von HTML-Hilfedateien für Delphi.
Schreiben von HTML-Hilfedateien
von Vegard A. Larsen
(ursprünglich für KORABE, der inoffizielle Newsletter für Delphi-Benutzer, geeignet für www.HowToDoThings.com)
Nachdem ich die Anwendung Verteidiger Tagebuch geschrieben hatte, ich das Bedürfnis zu schreiben, eine anständige Hilfe-Datei mit dem Paket zu gehen. Nun, das tat ich, was ich immer Tue, wie ich bin ein Freeware-Entwickler, die mit fast kein Geld vorhanden. Ich fand heraus welche Hilfe schreiben Programme existierte, und überprüft, ob diese Freeware waren. Nun, wie sich herausstellt, war das nähste bekam ich HelpScribble, was ist Shareware. Auf dieser Seite bemerkte ich die HTML Help Workshop von Microsoft, die waren tatsächlich frei. Dies ist, was normalerweise als Compiler für diese Drittanbieter Hilfe Autoren verwendet wurden, aber wie ich jetzt sah, war es nicht unmöglich, Hilfedateien, die nur dieses Tool zu schreiben. Einige von Ihnen können von Help Workshop gehört haben, die fast die gleiche, nur für normale Hilfedateien (.hlp) macht. Nach was ich mich erinnere, war dies äußerst kompliziert und let it Down schlecht durch die Dokumentation (und hey: das ist ein Hilfe-Schriftstellerin-Programm).
Also beschloss ich, dass es möglich schreiben diese Datei nur mit HTML Help Workshop und einem HTML-Editor helfen sollte. Setzte ich mich ruhig und durch die Hilfedateien, die mit ihm zu lesen, aber diesmal auch kein Lernprogramm waren verfügbar (schäm dich, Microsoft!). Also das ist, wenn ich beschlossen, diesen Artikel zu schreiben. Ich habe beschlossen, um dies so einfach wie möglich, wie Hilfe schreiben nicht immer so einfach, wie es scheint.
Was Sie benötigen, bevor Sie beginnen:
HTML Help Workshop
Ein anständiges HTML-Editor (oder wenn Sie begabt genug sind, können Sie Notepad)). Um Ihnen den Einstieg zu bekommen, empfehle ich, dass Sie ein separates Verzeichnis für dieses Tutorial zuweisen. (Ich empfehle es gerne auf der Seite Willkommen/Inhalt) Ihre erste HTML-Datei erstellen und speichern Sie sie in diesem Verzeichnis. Ich rief Mine welcome.htm. Nachdem Sie einfach die Seite erstellt haben (es muss nicht alles, nur die benötigten < BODY >, < HTML > enthalten und ähnliche Tags zu einer vollständigen HTML-Datei).

Feuer auf HTML Help Workshop (fortan: Heerhugowaard). Wählen Sie Datei, neu, und anschließend Projekt. Den ersten Bildschirm überspringen, indem Sie auf Weiter, und geben Sie Ihre Hilfe-Datei erstellt werden soll (Sie oben erstellten dasselbe Verzeichnis verwenden). Klicken Sie auf Weiter, und wählen Sie das letzte Feld (HTML-Dateien), und klicken Sie erneut auf Weiter. Fügen Sie Ihre HTML-Datei, und klicken Sie auf Weiter, dann beenden. Sie werden nun in das Hauptfenster von Heerhugowaard geholt, waren, dass Sie verbringen viel Zeit bei. Unter dem Abschnitt [FILES] im linken Frame können Sie sehen, dass die zuvor erstellten HTML-Datei vorhanden ist. Sie müssen die HTML-Dateien Ihres Projekts in diesem Abschnitt hinzu, und dies geschieht, indem Sie auf die zweite Schaltfläche von oben zählen. Klicken Sie nun auf der Registerkarte Inhalt von Heerhugowaard. Wählen Sie erstellen eine neue Inhaltsdatei gefragt, und klicken Sie auf OK. Speichern Sie sie im gleichen Verzeichnis wie vorher (ich werde annehmen, Sie haben verstanden, das von nun an). Sie sehen eine völlig leere Liste, und das ist, was wir als nächstes ändern.

Der rechten Maustaste in das leere Listbox, und klicken Sie auf Einfügen-Thema. In der Editbox Eintrag Titel zu schreiben, was auch immer Sie wünschen ('Willkommen' angebracht wäre), und klicken Sie auf hinzufügen. Wählen Sie die einzige Datei in der Liste (es werden mit dem gleichen Namen aufgelistet wie in dem < TITLE > HTML-Tag angegeben aus), und klicken Sie zweimal auf OK. Jetzt haben Sie ein Element in der Liste. Nun klicken Sie auf die Registerkarte Index von Heerhugowaard, und wählen Sie erstellen eine neue Indexdatei gefragt. Es wird eine neue leere Listbox angezeigt. Ich werde dies ausfüllen, zu gegebener Zeit.
Jetzt können Sie beginnen, erstellen Ihre zweite HTML-Datei (und Ihre dritte, vierte...). Der Projekt-Datei-Liste alle hinzufügen (zweite Schaltfläche von oben). Sie müssen nicht alle Dateien zu erstellen, bevor Sie starten, Erstellen der Datei, es ist oft eine gute Idee, eine Datei zu einem Zeitpunkt für das Projekt, mit kompletten Keywords hinzufügen und sie waren in der Inhaltsliste sein sollen. Wenn Sie erstellt und ein oder zwei Dateien mehr hinzugefügt haben, bewegen Sie zurück in die Registerkarte Index. Rechten Maustaste, und wählen Sie einfügen-Schlüsselwort. Geben Sie das Stichwort, und klicken Sie dann auf hinzufügen. Sie können mehrere Dateien ein Schlüsselwort zuordnen. Fügen Sie Weitere Suchbegriffe wie Sie gehen. Sie können sub-key-Wörter, auch erstellen, indem Erstellen eines normalen Schlüsselwort und verschieben es mithilfe der Pfeilschaltflächen (auf der Symbolleiste).
Verschieben Sie wieder an den Inhalt Registerkarte hinzufügen Themen und Inhalte für die Dateien, die Sie verwenden möchten. Sie können dies in ähnlicher Weise mithilfe der Pfeil-Schaltflächen der Symbolleiste verschieben.
Obwohl dies keine sehr gründliche Anleitung in Hilfedateien zu schreiben ist, fühle ich mich, dass es deckt, was Sie brauchen, zu wissen, wann Sie rund um Ihr Programm zu dokumentieren. Experimentieren ist keine schlechte Sache, vor allem mit einer Dokumentation, die nie stört Nutzer die Grundlagen der HTML-Hilfe, schreiben zu lernen. Die Dokumentation von Heerhugowaard haben einen einfachen Teil (wie z. B. 'Entwerfen Sie ein Hilfesystem') und eine übermäßige technische Teil ('HTML Help Referenzen'). Wie auch immer, Heerhugowaard ist kein schlechtes Programm, es ist einfach im Stich gelassen von seiner Dokumentation und beachten Sie dies wenn Sie es Schnittstelle verwendet werden. Hoffe, dass Sie genossen dieses Mini-Tutorial.
Microsoft musste ändern die API verwendet, um die Hilfefunktionen zugreifen, wenn sie das HTML-Hilfesystem (HH) erstellt, und daher ist die Umsetzung der in Delphi Hilfe etwas ungültig geworden. Um dieses Problem zu umgehen heruntergeladen habe ich eine Freeware-Kit von www.helpware.net. Es wird angenommen, um den Prozess der Implementierung einer HH-Datei in Ihrer Anwendung ein Kinderspiel.
Als ich die Dokumentation für dieses Kit zuerst sah, sah ich, dass alle, die zusammen mit ihm kam war eine einfache Textdatei. Allerdings merkte ich schnell, es war die einzige Dokumentation erforderlich. In diesem Artikel werde ich den Fokus auf die Funktion HtmlHelp, verwendet um ein HH Fenster mit jedem Thema, das Sie möchten festlegen. Die Themen werden gefunden, indem mit dem Dateinamen des Themas zu bringen, z.B. Wenn eine der Dateien in der HH-Datei 'versionhistory.htm' benannt ist, der folgende Aufruf holt oben die HH-Datei mit der Version Geschichte Thema:
HtmlHelp (GetDesktopWindow, 'C:\help.chm::/versionhistory.htm',
HH_DISPLAY_TOPIC, 0);
GetDesktopWindow kann durch eine einfache 0 ersetzt werden, aber die Helpware Group empfiehlt die Verwendung von GetDesktopWindow. Denken Sie daran, das obige Beispiel ist schlecht, es zu tun, müssten Sie einen Variablen Pfad zu der Datei haben (verwenden Sie nicht Application.HelpFile direkt).