Re: [bcn-pm] Sistema de documentación

Xavier Noria fxnahashref.com
Div Oct 14 02:14:08 PDT 2005


On Oct 14, 2005, at 10:02, Carlos Escribano wrote:

>> Ahora bien, eso no tiene estructura, es plano, no hay nesting, por lo
>> que el XML tiene sentido como lingua franca pero no parece que mucho
>> mas.
>>
>
> El uso de XML no es sólo por ser un lenguaje exportable, sino  
> porque la
> documentación ya se hace en XML (ahora utilizo DocBook, y estoy  
> explorando la
> posibilidad de utilizar OpenDocument)

Pero piensa que el markup de documentacion es independiente del  
formato del programa completo en litprog. Como sabes un programa  
escrito usando ese paradigma tiene trozos de documentacion y trozos  
de codigo, y el formato del programa en si (donde va todo), es  
tipicamente propio.

Es decir, noweb documenta en LaTeX pero un documento noweb no es un  
documento LaTeX. En tu caso tendras un vocabulario XML _por encima_  
del de DocBook (que dejara de ser DocBook ahi para pasar a ser un  
chorro de bytes, interpretado solo por la utilidad de extraccion de  
documentacion) y _por encima_ de Perl (que deja de ser Perl ahi e  
igualmente es visto por el XML como un chorro de bytes, que sera  
interpretado por el extractor de codigo).

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.

Otra cosa es que quieras aprovechar algo que ya tienes implementado.

-- fxn


Més informació de la llista de correu Barcelona-pm