Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

Heh. Well, that one sailed right over my head when I originally posted. :) Thanks.

I guess then, one could scratch that initial idea about starting each comment line with '#@' and instead just take a nod from the way existing POD does it and wrap the texi docs in =pod/=cut blocks.

(Edit: Yes, this wouldn't fix that problem either, though, at least it would look just like plain unadorned Texinfo, so the user would do the usual escaping they do when writing an '@' sign -- which could be pretty frequent if documenting a Perl program. Oh well.)

Anyhow, the whole thing is moot, regardless. It seems that some very smart and experienced people have already volunteered and are interested in putting in the work. Evidently, there's justification for extending Perl 5 POD rather than leaping to some other already-established doc format, and it's accepted that new Perl 6 users will just have to get used to it in addition to whatever other doc formats they currently use for their other documentation needs. Maybe Perl 6 Pod is meant to be general enough to service those general documentation needs as well. Not sure yet.


In reply to Re^8: Perl 6 Pod -- reinventing the wheel? by j3
in thread Perl6 Pod -- reinventing the wheel? by j3

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 having a coffee break in the Monastery: (5)
As of 2024-04-19 04:04 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found