Aprende a crear tus documentos con LyX y tu documentación en formato DocBook. En este howto te enseño a instalar, configurar y aprender lo necesario para que puedas escribir documentación en sgml.
Howto de LyX + DocBook
¿Qué es LyX? LyX es un procesador de textos WYSIWYM, es un procesador de alto nivel basado en Látex.
Diferencias entre WYSIWYG y WYSIWFM
- Los procesadores de texto WYSIWYG (What You See Is What You Get) son los procesadores que habrás estado usando durante toda tu vida. Son aquellos en los cuales lo que ves por pantalla es lo mismo que se imprimirá, o sea que te tienes que encargar no solo del contenido del texto sino también de la forma que le das a tu documento.
- Para ahorrarnos trabajo existen los procesadores de texto WYSIWYM (What You See Is What You Mean), que como supongo que ya habrás imaginado son aquellos en los cuales lo que ves por pantalla no es lo mismo que se imprimirá. Es decir, tu escribes tu documento fijándote lo mínimo en la forma (así tienes más tiempo para cuidar el fondo 😉 . Cuando escribes un documento en LyX no tienes que ir preocupando de si el segundo párrafo esta alineado con el primero, de si has añadido un nuevo pie de pagina tener que cambiar la numeración de estos, etc … De todo esto y mucho más se encarga LyX!
- Al decir que LyX es WYSIWYM no significa que no puedas ir cambiando el tamaño de las letras, ponerle colores a tus documentos, … Claro que puedes, para ir viendo como queda tu documento solo tienes que darle a Ver\rightarrow DVI y verás como queda el documento impreso (seria el equivalente a presentación preliminar del Word).
- LyX, al estar basado en Látex, permite insertar un gran número de fórmulas matemáticas, tablas, etc … Por algo se usa para realizar textos científicos que necesitan gran rigor (sino prueba a insertar matrices, integrales o llaves con el Word).
- Y quizá la ventaja más importante de LyX es que permite exportar un documento a multitud de formatos: ASCII, DVI, Látex, PDF, Postscript, DocBook, …
¿Qué es DocBook? DocBook es un tipo de documento escrito en SGML o XML. SGML es un lenguaje de marcas que sirve para escribir otros lenguajes. Desde un documento en sgml podemos exportarlo a multitud de formatos, igual que un documento en LyX pero la gran ventaja de DocBook es que podemos exportar a HTML. Es decir podemos escribir documentos que podrán ser expuestos en la WWW de manera sencilla. Por esta razón se usa DocBook para realizar documentación de cualquier tipo.
Como instalar y configurar LyX + DocBook en Linux Esta es quizá la parte más importante de este documento, aquí aprenderás a tener correctamente configurado LyX 🙂
¿Qué paquetes tengo que bajarme? La lista de paquetes que necesitas para usar LyX son los siguientes, yo uso debian sid y me he bajado todos los paquetes vía apt, si usas otra distribución podrás encontrarlos en rpmfind.net o freshmeat.net:
- Los paquetes tetex (yo los tuve que instalar todos para que no me diera problemas el LyX al exportar documentos a pdf): tetex-base, tetex-bin, tetex-doc, tetex-eurosym y tetex-extra. Si lo instalas vía apt te instalará las dependencias que necesite automáticamente y si no tendrás que ir bajándotelas e instalándolas antes de instalar dichos paquetes. Estas dependencias son: zlib1g, texinfo, libkpathsea3, ed y alguna que otra más.
apt-get install tetex-base tetex-bin tetex-doc tetex-eurosym tetex-extra
- El paquete de LyX: lyx.
apt-get install lyx
- Los paquetes de DocBook y sus dependencias: docbook, sgml-base, sgml-data, libsp1, jade, docbook-dsssl, libsgmls-perl, sp, sgmlspl, jadetex, docbook-utils, docbook-xml, sgmltools-lite.
apt-get install docbook sgml-base sgml-data libsp1 jade docbook-dsssl
libsgmls-perl sp sgmlspl jadetex docbook-utils docbook-xml sgmltools-lite
- Otros paquetes que te serán de utilidad: El xdvi para ver el documento en DVI, el gv para verlo en PostScript, el acroread para verlo en pdf. Y los paquetes de corrección ortográfica, yo recomiendo el ispell, hay que instalar el paquete base y los de los idiomas que quieras (iidioma).
apt-get install xdvi gv acroread
apt-get install ispell ispanish icatalan
Configuración de los paquetes Lo único que tendrás que hacer para configurarlos es lo siguiente:
Configurar los parámetros de los paquetes tetex correctamente:
/usr/bin/texconfig
La primera vez que arranques LyX te pedirá lo siguiente:
No tiene un directorio LyX personal. Se necesita para mantener su propia configuración.
¿Desea que intente configurarlo por usted (recomendado)?
Le damos al Sí.
Mi primer DocBook Para escribir un documento que sea exportable a DocBook tenemos que realizar lo siguiente:
Archivo -> Nuevo documento basado en plantilla -> y seleccionamos docbook_template.lyx.
Nos aparecerá una plantilla con título, autor, fecha y la primera sección. Antes de empezar a escribir sería recomendable saber como realizar un documento en LyX a secas, o sea que leer el tutorial que viene con el LyX es necesario:
Ayuda -> Tutorial.
Lo primero que podemos hacer es fijar el idioma del documento:
Formato -> Documento -> Idioma -> idioma: spanish (o el que quierás).
También fijamos el corrector ortográfico a español:
Editar -> Preferencias -> Idioma -> Corrector ortográfico -> Describir comando: ispell
Editar -> Preferencias -> Idioma -> Idioma -> Idioma por defecto: spanish
Ya podemos empezar a redactar nuestro documento. Cosas que pueden ser útiles (sobretodo si no has leído el tutorial):
- Para insertar más de un espacio o salto de linea ctrl-space y ctrl-enter respectivamente.
- Seleccionando algo del documento no lo copias, tienes que seleccionarlo y copiarlo (botón derecho-copiar o ctrl-c).
- Con la flecha que está debajo de editar seleccionamos el tipo de la linea/s en la que nos encontramos. Sería recomendable que antes de empezar a redactar un documento probases todas las opciones que hay.
- Si queremos introducir fórmulas matemáticas le damos al botón correspondiente situado debajo de Ayuda. También podemos introducir más cosas(fórmulas, llaves, flechas,…) con:
Editar -> Panel de fórmulas
- Hay muchas más opciones que te dejo que explores tu mismo 🙂
Y para finalizar corregimos la ortografía del documento con F7 y luego exportamos nuestro documento en LyX a html, eso era el objetivo de escribir un DocBook:
Archivo -> Exportar -> DocBook
Si te funciona exportar a html perfecto pero como no funciona una vez tengas el DocBook hay que realizar lo siguiente:
jade -d /usr/share/sgml/stylesheet/dsssl/sgmltools/html.dsl -t sgml -ihtml -V nochunks
documento.sgml > documento.html
Haz un script para no tener que ir poniendo el comando cada vez :
#!/bin/bash
#
jade -d /usr/share/sgml/stylesheet/dsssl/sgmltools/html.dsl -t sgml -ihtml -V nochunks $1 > $2
#
##Y ejecutas el script asi: nombre_script documento.sgml documento.html
Este documento no puede ser reproducido ni parcial ni totalmente sin consentimiento de su autor. Si tienes material adicional que aportar escríbeme al e-mail o habla conmigo por el irc-hispano.
Irc nick: ppalou
E-mail: [email protected]
Este post ha sido traido de forma automatica desde https://web.archive.org/web/20140625063149/http:/bulma.net/body.phtml?nIdNoticia=1252 por un robot nigromante, si crees que puede mejorarse, por favor, contactanos.