hyphenation-0.8.2: Configurable Knuth-Liang hyphenation
Copyright(C) 2012-2019 Edward Kmett
LicenseBSD-style (see the file LICENSE)
MaintainerEdward Kmett <ekmett@gmail.com>
Stabilityprovisional
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.Hyphenation.Hyphenator

Description

Hyphenation based on the Knuth-Liang algorithm as used by TeX.

Synopsis

Documentation

data Hyphenator Source #

A Hyphenator is combination of an alphabet normalization scheme, a set of Patterns, a set of Exceptions to those patterns and a number of characters at each end to skip hyphenating.

Constructors

Hyphenator 

Fields

Hyphenate with a given set of patterns

hyphenate :: Hyphenator -> String -> [String] Source #

hyphenate a single word using the specified Hyphenator. Returns a set of candidate breakpoints by decomposing the input into substrings.

>>> import Text.Hyphenation
>>> hyphenate english_US "supercalifragilisticexpialadocious"
["su","per","cal","ifrag","ilis","tic","ex","pi","al","ado","cious"]
>>> hyphenate english_US "hyphenation"
["hy","phen","ation"]