Beefy Boxes and Bandwidth Generously Provided by pair Networks
Clear questions and runnable code
get the best and fastest answer
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
I went once around the block with a number of the existing perl tools for pod to html processing, and I wrote up what I found: Pod to Html.

My goal was to find a simple way to extract the pod from a tree of multiple *.pm/*.pod files and convert it into a tree of html files. And if you're nodding your head saying "Of course, that's so simple!", you probably haven't looked into this very closely.

Summary: Pod::Html and pod2html are known to be very weak, limited tools (and ditto pods2html, which is closer to what I needed). There are many alternative methods, none of which have become standards as of yet. My suggestion is to keep an eye on Sean M. Burke: his Pod::Simple::HTMLBatch turned out to be almost exactly what I was looking for: it crunches the documentation for a tree of modules, and generates readable html, converting L<> links into relative html links.

An honorable mention also goes to Mark Overmeer who looks like he's developing some interesting ideas with his OODoc (some custom extentions to pod markup to deal with large OO projects).

By the way: it's a funny thing, but pod processing modules almost always seem to have very sketchy pod...


In reply to Pod::Simple::HtmlBatch by doom

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others studying the Monastery: (5)
As of 2024-04-19 07:59 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found