Projekt „Textorientierte Autorentools“

WerkzeugentwicklungaTool

Springer Verlag – RWTH Aachen – TU München 19. Februar 2001

Lehrstuhl für Informatik IIIRWTH Aachen

Dipl.-Inform. Oliver MeyerDipl.-Inform. Felix Gatzemeier

aTool: Werkzeugentwicklung 19. Februar 2001

aTool: verfügbare Funktionen

1. Batch-Konvertierung Word-Dokument XML-Baum

2. XML-Baum wird inkrementell validiert.

3. Elementattribute bearbeiten

4. Teilbäume verschieben

5. Dokumente als XML speichern

aTool: Werkzeugentwicklung 19. Februar 2001

aTool: geplante Funktionen zur Evaluation

• Inkrementelle Integration Word aTool

• Generierung von Blockelementen

• Erweiterte Strukturoperationen

• Speichern als aTool-Dokument

• Umschalten Eigen/Fremdformatierung

• Elementannotationen

Projekt „Textorientierte Autorentools“

Strukturvorgaben und Hilfetextein aTool

Springer Verlag – RWTH Aachen – TU München 19. Februar 2001

Technische Universität MünchenProf. Dr. Anne Brüggemann-KleinDipl.-Math. Diana Gross

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

aTool-Kit

• aTool-Werkzeug parametrisierbar durch aTool-Kit

• Das Autorenwerkzeug wird zusammen mit einem vordefinierten aTool-Kit ausgeliefert.

• aTool-Kit:

1. Strukturvorgabe (DTD)

2. Hilfetexte zur intendierten Verwendung von Strukturelementen und ihren Attributen, zur Ursachenanalyse bei Verstößen gegen die Validität von Strukturelementen sowie zur kontextsensitiven Editierunterstützung

• Notation:

1. XML-DTD

2. Annotationsdokument in XML

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

aTool-Kit: DTDs

Wer verwendet aTool?

• AutorInnen beim Erstellen, Bearbeiten, Drucken, Speichern ihrer Dokumente

• LektorInnen im Verlag beim weiteren Bearbeiten der Dokumente

Dementsprechend werden zwei DTDs für aTool-Kits entwickelt:

• Autor XML-DTD

• Verlag XML-DTD

Ausgangspunkt bei der XML-Entwicklung ist die Article+ SGML-DTD, die die Strukturvorgaben enthält, die im Springer Verlag für Zeitschriftenartikel verwendet werden.

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Entwicklungsweg zu den aTool-Kit XML-DTDs

Article+ SGML-DTD Article+ XML-DTD

Autor XML-DTD

Verlags XML-DTD

Konvertierung der Article+ SGML-DTD nach XML

Entwicklung der aTool-Kit XML-DTDs

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Konvertierung der Article+ SGML-DTD nach XML

Article+ SGML-DTD

• ca. 190 Elementtypen, ca. 50 Parameterentitäten, 10 Notationen, 23 extern definierte Entitäten für Zeichen

• SGML-Features, die in XML nicht zulässig sind:

– Minimierungsangaben „O“ und „-“

– Kommentare innerhalb von Deklarationen

– Attributtyp NUMBER

– allgemeine Mixed Content Elemente

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Konvertierung der Article+ SGML-DTD nach XML

Article+ SGML-DTD

• weitere SGML-Features, die in XML nicht zulässig sind:

– Exklusionen oder Inklusionen

– „&“-Operator

– Elementdeklarationen CDATA und RCDATA

– Public Identifiers ohne System Identifiers

– SDATA Entitäten

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Konvertierung der Article+ SGML-DTD nach XML

Eingesetzte Konvertierungstechniken // Konsequenzen für die Instanzender SGML-DTD für die Konvertierung nach XML

1. semantisch äquivalente syntaktische Änderungen // Vollständige Klammerung von Elementen (End-Tag), Anführungszeichen bei Attributwerten

2. Verallgemeinerung der DTD ( NUMBERNMTOKEN, Elimination von Exklusionen, Mixed Contents) und Aufnahmeder Zusatzbedingungen im Annotationsdokument,um semantische Äquivalenz zu erreichen // keine

3. Spezialisierung der DTD („&“-Operator) // Umstrukturierung

4. Werkzeugunterstützung auf Instanzebene (RCDATA) // Schützender XML-Funktionszeichen

5. Umbenennen von Elementen in bestimmten Kontexten (Exklusionen) // Umbenennen

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Entwicklung der aTool-Kit XML-DTDs

• Ausgangspunkt: Article+ XML-DTD

• Ziel: Autor- und Verlags XML-DTD

• Stand: in Entwicklung

• Weitere Bearbeitung der Article+ XML-DTD:

- Überarbeitung (verlagsinterne Gründe)

- Vereinfachung für AutorInnen durch Entfernen von produktionsspezifischen Elementen und Attributen

- Aufnahme von Zusatzbedingungen im Annotationsdokument

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Annotationsdokument

• ist ein XML-Dokument: Annotationen.xml

• ist so wie auch die XML-DTD maßgebend für die Struktur der editierten aTool-Dokumente

• ist ein Bestandteil des aTool-Kits

Annotationen.xml formuliert:

• Beschränkungen an Elemente und Attribute, die die DTD selbst nicht ausdrücken kann.

• semantische Angaben zu den Elementen und Attributen der DTD, durch die aTool den Benutzern verständliche Hilfen anbieten kann.

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Annotationsdokument

Benutzung im aTool-Werkzeug

• wann: beim Editieren eines Dokuments (Tooltips und kontextsensitive Editierunterstützung)

• wann: beim Validieren eines Dokumentes

• aTool berechnet Vorschläge zur Fehlerbehandlung aus Informationen, die im Dokument, DTD und Annotationen.xml über die DOM-API zur Verfügung stehen

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Annotationsdokument

Beispiel <?xml version="1.0"?>

<!DOCTYPE dtdAnnotationen SYSTEM "dtdAnnotationen.dtd">

<dtdAnnotationen dtdURL="{URL der zu annotierenden DTD}">

<elementInfo eName="titlegrp">

<fullName>

Titelgruppe

</fullName>

<meaning>

Enthält Überschriften ersten und zweiten Grades für den Artikel.

</meaning>

<hints>

<!--Auf den zu annotierenden Elementtyp zugeschnittene Formtexte, die in den Hilfetexten

zu Validierungsfehlern Verwendung finden. Das genauere Format des Elements hints muss

noch entwickelt werden. -->

</hints>

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Annotationsdokument

Beispiel <classes>

<!-- Welche aTool-Klassifizierungen hat das Element? -->

<!--autoIns/-->

<autoGen>

<![CDATA[ <title language="de"></title> ]]>

</autoGen>

<!--authorlevel/-->

</classes>

<!--eConstraints-->

<!-- Welche Constraints erfuellt das Element ueber die DTD hinaus?

Vorerst sind nur einzelne Constraints definiert.

Als Erweiterung koennte man sich hier eine Sprache

vorstellen, mit der sich Constraints konstruieren lassen -->

<!--neverEmpty/--!>

<!--alwaysFirst/--> <!--/eConstraints-->

</elementInfo></dtdAnnotationen>

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Hilfetexte

• Hilfen und Dokumentation integriert in Word-Hilfemechanismen.

• Hilfetexte integriert in den Annotationen.

Strukturvorgaben und Hilfetexte in aTool 19. Februar 2001

Dokumente

• http://www11.in.tum.de/aTool/ - Projektserver:

• Annotationen.xml und Annotationen.dtd

• Dokumentation der SGML nach XML Konvertierung von Article+ DTD

• Anforderungen an Fehlermeldungen und Fehlerbehandlung bei der Validierung in aTool