| Tina Mueller |
Version vom: $Date: 2001/02/08 22:03:11 $
|
| Zurück | Hauptseite |
|
Ein Skript (depend.pl) durchläuft in regelmässigen Abständen den Dokumentenbaum und speichert vorhandene Versionsbeziehungen;
um dem Programm zu ermöglichen Versionsunterschiede festzustellen, müssen in jede HTML-Datei spezielle Meta-Tags eingefügt werden. Die aktuelle Version (8.12.2000) des Skripts findet sich unter: $CVSROOT/tools/bin/konsistenzNeue Merkmale der aktuellen Version:
Benutzung des SkriptsAllgemein gilt, dass alle Pfade relativ zum Dokumentenbaum angeben werden müssen, d.h. der Dokumentenbaum ist z.B. /was/auch/immer/VS/docs und der zugehörige Pfad wird relativ von dort angegeben.Es gibt keine globale Versionsnummer, d.h alle Dokumente können verschiedene Versionsnummern haben. Vor der Benutzung des Skripts muss die Umgebungsvariable DOCUMENT_TREE wie folgt gesetzt werden: export DOCUMENT_TREE=/home/whoever/VIS/dokumenteWurde diese Variable nicht gesetzt, so bricht das Programm ab. Weiter müssen die Ausführungsrechte unter UNIX gesetzt werden. Der Aufruf erfolgt durch:
Erster Aufrufdepend.pl initDer Dokumentenbaum wird unter dem im Skript angegebenen Root-Verzeichnis durchlaufen und eine erste Status-Datei wird erstellt. Bei allen Dateien bzw. Datei-Beziehungen steht der Status auf 1 (für "ok"). Visualisierung/WebinterfaceExplizit aufgerufen mit:depend.pl visualDie zwei Dateien status.html und konflikte.html werden in dem Verzeichnis des Wertes der Variable $DOCUMENT_TREE erstellt.Die Datei status.html hat folgende typische Form: status.html Aufruf nach Ändern eines DokumentsErst nachdem ein Autor sein Dokument verändert hat, wird das Skript aufgerufen.depend.pl change dokumentenname.htmlBei auftretenden Konflikten werden die entsprechenden Autoren beachrichtigt (z.Zt. noch als Textausgabe realisiert). Der Status der entsprechenden Dokumentbeziehungen (hier der von dok-a und dok-b) wird auf 0 (für "nicht ok") gesetzt. Aufruf nach Ändern eines bestimmten DokumentesDer Besitzer des dokument-a.html Dokumentes wurde per Email benachrichtigt:depend.pl change dokument-b.html dokument-a.htmlFalls also A sein Dokument geändert hat, eine Nachricht an B geschickt wurde, und B auch etwas ändern musste, muss nun das System mitgeteilt bekommen, dass der Status von dok-a in Beziehung zu dok-b wieder in Ordnung ist. B ändert also die Version und ruft obiges Kommando auf. Aufruf nach Überprüfungund feststellen, dass keine Änderung erforderlich ist:depend.pl update dok-b.html dok-a.htmlDer gleiche Fall wie oben, allerdings musste B nichts ändern. Dann muss dem System nur mitgeteilt werden, dass der Status wieder ok ist. Eine Versionsänderung ist nicht notwendig. Aufruf beim Einfügen eines neuen Dokuments in das Systemdepend.pl change dokumentname.htmlDas Dokument dokumentname.html wird in den Dokumentbaum mit dem Status OK eingefügt. Einbindung der Meta-Tags in den Kopf einer HTML-DateiDie Syntax der Meta-Tags sollte fehlerfrei sein (also mit Anführungszeichen) und zwischen den Tags <head> und </head> eingefügt werden. Es gibt folgende Meta-Tags:<meta name="author" content="wer auch immer"> Autor-name: Der Autor der HTML-Datei <meta name="author-email" content="wer-auch-immer@email.com"> Email-Adresse des Autors für Benachrichtigungen <meta name="depends" content="dok-b.html,dok-c.html"> Dokumente, von denen dieses abhängig ist (wird vom Skript in bidirektionale Abhaengigkeiten umgewandelt, also zyklischen Abhängigkeiten vermeiden) <meta name="entwurfs-version" content="1.2"> Versionsnummer des Dokuments; eine beliebige Zahl vor dem punkt > 0 und eine beliebige Ziffer hinter dem Punkt. |
| Zurück | Top | Hauptseite |