NAME
Text::Perfide::BookCleaner - A module for processing books in plain text formats.
VERSION
Version 0.01_01
SYNOPSIS
Quick summary of what the module does.
Perhaps a little code snippet.
use Text::Perfide::BookCleaner;
my $foo = Text::Perfide::BookCleaner->new();
...EXPORT
A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module.
FUNCTIONS
gettxt
Opens a text file and returns its contents.
Optionally, the file encoding may be defined. Default encoding is UTF-8.
Removes all ^M characters.
pages
Extracts and removes from text page breaks, headers and footers.
paux_pnum_pbr
Removes pagenumbers + pagebreaks
paux_pnum_nopbr
Removes pagenumbers with no pagebreaks
paux_pbr
Removes single page breaks
paux_hef
Counts and removes headers and footers
sections
Detects section titles and breaks.
paragraphs
Detects and normalizes paragraph notation.
footnotes
Detects and removes footnotes.
chars
Several character-level operations: replacing non-ISO characters
translin
Deals with translineations (words split across lines caused by line-wrapping) and transpaginations (same situation but for pages).
commit
Returns a text with all changes commited (removes marks left by other functions).
writefile
Writes text in file pointed by given file descriptor (default enconding UTF8).
AUTHOR
Jose Joao, <jj at di.uminho.pt>
Andre Santos, <andrefs at cpan.org>
BUGS
Please report any bugs or feature requests to bug-text-bookcleaner at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-BookCleaner. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Text::Perfide::BookCleanerYou can also look for information at:
RT: CPAN's request tracker
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
Copyright 2010 Jose Joao.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.