1. Plain Old Documentation Generator
- Posted by J E M <budmeister1 at JUNO.COM>
Aug 22, 1999
-
Last edited Aug 23, 1999
Hi everyone,
I have just finished my first version of a POD Generator for Euphoria.
Here's a
little snippet from the README:
------------
Plain Old Documentation (POD) is an idea I borrowed from Perl. It allows
you to intermix documentation and source code by using special commands
like '=head1', '=p', '=list', etc. Then you use POD translators
(pod2latex,
pod2html, pod2text) to extract the docs and put them into their own
files.
Using POD within Perl code, you can distribute the source code and
documentation
all within one file.
POD isn't natively supported (ie: ignored) by the Euphoria interpreter,
but
by using it inside of comments, it almost works the same :)
One advantage of using POD is you can create many different output
formats
from a common source, similar to SGML. This version of POD comes with 2
output formats, plain text and HTML. More output formats can be added to
POD by using Format Generator Modules (FGMs), explained in detail in
modules.txt.
------------
Hopefully this gives a general idea of what it does. I've sent the
zipfile
to Rob, and it should be added to the User Contributions page soon.
Any comments?
----->Buddy
budmeister1 at juno.com
