Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

variables in POD

by nop (Hermit)
on Dec 28, 2000 at 21:50 UTC ( #48645=perlquestion: print w/replies, xml ) Need Help??
nop has asked for the wisdom of the Perl Monks concerning the following question:

I'm using POD on Activestate Perl for NT. In the POD docs, Larry writes
In particular, you can leave things like this verbatim in your text: Perl FILEHANDLE $variable function() manpage(3r)
From this sentence, it sounds like POD should put things that look like functions and variables in fixed font automatically. I'm not getting this behavior. Here's a chunk of my POD :
=item blah blah The program C<< getdata.pl >> pulls data from the database on blah blah blah. The program creates a data structure $IDVC and stores it in C<< dsave-IDVC.txt >> using L<Storable|"PORTABILITY">.
My issue is that  $IVDC isn't put into fixed font.

What am I doing wrong here? Do I need to wrap every variable in C < > tags? Thanks.

Replies are listed 'Best First'.
Re: variables in POD
by Dominus (Parson) on Dec 28, 2000 at 23:18 UTC
    Says nop:
    Larry writes ...
    That's not Larry; it's Tom. And you're right about what it means. But it was never true; some POD translators do that, and some don't. Tom is engaging in wishful thinking here, as he often does.

    You didn't say which translator you were using; I guess it was the very stinky pod2html. There might be a better version in Russ Allbery's podlators package. If not, he's the person to ask about it.

Re: variables in POD
by ichimunki (Priest) on Dec 28, 2000 at 22:03 UTC
    By verbatim, I think he means that it won't be interpolated or compiled and is therefore safe to leave as is. If you want to send a directive to the POD interpreter to make it look like code, you will want to mark it up with C<< >>.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: perlquestion [id://48645]
Approved by root
help
Chatterbox?
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (9)
As of 2018-06-22 00:54 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    Should cpanminus be part of the standard Perl release?



    Results (120 votes). Check out past polls.

    Notices?