27 Oct 2020 18:52:43 UTC
- Distribution: Pod-Definitions
- Module version: 0.03
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (177 / 0 / 19)
- KwaliteeBus factor: 1
- 91.32% Coverage
- License: perl_5
- Perl: v5.20.0
- Activity24 month
- Download (17.3KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionWLINDLEY William Lindley
Pod::Definitions::Heuristic -- Apply heuristics to headings defined in Pod, presumably in English, for indexing and cross-referencing
my $h = Pod::Headings::Heuristic->new( text => "Splitting the infinitive"); $h->clean(); # returns "Infinitive, splitting the"
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.
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'.
Applies the keyword-finding heuristics on text in 'text' and returns a best guess version with the keyword in first position.
The content of the text to be parsed.
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.
This module was written and is maintained by William Lindley <email@example.com>.
Module Install Instructions
To install Pod::Definitions, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Pod::Definitions
For more information on module installation, please visit the detailed CPAN module installation guide.