RTFC Hypertext-Compiler 

  Home  
  Wegweiser  
  Braille  
  Daisy  
  Download  
  Kontakt  
  Datenschutz  
  Impressum  

  Inhalt  
  Index  
  Suche  

[RTFC Logo]

[Inhalt] RTFC Hypertext-Compiler   [Inhalt] 9.1 Was ist RTFC?   [Verzeichnis] Index

[Inhaltsverzeichnis]

9.1.1 Aufbau einer Map-Datei

RTFC benötigt eine Map-Datei, um Sprungziele für Querverweise aufzulösen. Die Map-Datei, die bei jedem CompilierVorgang erzeugt wird, ordnet jeder Überschrift im Dokument einen sog. Context String zu. Über diesen Context String kann ein Abschnitt mit Hyperlinks aus einem anderen Abschnitt, einer anderen Datei oder aus einem Anwendungsprogramm aufgerufen werden.

Wenn Sie mit dem Kommandozeilenparameter -A arbeiten, müssen Sie u. U. selbst eine Map-Datei erstellen, die Sie aber auch von einer bereits vorhandenen Map-Datei ableiten können.

Dateityp
Eine Map-Datei ist eine reine Textdatei, die Sie z. B. mit dem Windows-Editor erstellen können. Sie sollten diese Datei auf jeden Fall unter Windows erstellen und nicht unter DOS, da hier ein anderer Zeichensatz verwendet wird, d. h. Umlaute und Sonderzeichen werden anders codiert.

Dateiformat
Eine Zeile, die mit einem Semikolon beginnt, ist eine Kommentarzeile.
Leerzeilen sind zulässig.
Darüber hinaus enthält jede Zeile in der Map-Datei einen Verweistext und das zugeordnete Verweisziel (Context String und Zieldatei mit zusätzlichen Steuerzeichen) durch "#" voneinander getrennt:

Windows Help
Text#[*|%]Context String|Grafikdatei[@Datei|Context String][>Fenster]

HTML und HTML Help
Text#[%][Context String|Grafikdatei|HTML-Datei][@URL][>Fenster]

126 Die Angabe @URL muss bei HTML-Projekten immer gemacht werden, wenn keine Grafik oder HTML-Datei eingebunden wird (siehe "Verweissensitive Grafiken" und "Einbinden von HTML- und XML-Code").

Die einzelnen Parameter haben folgende Bedeutung:

"Text" kann eine beliebige Zeichenkette sein und darf nicht länger als 255 Zeichen sein. Beim Einbinden von Grafiken wird der Text als ALT-Text verwendet.
"#" dient als Trennzeichen zwischen dem Text und dem Verweisziel und darf deshalb im Text selbst nicht vorkommen.

Hinweis: 
Alle Angaben ab "#" (einschließlich) können in Map-Dateien für die Definition von Indexeinträgen entfallen (sie werden ignoriert, falls vorhanden).

"Context String" muss einem in der jeweiligen Zieldatei enthaltenen Context String bzw. lokalen Anker auf einer HTML-Seite entsprechen. Ein Context String darf nicht länger als 96 Zeichen sein.

Windows Help
Wird dem Context String das Zeichen "*" vorangestellt, dann erscheint der Querverweis zwar unterstrichen, aber nicht in der Standard-Farbe für Hyperlinks (Dunkelgrün). Wird das Zeichen "%" vorangestellt, dann erscheint der Querverweis weder unterstrichen, noch in der Standard-Farbe für Hyperlinks (Dunkelgrün).
Anstelle des Context Strings kann auch eine Grafikdatei angegeben werden. Dadurch können Sie Grafiken mit dem Dokument verknüpfen und grafische Verweise erzeugen.

HTML und HTML Help
Wird dem Context String das Zeichen "%" vorangestellt, dann erscheint der Querverweis in HTML 4.0 mit CSS Style Sheets und XHTML nicht unterstrichen.
Der Context String kann entfallen, da die Zieldatei stets als Sprungziel mit angegeben werden muss. Der Context String bietet aber die Möglichkeit, nicht nur an den Anfang einer Seite, sondern auch mitten hinein zu springen.
Anstelle des Context Strings kann auch eine Grafikdatei angegeben werden. Dadurch können Sie Grafiken über ihren ALT-Text mit dem Dokument verknüpfen und grafische Verweise erzeugen.
Ebenso kann eine HTML-Datei anstelle des Context Strings angegeben werden. Dann wird der Verweistext mit dem Inhalt der angegebenen HTML-Datei ersetzt. Dies erlaubt die Einbindung beliebiger HTML-Dateien an jeder beliebigen Stelle im Hypertext.

[@Datei] oder [@URL] ist die Angabe der Hilfe- bzw. HTML-Datei, in der das Sprungziel liegt.

[>Fenster] ist die optionale Angabe eines alternativen Fensters zur Darstellung des Hilfethemas, wobei "Fenster" eines der in der Projektdatei im Abschnitt [WINDOWS] definierten Unterfenster sein muss. In HTML wird diese Angabe mit dem TARGET-Attribut umgesetzt. Dieser Parameter darf nicht für Popup-Definitionen verwendet werden.

Besondere Hinweise
Die Einträge in der Map-Datei können völlig ungeordnet sein.
Wenn in einer Map-Datei Duplikate vorkommen, wird der erste Eintrag verwendet.
127 Wenn in mehreren gleichzeitig verwendeten Map-Dateien Duplikate vorkommen, gelten bestimmte Vorrangregeln (siehe "-A - Automatische Querverweise").

Windows Help
Anstelle eines Context Strings ist auch die Angabe von Makros möglich. Dann lautet die allgemeine Syntax:

Text#[*|%]!Makro[;Makro][;Makro]...

Für Informationen über Makros lesen Sie bitte "Win32 SDK Programmer's Reference, Volume 4" unter "Part 2: Tools Reference, Windows Help Statements and Macros" von Microsoft.

HTML und HTML Help
Anstelle der Zieldatei können auch allgemeine URLs angegeben werden. Auf diese Weise können z. B. auch sog. Sendmail-Links erzeugt werden, die beim Anklicken ggf. einen Mail-Client laden.

Beispiele:

Windows Help
Erstellen von Hypertext mit RTFC#erstellen_von_hypertext_mit_rtfc
So wird's gemacht#so_wird27s_gemacht2e2e2e@Rtfc.hlp
Hinweise#besondere_hinweise>info
Grafik#datei.bmp

HTML und HTML Help
Datei lokal#@../../dokus/info.htm
Abschnitt in lokaler Datei#abschnitt@../../dokus/info.htm
Datei im Web#@http://www.domain.de/seite.html
Datei zum Download#@ftp://www.domain.de/pfad/datei.zip
Schreiben Sie eine Mail#@mailto:name@domain.de
Grafik#datei.png
Verweissensitive Grafik#datei.png@http://www.domain.de/pfad/seite.html
Eingebundener HTML-Code#include.htm

Siehe auch: 
 
 
 
 
 
 

[< Zurück] 9.1 Was ist RTFC?

[Weiter >>] 9.1.2 Von RTFC erzeugte Grafikdateien

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