-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Configurable Knuth-Liang hyphenation
--   
--   Configurable Knuth-Liang hyphenation
@package hyphenation
@version 0.1


-- | Hyphenation based on the Knuth-Liang algorithm as used by TeX.
--   
--   The implementation is based on Ned Batchelder's public domain
--   <tt>hyphenate.py</tt> and simplified to remove the need for a manual
--   exception list.
module Text.Hyphenation

-- | Builds a hyphenator given a character normalization function and a
--   list of patterns.
--   
--   Designed to be used partially applied to all but the last argument The
--   resulting function can be used to break a word up into fragments where
--   it would be legal to hyphenate the text.
--   
--   The Knuth-Liang hyphenation algorithm isn't designed to find all such
--   points, but it does find most of them, and in particular tries avoids
--   ones where the hyphenation varies depending on the use of the word as,
--   for instance either a noun or a verb.
--   
--   <pre>
--   do en &lt;- hyphenate toLower &lt;$&gt; readHyphenationPatternFile "en.hyp"
--      return $ en "hyphenation"
--   </pre>
--   
--   <pre>
--   ["hy","phen","ation"]
--   </pre>
hyphenate :: (Char -> Char) -> [String] -> String -> [String]

-- | Load a file containing whitespace delimited patterns stripping out
--   comments lines that start with <tt>#</tt>
readHyphenationPatternFile :: String -> IO [String]

-- | Read a built-in language file from the data directory where cabal
--   installed this package.
--   
--   (e.g. <tt>hyphenateLanguage "en"</tt> opens
--   <tt>"/Users/ekmett/.cabal/lib/hyphenation-0.1/ghc-7.4.1/en.hyp"</tt>
--   when run on the author's local machine)
hyphenateLanguage :: String -> IO (String -> [String])

-- | <pre>
--   ghci&gt; hyphenateEnglish "supercalifragilisticexpialadocious"
--   ["su","per","cal","ifrag","ilis","tic","ex","pi","al","ado","cious"]
--   </pre>
hyphenateEnglish :: String -> [String]

-- | <pre>
--   ghci&gt; hyphenateFrench "anticonstitutionnellement"
--   ["an","ti","cons","ti","tu","tion","nel","le","ment"]
--   </pre>
hyphenateFrench :: String -> [String]

-- | <pre>
--   ghci&gt; hyphenateIcelandic "vaðlaheiðavegavinnuverkfærageymsluskúr"
--   ["va\240la","hei\240a","vega","vinnu","verk","f\230ra","geymslu","sk\250r"]
--   </pre>
hyphenateIcelandic :: String -> [String]