Lingua::EN::Fathom - provide readability and general text measurements
=head1 SYNOPSIS
use Lingua::EN::Fathom;
my $text = new Lingua::EN::Fathom;
$text->analyse_file("sample.txt");
$text->analyse_block($text_string);
$num_chars = $text->num_chars;
$num_words = $text->num_words;
$num_sentences = $text->num_sentences;
$num_text_lines = $text->num_text_lines;
$num_blank_lines = $text->num_blank_lines;
%words = $text->unique_words;
foreach $word ( sort keys %words )
{
print("$words{$word} :$word\n");
}
$fog = $text->fog;
$flesch = $text->flesch;
$kincaid = $text->kincaid;
print($text->report);
=head1 DESCRIPTION
This module analyses English text in either a string or file. Totals are
then calculated for the number of characeters, words, sentences, blank
and onon blank (text) lines.
Three common readablity statistics are also derived, the Fog, Flesch and
Kincaid indices.
All of these properties can ve accessed through individual methods, or by
generatring a text report.
=head1 REQUIRES
Perl, version 5.001 or higher, Lingua::EN::Syllable
=head1 HOW TO INSTALL
perl Makefile.PL
make
make test
make install
=head1 BUGS
=head1 CHANGES
0.01 23 Jan 2000: First Release
=head1 COPYRIGHT
Copyright (c) 2000 Kim Ryan. All rights reserved.
This program is free software; you can redistribute it
and/or modify it under the terms of the Perl Artistic License
(see http://www.perl.com/perl/misc/Artistic.html).
=head1 AUTHOR
Fathom was written by Kim Ryan <kimaryan@ozemail.com.au> in 2000.