RTFC Hypertext-Compiler 

  Home  
  Wegweiser  
  Braille  
  Daisy  
  Download  
  Kontakt  
  Datenschutz  
  Impressum  

  Inhalt  
  Index  
  Suche  

[RTFC Logo]

[Inhalt] RTFC Hypertext-Compiler   [Verzeichnis] Index

[Inhaltsverzeichnis]

10.4 -A - Automatische Querverweise

149 Syntax
-A[Map-Datei[.Map]][,[Zieldatei[.HLP|.HTM]][,P|I|+][-]]

Groß-/Kleinschreibung spielt bei den Angaben keine Rolle. Die Dateiendungen .Map und .HLP bzw. .HTM sind optional. Eine zusätzliche Pfadangabe ist zulässig.

Die 3 Teilparameter haben folgende Bedeutung:

  1. Die Map-Datei (Steuerdatei für Querverweise mit Verweistexten und Sprungzielen)
  2. Die Zieldatei (darin befinden sich die Sprungziele für Querverweise)
  3. Die Querverweisart:

    keine Angabe = Jump
    P = Popup
    I = Indexeintrag
    + = nur für manuelle Querverweise aufgrund von Steuerzeichen im Quelldokument
    - = Zusatzangabe für versteckte Querverweise

Beschreibung
RTFC kann nach bestimmten Zeichenketten in Dokumenten suchen, um diese als Querverweise (Jumps, Popups oder Indexeinträge) auf folgende Verweisziele zu verwenden:

  1. Abschnitte im gleichen Dokument
  2. Abschnitte in einem anderen Dokument (bei mehreren in der Kommandozeile angegebenen Quelldokumenten)
  3. Abschnitte in einem anderen Dokument (eine andere Hilfe oder andere HTML-Seite)

Für diesen Zweck können Sie selbst eine Map-Datei erstellen oder auf eine von RTFC erzeugte zurückgreifen. Sie können auch eine vorhandene Map-Datei kopieren, um ggf. andere Verweise daraus abzuleiten.

Im einfachsten Fall (wenn Sie nur -A angeben) liest RTFC die Standard-Map-Datei (vgl. "-M - Map-Dateiname für Hyperlinks"), sucht nach den darin vermerkten Überschriften im Dokument und trägt an den jeweiligen Stellen einen Querverweis (Jump) auf den entsprechenden Abschnitt ein.

Wenn Sie die vorhandene Map-Datei ergänzen, können Sie bewirken, dass neben Überschriften auch beliebige andere Zeichenketten auf einen bestimmten Abschnitt verweisen (vgl. "Überschriften").

Wenn Sie mit dem 2. Teilparameter zusätzlich einen Zieldateinamen angeben, legen Sie fest, dass alle "Sprungziele" aus der Map-Datei in einer anderen Hilfe- oder HTML-Datei liegen. In diesem Fall geben Sie in der Map-Datei zwar Zeichenketten aus dem aktuellen Dokument an, verweisen jedoch auf Context Strings bzw. "lokale Anker" (Sprungziele innerhalb einer Seite) aus einem anderen Dokument. Dies muss nicht einmal ein durch RTFC erzeugter Hypertext sein. Bedingung ist lediglich, dass Ihnen die Context Strings bzw. lokalen Anker bekannt sind.

  150 Windows Help
Damit Querverweise zur Laufzeit aufgelöst werden können, sollten alle Hilfe-Dateien im gleichen Verzeichnis liegen. Mit Windows Help 4.0 ist dies nicht unbedingt notwendig, da der Anwender die Hilfe-Datei zur Laufzeit angeben kann.

HTML
Als Zieldateiname müssen Sie eine von RTFC erzeugte Startseite (Inhaltsverzeichnis) angeben. Falls Sie den Kommandozeilenparameter -Nd verwenden, müssen Sie ihn beim Erzeugen aller referenzierten Zieldateien ebenso angeben.
Wenn Sie Verweise auf HTML-Seiten machen wollen, die nicht mit RTFC erzeugt wurden, können Sie auch deren relative Pfade in Bezug auf die Startseite Ihres Dokuments direkt in der Map-Datei angeben.
Für Verweise auf Dateien im Internet können Sie hier beliebige URLs angeben.

HTML Help
Als Zieldateiname müssen Sie eine CHM-Datei angeben. Die Pfadangaben in der Map-Datei gelten in diesem Fall relativ zum Stammverzeichnis im Dateisystem der CHM-Datei (CHM-Dateien sind CAB-Archive mit einem internen Dateisystem). Falls die Datei mit RTFC erzeugt wurde und Sie den Kommandozeilenparameter -Nd verwenden, müssen Sie ihn beim Erzeugen aller referenzierten Zieldateien ebenso angeben.
Wenn Sie Verweise auf HTML-Seiten machen wollen, die nicht mit RTFC erzeugt wurden, können Sie auch deren relative Pfade in Bezug auf das Stammverzeichnis direkt in der Map-Datei angeben.
Für Verweise auf Dateien im Internet können Sie hier beliebige URLs angeben.
Wenn mehrere CHM-Dateien miteinander verknüpft werden, müssen Sie im gleichen Verzeichnis stehen. Verweise auf CHM-Dateien in anderen Verzeichnissen werden nicht unterstützt.

Mit dem 3. Teilparameter können Sie angeben, ob ein Querverweis zu einem Popup-Fenster führen soll ("P") oder ob Sie lediglich einen Indexeintrag des betreffenden Worts oder der Phrase wünschen ("I"). Im letztgenannten Fall werden ggf. die Context Strings in der Map-Datei und der 2. Parameter Ignoriert.
Durch die Angabe "+" wird die Map-Datei ausschließlich für manuelle Querverweise herangezogen. So können Sie auch Verweistexte verwenden, die keiner Überschrift aus dem Quelldokument entsprechen oder die in ein anderes Dokument verweisen.
Wenn Sie zusätzlich "-" angeben (nur für Jumps oder Popups), sind die Querverweise im Hypertext nicht als solche sichtbar, d. h. sie werden nicht hervorgehoben dargestellt. Wenn Sie den Mauszeiger jedoch über einen Querverweis bewegen, verwandelt er sich wie gewohnt in eine "Hand" und Sie können den Querverweis anklicken.

Hinweis: 
Wenn Sie über eine gültige Map-Datei für die angegebene Zieldatei verfügen, können Sie diese als 4. Teilparameter angeben. Dann prüft RTFC, ob alle in der Map-Datei angegebenen Context Strings auch tatsächlich in der Zieldatei existieren. Falls nicht, wird die Warnung 8874 ausgegeben.

151 Bei den Verweistexten in einer oder mehreren Map-Dateien sind zwar Duplikate erlaubt, da aber immer nur ein Sprungziel möglich ist, gelten folgende Vorrangregeln:

  • Popups haben die stärkste Bindung, d. h. ein Popup (z. B. ein Eintrag im Glossar) kann nicht als Jump oder Indexeintrag umdefiniert werden.
  • Jumps haben Vorrang vor Indexeinträgen, d. h. Jumps können nicht als Indexeintrag umdefiniert werden.

Hinweis: 
Verweistexte aus Map-Dateien gelangen ggf. auch ins Stichwortverzeichnis und den Suchindex einer Hilfe.

Ausnahmelisten
Ein Problem beim automatischen Erzeugen eines Stichwortverzeichnisses bzw. beim automatischen Auflösen von Querverweisen bilden automatisch erkannte Wörter oder Phrasen, die nicht als Stichwort oder Querverweis verwendet werden sollen. Um diesem Problem zu begegnen, bietet RTFC die Möglichkeit, unerwünschte Indexeinträge in der Ausnahmeliste Rtfc.nil und unerwünschte Querverweistexte in der Ausnahmeliste Links.nil zu hinterlegen. Die Ausnahmeliste Links.nil gilt auch für URLs (Internet-Verweise).

Die beiden Ausnahmelisten können jeweils im globalen Verzeichnis für Anwendungsdaten unter "...\Anwendungsdaten\Rtfc" (bis Windows XP) bzw. "C:\ProgramData\Rtfc" (ab Windows Vista) oder dem Arbeitsverzeichnis stehen. Das Arbeitsverzeichnis ist das Verzeichnis, aus dem RTFC aufgerufen wird. Beim Aufruf über den Hypertext-Assistent gilt das Zielverzeichnis als Arbeitsverzeichnis für dokumentenspezifische Ausnahmelisten. Es hat Vorrang vor dem globalen Verzeichnis für Anwendungsdaten. Während dem Compiliervorgang wird angezeigt, welche Ausnahmeliste verwendet wird.

Im Lieferumfang von RTFC sind die Standard-Ausnahmelisten für Stichwörter (Rtfc.nil) und Hyperlinks (Links.nil) enthalten. Sie können anhand dieser Dateien sehen, wie solche Ausnahmelisten aufgebaut sind. Es handelt sich dabei um reinen ANSI-Text mit jeweils einem Wort oder einer Phrase pro Zeile. Groß-/Kleinschreibung spielt keine Rolle. Sie können dabei auch mit Wildcards (Platzhalter wie "*" und "?") arbeiten. Die Angabe "*" ist nur am Ende eines Eintrags möglich.

Falls einer der Einträge in einer Ausnahmeliste bereits durch einen anderen Eintrag mit Wildcard (in diesem Fall "*" am Ende eines Wortes) abgedeckt und somit überflüssig ist, wird die Warnung 8884 ausgegeben.

Siehe auch: 
-S - Stichwortverzeichnis und Internet-Verweise erstellen

Vorgabewert
RTFC löst nur manuelle Querverweise auf.

Vorgabewert bei fehlender Map-Dateiangabe
RTFC liest die Standard-Map-Datei (d. h. die Datei Rtfc.map bzw. die mit dem Parameter -M angegebene) und löst die darin definierten Querverweise auf.

Vorgabewert bei fehlender Zieldateiangabe
Das momentane Quelldokument bzw. der daraus erzeugte Hypertext gilt als Zieldatei.

  152 Vorgabewert bei fehlender Angabe der Querverweisart
RTFC löst alle Einträge aus der Map-Datei als Jumps auf und fügt die einzelnen Wörter zum Stichwortverzeichnis und Suchindex hinzu. Vollständige Überschriften gelangen nicht in den Suchindex, sondern nur einzelne Wörter aus den Überschriften, sofern sie nicht in der Ausnahmeliste Rtfc.nil enthalten sind. Dies gilt für die Standard-Map-Datei auch dann, wenn als Querverweisart "I" angegeben wird.

Beispiele
RTFC -A dokument.rtf
RTFC liest die Standard-Map-Datei (s. o.) und löst die darin definierten Querverweise als Jumps auf. Außerdem wird ein Stichwortverzeichnis und Suchindex mit den darin enthaltenen Wörtern erstellt.

RTFC -Ameinemap.txt dokument.rtf
RTFC liest die Datei meinemap.txt und löst die darin definierten Querverweise als Jumps auf.

RTFC -Ameinemap.txt,,P dokument.rtf
RTFC liest die Datei meinemap.txt und löst die darin definierten Querverweise als Popups auf. Dabei prüft RTFC nicht, ob die jeweiligen Hilfethemen überhaupt in einem Popup-Fenster Platz haben.

RTFC -Aindex.txt,,I dokument.rtf
RTFC fügt die in der Datei index.txt definierten Wörter oder Phrasen ins Stichwortverzeichnis ein.

RTFC -Ameinemap.txt,hilfe.hlp dokument.rtf
RTFC liest die Datei meinemap.txt und löst die darin angegebenen Querverweise als Jumps in die Hilfe-Datei hilfe.hlp auf.

RTFC -Ameinemap.txt,hilfe.htm -Odokument.htm dokument.rtf
RTFC liest die Datei meinemap.txt und löst die darin angegebenen Querverweise als Jumps in die HTML-Datei hilfe.htm bzw. damit verbundene HTML-Seiten auf.

Die genannten Möglichkeiten können auch Kombiniert werden, z. B. auf folgende Weise:

RTFC -A -Ameinemap.txt -Aglossar.map,,P -Aindex.txt,,I dokument.rtf

Siehe auch: 
 
 
 

[<< Zurück] 10.3 -4 - HTML und WinHelp 4.0-Erweiterungen

[Weiter >>] 10.5 -B - Grafik für den Überschrifts-Bereich

Erstellt: 01.12.2010 19:00   Aktualisiert: 28.08.2023 08:00
Autor: Dipl.-Ing. (FH) W. Hubert
Copyright © 2023 RTFC Service