• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• METHODS
  • my $speller = Text::Hspell->new;
  • $speller->check_word($word)
  • my $array_ref = $speller->try_to_correct_word($word)
  • $speller->proto_new()
  • $speller->check_word_internal()
  • $speller->trycorrect_internal()
• COPYRIGHT & LICENSE
• THANKS
• SUPPORT
  • Websites
  • Bugs / Feature Requests
  • Source Code
• AUTHOR
• BUGS
• COPYRIGHT AND LICENSE

NAME

Text::Hspell - wrapper for the hspell (= Hebrew speller) library

VERSION

version 0.4.1

SYNOPSIS

    use Text::Hspell ();
    use utf8;

    my $speller = Text::Hspell->new;

    print $speller->check_word("שלום") ? "spelled right\n" : "misspelling\n";

DESCRIPTION

This module allows one to use libhspell ( http://hspell.ivrix.org.il/ ) to spell check Hebrew words.

METHODS

my $speller = Text::Hspell->new;

Create a new speller object instance.

$speller->check_word($word)

Returns true if the word is spelled right and false if it is an unknown word.

my $array_ref = $speller->try_to_correct_word($word)

Returns an array reference of strings with spell correction suggestions for $word .

(Added in version 0.4.0 .)

$speller->proto_new()

For internal use.

$speller->check_word_internal()

For internal use.

$speller->trycorrect_internal()

For internal use.

COPYRIGHT & LICENSE

Copyright 2019 by Shlomi Fish.

This program is distributed under the MIT / Expat License: http://www.opensource.org/licenses/mit-license.php . Note that it depends on libhspell which is currently under the https://en.wikipedia.org/wiki/Affero_General_Public_License v3.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THANKS

An early version of this module required Inline::Python (by https://metacpan.org/author/NINE and others) and HspellPy ( https://pypi.org/project/HspellPy/ ) from PyPI (by https://github.com/eranroz/ ), so thanks to them. The dependency on these packages was removed in version 0.2.0.

We still make use of libhspell ( http://hspell.ivrix.org.il/ ) by wrapping its C API.

Thanks to the authors of hspell and libhspell: Nadav Har’El ( http://nadav.harel.org.il/ ), Dan Kenigsberg ( http://www.cs.technion.ac.il/~danken/ ) and possibly others.

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.

• MetaCPAN

  A modern, open-source CPAN search engine, useful to view POD in HTML format.

  https://metacpan.org/release/Text-Hspell

• RT: CPAN's Bug Tracker

  The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

  https://rt.cpan.org/Public/Dist/Display.html?Name=Text-Hspell

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.cpanauthors.org/dist/Text-Hspell

• CPAN Testers

  The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/T/Text-Hspell

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

  http://matrix.cpantesters.org/?dist=Text-Hspell

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=Text::Hspell

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-text-hspell at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Text-Hspell. 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/Text-Hspell

  git clone git://github.com/shlomif/Text-Hspell.git

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/Text-Hspell/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) 2019 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License

cpanm Text::Hspell

perl -MCPAN -e shell
install Text::Hspell