-
-
22 Apr 2016 07:36:12 UTC
- Distribution: Pod-Spell
- Module version: 1.20
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (2)
- Testers (10628 / 9 / 2)
- Kwalitee
Bus factor: 1- 80.73% Coverage
- License: artistic_2
- Perl: v5.8.0
- Activity
24 month- Tools
- Download (30.49KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 6 contributors-
Sean M. Burke
-
Caleb Cushing
-
David Golden
-
Kent Fredric
-
Mohammad S Anwar
-
Paulo Custodio
NAME
Pod::Wordlist - English words that come up in Perl documentation
VERSION
version 1.20
DESCRIPTION
Pod::Wordlist is used by Pod::Spell, providing a set of words that are English jargon words that come up in Perl documentation, but which are not to be found in general English lexicons. (For example: autovivify, backreference, chroot, stringify, wantarray.)
You can also use this wordlist with your word processor by just pasting
share/wordlist
's content into your wordprocessor, deleting the leading Perl code so that only the wordlist remains, and then spellchecking this resulting list and adding every word in it to your private lexicon.ATTRIBUTES
wordlist
ref $self->wordlist eq 'HASH'; # true
This is the instance of the wordlist
no_wide_chars
If true, words with characters outside the Latin-1 range
0x00
to0xFF
will be stripped like stopwords.METHODS
learn_stopwords
$wordlist->learn_stopwords( $text );
Modifies the stopword list based on a text block. See the rules for <adding stopwords|Pod::Spell/ADDING STOPWORDS> for details.
is_stopword
if ( $wordlist->is_stopword( $word ) ) { ... }
Returns true if the word is found in the stopword list.
strip_stopwords
my $out = $wordlist->strip_stopwords( $text );
Returns a string with space separated words from the original text with stopwords removed.
WORDLIST
Note that the scope of this file is only English, specifically American English. (But you may find in useful to incorporate into your own lexicons, even if they are for other dialects/languages.)
remove any q{'s} before adding to the list.
The list should be sorted and uniqued. The following will work (with GNU Coreutils ).
sort share/wordlist -u > /tmp/sorted && mv /tmp/sorted share/wordlist
AUTHORS
Sean M. Burke <sburke@cpan.org>
Caleb Cushing <xenoterracide@gmail.com>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2016 by Olivier Mengué.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
Module Install Instructions
To install Pod::Spell, copy and paste the appropriate command in to your terminal.
cpanm Pod::Spell
perl -MCPAN -e shell install Pod::Spell
For more information on module installation, please visit the detailed CPAN module installation guide.