Pflichtenheft Dokumentation Ressourcen

Handbuch zum XLink-Verarbeitungs-Skript

Beschreibung und Verwendung

Das Skript sammelt aus einer angegebenen XML-Datei mit durch XLink-Spezifikationen gelegten Links - im folgenden wird eine derartige Datei Linkbank genannt - alle erweiterten Links (nach den Spezifikationen des W3-Consortiums - siehe Links).
Es fügt in alle XHTML-Dateien, die in der Linkbank angegeben sind, jene "XLinks" ein, die einen Link von dieser auf andere XHTML-Dokumente beschreiben. Es macht Third-Party-Links in den an XLinks beteiligten XHTML-Dateien sozusagen als ausgehende Kanten sichtbar.

Implementiert ist die Verarbeitung in zwei XSLT-Skripten, die in einer Windows-Batch-Datei zu einem Befehl zusammengesetzt sind. Zum Verarbeiten einer Linkbank rufen Sie diese von der Eingabeaufforderung auf. Siehe Voraussetzungen für die technischen Anforderungen der Anwendung.

Die Implementation wird wie folgt aufgerufen:

proccess-lb {Linkbank} [Temporäre Datei]

Die Angabe einer Linkbank ist obligatorisch. Der Name einer temporären Datei kann angegeben oder ausgelassen werden.
Um etwa eine Linkbank mit dem Namen lb.xml zu verarbeiten, wäre folgender Aufruf nötig:

proccess-lb lb.xml

Das Programm gibt Fehlermeldungen oder eine Bestätigung der Verarbeitung zurück. Es meldet zudem, wenn in der Linkbank referenzierte Ressourcen auf der Festplatte vorhanden und diese modifiziert worden sind. Wurden keine XLinks gefunden, gibt die Implementation keine Meldungen aus.

Bei Fehlern: Fehlerbehebung

Optionen

Sie können die referenzierten Dateien modifizieren oder überschreiben lassen. Das Skript erzeugt als Standard modifizierte Kopien der Dateien. Wollen sie die Dateien überschreiben, müssen sie eine Konstante im Batch-Skript ändern.
Im Kopf wird eine Variable "modus" gesetzt. Ihr Standardwert beträgt "mod". Ändern sie diesen zum Überschreiben auf "over".

Voraussetzungen

Stellen sie sicher, dass sich die Datei proccess-lb.cmd sowie die Dateien collect-links.xsl und insert-links.xsl im aktuellen Verzeichnis befinden. Zudem muss hier eine wohlgeformte oder valide XML-Datei mit enthaltenen XLink-Spezifikationen vorhanden sein.
Alle hier referenzierten Dateien sollten nach Möglichkeit lokal vorhanden und les- sowie schreibbar sein. Sie sollten in der Linkbank so referenziert sein, dass der bei den in der Linkbank referenzierten Ressourcen angegebene Pfad unmittelbar zu den Dateien führt. Ist also "../datei.xhtml" in der Linkbank angegeben, sollte sich datei.xhtml eine Verzeichnisstufe unterhalb der Linkbank-Datei befinden.

Der Prozessor muss die XSL-T Sprachversion 1.1 verarbeiten können. Es wird mit dem Saxon oder Instant Saxon 6.5.2 gearbeitet.

Fehlerbehebung

Verarbeitung wurde abgebrochen

Dateien wurden nicht gefunden:
Stellen sie sicher, dass alle vier
oben angegebenen Dateien in einem Verzeichnis liegen und Linkbank und Ressourcen vorhanden und lesbar sind. Da XHTML-Dateien die Zieldokumente der Links sind, müssen sie valide (nach der XHTML 1.0 DTD des W3C) sein.

Saxon nicht vorhanden

Das Skript ruft den Befehl "saxon" auf. Im Suchpfad des Betriebssystems (die $path-Umgebungsvariable bei Windows-Systemen) muss sich die Datei "saxon.exe" befinden. Damit dieser funktioniert, muss zudem der MSXML-Parser installiert sein.

Sollten Sie die Java-Implementation des Saxon nutzen, müssen sie die Batch-Skript-Datei modifizieren.
In dessen Kopf wird eine Umgebungsvariable "saxcommand" gesetzt. Tragen Sie bei Problemen mit dem Prozessor aufruf hier den auf Ihrem System passenden Befehle ein.
Bei der Java-Implementation des Prozessors also:

java -jar [C:\Pfad\zum\JAR-File\Saxon.jar]

Wie genau Sie Ihren Saxon-Prozessor aufrufen, erfahren sie auf den Seiten des Saxon-Prozessors.

Die Modifikation erlaubt allerdings auch den Einsatz weiterer XSL-Prozessoren. Empfohlen wird dies nicht: Die Skripte wurden mit dem Saxon entwickelt. Da XSL-T ein sich entwickelnder Standard ist, können verschiedene seiner Implementationen unterschiedlich auf die Skripte reagieren.

Saxon Fehlermeldungen

Fehler des Parsers:
Sowohl XSL-T-Stylesheet als auch Linkbank müssen wohlgeformtes XML sein. Stellen sie sicher, dass bei Änderungen an der Linkbank oder dem Skript alle Elemente mit passenden, XML-konformen End-Elementen abschließen.
Bei weiteren Problemen hilft die Homepage des SAXON.

platzhalter platzhalter platzhalter platzhalter platzhalter