Parsewiki permite transformar un fichero de texto, con alguna sintaxis simple al estilo Wiki, en varios formatos que incluyen HTML, XHTML, Docbook y LaTeX.
Copyright (C) 2005 Ricardo Cerrato. Este documento es un resumen de el Manual de parsewiki de Jaime E. Villate. Se otorga permiso para copiar, distribuir y/o modificar este documento bajo las condiciones de la Licencia GNU para Documentación Libre, versión 1.1 o posterior, publicada por la Free Software Foundation, sin secciones invariantes.
Para producir una versión HTML:
parsewiki archivo.txt > archivo.html
Para obtener un fichero Docbook/XML o LaTeX
parsewiki -f docbook archivo.txt > archivo.xml parsewiki -f latex archivo.txt > archivo.tex
La primera regla a tener en cuenta es que el texto debe comenzar en la primera columna. Si dejamos espacio en blanco al comienzo de la línea, será presentada en forma textual, sin procesar. Esto es adecuado por ejemplo para representar código, como el párrafo siguiente:
if ($resultado > 0){
print "El resultado es $resultado \n";
}
Para terminar un párrafo dejamos una o mas líneas en blanco.
Se indica con el texto entre símbolos =, dejando espacio entre los símbolos y el titulo; p.ej.
= Sección 1 =
Para subsecciones se usa más que un símbolo =; por ejemplo:
=== Sección de nivel 3 ===
Existen tres tipos: sin enumerar, enumeradas y descriptivas (glosarios). Un ítem muy largo podemos cortarlo colocando un \ al final y continuar en la siguiente linea. Si dejas una o mas líneas en blanco se cierra la lista.
Cada ítem debe comenzar por un asterisco.
Se puede dejar o no espacio después de cada asterisco.
La lista acaba cuando aparezca una línea con algo diferente de * en la primera columna.
Cada ítem debe comenzar por un cuadradillo.
Se puede dejar o no espacio después de cada asterisco.
La lista acaba cuando aparezca una línea con algo diferente de # en la primera columna.
Son listas con términos seguidos de descripciones, como un diccionario o un glosario.
Cada ítem debe comenzar por un punto y coma, seguido por el termino, seguido por dos puntos y el texto en la misma linea.
Cumple el resto de normas de las anteriores listas.
Para incluir una lista dentro de otra, se le debe aumentar el nivel a la lista (o las listas) que estén dentro; por ejemplo:
Lista enumerada de nivel 1 comienza por #
Después de este ítem iniciamos una lista sin enumerar de nivel 2
Lista sin enumerada de nivel 2 comienza por **
Otro ítem mas de nivel 2, comienza por **.
Aquí continuamos con nuestra lista inicial, comienza por #.
Simplemente escribiendo la URL como por ejemplo http://barrapunto.com . Si la URL termina en jpg, jpeg, png, bmp o gif se vera la figura. Para asociar la URL o figura a un texto se escribe la URL seguida por el texto entre corchetes. Ejemplo: Larga vida al Proyecto GNU.
Este caso es igual que los anteriores, pero usamos siempre doble corchete. Por ejemplo parsewiki-corto.html o Este manual. Si finalmente el fichero lo vas a convertir en PostScript o PDF, las figuras se esperará que exista un fichero con el mismo nombre pero con extensión:
.ps o .eps, cuando se obtenga ps con latex y dvips,
.jpg, .jpeg, .png o .pdf para obtener pdf con pdflatex
Itálica usando dos apóstrofos seguidos antes y después del texto: así.
Negrilla usando tres apóstrofos.
Letra de espacios fijos se usan dos comas seguidas.
El texto en letra diferente debe estar dentro de una única línea o finalizar la linea con el carácter de continuación de línea(\).
Alguna información opcional puede ser incluida al comienzo usando la sintaxis: {nombre: contenido}.
Donde nombre puede ser: título autor fecha organización dirección versión resumen copyright idioma
La meta información sobre un documento deberá estar toda al comienzo, y cada conjunto {nombre: contenido} debe ocupar una única línea.
El fichero de salida se crea a partir de unas plantillas definidas por el
propio programa. En el subdirectorio templates vienen copias de las 4
plantillas usadas intrínsecamente.
Se pueden usar como modelo para producir otras plantillas diferentes.
Luego la podremos usar por medio de la opción -t de parsewiki, p.ej:
parsewiki -f latex -t ~/plantilla.tex fichero.txt > fichero.tex
Este método puede servir como base para crear una versión inicial que después se puede volver más completa trabajando sobre el fichero LaTeX o DocBook creado con este método.