5.2 Allgemeine Benutzerdokumentation

In der allgemeinen Benutzerdokumentation sind die Anleitungen zusammengefaßt, die grundsätzliche Beschreibungen zum System und zu seiner Bearbeitung enthalten. Dazu gehören ein Überblick über die Struktur des Systems und der Arbeitsweise der Scripte, Erläuterungen und Hinweise zu den Konventionen bei URL-Angaben, eine Dokumentation des HTML-Editors HotMetal 2.0 sowie ein Beispiel. Die im folgenden beschriebenen Anleitungen befinden sich im Anhang L.

Struktur des Systems (Datei struktur.doc, Anhang L1)

Diese Anleitung gibt einen Überblick über die gesamte Verzeichnisstruktur des Systems auf dem WWW-Server inklusive aller Unterverzeichnisse. Zuerst erfolgt eine Auflistung des Hauptverzeichnisses mit einer Zuordnung der enthaltenen Unterverzeichnisse und Dateien (1. Ebene) zu den sechs festgelegten Verantwortungsbereichen mit Angabe der jeweils verantwortlichen Mitarbeiter. Die zu jedem Bereich gehörenden Unterverzeichnisse sind danach einzeln und detailliert mit allen weiteren Unterverzeichnissen und Dateien aufgelistet (2. bis unterste Ebene), wobei zu jedem Eintrag (HTML-Dokumente und Grafiken) eine kurze Beschreibung seines Inhaltes angegeben ist. Bei Dateien, die in deutscher und englischer Sprache vorhanden sind, wurde ein entsprechender Vermerk vorgenommen.

Editor Hotmetal 2.0 (Datei hotmetal.doc, Anhang L2)

Diese Anleitung enthält eine Kurz-Dokumentation zur Benutzung des HTML-Editors HotMetal 2.0. Sie erhebt keinen Anspruch auf Vollständigkeit und berücksichtigt nur die wichtigsten Punkte, die für die Modifizierung bestehender HTML-Seiten und für die Bearbeitung der Vorlagen notwendig sind:

• Dateien öffnen und speichern,
• Formatierung von Texten (Schriftarten, Schriftgrößen, Überschriften, Absätze, Sonderzeichen u.a.),
• Ausschneiden, Kopieren und Einfügen von Texten (z.B. zum Einfügen von in Word für Windows erstellten Texten),
• Einbinden von Grafiken,
• Einfügen und Ändern von Links mit Beschreibung der verschiedenen Link-Arten (mailto, relative und absolute Links, Marken),
• Einfügen und Ändern von Listen und Tabellen und
• Bearbeitung von Meta-Informationen.

Auf Ausführungen zum Umgang mit Tastenkombinationen und Symbolleisten wurde aus Gründen der Übersichtlichkeit und des Umfangs verzichtet, darum ist in dieser Dokumentation, die auf eigenen Erfahrungen in der Benutzung des Editors beruht, auch nur die menügesteuerte Vorgehensweise der Bearbeitung beschrieben worden.

Beispiel (Datei beispiel.doc, Anhang L3)

Diese Anleitung umfaßt zum besseren Verständnis die verschiedenen Ansichtsebenen für die Darstellung einer HTML-Seite am Beispiel der Seite Eintrittspreise:

• oberste Ebene: Ansicht des Ergebnisses in einem Browser (Netscape), bei dem die Tags in ein Layout umgesetzt wurden,
• mittlere Ebene: Bearbeitungsansicht in einem komfortablen HTML-Editor (HotMetal 2.0) mit hervorgehobenen Tags und ihrer teilweise gestalterischen Umsetzung („Halb-Layout", aber kein WYSIWYG),
• unterste Ebene: Ansicht der eigentlichen HTML-Datei in einem Texteditor (Windows-Notepad) ohne Layout.

URL-Konventionen (Datei url_konv.doc, Anhang L4)

Diese Anleitung behandelt das Problem der Sonderzeichen und Umlaute in Verzeichnis- und Dateinamen bei URL-Angaben. Sie enthält Angaben zu den Zeichen, die in Verzeichnis- und Dateinamen vorkommen bzw. nicht vorkommen dürfen, eine Beschreibung der wichtigsten Zeichen-Kodierungen (Ersatzzeichen für Sonderzeichen) und erläuternde Beispiele. Die Beachtung dieser URL-Konventionen ist notwendig, da im Fuß jeder Seite die URL dieser Seite angegeben wird.

Von Kodierungen betroffen sind insbesondere die verschiedenen Listen, die aus langen und aussagekräftigen Datei- und Verzeichnisnamen gebildet werden:

• Pflanzen des Jahres, z.B.:
  1996+-+Die+Küchenschelle+-+Pulsatilla+vulgaris+Mill..htm
• Infoblätter, z.B.:
  Sie+blüht+nur+einmal+im+Leben+-+die+Agave.htm
• Mitarbeiterverzeichnisse, z.B.:
  \Dörthe+Hildebrandt

Bei den Namen der Mitarbeiterverzeichnisse ist außerdem noch zu beachten, daß die Kodierung nicht nur in der URL-Angabe erfolgen muß, sondern auch auf der Visitenkarte, wenn ein Mitarbeiter dort die Adresse seine Mitarbeiterseite mit aufnehmen möchte. Dieser spezielle Fall wurde ausführlich in der Dokumentation der Mitarbeiterseiten beschrieben (siehe dazu Abschnitt 5.3 und Anhang M7).
Konkretere Ausführungen zu den Datei- und Verzeichnisnamen und zu den Kodierungen befinden sich in der Beschreibung der PERL-Scripte in Abschnitt 4.3.

Scripte (Datei scripte.doc, Anhang L5)

Diese Anleitung beschreibt in vereinfachter Form, d.h. ohne programmierspezifische Details hinsichtlich der verwendeten PERL-Routinen, die grundlegende Arbeitsweise der Scripte, insbesondere:

• welche Verzeichnisse jeweils gelesen werden,
• wie aus den gefundenen Einträgen die Listen generiert werden,
• wie die Ergebnislisten im Browser aussehen (anhand von Abbildungen),
• wie das Script gestartet wird und
• in welchen konkreten HTML-Seiten dieser Aufruf erfolgt.