DesarrolloPersonal #xml 2 min

XML y DocBook: creación de documentación técnica estructurada

Traducción del original en inglés. Léela en: CatalàEnglish

docbook.jpg
DocBook

XML son las siglas de Extended Markup Language y es un subconjunto de SGML, el Standard Generalized Markup Language. XML es un lenguaje de formateo parecido al HTML. Mientras que la mayoría de los formatos relacionados con HTML desarrollados en el pasado adoptaron la actitud de "sé conservador en lo que envías y liberal en lo que recibes", XML toma el enfoque contrario: los documentos deben ser 100% compatibles. Esta compatibilidad se conoce como que un documento XML está "bien formado". Con este fin, incluso cuando el objetivo está claro, un documento se rechaza si no sigue las especificaciones de XML en toda su extensión. En términos prácticos, este enfoque garantiza la interoperabilidad a largo plazo. A diferencia de HTML, que es el nombre de grupo estándar para un montón de subprotocolos que son ligeramente diferentes y no del todo interoperables entre sí, el rigor de XML garantiza la compatibilidad. XML también mejora la seguridad de manera espectacular, porque sólo hay una manera de interpretar las expresiones, una manera en la que todo el mundo está de acuerdo.

DocBook es una Definición de Tipo de Documento XML o DTD. Es un subconjunto de XML especialmente adecuado, pero no limitado, a la creación de libros y artículos sobre hardware y software de ordenadores. DocBook es bien conocido en la comunidad Linux y lo usan muchas editoriales y proyectos de desarrollo de código abierto. La mayoría de las herramientas están desarrolladas para la DTD DocBook y están incluidas en la mayoría de las distribuciones Linux. Esto permite enviar datos en bruto que se pueden procesar en el extremo del receptor, allí donde haya aplicaciones capaces de interpretar XML directamente.

Lo importante que hay que tener en cuenta es que XML y DocBook permiten a los autores centrarse en el contenido. En este sentido, la presencia de la palabra "markup" en la definición de XML es engañosa. Con XML, los autores especifican qué tipo de datos están incluyendo, como explicaciones de texto, nombres de comandos, tablas o imágenes. Cómo se formatea, se maqueta y se muestra el contenido no debería ser su preocupación. A partir de una única fuente, el receptor puede generar PDF, PS, texto plano, HTML y muchas otras representaciones del contenido.

Otra ventaja es que los ficheros XML de DocBook están escritos en texto plano. Aunque hay muchos editores disponibles, como oXygen y XMLmind, los usuarios avanzados de DocBook pueden escribir fácilmente los textos fuente usando vim, Emacs o cualquier otro editor de texto.

Publicado en Linux Journal:

XML & DocBook: Structured Technical Documentation Authoring