Name

xs:documentation

Synopsis

<xs:documentation
  source = "anyURI"
  xml:lang = "language">
  <!-- any well-formed XML markup -->
</xs:documentation>

The xs:documentation element appears exclusively inside xs:annotation elements, where it provides human-readable information about the schema or schema element it’s annotating. It has no effect on schema validation. It can contain absolutely any XML markup: XHTML, DocBook, or just plain text. The only restriction is that the contents must be well-formed. Alternately, instead of or in addition to including this information directly, the source attribute can point to it using a URI. The xml:lang attribute can indicate the language in which the description is written. You could even include multiple xs:documentation elements in different languages.

Get XML in a Nutshell, 3rd Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.