Capítulo 1. Introducción

DocBook es un dialecto de SGML que permite la escritura de documentación técnica y que día a día gana más adeptos dentro de la comunidad del software libre y de fuente abierta. Prueba de ello es que la documentación de Gnome, KDE, FreeBSD y LinuxDoc esté realizada con dicho formato. De igual forma existen empresas que usan dicho para formato para generar su documentación, cómo son los caso de Cogent y Mitel NSSG.

Este tutorial se hizo con el objetivo de brindar un enfoque integrado para la realización de documentos en DocBook, usando como editor a emacs[1] y utilizando algunas herramientas libres, así como para brindar soporte en aspectos menos documentados de DocBook como la generación de índices y la automatización de ciertas labores usando Makefiles; todo ello en el hermoso idioma castellano.

Se trata entonces de presentar algunos ejemplos de situaciones típicas del uso de DocBook, pero no se trata de cubrir todos los temas que están involucrados alrededor de cada tema. Por lo tanto es útil que usted tenga una guía de referencia rápida, en caso de que necesite profundizar en algún tema en particular

A continuación listamos algunos sitios en internet con muy buena información acerca DocBook

• El DocBook HOWTO de Jorge Godoy, que posteriormente sirvió de insumo para LDP Author Guide.

• Get Going with Docbook: Notes for Hackers de Mark Galassi, quizás es el primer tutorial de DocBook, fue posteriormente completado en Writing Documentation Using DocBook: A Crash Course.

• Self DocBook de Tim Waugh, un tutorial que es autoreferente, lleno de trucos interesantes y no tan documentados de DocBook

• NewbieDoc Docbook Guide, de Jesse Goerz el cuál es una introducción muy completa para usuarios novatos y Mark Johnson Bookmarks, que es una página llena de enlaces muy buenos referentes a DocBook.

• El Tutorial de DocBook de Ismael Olea, que muestra la forma en que funciona un ambiente DocBook, así como los objetivos que persigue dicho formato y los Recursos básicos para empezar con docbook, que son una colección de enlaces acerca de DocBook. Una de las características más importantes de dicha documentación es que esta disponible en el hermoso idioma castellano.

Sin embargo la guía definitiva para DocBook sigue siendo el libro DocBook: The Definitive Guide. En la fecha de revisión de este documento la última versión era la 2.0.4 y era documentación libre publicada bajo la GFDL. De la versión anterior (1.0.3) usted puede obtener una copia de dicho libro para uso personal.

Agradezco las valiosas sugerencias de Vladimir Támara <vladimir@tamarapatino.com> y Alejandro Forero <azul@bachue.com> quienes señalaron diversos errores e imprecisiones en este documento. Para cualquier sugerencia o duda que contribuya a hacer de este un mejor tutorial no dude en enviarme un email a <jadavila@uniandes.edu.co> Las fuentes completas de este libro así de sus ejemplos se encuentran en este archivo, siéntase libre de usar éstas como mejor le convenga.

Sólo me resta desearle que se divierta tanto aprendiendo, como yo disfruté escribiendo este documento.