Reference
En el tema DITA Reference se describen las características generales de un asunto o producto, tales como los comandos de un lenguaje de programación o de una interfaz de programación de aplicaciones (API). Los temas DITA Reference pueden ofrecer información sobre cualquier asunto con contenido normalizado, como recetas, catálogos, bibliografías, o cualquier información descriptiva estructurada similar.
En un tema Reference se incluyen las siguientes etiquetas principales:
reference: contiene todas las demás etiquetas
title: el asunto del tema
shortdesc: una descripción breve o resumen del tema
prolog: distintos tipos de metadatos sobre el tema como, por ejemplo, el autor, copyright, los términos de índice, etcétera
refbody: contiene el contenido real del tema
Los temas Reference suelen estar organizados en una o varias secciones, tablas y listas que se pueden organizar en el orden deseado. A continuación se muestran las etiquetas principales en el cuerpo del tema Reference:
section: un contenedor para contenido que se debe agrupar en una referencia
refsyn: sintaxis o información similar
properties: lista de propiedades asociadas al asunto de la referencia, presentadas normalmente como tabla
example: ejemplos que ilustran o soportan la información de referencia
En la etiqueta refbody también se incluyen las tablas DITA estándar.
related-links: se incluyen vínculos de referencias cruzadas a información relacionada.
La mayoría de estas etiquetas son opcionales, por lo que sólo utilizará las que necesite para ser el autor del tema.
¿Fue esto útil?