1Pod::Wordlist(3)      User Contributed Perl Documentation     Pod::Wordlist(3)
2
3
4

NAME

6       Pod::Wordlist - English words that come up in Perl documentation
7

VERSION

9       version 1.20
10

DESCRIPTION

12       Pod::Wordlist is used by Pod::Spell, providing a set of words that are
13       English jargon words that come up in Perl documentation, but which are
14       not to be found in general English lexicons.  (For example: autovivify,
15       backreference, chroot, stringify, wantarray.)
16
17       You can also use this wordlist with your word processor by just pasting
18       "share/wordlist"'s content into your wordprocessor, deleting the
19       leading Perl code so that only the wordlist remains, and then
20       spellchecking this resulting list and adding every word in it to your
21       private lexicon.
22

ATTRIBUTES

24   wordlist
25               ref $self->wordlist eq 'HASH'; # true
26
27       This is the instance of the wordlist
28
29   no_wide_chars
30       If true, words with characters outside the Latin-1 range 0x00 to 0xFF
31       will be stripped like stopwords.
32

METHODS

34   learn_stopwords
35           $wordlist->learn_stopwords( $text );
36
37       Modifies the stopword list based on a text block. See the rules for
38       <adding stopwords|Pod::Spell/ADDING STOPWORDS> for details.
39
40   is_stopword
41               if ( $wordlist->is_stopword( $word ) ) { ... }
42
43       Returns true if the word is found in the stopword list.
44
45   strip_stopwords
46           my $out = $wordlist->strip_stopwords( $text );
47
48       Returns a string with space separated words from the original text with
49       stopwords removed.
50

WORDLIST

52       Note that the scope of this file is only English, specifically American
53       English.  (But you may find in useful to incorporate into your own
54       lexicons, even if they are for other dialects/languages.)
55
56       remove any q{'s} before adding to the list.
57
58       The list should be sorted and uniqued. The following will work (with
59       GNU Coreutils ).
60
61               sort share/wordlist -u > /tmp/sorted && mv /tmp/sorted share/wordlist
62

AUTHORS

64       •   Sean M. Burke <sburke@cpan.org>
65
66       •   Caleb Cushing <xenoterracide@gmail.com>
67

69       This software is Copyright (c) 2016 by Olivier Mengué.
70
71       This is free software, licensed under:
72
73         The Artistic License 2.0 (GPL Compatible)
74
75
76
77perl v5.32.1                      2021-01-27                  Pod::Wordlist(3)
Impressum