[Inhaltsverzeichnis] [Vorheriges Kapitel] [Nächstes Kapitel]

4.3.4 Technische Vorgaben für die Dokumente

Um dem Benutzer die Suche nach der ihn betreffenden Lösung zu erleichtern, bedarf es einer Formatvorlage, in der einige wesentliche Vorgaben gemacht werden. Durch diese Vorlage soll erreicht werden, daß die Lösungen übersichtlich und einheitlich gestaltet werden. Ausserdem ist sie eine Arbeitserleichterung für den Bearbeiter, da das fertige Gerüst des Dokumentes schon vorhanden ist.

Grundsätzliches

Eine der wichtigsten Vorgaben ist, daß in den Dokumenten in der Hauptsache HTML-Tags verwendet werden, die schon in der HTML 2.0-Spezifikation vorhanden sind. Dadurch wird erreicht, daß auch einfache Browser die Dokumente aus der Lösungsdatenbank darstellen können. Nicht zulässig sind deshalb proprietäre HTML-Erweiterungen, wie Frames und Layers. Tabellen, Farbelemente und ähnliches dürfen nur eingesetzt werden, wenn die Information weiterhin mit einem HTML 2.0-Browser lesbar ist.

Des weiteren dürfen zwar Grafiken in den Lösungen zum Illustrieren von Problemen verwendet werden, aber die Information muß weiterhin mit einem Nur-Text-Browser verständlich sein.

Inhalte der Lösungsdatenbank-Vorlage

Diese Vorlage ist die Grundlage jedes Dokumentes in der Lösungsdatenbank:

<HTML><HEAD>: <HTML> ist der Beginn eines HTML-Dokumentes.; <HEAD> ist der Beginn des 'Kopfes' eines HTML-Dokumentes. In diesem 'Kopf' stehen Informationen zum Dokument, die vom Browser und von Suchmaschinen gelesen und interpretiert werden.
<TITLE>Titel des Dokumentes</TITLE>: In <TITLE></TITLE> steht der Titel des Dokumentes. Der Titel wird von Suchmaschinen ausgewertet und von Browsern in der Titelzeile angezeigt.; In der Lösungsdatenbank wird der Titel indiziert und im 'Virtuellen Suchbaum' (siehe Kapitel Auffinden von Informationen) angezeigt. Im Titel soll eine klare Aussage über den Inhalt des Dokumentes enthalten sein.
<META NAME="keywords" CONTENT="SCHLUESSELWORTE">: Mit dem <META>-Tag kann man für ein HTML-Dokument Schlüsselwörter definieren. <META> wird zum Beispiel von AltaVista Search verwendet, um Dokumente aus dem WWW zu katalogisieren.; In der Lösungsdatenbank wird <META> dazu verwendet, Schlüsselwörter zu dem Dokument zu definieren. Deshalb wird als NAME "keywords" angegeben. Die Schlüsselwörter werden im CONTENT angegeben und werden zusammen mit dem Titel indiziert und im 'Virtuellen Suchbaum' verwendet. Die Schlüsselwörter sollen angeben, welche Dinge in dem Dokument beschrieben werden. (Beispiel: Eine Beschreibung wie man unter dem Betriebssystem UNIX eine Textdatei ausdruckt, könnte die Schlüsselwörter UNIX, drucken, Textdatei enthalten.)
<LINK REV="made" HREF="mailto:AUTOREMAIL">: Das <LINK>-Tag ist in HTML dafür gedacht, Verbindungen eines Dokumentes zu anderen Dokumenten und Quellen anzugeben. Mit der Option REV="made" wird gewöhnlich ein Link auf den Autor des Dokumentes im HREF angegeben.; In der Lösungsdatenbank wird so ein Verweis auf die E-Mail-Adresse des Autors des jeweiligen Dokumentes eingebaut.
</HEAD>: </HEAD> ist das Ende des 'Kopfes' eines HTML-Dokumentes. (s.o.)
<BODY>: Mit dem <BODY>-Tag beginnt der Inhalt des Dokumentes. Alles was nun folgt, wird vom WWW-Browser interpretiert und dargestellt.
<H1>Titel des Dokumentes</H1>: <H1> ist die Hauptüberschrift eines Dokumentes. An dieser Stelle soll der gleiche Inhalt wie im <TITLE> stehen, um Verwirrung am Übergang zwischen 'Virtuellem Suchbaum' und den Dokumenten der Lösungsdatenbank zu vermeiden.
[Anleitung zum Lösen des Problems]: Hier werden weitere HTML-Elemente und Text zur Beschreibung eines Problems und der Lösung eingefügt. Für diesen Teil gibt es Vorgaben, die im Kapitel Layout-Vorgaben für die Dokumente beschrieben werden.
: Dieser Teil ist ein Server-Side-Include. Der WWW-Server fügt an dieser Stelle das Resultat des Scriptes treecounter.pl in das Dokument ein. Dadurch wird ein Zähler der internen Lösungsdatenbank-Statistik für den Anwender unsichtbar hochgezählt.
: Hier wird ein einheitlicher Text eingefügt, der die Schnittstelle zum Problem Management System darstellt.
<ADDRESS>Autor: <A HREF="AUTORURL">AUTORNAME</a></ADDRESS>: Hier wird der Autor des Dokumentes sichtbar angegeben.
<ADDRESS>Letzte Änderung: : Hier wird die letzte Änderung des Dokumentes angegeben. Als Datum wird automatisch das Änderungsdatum der Datei eingetragen.
<A NAME="AUTOR" HREF="AUTORURL">AUTORNAME</a></address>: Hier wird eingetragen, wer die letzte Änderung an der Datei vorgenommen hat
<ADDRESS>Version: $Revision$</ADDRESS>: Hier wird die Nummer der Änderung aus dem Revision Control System eingefügt.

[Inhaltsverzeichnis] [Vorheriges Kapitel] [Nächstes Kapitel]

Autor: Cord Beermann