Parameters #Parameters

$text

(Required) (string) text to process

$patterns

(Required) (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from <a href="http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/">http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/</a>

$dictionary

(Optional) (array) Array of words to be returned without applying the hyphenation algorithm.

Default value: array()

$leftmin

(Optional) (int) Minimum number of character to leave on the left of the word without applying the hyphens.

Default value: 1

$rightmin

(Optional) (int) Minimum number of character to leave on the right of the word without applying the hyphens.

Default value: 2

$charmin

(Optional) (int) Minimum word length to apply the hyphenation algorithm.

Default value: 1

$charmax

(Optional) (int) Maximum length of broken piece of word.

Default value: 8