NAME

Meta::Tool::Aspell - run aspell for you to check spelling.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Aspell.pm
        PROJECT: meta
        VERSION: 0.14

SYNOPSIS

        package foo;
        use Meta::Tool::Aspell qw();
        my($object)=Meta::Tool::Aspell->new();
        my($result)=$object->method();

DESCRIPTION

This module hides the complexity of running aspell on SGML documents from you.

FUNCTIONS

        BEGIN()
        checksgml($)
        checkhtml($)
        checktxt($)
        TEST($)

FUNCTION DOCUMENTATION

BEGIN()

Bootstrap method to locate your aspell executable.

checksgml($)

This method will check an sgml source file for spell correctness. It returns a boolean specifiying whether it is correct or not. There are several problems in aspell: 0. If you dont want it to run interactivly you have to use the --list (-l) flag but when using this option you cannot use aspell to check a file but only stdin. 1. Aspell's exit code does not imply if the document was correct or not. In order to do that you have to check that the output list is empty. At the end, this module uses my Unique module to produce a list of different words which were not spelled correctly.

Another problem is that Aspell that not recurse into included docbook documents.

checkhtml($)

This method will check an HTML file for syntax errors. Currently it just calls the SGML version because all our HTML documents are SGML compliant.

checktxt($)

This method will check a regular text file. Currently it is unimplemented and just returns true.

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV history change
        0.01 MV spelling and papers
        0.02 MV fix docbook and other various stuff
        0.03 MV perl packaging
        0.04 MV BuildInfo object change
        0.05 MV md5 project
        0.06 MV database
        0.07 MV perl module versions in files
        0.08 MV movies and small fixes
        0.09 MV thumbnail user interface
        0.10 MV more thumbnail issues
        0.11 MV website construction
        0.12 MV web site automation
        0.13 MV SEE ALSO section fix
        0.14 MV md5 issues

SEE ALSO

Meta::Baseline::Aegis(3), Meta::Utils::File::Patho(3), Meta::Utils::Output(3), Meta::Utils::System(3), Meta::Utils::Text::Unique(3), strict(3)

TODO

Nothing.