Docbook XML

Fernando Reyero Noya

Universidad de León, España

camarlegno@yahoo.es

Sinopsis

Docbook XML es una aplicación XML (hay también disponible una aplicación SGML), muy bien adaptada a la composición de libros y documentos técnicos sobre hardware y software, aunque va mucho más allá.

Docbook, para abreviar, es un DTD muy sencillo de entender y usar, añadiendo todas las ventajas innatas de XML.

Página oficial de Docbook (http://www.oasis-open.org/docbook)

Introducción

Hay múltiples razones para usar Docbook pero se pueden resumir en 7:

7 razones para usar Docbook

Estructuración de los datos

Docbook nos permite que nuestros documentos posean una estructura de forma que podamos mantener orden dentro del mismo y habilitar características como tablas de contenidos o índices generados automáticamente.

Similitud con HTML

Crear documentos en Docbook es parecido a escribir documentos en HTML. Si ya has trabajado con páginas web, no te costará habituarte a la sintaxis y la forma de trabajo de Docbook.

Texto plano

Un documento en Docbook es texto plano, sin embargo, su significado es mucho mayor que un conjunto de caracteres. De esta forma, no necesitamos aplicaciones complejas ni propietarias para trabajar. Un simple editor como Emacs es suficiente.

Versatilidad

Con Docbook puedes crear casi cualquier tipo de documento que necesites. Además, dadas sus características podrás comprimirlo o enviarlo a través de red con facilidad. Por otro lado, Docbook es fácil de analizar o extraer la información semántica que aporta.

Un cuerpo, mil caras

Docbook puede ser usado con otras tecnologías especializadas en la presentación de documentos como XSL o CSS. Esto nos permite centrarnos en la estructura y mantener un único documento fuente pero obtener un documento de salida adaptado a nuestras necesidades. Casi cualquier formato se puede obtener a partir de Docbook: TeX, LaTeX, PDF, RTF, texto, (X)HTML,...

¿Perdido? Todo está en la documentación

La documentación en Docbook es realmente extensa y completa. Perderse es complicado. En todo caso, puedes consultar las guías del Proyecto Lucas (http://lucas.hispalinux.es) o la página de Normal Walsh (http://www.nwalsh.com), llena de recursos útiles.

Libre y multiplataforma

Docbook es, al igual que su padre XML, libre y podrás encontrar parsers transformadores para casi cualquier plataforma.

Instalación y configuración

En Debian, la instalación y configuración de Docbook se reduce a la instalación de los paquetetes

• d

ocbook-xml

Adicionalmente, podemos instalar paquetes que complementen el DTD como xsltproc, psgml o distintos paquetes de hojas de estilo.

Herramientas

Emacs

El editor. A su potencia, se le añade la facilidad que ofrece psgml

Psgml

El complemento perfecto para Emacs. Permite trabajar con cualquier DTD, facilitando terriblemente el trabajo, mediante la resaltación de la sintaxis o el completado de sus elementos. Aunque en nuestro caso trabajamos con el major mode xml-mode, se puede trabajar en otro modos adecuados a DTDs en SGML

xsltproc

Transformados XSLT de gran facilidad y que puede ser usado desde la línea de comandos. Nos permite transformar nuestro documento XML, en este caso Docbook, en otro muchos formatos de salida más adecuados para su presentación.

Huelga decir que la alimentación de xsltproc son las hojas de estilo. En Debian, existen varios paquetes que recogen un gran número de ellas, incluidas las del propio Norman Walsh y que te permitirán obtener casi cualquier formato.

Para nuestro caso concreto, hemos usado una versión modificada de las hojas de estilo usadas por LDP.

Generación del artículo

Este artículo ha sido producido usando DocBook XML 4.1.2

DocBook es una aplicación XML (también hay una versión SGML) que facilita los sistemas de documentación, al dotar de semática a los textos desde el punto de vista de los sistemas informáticos. Además permite la versatilidad de dar como salida casi cualquier formato documental: LaTeX, TeX, TeXinfo, PDF, RTF, xhtml,...

La edición del texto ha sido realizada con Emacs 21, en el major mode xml-mode. Los paquetes Debian usados han sido psgml (http://packages.debian.org/testing/text/psgml.html) y xae (http://packages.debian.org/testing/text/xae.html). Las transfomaciones de prueba han sido realizadas con las hojas de estilo XSL mantenidas por Normal Walsh (http://sourceforge.net/projects/docbook), recogidas en el paquete docbook-xsl (http://packages.debian.org/testing/text/docbook-xsl.html) y con el procesador xsltproc (http://packages.debian.org/testing/text/xsltproc.html), recogido en el paquete con el mismo nombre.

Sobre este documento

Se otorga permiso para copiar, distribuir y/o modificar este documento bajo los términos de la Licencia de Documentación Libre GNU, versión 1.1 o cualquier versión posterior publicada por la Free Software Foundation. Puedes consultar una copia de la licencia en http://www.gnu.org/copyleft/fdl.html (http://www.gnu.org/copyleft/fdl.html)

Este documento ha sido escrito en formato XML utilizando la DTD de DocBook (http://www.docbook.org). Mediante este sistema, puede ser fácilmente transformado a múltiples formatos (HTML, TXT, PDF, PostScript, LaTeX, DVI, ...). Se recomienda su utilización como herramienta de documentación potente y libre.

Bibliografía

Norman Walsh y Leonard Muellner . DocBook: The Definitive Guide (http://docbook.org/tdg/en/html/docbook.html). 12-06-2002. V2.0.6