Gossamer Forum
Home : Products : Gossamer Links : Discussions :

pod help (documentation)

Quote Reply
pod help (documentation)
I found another utility that helps get to the module documentation.

It takes awhile to run, but it generates a bunch of HTML pages that can be browsed, rather than having to deal with Unix at all.

http://www.nihongo.org/...lities/perldoc2tree/

You can see an example of this there, and what it does.

You feed it the path to the output directory and the base url to use when making the pages:

perldoc2tree.pl --target_dir=/www/path/to/FAQ/LinkSQL/perldoc \
--html_base=/FAQ/LinkSQL/perldoc

To add the various GT libraries in, the easiest thing is to push them onto the stack before the program runs:

add the following right after the package declaration (which, BTW, you may need to change to just package PerlDoc2Tree;

BEGIN {
unshift(@INC, "/www/path/to/links/cgi-bin/FAQ/admin");
unshift(@INC, "/www/path/to/New_LinkSQL/cgi-bin/admin");
}

I put up the page that the FAQ server is running, including the GT:: library files POD as well (for the next gen).
http://postcards.com/FAQ/LinkSQL/perldoc/

As you can see, the old 1.1x Links:: did not have any documentation in them.



PUGDOGŪ
PUGDOGŪ Enterprises, Inc.
FAQ: http://postcards.com/FAQ


Quote Reply
Re: pod help (documentation) In reply to
As you can tell, our POD still needs a bit of work on the formatting. =)

A good HTML translation of perl pod can be found at:

http://www.activestate.com/...cts/ActivePerl/docs/

Quite a nice reference.

Cheers,

Alex

--
Gossamer Threads Inc.