lib/Pod/Simple.pm

16 ++

16 ++

Pod::Simple::Select - Select parts in a file using pod directives

++

++

This module will extract specified sections of pod documentation from a file. This ability is provided by the select method which arguments specify the set of POD sections to select for processing/printing....

Pod::Simple::RTF - format Pod as RTF

16 ++

16 ++

This class is a formatter that takes Pod and renders it as RTF, good for viewing/printing in MSWord, WordPad/write.exe, TextEdit, etc. This is a subclass of Pod::Simple and inherits all its methods....

Pod::Simple::Vim - Render pod for display in vim

++

++

This module translates pod into a format used by the vim PERLDOC2 plugin to display perl documentation with syntax highlighting, rather than as plain text....

Pod::Simple::Text - format Pod as plaintext

16 ++

16 ++

This class is a formatter that takes Pod and renders it as wrapped plaintext. Its wrapping is done by Text::Wrap, so you can change $Text::Wrap::columns as you like. This is a subclass of Pod::Simple and inherits all its methods....

Pod::Simple::HTML - convert Pod to HTML

16 ++

16 ++

This class is for making an HTML rendering of a Pod document. This is a subclass of Pod::Simple::PullParser and inherits all its methods (and options). Note that if you want to do a batch conversion of a lot of Pod documents to HTML, you should see t...

Pod::Simple::Data - retrieve the data inlined in Pod

++

++

This class is that for retrieving data from "=begin/=for/=end" sections. The constructor accepts a list of identifier, the default is '*' which allows to retrieve all data. This is a subclass of Pod::Simple and inherits all its methods....

Pod::Simple::Wiki - A class for creating Pod to Wiki filters.

3 ++

3 ++

The "Pod::Simple::Wiki" module is used for converting Pod text to Wiki text. Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation. A Wiki is a user extensible web site. It uses very simple mark-up that is conv...

Pod::Simple::LaTeX - format Pod as LaTeX

++

++

This class is a formatter that takes Pod and renders it as LaTeX. If you are particularly interested in customizing this module's output even more, see the source and/or write to me....

Pod::Simple::XHTML - format Pod as validating XHTML

16 ++

16 ++

This class is a formatter that takes Pod and renders it as XHTML validating HTML. This is a subclass of Pod::Simple::Methody and inherits all its methods. The implementation is entirely different than Pod::Simple::HTML, but it largely preserves the s...

Pod::Simple::31337 - Convert POD to Cool Talk

++

++

This module translates POD into Cool Talk....

Pod::Simple::Words - Parse words and locations from a POD document

++

++

This Pod::Simple parser extracts words from POD, with location information. Some other event types are supported for convenience. The intention is to feed this into a spell checker. Note: stopwords This module recognizes inlined stopwords. These are ...

Pod::Simple::Debug - put Pod::Simple into trace/debug mode

16 ++

16 ++

This is an internal module for controlling the debug level (a.k.a. trace level) of Pod::Simple. This is of interest only to Pod::Simple developers....

Pod::Simple::Pandoc - convert Pod to Pandoc document model

3 ++

3 ++

This module converts Pod format (perlpod) to the document model used by Pandoc <http://pandoc.org/>. The result can be accessed with methods of Pandoc::Elements and further processed with Pandoc to convert it to other document formats (HTML, Markdown...

Pod::Simple::Search - find POD documents in directory trees

16 ++

16 ++

Pod::Simple::Search is a class that you use for running searches for Pod files. An object of this class has several attributes (mostly options for controlling search options), and some methods for searching based on those attributes. The way to use t...

Pod::Simple::JustPod - just the Pod, the whole Pod, and nothing but the Pod

16 ++

16 ++

This class returns a copy of its input, translated into Perl's internal encoding (UTF-8), and with all the non-Pod lines removed. This is a subclass of Pod::Simple::Methody and inherits all its methods. And since, that in turn is a subclass of Pod::S...

Pod::Simple::Methody - turn Pod::Simple events into method calls

16 ++

16 ++

This class is of interest to people writing Pod formatters based on Pod::Simple. This class (which is very small -- read the source) overrides Pod::Simple's _handle_element_start, _handle_text, and _handle_element_end methods so that parser events ar...

Pod::Simple::Checker - check the Pod syntax of a document

16 ++

16 ++

This class is for checking the syntactic validity of Pod. It works by basically acting like a simple-minded version of Pod::Simple::Text that formats only the "Pod Errors" section (if Pod::Simple even generates one for the given document). This is a ...

Pod::Eventual::Simple - just get an array of the stuff Pod::Eventual finds

++

++

Pod::Simple::FromTree - parse POD from tree form

++

++

This is a subclass of Pod::Simple, intended to be further subclassed. Objects of this class, as with Pod::Simple, can parse a POD document, internally using an event-based protocol, and subclasses are expected to add specific behaviour to do somethin...