GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POD::WORDLIST (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 1.19

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 to 0xFF 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

o Sean M. Burke <sburke@cpan.org>
o Caleb Cushing <xenoterracide@gmail.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Olivier Mengue\k:'\h |\n:u.

This is free software, licensed under:



  The Artistic License 2.0 (GPL Compatible)



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 POD::WORDLIST (3) 2016-02-20

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.