TeX::Hyphen::czech

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-27
Page Index

NAME

TeX::Hyphen::czech -- provides parsing routine for Czech patterns

SYNOPSIS

        use TeX::Hyphen;
        my $hyp = new TeX::Hyphen 'hyphen.tex', style => 'czech';

        # and then follow documentation for TeX::Hyphen

DESCRIPTION

This pattern processing happens to be the default. If you need to write you own style of parsing the pattern file, you might want to start with this file and hack it to suit your needs. There is nothing for end users here --- just specify the style parameter in call to new TeX::Hyphen.

The language style specific modules have to define the following functions:

process_patterns: This method gets individual lines of the \patterns content. It should parse these lines, and fill values in $bothhyphen, $beginhyphen, $endhyphen and $hyphen which are being passed to this function as parameters following the line. The function should return 0 if end of the pattern section (macro) was reached, 1 if the parsing should continue.
process_hyphenation: This method gets the lines of the \hyphenation content. It should parse these lines and fill values into $exception which is passed as second parameter upon call. The function should return 0 if end of the exception section (macro) was reached, 1 if the parsing should continue.

Check the TeX::Hyphen::czech source to see the exact form of the values inserted into these has structures.

Each style module should also define $LEFTMIN and $RIGHTMIN global variables, if they have different values than the default 2. The values should match the paratemers used to generate the patterns. Since various pattern files could be generated with different values set, this is just default that can be changed with parameters to the TeX::Hyphen constructor.