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.26
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

METHODS

24   learn_stopwords
25           $wordlist->learn_stopwords( $text );
26
27       Modifies the stopword list based on a text block. See the rules for
28       <adding stopwords|Pod::Spell/ADDING STOPWORDS> for details.
29
30   is_stopword
31           if ( $wordlist->is_stopword( $word ) ) { ... }
32
33       Returns true if the word is found in the stopword list.
34
35   strip_stopwords
36           my $out = $wordlist->strip_stopwords( $text );
37
38       Returns a string with space separated words from the original text with
39       stopwords removed.
40

ATTRIBUTES

42   wordlist
43           ref $self->wordlist eq 'HASH'; # true
44
45       This is the instance of the wordlist
46
47   no_wide_chars
48       If true, words with characters outside the Latin-1 range 0x00 to 0xFF
49       will be stripped like stopwords.
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

BUGS

64       Please report any bugs or feature requests on the bugtracker website
65       <https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Spell> or by
66       email to bug-Pod-Spell@rt.cpan.org <mailto:bug-Pod-Spell@rt.cpan.org>.
67
68       When submitting a bug or request, please include a test-file or a patch
69       to an existing test-file that illustrates the bug or desired feature.
70

AUTHORS

72       •   Sean M. Burke <sburke@cpan.org>
73
74       •   Caleb Cushing <xenoterracide@gmail.com>
75

77       This software is Copyright (c) 2023 by Olivier Mengué.
78
79       This is free software, licensed under:
80
81         The Artistic License 2.0 (GPL Compatible)
82
83
84
85perl v5.36.0                      2023-03-14                  Pod::Wordlist(3)
Impressum