Und hier noch die bereits in TAUSCHBAU erschienene Doku zum Format des ITK:
ITK-Zeilen:
# | ID des Kommandos |
N | Name des Kommandos |
A | Aufzählung der Werte eines Aufzählungstyps |
B | Beschreibung der Werte eines Aufzählungstyps |
C | Konstante Teile der Syntax |
D | Defaultwert für ein Feld |
F | Datentyp eines Feldes |
H | Ausführliche Beschreibung des Kommandos |
K | Kurze Beschreibung eines Parameters |
L | Ausführliche Beschreibung eines Parameters |
T | Art des Kommandos |
V | Version des Kommandos |
G | Gruppe zu der dieses Kommando gehört |
Bedeutung:
# | ist eine ganze Zahl, die dieses Kommando eindeutig identifiziert. |
N | ist eine nicht zu lange Bezeichnung für das Kommando; sie könnte z.B. als Auswahl in einem Menü verwendet werden. |
C | beschreibt konstante Teile der Syntax. |
H | ist eine ausführlichere Beschreibung des Kommandos; das Frontend könnte sie als Online-Hilfe im Menü für das entsprechende Kommando zur Verfügung stellen. |
V | enthält eine ganze Zahl, die als Versionsnummer dieses Kommandos dient. Ändert sich die Syntax oder die Bedeutung, so ist diese Nummer zu erhöhen. |
T | gibt die Art des Kommandos an:
|
Fc | gibt den Datentyp eines Parameters an (s. unten) |
Ks | gibt eine kurze Bezeichnung eines Parameters; das Frontend kann sie benutzen, um im Dialog das entsprechende Feld zu beschriften. |
Ls | gibt eine ausführlichere Beschreibung des Parameters. Das Frontend könnte diese als Onlinehilfe zu dem einzelnen Feld anbieten. |
Ds | gibt einen Defaultwert für den Parameter vor; die Syntax ist die, die auch im Infile für diesen Parameter zu verwenden ist. |
As[:s...] | Gibt die Infile-Syntax für einen Wert eines
Aufzählungstyps an. Jeder Wert kann mehrere Zustände
annehmen. Die Syntax verschiedener Zustände wird dabei durch
Doppelpunkte getrennt. Beispiel:
|
Bs | bezeichnet einen Wert eines Aufzählungstyps. Die Unterteilung von Aufzählungstypen erfolgt zweidimensional ("Werte des Aufzählungstyps" X "Zustände eines Wertes"), da dies der Praxis am nächsten kommt. Beschreibungen werden nur für *Werte* angegeben, während die verschiedenen Zustände eines Wertes nur durch unterschiedliche Markierungen an der jeweiligen einzigen Beschreibung dargestellt werden. Übrigens existiert die Option "Set Of" nur entlang der ersten Dimension. Diese Aspekte sind beim Entwurf von Kommandobeschreibungen zu berücksichtigen. Es ist von Fall zu Fall zu entscheiden, ob es intuitiver ist, die Werte entlang der ersten, der zweiten oder beider Dimensionen anzuordnen. Beispielsweise ist es sinnvoll, eine Auswahl im Sinne von "Ein/Aus" (z.B. "Anfordern/Nicht Anfordern") entlang der zweiten Dimension anzu- ordnen: es genügt vollkommen, wenn der Anwender ein Feld "Anfordern" erhält, das er aktivieren kann oder nicht. Hingegen ist es bei einer Auswahl zwischen zwei nicht direkt entgegen- gesetzten Möglichkeiten ("Neue anfordern/Alle anfordern") sinnvoll, dies entlang der ersten Dimension zu tun, um zwei verschiedene Dialog- felder mit jeweils eigenen Beschreibungen zu erzeugen. |
Gx | Gibt die (G)ruppe an, zu der dieses Kommando gehört. Im Moment sind für x folgende Werte definiert:
|
Die generelle Struktur eines ITK-Eintrags ist somit wie folgt:
#<Kommando-Nummer> |
|
N<Kommando-Name> |
|
H<Kommando-Beschreibung> |
|
T<Kommando-Art> |
|
V<Kommando-Version> |
|
Auf diesen mehr oder weniger konstanten Block folgen dann ein oder mehrere syntaxbeschreibende Blöcke. Ein syntaxbeschreibender Block wird eingeleitet durch eine C- oder eine F-Zeile. Wird er durch eine C-Zeile eingeleitet, so produziert er einen konstanten String und besteht nur aus dieser C-Zeile. Ein Block, der durch eine F-Zeile eingeleitet wird, beschreibt einen vom User einzugebenden Parameter.
F<Datentyp> |
|
D<Defaultwert> |
|
K<kurze Beschreibung> |
|
L<lange Beschreibung> |
|
<ggf. noch A- und B-Zeilen, immer paarweise, immer A-Zeile zuerst> |
Die Produkte aller C/F-Blöcke, in der gegebenen Reihenfolge konkateniert, ergeben das Infile-Kommando.
H und L dürfen jeweils mehrfach auftreten. Ein Blank zu Beginn einer Zeile weist das Frontend an, diese Zeile weder neu umzubrechen noch sie zwecks neuen Umbruchs an die vorhergehende Zeile anzuhängen.
Darstellung im Infile | ||
A | Aufzählungstyp | wie in A-Zeilen angegeben |
M | Set of Aufzählung; | |
es gilt alles wie für A, | ||
nur daß das Frontend erlauben | ||
muß, mehrere Werte gleichzeitig | ||
zu aktivieren. | ||
D | Datum | JJJJMMTTHHMM[SS] |
d | Datum | TT[.MM[.JJJJ]] |
Sn | String der Länge n | wie eingegeben |
Pn | Paßwort der Länge n | wie eingegeben |
(wird ggf. nicht angezeigt) | ||
pn | neues Paßwort der Länge n | wie eingegeben |
(Frontend kann ggf. zweimal | ||
fragen) | ||
U | Username | wie eingegeben |
I | ganze Zahl, 2 Byte | dezimal, Ascii, mit |
Vorzeichen, auch wenn positiv | ||
Im,n | ganze Zahl aus dem Intervall | dezimal, Ascii, mit |
[m;n]. | Vorzeichen, auch wenn positiv | |
G | Gruppenname | im Klartext |
g | Name einer Gruppe, in der | im Klartext |
User Chef ist |
Ein 'o' hinter dem Datentyp bedeutet, daß in das Feld keine Daten eingegeben werden müssen. Im Infile ist dann ein Leerstring einzutragen.
Copyright © by Christian Goßlar
Letzte Aktualisierung am 6. November 1997