Definition der HTML-Generierungsprozesse

Definition der Ein- und Ausgaben

Der Ablauf der Generierung von HTML-Seiten durch den VDM Datenbank Server wird allein durch die Parameter bestimmt, die dem URL des VDM Clients hinzugefügt sind. Parameter, die in Form einer Zeichenkette über das CGI-Interface übermittelt werden, lassen sich durch vier Eigenschaften charakterisieren:

Einzelne Parameter werden in der Zeichenkette durch das Zeichen ,,&`` getrennt
Parameter liegen in der Form ,,parameter=value`` vor
Mehrere Parameter gleichen Namens sind möglich
Zeichen, die nicht Zahlen und Buchstaben sind, werden im Format ,,%xx`` übergeben, wobei xx den hexadezimalen ASCII-Code angibt.

Ferner läßt sich zu CGI-Parametern die Warnung aussprechen, daß abhängig vom eingesetzten WEB-Server Leerzeichen Probleme bereiten können, jedoch nicht müssen. Auf Leerzeichen bei der Parameterisierung wurde im gesamten Projekt verzichtet. Hexadezimale Werte, die durch das Escape-Zeichen ,,%`` angeführt werden, setzt der VDM Server in den gültigen ASCII-Code um.

Alle gültigen Parameter für den VDM Datenbank Klienten, sowie die entsprechenden weitere Subparameter werden nachfolgend definiert und beschrieben.

Ein grundsätzlicher Steuerungparameter ist

conttype=mime | raw | text

Fehlt dieser Parameter gänzlich, ist sein Wert undefiniert oder leer, so wird als Standardwert text angenommen. Der Wertbereich von conttype hat damit folgende Bewandnis:

mime: Es wird ein MIME-Element der VDM Bibilothek referenziert. Zusätzlich wird erwartet, daß die Subparameter adt, impl, oper und comp einen gültigen Inhalt in der gesamten Datenbankstruktur referenzieren. In der Regel ist dies als ADT mimelib, als Implementation aux, sowie als Operation und Komponente ein Eintrag zu der Sparte mimelib, denn um einen ,,echten`` wohlgeformten ADTs handelt es sich bei mimelib nicht. Die MIME Haupt- und Untergruppe als auch der MIME-kodierte Inhalt selbt werden zur Interpretation durch den VDM Datenbank Klienten zurückgeliefert.
raw: Es wird ein von ADTs unabhängiger Hilfetext zurückgegeben, der auch Hypertext beinhalten kann und durch den VDM Preprozessor aufbereitet ist. Die Referenzierung des Hypertextes in der Datenbank erfolgt durch die Subparameter adt, impl, oper und comp . Das Ausgabeformat ist HTML.
text: Der Wert text für contenttype ist wie erwähnt auch Standardwert, und wird regelmäßig dann angenommen, wenn nicht explizit ein anderer Typ gegeben ist. Die Subparameter für diesen Inhaltstypen sind so vielfältig, daß für sie eine gesonderte Beschreibung notwendig ist.

Die Eigenschaften des Inhaltstyps text werden durch den Subparameter hot untergliedert. Von dem Wert von hot ist die Gültigkeit weiterer Subparameter abhängig. Grunsätzlich ist hot nur dann gültig, wenn contenttype entweder auf text, überhaupt nicht oder auf einen undefinierten Wert gesetzt ist. Mit hot wird ein anderer, als der Standardeinsprungspunkt für die Seitengenerierung festgelegt. Ist hot nicht oder ungültig definiert, so wird die Seite für die Direktauswahl von ADTs in der Datenbank ausgewählt.

Gültige Werte für hot :

setup

Es wird eine Seite produziert, welche die komfortable Einstellung der Tabelleneintragsgröße durch den Benutzer zuläßt.

help

Verschiedene Hilfsmöglichkeiten werden angeboten. Wählbar sind hierdurch auch die direkt mit hot erreichbaren Einsprungsstellen help_usage, help_examples, und help_search.

help_usage

Eine Seite mit einer Bedienungshilfe zum System wird produziert

help_examples

Die Haupt-Seite der VDM Anwendungsbeispiele wird zurückgegeben, sofern die Subparameter runtype und example kein bestimmtes Beispiel und dessen Ausführungsart bestimmen. Die zuässigen Werte für die Subparamter werden unter Abschnitt [*] dieser Arbeit gemeinsam mit detailierten Informationen erläutert.

help_search

Einsprung zur den Suchfunktionen

help_search_commit

Suche nach Themen. Diese sind ein oder mehrere ADTs, dessen Implementationen oder Operationen. Die äquivalenten Subparameter sind entsprechend adts, opers und impls.

help_search_full

Volltextsuche zu gefundenen Themen. Die gefundenen Themen werden anhand der Subparameter adts, opers und impls ermittelt.

enlarge

Erweitern der aktuellen Tabelleneintragsbreite in cols um 1 und Ausgabe der Standardseite mit Auswahltabelle.

reduce

Reduzieren der aktuellen Tabelleneintragsbreite in cols um 1 und Ausgabe der Standardseite mit Auswahltabelle.

Alle weiteren Werte führen führen neben enlarge und reduce ebenfalls zur Standardseite mit Auswahltabelle. Die Auswahltabelle kennt folgende Subparameter

adt: Selektierter ADT. Zusätzlich zu den üblichen ADTs der Datenbank bewirkt eine Angabe von adt=Predefined die Ausgabe der vordefinierten Abstrakten Datentypen
impl: Selektierte Implementation zum selektierten ADT
oper: Operation der gewählen Implementation des angegebenen ADTs
general: Allgemeine Informationen zum mit adt gewählten Abstrakten Datentypen werden ausgegeben
feature: Besonderheiten und Merkmale einer mit adt und implementation gewählten Implementation werden ausgegeben
optype: Der globale Operationstypus für jegliche Auswahl wird festgelegt. Gütige Werte sind C, C++, und A++. Der Standard- und Vorgabewert ist C.

Zusätzlich sind zwei ,,globale`` Parameter definiert, die unabhängig von allen weiteren Parametern gesetzt werden können und allein die Darstellung der Auswahl in der Standard- bzw. Heimatseite des Sytems betreffen. Die Namen dieser Parameter sind cols und text, dessen Definition ist wie folgt:

cols

Zunächst soll der globale Parameter cols beschrieben werden, welcher grundsätzlich von (fast) allen Seiten ,,mitgeschleift`` wird. Das bedeutet, daß (fast) jeder Einsprungspunkt des Programms, diesen Parameter in allen produzierten URLs integriert, sofern dieser als Parameter übergeben wurde. Ist cols nicht spezifiziert, so wird ein Standardwert eingesetzt. Der Anwender, der in seinem HTML-Browser ein Lesezeichen (bookmark) für das VDM Informations- und Hilfesystem einrichtet, kann damit auch seine Konfiguration speichern. Der Wert für cols kann durch das Setup als auch durch die Enlarge-und Reduce-Funktionen verändert werden.

text

Der Parameter text ist für die Ausrichtung des Hilfetextes in Bezug auf die Auswahltabelle verantwortlich. Vorgabe ist die Darstellung des Textes unterhalb der Tabelle. Seine gültigen Werte sind

bottom: Anzeige von Hilfstexten unterhalb der Tabelle
top: Anzeige von Hilfstexten überhalb der Tabelle mit Justierung der Seite auf den Textanfang
topcenter: Hilfstexte werden überhalb der Tabelle angezeigt, die Justierung erfolgt auf dem Beginn der Auswahltabelle zur Erleichterung der Folgeauswahl

Selbstverständlich werden alle Parameter, die nicht der gültigen Struktur entsprechen, stillschweigend ignoriert und vom VDM Server gefiltert. Der ,,hackende`` Benutzer hat damit nicht die Chance die Datensicherheit gefährdende Operationen auszulösen.

[ Inhalt ] [ Index ]

Spezifikation der Lösung

Systemdefinition

Definition der HTML-Generierungsprozesse

VDM Class Library