Home Previous Zeitschrift 1999/02 Next Archiv Index

  Inhalt:

Einleitung

Querverweis

QV anlegen

QV definieren

QV formatieren

Ungelöste QV

Hypertext

PDF nutzen

Der Autor

Adobe FrameMaker 5.5 (7)

Querverweise und Hyptertextverbindungen

Die Erstellung einer technischen Dokumentationen ist eine Sache, die Ausgabe auf verschiedene Medien und Verteilung der Information eine andere. Bei der Verteilung digitaler Information muß diese Zusatzfunktionen zur Navigation enthalten. FrameMaker bietet diese Funktionen schon seit vielen Jahren an. Wie sie eingebaut werden und wo der Nutzen liegt zeigt dieser Beitrag.

Warum unterscheiden?

Ein Querverweis und eine Hyptertextverbindung haben eigentlich ein gemeinsames Ziel: die Lesbarkeit zu verbessern und die Strukturinformation von Dokumentationen zu verdeutlichen. Schön, daß der FrameMaker Querverweise und Hypertextverbindungen in einer Funktion abbildet. Nachträgliches Gestalten für Online-Dokumentation kann so entfallen. Außerdem kann der Querverweis auch innerhalb des FrameMakers als Hypertext benutzt werden.

Der Querverweis

In der technischen Dokumentation finden Querverweise vielfache Verwendung. Mit Hilfe von Querverweisen erlangt die Dokumentation über die eigentliche Struktur hinaus einen Zusatznutzen durch Hinweise auf weitere Informationsstellen im Dokument. Die Anlage von Querverweisen bewerkstelligt jedes Programm auf seine Weise. Im Adobe FrameMaker wurde ein anwerderfreundlicher Weg gefunden, schnell und einfach Querverweise anzulegen.

Querverweistypen

FrameMaker bietet die Möglichkeit, Querverweise auf Absätze und auf Textstellen zu erstellen. Am häufigsten findet die Funktion ,Querverweise auf Absätze" Anwendung.

Anlage eines Querverweises

Die Anlage eines Querverweises beginnt mit der Überlegung, wohin der Querverweis zeigen soll.

Querverweise auf Absätze im geöffneten Dokument legen Sie direkt an. Soll auf ein anderes Dokument, z.B. in einem Buch, verwiesen werden, muß dieses Dokument ebenfalls geöffnet sein.

  • Öffnen Sie das Dokument, auf das der Querverweis zeigen soll
  • Positionieren Sie Ihre Schreibmarke an die Stelle in Ihrem Dokument, an welcher der Querverweis eingefügt werden soll
  • Öffnen Sie das Querverweisfenster mit ,Spezial > Querverweis"

Es erscheint folgendes Fenster:

Das Funktionsfenster Querverweise ermöglicht zum einen die Anlage von Querverweisen innerhalb eines Dokuments und dokumentübergreifend. Zum anderen legen Sie hier Querverweisdefinitionen an. FrameMaker bietet eine Reihe von Standardeinstellungen für die Generierung an. Sie können diese sofort einsetzen.

Das Querverweisfenster teilt sich auf in den Bereich Quellenauswahl, Querverweisdefinition und Querverweisformat.

Quellenauswahl

Die Bezeichnung Quellentyp ist verwirrend. An dieser Stelle wählen Sie nicht den Typ der Quelle, sondern die Quelle selbst aus.

  • Aktivieren Sie die Auswahlbox

FrameMaker zeigt Ihnen alle offenen Dokumente in der Auswahl an.

  • Wählen Sie das Dokument, auf das Sie verweisen möchten.
Querverweisdefinition

Der Bereich Querverweisdefinition teilt sich auf in Absatztypen und Absätze. Sobald Sie einen Quelltyp gewählt haben, listet FrameMaker die Absatztypen der Quelle auf und zeigt die jeweiligen Inhalte der einzelnen im Quelldokument enthaltenen Absatztypen. Durch Auswahl eines Absatztyps verändert sich die Anzeige im Bereich Absätze.

  • Wählen Sie zunächst den Absatztyp aus, auf den der Querverweis abgelegt werden soll
  • Suchen Sie danach im Bereich Absätze den Inhalt heraus, auf den Sie den Querverweis setzen möchten und markieren Sie diesen mit Mausklick
Querverweisformat

Der dritte Bereich des Querverweisfensters zeigt die Standardformate des FrameMakers.

Die Syntax der Formatdefinition ist zunächst erschreckend. Keine Angst, im Handbuch finden Sie eine umfangreiche Dokumentation zum Thema Definiton von Querverweisformaten.

 

Im Auswahlfenster Format listet FrameMaker die Standardformate auf. Haben Sie bereits ein weiteres Querverweisformat definiert, wird dieses ebenfalls angezeigt.

Die Namen der Querverweisformate ist frei definierbar. Sinvollerweise sollte der Name den Formattyp inhaltlich beschreiben z.B. Überschift & Seite zeigt als Querverweis den Inhalt der Überschrift und die Seitennummer, auf der sich die Überschrift befindet.

  • Wählen Sie einen Querverweistyp aus
  • Mit ,Einfügen" wird der Querverweis im Dokument angelegt.
Querverweistypen anlegen

FrameMaker bietet an verschiedenen Stellen bereits in der Oberfläche die Möglichkeit der Nutzung von FrameMaker-internen Variablen.

  • Klicken Sie auf ,Format bearbeiten"

Das folgende Fenster zeigt den aktuellen Formattyp mit der jeweiligen Definition und die möglichen Variablen für den Querverweistyp.

 

Der Querverweis kann aus Variablen oder einer Kombination aus Variablen und Text zusammengestellt werden.

Um einen neuen Eintrag einzufügen, gehen Sie wie folgt vor:

  • Name des Quellformattyps eingeben
  • Bausteine auswählen und mit Mausklick in das Definitionsfenster einfügen
  • Klicken Sie auf ,Einfügen" um die Querverweisdefinition dem System mitzuteilen.

Der Querverweis für unser Beispiel sieht dann wie folgt aus:

Bitte beachten Sie, daß eine Reihe von Sonderzeichen in Dialogfeldern nicht direkt eingegeben werden können. Sonderzeichen haben hier eine eigene Syntax. So wird z.B. das Anführungszeichen (unten doppelt) mit \g definiert.

Eine Übersicht aller Eingaben in Dialogfeldern finden Sie im FrameMaker Handbuch im Anhang A.

Ungelöste Querverweise

Mit der Meldung über ungelöste Querverweise teilt FrameMaker mit, daß es unvollständige Querverweisinformationen im Dokument gibt. Die automatische Überprüfung der Querverweise erfolgt immer dann, wenn FrameMaker ein Dokument öffnet oder druckt. Ursache für diese Fehler sind:

  • Querverweismarke für die Quelle wurde gelöscht
  • Querverweismarke wurde in eine andere Datei verschoben
  • Datei, auf die der Querverweis verzweigt, wurde gelöscht oder umbenannt
Was ist zu tun?

Zunächst müssen Sie die fehlerhaften Querverweise finden. Hier bietet FrameMaker eigene Funktionen zur Problembehebung an.

  • Mit ,Bearbeiten > Referenzen aktualisieren" öffnen Sie das Funktionsfenster
  • Im Aufklappmenü ,Befehle" wählen Sie die Funktion ,Ungelöste Querverweise aktualisieren"
  • Wählen Sie im Bereich der Dokumente die einzelnen Dateien aus und beachten Sie die Anzeige der ungelösten Querverweise

 

  • Mit ,Suchen in" wird das Verzeichnis ausgewählt, in dem vermutlich die Quelle des Querverweises vorhanden ist
  • Markieren Sie die passende Datei
  • Klicken Sie auf ,Öffnen"

War die Dokumentauswahl passend, wird der Querverweis aktualisiert. Im Fenster erscheint der entsprechende Dateiname. Es sind keine ungelösten Querverweise mehr vorhanden.

So können Sie die nicht mehr gültigen (ungelösten) Querverweise überarbeiten.

Kann die Quelle des Querverweises nicht mehr gefunden werden, muß das Ziel bzw. die Quelle des Querverweises entfernt und der Querverweis neu angelegt werden.

Umfangreiche Bearbeitung

Bei umfangreichen Dokumentationen, die von mehreren Redakteuren oder Setzern bearbeitet werden, stellt sich das Problem der ungelösten Querverweise öfter als an einem Einplatzsystem. Die Aktualisierung der Querverweise kann so schnell zu einer zeitraubenden Tätigkeit werden.

Hilfestellung bietet der FrameMaker mit der Funktion der Referenzlisten.

  • Unter ,Datei" finden Sie den Menüpunkt ,Generieren Buch"
  • Im Aufklappmenü ,Liste" finden Sie die Auswahl ,Referenzliste"
  • Klicken Sie auf ,Generieren"
  • Verschieben Sie den Eintrag ,Ungelöste Querverweise" in die Auswahlliste ,Übernahme der Referenzen"
  • Mit ,Generieren" führen Sie die Funktion aus

In der generierten Liste finden Sie die jeweiligen Informationen zu den ungelösten Querverweisen:

  • Seitennummern
  • interne oder externe fehlende Nummer
  • Quellabsatztyp
  • Quellabsatztext

Es ist zu beachten, daß der Quellabsatztyp und Quellabsatztext nicht unbedingt richtig sein muß. Der Grund dafür liegt an der möglichen Differenz zwischen Information des Querverweises und letzter Aktualisierung des Querverweises.

Wo bleibt der Hypertext?

Dieses Kapitel ist schnell abgehandelt. Jeder Querverweis wird im FrameMaker-Dokument als Hypertextverbindung abgelegt. Und diese Funktion ist schon seit vielen Jahren im FrameMaker enthalten. Probieren Sie es einfach aus.

  • Legen Sie einen Querverweis an
  • Drücken Sie dann Strg+Alt und bewegen Sie den Mauszeiger auf einen Querverweis (Mauszeiger wird zum Finger)
  • Klicken Sie bei gedrückter Tastenkombination auf den Querverweis

Der FrameMaker führt den Hypertext direkt aus und springt entsprechend der Verbindung auf das definierte Ziel.

Nutzen Sie PDF

Durch den Erwerb von FrameMaker erhalten Sie automatisch eine Lizenz für den Adobe Acrobat. Damit ist es möglich, direkt aus dem FrameMaker heraus, Acrobat-Dateien (PDF) zu erzeugen. Hervorzuheben ist dabei, daß alle gesetzten Querverweise und generierte Listen (z.B. Inhalts- und Indexverzeichnis) im FrameMaker als Hypertext angelegt und im PDF als Hyperlinks generiert werden. FrameMaker-Dokumente können damit auch unkompliziert online publiziert werden.


Benutzerhilfen


Tastenkombinationen verkürzen
die Bearbeitungszeiten:

Querverweisfenster öffnen

Esc S q

Referenzen aktualisieren

Esc b r

Hypertext ausführen

Strg+Alt Mausklick

Der Autor dieses Beitrags:
Diplom-Betriebswirt (FH) Martin Wanka, Produktmanager Publishing, COI GmbH, Herzogenaurach

Zum Seitenanfang


© ADOLPH Verlag GmbH - Letztes Update 03.05.2004