Escribir documentación para aplicaciones GNOME

TableOfContents()

Documentos de ayuda

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 ams 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.

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.

Estructura de un archivo XML

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/vimrx" y habilitar la línes syntax on.

Generación de formatos

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