Cómo se escribe un documento XML: Sintaxis

2. Cómo se escribe un documento XML: Sintaxis

Un documento XML está formado por una jerarquía de elementos. Veamos punto por punto cómo se escribe un documento XML.

2.1. Declaración XML

La declaración XML (XML declaration) es una instrucción que se coloca al comienzo de un documento XML para indicar que el archivo sigue la sintaxis y reglas del lenguaje XML. La sintaxis básica de una declaración XML es la siguiente:

<?xml versión="1.0" encoding="UTF-8"?>

Donde:

• <?xml indica el inicio de la declaración XML.
• versión="1.0" especifica la versión de XML utilizada. En este caso, se utiliza la versión 1.0.
• encoding="UTF-8" indica la codificación de caracteres utilizada en el documento. En este caso, se utiliza UTF-8, que es una codificación común para admitir caracteres multilingües.

Es importante destacar que la declaración XML es opcional en ciertos casos. Sin embargo, se recomienda incluir la declaración XML para garantizar la compatibilidad y claridad del documento.

Además de la versión y la codificación, la declaración XML también puede incluir otras propiedades, como la especificación del DTD (Document Type Definition) o el esquema XML utilizado en el documento. Estas propiedades adicionales se agregan utilizando atributos en la declaración XML.

El atributo standalone es opcional y se utiliza para indicar si el documento XML puede funcionar de manera independiente o si requiere información adicional de otro archivo externo (como un DTD o un esquema) para ser interpretado correctamente.

• standalone="yes": Indica que el documento XML no depende de ningún archivo externo y puede ser interpretado de manera autónoma. Todos los datos necesarios para la interpretación están contenidos dentro del propio archivo XML.
• standalone="no": Indica que el documento XML depende de un archivo externo, como un DTD o un esquema, para ser interpretado correctamente. El archivo externo proporciona la definición de la estructura y reglas que el XML debe seguir.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

2.2. Elementos

Un documento XML está formado por una jerarquía de elementos a partir de un elemento raíz único. Los elementos constan de una etiqueta de inicio <nombreetiqueta>, un valor y una etiqueta de fin </nombreetiqueta>.

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <element1>Contenido del elemento 1</element1>
  <element2 atributo="valor">Contenido del elemento 2</element2>
  <element3>
    <subelement>Contenido del subelemento</subelement>
  </element3>
</root>

En el ejemplo anterior el elemento raíz <root> es el contenedor principal del documento XML. Todos los demás elementos deben estar contenidos dentro de él.

Los elementos se han definido utilizando etiquetas. Por ejemplo, <element1> y <element2> son elementos en el ejemplo.

Como ves, los elementos pueden tener atributos, que se definen dentro de la etiqueta de apertura. Por ejemplo, <element2 atributo="valor">. Además, los elementos pueden contener texto, como se muestra en los ejemplos con el contenido entre las etiquetas de apertura y cierre, y también pueden contener otros elementos, formando una estructura jerárquica.

2.3. Nombres de los elementos y sintaxis

El nombre de un elemento o tag debe empezar por una letra o el guion bajo, seguido por letras, dígitos, el carácter punto, el carácter guion medio o el carácter guion bajo. Además, el nombre no deberá comenzar por la cadena XML, ya sea en mayúsculas o en minúsculas.

XML distingue entre mayúsculas y minúsculas. Por tanto, no es lo mismo poner <nombre> que <NOMBRE>.

Los nombres de los elementos son definidos por el desarrollador o desarrolladora y es recomendable que sean lo más descriptivos posible. Ejemplo:

<?xml version="1.0" encoding="UTF-8"?>
<profesor>
  <nombre>Andrea</nombre>
  <apellidos>Lluch Cruz</apellidos>
  <fecha-de-nacimiento>
      <día>28</día>
      <mes>2</mes>
      <año>2030</año>
   </fecha-de-nacimiento>
</profesor>

2.4. Espacios en blanco y saltos de línea

Detrás del nombre de una etiqueta se permite escribir un espacio en blanco (blank space) o un salto de línea (line break). Por ejemplo, sintácticamente es correcto escribir:

<nombre >Andrea</nombre>

Sería lo mismo que escribir:

<nombre>Andrea</nombre>

Sin embargo, no puede haber un salto de línea o un espacio en blanco antes o en medio del nombre de una etiqueta. En caso de que se necesite un salto de línea por organización del código, puede hacerse después de la etiqueta de apertura completa:

<nombre>
Andrea
</nombre>

2.5. Elementos vacíos

En un documento XML, un elemento puede no contener ningún valor, es lo que se llama elemento vacío (empty element). Ejemplo:

<nombre></nombre>

El código anterior se puede escribir de la siguiente manera:

<nombre/>

2.6. Atributos de los elementos

En XML, los atributos son valores adicionales que se pueden asociar a elementos para proporcionar información adicional o metadatos sobre ellos. Los atributos se definen dentro de la etiqueta de apertura de un elemento y tienen un nombre y un valor.

La sintaxis básica para definir un atributo en XML es la siguiente:

<elemento atributo="valor">

Donde:

• elemento es el nombre del elemento al que se le está asignando el atributo.
• atributo es el nombre del atributo que se está definiendo.
• valor es el valor asignado al atributo.

Ejemplo:

<persona nombre="Andrea" edad="30" profesion="profesora"/>

Los nombres de los atributos cumplen las mismas normas de sintaxis que los nombres de los elementos. Además, todos los atributos de un elemento tienen que ser únicos y deben separarse con espacios en blanco.

Por ejemplo, es incorrecto escribir:

<persona nombre="Andrea" apellido="Lluch" apellido="Cruz"/>

Sin embargo, sí es correcto escribir:

<persona nombre="Andrea" primerapellido="Lluch" segundoapellido="Cruz"/>

2.7. Comentarios en XML

Puedes insertar comentarios (comments) en tu documento XML para proporcionar explicaciones o notas adicionales. Los comentarios no se interpretan ni se muestran en la salida del documento XML, ya que son información destinada únicamente a los desarrolladores o lectores del código.

Es importante tener en cuenta que no se pueden agregar comentarios en el interior de las etiquetas y no está permitido escribir dos guiones seguidos en el interior de un comentario.

Ejemplo de cómo agregar comentarios en XML:

<!-- Este es un comentario en XML -->
<etiqueta>Contenido de la etiqueta</etiqueta>
<!-- Otro comentario -->
<otra_etiqueta>Contenido de otra etiqueta</otra_etiqueta>

2.8. Atributo xml:space

El atributo xml:space es un atributo especial en XML que se utiliza para controlar cómo se manejan los espacios en blanco dentro de los valores de texto en un elemento XML. Este atributo se puede aplicar a cualquier elemento XML y tiene dos posibles valores:

• default: Este es el valor predeterminado si no se especifica el atributo xml:space. Indica que los espacios en blanco dentro del valor de texto se manejan de acuerdo con las reglas normales de XML. Esto significa que los espacios en blanco iniciales y finales se eliminan y los espacios en blanco consecutivos se reducen a un solo espacio.
• preserve: Este valor indica que los espacios en blanco dentro del valor de texto deben preservarse tal como están, sin eliminación ni reducción. Esto es útil cuando se desea conservar los espacios en blanco significativos en el texto, como en los códigos de programación o los contenidos preformateados.

<elemento xml:space="preserve">
    Este es      un    texto con    espacios   en blanco.
</elemento>

En este ejemplo, al utilizar xml:space="preserve", se conservarán todos los espacios en blanco, incluidos los espacios múltiples entre las palabras. Si no se especificara el atributo xml:space, se aplicaría el comportamiento predeterminado y los espacios en blanco serían reducidos y normalizados.

2.9. Tabulaciones

El uso de tabulaciones (tabuladores) está permitido para mejorar la legibilidad del documento, al igual que los espacios y saltos de línea. Pueden utilizarse para indentar las etiquetas y estructurar visualmente la jerarquía del documento XML, lo que ayuda a entender la relación entre los diferentes elementos.

Por ejemplo, se puede utilizar el tabulado para indentar elementos anidados:

<persona>
    <nombre>Andrea</nombre>
    <apellido>Lluch</apellido>
    <contacto>
        <email>andrea@example.com</email>
        <telefono>123456789</telefono>
    </contacto>
</persona>

Ahora que ya sabes cómo escribir un documento XML, te interesa ver la siguiente sección para aprender cómo se crea un documento XML.