Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
Let me preface this by saying I realize it isn't really the best place to be saying this. I'm posting here more as an exercise of letting off steam than any expectation of real change.

Recently I was playing around with doing some automatic generation of various pieces of information from the copious documentation that comes with perl. For example, one of things I was playing with was attempting to make perldoc -X $var work in the same way that perldoc -f func works. It sounded simple and fairly easy to do. So I opened up perlvar.pod. Good lord, do they ever use the same convention twice? Head 1 tags there, head 2 tags here, random lists, etc. It was really not very nice to parse.

I realize at the time they came up with pod, they wanted a simple language anyone could use that would produce nicely formatted documentation. In that respect, it reminds me a lot of say, HTML2. Quick and simple, combining content and presentation. Well HTML has moved on, can POD move on also?

I hate to jump on the XML bandwagon and pointlessly use it, but it does seem like the best way for documentation to be self documenting, as it were. I suppose we could also solve this by just mandating a specific POD layout, or perhaps a version of POD with a higher emphasis on the metadata instead of the presentation.

Regardless of how we do it, can we please god get it done?!

20050913 Unconsidered by Corion. Was at "keep: 19 edit: 19 delete: 0" by monsieur_champs: "Please adjust title to something more aligned with your text, Its an interesting and needed proposal."


In reply to Please for the love of god, can I get a documentation format that doesn't suck? by BUU

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



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

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

    How do I use this? | Other CB clients
    Other Users?
    Others scrutinizing the Monastery: (8)
    As of 2015-07-04 14:41 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









      Results (60 votes), past polls