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

Re: POD in 5 minutes

by mirod (Canon)
on Apr 23, 2003 at 10:30 UTC ( #252506=note: print w/ replies, xml ) Need Help??


in reply to POD in 5 minutes

Very nice intro to POD, juerd++.

One comment: there is one section I woudl like to see expanded: links. I know it always takes me a while to figure out how to link to somewhere else in the file, outside of the file, what I am allowed to link to etc... and half of the time I get it wrong.


Comment on Re: POD in 5 minutes
Re: Re: POD in 5 minutes
by Juerd (Abbot) on Apr 23, 2003 at 10:37 UTC

    One comment: there is one section I woudl like to see expanded: links. I know it always takes me a while to figure out how to link to somewhere else in the file, outside of the file, what I am allowed to link to etc... and half of the time I get it wrong.

    pod2html would break every promise I make, so here's my practical guide to linking in pod:

    • Linking to URLs: Just put the URL in there and make sure it's followed by whitespace to avoid having too much interpunction in the link itself.
    • Linking to e-mail addresses: Why? Want spam or something? Just put the address in there and it'll probably get linked - and harvested.
    • Linking within the same document: pod2html will try to do this automatically.
    • Linking to other documents: L<perlfoo>

    I use explicit links only in SEE ALSO.

    But I think only TorgoX really knows what is and what is not allowed.

    Juerd
    - http://juerd.nl/
    - spamcollector_perlmonks@juerd.nl (do not use).
    

      From perlpod
      L<name> A link (cross reference) to name L<name> manual page L<name/ident> item in manual page L<name/"sec"> section in other manual page L<"sec"> section in this manual page (the quotes are optional) L</"sec"> ditto same as above but only 'text' is used for output. (Text can not contain the characters '/' and '|', and should contain matched '<' or '>') L<text|name> L<text|name/ident> L<text|name/"sec"> L<text|"sec"> L<text|/"sec">
      perlpodspec will be up updated to make support for L<link text|url> official, so to be on the safe side (with ye old modules), just use L<url> or don't use L at all cause pod2html will autolink it.

      Now, what pod2html will do is try to autolink C<=item functioname> if you use C<$foo-E<gt>method>.

      Pod::Html will also try to autolink to any core perl functions and the like. This has nothing to do with pod, it's just extra fluff (i like it).

      What everybody wants to do is use podchecker. You wanna lookout for "multiple link targets" warnings, like if you have =headN FOO twice.


      MJD says you can't just make shit up and expect the computer to know what you mean, retardo!
      I run a Win32 PPM repository for perl 5.6x+5.8x. I take requests.
      ** The Third rule of perl club is a statement of fact: pod is sexy.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others perusing the Monastery: (14)
As of 2014-07-30 16:53 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite superfluous repetitious redundant duplicative phrase is:









    Results (237 votes), past polls