Configuration
Make the settings for Hyphenator. Leave empty textfields empty for the default value to be set. If no special configuration is made, there will be no Hyphenator.config(); function in the output.
Don't hyphenate words shorter than this value (leave empty for default value 6)
A value lesser than 4 makes no sense. By increasing this value lesser words will be hyphenated, thus, there's a small speed gain.
The hyphen char for words (leave empty for ­)
The hyphen char for URLs and E-Mail (leave empty for zero width space)
Enable remote loading of language patterns.
By enabling remote loading Hyphenator will automatically load language patterns of supported languages when they are needed.
If you turn off remote loading Hyphenator only hyphenates texts in languages it has the patterns for. Make sure you have them selected!
Enable cache
Once a word is hyphenated it is cached, thus a word has only to be hyphenated once. You can turn this mechanism off – mainly for performance-measuring.
hidden
visible
Define intermediate state (style.visibility of elements while they are hyphenated).
Since Javascript is executed after the page is loaded, the user may see the unhyphenated text for a short time befor it is hyphenated and redrawn. To prevent this all textblocks treated by Hyphenator are set to invisible upon hyphenation (setting: "hidden"). The result is, that only hyphenated text is displayed.
On the other hand – if there's an error in the execution of Hyphenator.js – the text may stay invisible. Turn hiding off for debugging or if you prefer to see the redrawing of the text (setting: "visible").
Element Selection
Indicate how to get the elements for hyphenation:
Standard: Collecting elements by a classname
Custom: Collecting elements by a custom Selector-Function
indicate a classname (leave empty for default "hyphenate")
Selector Function:
Using this method Hyphenator.js searches the DOM for elements with the indicated classname. Note: an element can have multiple classnames; separate them with spaces (e.g. <div class="content hyphenate">)
If you want to have more control over the element selection you may define your own selector function. It has to return an array of elements to be hyphenated. Specifially if you use a JavaScript-Framework, this may be very interesting…
Indicate a classname for elements that should NOT be hyphenated:
indicate a classname (leave empty for default "donthyphenate")
You can turn off hyphenation for elements with the indicated classname. (Note: The following elements are never hyphenated: script, code, pre, img, br, samp, kbd, var, abbr, acronym, sub, sup, button, option, label, textarea)
Toggle Box
Indicate how the Togglebox should be displayed:
Display Toggle Box
The standard togglebox is a small button in the upper right corner of the page. By clicking on it, the user can turn off/on hyphenation. This is useful for copying or searching text on the site.
Since the standard togglebox may interfere with the design of your page, you can define it on your own.
Special Settings
Trigger callback function when hyphenation is done
onhyphenationdonecallback function:
This function is called, when hyphenation of a page is completed.
Overwrite onerrorhandler
onerrorhandler function:
Most errors are catched and catched errors dipatch the onerror function. By default there's an alert with a predefined text. You can change this function.
Minify
By minifying the resulting script you can save some bandwith. This page uses the JavaScript-Version of jsmin since it's easy to run on a webpage. You may achieve better results if you pack the resulting script with other minifiers/packers such as YUI Compressor or Dean Edwards' packer .
pack with jsmin
Level
1 - minimal
2 - normal
3 - aggressive