Anhang A: Eigene Online-Hilfe zuordnen

Mit 4D können Sie jeder 4D Datenbank eine eigene Online-Hilfedatei zuordnen. So erhält der Benutzer zusätzliche Erläuterungen zur Funktionsweise Ihrer Anwendung.

Die selbst erstellte Online-Hilfe ist mit allen 4D Umgebungen kompatibel: Einzelplatz, Client/Server-Betrieb, interpretiert oder kompiliert, 4D Desktop Interpreted oder mit integrierter 4D Volume Desktop.

4D unterstützt für Hilfedateien die Formate CHM und HTML. Diese Formate entsprechen den Standards der Software-Industrie.

Außerdem können Sie jedem Formular der Datenbank einen bestimmten Teil dieser Hilfedatei zuordnen, und so dem Benutzer kontextuelle Online-Hilfe zur Verfügung stellen.

Sie können die Hilfedatei Ihrer Anwendung in folgenden Formaten liefern:

• Datei “.CHM”, das ist das Standardformat von Microsoft® Help für Windows. Dieser Dateityp lässt sich mit dem Programm Microsoft® HTML Help Executable (HH.EXE) öffnen, das im Betriebssystem integriert ist. Die Dateien sind mit Windows XP und Windows Vista kompatibel.
  Zum Erstellen und Kompilieren der .CHM-Dateien benötigen Sie das Programm HTML Help Workshop, das von Microsoft® kostenlos zur Verfügung gestellt wird.
• Datei “.HTM”, das ist das HTML-Format. Damit erstellen Sie eine für alle Plattformen identische Online-Hilfe, die dann über einen Web Browser angezeigt wird.

Ist die Hilfedatei erstellt, müssen Sie diese einer Datenbank zuordnen. Sie wird dann automatisch aufgerufen, wenn der Benutzer die online Hilfe aufruft (siehe unteren Absatz Online-Hilfe in einer 4D Datenbank aufrufen) Dazu müssen folgende Bedingungen erfüllt sein:

• Der Name der Hilfedatei muss identisch sein mit dem Namen der Datenbankstruktur und je nach Format und Plattform die Erweiterung “.CHM” oder “.HTM” haben. Heißt die Strukturdatei z.B. „Rechnungen.4DB“, muss die Hilfedatei „Rechnungen.CHM“ oder „Rechnungen.HTM“ lauten. 
• Die Hilfedatei wird neben die Strukturdatei der Datenbank oder in den Ordner Resources gelegt, der auf derselben Ebene wie die Strukturdatei liegt.

4D Server: Soll die Hilfedatei mit 4D Server auf allen Arbeitsstationen verfügbar sein, legen Sie die Datei in den Ordner Resources. Sie wird dann automatisch auf die Arbeitsstationen übertragen. 

Auch Plug-Ins können eine Hilfedatei haben. Diese muss sowohl für Einzelplatz- als auch Client/Server-Anwendungen im Ordner PlugIns liegen. Die Plug-In Hilfedatei muss den Namen des Plug-In mit der Endung .CHM oder .HTM haben. Für Plug-Ins die als Ordner geliefert werden, muss die Hilfedatei an folgender Stelle liegen:
- Neben dem ausführbaren Plug-In, also entweder in Contents/MacOS oder Contents/Windows.
- oder im Ordner Contents/Resources des Plug-In.

Ebenso können Komponenten eine eigene Hilfedatei haben. Sie muss neben der Strukturdatei der Komponente liegen. Weitere Informationen dazu finden Sie im Abschnitt Online Hilfe für Komponenten.

Eine kontextuelle Online-Hilfe erstellen Sie, wenn Sie jedem Ihrer Formulare eine Nummer zuweisen. Ruft der Benutzer dann die Online-Hilfe von einem Formular aus auf, erscheint die Hilfeseite mit derselben Nummer wie das Formular.

Die kontextuelle Online-Hilfe ist verfügbar:

• Unter Windows, wenn sie im CHM-Format ist.
• Unter Windows und Mac OS, wenn sie im HTML-Format ist.

Eine Kennummer weisen Sie dem 4D Formular in den Formulareigenschaften zu. Weitere Informationen dazu finden Sie im Abschnitt Hilfe.

Der Hilfedatei müssen Sie dieselbe Nummer zuordnen wie dem Kapitel Ihres Formulars. Diese Operation variiert je nach dem verwendeten Format:

• Für CHM Dateien schlagen Sie in der Dokumentation zum Programm HTML Help Workshop nach.
• Für HTML Dateien legen Sie für jeden Abschnitt eine Marke fest und weisen ihm eine Nummer zu.
  Einen Abschnitt legen Sie mit folgender Marke an:
  

  <A NAME="Section">

  
  Zum Beispiel:
  

   <A NAME="21">

  
  Die URL des Abschnitts lautet:
  

  <A HREF="#Section">...</A>

  
  Zum Beispiel:
  

  <A HREF="#21">...</A>

Ist die übergebene Nummer gleich 0 (Null), zeigt 4D die erste Seite der Hilfedatei an.

In 4D rufen Sie die eigene Online-Hilfe einer Datenbank auf zwei Arten auf:

• Sie wählen im Menü Hilfe>Datenbankname Hilfe. In diesem Fall wird die erste Seite der Hilfedatei angezeigt.
• Sie drücken die Taste F1 (Mac OS und Windows) oder die Taste Hilfe (nur Mac OS) wenn ein Formular im Anwendungsmodus angezeigt wird. Ist dem Formular eine Hilfedateinummer zugeordnet, erscheint die entsprechende Seite (kontextuelle Hilfe). Andernfalls erscheint die erste Seite der Hilfedatei.

Hinweis: Auf Mac OS lässt sich die Funktionsweise der F1 Taste anpassen. Drückt der Benutzer im Anwendungsmodus diese Taste, gilt folgendes:

• Gibt es eine Datei “DatenbankName.HTM” neben der Strukturdatei der Datenbank, wird die Standardoperation zum Verwalten von 4D Online-Hilfe Dateien integriert. Die Hilfedatei wird in einem standardmäßigen Browser-Fenster geöffnet.
• Andernfalls führt 4D nichts aus und der Entwickler muss die Operation selbst steuern. Auf diese Weise kann er ein eigenes Hilfesystem einrichten oder der F1 Taste eine andere Funktion zuweisen.