Benutzung des Systems
In diesem Anhang beschreibe ich die Benutzung der
ausführbaren Programme von IP4W3
im Stil von Unix-Manualseiten. Alle anderen Komponenten werden nicht
über die Kommandozeile gestartet, sondern durch den Web-Server
beziehungsweise die CGI-Skripte aufgerufen.
- Name
- ip4w3-manager - Administrationswerkzeug
für IP4W3
- Aufruf
- ip4w3-manager [init|neu|update DokID]
- Beschreibung
- Der ip4w3-manager dient dazu, ein neues Dokument
in IP4W3 zu integrieren beziehungsweise IP4W3 darüber zu
informieren, daß sich ein
Dokument geändert hat.
- Benutzung
- ip4w3-manager init führt die Initialisierung für
ein neues Dokument durch. Bei diesem Schritt muß ein eindeutiger
Bezeichner für das Dokument genannt werden. Der Bezeichner wird
als Verzeichnisname und innerhalb eines URLs
verwendet und unterliegt den entsprechenden Beschränkungen. Es
empfiehlt sich, einen Bezeichner mit einem Buchstaben zu
beginnen und nur aus Buchstaben und Ziffern
zusammenzusetzen. Darüber hinaus sollten nur kleine Buchstaben
benutzt werden.
ip4w3-manager neu nimmt das neue
Dokument in IP4W3 auf. Neben der Angabe des
Dokumentbezeichners fragt das Programm nach dem Dateinamen der Instanz, dem
Dateinamen des DSSSL-Rumpfes, dem Dateinamen der
Suchmuster-Instanz sowie dem Titel des
Dokuments.
ip4w3-manager update DokID aktualisiert
alle internen Informationen des Dokuments mit dem Bezeichner
DokID. Dies ist notwendig, wenn am Dokument oder den
Suchmustern Änderungen vorgenommen wurden.
- Name
- makeindex - erzeugt ein
Stichwortverzeichnis für eine SGML/XML-Instanz
- Aufruf
- makeindex sgml-instanz [nsgmls-parameter]
- Beschreibung
- makeindex erzeugt ein Stichwortverzeichnis, das
jedem Wort einer gegebenen Instanz den Wert des Attributs
internal-id des umgebenden Elements zuordnet.
- Benutzung
- Der Parameter sgml-instanz ist zwingend
erforderlich und gibt den Dateinamen der Instanz an. Die
weiteren Parameter werden an nsgmls weitergereicht. Die Ausgabe erfolgt
auf der Standardausgabe.
- Name
- ergaenze-ids - fügt IDs in
SGML/XML-Instanzen ein
- Aufruf
- ergaenze-ids sgml-instanz [-o ausgabedatei] [jade-parameter]
- Beschreibung
- ergaenze-ids fügt in jedes Element einer
gegebenen Instanz das Attribut internal-id mit einem
eindeutigen Wert ein.
- Benutzung
- Der Parameter sgml-instanz ist zwingend
erforderlich und gibt den Dateinamen der Instanz an. Mit dem
optionalen Parameter -o ausgabedatei kann die Ausgabe
in eine Datei umgelenkt werden; andernfalls erfolgt die Ausgabe
auf der Standardausgabe. Die weiteren optionalen Parameter
werden direkt an Jade weitergeleitet.
© Stefan Mintert