Escribir documentación para aplicaciones GNOME

TableOfContents()

En todo proyecto la documentación es un elemento muy importante y que lamentablemente no siempre se le da la atención que requiere. Tanto desde el punto de vista de quien recibe la documentación como de quien la genera, es vital contar con herramientas que hagan mucho mas fácil esta labor.

Así existe el visor de ayuda Yelp para poder leer la documentación y para generar documentación existe DocBook, que permite a través de un documento fuente generar documentos en diferentes formatos.

Visor de ayuda Yelp

El navegador de ayuda de GNOME incluye documentación detallada de la mayoría de las aplicaciones, utilidades u otros componentes como el panel o el administrador de archivos Nautilus.

Yelp puede mostrar algunos archivos HTML y XML al ser pasados como parámetro en la línea de comandos. Este programa acepta todos las opciones estándares de GNOME y GTK+ que siga la sintáxis habitual de la línea de comandos GNU. Para obtener mas información sobre estas opciones utilize Yelp con el argumento --help.

DockBook

Con docbook se pueden generar documentos en diferentes formatos: html, latex, txt, pdf, postscript. Permite la creación de documentos tales como libros, articulos, manuales, etc. Se ha convertido junto a Open eBook en un estandar internacional para el procesamiento de este tipo de documentos.

Programas necesarios

Para Debian lenny/sid instale los siguientes paquetes para el uso de docbook:

Para utilizar Vim, instale los paquetes:

Si quiere activar el soporte para syntax highlighting (resaltar la sintaxis), debe editar el archivo /etc/vim/vimrc y habilitar la línea syntax on.

Donde escribir los documentos

Cualquier editor sirve para escribir nuestro documento, Vim con la opción syntax on activada para el resalte de etiquetas con colores es una buena idea. También puede usar Emacs con el módulo SGML mode, el que permite escribir con mas facilidad estos documentos.

Tipos de documentos

Docbook permite dos tipos de documentos; book (libro) y article (articulo). Los Articulos son mas sencillos de que los libros, estos no tienen ­índice de contenidos y ocupan menos hojas. Los libros permiten el uso de capí­tulos e índice de contenidos. Los libros además tienen la ventaja de que pueden contener más de un archivo, es decir, se pueden incluir otros archivos en un documento.

Artículo

Como ya indicamos, este tipo de documento es mucho mas sencillo que un libro. En el siguiente ejemplo vemos uno de estos documentos. 

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
            <article lang="es">
            <articleinfo>
              <author>
                <firstname>Comunidad</firstname>
                <surname>GNOME Hispano</surname>
              </author>
              <title>Ejemplo de un articulo</title>
            </articleinfo>
            <sect1 id="sect1">
              <title>Primera sección</title>
              <para>
              Contenido primera sección...
              </para>
            </sect1>
            </article>

Libro

Generación de formatos

Para pasar el documento fuente a otros formatos tenemos los siguientes comandos: