Legenda van de schemadocumentatie
De schemadocumentatie gebruikt interactieve diagrammen om de XML-structuur te visualiseren en aan te geven hoe de informatie gestructureerd is. Onderstaande diagrammen illustreren de meestgebruikte symbolen en andere onderdelen van zo'n diagram. In de documentatie zijn de diagrammen klikbaar: de benoemde onderdelen linken naar hun eigen definitie.
De uitleg hieronder gebruikt de prefix xs:
voor elementen uit namespace van XML Schema Documents xmlns:xs="http://www.w3.org/2001/XMLSchema"
.
Elementen
Elementen worden in de diagrammen getekend als een een rechthoek met afgeronde hoeken.
Het onderstaande diagram toont een element waarvan de kindelementen een vaste volgorde
hebben (middels een xs:sequence
). De namen van de kinderen in dit voorbeeld geven de verschillende kardinaliteiten
(optioneel, verplicht, meervoudig). De lijnen naar en om verplichte kinderen zijn in de diagrammen dikker dan de lijnen naar en om optionele kinderen.
Het element in dit voorbeeld heeft tevens een attribuutgroep.
Globale en lokale definities
In bovenstaand diagram verwijst (middels xs:element/@ref
) het content model naar vier globaal gedeclareerde elementen ( verplicht-element
, optioneel-element
, verplicht-meervoudig-element
en optioneel-meervoudig-element
). De verwijzing is getoond middels het pijltje rechts onderin de rechthoek. Globaal
gedeclareerde elementen hebben in de gehele XSD dezelfde definitie.
Het laatste element element-lokaal-in-dit-content-model
is een lokale declaratie (middels xs:element/@name
) die alleen geldt binnen de context van het ouder-element element-met-vaste-volgorde
.
De lokale elementdeclaraties staan in de documentatie op dezelfde pagina als het ouderelement. Dat is immers de enige context waarin dat element gebruikt mag worden.
Element met keuze
Onderstaand diagram toont een element waar het content model een keuze biedt (middels een xs:choice
) tussen een verplichte-eerste-element
enerzijds of een verplichte-tweede-keuze
gevolgd door een optionele-derde-keuze
anderzijds.
Element met onbepaalde volgorde
Onderstaande diagram toont een element waarin de volgorde van de kindelementen onbepaald
is (middels een xs:all
)
Attribuutgroep
Attributen worden getekend als een rechthoek met links rechte en rechts afgeronde hoeken.
xs:complexType
Een element waarvan het type gedefinieerd is middels een benoemd xs:complexType
toont de naam van zijn type onderin de afgeronde rechthoek en toont tevens het model
van dat complexType:
Het xs:complexType
zelf wordt getekend als een rechthoek met scherpe hoeken met daarbinnen links een
vierkant:
Lokale elementen binnen een xs:complexType
Binnen een xs:complexType
worden vaak alleen lokale elementdeclaraties gebruikt. Net zoals lokale elementdeclaraties binnen een element worden de lokale
elementen van een xs:complexType
op dezelfde pagina als het xs:complexType
zelf gedocmenteerd.
xs:simpleType
Een element waarvan het type is gedefinieerd middels een zogenaamd xs:simpleType
ofwel "datatype" toont ook de naam van dat type onderin de afgeronde rechthoek
Het xs:simpleType
zelf is een langwerpige achthoek met daarbinnen links een driehoek. Het diagram toont
het basistype van de XML Schema datatypes waarop het xs:simpleType
is gebaseerd.