[bcn-pm] Sistema de documentación
Carlos Escribano
cesatablinum.org
Div Oct 14 02:49:27 PDT 2005
El Viernes 14 Octubre 2005 11:14, Xavier Noria escribió:
> De manera que si escoges XML como formato del sistema de litprog
> entonces se dara la coincidencia de que el formato de documentacion
> tambien es XML, pero no le veo mucha ventaja a eso de por si, ese XML
> estara como CDATA, tan ajeno al XML de alrededor como lo estaria otro
> formato no XML como Markdown.
Bueno, es la ventaja de utilizar XML. El código va en un espacio de nombres
propio (lp en este ejemplo), y la documentación en el espacio de nombres
principal (docbook en este caso). El documento sigue siendo un documento
válido XML, y las herramientas de DOM y XPAth siguen estando asequibles para
ambos espacios de nombres. Algo así:
<para>Esto imprime el texto Hola Mundo:</para>
<lp:fragment id="Impresión de hola mundo">print "Hola Mundo";</lp:fragment>
Hacer que el elemento lp:fragment se integre en el espacio de nombres
principal (weave) es irrelevante para una hoja de estilo XSLT o para una
pequeña aplicación DOM-XPath de cuatro líneas. Añadirle enlaces a los lugares
donde aparece este código, contar el número de ocurrencias, etc. también es
muy sencillo.
Y extraer el código (tangle) no es otra cosa que pasar una hoja XSLT o una
sentencia XPath que sólo vea el espacio de nombres lp (y ensartarlo en su
orden, claro).
Bueno, todo esto ya lo lo implementé hace dos años, y si ahora lo reimplemento
es sólo para hacerlo más completo y para ofrecer más portabilidad, que no
dependa de una librería en concreto.
Mis dudas no están en la implementación, sino en cómo enlazo la documentación
externa (POD); pero veo por el otro mesaje que has enviado que esto no lo
llegaste a plantear en Halk.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: signature
Url : http://mail.pm.org/pipermail/barcelona-pm/attachments/20051014/777e6bc8/attachment.bin
Més informació de la llista de correu Barcelona-pm