Introducción a la documentación estructurada
Los documentos estructurados cumplen un conjunto de reglas que definen y controlan la estructura de los documentos. XML y HTML son ejemplos de documentos estructurados.
El conjunto de reglas que define la estructura de un documento se denomina su “tipo de documento”. Al crear un documento en Arbortext Editor, el editor verifica constantemente las reglas definidas en el tipo de documento asociado y sólo permitirá insertar contenido en el documento que cumpla dichas reglas. DocBook y DITA (Darwin Information Typing Architecture) son ejemplos de tipos de documentos.
Los tipos de documentos definen los siguientes componentes de los documentos:
• El conjunto de etiquetas que se pueden usar en un documento
Las etiquetas son el bloque de construcción básico de los documentos estructurados. Las etiquetas son contenedores y vienen en parejas (una de inicio y una de fin). Las etiquetas pueden contener otras etiquetas, atributos y texto. Los párrafos y las listas son ejemplos de etiquetas.
• Los “atributos” asociados con cada etiqueta
Los atributos proporcionan información adicional acerca de las etiquetas y se encuentran dentro de las etiquetas. Por ejemplo, una etiqueta podría tener un atributo que defina el tipo de usuario para el cual está destinada la información de la etiqueta.
• La estructura en la cual pueden disponerse las etiquetas
Cada tipo de documento tiene una única etiqueta con todas las demás etiquetas definidas en el tipo de documento. El tipo de documento define la jerarquía de etiquetas que se incluye en dicha etiqueta exterior. El tipo de documento define también si una etiqueta es opcional u obligatoria y si puede incluir otras etiquetas, texto o ambos.
A continuación se muestra un ejemplo de un tipo de documento para escribir una carta:
Carta Fecha Saludo Cuerpo Párrafo o Lista o Cierre de tabla
En el tipo de documento Carta se incluyen las siguientes etiquetas principales:
• Carta
La etiqueta Carta es la etiqueta exterior del tipo de documento e incluye otras siete etiquetas. Cuatro de ellas (Fecha, Saludo, Cuerpo y Cierre) son obligatorias y deben estar en los documentos Carta en dicho orden.
• Date (fecha)
La etiqueta Fecha debe ser la primera etiqueta insertada en los documentos Carta. Sólo puede incluir texto y debe contener una fecha.
• Greeting (saludo)
La etiqueta Saludo debe ser la segunda etiqueta insertada en los documentos Carta. Sólo puede contener texto.
• Body (cuerpo)
La etiqueta Cuerpo debe ser la tercera etiqueta insertada en los documentos Carta. Sólo puede incluir otras etiquetas, sin texto. La etiqueta Cuerpo puede incluir una o varias etiquetas Párrafo, Lista o Tabla. Cuerpo puede contener cualquiera de estas etiquetas en cualquier orden.
• Close (despedida)
La etiqueta Cierre debe ser la última etiqueta insertada en los documentos Carta. Sólo puede contener texto.
Hojas de estilo
El formato de los documentos estructurados no se almacena en los documentos en sí. En cambio, cada tipo de documento tiene una o varias hojas de estilo asociadas con el tipo de documento que controla el aspecto del documento a través de un conjunto de configuraciones de estilo. En las configuraciones de estilo se puede incluir información de formato básico, tal como el tamaño de fuente, el espacio entre párrafos y el diseño de página, o bien de formatos más avanzados, tal como la generación automática de una tabla de contenido y un índice.
El aspecto de los documentos en la ventana de Arbortext Editor viene controlado por una hoja de estilo.