The Pod::WordML module

This is an abandoned module. You can adopt it if you like:

        https://pause.perl.org/pause/authenquery?ACTION=pause_04about#takeover

This is the README for the Pod::WordML Perl module. I created this module to help write Effective Perl Programming and I did the minimum I needed to do to support the features I needed. In most places, I tried to program in a way that wouldn't limit future development. Unless I need it again, I'm unlikely to work on it. Make it your own!

You're probably looking at this because you don't know where else to find what you're looking for. Read this once and you might never have to read one again for any Perl module.

Documentation

To read about Pod::WordML, look at the embedded documentation in the module itself. Inside the distribution, you can format it with perldoc:

        % perldoc lib/Pod/WordML.pm

If you have already installed the module, you can specify the module name instead of the file location:

        % perldoc Pod::WordML

You can read the documentation and inspect the meta data on one of the CPAN web interfaces, such as MetaCPAN.

The standard module documentation has example uses in the SYNOPSIS section, but you can also look in the examples/ directory (if it's there), or look at the test files in t/.

Installation

You can install this module with a CPAN client, which will resolve and install the dependencies:

        % cpan Pod::WordML
        % cpanm Pod::WordML

You can also install directly from the distribution directory, which will also install the dependencies:

        % cpan .
        % cpanm .

You could install just this module manually:

        % perl Makefile.PL
        % make
        % make test
        % make install

You probably don't want to do that unless you're fiddling with the module and only want to run the tests without installing anything.

Source location

The meta data, such as the source repository and bug tracker, is in Makefile.PL or the META.* files it creates. You can find that on those CPAN web interfaces, but you can also look at files directly in the source repository:

• https://github.com/CPAN-Adoptable-Modules/pod-wordml

Copyright and License

You should have received a LICENSE file, but the license is also noted in the module files. About the only thing you can't do is pretend that you wrote code that you didn't.

Good luck!

Enjoy,

brian d foy, bdfoy@cpan.org