Go to file
George Sokianos 82ab955b04 Fix lha archive 2023-11-12 17:54:31 +00:00
doc Some cleanup 2016-04-24 14:09:03 +02:00
tests Discard too long lines in dictionary file (#14) 2017-11-27 12:19:26 +01:00
.cvsignore add .cvsignores 2010-03-04 12:19:52 +00:00
.gitignore Added Makefile to build it for AmigaOS 4 2023-01-05 23:10:29 +00:00
.travis.yml Configure Travis CI 2016-11-05 13:34:51 +01:00
AUTHORS sync 2.8.3 into CVS 2012-06-29 07:10:58 +00:00
COPYING Initia import 2010-03-04 12:13:53 +00:00
COPYING.LGPL Initia import 2010-03-04 12:13:53 +00:00
COPYING.MPL Initia import 2010-03-04 12:13:53 +00:00
ChangeLog coverity#58283 patterns vs MAXPATHS 2014-09-18 15:42:34 +00:00
Makefile.am Build DLL using cross-compilation 2016-07-23 13:06:38 +02:00
Makefile.os4 Fix lha archive 2023-11-12 17:54:31 +00:00
NEWS bump for hyphen 2.8.8 2014-09-18 15:47:14 +00:00
README Build DLL using cross-compilation 2016-07-23 13:06:38 +02:00
README.compound sync 2.8.3 into CVS 2012-06-29 07:10:58 +00:00
README.hyphen Initia import 2010-03-04 12:13:53 +00:00
README.nonstandard Initia import 2010-03-04 12:13:53 +00:00
README_hyph_en_US.txt Initia import 2010-03-04 12:13:53 +00:00
THANKS Initia import 2010-03-04 12:13:53 +00:00
TODO Initia import 2010-03-04 12:13:53 +00:00
checkme.lst Initia import 2010-03-04 12:13:53 +00:00
configure.ac Some cleanup 2016-04-24 14:09:03 +02:00
example.c hnj_hyphen_hyphword: fix buffer overflow (#13) 2017-05-02 18:00:42 +02:00
hnjalloc.c Initia import 2010-03-04 12:13:53 +00:00
hnjalloc.h Initia import 2010-03-04 12:13:53 +00:00
hyphen.c Discard too long lines in dictionary file (#14) 2017-11-27 12:19:26 +01:00
hyphen.h add missing #include <stdio.h> to hyphen.h 2014-06-30 10:22:51 +00:00
hyphen.patch Initia import 2010-03-04 12:13:53 +00:00
hyphen.tex Initia import 2010-03-04 12:13:53 +00:00
lig.awk More portable awk script 2016-11-12 00:36:06 -08:00
ligpatch.txt Initia import 2010-03-04 12:13:53 +00:00
ooopatch.sed NOHYPHEN feature, see README.compound 2010-11-27 02:20:33 +00:00
substrings.c coverity#58283 patterns vs MAXPATHS 2014-09-18 15:42:34 +00:00
substrings.pl substrings.pl: support comments (lines starting with %) 2016-05-04 14:49:54 +02:00
tbhyphext.sh Initia import 2010-03-04 12:13:53 +00:00
tbhyphext.tex Initia import 2010-03-04 12:13:53 +00:00


Hyphen - hyphenation library to use converted TeX hyphenation patterns
(C) 1998 Raph Levien
(C) 2001 ALTLinux, Moscow
(C) 2006, 2007, 2008, 2010, 2011 László Németh
This was part of libHnj library by Raph Levien.
Peter Novodvorsky from ALTLinux cut hyphenation part from libHnj
to use it in OpenOffice.org.
Compound word and non-standard hyphenation support by László Németh.
License is the original LibHnj license:
LibHnj is dual licensed under LGPL and MPL (see also README.libhnj).

Because LGPL allows GPL relicensing, COPYING contains now 
LGPL/GPL/MPL tri-license for explicit Mozilla source compatibility.

Original Libhnj source with OOo's patches are managed by Rene Engelhard
and Chris Halls at Debian:

and http://packages.debian.org/unstable/source/libhnj


This distribution is the source of the en_US hyphenation patterns
"hyph_en_US.dic", too. See README_hyph_en_US.txt.

Source files of hyph_en_US.dic in the distribution:

hyphen.tex (en_US hyphenation patterns from plain TeX)

  Source: http://tug.ctan.org/text-archive/macros/plain/base/hyphen.tex

tbhyphext.tex: hyphenation exception log from TugBoat archive

  Source of the hyphenation exception list: 

  Generated with the hyphenex script

  sh hyphenex.sh <tb0hyf.tex >tbhyphext.tex


autoreconf -fvi
make install


make check
VALGRIND=memcheck make check


./example hyph_en_US.dic mywords.txt

or (under Linux)

echo example | ./example hyph_en_US.dic /dev/stdin

NOTE: In the case of Unicode encoded input, convert your words
to lowercase before hyphenation (under UTF-8 console environment):

cat mywords.txt | awk '{print tolower($0)}' >mywordslow.txt


./configure --host i586-mingw32 --prefix=/tmp/hyphen-dll
make install


See README.hyphen for hyphenation algorithm, README.nonstandard
and doc/tb87nemeth.pdf for non-standard hyphenation,
README.compound for compound word hyphenation, and tests/*.

Description of the dictionary format:

First line contains the character encoding (ISO8859-x, UTF-8).

Possible options in the following lines:

LEFTHYPHENMIN num          minimal hyphenation distance from the left word end
RIGHTHYPHENMIN num         minimal hyphation distance from the right word end
COMPOUNDLEFTHYPHENMIN num  min. hyph. dist. from the left compound word boundary
COMPOUNDRIGHTHYPHENMIN num min. hyph. dist. from the right comp. word boundary

hyphenation patterns       see README.* files

NEXTWORD                   separate the two compound sets (see README.compound)

Default values:
Without explicite declarations, hyphenmin fields of dict struct
are zeroes, but in this case the lefthyphenmin and righthyphenmin
will be the default 2 under the hyphenation (for backward compatibility).


Use percent sign at the beginning of the lines to add comments to your
hpyhenation patterns (after the character encoding in the first line):

% comment

* Warning! Correct working of Libhnj *needs* prepared hyphenation patterns. *

For example, generating hyph_en_US.dic from "hyphen.us" TeX patterns:
perl substrings.pl hyphen.us hyph_en_US.dic ISO8859-1

or with default LEFTHYPHENMIN and RIGHTHYPHENMIN values:

perl substrings.pl hyphen.us hyph_en_US.dic ISO8859-1 2 3
perl substrings.pl hyphen.gb hyph_en_GB.dic ISO8859-1 3 3


Java hyphenation: Peter B. West (Folio project) implements a hyphenator with
non standard hyphenation facilities based on extended Libhnj. The HyFo module
is released in binary form as jar files and in source form as zip files.
See http://sourceforge.net/project/showfiles.php?group_id=119136

László Németh
<nemeth (at) numbertext (dot) org>