1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/hyphenation/src/README Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,127 @@
1.4 +Hyphen - hyphenation library to use converted TeX hyphenation patterns
1.5 +
1.6 +(C) 1998 Raph Levien
1.7 +(C) 2001 ALTLinux, Moscow
1.8 +(C) 2006, 2007, 2008, 2010, 2011 László Németh
1.9 +
1.10 +This was part of libHnj library by Raph Levien.
1.11 +
1.12 +Peter Novodvorsky from ALTLinux cut hyphenation part from libHnj
1.13 +to use it in OpenOffice.org.
1.14 +
1.15 +Compound word and non-standard hyphenation support by László Németh.
1.16 +
1.17 +License is the original LibHnj license:
1.18 +LibHnj is dual licensed under LGPL and MPL (see also README.libhnj).
1.19 +
1.20 +Because LGPL allows GPL relicensing, COPYING contains now
1.21 +LGPL/GPL/MPL tri-license for explicit Mozilla source compatibility.
1.22 +
1.23 +Original Libhnj source with OOo's patches are managed by Rene Engelhard
1.24 +and Chris Halls at Debian:
1.25 +
1.26 +http://packages.debian.org/stable/libdevel/libhnj-dev
1.27 +and http://packages.debian.org/unstable/source/libhnj
1.28 +
1.29 +
1.30 +OTHER FILES
1.31 +
1.32 +This distribution is the source of the en_US hyphenation patterns
1.33 +"hyph_en_US.dic", too. See README_hyph_en_US.txt.
1.34 +
1.35 +Source files of hyph_en_US.dic in the distribution:
1.36 +
1.37 +hyphen.tex (en_US hyphenation patterns from plain TeX)
1.38 +
1.39 + Source: http://tug.ctan.org/text-archive/macros/plain/base/hyphen.tex
1.40 +
1.41 +tbhyphext.tex: hyphenation exception log from TugBoat archive
1.42 +
1.43 + Source of the hyphenation exception list:
1.44 + http://www.ctan.org/tex-archive/info/digests/tugboat/tb0hyf.tex
1.45 +
1.46 + Generated with the hyphenex script
1.47 + (http://www.ctan.org/tex-archive/info/digests/tugboat/hyphenex.sh)
1.48 +
1.49 + sh hyphenex.sh <tb0hyf.tex >tbhyphext.tex
1.50 +
1.51 +
1.52 +INSTALLATION
1.53 +
1.54 +./configure
1.55 +make
1.56 +make install
1.57 +
1.58 +UNIT TESTS (WITH VALGRIND DEBUGGER)
1.59 +
1.60 +make check
1.61 +VALGRIND=memcheck make check
1.62 +
1.63 +USAGE
1.64 +
1.65 +./example hyph_en_US.dic mywords.txt
1.66 +
1.67 +or (under Linux)
1.68 +
1.69 +echo example | ./example hyph_en_US.dic /dev/stdin
1.70 +
1.71 +NOTE: In the case of Unicode encoded input, convert your words
1.72 +to lowercase before hyphenation (under UTF-8 console environment):
1.73 +
1.74 +cat mywords.txt | awk '{print tolower($0)}' >mywordslow.txt
1.75 +
1.76 +DEVELOPMENT
1.77 +
1.78 +See README.hyphen for hyphenation algorithm, README.nonstandard
1.79 +and doc/tb87nemeth.pdf for non-standard hyphenation,
1.80 +README.compound for compound word hyphenation, and tests/*.
1.81 +
1.82 +Description of the dictionary format:
1.83 +
1.84 +First line contains the character encoding (ISO8859-x, UTF-8).
1.85 +
1.86 +Possible options in the following lines:
1.87 +
1.88 +LEFTHYPHENMIN num minimal hyphenation distance from the left word end
1.89 +RIGHTHYPHENMIN num minimal hyphation distance from the right word end
1.90 +COMPOUNDLEFTHYPHENMIN num min. hyph. dist. from the left compound word boundary
1.91 +COMPOUNDRIGHTHYPHENMIN num min. hyph. dist. from the right comp. word boundary
1.92 +
1.93 +hyphenation patterns see README.* files
1.94 +
1.95 +NEXTWORD separate the two compound sets (see README.compound)
1.96 +
1.97 +Default values:
1.98 +Without explicite declarations, hyphenmin fields of dict struct
1.99 +are zeroes, but in this case the lefthyphenmin and righthyphenmin
1.100 +will be the default 2 under the hyphenation (for backward compatibility).
1.101 +
1.102 +Comments
1.103 +
1.104 +Use percent sign at the beginning of the lines to add comments to your
1.105 +hpyhenation patterns (after the character encoding in the first line):
1.106 +
1.107 +% comment
1.108 +
1.109 +*****************************************************************************
1.110 +* Warning! Correct working of Libhnj *needs* prepared hyphenation patterns. *
1.111 +
1.112 +For example, generating hyph_en_US.dic from "hyphen.us" TeX patterns:
1.113 +
1.114 +perl substrings.pl hyphen.us hyph_en_US.dic ISO8859-1
1.115 +
1.116 +or with default LEFTHYPHENMIN and RIGHTHYPHENMIN values:
1.117 +
1.118 +perl substrings.pl hyphen.us hyph_en_US.dic ISO8859-1 2 3
1.119 +perl substrings.pl hyphen.gb hyph_en_GB.dic ISO8859-1 3 3
1.120 +****************************************************************************
1.121 +
1.122 +OTHERS
1.123 +
1.124 +Java hyphenation: Peter B. West (Folio project) implements a hyphenator with
1.125 +non standard hyphenation facilities based on extended Libhnj. The HyFo module
1.126 +is released in binary form as jar files and in source form as zip files.
1.127 +See http://sourceforge.net/project/showfiles.php?group_id=119136
1.128 +
1.129 +László Németh
1.130 +<nemeth (at) numbertext (dot) org>
