1TeX::Hyphen(3) User Contributed Perl Documentation TeX::Hyphen(3)
2
6 TeX::Hyphen -- hyphenate words using TeX's patterns
7
9 use TeX::Hyphen;
10 my $hyp = new TeX::Hyphen 'file' => 'hyphen.tex',
11 'style' => 'czech', leftmin => 2,
12 rightmin => 2;
13 # my $hyp = new TeX::Hyphen "hyphen.tex";
15 my $word = "representation";
17 my @points = $hyp->hyphenate($word);
18 print $hyp->visualize($word), "\n";
19
21 Constructor new() creates a new Hyphen object and loads the file with
22 patterns into memory. Then you can ask it for hyphenation of a word by
23 calling a method of this object. If no file is specified, the default
24 Donald E. Knuth's hyphen.tex, that is included in this module, is used
25 instead.
26 Arguments to constructor
28 You can pass arguments to the new() call as hash, possible options are
29 file
31 Name of the file with the patters. It will be loaded and the
32 resulting object will be able to hyphenate according to patterns in
33 that file.
34 For convenience and backward compatibility, the file name can also
36 be specified as the first (odd) parameter to new().
37 style
39 Various languages use special shortcuts to specify the patterns.
40 Instead of doing the full TeX expansion, we use Perl code to parse
41 the patterns. The style option loads TeX::Hyphen::name_of_the_style
42 module and uses the parsing functions found in it.
43 Currently, the default czech (which also works for English alright)
45 and german are available. See the TeX::Hyphen::czech man page for
46 more information, especially if you want to support other
47 languages/styles.
48 leftmin
50 The minimum starting substring which will not be hyphenated. This
51 overrides the default specified in the style file.
52 rightmin
54 The minimum ending substring which will not be hyphenated. This
55 overrides the default specified in the style file.
56 Methods that are supported
58 Method hyphenate() returns list of places where the word can be
59 divided, so
60 $hyp->visualize('representation')
62 returns list (3, 5, 8, 10).
64 Method visualize() can be used to show these points, so
66 $hyp->visualize('representation')
68 should return "rep-re-sen-ta-tion", at least for English patterns.
70 Variables $TeX::Hyphen::LEFTMIN and $TeX::Hyphen::RIGHTMIN can be used
72 to restrict minimal starting and ending substring where it is not
73 possible to hyphenate. They both default to 2 but should be changed to
74 match the paratemers used to generate the patterns.
75 Variable $TeX::Hyphen::DEBUG can be set to see some statistics and
77 processing.
78 The file with hyphenation patterns may contain "\'" and "\v" accents,
80 used in the Czech (and other) languages.
81
83 0.110 Tue Dec 11 14:26:15 MET 2001
84 Support for more languages made modular, code for German parsing
85 provided by Slaven Rezic.
86 0.101 Wed Nov 3 16:06:02 MET 1999
88 Parsing of patterns extended to allow other styles as well --
89 Spanish pattern file provided by Adrian Perez Jorge.
90 0.10 Fri Dec 11 10:58:01 MET 1998
92 Bug fixes concering LEFTMIN and RIGHTMIN values and use of
93 exceptions (thanks go to Vladimir Volovich).
94 0.06 Mon Jul 21 18:53:26 MET DST 1997
96 Exception table handling added -- error spotted by Jon Orwant.
97 0.05 Wed Jul 9 14:49:42 MET DST 1997
99 Added the default hyphen.tex into the module and possibility to
100 call the constructior without argument to get this default pattern
101 file.
102 0.04 Wed Apr 9 15:41:32 MET DST 1997
104 Hash lookup made faster.
105 Method TeX::Hyphen::visualize() only takes one argument, it calls
107 hyphenate().
108 0.03 Sun Feb 16 13:55:26 MET 1997
110 Hash lookup made faster.
111 Original name Hyphen chaged to TeX::Hyphen.
113
115 0.140
116
118 perl(1), TeX::Hyphen::czech.
119
121 (c) 1997--2002 Jan Pazdziora, adelton@fi.muni.cz at Faculty of
122 Informatics, Masaryk University, Brno
123perl v5.10.1 2002-09-24 TeX::Hyphen(3)