Para entender los archivos de declaración que utiliza el servidor de aplicaciones de InterAction y el Web Client, es importante conocer los conceptos básicos del Lenguaje de Marcado Extensible (XML).
XML es un lenguaje de marcado similar a HTML. La diferencia principal es que XML es más estructurado y es extensible: un documento XML puede usar un conjunto personalizado de etiquetas de marcado.
Esta sección cubre los siguientes temas:
- Declaración XML
- Elementos y Etiquetas
- Atributos y Valores
- Comentarios
- Cómo hacer que un documento XML esté bien formado
- Uso de un editor XML
Esta guía ofrece una visión muy general de los archivos XML para fines de personalización del Web Client. Para una explicación más completa sobre XML, consulta otros recursos sugeridos en Más recursos sobre XML.
Declaración XML
La primera línea de un documento XML es siempre la declaración XML:
<?xml version="1.0" standalone="yes"?>
Esto proporciona información sobre la versión de XML y si el documento utiliza una definición de tipo de documento (DTD). Una DTD es un conjunto de reglas que define la estructura permitida para un documento XML. Los archivos XML que necesitas editar para el servidor de aplicaciones se consideran documentos independientes; esto significa que no existe una DTD correspondiente para estos archivos.
Elementos y Etiquetas
XML es similar a HTML en el sentido de que está compuesto por elementos. Un elemento puede marcar texto o simplemente proporcionar información que utiliza el servidor de aplicaciones. Por ejemplo, un elemento “menuItemDeclarations” marca texto que se define como elementos de menú.
Los elementos se especifican en un documento XML colocándolos dentro de etiquetas. Una etiqueta está delimitada por los signos menor que (<) y mayor que (>) y contiene el nombre del elemento, como el siguiente ejemplo:
<profileDeclarations>
Este es un ejemplo de una etiqueta de apertura para el elemento. Todas las etiquetas de apertura deben cerrarse con una etiqueta de cierre. Una etiqueta de cierre es idéntica a la de apertura, excepto que lleva una barra diagonal (/) antes del nombre del elemento:
</profileDeclarations>
Todo lo que esté entre la etiqueta de apertura y la de cierre se considera parte del elemento. El elemento puede contener texto, otras etiquetas XML o estar vacío.
Un elemento puede tener requisitos específicos sobre lo que puede contener entre las etiquetas de apertura y cierre. Por ejemplo, un elemento puede permitir solo información de texto. Otro elemento puede permitir solo otros elementos.
A diferencia de HTML, cada etiqueta de apertura debe tener una etiqueta de cierre correspondiente. Si no hay texto ni otras etiquetas entre la de apertura y la de cierre, puedes condensarlas en una sola colocando la barra diagonal antes del signo mayor que de cierre. Por ejemplo, observa la diferencia a continuación.
Elementos vacíos en XML
|
<formControl type="label"> <controlLabel>Nombre:</controlLabel> </formControl> |
Este elemento contiene otros elementos. Observa las etiquetas de apertura y cierre separadas (<formControl> y </formControl>) que encierran la información. |
|
<field id="2/-10401"> </field> |
Este elemento no contiene texto ni otros elementos; no hay nada entre las etiquetas <field> y </field>. Por lo tanto, las etiquetas de apertura y cierre pueden condensarse en una sola etiqueta. <field id="2/-10401" /> |
Las etiquetas XML pueden estar anidadas unas dentro de otras. Las etiquetas anidadas deben abrirse y cerrarse al mismo nivel.
Los elementos disponibles para usar al configurar el Web Client dependen del tipo de archivo XML que estés editando. Para consultar los elementos que se usan en el Web Client, revisa las siguientes secciones:
- Elementos y atributos para una declaración de método de página
- Elementos y atributos para una declaración de lista de nuggets
- Elementos y atributos para una declaración de lista de búsqueda
Atributos y Valores
Un elemento también puede tener atributos. Un atributo proporciona información adicional sobre el elemento.
Los atributos se especifican en la etiqueta de apertura de un elemento, con la sintaxis nombre_atributo = "valor". Por ejemplo, el elemento field tiene los siguientes dos atributos:
-
labelcon el valor “Clientes” -
labelClasscon el valor “headline”
Los valores de los atributos deben ir entre comillas simples o dobles. No importa cuál tipo uses.
Los atributos y valores permitidos para un elemento en particular dependen del elemento. Para consultar los atributos permitidos por los elementos usados en el Web Client, revisa las siguientes secciones:
- Elementos y atributos para una declaración de método de página
- Elementos y atributos para una declaración de lista de nuggets
- Elementos y atributos para una declaración de lista de búsqueda
Comentarios
Un archivo XML puede contener comentarios. Estos se ignoran durante el procesamiento del archivo. Los comentarios son útiles para incluir notas sobre el significado de las diferentes etiquetas.
Los comentarios usan la misma sintaxis que HTML: cualquier texto entre <!-- y --> es un comentario, por ejemplo:
<!-- Esto es un comentario -->
No se pueden incluir comentarios dentro de una etiqueta. Además, un comentario no puede contener dos guiones seguidos (--).
Los archivos XML instalados con el servidor de aplicaciones de InterAction incluyen comentarios.
Cómo hacer que un documento XML esté bien formado
Un archivo XML se considera bien formado si cumple con un conjunto de reglas. Estas reglas incluyen lo siguiente:
- El archivo comienza con la declaración XML.
- Todos los valores de los atributos están entre comillas. Pueden ser comillas simples o dobles.
- Todas las etiquetas de apertura de elementos tienen su etiqueta de cierre correspondiente.
- Todas las etiquetas de los elementos están correctamente anidadas.
Para más información sobre archivos XML bien formados, consulta alguno de los recursos sobre XML que aparecen en Más recursos sobre XML.
Un archivo XML se considera válido si el archivo es tanto bien formado como cumple con una definición de tipo de documento (DTD). Una DTD es un conjunto de reglas que define la estructura permitida para un documento XML. Los archivos XML que necesitas editar para el servidor de aplicaciones de InterAction se consideran documentos independientes; esto significa que no existe una DTD correspondiente para estos archivos.
El servidor de aplicaciones solo puede procesar archivos XML bien formados. Usar un editor XML es una buena manera de asegurarte de que tus documentos estén bien formados.
Uso de un editor XML
Aunque puedes editar los archivos XML del servidor de aplicaciones de InterAction con un editor de texto, se recomienda encarecidamente usar un editor XML validador. Esto se debe a que el servidor de aplicaciones solo puede procesar archivos XML bien formados. Un editor XML validador puede confirmar que el archivo esté bien formado antes de guardar los cambios. El editor también debería incluir funciones para ayudarte a encontrar errores, como etiquetas que no se han cerrado correctamente.
Algunos editores XML también usan diferentes colores para las etiquetas, lo que puede ayudarte a encontrar la información que necesitas editar al modificar el documento.
Consulta la documentación de tu editor XML para obtener detalles sobre cómo usarlo y cómo validar documentos XML.
Existen varios editores XML gratuitos, de pago y comerciales disponibles.