Dokumentation generieren

www.altova.com Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Benutzerhandbuch und Referenz > Menübefehle > Menü "Schema-Design" >

Dokumentation generieren

ic_schema_docs

Mit diesem Befehl wird eine detaillierte Dokumentation zu Ihrem XML- oder JSON-Schema (siehe Abbildung unten ) im HTML-, MS Word-, RTF-, oder PDF-Format erzeugt. Diese Dokumentation kann nach Wunsch geändert und verwendet werden; Sie benötigen dafür keine Genehmigung von Altova. Die Dokumentation wird für diejenigen Komponenten generiert, die Sie im Dialogfeld "(JSON)-Schema-Dokumentation" auswählen (Aufruf des Dialogfelds mit dem Befehl "Dokumentation generieren"). Verwandte Elemente (Child-Elemente, ComplexTypes, usw.) werden in der Regel in der Bildschirmausgabe mit Hyperlinks versehen, sodass Sie zwischen den einzelnen Komponenten navigieren können. Komponenten mit einem Content Model weisen auch Links zur jeweiligen Content Model-Definition auf. Beachten Sie, dass Schema-Dokumentation auch für inkludierte  und importierte Schemakomponenten generiert wird. Die verschiedenen Optionen für die Generierung von Dokumentation zu XML-Schemas werden im Abschnitt "Dokumentationsoptionen" beschrieben. Die Optionen zur Generierung von JSON-Schemas sind im Abschnitt Generieren von JSON-Schema-Dokumentation beschrieben.

 

Beachten Sie, dass die Dokumentationsoptionen zusätzlich zu den im Dialogfeld Schema-Ansicht konfigurieren definierten Einstellungen angewendet werden.

 

Anmerkung:Um Dokumentation im Format MS Word zu generieren, müssen Sie MS Word (Version 2000 oder höher) installiert haben.

 

Sie können für das generierte Dokument entweder das festgelegte Standard-Design von XMLSpy verwenden oder für das Design ein StyleVision SPS verwenden. Die Verwendung eines StyleVision SPS hat den Vorteil, dass Sie das Design der generierten Dokumentation anpassen sowie als zusätzliches Ausgabeformat PDF generieren können. Wie man mit einem SPS arbeitet, wird in im Abschnitt "Benutzerdefiniertes Design" erklärt.

 

Anmerkung:Um ein SPS zum Generieren von Schema-Dokumentation zu verwenden muss StyleVision auf Ihrem Computer installiert sein.

schema-doc-ipo

In der oben gezeigten Abbildung sehen Sie die generierte Schema-Dokumentation mit einem Index (alle verwandten Schemas mit ihren globalen Komponenten nach Komponententyp geordnet) am Beginn des Dokuments.

 

Anmerkung:Bei der Generierung von Dokumentation für W3C-Schemadokumente verwendet XMLSpy applikationsinterne Versionen dieser Dokumente. Aus diesem Grund werden andere Ordner für diese Applikationen nicht berücksichtigt und Redefinitionen und andere Änderungen am Schema werden in der Dokumentation nicht berücksichtigt.

 


© 2019 Altova GmbH