On 03/31/2015 10:46 PM, Bill Page wrote: > Of course I will update the documentation but not without first > complaining that the current situation with > > )if LiterateDoc ... )endif
[snip] > in about 10 other SPAD files seems like a mess to me. Yes, it is. Waldek translated some noweb stuff into )if false ... )endif. And I thought for my stuff, I rather like a more telling markup. It's not perfect, but it's sufficient for my literate documentation and doesn't conflict with Waldek's wish to have .spad instead of .spad.pamphlet files. There are also two files in my master-hemmecke branch: https://github.com/hemmecke/fricas/blob/master-hemmecke/src/doc/literatedoc.sty https://github.com/hemmecke/fricas/blob/master-hemmecke/src/doc/literatedoc.awk That gives sufficiently readable output for code that follows the )if LiterateDoc style. > Code embedded in a lot of text, i.e. noweb, was bad enough but now we > have a lot of text embedded in code and that seems even worse. Sorry, but I still think that writing literate programs is way better than just writing code and pointing people to documents that are perhaps inaccessible to the reader. How would you have understood how XHashTable works if I hadn't included all the background information and design decisions? And yes, separating code from documentation makes it easier to have them diverge. > Although I do appreciate having the documentation available, but my > first reaction was to start by deleting everything between )if > LiterateDoc ... )endif so I could actually read the code in a > reasonably concise form. That can be done by either an appropriate editor (would be nice if someone convinces emacs to fold such parts) or a simple one-line-sed-script. > Do we still have a way to produce pdf or dvi files from these > "literate" source documents? See above. Ralf -- You received this message because you are subscribed to the Google Groups "FriCAS - computer algebra system" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/fricas-devel. For more options, visit https://groups.google.com/d/optout.
