RTFC Hypertext-Compiler 

  Home  
  Wegweiser  
  Braille  
  Daisy  
  Download  
  Kontakt  
  Datenschutz  
  Impressum  

  Inhalt  
  Index  
  Suche  

[RTFC Logo]

[Inhalt] RTFC Hypertext-Compiler   [Verzeichnis] Index

[Inhaltsverzeichnis]

10.11 -H - Help Map-Datei (HM) für ein Anwendungsprogramm erzeugen

162 Syntax
-H[dateiname|*[.HM]][,N]

Groß-/Kleinschreibung spielt beim Dateiname keine Rolle. Eine zusätzliche Pfadangabe ist zulässig. Wenn Sie "*" anstelle eines Dateinamens angeben, wird der Name des (ersten) Quelldokuments übernommen. Bei fehlender Dateiendung wird .HM verwendet. Sie können aber auch andere Endungen wie .H oder .HPP angeben, um ein "Header-File" für ein C++-Programm zu erzeugen.

Die Angabe ,N bewirkt hier, dass keine Kommentarzeichen in die HM-Datei eingefügt werden.

Beschreibung
Erzeugt eine Help Map-Datei, mit der die Ressourcen (Menübefehle, Dialogelemente usw.) eines Anwendungsprogramms bestimmten Hilfethemen zugeordnet werden (kontext-sensitive Hilfe).

In der HM-Datei sind die "Context Strings" für alle Hilfethemen zunächst als Kommentarzeilen enthalten, wenn nicht zusätzlich "N" angegeben wurde. Die Context-IDs werden in der Reihenfolge der Hilfethemen aufsteigend vorgegeben. Um eine Zuordnung zwischen einem Thema und einer Resource- bzw. Context-ID der Anwendung herzustellen muss ggf. das Kommentarzeichen entfernt und die ID hinter dem Context String ersetzt werden.

Beim Aufruf der Hilfe aus einer Anwendung wird dem Hilfesystem die entsprechende ID mitgeteilt. Windows Help bzw. HTML Help ermittelt dann anhand der ID das passende Hilfethema. Dabei wird zunächst der zugehörige Context String aus der Help Map-Datei ermittelt und dann das Thema angezeigt, das diesem Context String entspricht.

Sie können auch die von RTFC vorgegebenen Context-IDs beibehalten und in Ihren Programmcode einbinden. In diesem Fall verwenden Sie die HM-Datei - wie oben erwähnt - als "Header-File" für Ihr Programm.

RTFC aktualisiert die HM-Datei mit neuen Themen, indem es deren Context Strings an das Dateiende anhängt und die nächste freie ID einträgt. Dadurch kann die Hilfe im Laufe eines Entwicklungsprojekts leicht erweitert werden. Bereits zugeordnete IDs bleiben erhalten.

RTFC fügt außerdem ein Include-Kommando für die HM-Datei im Abschnitt [Map] in der Projektdatei (siehe "Arbeiten mit Projektdateien") ein, damit die Datei vom Microsoft Help-Compiler zur Herstellung der Hilfe verwendet wird. Für HTML Help-Projekte werden die Context Strings mit den zugehörigen HTML-Dateien im Abschnitt [ALIAS] eingetragen, damit das Hilfesystem die jeweilige HTML-Datei ermitteln kann.

Vorgabewert
RTFC erzeugt keine Help Map-Datei.

163 Vorgabewert bei fehlender Dateiangabe
RTFC erzeugt eine Help Map-Datei mit Namen dokument.HM, wobei "dokument" der Name der Ausgabedatei ohne Endung ist, und fügt diese in der Projektdatei (siehe "Arbeiten mit Projektdateien") im Abschnitt [Map] ein.

Vorgabewert ohne die Angabe ,N
RTFC fügt Kommentarzeichen in die Help Map-Datei ein.

Beispiele
RTFC -H dokument.rtf
RTFC -Hprogramm dokument
RTFC -Hprogramm.h,N dokument.rtf

[<< Zurück] 10.10 -G - Überschriften nummerieren

[Weiter >>] 10.12 -I - Überschriften für Hypertext-Verzeichnisse

Erstellt: 01.12.2010 18:00   Aktualisiert: 03.11.2018 17:00
Autor: Dipl.-Ing. (FH) W. Hubert
Copyright © 2018 Alle Rechte vorbehalten.