xs:documentation

(Auszug aus "XML Schema" von Eric van der Vlist)

Dokumentation für Menschen.

<xs:documentation
    source = xs:anyURI
    xml:lang = xml:lang
    >
    Content: ({any})*
</xs:documentation>

Kann auftreten innerhalb von: xs:annotation

Beschreibung

xs:documentation ist ein Container für Dokumentation als einfacher Text oder in strukturiertem Format, die für Menschen lesbar ist. Sein Inhaltsmodell ist offen und kann jedes beliebige Element aus jedem beliebigen Namensraum akzeptieren (mit der Validierung lax; hier angegebene Elemente von W3C XML Schema müssen gültig sein). xs:documentation kann verwendet werden, um beliebige Arten von Information aufzunehmen.

Der Inhalt ist ähnlich wie bei xs:appinfo (das für Informationen reserviert ist, die von Anwendungen verarbeitet werden können) mit Ausnahme des Attributs xml:lang (das bei xs:documentation erlaubt ist, bei xs:appinfo jedoch verboten).

Einschränkungen

Fremdattribute können für xs:documentation nicht angegeben werden. Das Attribut source ist in der Recommendation nicht ausreichend spezifiziert. Dies könnte zu Interoperabilitätsproblemen zwischen Anwendungen, die auf xs:documentation zugreifen, führen.

Beispiel

<xs:element name="author" type="author">
    <xs:annotation>
        <xs:documentation xml:lang="en">The author of a book.</xs:documentation>
        <xs:documentation xml:lang="de">Der Autor eines Buches.</xs:documentation>
    </xs:annotation>
</xs:element>

Attribute

source
Kann verwendet werden, um eine Verknüpfung zur Informationsquelle anzugeben, wenn ein Ausschnitt angegeben wird; kann auch als semantisches Attribut benutzt werden, um die Art der angegebenen Information zu bestimmen.

xml:lang
Die für die Dokumentation verwendete Sprache.

   

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema XML Schema bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2003 O'Reilly Verlag GmbH & Co. KG
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "XML Schema" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

O’Reilly Verlag GmbH & Co. KG, Balthasarstraße 81, 50670 Köln, kommentar(at)oreilly.de