[bcn-pm] Página de recetas

[carlos escribano]

Hola, he estado mirando algo el tema de las recetas en la web, tal y como 
hablamos en la reunión, y paso a abrir tema, reflexionando sobre diversas 
cuestiones, a fin de que se vayan proponiendo soluciones más eficientes y 
podamos acotar el tema.

El planteamiento creo sería un programa sencillo, que nos permitiera entrar 
una documentación para su publicación, del estilo de un artículo de una a 
pocas páginas, como una receta de cocina, al que se accediera mediante un 
índice de recetas.  Necesitaríamos al menos un módulo de autentificación, un 
grupo de scripts gestionandolo todo, un interfaz  web y un módulo de gestión 
de datos en bases de datos de texto.

Yo no he encontrado nada sencillo para hacer esto. Hay bastantes soluciones 
complejas,  que hacen esto y mucho más, normalmente para weblogs, pero no 
encuentro un software simple. Creo que podemos hacerlo a medida, no es 
complicado con la ayuda de CPAN. 

En el planteamiento de hacerlo nosotros, paso a comentar en primer lugar el 
problema del formato de los textos. Las alternativas que conozco viables son:

XHTML: No hace falta comentar gran cosa aqui. La ventaja es que de manera 
inmediata podriamos hacerlo servir en la web sin demasiado trabajo. La 
desventaja es que no es un medio específicamente construido para albergar 
documentacion, por lo que es menos flexible que otros DTDs. Se trataría de 
preparar las hojas de estilo correspondientes y ofrecer un interfaz de 
entrada de datos que admitiera unas pocas etiquetas, las imprescindibles para 
la edición, y mediante un parser se ignorara el resto.

POD: Puesto que se tiene la posibilidad de convertir directamente a html es 
una alternativa viable. Las ventajas, la utilizacion de herramientas 
estandard de Perl y su sencillez de uso; la desventaja, su formato menos 
sólido para crear documentación que los sistemas basados en XML/SGML.

LE-Document: Docbook es un DTD muy complejo, que es en la actualidad la 
referencia de los proyectos de documentación del software libre. Existen 
varios subconjuntos  para necesidades más simples, como Docbook Lite, o este 
LE-Document. Construido para un sitio Debian 
(http://www.laespiral.org/documentacion/recetas/bin/lista), el DTD es un 
subconjunto de Docbook, con algunas adaptaciones,  para "recetas", que 
contiene un conjunto reducido de etiquetas y una hoja de estilos.

El manual de uso es la primera receta de la web, en  
http://www.laespiral.org/documentacion/recetas/bin/numero?1. Tienen un 
interfaz web para introducir la "receta" y es guardada en un CVS y una base 
de datos. El codigo es perl, y hay algun fragmento de él visible en 
http://laespiral.org/documentacion/articulos/zaragoza02/slides.html

La ventaja es que el proyecto se acerca bastante a las necesidades que 
podemos tener. La desventaja es que utilizar  XML implica más trabajo a la 
hora de preparar la web.

Puesto que se trata de un subconjunto de Docbook, este planteamiento puede 
cambiarse fácilmente, quitando etiquetas o añadiendo otras. Otra referencia 
similar es Docbook Lite. En 
http://tecfa.unige.ch/guides/xml/frame-sgml/sdocbook/sdocbook-test-TAGS.pdf
teneis una presentacion grafica de todas las etiquetas válidas en Docbook 
Lite.

Hay algunos formatos adicionales, como Linuxdoc, el DTD de los HOWTO de 
Linux, en transición en la actualidad hacia Docbbok, o DebianDoc, el DTD 
utilizado tradicionalmente en la documentación de Debian, éste más bien 
orientado a textos amplios, y también en fase de transición hacia Docbook, 
pero creo que los tres mencionados son los más adecuados pra nosotros.

Para mí es difícil realizar una elección. Yo me sentiría ligeramente 
inclinado a Le-Document, pero confieso que sólo por la posibilidad de 
trastear código con clases XML, no tengo una razón importante para 
defenderlo. Os lo comento para ver la opinión del grupo al respecto, y 
empezar con alguna cosa