Bern University of Applied Sciences Engineering and Information Technology Documentation generator for XML-based description standards Ausgangslage: Die.

Präsentation zum Thema: "Bern University of Applied Sciences Engineering and Information Technology Documentation generator for XML-based description standards Ausgangslage: Die."—  Präsentation transkript:

1 Bern University of Applied Sciences Engineering and Information Technology Documentation generator for XML-based description standards Ausgangslage: Die Firma itserve AG, Bern, ist technischer Ansprechpartner der swissdec im Rahmen der Entwicklung einer elektronischen Lohndaten- übermittlung via Webservices. Dabei sind sowohl die zu übermittelnden Daten als auch die beteiligten Applikationsschnittstellen in XML beschrieben. Da es sich dabei um ein Grossprojekt mit vielen beteiligten Parteien handelt, die sowohl in technischer als auch fachlicher Hinsicht reibungslos zusammenarbeiten müssen, entstand das Bedürfnis, automatisiert fachliche Dokumentationen der betroffenen XML- Datensätze erstellen zu können. Problemstellung: Die zentrale Schwierigkeit bestand darin, dem technisch unversierten Leser den eigentlichen Informationszusammenhang möglichst intuitiv zu erschliessen. Nebst rein darstellungs-orientierten Aspekten stellte sich die Frage, wie ein „Plus“ an Kontext-Informationen bereitgestellt werden kann. Nebst Anreicherung von Schemas oder Transfor- mations-Stylesheets mit zusätzlichen Informationen geschieht dies v.a. auch mittels dynamischer Erstellung von bildhaften Übersichten, dynamischer Extraktion von Beispiel-Markup aus den jeweiligen Instanzen und symbolischer Umformung von komplexen Strukturen, die dem Leser schwierig zu vermitteln sind. Informatik www.dgx-doc.ch Studenten: Christian Hegner, Cédric Reginster, Marco Stettler Professor: Dr. Arno Schmidhauser Produkt: Mit wird dem Benutzer ein Framework (Applikation, API, Schemas, Stylesheets, Konfigurationsmöglichkeiten) zur Verfügung gestellt, das es erlaubt, die oben beschriebenen Aufgaben zu erledigen. Unterstützte Output-Formate: FO (erlaubt Transformation in verschiedenste Formate, v.a. PDF.), HTML. Verwendete Technologien: Unterstützte Input-Formate: XML, XSD, WSDL. 100% Open Source Java XML/XSD/XSL(T)‏ Maven Xerces, Xalan, FOP,… Docbook 5.0 Subversion Trac Ausblick: Zusätzlich zur Implementierung des Frameworks, welches die gewünschten Funktionalitäten implemen- tiert, sind folgende Erweiterungen geplant : Erweiterte Konfigurierbarkeit des Outputs Webapplikation (JSF)‏ Dokumentations-Editor Einige Schlüsseleigenschaften: - Fachliche und technische Dokumentationen erstellbar -Im fachlichen Bereich bestehen verschiedene Eigenschaften, um Inhalt intuitiver zu vermitteln (dynamische Kontext-Bilder-Erzeugung, um einen besseren Überblick über die vermittelte Struktur zu erhalten; dynamische Instanz- Extraktion, um Beispielcode vermitteln zu können)‏ -Einfacher dgx-Dokumentationsstandard (Beschreibungssprache) -Aufarbeitung sämtlicher komplexer und simpler Typen (XML-Schema) als Übersichtslisten -Konfigurierbar, aus welchen Teilen eines XML- Schemas (Untermenge aller Elemente) eine Dokumentation erstellt werden soll -Konfigurierbar, welche Elemente für welche Leserschaft dokumentiert werden sollen (WER darf WAS lesen...) -Einfache Konfigurierbarkeit des Tools über XML-Konfigurationsdatei -Komplett stream-orientiert  performant (!) -Als API und/oder über GUI sowie Kommando- zeile verwendbar -Intern Verwendung von DocBook, einem weit- verbreiteten und sich ständig in Weiterent- wicklung befindenden Dokumentationsstandard auf XML-Basis -Ausschliessliche Verwendung von leistungs- fähigen Open-Source-Komponenten