Stack Overflow
Stack Overflow

Questions tagged [perl-pod]

Plain Old Documentation format. Pod is a simple-to-use markup language used for writing documentation for Perl, Perl programs, and Perl modules.

perlpod

63 questions
5
votes
2 answers

How to document parameters in Perl POD

I have this POD: =head1 My code =head2 check Checks something. Parameters: =over 8 =item what to check. =back =cut podchecker doesn't complain. perldoc shows this: My code check Checks something. Parameters: what to…
Robert
  • 7,394
  • 40
  • 45
  • 64
5
votes
2 answers

POD multilanguage documentation

Is there any way to write multilanguage documentation using POD? If no, what should I write it in (I already have POD documentation in English, so I will want to convert it and then translate)?
ZyX
  • 52,536
  • 7
  • 114
  • 135
5
votes
2 answers

How to specify a width in pod2usage?

I have a small perl module, and am using Getopt::Long, and I figured I might as well use Pod::Usage to get a nice looking help display. After some fiddling, I got it to work reasonably well, with one minor exception. I can't set the width of the…
Quixadhal
  • 99
  • 3
4
votes
2 answers

What is the correct syntax for producing http links with custom text with pod2html?

The perlpod documentation tells me that I can link to URLs using L or L, it even lists L as an example. The first case works fine for me: pod2html…
hillu
  • 9,423
  • 4
  • 26
  • 30
4
votes
3 answers

In Perl POD, what is the proper way to link to an internal function?

The perlpod documentation says you can L but it does not indicate the proper way to reference a Perl-core function (or if it does, it wasn't obvious to me). Specifically, I want to link to what is shown by perldoc -f wantarray. …
KJ7LNW
  • 1,437
  • 5
  • 11
4
votes
2 answers

Is there a way to re-use text in perlpod documentation?

I have a bunch of repeated text in my perlpod documentation. I could of course create a separate section and reference it, but I was wondering if there's a way to enter the text once somewhere and have it inserted in multiple places? I don't think…
hepcat72
  • 890
  • 4
  • 22
4
votes
1 answer

How do I add formatting in a link in Perl Pod?

I wonder: I have some POD with =items like this: =item BI When I try to create a link in the text, none of those works: LI>, L Using pod2html I see that there are name=…
U. Windl
  • 3,480
  • 26
  • 54
4
votes
1 answer

Is there a Perl module that can split one master Pod file into several views?

I want to write one Pod file for perlop and perlopref. My gut instinct is to say something like =head1 PRECEDENCE blah =head1 OPERATORS =head2 "X" =for short The double quote circumflex operator surrounds an interpolating string. See…
Chas. Owens
  • 64,182
  • 22
  • 135
  • 226
4
votes
1 answer

Preprocess POD with Pod::Weaver before using Pod::Simple::HTML

I'm trying to make a simple subclass of Pod::Simple::HTML for use with Pod::Simple::HTMLBatch. I want all of the POD to be preprocessed with POD::Weaver. However, I am unable to find what API/commands I should use to process a string document with…
Nate Glenn
  • 6,455
  • 8
  • 52
  • 95
4
votes
2 answers

Can I embed a custom title in a perlpod document?

When writing perlpod documentation that will be exported to HTML, can I embed the title of the resulting HTML file in the POD directives? I want to be able to convert multiple POD text files to HTML with the pod2html command, and don't want to have…
Steve HHH
  • 12,947
  • 6
  • 68
  • 71
3
votes
2 answers

pod2html: Linking to Other Files

I have a bunch of PODs spread over multiple Perl script files. I want to write a landing page for all these PODs using another .pod file. Say, in the folder /my/root/sub_folder/ I have a script file FirstScript.pl with the following POD. =head1…
Ishan De Silva
  • 935
  • 2
  • 8
  • 22
3
votes
2 answers

How can I check if a function has POD (perl in-file documentation)?

Is there any library that can tell me if a specific function has POD? I want to add that into our build system. As in, the convention as established in the docs on POD, =item stuff() This function does stuff. =cut sub stuff { ... } I want to…
Evan Carroll
  • 78,363
  • 46
  • 261
  • 468
3
votes
1 answer

Pod::Usage: `=begin :text`/`=end :text` messes up formatting

I have some POD documentation with a section that should be rendered differently in Latex (using pod2latex) and plain text/man. For this purpose, I have a =begin :text/=end :text section. Now, I want to show individual sections of the POD on the…
xebtl
  • 450
  • 4
  • 11
3
votes
2 answers

Pod::Usage help formatting

I would like to correctly format my help message for my Perl scripts and if possible by using a standard module such as Pod::Usage. Unfortunately I do not really like the output format of pod2usage. For instance, with grep I get the following help…
nowox
  • 25,978
  • 39
  • 143
  • 293
3
votes
1 answer

How to add HTML section in Perl POD using Pod::Weaver

I use Pod::Weaver with Dist::Zilla. It does several good things for me. It adds POD section VERSION, AUTHOR, LICENSE automatically, and in my source code I can use simple POD syntax, I can write "=method new" and it will be converted to correct…
bessarabov
  • 11,151
  • 10
  • 34
  • 59
1
2
3 4 5