[Chicago-talk] requiring() pod files?

Steven Lembark lembark at wrkhors.com
Fri May 5 09:24:11 PDT 2006


 >>> Sure, look at WWW::Mechanize.  It installs WWW::Mechanize::FAQ.pod
 >> You lost me.  I want to take:
 >>
 >> INSTALL.pod
 >> USAGE.pod
 >> FAQ.pod
 >>
 >> and combine them into:

You probably don't want to do that. The problem will be
that it'll probably end up with multiple copies of the
same heading, etc. If they REALLY are useful as a single
document then just put them into a single piece of POD
and let pod2html dump them out with links to the various
sections (or people can use pod2text and search for
headings).

For example, if have a "See Also" in each of the files
you'll end up with three widely separated sections
in the text having the same title. Blech...

If they are useful separately then leave them that way
and reference all three of them in the See Also section
of your main module and each of them.


-- 
Steven Lembark                                         85-09 90th Street
Workhorse Computing                                  Woodhaven, NY 11421
lembark at wrkhors.com                                      +1 888 359 3508


More information about the Chicago-talk mailing list