NAME

HTML::Spelling::Site::Whitelist - handles the whitelist file.

VERSION

version 0.4.3

SYNOPSIS

    use HTML::Spelling::Site::Whitelist;

    my $obj = HTML::Spelling::Site::Whitelist->new(
        {
            filename => 'path/to/whitelist.txt',
        }
    );

    $obj->parse;

    if (! $obj->check_word('clover'))
    {
        # Do more spell checking.
    }

    $obj->write_sorted_file;

DESCRIPTION

The instances of this class can be used to manage a whitelist of words to spell check.

METHODS

my $obj = HTML::Spelling::Site::Checker->new({ filename => './path/to/whitelist.txt'});

Initialises a new object. filename is the path to the file.

$whitelist->parse;

For now you should call this method right after the object is created.

$finder->check_word({filename => $filename, word => $word})

Checks if the word $word in the file $filename is in the whitelist.

$finder->write_sorted_file;

Rewrites the file to be sorted and canonicalized.

$finder->is_sorted();

Checks if the file is properly sorted and canonicalized.

$finder->get_sorted_text()

Returns the sorted text of the whitelist.

$finder->filename()

Returns the filename.

WHITELIST FORMAT

The format of the whitelist file is:

    ==== GLOBAL:

    [Global whitelist with one word per line]

    ==== In: path1 , path2 , path3

    [one word per line whitelist for path1, path2 and path3]

    ==== In: path4

    [one word per line whitelist for path4]

(NOTE that the paths are a complete path to the file and not parsed for wildcards or regular expression syntax.)

Here's another example:

https://bitbucket.org/shlomif/shlomi-fish-homepage/src/493302cc5f1d81584f6f21bbd64197048e185aa6/lib/hunspell/whitelist1.txt?at=default&fileviewer=file-view-default

You should keep the whitelist file canonicalised and sorted by using write_sorted_file() and is_sorted() .

SUPPORT

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-html-spelling-site at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=HTML-Spelling-Site. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/HTML-Spelling-Site

  git clone https://github.com/shlomif/HTML-Spelling-Site.git

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/html-spelling-site/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License