NAME
Text::Hoborg - Spell-and-quality check for texts, including novels.
VERSION
This document describes Text::Hoborg version 0.0.5
SYNOPSIS
use Text::Hoborg;DESCRIPTION
This started as a spell and quality check for my novel, "Manuel the Magnificent Mechanical Man". Eventually, it can be used for checking any kind of markdown-formatted text, be it fiction or non-fiction. It includes, as documentation, the novel itself (check it out at Text::Hoborg::Manuel and also in the test directory the markdown source.
INTERFACE
new [$dir]
Creates an object with the novel text inside
text
Returns the text in original format
text_file
Returns the name of the text file
dir
Returns the dir the source file is in. Since this is managed from the object, it is useful for other functions.
appendices
Returns an array with the appendices included with the novel. It's used mainly for checking the spelling.
DEPENDENCIES
Text::Hoborg requires Text::Hunspell. And the Hoborg novel http://jj.github.io/hoborg should be somewhere. It also needs the en_US dictionnary for hunspell, which you can install with sudo apt-get install hunspell-en-us , but since I found no way of expressing this dependency within Makefile.PL, I have added it to the data dir, mainly
AUTHOR
JJ Merelo <jj@merelo.net>
LICENCE AND COPYRIGHT
Copyright (c) 2013, JJ Merelo <jj@merelo.net>. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.