Ports Search

The whole idea of this module is to take advantage of all the syntax colouring modules that exist (such as Perl::Tidy) to produce colourful code examples in a POD document (after conversion to HTML).

This module implements a parser to convert Pod documents into a simple object model form known hereafter as the Pod Object Model. The object model is generated as a hierarchical tree of nodes, each of which represents a different element of the original document. The tree can be walked manually and the nodes examined, printed or otherwise manipulated. In addition, Pod::POM supports and provides view objects which can automatically traverse the tree, or section thereof, and generate an output representation in one form or another.

This module allows you to generates CPAN like pod pages from your modules (not only perl but also javascript including pod) for your projects. Set your library modules' root directory with libroot option. And you have to set output directory's path with outroot option. And this module searches your pm and pod files from your libroot, and generates html files, and an index page lists up all your modules there.

This module is a subclass of Pod::PlainText which provides additional POD markup for generating README files.

Pod::Simple is a Perl library for parsing text in the Pod ("plain old documentation") markup language that is typically used for writing documentation for Perl and for Perl modules. The Pod format is explained in the perlpod man page; the most common formatter is called "perldoc". Pod formatters can use Pod::Simple to parse Pod documents into produce renderings of them in plain ASCII, in HTML, or in any number of other formats. Typically, such formatters will be subclasses of Pod::Simple, and so they will inherit its methods, like parse_file.

Pod::Spell is a Pod formatter whose output is good for spellchecking. Pod::Spell rather like Pod::Text, except that it doesn't put much effort into actual formatting, and it suppresses things that look like Perl symbols or Perl jargon (so that your spellchecking program won't complain about mystery words like "$thing" or "Foo::Bar" or "hashref").

This be Pod::Stripper, a subclass of Pod::Parser. It parses perl files, stripping out the pod, and dumping the rest (presumably code) to wherever you point it to (like you do with Pod::Parser).

Pod::Tree parses a POD into a static syntax tree. Applications walk the tree to recover the structure and content of the POD.

How does Pod::WSDL work? If you instantiate a Pod::WSDL object with the name of the module (or the path of the file, or an open filehandle) providing the web service like this my $pwsdl = new Pod::WSDL(source => 'My::Module', location => 'http://my.services.location/on/the/web'); Pod::WSDL will try to find "My::Module" in @INC, open the file, parse it for WSDL directives and prepare the information for WSDL output. By calling $pwsdl->WSDL; Pod::WSDL will output the WSDL document. That's it.

Pod works well, but writing it can be time-consuming and tedious. For example, commonly used layouts like lists require numerous lines of text to make just a couple of simple points. An alternative approach is to write documentation in a wiki-text shorthand (referred to here as wikidoc) and use Pod::WikiDoc to extract it and convert it into its corresponding Pod as a separate .pod file.