Index – wenn, dann richtig

Text: Manfred Krüger

Die Komplettierung einer umfassenden Technischen Dokumentation oder wissenschaftlichen Publikation mit einem editierten Index ist aus der Mode gekommen. Warum ist das so?

Inhaltsübersicht

Lesedauer: 05:21 Minuten

Eine verbreitete Meinung lautet, dass sich bei einer elektronischen Lieferform ein Index nutzerseitig durch eine Volltextsuche oder eine automatisierte Indexierung ersetzen lässt. Mit Blick auf meine berufliche Vergangenheit in renommierten wissenschaftlichen Verlagen erzeugt diese Einschätzung nicht nur Kopfschütteln.

Der spezifische Nutzen eines Index

Wozu und wem dient ein Index, auch Sachregister, Stichwort- oder Schlagwortverzeichnis genannt, als Ergänzung eines Werks mit technischen oder wissenschaftlichen Inhalten? Neben der zweckdienlichen Gliederung und Überschriftenformulierung, angezeigt in einem Inhaltsverzeichnis, vermittelt der Index der Leserin und dem Leser einen zusätzlichen Einstieg in den Inhalt mit ganz eigenen Leistungsmerkmalen.

Bei der Suche im alphabetisch geordneten Index nutzen Leserin und Leser ihr Vorwissen zu den Themen des Werks. Sie suchen also die Stichworte entsprechend ihrer Begrifflichkeit. Je besser der Index die Begrifflichkeit der Leser mit den im Werk verwendeten Begriffen verbindet, desto höher der Nutzen für sie und ihre Bereitschaft, den Index als zielgenauen Einstieg in die Inhalte zu verwenden.

Diese Überlegungen zeigen, dass die automatisierte Indexgenerierung aus dem textlichen Inhalt eines Werks weder die Begrifflichkeit noch die Intentionen der Leser berücksichtigt. Die Erstellung der Indexbegriffe und deren Positionierung im Inhalt ist also eine eigene Herausforderung an die redaktionelle Arbeit. Der Gebrauchswert eines Index ist entscheidend abhängig von der Qualität der Arbeit der Person, die den Index erstellt. In der angelsächsischen Tradition der Wissenschaftspublikation gibt es deshalb auch den eigenständigen Beruf des Indexers.

Der praktische Nutzen eines guten Index in einer Technischen Dokumentation oder wissenschaftlichen Publikation ist unabhängig von der Distribution in traditioneller Druckform oder zeitgemäßer elektronischer Form. Lediglich die Handhabung des Index ist in der elektronischen Form durch die Verlinkung des Indexbegriffs mit dem Inhalt ungleich schneller und zielgenauer. Wäre da nicht der erhebliche Aufwand in der redaktionellen Arbeit ‒ so die verbreitete Meinung –, der der vermuteten Wertschätzung durch die Leser/Nutzer in vielen Fällen nicht entspricht.

In den nächsten Abschnitten ist ein praktischer Weg dargestellt, wie die Qualität des Index erhöht, der Aufwand der Indexerstellung minimiert und das Prozedere der Indexgenerierung zuverlässig automatisiert werden kann.

Index generiert aus XSL-FO

Abb. 01 Ein mit XSL-FO generierter Index. Quelle Manfred Krüger

Strukturelle Grundlage eines Index

Voraussetzung ist, dass die Quelldaten des Werks oder einer Sammlung von thematisch zusammenhängenden Werken in einer beliebigen XML-Struktur erfasst bzw. gehalten werden. Weiterhin sei vorausgesetzt, dass die gegebene XML-Struktur die Inhalte in Informationseinheiten gliedert. Im Falle einer traditionellen Gliederung beispielsweise in Kapitel, Abschnitte, Absätze oder Listen, im Falle einer semantischen Struktur beispielsweise in Installation, Betrieb, Handlungsanweisung oder Prüfprozedur.

Aus der etablierten XML-Anwendung DocBook (DocBook.org) übernehme ich die Strukturierung der Indexeinträge:

<!ELEMENT indexterm (primary, secondary?)>
<!ELEMENT primary (#PCDATA | . . .)>
<!ELEMENT secondary (#PCDATA | . . .)>

Auf die dritte Ebene von Indexeinträgen (tertiary) und Verweise auf andere Indexeinträge (seealso) verzichte ich, weil sich darin kein Zusatznutzen eines Index erkennen lässt. Anstelle der drei Punkte in den Deklarationen lassen sich weitere Auszeichnungen definieren, die im formatierten Index typografische Abweichungen vom normalen Text produzieren.

Die Indexeinträge (indexterm) lasse ich innerhalb jeder Informationseinheit als optionales Unterelement zu. Überschriften gelten nicht als eigene Informationseinheiten. Sie sind lediglich Bezeichner für den Informations-Container, zum Beispiel Kapitel, in dem sie am Anfang gesetzt sind. Da diese Indexeinträge später im formatierten Fließtext nicht angezeigt werden, sondern lediglich Linkziele aus dem generierten Index darstellen, ist es unerheblich, ob die Informationseinheit, in der die Einträge eingebettet sind, inzeilige Elemente enthalten darf (zum Beispiel Kapitel). Wichtig ist die Platzierung der Indexeinträge möglichst am Anfang der Informationseinheit, weil unter bestimmten Einstellungen des Browserfensters das Linkziel in die erste Zeile im Kopf des Browserfensters rückt. Indexeinträge, die an beliebiger Position in der Informationseinheit positioniert sind, zwingen den Leser, bevor er den Inhalt wahrnehmen kann, erst durch Scrollen des Textes im Fenster den Anfang des relevanten Inhalts zu finden.

Erstellung und Pflege der Indexeinträge

Führen die Autoren des Inhalts die Indexeinträge selbst aus, dann empfiehlt es sich, die Einträge zusammen mit dem Inhalt zu setzen. Das minimiert den Aufwand für die Indexerstellung. Ein allgemeines Konzept für das Setzen und die Formulierung von Indexeinträgen fördert die Qualität und den Nutzen des Index, ist aber außerhalb des Anspruchs dieses Artikels. Eine solche Konzeption ist am ehesten gegeben, wenn das Setzen der Indexeinträge einem professionellen Indexautor (Indexer) überlassen wird, wie es im angelsächsischen Umfeld traditionell üblich ist.

Transformation und Formatierung

Die Indexgenerierung aus den gesetzten Indexeinträgen ist mit der XSL-FO-Technologie und entsprechenden Werkzeugen ‒ einem XML-Transformationsprozessor und XSL-Formatierer ‒ ein Prozess, der ohne separate Prozeduren oder spezifische Software in die Verarbeitung der Inhalte integriert ist.

In einem XSL-Stylesheet werden die Transformationen der XML-Daten und die Gestaltungsparameter für die Verarbeitung in dem Formatierer für einen Dokumenttyp und die gewünschte Ausgabeform formuliert. Für den automatisierten Verarbeitungsprozess wird den XML-Daten das XSL-Stylesheet zugeordnet. Die Produktion selbst ist ein völlig automatisierter qualitätsgesicherter Prozess. Das Ergebnis ist ein PDF-Dokument mit den im Stylesheet spezifizierten Leistungs- und Gestaltungsmerkmalen.

Der für die Generierung des Index zuständige XSL-Code lässt sich zum Beispiel ohne Änderung oder Ergänzung aus einer Vorlage entnehmen und in ein beliebiges Stylesheet einfügen [1]. Der mit dem Antenna House XSL Formatter formatierte Index sieht zum Beispiel so aus wie in Abbildung 01.

Anzumerken ist, dass die in der XSL Recommendation, Version 1.1, enthaltenen Indexkonstrukte (s. folgender Abschnitt) nicht von allen Formatierer-Produkten unterstützt werden. Empfehlenswert ist zum Beispiel der „XSL Formatter“ von Antenna House. Die Anwendung kam auch für das Beispiel in diesem Artikel zum Einsatz.

Index für zusammenhängende Werke

Für thematisch zusammenhängende Werke, also eine Sammlung Technischer Dokumentationen, die sich beispielsweise auf eine Produktgruppe beziehen, habe ich ein alternatives Indexkonzept entwickelt und mit XSL-FO realisiert:

Zunächst wird unabhängig von einzelnen Dokumentationen dieser Gruppe ein Index erarbeitet, der die Informationsbedürfnisse für diese Produktegruppe umfassend abdeckt. Jeder Eintrag bekommt einen im gesamten Index eindeutigen, formalen Namen.

Die Autoren der einzelnen Technischen Dokumentationen referenzieren diese Namen an entsprechender Stelle in ihren Inhalten. So lässt sich automatisiert sowohl für jede Dokumentation innerhalb der Sammlung ein dokumentgebundener Index als auch ein Gesamtindex mit Links in die Dokumentationen der Sammlung generieren. In diesem Konzept liegt ein beträchtlicher Nutzen für die Leser bzw. Benutzer einer solchen Sammlung.

Merkmale nach Recommendation

Mancher wird bezweifeln, ob das skizzierte Konzept der Indexgenerierung die in der Praxis gewünschten Leistungsmerkmale aufweist. Deshalb zum Schluss eine Liste an Merkmalen, wie sie für den Antenna House XSL Formatter gelten:

  • Alphabetische Ordnung – nach Duden-Regeln, Groß- und Kleinbuchstaben lassen sich gleich sortieren, Umlaute werden wie ihre Grundbuchstaben geordnet. Die textlichen Inhalte der Indexbegriffe lassen sich differenziert typografisch darstellen. Es gibt keine Beschränkungen für die Darstellung von Sonderzeichen.
  • Seitenverweise – Wiederholungen gleicher Indexeinträge in einer Seite werden ignoriert. Wiederholungen, die über Seitengrenzen hinausgehen, werden als Seite-bis-Seite dargestellt. Bei Vorkommen in unterschiedlichen Seiten lässt sich der Trenner (zum Beispiel Komma und Leerzeichen) auch durch eine andere Zeichenfolge ersetzen. Die Seitenzahlen lassen sich mit Prä- und Suffixen ergänzen. In Abhängigkeit vom Auftreten in unterschiedlichen Bereichen des Dokuments lässt sich die Seitenzahl spezifisch gestalten.
  • Interaktivität – die Seitenzahlen können mit Hyperlinks in den Inhalt hinterlegt werden.
  • Typografie, Spalten- und Seitenumbruch – die Silbentrennregeln und die Zeilengestaltung lassen sich wie im Inhalt anwenden. Der Index kann mit allen verfügbaren typografischen Mitteln in beliebiger Spaltigkeit gestaltet werden. 

literatur zum beitrag

[1] Krüger, Manfred (2014): XSL-FO ‒ Verstehen und Anwenden. XML-Verarbeitung für PDF und Druck. 2., überarbeitete und veränderte Ausgabe. MedienEdition Welsch (über den Autor zu beziehen).

Index - wenn, dann richtig