Escribir documentación para aplicaciones GNOME
Documentos de ayuda
Visor de ayuda Yelp
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:
- sgml-base: Infraestructura SGML.
- sgml-data: Datos comunes para SGML y XML.
- docbook: Sistema estandar SGML para la representación de documentos ténicos
- docbook-utils: Convertidor de archivos docbook a otros formatos.
docbook-xsl: Estilos para el procesamiento de archivos DocBook XML.
Generación de formatos
Para pasar el documento fuente a otros formatos tenemos los siguientes comandos:
- db2dvi: genera un documento en formato dvi.
- db2html: genera un directorio con el nombre del archivo y el su interior archivos html.
- db2pdf: genera un documento en formato pdf.
- db2ps: genera un documento en formato postscript.
- db2rtf: genera un documento en formato rtf.