Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

Consider POD first (for Perl), then maybe XML/XSLT. Either one will export easily to other formats.

I have a modest Perl/Tk program of some umpteen modules. In all it runs to 3629 lines of code, 1052 comment lines and a longish POD tagging along at the end. It is available on-line here...

The in-line comments are for me to know which subs do what. Any snippet of Perl, however small, gets a comment if come next year I might have forgotten what it is for. The POD I usually aim at the user...or as a general overview. For the user I'll also convert the POD into HTML for display online.

Inside the link cited above cited above is a button labled "POD as HTML" which is what it says it is. But the save you the trouble of pressing it, I give same below...

Such as it is, that is the method which works for me in writing Perl. For absolutely everything else I default to XML/XSLT. The link cited above was exported to HTML from XML/XSLT. If you like, I have something on XML/XSLT here...

In reply to Re: Preferred method of documentation? by Anonymous Monk
in thread Preferred method of documentation? by Anonymous Monk

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 or How to display code and escape characters are good places to start.
Log In?

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

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (2)
As of 2021-10-25 18:06 GMT
Find Nodes?
    Voting Booth?
    My first memorable Perl project was:

    Results (89 votes). Check out past polls.