POD-Templates

[Bastian.Zacher]

Hello NG,

I'm actually exploring the perl-documentation via POD. It's nice and easy
to improve the code. While exploring
and writing own PODs, I just want to know if it's possible to work with
templates.
The design of most PODs is the same and my doc's should also be identical.
But I don't want to write the framework
over and over again.

The easiest way, I think, is to write a text-pod and pipe it into the
source. Maybe there's a "pod"-buildin?

How do you manage this?

Thanks,

bastian

 

[Paul Lalli]

I'm actually exploring the perl-documentation via POD. It's nice and easy
to improve the code. While exploring
and writing own PODs, I just want to know if it's possible to work with
templates.
The design of most PODs is the same and my doc's should also be identical.
But I don't want to write the framework
over and over again.

The easiest way, I think, is to write a text-pod and pipe it into the
source. Maybe there's a "pod"-buildin?

Are you trying to write a POD for your own new module? If that's the
case, allow me to suggest Randal Schwartz's _Learning Perl Objects,
References, and Modules_. I just finished re-reading it a week ago, so
the material is relatively fresh on my mind - which made your post jump
out a bit. The last 2 or 3 chapters of the book all deal with writing
your own modules, documenting them, and testing them. Within these
chapters, it is suggested to use the program h2xs which comes with a
standard Perl installation. Running this command will give you the
directories and templates for all files needed to create a distribution.
This includes the skeleton POD included within the .pm file. This
serves as a basic template.

If this is not what you're looking for, carry on.

Paul Lalli

 

[Bastian.Zacher]

Are you trying to write a POD for your own new module? If that's the
case, allow me to suggest Randal Schwartz's _Learning Perl Objects,
References, and Modules_. I just finished re-reading it a week ago, so
the material is relatively fresh on my mind - which made your post jump
out a bit. The last 2 or 3 chapters of the book all deal with writing
your own modules, documenting them, and testing them. Within these
chapters, it is suggested to use the program h2xs which comes with a
standard Perl installation. Running this command will give you the
directories and templates for all files needed to create a distribution.
This includes the skeleton POD included within the .pm file. This
serves as a basic template.

If this is not what you're looking for, carry on.

Paul Lalli

Yes - I heard about h2xs. Hmmm, it's time to explore this feature...

But I'm not writing modules, just perlscripts. Comments with beginning "#"
is not what I'm looking for, cause others don't want to search the whole
script for descriptions.

Maybe the best way is to create an own template and using it while
starting
a new script.

Thanks,

Bastian