Changes between Initial Version and Version 1 of echo-schema/overview

Timestamp:

Jul 19, 2011, 2:53:45 PM (13 years ago)

Author:

Wolfgang Schmidle

Comment:

--

echo-schema/overview

@@ +1 @@
+[[PageOutline(1-4,,pullout)]]
+
+[wiki:echo-schema ECHO-Schema], [wiki:echo-schema/overview 1. Überblick], [wiki:echo-schema/usage-guide 2. Usage Guide], [wiki:echo-schema/implementation 3. Umsetzung]
+
+== 1. Übersicht
+
+Übersichtsgrafik über die Schema-Module: 
+
+[[Image(schema_overview.gif, 70%)]]
+
+
+=== Schema-Struktur
+
+Das Schema besteht aus Gruppen von Modulen, die im Schaubild mit schwarzen Rahmen markiert sind:
+
+ 1. Standard-Module
+  * core modules: [source:trunk/schema/schema/echo/modules/echo-start.rnc start], [source:trunk/schema/schema/echo/modules/echo-metadata.rnc metadata], [source:trunk/schema/schema/echo/modules/echo-text.rnc text], [source:trunk/schema/schema/echo/modules/echo-block.rnc block], [source:trunk/schema/schema/echo/modules/echo-content.rnc content], [source:trunk/schema/schema/echo/modules/echo-attribute.rnc attribute], [source:trunk/schema/schema/echo/modules/echo-datatype.rnc datatype]. Diese Module müssen auf alle Fälle vorhanden sein.
+ 2. Module zur Grobstrukturierung des Textes
+  * text structure: [source:trunk/schema/schema/echo/modules/echo-div.rnc div], [source:trunk/schema/schema/echo/modules/echo-milestone.rnc milestone]. Diese Module sind optional, aber wird bekommen die entsprechende Information aus dem transkribierten Text, und unser Anzeigesystem benötigt diese Informationen.
+ 3. Module zur Feinstrukturierung des Textes
+  * additional text blocks (floats): [source:trunk/schema/schema/echo/modules/echo-float.rnc float], [source:trunk/schema/schema/echo/modules/echo-note.rnc note], [source:trunk/schema/schema/echo/xhtml/echo-import-xhtml.rnc import-xhtml], [source:trunk/schema/schema/echo/modules/echo-figure.rnc figure], [source:trunk/schema/schema/echo/modules/echo-handwritten.rnc handwritten]. Diese Module sind ebenfalls optional, aber wird bekommen die entsprechende Information aus dem transkribierten Text.
+  * additional text blocks (non-floats): [source:trunk/schema/schema/echo/modules/echo-textflows.rnc textflows], [source:trunk/schema/schema/echo/modules/echo-block-scholarly.rnc block-scholarly]. Diese optionalen Module werden bei Texten mit mehreren Textflows (z.B die "Conimbricenses") sowie bei der Erstellung von Editionen mit wissenschaftlichem Anspruch benötigt.
+ 4. Module für die Auszeichnung von Text:
+  * additions to the inline model: [source:trunk/schema/schema/echo/modules/echo-gap.rnc gap], [source:trunk/schema/schema/echo/modules/echo-de.rnc de], [source:trunk/schema/schema/echo/modules/echo-mathematics.rnc mathematics], [source:trunk/schema/schema/echo/modules/echo-import-mathml.rnc import-mathml], [source:trunk/schema/schema/echo/modules/echo-gis.rnc gis], [source:trunk/schema/schema/echo/modules/echo-content-scholarly.rnc content-scholarly]. Diese optionalen Module sind (bis auf gap) Teil der wissenschaftlichen Bearbeitung der Texte
+  * additional attributes for Chinese text: [source:trunk/schema/schema/echo/modules/echo-chinese-text.rnc chinese-text]. Dieses Modul wird für chinesischen Text benötigt. Die entsprechenden Informationen sind in der Transkription bereits enthalten.
+
+Die Grund-Datei des Schemas ist [source:trunk/schema/schema/echo/echo.rnc echo.rnc] im Verzeichnis [source:trunk/schema/schema/echo], in der die Version des Schemas (z.B. 1.0) sowie die verwendeten namespaces definiert werden. In der Grund-Datei werden außerdem die Module eingebunden. Wenn man für einen bestimmten Text nicht alle Module benötigt, kann man die entsprechenden Zeilen einfach auskommentieren. Zum Beispiel sind in [source:trunk/schema/schema/echo/echo-automated-european.rnc echo-automated-european.rnc] die Module [source:trunk/schema/schema/echo/modules/echo-chinese-text.rnc chinese-text] für chinesischen Text und [source:trunk/schema/schema/echo/modules/echo-content-scholarly.rnc content-scholarly] für nicht-automatisierbare Textverbesserungen auskommentiert.
+
+Die Module sind alle im Unterverzeichnis [source:trunk/schema/schema/echo/modules modules], bis auf [source:trunk/schema/schema/echo/xhtml/echo-import-xhtml.rnc import-xhtml], das zusammen mit einigen unnverändert übernommenen xhtml-Modulen im Unterverzeichnis [source:trunk/schema/schema/echo/xhtml xhtml] ist.  
+
+=== Beziehungen zwischen den Modulen
+
+Die Beziehungen zwischen den Modulen sind im Schaubild durch Pfeile dargestellt. Dazu einige Erläuterungen:
+
+ 1. Pfeile 
+  * A → B:  Modul A modifiziert Modul B, indem es in A definierte Klassen oder Elemente in in B definierten Klassen oder Elementen erlaubt
+  * A --> B:  Modul A weiß von Modul B, modifiziert es aber nicht
+
+ Die Pfeile geben also nicht die Hierarchie der Elemente im XML-Dokument wieder. Sondern: Wenn man B auskommentiert, wird A nicht mehr richtig funktionieren.
+ 2. Farben
+  * grün: Module
+   * dunkelgrün: Information in der Transkription enthalten
+   * hellgrün: Information nicht in der Transkription enthalten
+  * rot: !Element/Klasse wird in diesem Modul definiert
+  * gelb: entspricht einem Pfeil, also A modifies B; wird verwendet, wenn ein Pfeil das Schaubild verwirren würde
+  *  weiß: modifiziert Modul B, indem es Attribute ergänzt
+  * blau: A verwendet ein in [source:trunk/schema/schema/echo/modules/echo-echo-content.rnc echo-content] definiertes Textmodell (weggelassen, wenn A bereits einen Pfeil zu echo-content hat)
+
+Die Definitionen in den Modulen [source:trunk/schema/schema/echo/modules/echo-echo-attribute.rnc echo-attribute] und [source:trunk/schema/schema/echo/modules/echo-echo-datatype.rnc echo-datatype] werden von allen anderen Modulen verwendet. Verbindungen zu diesen Modulen sind nicht eingezeichnet. 
+
+Das originale PDF ist hier: [source:trunk/papers/documentation/schema_overview/schema_overview.pdf PDF]; Legende zur Grafik: [source:trunk/papers/documentation/schema_overview/Legende.pdf PDF] (Beides Stand März 2010. Die Struktur des Schemas hat sich kaum geändert; trotzdem TO DO: aktualisieren)