I-dox-XML: (0.06) (potato)
	Guia rápida para generar documentación XML para "La Espiral"
	(Resumen del "Publicando en la Web con XML" de Jaime Villate)



0.01         Primera versión
0.02 2.11.00 +sintaxis coloreada emacs (gracias Miquel)
0.03 4.11.00 +conversión a ASCII (gracias Jaime)
0.04 5.11.00 +uso de etiquetas, +corrección ortográfica
0.05 5.11.00 +conversión a DVI y PS, +script de Jaime
0.06 25.11.00 +recetas


Copyright Manel Marin @ 2000 Cubierto por la licencia GNU GPL disponible en
http://www.gnu.org/copyleft/gpl.html  Se puede copiar, distribuir y modificar
libremente bajo los términos de la GPL e incluyendo siempre este párrafo



***POR HACER:***
Un poco de teoría
Solucionar bug de "->" a "-?"



ANTES DE EMPEZAR:

1) Instalar los paquetes:


    De Potato

	emacs20		Editor de texto extensible
	psgml		Modo emacs de edición SGML (funciona con cualquier DTD)
	sp		Herramientas SGML/XML
	libxmltok1	Kit de herramientas de parser de XML


    De la espiral (bajarlos de http://www.laespiral.org/software)

	le-docxml	Formato DTD para laespiral (= DocBook simplificado)


    De woody o laespiral (bajarlos de http://www.laespiral.org/software)

	sablotron	Procesador de paginas XSL para convertir XMLðen HTML
	    libsablot0


    Bajar del CVS de La Espiral la definición más nueva (DTD) de las recetas

	http://www.laespiral.org/cvs/software/recetas/LE-receta.dtd

    - Copialo al directorio donde vas a escribir las recetas (es lo más fácil)


USO DE EMACS:

    Entrar en emacs:	emacs

  --- ATENCION: En emacs C-c significa CTRL+c, y M-c significa ALT+c ---
  

    Activar sintáxis coloreada de tags (para esta sesión):
	Menú Help -> Options -> [X] Global Font Lock (highlights syntax)  

    Activar sintáxis coloreada de tags (para siempre):
	Menú Help -> Customize -> Browse Customization Groups

	    --- *Customize Browser* ---
	    [+] Faces -> [+] Font Lock -> [Option] Global Font Lock Mode

		--- *Customize option: Global Font Lock Mode* ---
		[Toggle]				#Ahora queda "on"
		[Save for Future Sessions]
		File for customizacions: ~/.emacs
		    Pulsar ENTER

    Entrar en modo XML:
	Abrir un archivo con extensión .xml p.e.: vacio.xml conteniedo las
	lineas de cabecera siguientes (se puede escribir a mano...)

Para artículo:
---8<---
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE article PUBLIC "-//laespiral.org//DTD LE-document 1.0//EN"
    "LE-document.dtd">
--->8---

Para receta:
---8<---
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE receta PUBLIC "-//laespiral.org//DTD LE-receta 1.0//ES"
    "LE-receta.dtd">
--->8---

    (Modo XML a mano:	CTRL-x xml-mode + Menú DTD -> Parse DTD	ó CTRL+c CTRL+p)

    Insertar elemento:	Menú Markup -> Insert element	ó SHIFT +Click Derecho

    Próximo campo:	Menú Move -> Next Data Field	ó CTRL+c CTRL+d

    Verificar sintaxis:	Menú SGML -> Validate + ENTER	ó CTRL+c CTRL+v ENTER
	SGML validation finished at Wed Nov  1 13:05:31		= BIEN
	SGML validation exited abnormally with code 1 at ...	= MAL

    Corrección ortográfica: Menú Edit -> Spell -> Check Buffer
	Funciona como ispell, pero es _MUCHO_ más cómodo
	La lista de palabras propuestas sale justo debajo del menú
	Deberás insertar (i) las etiquetas en tu diccionario personal



USO DE ETIQUETAS:

    Para "Tablas" ASCII (usando espacios y tabuladores) usar "programlisting"

    Para hacer listas de pasos 1) 2) 3) usar la etiqueta "variablelist",
    (esto aplica indentación en HTML a la descripción, pero no en PDF)
	Pon en la etiqueta "term" el "1) primer paso"
	Añade la descripción dentro del "listitem" en un "para" u otra etiqueta




CONVERSION DE FORMATOS:

    XML a HTML (empleando hoja de estilo XSL)

	le2html fichero.xml > fichero.html	#aplica LE-document.xsl
	le2html -s laespiral.xsl fichero.xml > fichero.html


    XML a LATEX (empleando hoja de estilo XSL)

	le2latex fichero.xml > fichero.tex	#aplica LE-document-latex.xsl
	le2latex -s laespiral-latex.xsl fichero.xml > fichero.tex


    LATEX a DVI

	latex archivo			# no hace falta el .tex


    LATEX a PS

	latex archivo			# no hace falta el .tex
	dvips -o archivo.ps archivo	# no hace falta el .tex


    LATEX a  PDF

	pdflatex fichero.tex		# genera fichero.pdf y otros archivos


    HTML a TXT

	lynx -dump fichero.html > fichero.txt

	NOTA: existen html2text (woody), pstotext, pstoascii, pero
	Jaime Villate comenta que no dan buen resultado con documentos creados
	con le2html


UN POCO DE TEORIA:

	(POR HACER, descripción corta y concisa de cada uno)
    SGML
    DTD
    XML
    XSL
    HTML
    LATEX
    DVI
    PS
    PDF


ARCHIVOS:

    /usr/lib/sgml/dtd/*				Formatos DTD
    /usr/lib/sgml/stylesheet/xsl/laespiral/*	Hojas de estilo XSL
    ~/.ispell_default			Diccionario personal de ispell/emacs


DEFICIENCIAS:

    No hay un editor XML "visual", que se vea como queda mientras se escribe
    como en Lyx o en Abiword, hay que usar emacs


BUGS:

    "->" Se convierte en "-?" en los PS y PDF, en el HTML va bien



A PROBAR MAS:

MAS AYUDA:

    http://www.laespiral.org

    Publicando en la Web con XML en Linux, por Jaime Villate, en:
    http://www.laespiral.org/articulos/articulos-COMO/articulos-COMO.html


ANEXO-1 script process-article de Jaime Villate
---8<---
#!/bin/sh
# Crea artic.html, artic.tex, artic.ps y artic.pdf a partir de un
# fichero fuente artic.xml escrito usando el sistema LE-document
#
# necesita las páginas de estilo laespiral.xsl y
# laespiral-latex.xsl (en el directorio de trabajo), los filtros
# iso2html y latex-entities, sablotron 0.43, latex, pdflatex y dvips
#
# Uso: process-article artic.xml
# $Id: process-article,v 1.3 2000/10/05 15:27:01 villate Exp $


i=$(echo $1| sed s/\\.xml$//)

echo ">>>>> Creando la versión html..."
le2html -s laespiral.xsl $1 >$i.html

echo ">>>>> Creando la versión latex..."
le2latex -s laespiral-latex.xsl $1 >$i.tex

echo ">>>>> Creando la versión postscript..."
latex $i && latex $i && dvips -o $i.ps $i

echo ">>>>> Creando la versión pdf..."
pdflatex $i && pdflatex $i


# Limpieza
rm -f $i.log $i.aux $i.dvi $i.out
--->8---