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  -  TEXT::SPELLCHECKER (3)

.ds Aq ’

NAME

Text::SpellChecker - OO interface for spell-checking a block of text

CONTENTS

SYNOPSIS



    use Text::SpellChecker;
    ($Text::SpellChecker::pre_hl_word,
     $Text::SpellChecker::post_hl_word) = (qw([ ]));

    my $checker = Text::SpellChecker->new(text => "Foor score and seven yeers ago");

    while (my $word = $checker->next_word) {
        print $checker->highlighted_text,
            "\n",
            "$word : ",
            (join "\t", @{$checker->suggestions}),
            "\nChoose a new word : ";
        chomp (my $new_word = <STDIN>);
        $checker->replace(new_word => $new_word) if $new_word;
    }

    print "New text : ".$checker->text."\n";



--or—



    use CGI;
    use Text::SpellChecker;
    my $q = new CGI;
    print $q->header,
          $q->start_html,
          $q->start_form(-method=>POST,-action=>$ENV{SCRIPT_NAME});

    my $checker = Text::SpellChecker->new(
        text => "Foor score and seven yeers ago",
        from_frozen => $q->param(frozen) # will be false the first time.
    );

    $checker->replace(new_word => $q->param(replacement))
        if $q->param(replace);

    if (my $word = $checker->next_word) {
        print $q->p($checker->highlighted_text),
            $q->br,
            qq|Next word : "$word"|,
            $q->br,
            $q->submit(-name=>replace,-value=>replace with:),
            $q->popup_menu(-name=>replacement,-values=>$checker->suggestions),
            $q->submit(-name=>skip);
    } else {
        print "Done.  New text : ".$checker->text;
    }

    print $q->hidden(-name => frozen,
                     -value => $checker->serialize,
                     -override => 1),
          $q->end_form,
          $q->end_html;



DESCRIPTION

This module is a thin layer above either Text::Aspell or Text::Hunspell (preferring the latter if available), and allows one to spellcheck a body of text.

Whereas Text::(Hu|A)spell deals with words, Text::Spellchecker deals with blocks of text. For instance, we provide methods for iterating through the text, serializing the object (thus remembering where we left off), and highlighting the current misspelled word within the text.

METHODS

$checker = Text::SpellChecker->new(text => $text, from_frozen => $serialized_data, lang => $lang, options => $options) Send either the text or a serialized object to the constructor. Optionally, the language of the text can also be passed. If no language is passed, $ENV{LANG} will be used, if it is set. If it is not set, the default language will be en_US.

$options are checker-specific options (see below).

$checker = new_from_frozen($serialized_data) This is provided separately, so that it may be overridden for alternative serialization techniques.
$str=$checker->serialize Represent the object in its current state.
$checker->reset Reset the checker to the beginning of the text, and clear the list of ignored words.
$word = $checker->next_word Returns the next misspelled word.
$checker->current_word Returns the most recently returned word.
$checker->replace(new_word => $word) Replace the current word with $word.
$checker->ignore_all Ignore all subsequent occurences of the current word.
$checker->replace_all(new_word => $new_word) Replace all subsequent occurences of the current word with a new word.
$checker->suggestions Returns a reference to a list of alternatives to the current word in a scalar context, or the list directly in a list context.
$checker->text Returns the current text (with corrections that have been applied).
$checker->highlighted_text Returns the text, but with the current word surrounded by $Text::SpellChecker::pre_hl_word and $Text::SpellChecker::post_hl_word.
$checker->set_options Set checker-specific options. Currently only aspell supports setting options, e.g.



    $checker->set_options(aspell => { "extra-dicts" => "nl" } );



CONFIGURATION OPTIONS

$Text::SpellChecker::pre_hl_word Set this to control the highlighting of a misspelled word.
$Text::SpellChecker::post_hl_word Set this to control the highlighting of a misspelled word.
$Text::SpellCheckerDictionaryPath{Hunspell} Set this to the hunspell dictionary path. By default /usr/share/hunspell.

This directory should have $lang.dic and $lang.aff files.

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

TODO

Add word to custom dictionary

SEE ALSO

Text::Aspell, Text::Hunspell

AUTHOR

Brian Duggan <bduggan@matatu.org>
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TEXT::SPELLCHECKER (3) 2014-11-06

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