README

This library provides TeX-Hyphenation in PHP.

Requirements:

This package has the following requirements:

PHP-Version >= 7.2
Multibyte-Extension loaded
Input has to be UTF8-encoded.

On loading the \Org\Heigl\Hyphenator\Hyphenator-class the internal encoding for the Multibyte-String-Extension will be set to UTF8.

Installation:

This package is best installed via composer:

composer require org_heigl/hyphenator

More information can be found in the doc-section

Usage:

use \Org\Heigl\Hyphenator as h;
// Create a hyphenator-instance based on a given config-file
$hyphenator = h\Hyphenator::factory('/path/to/the/config/file.properties');

// And hyphenate a given string
echo $hyphenator->hyphenate('Hyphenation');
// Hy-phe-na-ti-on

Documentation:

More documentation can be found at http://orgheiglhyphenator.readthedocs.org/en/latest/

Build-Status of the latest release can be found at http://travis-ci.org/#!/heiglandreas/Org_Heigl_Hyphenator

Hyphenation patterns

The dictionaries in src/share/files/dictionaries come from two upstream projects, and two scripts install them:

tools/updateHyphenationFilesFromTexHyphen.sh builds the locales listed in its mapping table from the TeX hyphenation patterns of hyph-utf8. For German it also keeps the compound word list of the LibreOffice dictionary, because the patterns alone do not mark compound boundaries.
tools/updateHyphenationFilesFromLibreOffice.sh imports every locale from LibreOffice/dictionaries and then runs the hyph-utf8 script again, so the locales in its mapping table keep their hyph-utf8 dictionaries.

The hyph-utf8 script pins its sources to a commit, so a repeated run produces byte identical files. Both scripts render the <locale>.ini files the runtime reads through tools/renderDicts. Dictionaries and rendered files are committed.

src/share/files/dictionaries/SOURCES.md records the source, version, licence and pinned commit for every locale, and explains how to update the pins or migrate another locale.

Legal Stuff

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

org_heigl / hyphenator

Package info

Security

Statistics