WinHelp-Projekt erstellen

Allgemeines ,
Seiten / Projekt erstellen lassen , Seiten einbinden ,
Projektdatei erstellen , Contentsfile erstellen ,
 RTF-Seiten erstellen ,
Compilieren , Testen

vorige Seite

nächste Seite

 

Nach oben   Allgemeines:

   

    Um eine WinHelp-Hilfedatei zu erhalten, müssen Sie diese erstellen lassen. Hierzu müssen je nach gewünschter Funktion außer den RTF-Seiten noch verschiedene andere Dateien erstellt werden. Diese werden letztendlich vom Helpcompiler in eine einzelne Hilfedatei vereint.
    Auch zur Erstellung dieser weiteren Dateien benötigen Sie mit HTML-Help Projects keine besonderen Kenntnisse.

    Die folgenden Hintergrundinformationen reichen für die meisten WinHelp Hilfeprojekte aus:
    Das     Hilfefenster zeigt immer nur die Hilfeseiten an. Über die Buttons Inhalt, Index und Suchen wird ein weiteres Fenster mit den entsprechenden Tabs geöffnet.
    Über die << und     >> Buttons kann zur nächsten bzw. vorhergehenden Seite gewechselt werden.
    Seiten die man über diese Buttons erreichen können soll, müssen in     sogenannten Browsesequenzen definiert werden. Dies ist mit HTML-Help-Projects jedoch kein Problem.

      WinHelpSite

      Funktion

      Bedeutung

      Wird angezeigt wenn

      Contents

      Inhaltsverzeichnis zum direkten Navigieren zu bestimmten Seiten.
      (in obigem Bild nicht vorhanden)

      Index

      Stichwortliste zum auffinden von Seiten anhand von Ihnen angegebener Stichwörter.

      Suchen

      Volltextsuche über alle Seiten hinweg durch Eingabe eines Suchbegriffs.

    In den Fenstereinstellungen wird außerdem angegeben, welche Buttons angezeigt werden sollen, wie groß das Hilfefenster beim öffnen sein soll etc.

    Das ganze Projekt oder Teile davon können Sie über die Hilfe-Projektvorschau CreateHelpProj im Projektnavigator erstellen lassen. Hierbei werden Sie Schritt für Schritt an Ihre Hilfe herangeführt.
    Sie können jederzeit einen oder mehrere Schritte vor oder zurückgehen, Änderungen vornehmen und die entsprechende Datei jeweils durch Knopfdruck erstellen lassen.
    Über F1 erhalten Sie zu jedem Schritt bei Bedarf eine entsprechende Hilfe.
    Am Ende wird Ihre     Hilfedatei compiliert und automatisch aufgerufen.
    Direkt in HTML-    Help-Projects können Sie die erstellte Hilfe daraufhin bei Bedarf testen.

Nach oben   Seiten / Projekt erstellen lassen:

   

    Bei aktiviertem Projektnavigator kann nach Anwahl von CreateHelpProj das komplette Projekt oder auch nur Teile davon erstellt werden.
    HTML-Help Projects verwaltet innerhalb des aktuellen Projektes beliebig viele Einstellungen zum erstellen von     Hilfedateien aus Seiten Ihres Projekts.
    Somit ist es Ihnen bei Bedarf möglich, verschiedene Versionen von     Hilfedateien mit unterschiedlichen Seitenzusammenstellungen zu erzeugen.

    Projekterstellung:
    Wählen Sie entweder aus der Liste einen Namen aus, oder geben Sie einen neuen Namen für Ihre Projekterstellung ein.
    Bitte beachten Sie hierbei, dass Ihre     Hilfedatei diesen Namen erhält, Sie können diese nach der Erstellung jedoch beliebig umbenennen.

html-help

html-winhelpeinst

    Hinweis Ein neuer Name erscheint erst in der Liste, nachdem tatsächlich Seiten erstellt wurden.

    Erstelle Info-Seite:
    Wählen Sie an, ob eine Infoseite erstellt werden soll. Erstellt lediglich eine     Kurzübersicht der Files.
    HTML-Help:
    Wählen Sie diese Funktion ab und "32 Bit Hilfe" an.
    Hinweis Vor erstellen von 16 Bit Hilfen lesen Sie bitte diese Hinweise

Wählen Sie "Weiter"

Nach oben   Seiten einbinden / Inhaltsverzeichnis definieren / Browse Sequenz:

   

    Sie erhalten eine Liste, in der genau wie im Projektnavigator alle Gruppen und Seiten eingetragen sind. Mit Hilfe dieser Liste bestimmen Sie, welche Seiten compiliert werden sollen, außerdem stellt diese Liste auch das spätere Inhaltsverzeichnis der WinHelp-Hilfe dar. Die Reihenfolge in dieser Liste bestimmt außerdem die Browsereihenfolge für die << und >> Buttons.

    Sie können hier wie gewohnt Gruppen aufklappen.
    Außerdem können Sie Gruppen verschieben und Seiten z.B in eine andere Gruppe ziehen.
    Sie Können eine Gruppe auch in eine andere hineinschieben und so eine ganz individuelle Gliederung des Inhaltsverzeichnisses erreichen..

    Über die rechte Maustaste können außerdem die Bezeichnungen geändert werden.
    Auch zusätzliche Gruppen können Sie über die rechte     Maustaste anlegen.
    Für     Profiuser, besteht die Möglichkeit, zusätzliche Verweise und auch Makros einzufügen.

html-liste

    Nicht Einbinden:
    Wenn Sie eine Gruppe oder eine Seite angewählt haben, können Sie diese über F5 vom compilieren auss    chließen.

    Alle Seiten erstellen:
    Wenn Sie diesen Punkt anwählen, werden alle Seiten der Liste erstellt, unabängig davon, ob diese auf "Nicht Einbinden" gestellt sind oder nicht.

    In nebenstehender Abbildung sind z.B alle Seiten in der Gruppe Standard, Poppig und Winhelp über F5 vom erstellen ausgeschlossen worden. Außerdem die Seite "Neue Seiteb" in der Gruppe "Modern" .

    Alle anderen Seiten werden erstellt.
    Sollten in den Seiten, die erstellt werden Verweise zu den ausgeschlossenen Seiten definiert sein, dann werden diese Verweise nicht erstellt und Sie erhalten einen Warnhinweis.

    TipSie erstellen und verwalten mehrere Hilfedateien?
    Dann wäre es denkbar, jeweils ähnliche in ein und dem selben Projekt anzulegen. Sie erstellen also im Projektnavigator lediglich eine Gruppe für ein neues Projekt.
    Für jede     Hilfedatei legen Sie dann eine Projekterstellung an, in der Sie die jeweils anderen Gruppen einfach ausschließen.

html-listeb

In den meisten Fällen werden Sie keine Seiten vom Erstellen ausschließen.
Unter Umständen erstellen Sie jedoch verschiedene Hilfedateien aus einem Projekt heraus, dann wird Ihnen diese Funktion sehr nützlich sein. Außerdem haben Sie bei sehr großen Projekten so die Möglichkeit nur die Kapitel und Seiten zu compilieren, die Sie gerade testen wollen.

    Standard Anzeigefenster:
    Ein     Hilfeprojekt benötigt zum compilieren eine Fenstereinstellung in der die Hilfeseiten standardmäßig angezeigt werden sollen. Ziehen Sie also aus dem Projektnavigator aus der Liste Fenster eine Fenstereinstellung in dieses Feld. Achten Sie darauf, dass in dieser Fenstereinstellung auch die Angaben für die WinHelp-Hilfe gemacht wurden. Sie definieren hier also Fensterhintergrundfarbe, Verweisfarbe, die Buttons etc.

html-listefenster

    Nicht im Inhaltsverzeichnis:
    Sie können nun für jede Gruppe und auch für jede Seite wählen,     ob diese überhaupt im Inhaltsverzeichnis der erstellten Hilfedatei erscheinen soll. Wählen Sie Hierzu die entsprechenden Gruppen und Seiten einzeln an und wählen Sie diese Option.

html-nichtinh

    Für jede Seite können Sie eine ID und ein Anzeigefenster angeben.
    Wählen Sie hierzu eine Seite in der Liste an.
    ID der Seite:
    HTML-Help-Projects hat bereits den Namen der Seite als ID eingetragen.
    Sie können diese hier bei Bedarf ändern. Anhand dieser     Id ist es Ihnen später möglich die Seite direkt aus einer Anwendung heraus aufzurufen.

    Anzeige in Fenster:
    Soll die Seite nicht in dem vorher definierten Standardanzeigefenster angezeigt werden, dann ziehen Sie aus dem Projektnavigator ein Anzeigefenster für diese Seite in dieses Feld.

    Hilfedatei:
    Dieses Feld benötigen Sie nur, wenn sich diese Seite gar nicht in der aktuellen Hilfedatei befindet. Geben Sie in diesem Fall hier den Namen der Hilfedatei ein, in welcher sich die Seite befindet z.B hilfe2.chm.

html-listeseite
HTML-Help-Projects erstellt automatische ID's und Aliasnamen mit Kontextnummern für jede Seite. Die ID können Sie hier bei Bedarf ändern.

Auszug aus der erstellten Projektdatei.
[MAP]
Seite1   11
Index   10
Seite2   12
ThemaExtern   13

[FILES]
.\Seite1_00011.rtf
.\Index__00010.rtf
.\Seite2_00012.rtf
.\ThemaExtern_00013.rtf
Eine bestimmte Seite wird bei WinHelp über die Kontextnummer aufgerufen. Alternativ können Seiten über A-Link K-Link oder Multikey aufgerufen werden.

    Browse Sequenz:
    Über F5 kann außerdem festgelegt werden, ob eine Seite über die Browse-Buttons "<<" ">>" erreicht werden kann.
    In     nebensthendem Beispiel werden auf Seite 1 keine "<<" ">>" Buttons angezeigt. Wenn man sich auf der Seite "Index" befindet, kann mit ">>" zur Seite "Seite2" gewechselt werden. Ebenso von Seite "Seite 2" über "<<" zu Seite "Index"
    Hinweis    Die Browse-Buttons können in den Fenstereinstellungen aktiviert werden.

winh-browseseq
Seite 1 kann nicht über << oder >> erreicht werden.


Wählen Sie "Weiter"

Nach oben Grafiken überschreiben:

   


    Vorhandene Grafikdateien überschreiben:
    Nicht angewählt (Vorwahl):
    Beim späteren erstellen der Seiten erfolgt vor überschreiben von bereits vorhandenen Grafikdateien und sonstigen Files, die Sie über die Liste Objekte hinzugefügt haben eine Abfrage.

    Angewählt:
    Es erfolgt später keine Abfrage vor dem Überschreiben.

e-html3
Sie erhalten folgenden Dialog.

e-rtf-grafexist

Sie können wählen, ob nur die aktuelle Datei überschrieben werden soll, alle weiteren auch, oder auch keine. Im Normalfall werden Sie die Dateien überschreiben lassen.

    HinweisHTML-Help Projects kopiert alle benötigten Dateien für Ihr WinHelp-Hilfe Projekt in das Zielverzeichnis.

Wählen Sie "Weiter"

Nach oben Projektdatei erstellen:

   


    Projektdatei erstellen:
    In diesem Schritt wird die Projektdatei für den Helpcompiler erstellt.
    Betätigen Sie hierzu "    Projektdatei erstellen"
    HTML-    Help-Projects fügt automatisch alle nötigen Informationen zur Projektdatei hinzu.
    Vor dem ersten erstellen müssen Sie lediglich die weiter unten unter
    "Einstellungen zur Projektdatei"     Beschriebenen Einstellungen vornehmen.

    Projektdatei anzeigen:
    Öffnet die erstellte Projektdatei in Ihrem Texteditor. Sie können sich hier bei Bedarf Kontextnummern, und sonstige Informationen zum aufrufen aus Ihrer Anwendung entnehmen.

    Nur geänderte ..:
    Speichert die Projektdatei immer nur dann, wenn auch tatsächlich Änderungen stattgefunden haben. (IntelliSaveFile)

winhelpproja
Sie erhalten folgenden Dialog.

    Einstellungen zur Projektdatei:
    Die folgenden Einstellungen sollten Sie auf jeden Fall vornehmen.
    Titel:
    Den Titel Ihrer Hilfedatei. Dieser erscheint als Fenstertitel.
    Copyrighttext:
    Erscheint beim ausdrucken der Hilfedatei, oder wenn Text aus dieser kopiert wird.

    Seite die beim..:
    Ziehen Sie die Seite aus dem Projektnavigator in dieses Feld, die Standardmäßig beim öffnen der Hilfedatei angezeigt werden soll.
    Language:
    Anklicken führt zum Wechsel von English auf Scandinavian. (Verwendeter Zeichensatz)

winhelpprojektaa

    Multikeyword:
    Bei WinHelp sind K-Link A-Link und drei weitere Schlüsselworttabellen möglich.
    Wenn Sie bei den Stichwörtern     eine oder mehrere der Stichwortlisten 3, 4 oder 5 benutzen, können Sie hier für jede Liste den Kennbuchstaben für den Aufruf der jeweiligen Liste vorgeben.
    K und A können nicht geändert werden.

    Compiler Optionen:
    Warning:
    Level der Fehlertoleranz.
    Compress:
    Komprimieren der erstellten Hilfe.
    Report:
    Ein: Ausgabe von Meldungen beim compilieren.
    CD-Rom: Optimiert für verteilung auf CD
    Icon:
    Sie können hier ein eigenes Icon für die Hilfedatei auswählen.

winhelpprojektax

    Alle weiteren Optionen sollten Sie anschließend testen.
    Forcefont:
    Bei angabe bzw. Auswahl einer Schriftart, wird die komplette Hilfe in dieser angezeigt.

    Baggage Section:
    HTML-Help-Projects trägt in der Projektdatei unter [FILES] alle benötigten Dateien automatisch ein, sofern diese eingetragen werden müssen. Sollten Sie weitere Dateien in die Hilfe hineincompilieren wollen, dann tragen Sie diese hier ein.
    Achtung! Diese Dateien müssen Sie von Hand in das gleiche Verzeichnis hineinkopieren, in welchem sich auch die     Projektdatei befindet.

    Map-Section:
    HTML-Help-Projects erstellt die Map-Section in folgendem Format automatisch.

      [MAP]
      Seite1   11
      Index   10
      Seite2   12
      ThemaExtern   13

    Sollten Sie ein anderes bzw. weiteres Format verwenden wollen, oder z.B eine bestimmte Seite über eine weitere Kennung erreichen wollen, dann können Sie in dieser Liste beliebig viele Einträge vornehmen.

    Makros:
    Makros die beim starten der Hilfe aufgerufen werden sollen laden Sie vom Projektnavigator in diese Liste. Z.B. Musik abspielen, About etc.

Wählen Sie "Weiter"

Nach oben Contentsfile erstellen:

   

    Contentsdatei erstellen:
    (Inhaltsverzeichnis)
    In diesem Schritt wird die Contentsdatei für den Helpcompiler erstellt.
    Betätigen Sie hierzu "    Contentsfile erstellen"
    HTML-    Help-Projects erstellt anhand der bereits im ersten Schritt erstellten Liste das Inhaltsverzeichnis für Ihre Hilfedatei.
    Sie müssen hierzu keine weiteren Einstellungen vornehmen.

    Contentsfile im Editor anzeigen:
    Öffnet die erstellte Contentsdatei in Ihrem Texteditor. Bei Bedarf für erfahrene Benutzer um eventuell weitere Verweise direkt einzutragen.

    Contentsfile im Workshop bearbeiten:
    Öffnet die erstellte Contentsdatei im Help-Workshop (sofern dieser installiert ist). Ebenfalls bei Bedarf für erfahrene Benutzer um eventuell weitere Einstellungen vorzunehmen.

winhelpprojcontents
Sie erhalten folgenden Dialog.

    Nur geänderte ..:
    Speichert die Contentsdatei immer nur dann, wenn auch tatsächlich Änderungen stattgefunden haben. (IntelliSaveFile)

Wählen Sie "Weiter"

Nach oben RTF-Seiten erstellen:

   

    In diesem Schritt werden die RTF-Seiten für die Hilfedatei erstellt. Betätigen Sie hierzu
    "RTF-Seiten aktualisieren"
    HTML-    Help-Projects erstellt alle Seiten, die in der bereits im ersten Schritt erstellten Liste, nicht vom Erstellen ausgeschlossen wurden. Alle benötigten Dateien werden im Zielverzeichnis bereitgestellt.
    Sie müssen hierzu keine weiteren Einstellungen vornehmen.

winhelp-htmlsites
Sie erhalten folgenden Dialog.

    IntelliSaveFile
    Es werden immer alle gewählten Seiten erstellt, aber     nur dann gespeichert, wenn tatsächlich Änderungen vorliegen. Dies bringt Ihnen beim erstellen einer Hilfedatei lediglich den Vorteil, dass Sie nochmals eine Rückmeldung erhalten, welche Seiten Änderungen aufweisen.

    RTF-Datei anzeigen
    Öffnet einen Dialog zum Öffnen der erstellten Seiten in einem Editor.

    RTF ab Byte Offset
    Zeigt den Inhalt einer RTF-Datei ab einem bestimmten Byte Offset     an.
    Kann der Helpcompiler eine Seite nicht korrekt übernehmen, zeigt dieser eine Fehlermeldung mit einem Byteoffset an. Sie können in diesem Fall herausfinden, um welche Stelle auf der Seite es sich handelt, und entsprechend Änderungen vornehmen.

    HinweisDiese Funktionen erleichtert Ihnen die Fehlersuche, wenn der Helpcompiler ein Seite nicht erstellen kann.

Wählen Sie "Weiter"

Nach oben Compilieren:

   

    In diesem Schritt wird die Hilfedatei compiliert. Alle Infos zum Compiler finden Sie hier.

    Betätigen Sie hierzu "Helpcompiler starten".
    HTML-    Help-Projects öffnet den Helpcompiler mit der erstellten Projektdatei.
    Der Fortschritt wird in einem extra Fenster angezeigt.
    Nach kurzer Zeit wir die erstellte Hilfe automatisch geöffnet.

winhelp-htmlcompile
Sie erhalten folgenden Dialog.

    Compiler Meldungen anzeigen
    Während dem Compilieren werden Status und Fehlermeldungen ausgegeben. Diese können auch hinterher jederzeit über diesen Button angezeigt werden.
    Warnungen sollten Sie beachten und wenn möglich die Ursache beseitigen.
    Fehler müssen Sie auf jeden Fall beseitigen.
    Solange ein F    ehler vorliegt wird die Hilfedatei im Normalfall nicht erstellt. Korrigieren Sie also je nach Meldung die Projekteinstellungen, die HTML-Seite oder das Contentsfile. Lassen Sie die entsprechende Datei neu erstellen und compilieren Sie erneut.

    Projektverzeichnis
    Öffnet das     Zielverzeichnis im Explorer. Sie finden dort Ihre erstellte Hilfedatei.
    D    ie Projektdatei und das Contentsfile sind nur zum erstellen der Hilfe nötig. Sie müssen diese nicht mit ausliefern.

    HinweisHaben Sie Multimedia oder sonstige Files auf einer Seite eingefügt, und "File intern verwalten" abgewählt, dann finden Sie diese Dateien ebenfalls hier, diese sind für die Funktion der Hilfedatei nötig, und müssen mit dieser mitgeliefert werden.  

Nach oben Testen:

   

    Im Dialog Compilieren können Sie über das Menü "Erstellte Hilfe manuell testen" Ihre erstellte Hilfe auf verschiedene Arten aufrufen.

    Standardmäßig ist "Direkt" angewählt, HTML-Help-Projects öffnet in diesem Fall bei betätigen von F11 oder dem Button
    "Hilfe aufrufen" die     Hilfedatei so als würde diese im Explorer über doppelklick geöffnet.

    Kontextnummer:
    Eingabe einer Kontextnummer ruft die entsprechende Seite auf.

    Schlüsselwort:
    Eingabe eines A-Link Schlüsselwortes ruft die entsprechende Seite auf. Dieses Schlüsselwort muss definiert sein.

    Suchfenster:
    Öffnet die Hilfe mit angewähltem
    "Suchen Tab". Es kann vorab ein     Suchbegriff eingegeben werden.

    Pop-UP-Hilfe:
    Blendet die Popup Hilfe mit einer bestimmten Kontextnummer ein. Der Popup besteht aus dem Text innerhalb der Nonscrolling-Region der Seite.

    Multikey:
    Aufruf über A oder Klink Stichwort.

    Help-Author Modus:
    Wenn aktiviert, wird in der Titelzeile der Hilfedatei die jeweilige Kontextnummer eingeblendet.

    Hilfedatei automatisch testen:
    Es stehen mehrere Menüpunkte zum automatischen testen der Hilfedatei zur Verfügung. Hierbei werden jeweils alle Seiten durchlaufen.

help-htmltesten

winelp-htmltesteb