NAME
Pod::Definitions::Heuristic -- Apply heuristics to headings defined in Pod, presumably in English, for indexing and cross-referencing
VERSION
version 0.03
SYNOPSIS
my $h = Pod::Headings::Heuristic->new(
text => "Splitting the infinitive");
$h->clean(); # returns "Infinitive, splitting the"
DESCRIPTION
This class assumes that headings are written in the English language, and in a style typical of Pod pages written for CPAN. A set of heuristics are applied to select keywords and place them at the start of the heading.
METHODS
new
Creates a new object of type Pod::Headings::Heuristic. To this should be passed a list of items to be saved as a hash in the object. The only item currently required or defined is 'text'.
clean
Applies the keyword-finding heuristics on text in 'text' and returns a best guess version with the keyword in first position.
text
The content of the text to be parsed.
SEE ALSO
SUPPORT
This module is managed in an open GitHub repository, https://github.com/lindleyw/Pod-Definitions. Feel free to fork and contribute, or to clone and send patches.
AUTHOR
This module was written and is maintained by William Lindley <wlindley@cpan.org>.