[ download ] [ xml source ] [ discussion ]

---

This is the first run at the lpml (Literate Programming Markup Language). It is a simple Perl script, doesn't do much fancy yet -- but it works. My eventual plans for it are extensive, and I don't expect any of the code now in existence to survive long. (Note, six years later: in reality, it worked so perfectly for my purposes that it survived six years unchanged.)

I'd be overjoyed if someone else found this system to be useful. If you do, please tell me about it and of course feel free to update me with any changes you might have made to the code.

Table of contents:

• Script file structure
• Initial scan
  • Looking for tags
  • Handle object tag
  • Handling item tags
  • Handle piece tag within item
  • Handle format tag
• Tangle: write code output
  • Definition of 'tangle_one' subroutine
• Weave: Write documentation pages
• Prepare indices
• Process arguments and open source file
• Clean up afterwards
• Change log and further ideas

The completed code (a Perl script) is available here as a plain text file suitable for download. To install it, just replace the first line (which is the path to my Perl interpreter) with the path to your own Perl interpreter. I haven't written any user documentation except a list of the elements I use. The overall setup of a presentation isn't described anywhere yet.

You can, of course, study the XML-ish code I used to generate this code and documentation. This is pretty thin user documentation but soon I hope to augment it.

---

This code and documentation are released under the terms of the GNU license. They are copyright (c) 2000-2006, Vivtek. All rights reserved except those explicitly granted under the terms of the GNU license.