Convenio de codificación específico para XML

LIBP-0010 (Libro de pautas)

Se recogen una serie de convenios de codificación específicos de XML, a tener en cuenta además de los generales

Las convenciones de codificación ayudan a la uniformidad y legibilidad del código fuente, facilitando su mantenimiento por terceros, y eliminando la dependencia del desarrollador. A continuación se ofrece una convención de código de los diferentes elementos que componen el lenguaje XML. Los documentos XML se dividen en dos grupos, documentos bien formados y documentos válidos.

  • Bien formados: Son todos los que cumplen las especificaciones del lenguaje respecto a las reglas sintácticas sin estar sujetos a unos elementos fijados en un DTD o en un Xschema. De hecho los documentos XML deben tener una estructura jerárquica muy estricta y los documentos bien formados deben cumplirla.
  • Válidos: Además de estar bien formados, siguen una estructura y una semántica determinada por un DTD: sus elementos y sobre todo la estructura jerárquica que define el DTD o el Xschema, además de los atributos, deben ajustarse a lo que el DTD o el Xschema dicte.

Pautas

TítuloCarácter
Documentos bien formados y válidosObligatoria
Estructura de un documentoObligatoria
Elemento raíz de un documentoObligatoria
Comillas en valores de atributos en XMLObligatoria
Mayúsculas y minúsculasRecomendada
Identificación de elementosObligatoria

Documentos bien formados y válidos

Crear documentos que cumplan con la especificación XML 1.0

Los documentos XML deben cumplir con la especificación XML 1.0; es decir, deben estar bien formados y ser válidos; dicho de otro modo, deben cumplir una estructura predefinida en un DTD.

Estructura de un documento

Las etiquetas deben estar anidadas de forma correcta

Los documentos han de seguir una estructura estrictamente jerárquica con lo que respecta a las etiquetas que delimitan sus elementos. Una etiqueta debe estar correctamente incluida en otra, es decir, las etiquetas deben estar anidadas de forma correcta. Los elementos con contenido deben estar adecuadamente cerrados.

Elemento raíz de un documento

Establecer un solo elemento raíz para el documento XML.

Los documentos XML sólo permiten un elemento raíz del que todos los demás sean parte, es decir, sólo pueden tener un elemento inicial.

Comillas en valores de atributos en XML

Usar comillas en los valores de los atributos en XML

Los valores de los atributos en XML siempre deben estar encerrados entre comillas simples o dobles.

Mayúsculas y minúsculas

Escribir las etiquetas, desde el principio, todas en mayúsculas o en minúsculas

El XML es sensible a mayúsculas y minúsculas, por este motivo se recomienda escribir las etiquetas XML desde el principio todas en mayúsculas o en minúsculas.

Identificación de elementos

Asignar nombres a los elementos en los documentos XML

En XML los nombres tienen alguna característica en común, por lo que es necesario asignar nombres a las estructuras, tipos de elementos, entidades, elementos particulares, etc.

Contenidos relacionados