>>>>> "Carlos" == Carlos A P Gomes <[EMAIL PROTECTED]> writes:
Carlos> I've been looking for a way to improve the quality of my code, Carlos> making it more readable and understandable and easier to mantain Carlos> embeding in it some documentation. I think the answer is Carlos> literate programming and I'd like to know if anybody uses it in Carlos> gnu environment to produce source and documentation following Carlos> the gnu standards. It seems that there is no web software (cweb, Carlos> noweb) that produces texinfo or docbook output. Is there a way Carlos> to accomplish this task? A little while back, I was looking through some XML-based literate programming systems. None of them looked like they quite matched my specs, but then, I can get really picky, and DocBook wasn't a priority for me. One of the projects that looked pretty promising, and I plan on taking a look at it when DocBook becomes more important, is xmltangle <http://literatexml.sourceforge.net/>. It is designed (or at least intended) to be able to work with any XML-based document language, so it should fit in with DocBook quite well. Another system was DBLP (DocBook-based Literate Programming) <http://www.west-point.org/users/usma1978/36200/LitProg/SGMLWEB/>, which as you can probably tell by the name, is built on top of DocBook. I don't remember well, but I think I had some troubles with the XML version of DocBook and this package (or maybe I was just having troubles with the XML version of DocBook). Beware of treating LP as a magic bullet, though. It will not automatically make your documentation better, and it takes quite a bit of getting used to. It is quite a different way of thinking about programming, and it can be pretty frustrating for a while. I'm used to "hacking", which LP doesn't really allow you to do (at least if you do it properly). So some projects (smaller ones, where I want to get things out quickly), I just hack away at, while others (larger ones, where proper design is more important), I use LP. LP can also make tedious programming tasks more tedious too, if you aren't careful. (I found when I was trying out DBLP, that DocBook also made things more tedious. I guess you need to use a really good XML/SGML editor.) -- Hubert Chan <[EMAIL PROTECTED]> - http://www.uhoreg.ca/ PGP/GnuPG key: 1024D/124B61FA Fingerprint: 96C5 012F 5F74 A5F7 1FF7 5291 AF29 C719 124B 61FA Key available at wwwkeys.pgp.net. Encrypted e-mail preferred.
msg08121/pgp00000.pgp
Description: PGP signature
