Diferencias entre las revisiones 4 y 5
⇤ ← Versión 4 con fecha 2007-12-10 14:28:02 →
Tamaño: 1607
Editor: AlejandroValdes
Comentario:
← Versión 5 con fecha 2007-12-10 14:34:42 → ⇥
Tamaño: 1891
Editor: AlejandroValdes
Comentario:
Los textos eliminados se marcan así. Los textos añadidos se marcan así.
Línea 18: Línea 18:
Para Debian lenny/sid instale los siguientes paquetes: Para Debian lenny/sid instale los siguientes paquetes para el uso de docbook:
Línea 24: Línea 24:
 * docbook-xsl: Estilos para el procesamiento de archivos DocBook XML.  * docbook-xsl: Estilos para el procesamiento de archivos docbook XML.

Para utilizar Vim, instale los paquetes:

 * vim-common: Datos comunes.
 * vim: Editor VI mejorado.

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

Escribir documentación para aplicaciones GNOME

TableOfContents()

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 para el uso de docbook:

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

Para utilizar Vim, instale los paquetes:

  • vim-common: Datos comunes.
  • vim: Editor VI mejorado.

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:

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

Documentacion/Desarrollo/EscribirDocumentacionParaAplicacionesGNOME (última edición 2009-09-08 22:27:53 efectuada por DomingoGonzalez)