Projekt Textorientierte Autorentools Werkzeugentwicklung aTool Springer Verlag – RWTH Aachen – TU München19. Februar 2001 Lehrstuhl für Informatik III RWTH Aachen Dipl.-Inform. Oliver Meyer Dipl.-Inform. Felix Gatzemeier

aTool: Werkzeugentwicklung19. Februar 2001 aTool: verfügbare Funktionen Batch-Konvertierung Word-Dokument XML-Baum XML-Baum wird inkrementell validiert. Elementattribute bearbeiten Teilbäume verschieben Dokumente als XML speichern

aTool: Werkzeugentwicklung19. 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 Hilfetexte in aTool Springer Verlag – RWTH Aachen – TU München19. Februar 2001 Technische Universität München Prof. Dr. Anne Brüggemann-Klein Dipl.-Math. Diana Gross

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 aTool-Kit aTool-Werkzeug parametrisierbar durch aTool-Kit Das Autorenwerkzeug wird zusammen mit einem vordefinierten aTool-Kit ausgeliefert. aTool-Kit: Strukturvorgabe (DTD) 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: XML-DTD Annotationsdokument in XML

Strukturvorgaben und Hilfetexte in aTool19. 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 aTool19. Februar 2001 Entwicklungsweg zu den aTool-Kit XML-DTDs Article+ SGML-DTDArticle+ 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 aTool19. 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 aTool19. 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 aTool19. Februar 2001 Konvertierung der Article+ SGML-DTD nach XML Eingesetzte Konvertierungstechniken // Konsequenzen für die Instanzen der SGML-DTD für die Konvertierung nach XML 1. 1.semantisch äquivalente syntaktische Änderungen // Vollständige Klammerung von Elementen (End-Tag), Anführungszeichen bei Attributwerten 2. 2.Verallgemeinerung der DTD ( NUMBER NMTOKEN, Elimination von Exklusionen, Mixed Contents) und Aufnahme der Zusatzbedingungen im Annotationsdokument, um semantische Äquivalenz zu erreichen // keine 3. 3.Spezialisierung der DTD (&-Operator) // Umstrukturierung 4. 4.Werkzeugunterstützung auf Instanzebene (RCDATA) // Schützen der XML-Funktionszeichen 5. 5.Umbenennen von Elementen in bestimmten Kontexten (Exklusionen) // Umbenennen

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Konvertierung der Article+ SGML-DTD nach XML Mixed Content Elemente Sind Elemente mit gemischtem Inhalt aus Text und einer Folge weiterer Elemente zulässige Strukturen in SGML: #PCDATA in Kombination mit beliebigen Oparatoren zulässige Struktur in XML: – –Optional und wiederholbare (*) Either-Or Gruppe (|) – –#PCDATA immer als erstes Element – –Andere Elemente die #PCDATA folgen

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Konvertierung der Article+ SGML-DTD nach XML Mixed Content Konvertierungsbeispiel Die SGML Deklaration für das Mixed Content Element p (Paragraph): <!ELEMENT p - - (phead?,(#PCDATA|q|%e.subp;|emph|...|...)+ Wurde nach XML folgendermaßen konvertiert: <!ELEMENT p (#PCDATA|phead|q|%e.subp;|emph|...|...)* Problem: Ohne das Einfügen von neuen Elementen verliert man an Semantik. Lösung: Eine zusätzliche aTool-Funktionalität überprüft die durch Konvertierung verlorengegangene Strukturinformation.

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Konvertierung der Article+ SGML-DTD nach XML Exklusionen Eine 1:1 Konvertierung der SGML-Exklusionen in valide XML-Konstrukte ist nur durch Einfügen von zusätzlichen Elementen möglich. Für intuitive Fälle, wie zum Beispiel keine footnote in footnote, wurden die zu exkludierenden Elemente (hier footnote) einfach weggelassen. In einer zusätzlichen Beschreibung, wie z.B. Hilfetexten, kann man diese Regeln festhalten und dem Autor bekannt machen. In den weniger intuitiven Fällen wurden neue Elemente in der XML-DTD hinzugefügt.

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Konvertierung der Article+ SGML-DTD nach XML Beispiel einer Exklusionskonvertierung SGML-Deklaration: <!ELEMENT abstract - - (head?,(p|bq|...|%e.lists;)*,section*) -(subsec2)?> wobei subsec2 Kind von subsec1 und subsec1 Kind von section ist. subsec2 kommt nur im section-Zweig als Unterelement vor. XML-Deklaration: sectionA ist ein neues Element, das dieselbe Struktur wie section ohne subsec1 hat. Auf diese Weise kann subsec2 in abstract nicht vorkommen.

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Konvertierung der Article+ SGML-DTD nach XML RCDATA-Deklarationen Replaceable Character Data werden in der XML-Fassung durch PCDATA ersetzt. Problem: In SGML-Elementen mit RCDATA-Inhalt können Zeichen wie vorkommen, die in XML bestimmte Funktionen erfüllen und deswegen nicht als Zeichenformate in XML interpretiert werden können. Lösung: Erstellen einer Liste im aTool-Kit mit allen XML-Elementen deren Textinhalte wörtlich ausgegeben werden sollen. Einfügen der RCDATA-Inhalte in CData Sections. Wenn das Kodierungsformat oder das Vorkommen der Zeichen ]]> die erwünschte Anzeige der CData Sections nicht ermöglicht, dann werden für die nicht darstellbaren Zeichen Entitätsreferenzen eingesetzt

Strukturvorgaben und Hilfetexte in aTool19. 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 aTool19. 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 aTool19. 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 aTool19. Februar 2001 Annotationsdokument Beispiel Titelgruppe Enthält Überschriften ersten und zweiten Grades für den Artikel. <!--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. -->

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Annotationsdokument Beispiel ]]> <!-- 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 -->

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Hilfetexte Hilfen und Dokumentation integriert in Word-Hilfemechanismen. Hilfetexte integriert in den Annotationen.

Strukturvorgaben und Hilfetexte in aTool19. Februar 2001 Dokumente - 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