TeX::Hyphen::czech(3)

💅 TeX::Hyphen::czech 💅

Okay so this is the manual page for TeX::Hyphen::czech — and yes bestie, it's a User Contributed Perl Documentation page. If you're an end user, lowkey there's not much here for you; the real move is just passing the style parameter to new TeX::Hyphen. But if you're here to hack on pattern parsing, welcome, you're the main character now. 👑

---

✨ 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 — Czech is literally the blueprint, no cap. 👑 If you need to write your 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 the 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 the end of the pattern section (macro) was reached, and 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 the second parameter upon call. The function should return 0 if the end of the exception section (macro) was reached, and 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 the default that can be changed with parameters to the TeX::Hyphen constructor.

---

Okay that's the whole vibe check, bestie. This iconic little page comes from perl v5.32.1, dated 2018-02-09, and it's the TeX::Hyphen::czech(3) manual page. Slay. 💅✨