NAME
    Test::HTML::Spelling - Test the spelling of HTML documents

SYNOPSIS
      use Test::More;
      use Test::HTML::Spelling;

      use Test::WWW::Mechanize;

      my $sc = Test::HTML::Spelling->new(
          ignore_classes   => [qw( no-spellcheck )],
          check_attributes => [qw( title alt )],
      );

      $sc->speller->set_option('lang','en_GB');
      $sc->speller->set_option('sug-mode','fast');

      my $mech = Test::WWW::Mechanize->new();

      $mech->get_ok('http://www.example.com/');

      $sc->spelling_ok($mech->content, "spelling");

      done_testing;

DESCRIPTION
    This module parses an HTML document, and checks the spelling of the text
    and some attributes (such as the `title' and `alt' attributes).

    It will not spellcheck the attributes or contents of elements (including
    the contents of child elements) with the class `no-spellcheck'. For
    example, elements that contain user input, or placenames that are
    unlikely to be in a dictionary (such as timezones) should be in this
    class.

    It will fail when an HTML document if not well-formed.

METHODS
  ignore_classes
    This is an accessor method for the names of element classes that will
    not be spellchecked. It is also a constructor paramater.

    It defaults to `no-spellcheck'.

  check_attributes
    This is an accessor method for the names of element attributes that will
    be spellchecked. It is also a constructor paramater.

    It defaults to `title' and `alt'.

  ignore_words
    This is an accessor method for setting a hash of words that will be
    ignored by the spellchecker. Use it to specify a custom dictionary, e.g.

      use File::Slurp;

      my %dict = map { chomp($_); $_ => 1 } read_file('custom');

      $sc->ignore_words( \%dict );

  speller
      $sc->speller->set_option('lang','en_GB');

    This is an accessor that gives you access to the Text::Aspell object.
    Use this to configure the spellchecker.

  check_spelling
      if ($sc->check_spelling( $content )) {
        ..
      }

    Check the spelling of a document, and return true if there are no
    spelling errors.

  spelling_ok
        $sc->spelling_ok( $content, $message );

    Parses the HTML file and checks the spelling of the document text and
    selected attributes.

AUTHOR
    Robert Rothenberg, `<rrwo at cpan.org>'

LICENSE AND COPYRIGHT
    Copyright 2012 Robert Rothenberg.

    This program is free software; you can redistribute it and/or modify it
    under the terms of the the Artistic License (2.0). You may obtain a copy
    of the full license at:

    http://www.perlfoundation.org/artistic_license_2_0

    Any use, modification, and distribution of the Standard or Modified
    Versions is governed by this Artistic License. By using, modifying or
    distributing the Package, you accept this license. Do not use, modify,
    or distribute the Package, if you do not accept this license.

    If your Modified Version has been derived from a Modified Version made
    by someone other than you, you are nevertheless required to ensure that
    your Modified Version complies with the requirements of this license.

    This license does not grant you the right to use any trademark, service
    mark, tradename, or logo of the Copyright Holder.

    This license includes the non-exclusive, worldwide, free-of-charge
    patent license to make, have made, use, offer to sell, sell, import and
    otherwise transfer the Package with respect to any patent claims
    licensable by the Copyright Holder that are necessarily infringed by the
    Package. If you institute patent litigation (including a cross-claim or
    counterclaim) against any party alleging that the Package constitutes
    direct or contributory patent infringement, then this Artistic License
    to you shall terminate on the date that such litigation is filed.

    Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
    AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
    THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
    PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
    YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
    CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.