HyFo: Release Notes

Version Number

The version number of the release is 1.0.0.

This is the first release of the HyFo hyphenation package. The release comprises the HyFo driver jar, hyfo.jar, the javadocs, hyfo-javadocs.zip, and a number of jars containing the hyphenation tree for a particular licence regime, language, language_country, or language_qualifersetting.

System Requirements

Execution requires a Java 5 JRE, or later. Development requires a Java 5 JDK, or later. This release was compiled using NetBeans 5.5 running on the Sun Java 1.5.0_09 JDK.

Features

See the HyFo home page.

FOP compatibility

The class au.id.pbw.hyfo.hyph.HyphenatedWord contains some fop compatibility methods; namely

  • int[] get_fop_compatible_points()
  • String get_fop_pre_hyphen(int offset)
  • String get_fop_post_hyphen(int offset)
  • String to_fop_string()

Performance

Raw hyphenation performance is more than 50% faster than Fop's. Tested on an English word list of 131983 words, Fop hyphenated all of the words in approx. 1330ms. HyFo processed the list in approx. 830ms.

There is a price to be paid for this hyphenation performance. The hyphenation trees are larger than the corresponding Fop files. For example, the jar file containing the serialized (old) German file is 200291 bytes vs 87709, while the British file is 143666 vs 126340.

This difference in file size translates into a one-off deserialization hit very much greater than Fop's. Deserializing the en_GB file takes approximately 6ms in Fop, but 120ms in HyFo.

Documentation

See the HyFo home page.

Supported Languages

Public Key

The public key used to sign this package can be retrieved from the keyserver <pgp.mit.edu>.

Public Key Server -- Index ``pbw@pbw.id.au ''
Type bits /keyID    Date       User ID pub  1024D/B7FC034D 2006/05/10 Peter B. West (pbw) <pbw@pbw.id.au>
Key fingerprint = 2F1D F374 18FD 9B5D 7858 2850 8685 2751 B7FC 034D

Licence Type
Language
Apache
dk
Danish
GPL
cs
Czech

sk
Slovakia

ga_IE
Irish Gaelic
LGPL
hu
Hungarian1
Knuth
en_US
US English

en_US_18
US English2
LaTeX Project Public Licence (LPPL)
de
German (old)

de_DR3
German (reformed)

es
Spanish
Derived from LPPL
en_GB
British English

en_GB_18
British English2

fr
French
Public Domain
fi
Finnish

1 Contains extensive re-spelling hyphenation derived from the OpenOffice hyphenation pattern files.

2 Contains re-spelling hyphenation of "eighteen" and derivatives.

3 This language specifier follows the Fop usage. I am unaware of the rationale.

HyFo logo 48x48
Penn Library LogoLast modified: 20 January 2007
Folio Logo by permission of Schoenberg Center for Electronic Text & Image