HTML-Help Wie kann ich ..

zur genauen Erklärung Dieses Symbol führt Sie jeweils zu weiteren Erklärungen.  
Einen Link (Verweis, Sprung) zu einem Thema in einer anderen Hilfedatei erstellen
Eine .txt Datei aufrufen z.B Readme.txt

Whats this Popups erstellen und anwenden

Popups innerhalb der Hilfe definieren und anwenden

Nonscrolling Region verwenden / abschalten

Wie lautet die TopicID

Wie kann ich von meiner Anwendung aus direkt eine bestimmte Textstelle anzeigen

Grafiken auf eine Seite einfügen. (Alle Grafikformate)

Videos und Musik auf eine Seite einfügen. (MPEG, AVI usw.)

PDF Dokumente auf eine Seite einfügen

Downloaddateien wie .zip, .exe etc.auf eine Seite einfügen

Macromedia™ Flash (SWF Files)

Dateien und Funktionen auf die Seite einfügen, die nicht über den Objekteditor hinzugefügt werden können

Eigenen HTML-Code verwenden

Tabellen oder ganze Bereiche einrücken

 

Nach oben   Einen Link (Verweis, Sprung) zu einem Thema in einer anderen Hilfedatei erstellen.

    Sie könnten hierzu das Script "Zu externer Hilfeseite" verwenden.
    Dieses finden Sie in den Stammscripts unter Helpcompiler/HTML-Help/Verweise.

    Einfacher geht es, wenn Sie wie gewohnt eine Seite anlegen und in deren Eigenschaften "nur als Verweis" anwählen.zur genauen Erklärung
    Als "URL dieser Seite" tragen Sie folgenden Code ein.
    ms-its:Pfad\hilfedatei.chm::/Pfad/hilfethema.htm

    Sie können nun wie gewohnt den Verweis zu dieser externen Hilfeseite auf die Seite in eine Grafik oder einen angewählten Textbereich ziehen.

    Angenommen Sie möchten zur Seite Projektarten.htm der Hilfedatei zu HTML-Help Projects verweisen.

    HinweisAufgerufene Hilfedatei befindet sich im gleichen Verzeichnis wie die aufrufende Hilfedatei:
    dann muss der Eintrag wie folgt aussehen.
    ms-its:htmlhelpprojects.chm::Projektarten.htm

    HinweisAufgerufenen Hilfedatei befindet sich in anderem Verzeichnis wie die aufrufende Hilfedatei:
    Ist die Hilfedatei von HTML-Help Projects z.B in c:\test abgelegt, dann muss der Eintrag wie folgt aussehen.

    ms-its:c:\test\htmlhelpprojects.chm::Projektarten.htm

    HinweisAufgerufenes Hilfethema befindet sich in einem Unterverzeichnis:
    Beim compilieren der Hilfedateien werden Seiten, die sich nicht im Hauptverzeichnis befanden mit der Unterverzeichnisangabe der Seite eingebunden.
    Ist dies der Fall, dann muß dieses Unterverzeichnis mit angegeben werden.
    Wäre z.B Projektarten.htm beim
    compilieren im Unterverzeichnis /NeueSeiten gespeichert gewesen, dann müsste der Eintrag wie folgt aussehen

    ms-its:c:\test\htmlhelpprojects.chm::/NeueSeiten/Projektarten.htm

    TipWenn Sie viele Verweise zu externen Hilfedateien erstellen müssen, dann können Sie für jede externe Hilfedatei jeweils eine Gruppe in der Liste Seiten anlegen.
    Geben Sie dann in den Eigenschaften der Gruppe unter "URL der Elemente dieser Gruppe" z.B die folgende Zeile ein. ms-its:c:\htmlhelpprojects.chm::
    Passen Sie hierbei den Pfad und Namen der Hilfedatei an.
    Der Punkt "Seiten in dieser Gruppe werden als .. " darf nicht
    angewählt werden.
    Fügen Sie nun der Gruppe einen neuen Eintrag hinzu und geben Sie hierbei den Namen der Seite innerhalb der
    Hilfedatei an, die Sie aufrufen möchten. In unserem Beispiel z.B Projektarten.
    Der Verweis wird nun automatisch richtig erstellt und kann in den Eigenschaften der Seite nachkontrolliert werden.
    ms-its:c:\test\htmlhelpprojects.chm::Projektarten.htm

Nach oben Eine .txt Datei aufrufen z.B Readme.txt  

    Sie wollen, dass die aktuelle Readme.txt die im gleichen Verzeichnis wie die Hilfedatei gespeichert ist direkt im Hilfefenster angezeigt wird.
    Fügen Sie im Objekteditor die Textdatei hinzu. zur genauen Erklärung
    Ziehen Sie anschließend die
    Datei aus der Liste Objekte in den Editor. zur genauen Erklärung

    Wählen Sie in den Eigenschaften
    "Datei intern verwalten ab".
    "Nicht in Seite einbetten an".
    Es wird nun immer die Textdatei aus dem Startverzeichnis der Hilfedatei angezeigt.

    HTMLHelp Wenn Sie "Datei intern verwalten" anwählen, dann wird die im Objekteditor hinzugefügte Textdatei in die Hilfe hineincompiliert und angezeigt.

    WinHelp In WinHelp wird immer ein externes Textviewer Programm geöffnet, da hier kein direktes einbetten von txt-Dokumenten möglich ist.

Nach oben Whats this Popups erstellen und anwenden

    Erstellen:

    Whats this Popups erstellen Sie im Help-Wizzard im Blatt Projektdatei.
    Sie können dort über den Button "Popup Texte editieren" eine Popupliste erstellen.
    Die Verbindung der Popup-Texte zu Kontextnummern erstellt HTML-Help Projects automatisch wenn Sie den Button P
    rojektdatei erstellen betätigen.


    Testen:
    Nach K
    ompilierung des Projekts können Sie Ihre Popups direkt im Help-Wizzard testen, indem Sie im Blatt Helpcompiler den Menüpunkt "Erstellte Hilfe Manuell testen/PopupHilfe" anwählen. Geben Sie dort einfach eine Id also z.B 20000 ein und betätigen Sie OK. Über dem OK-Button erscheint nun Ihr Popup.

    Anwenden:

    Z.B in VB: Es muss hierzu z.B bei den Eigenschaften der Forms "WhatsThisButton" und "WhatsThisHelp" auf "True" gestellt werden. Für die einzelnen Steuerelemente kann nun die jeweilige "WhatsThisHelpId", die in der Popupliste angegeben wurde eingetragen werden.

    Zuletzt muß die Anwendung natürlich noch mit der Hilfedatei Verbunden werden.

    z.B.

      Private Sub Form_Load()

        App.HelpFile = App.Path & "\test.chm"

    End Sub


Nach oben Popups innerhalb der Hilfe definieren und anwenden

    In den Stamm-Scripts unter Helpcompiler/Html-Help finden Sie unter Activex mehrere Scripts zum definieren von Popup-Hilfen zu Elementen auf der Seite.
    PopupTexte:
    Mit dem Script
    PopupTexte können Sie z.B beliebig viele Texte anlegen, die in die Seite eingebunden werden.
    Das Script "
    onclick PopupText xx" kann auf der Seite in Verweise und Grafiken eingefügt werden und ruft jeweils einen PopupText aus PopupTexte auf.

    In den Stamm-Scripts unter Helpcompiler/Html-Help finden Sie unter Verweise noch.
    PopupFenster:
    Mit dem Script
    PopupFenster können Sie ein ganzes Thema als Popup-Window anzeigen lassen.
    PopupText_Titel:

    Mit dem Script
    PopupText_Titel können Sie für einen markierten Textbereich einen Popuptext erstellen, der bereits beim überfahren mit der Maus aufgerufen wird.

    WinHelp Für WinHelp können Popups direkt in den Eigenschaften der Verweise eingetrasgen werden.

Nach oben Nonscrolling Region verwenden / abschalten.

    Auch bei HTML-Help Projekten erstellt HTML-Help Projects aus dem Textrahmen 1 automatisch eine Nonscrolling Region.
    Wenn Sie keine
    Nonscrolling möchten, dann verwenden Sie entweder Textrahmen 1 nicht, oder aktivieren Sie in den Eigenschaften zum Textrahmen1 "HTML-Helpseite ohne Nonscrolling". zur genauen Erklärung

    WebSite   Ebenso können Sie für WebSeiten "Web-Seiten ohne Nonscrolling" einstellen.

Nach oben Wie lautet die TopicID

    Die Topic ID wird von HTML-Help Projects automatisch anhand der eindeutigen Seitennummer erstellt. Die Seitennummer ist im Eigenschaftendialog zur Seite hinter dem Eintrag "Name der Seite" ablesbar.zur genauen Erklärung
    Diese wird beim anlegen der Seite erstellt und kann nicht geändert werden.
    Die einzelnen Topic-
    IDs können Sie aus der für den Hilfecompiler erstellten Projektdatei entnehmen und in Ihre Anwendung einfügen.

    Für .Net Anwendungen wird zum vereinfachten Zugriff automatisch eine
    C# oder VB-Net Klasse im Zielverzeichnis erstellt, mit welcher sehr einfach alle Seiten und Anker der erstellten Hilfe aufgerufen werden können. Sie benötigen in diesem Fall keine TopicId's etc. Fügen Sie die Klasse einfach in Ihren Quellcode ein.

    Die Zuweisung von der
    TopicId zu den Seitennamen nimmt HTML-Help Projects automatisch vor.
    Beispiel: Teil der Projektdatei dieser Hilfedatei

        [FILES]
        Programm-Einstellungen.htm
        Der_Projektnavigator.htm
        Projekte_verwalten.htm

        [ALIAS]
        IDH_Programm_Einstellungen=Programm-Einstellungen.htm
        IDH_Der_Projektnavigator=Der_Projektnavigator.htm
        IDH_Projekte_verwalten=Projekte_verwalten.htm

        [MAP]
        #define IDH_Programm_Einstellungen   2450
        #define IDH_Der_Projektnavigator   2400
        #define IDH_Projekte_verwalten   1260
        #define IDH_Popup_20000   20000
        #define IDH_Popup_20010   20010
        #define IDH_Popup_20020   20020
        #define IDH_Popup_20030   20030
        #define IDH_Popup_20040   20040

        Je nach verwendetem Programmiersystem kann die Seite Projekte_verwalten.htm
        direkt über den
        Filenamen Projekte_verwalten.htm
        über den Alias-Namen IDH_Projekte_verwalten
        oder über die Kontextnummer 1260

        aufgerufen werden.

    Die Kontextnummer wird wie folgt berechnet (EindeutigeSeitennummer*10) +1000
    Die Seite "Projekte verwalten" hat die eindeutige ID 26
    26*10 + 1000 = 1260

    Hinweis Die Einträge #define IDH_Popup_20000 sind automatisch erstellte Kontextnummern zu einer verwendeten Whats this Hilfetabelle. Whats this ID's sollten ab 20000 beginnen.
    Am einfachsten können Sie die erstellte Hilfe mit der automatisch erstellten Klasse für .Net aufrufen.


Nach oben Wie kann ich von meiner Anwendung aus direkt eine bestimmte Textstelle anzeigen.

    Für .Net wird je nach Einstellung automatisch eine Klasse für C# oder VB erstellt, mit welcher Sie alle Seiten und Anker der erstellten Hilfe sehr einfach aufrufen können. Fügen Sie die Klasse in Ihren Quellcode ein und rufen Sie die Hilfeseite z.B. wie folgt auf. Sie finden die Klasse nach erstellen eines Hilfeprojektes im Zielverzeichnis


    C#

    JRHelp
    myhelp = new JRHelp();
    myhelp.ShowHelpTopic(this, myhelp.HelpTopic.Pagexxx.TopicURL);

    oder öffnen eines Ankers
    myhelp.ShowHelpTopic(this, myhelp.HelpTopic.Pagexxx.Anchor_xxxx );

   

    VB.Net:
    Dim myhelp As New JRHelp
    myhelp.ShowHelpTopic(Me, myhelp.HelpTopic.Pagexxx.TopicURL)
    oder öffnen eines Ankers
    myhelp.ShowHelpTopic(Me, myhelp.HelpTopic.Pagexxx.Anchor_xxxx)

    Beachten Sie jeweils, dass in myhelp.HelpFile der absolute Pfad zur erstellten Hilfe eingetragen ist.
    Wenn Sie Ihre Anwendung ausliefern setzen Sie myhelp.HelpFile auf den Installationspfad Ihrer Anwendung, wenn die Hilfe-Datei dort hin kopiert wird.

    Die automatisch erstellte Klasse enthält alle URL's zu den Hilfeseiten und Ankern und folgende Funktionen zum aufrufen der Hilfedatei.
    ShowTableOfContents   --> Zeigt Inhaltsverzeichnis an.
    ShowHelpTopic           --> Zeigt eine bestimmte Seite anhand deren URL an.
    ShowHelpTopicID       --> Zeigt eine bestimmte Seite anhand einer ID an.
    ShowIndexList           --> Index-Fenster ist aktiv.
    ShowAssociateIndexList--> Index Fenster mit einem bestimmten Anfangsbuchstaben.
    ShowHelpFind           -->
    Suchfenster ist aktiv.
    ShowHelpKeywordAssociateIndexList-->Ähnliche
    Indexeinträge bzw. Seite mit diesem Wort wird geöffnet.

    Für ältere Programmiersysteme gilt:
    Bei Aufruf der Hilfedatei mit dem Parameter HH_DISPLAY_TOPIC können Sie direkt den Filenamen der Seite übergeben. Alo
    z.B Index.htm.
    Sie können außerdem zu jedem Anker auf einer Seite springen, indem Sie
    filename.htm#Ankername angeben.

    Beispiel für VB6:

    Private Const HH_DISPLAY_TOPIC = &H0

    Declare Function HTMLHelpTopic Lib "hhctrl.ocx" Alias "HtmlHelpA" (ByVal hwndCaller As Long, ByVal pszFile As String, ByVal uCommand As Long, ByVal dwData As String) As Long

    HTMLHelpTopic hwnd, c:\testhelp.chm, HH_DISPLAY_TOPIC, "MeineSeite.htm#MeinAnker"


    Hinweis Eine Liste mit allen Seitennamen inklusive aller Anker erhalten Sie, wenn Sie das
    Hilfeprojekt mit Infoseite erstellen lassen. Aus der Infoseite können Sie alle Anker entnehmen.
    Für .Net wird je nach Einstellung eine Klasse für
    C# oder VB erstellt, mit welcher Sie die erstellte Hilfe sehr einfach aufrufen können.

Nach oben Grafiken auf eine Seite einfügen. (Alle Grafikformate)

    Fügen Sie im Objekteditor die Grafik dem Projekt hinzu. zur genauen Erklärung
    Ziehen Sie anschließend die Grafik aus der Liste Objekte in den Editor. zur genauen Erklärung
    Anschließend können Sie über die Eigenschaften noch die Größe und Ausrichtung festlegen.
    Außerdem können Sie dort ein Verweisziel angeben und der Grafik ein Script hinzufügen, welches diese z.B. verfremdet etc. zur genauen Erklärung

Nach oben   Videos und Musik auf eine Seite einfügen. (MPEG, AVI usw.)

    Fügen Sie im Objekteditor die Video oder Sound-Datei dem Projekt hinzu. zur genauen Erklärung
    Ziehen Sie anschließend die Funktion einfach aus der Liste Objekte in den Editor. zur genauen Erklärung
    Anschließend können Sie über die Eigenschaften noch das Abspielverhalten festlegen. zur genauen Erklärung

Nach oben   PDF Dokumente auf eine Seite einfügen.

    Fügen Sie im Objekteditor das PDF-Dokument dem Projekt hinzu. zur genauen Erklärung
    Ziehen Sie anschließend das Dokument einfach aus der Liste Objekte in den Editor. zur genauen Erklärung
    Die Anzeige Größe des PDF-Dokumentes entspricht der Größe des Platzhalters, ist also eventuell zu klein.
    Sie können durch
    doppelklick auf den Platzhalter diesen bis 250% Skalieren.
    Wenn diese Größe nicht reicht haben Sie folgende Möglichkeiten.

    1. Sie erstellen für dieses PDF-Dokument einen speziellen Platzhalter im Objekteditor z.B durch die Capture-Funktionen und den Menübefehl "Angezeigte Grafik im Editor als Platzhalter" zur genauen Erklärung
    2. Oder Sie öffnen den Eigenschaften-Dialog des Platzhalters und stellen im Eingabefeld HTML-Code den Wert für Breite=width und für Höhe=height auf den gewünschten Wert. Markieren Sie dann das Feld "nicht ändern"
    3. Oder Sie öffnen den Eigenschaften-Dialog des Platzhalters und wählen "nicht in Seite einbetten". beim anklicken des Platzhalters wird dann der PDF-Reader mit dem Dokument geöffnet.

    HTMLHelp   Für HTML-Help können Sie in den Eigenschaften zusätzlich wählen, ob das Dokument innerhalb der Hilfedatei gespeichert werden soll. ("Datei internverwalten") Dies Funktioniert auch in Verbindung mit "nicht in Seite einbetten"!

    WinHelp In WinHelp wird immer der PDF-Reader geöffnet, da hier kein direktes einbetten von PDF-Dokumenten möglich ist.

Nach oben Downloaddateien wie .zip, .exe etc.auf eine Seite einfügen.

    Fügen Sie im Objekteditor die Datei dem Projekt hinzu. zur genauen Erklärung
    Ziehen Sie anschließend das File einfach aus der Liste Objekte in den Editor. zur genauen Erklärung

    HTMLHelp   Für HTML-Help können Sie in den Eigenschaften zusätzlich wählen, ob das File innerhalb der Hilfedatei gespeichert werden soll. ("Datei internverwalten")

    WinHelp WinHelp kann diese Dateien nicht speichern. Diese müssen deshalb im gleichen Verzeichnis wie die Hilfedatei bereitgestellt werden. HTML-Help Projects erledigt dies automatisch für Sie.

Nach oben Macromedia™ Flash (SWF Files).

    Fügen Sie im Objekteditor die SWF Datei dem Projekt hinzu. zur genauen Erklärung
    Ziehen Sie anschließend das File einfach aus der Liste Objekte in den Editor. zur genauen Erklärung

    Anschließend können Sie über die Eigenschaften noch festlegen ob das Flash eingebettet wird oder nicht.. zur genauen Erklärung


    HTMLHelp Für HTML-Help können Sie in den Eigenschaften zusätzlich wählen, ob das File in die Hilfedatei integriert werden soll. ("Datei internverwalten")

    WinHelp WinHelp erzeugt nach anklicken eventuell eine Fehlermeldung, wenn keine zugehörige Anwendung gefunden werden kann. Sie können in den Eigenschaften unter RTF-Optionen "Nicht in Hilfedatei verwenden" anwählen um dies zu verhindern.

Nach oben Dateien und Funktionen auf die Seite einfügen, die nicht über den Objekteditor hinzugefügt werden können.

    Steht die Datei, oder die Funktion, die Sie verwenden wollen nicht im Objekteditor zum hinzufügen zur Auswahl zur genauen Erklärung, dann können Sie diese auf jeden Fall über die Liste Script hinzufügen.
    Über den Scripteditor kann jede Art von File und Scriptsprache auch in Kombination miteinander hinzugefügt werden.zur genauen Erklärung m Scripteditor

    WinHelp Für WinHelp können hier auch jede Art von WinHelp Makros verwaltet werden..

    Sie können von jedem Projekt aus auf die Stamm-Script Datenbank und somit auf eine Vielzahl von vorbereiteten Scripts zugreifen.
    Sie finden dort Java-Scripts, Java-Applets, VB-Script, CGI, HTML-Code, Browser-spezifischen HTML-Code und
    WinHelp Makros. Diese Datenbank können Sie mit eigenen Einträgen erweitern.

Nach oben Eigenen HTML-Code verwenden.

    Sie haben hier mehrere Möglichkeiten.

    • Wenn Sie eigene/spezielle Auszeichnungen für Absätze wie <h1>, <h2> usw. definieren wollen, dann können Sie die Auswahlliste für die Absatzformatierung erweitern. zur genauen Erklärung
    • Wenn Sie eigene/spezielle Auszeichnungen für Bereiche wie <em>, <strong> usw. definieren wollen, dann können
      Sie die Auswahlliste für die Bereichsformatierung erweitern. zur genauen Erklärung
    • Sie können jede Grafik, die Sie einfügen quasi als Platzhalter verwenden, in den Eigenschaften "HTML-Code nicht ändern" anklicken und beliebigen HTML-Code eintragen. Es wird beim erstellen der Seite nicht die Grafik, sondern ihr HTML-Code verwendet.
    • Sie können über den Scripteditor an jeder Stelle im Dokument beliebigen Code einfügen. Also Head, Body und Text.

    WinHelp Für WinHelp nicht relevant..

Nach oben Tabellen oder ganze Bereiche einrücken.

    Setzen Sie das HTML-Script <ul> an den Anfang und das Script </ul> an das Ende des Bereichs.
    Mehrmaliges einfügen von
    <ul> rückt den folgenden Text oder die Tabellen auch weiter ein.
    Setzen Sie immer genauso viele <ul> Scripts wie </ul>

    WinHelp Für WinHelp nicht relevant..