Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Re: POD as a general documentation system

by Abigail-II (Bishop)
on Mar 31, 2003 at 09:30 UTC ( #246881=note: print w/ replies, xml ) Need Help??


in reply to Re^2: POD as a general documentation system (pod is readable)
in thread POD as a general documentation system

You are over estimating Joe Random User. =head1 isn't clear at all, let alone =head2. Maybe he would have understood =title and =section. And you really think Joe Random User is going to understand =over? Or L<text|name/sec>?

And if you are going to use a pager to read POD anyway, you'd be better off it it was written in plain ASCII.

Abigail


Comment on Re: POD as a general documentation system
Select or Download Code
Re^4: POD as a general documentation system (yes, pod _is_ readable)
by Aristotle (Chancellor) on Mar 31, 2003 at 12:47 UTC

    Well, we'll have to disagree about the clarity of the command paragraphs then. The interior sequences might be problematic, but other than complex L<>s and E<> they're easy to ignore. In plaintext, you can't represent references directly anyway; the same solutions you come up with there are likely to work for POD as simple L<>s.

    I did say "in the absence of a POD parser" when I said you can read POD using a pager.

    Makeshifts last the longest.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://246881]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (10)
As of 2014-09-18 09:52 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    How do you remember the number of days in each month?











    Results (109 votes), past polls