Roland van Ipenburg > TeX-Hyphen-Pattern-0.04 > TeX::Hyphen::Pattern

Download:
TeX-Hyphen-Pattern-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

TeX::Hyphen::Pattern - class for providing a collection of TeX hyphenation patterns for use with TeX::Hyphen.

VERSION ^

This is version 0.04. To prevent plugging in of incompatible modules the version of the pluggable modules must be the same as this module.

SYNOPSIS ^

    use TeX::Hyphen;
    use TeX::Hyphen::Pattern;

    $pat = TeX::Hyphen::Pattern->new();
    $pat->label('Sh_ltn'); # Serbocroatian hyphenation patterns
    $hyph = TeX::Hyphen->new($pat->filename);

DESCRIPTION ^

The TeX::Hyphen module parses TeX files containing hyphenation patterns for use with TeX based systems. This module includes TeX hyphenation files from http://www.ctan.org and hyphenation patterns from http://www.openoffice.org and provides a single interface to use them in TeX::Hyphen.

http://tug.org/svn/texhyphen/trunk/hyph-utf8/tex/generic/hyph-utf8/patterns/
http://svn.services.openoffice.org/ooo/trunk/dictionaries/

SUBROUTINES/METHODS ^

TeX::Hyphen::Pattern->new();
TeX::Hyphen::Pattern->new(label => $label);

Constructs a new TeX::Hyphen::Pattern object.

$pattern->label($label);

Sets the label that determines the pattern to use. The label can be a simple language code, but since some languages can use multiple scripts with different hyphenation rules we talk about patterns and not just languages.

$pattern->available();

Returns a list of the available patterns.

$pattern->filename();

Returns the name of a temporary file that TeX::Hyphen can read it's pattern from for the current label. Returns undef if no pattern language matching the label was found.

CONFIGURATION AND ENVIRONMENT ^

The script tools/build_catalog.pl was used to get the TeX patterns file from the source on the internet and include them in this module. After that the copyright messages were manually checked and inserted to make sure this distribution complies with them.

DEPENDENCIES ^

Class::Meta::Express Encode File::Temp Log::Log4perl Module::Pluggable Readonly Set::Scalar Test::More Test::NoWarnings

INCOMPATIBILITIES ^

Not all available pattern files are parsed correctly by TeX::Hyphen. Versions up to and including 0.140 don't support utf8, so patterns using utf8 that are included in this package have a version number 0.00 to ignore them. Should you patch TeX::Hyphen yourself by inserting a binmode FILE, ":utf8"; you can change those version numbers to 0.04 to include them.

DIAGNOSTICS ^

This module uses Log::Log4perl for logging. It's a fatal error when the temporary file containing the pattern can't be written.

Can't write to file '%s', stopped %s

The temporary file created by File::Temp could not be written.

BUGS AND LIMITATIONS ^

AUTHOR ^

Roland van Ipenburg, <ipenburg@xs4all.nl>

LICENSE AND COPYRIGHT ^

Copyright (C) 2009 by Roland van Ipenburg

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.

The included pattern files in lib/TeX/Hyphen/Pattern/ are licensed as stated in those files.

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 LICENSE, 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.

syntax highlighting: