Documentación de esquemas

De Manuais Informática - IES San Clemente.
Revisión del 15:30 20 ene 2011 de Arribi (discusión | contribuciones)
(dif) ← Revisión anterior | Revisión actual (dif) | Revisión siguiente → (dif)
Ir a la navegación Ir a la búsqueda

A documentación dos esquemas é fundamental pois estes proporcionan información tanto ás persoas, como aos métodos de procesamento automático que se executan no momento de crear os documentos instancia XML. Unha forma de facelo é a través dos comentarios que se poden incluír como se facía en XML (os esquemas son documentos XML) pero existen elemtos máis potentes pensados para este obxectivo:

  • Elemento annotation. Proporciona un mecanismo para documentar ou anotar os compoñentes duneEsquema, facendo unha función similar aos comentarios, aínda que dando unha información máis completa, xa que annotation non se reduce á forma: <!? texto ­­>, senón que pode proporcionar documentación tanto para quen manexe o documento como para o procesado automático do mesmo. A continuación vemos un exemplo:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:annotation>
  <xs:appInfo>Libros</xs:appInfo>
  <xs:documentation xml:lang="es">
  Este esquema describe exemplares de libros.
  </xs:documentation>
</xs:annotation>

.
.
.

</xs:schema>
  • Elemento documentation. Consiste ben nun texto, lexible por un humano, ben nunha referencia a un texto dado por un URI, sempre dentro dun elemento annotation. O seu contido nun documento XML non ten límites, de forma que un elemento annotation pode conter moitos elementos documentation e cada un pode presentar información máis ou menos redundante, como sería o caso do uso de idiomas distintos. Os seus dous atributos opcionais son source ( unha URI que o procesador non valida, que representa calquera documento considerado relevante ) e xml:lang ( que especifica a linguaxe da documentación ).
  • Elemento appinfo. Proporciona información a outras aplicacións, o que supón un procesamiento externo ao propio documento e que só un elemento annotation pode conter.