/*!
* Hyphenator 2.4.0 - client side hyphenation for webbrowsers
* Copyright (C) 2009 Mathias Nater, Zürich (mathias at mnn dot ch)
* Project and Source hosted on http://code.google.com/p/hyphenator/
*
* This JavaScript code is free software: you can redistribute
* it and/or modify it under the terms of the GNU Lesser
* General Public License (GNU LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option)
* any later version. The code is distributed WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
*
* As additional permission under GNU GPL version 3 section 7, you
* may distribute non-source (e.g., minimized or compacted) forms of
* that code without the copy of the GNU GPL normally required by
* section 4, provided you include this license notice and a URL
* through which recipients can access the Corresponding Source.
*/
/*
* Comments are jsdoctoolkit formatted. See jsdoctoolkit.org
*/
/* The following comment is for JSLint: */
/*global window, ActiveXObject, unescape */
/*jslint browser: true, eqeqeq: true, immed: true, newcap: true, nomen: true, onevar: true, undef: true, white: true, indent: 4*/
/**
* @fileOverview
* A script that does hyphenation in (X)HTML files
* @author Mathias Nater, mathias@mnn.ch
* @version 2.4.0
*/
/**
* @constructor
* @description Provides all functionality to do hyphenation, except the patterns that are loaded
* externally.
* @namespace Holds all methods and properties
* @example
* <script src = "Hyphenator.js" type = "text/javascript"></script>
* <script type = "text/javascript">
* Hyphenator.run();
* </script>
*/
var Hyphenator = (function () {
/**
* @name Hyphenator-languageHint
* @fieldOf Hyphenator
* @description
* A string to be displayed in a prompt if the language can't be guessed.
* If you add hyphenation patterns change this string.
* Internally, this string is used to define languages that are supported by Hyphenator.
* @see Hyphenator-supportedLang
* @type string
* @private
* @see Hyphenator-autoSetMainLanguage
*/
var languageHint = 'cs, da, bn, de, en, es, fi, fr, gu, hi, hu, it, kn, ml, nl, or, pa, pl, pt, ru, sv, ta, te, tr, uk',
/**
* @name Hyphenator-supportedLang
* @fieldOf Hyphenator
* @description
* A generated key-value object that stores supported languages.
* The languages are retrieved from {@link Hyphenator-languageHint}.
* @type object
* @private
* @example
* Check if language lang is supported:
* if (supportedLang[lang])
*/
supportedLang = (function () {
var k, i = 0, a = languageHint.split(', '), r = {};
while (!!(k = a[i++])) {
r[k] = true;
}
return r;
}()),
/**
* @name Hyphenator-prompterStrings
* @fieldOf Hyphenator
* @description
* A key-value object holding the strings to be displayed if the language can't be guessed
* If you add hyphenation patterns change this string.
* @type object
* @private
* @see Hyphenator-autoSetMainLanguage
*/
prompterStrings = {
'cs': 'Jazyk této internetové stránky nebyl automaticky rozpoznán. Určete prosím její jazyk:',
'da': 'Denne websides sprog kunne ikke bestemmes. Angiv venligst sprog:',
'de': 'Die Sprache dieser Webseite konnte nicht automatisch bestimmt werden. Bitte Sprache angeben:',
'en': 'The language of this website could not be determined automatically. Please indicate the main language:',
'es': 'El idioma del sitio no pudo determinarse autom%E1ticamente. Por favor, indique el idioma principal:',
'fi': 'Sivun kielt%E4 ei tunnistettu automaattisesti. M%E4%E4rit%E4 sivun p%E4%E4kieli:',
'fr': 'La langue de ce site n%u2019a pas pu %EAtre d%E9termin%E9e automatiquement. Veuillez indiquer une langue, s.v.p.%A0:',
'hu': 'A weboldal nyelvét nem sikerült automatikusan megállapítani. Kérem adja meg a nyelvet:',
'it': 'Lingua del sito sconosciuta. Indicare una lingua, per favore:',
'ml': 'ഈ വെ%u0D2C%u0D4D%u200Cസൈറ്റിന്റെ ഭാഷ കണ്ടുപിടിയ്ക്കാ%u0D28%u0D4D%u200D കഴിഞ്ഞില്ല. ഭാഷ ഏതാണെന്നു തിരഞ്ഞെടുക്കുക:',
'nl': 'De taal van deze website kan niet automatisch worden bepaald. Geef de hoofdtaal op:',
'pt': 'A língua deste site não pôde ser determinada automaticamente. Por favor indique a língua principal:',
'ru': 'Язык этого сайта не может быть определен автоматически. Пожалуйста укажите язык:',
'sv': 'Spr%E5ket p%E5 den h%E4r webbplatsen kunde inte avg%F6ras automatiskt. V%E4nligen ange:',
'tr': 'Bu web sitesinin dilini otomatik olarak tespit edilememiştir. Lütfen ana dili gösterir:',
'uk': 'Мова цього веб-сайту не може бути визначена автоматично. Будь ласка, вкажіть головну мову:'
},
/**
* @name Hyphenator-basePath
* @fieldOf Hyphenator
* @description
* A string storing the basepath from where Hyphenator.js was loaded.
* This is used to load the patternfiles.
* The basepath is determined dynamically by searching all script-tags for Hyphenator.js
* If the path cannot be determined http://hyphenator.googlecode.com/svn/trunk/ is used as fallback.
* @type string
* @private
* @see Hyphenator-loadPatterns
*/
basePath = (function () {
var s = document.getElementsByTagName('script'), i = 0, p, src, t;
while (!!(t = s[i++])) {
if (!t.src) {
continue;
}
src = t.src;
p = src.indexOf('Hyphenator.htm');
if (p !== -1) {
return src.substring(0, p);
}
}
return 'http://hyphenator.googlecode.com/svn/trunk/';
}()),
/**
* @name Hyphenator-isLocal
* @fieldOf Hyphenator
* @description
* isLocal is true, if Hyphenator is loaded from the same domain, as the webpage, but false, if
* it's loaded from an external source (i.e. directly from google.code)
*/
isLocal = (function () {
var re = false;
if (window.location.href.indexOf(basePath) !== -1) {
re = true;
}
return re;
}()),
/**
* @name Hyphenator-documentLoaded
* @fieldOf Hyphenator
* @description
* documentLoaded is true, when the DOM has been loaded. This is set by runOnContentLoaded
*/
documentLoaded = false,
/**
* @name Hyphenator-dontHyphenate
* @fieldOf Hyphenator
* @description
* A key-value object containing all html-tags whose content should not be hyphenated
* @type object
* @private
* @see Hyphenator-hyphenateElement
*/
dontHyphenate = {'script': true, 'code': true, 'pre': true, 'img': true, 'br': true, 'samp': true, 'kbd': true, 'var': true, 'abbr': true, 'acronym': true, 'sub': true, 'sup': true, 'button': true, 'option': true, 'label': true, 'textarea': true},
/**
* @name Hyphenator-enableCache
* @fieldOf Hyphenator
* @description
* A variable to set if caching is enabled or not
* @type boolean
* @default true
* @private
* @see Hyphenator.config
* @see hyphenateWord
*/
enableCache = true,
/**
* @name Hyphenator-enableRemoteLoading
* @fieldOf Hyphenator
* @description
* A variable to set if pattern files should be loaded remotely or not
* @type boolean
* @default true
* @private
* @see Hyphenator.config
* @see Hyphenator-loadPatterns
*/
enableRemoteLoading = true,
/**
* @name Hyphenator-displayToggleBox
* @fieldOf Hyphenator
* @description
* A variable to set if the togglebox should be displayed or not
* @type boolean
* @default false
* @private
* @see Hyphenator.config
* @see Hyphenator-toggleBox
*/
displayToggleBox = false,
/**
* @name Hyphenator-hyphenateClass
* @fieldOf Hyphenator
* @description
* A string containing the css-class-name for the hyphenate class
* @type string
* @default 'hyphenate'
* @private
* @example
* <p class = "hyphenate">Text</p>
* @see Hyphenator.config
*/
hyphenateClass = 'hyphenate',
/**
* @name Hyphenator-dontHyphenateClass
* @fieldOf Hyphenator
* @description
* A string containing the css-class-name for elements that should not be hyphenated
* @type string
* @default 'donthyphenate'
* @private
* @example
* <p class = "donthyphenate">Text</p>
* @see Hyphenator.config
*/
dontHyphenateClass = 'donthyphenate',
/**
* @name Hyphenator-min
* @fieldOf Hyphenator
* @description
* A number wich indicates the minimal length of words to hyphenate.
* @type number
* @default 6
* @private
* @see Hyphenator.config
*/
min = 6,
/**
* @name Hyphenator-isBookmarklet
* @fieldOf Hyphenator
* @description
* Indicates if Hyphanetor runs as bookmarklet or not.
* @type boolean
* @default false
* @private
*/
isBookmarklet = (function () {
var loc = null, re = false, jsArray = document.getElementsByTagName('script'), i, l;
for (i = 0, l = jsArray.length; i < l; i++) {
if (!!jsArray[i].getAttribute('src')) {
loc = jsArray[i].getAttribute('src');
}
if (!loc) {
continue;
} else if (loc.indexOf('Hyphenator.htm?bm=true') !== -1) {
re = true;
}
}
return re;
}()),
/**
* @name Hyphenator-mainLanguage
* @fieldOf Hyphenator
* @description
* The general language of the document
* @type number
* @private
* @see Hyphenator-autoSetMainLanguage
*/
mainLanguage = null,
/**
* @name Hyphenator-elements
* @fieldOf Hyphenator
* @description
* An array holding all elements that have to be hyphenated. This var is filled by
* {@link Hyphenator-gatherDocumentInfos}
* @type array
* @private
*/
elements = [],
/**
* @name Hyphenator-exceptions
* @fieldOf Hyphenator
* @description
* An object containing exceptions as comma separated strings for each language.
* When the language-objects are loaded, their exceptions are processed, copied here and then deleted.
* @see Hyphenator-prepareLanguagesObj
* @type object
* @private
*/
exceptions = {},
/**
* @name Hyphenator-docLanguages
* @fieldOf Hyphenator
* @description
* An object holding all languages used in the document. This is filled by
* {@link Hyphenator-gatherDocumentInfos}
* @type object
* @private
*/
docLanguages = {},
/**
* @name Hyphenator-state
* @fieldOf Hyphenator
* @description
* A number that inidcates the current state of the script
* 0: not initialized
* 1: loading patterns
* 2: ready
* 3: hyphenation done
* 4: hyphenation removed
* @type number
* @private
*/
state = 0,
/**
* @name Hyphenator-url
* @fieldOf Hyphenator
* @description
* A string containing a RegularExpression to match URL's
* @type string
* @private
*/
url = '(\\w*:\/\/)?((\\w*:)?(\\w*)@)?((([\\d]{1,3}\\.){3}([\\d]{1,3}))|(([\\w]*\\.)+([\\w]{2,4})))(:\\d*)?(\/[\\w#!:\\.?\\+=&%@!\\-]*)*',
/**
* @name Hyphenator-mail
* @fieldOf Hyphenator
* @description
* A string containing a RegularExpression to match mail-adresses
* @type string
* @private
*/
mail = '[\\w-\\.]+@[\\w\\.]+',
/**
* @name Hyphenator-urlRE
* @fieldOf Hyphenator
* @description
* A RegularExpressions-Object for url- and mail adress matching
* @type object
* @private
*/
urlOrMailRE = new RegExp('(' + url + ')|(' + mail + ')', 'i'),
/**
* @name Hyphenator-zeroWidthSpace
* @fieldOf Hyphenator
* @description
* A string that holds a char.
* Depending on the browser, this is the zero with space or an empty string.
* The zeroWidthSpace is inserted after a '-' in compound words, so even FF and IE
* will break after a '-' if necessary.
* zeroWidthSpace is also used to break URLs
* @type string
* @private
*/
zeroWidthSpace = (function () {
var zws, ua = navigator.userAgent.toLowerCase();
if (ua.indexOf('msie 6') === -1) {
zws = String.fromCharCode(8203); //Unicode zero width space
} else {
zws = ''; //IE6 doesn't support zws
}
return zws;
}()),
/**
* @name Hyphenator-onHyphenationDone
* @fieldOf Hyphenator
* @description
* A method to be called, when the last element has been hyphenated or the hyphenation has been
* removed from the last element.
* @see Hyphenator.config
* @type function
* @private
*/
onHyphenationDone = function () {},
/**
* @name Hyphenator-onError
* @fieldOf Hyphenator
* @description
* A function that can be called upon an error.
* @see Hyphenator.config
* @type function
* @private
*/
onError = function (e) {
alert("Hyphenator.htm says:\n\nAn Error ocurred:\n" + e.message);
},
/**
* @name Hyphenator-selectorFunction
* @fieldOf Hyphenator
* @description
* A function that has to return a HTMLNodeList of Elements to be hyphenated.
* By default it uses the classname ('hyphenate') to select the elements.
* @see Hyphenator.config
* @type function
* @private
*/
selectorFunction = function () {
var tmp, el = [], i, l;
if (document.getElementsByClassName) {
el = document.getElementsByClassName(hyphenateClass);
} else {
tmp = document.getElementsByTagName('*');
l = tmp.length;
for (i = 0; i < l; i++)
{
if (tmp[i].className.indexOf(hyphenateClass) !== -1 && tmp[i].className.indexOf(dontHyphenateClass) === -1) {
el.push(tmp[i]);
}
}
}
return el;
},
/**
* @name Hyphenator-intermediateState
* @fieldOf Hyphenator
* @description
* The value of style.visibility of the text while it is hyphenated.
* @see Hyphenator.config
* @type string
* @private
*/
intermediateState = 'hidden',
/**
* @name Hyphenator-hyphen
* @fieldOf Hyphenator
* @description
* A string containing the character for in-word-hyphenation
* @type string
* @default the soft hyphen
* @private
* @see Hyphenator.config
*/
hyphen = String.fromCharCode(173),
/**
* @name Hyphenator-urlhyphen
* @fieldOf Hyphenator
* @description
* A string containing the character for url/mail-hyphenation
* @type string
* @default the zero width space
* @private
* @see Hyphenator.config
* @see Hyphenator-zeroWidthSpace
*/
urlhyphen = zeroWidthSpace,
/**
* @name Hyphenator-Expando
* @methodOf Hyphenator
* @description
* This custom object stores data for elements: storing data directly in elements
* (DomElement.customData = foobar;) isn't a good idea. It would lead to conflicts
* in form elements, when the form has a child with name="foobar". Therefore, this
* solution follows the approach of jQuery: the data is stored in an object and
* referenced by a unique attribute of the element. The attribute has a name that
* is built by the prefix "HyphenatorExpando_" and a random number, so if the very
* very rare case occurs, that there's already an attribute with the same name, a
* simple reload is enough to make it function.
* @private
*/
Expando = (function () {
var container = {},
name = "HyphenatorExpando_" + Math.random(),
uuid = 0;
return {
getDataForElem : function (elem) {
return container[elem[name]];
},
setDataForElem : function (elem, data) {
var id;
if (elem[name] && elem[name] !== '') {
id = elem[name];
} else {
id = uuid++;
elem[name] = id;
}
container[id] = data;
},
appendDataForElem : function (elem, data) {
var k;
for (k in data) {
if (data.hasOwnProperty(k)) {
container[elem[name]][k] = data[k];
}
}
},
delDataOfElem : function (elem) {
delete container[elem[name]];
}
};
}()),
/*
* runOnContentLoaded is based od jQuery.bindReady()
* see
* jQuery JavaScript Library v1.3.2
* http://jquery.com/
*
* Copyright (c) 2009 John Resig
* Dual licensed under the MIT and GPL licenses.
* http://docs.jquery.com/License
*
* Date: 2009-02-19 17:34:21 -0500 (Thu, 19 Feb 2009)
* Revision: 6246
*/
/**
* @name Hyphenator-runOnContentLoaded
* @methodOf Hyphenator
* @description
* A crossbrowser solution for the DOMContentLoaded-Event based on jQuery
*
* lang-attribute in the html-tag
* <meta http-equiv = "content-language" content = "xy" />
* <meta name = "DC.Language" content = "xy" />
* <meta name = "language" content = "xy" />
*
* If nothing can be found a prompt using {@link Hyphenator-languageHint} and {@link Hyphenator-prompterStrings} is displayed.
* If the retrieved language is in the object {@link Hyphenator-supportedLang} it is copied to {@link Hyphenator-mainLanguage}
* @private
*/
autoSetMainLanguage = function () {
var el = document.getElementsByTagName('html')[0],
m = document.getElementsByTagName('meta'),
i, text, lang, e, ul;
mainLanguage = getLang(el);
if (!mainLanguage) {
for (i = 0; i < m.length; i++) {
//
if (!!m[i].getAttribute('http-equiv') && (m[i].getAttribute('http-equiv') === 'content-language')) {
mainLanguage = m[i].getAttribute('content').substring(0, 2).toLowerCase();
}
//
if (!!m[i].getAttribute('name') && (m[i].getAttribute('name') === 'DC.language')) {
mainLanguage = m[i].getAttribute('content').substring(0, 2).toLowerCase();
}
//
if (!!m[i].getAttribute('name') && (m[i].getAttribute('name') === 'language')) {
mainLanguage = m[i].getAttribute('content').substring(0, 2).toLowerCase();
}
}
}
if (!mainLanguage) {
text = '';
ul = navigator.language ? navigator.language : navigator.userLanguage;
ul = ul.substring(0, 2);
if (prompterStrings.hasOwnProperty(ul)) {
text = prompterStrings[ul];
} else {
text = prompterStrings.en;
}
text += ' (ISO 639-1)\n\n' + languageHint;
//lang = window.prompt(unescape(text), ul).toLowerCase();
//if (supportedLang[lang]) {
// mainLanguage = lang;
//} else {
// e = new Error('The language "' + lang + '" is not yet supported.');
// throw e;
//}
mainLanguage = "hu";
}
},
/**
* @name Hyphenator-gatherDocumentInfos
* @methodOf Hyphenator
* @description
* This method runs through the DOM and executes the process()-function on:
* - every node returned by the {@link Hyphenator-selectorFunction}.
* The process()-function copies the element to the elements-variable, sets its visibility
* to intermediateState, retrieves its language and recursivly descends the DOM-tree until
* the child-Nodes aren't of type 1
* @private
*/
gatherDocumentInfos = function () {
var elToProcess, tmp, i = 0,
process = function (el, hide, lang) {
var n, i = 0, hyphenatorSettings = {};
if (hide && intermediateState === 'hidden') {
if (!!el.getAttribute('style')) {
hyphenatorSettings.hasOwnStyle = true;
} else {
hyphenatorSettings.hasOwnStyle = false;
}
hyphenatorSettings.isHidden = true;
el.style.visibility = 'hidden';
}
if (el.lang && typeof(el.lang) === 'string') {
hyphenatorSettings.language = el.lang.toLowerCase(); //copy attribute-lang to internal lang
} else if (lang) {
hyphenatorSettings.language = lang.toLowerCase();
} else {
hyphenatorSettings.language = getLang(el, true);
}
lang = hyphenatorSettings.language;
if (supportedLang[lang]) {
docLanguages[lang] = true;
} else {
onError(new Error('Language ' + lang + ' is not yet supported.'));
}
Expando.setDataForElem(el, hyphenatorSettings);
elements.push(el);
while (!!(n = el.childNodes[i++])) {
if (n.nodeType === 1 && !dontHyphenate[n.nodeName.toLowerCase()] &&
n.className.indexOf(dontHyphenateClass) === -1 && !(n in elToProcess)) {
process(n, false, lang);
}
}
};
if (Hyphenator.isBookmarklet()) {
elToProcess = document.getElementsByTagName('body')[0];
process(elToProcess, false, mainLanguage);
} else {
elToProcess = selectorFunction();
while (!!(tmp = elToProcess[i++]))
{
process(tmp, true);
}
}
if (!Hyphenator.languages.hasOwnProperty(mainLanguage)) {
docLanguages[mainLanguage] = true;
} else if (!Hyphenator.languages[mainLanguage].prepared) {
docLanguages[mainLanguage] = true;
}
if (elements.length > 0) {
Expando.appendDataForElem(elements[elements.length - 1], {isLast : true});
}
},
/**
* @name Hyphenator-convertPatterns
* @methodOf Hyphenator
* @description
* Converts the patterns from string '_a6' to object '_a':'_a6'.
* The result is stored in the {@link Hyphenator-patterns}-object.
* @private
* @param string the language whose patterns shall be converted
*/
convertPatterns = function (lang) {
var plen, anfang, pats, pat, key, tmp = {};
pats = Hyphenator.languages[lang].patterns;
for (plen in pats) {
if (pats.hasOwnProperty(plen)) {
plen = parseInt(plen, 10);
anfang = 0;
while (!!(pat = pats[plen].substr(anfang, plen))) {
key = pat.replace(/\d/g, '');
tmp[key] = pat;
anfang += plen;
}
}
}
Hyphenator.languages[lang].patterns = tmp;
Hyphenator.languages[lang].patternsConverted = true;
},
/**
* @name Hyphenator-convertExceptionsToObject
* @methodOf Hyphenator
* @description
* Converts a list of comma seprated exceptions to an object:
* 'Fortran,Hy-phen-a-tion' -> {'Fortran':'Fortran','Hyphenation':'Hy-phen-a-tion'}
* @private
* @param string a comma separated string of exceptions (without spaces)
*/
convertExceptionsToObject = function (exc) {
var w = exc.split(', '),
r = {},
i, l, key;
for (i = 0, l = w.length; i < l; i++) {
key = w[i].replace(/-/g, '');
if (!r.hasOwnProperty(key)) {
r[key] = w[i];
}
}
return r;
},
/**
* @name Hyphenator-loadPatterns
* @methodOf Hyphenator
* @description
* Adds a <script>-Tag to the DOM to load an externeal .js-file containing patterns and settings for the given language.
* If the iven language is not in the {@link Hyphenator-supportedLang}-Object it returns.
* One may ask why we are not using AJAX to load the patterns. The XMLHttpRequest-Object
* has a same-origin-policy. This makes the isBookmarklet-functionality impossible.
* @param string The language to load the patterns for
* @private
* @see Hyphenator-basePath
*/
loadPatterns = function (lang) {
var url, xhr, head, script;
if (supportedLang[lang] && !Hyphenator.languages[lang]) {
url = basePath + lang + '.htm';
} else {
return;
}
if (isLocal && !isBookmarklet) {
//check if 'url' is available:
xhr = null;
if (typeof XMLHttpRequest !== 'undefined') {
xhr = new XMLHttpRequest();
}
if (!xhr) {
try {
xhr = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
xhr = null;
}
}
if (xhr) {
xhr.open('HEAD', url, false);
xhr.setRequestHeader('Cache-Control', 'no-cache');
xhr.send(null);
if (xhr.status === 404) {
onError(new Error('Could not load\n' + url));
delete docLanguages[lang];
return;
}
}
}
if (document.createElement) {
head = document.getElementsByTagName('head').item(0);
script = document.createElement('script');
script.src = url;
script.type = 'text/javascript';
head.appendChild(script);
}
},
/**
* @name Hyphenator-prepareLanguagesObj
* @methodOf Hyphenator
* @description
* Adds a cache to each language and converts the exceptions-list to an object.
* @private
* @param string the language ob the lang-obj
*/
prepareLanguagesObj = function (lang) {
var lo = Hyphenator.languages[lang], wrd;
if (!lo.prepared) {
if (enableCache) {
lo.cache = {};
}
if (lo.hasOwnProperty('exceptions')) {
Hyphenator.addExceptions(lang, lo.exceptions);
delete lo.exceptions;
}
if (exceptions.hasOwnProperty('global')) {
if (exceptions.hasOwnProperty(lang)) {
exceptions[lang] += ', ' + exceptions.global;
} else {
exceptions[lang] = exceptions.global;
}
}
if (exceptions.hasOwnProperty(lang)) {
lo.exceptions = convertExceptionsToObject(exceptions[lang]);
delete exceptions[lang];
} else {
lo.exceptions = {};
}
convertPatterns(lang);
wrd = '[\\w' + lo.specialChars + '@' + String.fromCharCode(173) + '-]{' + min + ',}';
lo.genRegExp = new RegExp('(' + url + ')|(' + mail + ')|(' + wrd + ')', 'gi');
lo.prepared = true;
}
},
/**
* @name Hyphenator-prepare
* @methodOf Hyphenator
* @description
* This funtion prepares the Hyphenator-Object: If RemoteLoading is turned off, it assumes
* that the patternfiles are loaded, all conversions are made and the callback is called.
* If RemoteLoading is on (default), it loads the pattern files and waits until they are loaded,
* by repeatedly checking Hyphenator.languages. If a patterfile is loaded the patterns are
* converted to their object style and the lang-object extended.
* Finally the callback is called.
* @param function-object callback to call, when all patterns are loaded
* @private
*/
prepare = function (callback) {
var lang, docLangEmpty = true, interval;
if (!enableRemoteLoading) {
for (lang in Hyphenator.languages) {
if (Hyphenator.languages.hasOwnProperty(lang)) {
prepareLanguagesObj(lang);
}
}
state = 2;
callback();
return;
}
// get all languages that are used and preload the patterns
state = 1;
for (lang in docLanguages) {
if (docLanguages.hasOwnProperty(lang)) {
loadPatterns(lang);
docLangEmpty = false;
}
}
if (docLangEmpty) {
state = 2;
callback();
return;
}
// wait until they are loaded
interval = window.setInterval(function () {
var finishedLoading = false, lang;
for (lang in docLanguages) {
if (docLanguages.hasOwnProperty(lang)) {
if (!Hyphenator.languages[lang]) {
finishedLoading = false;
break;
} else {
finishedLoading = true;
delete docLanguages[lang];
//do conversion while other patterns are loading:
prepareLanguagesObj(lang);
}
}
}
if (finishedLoading) {
window.clearInterval(interval);
state = 2;
callback();
}
}, 100);
},
/**
* @name Hyphenator-switchToggleBox
* @methodOf Hyphenator
* @description
* Creates or hides the toggleBox: a small button to turn off/on hyphenation on a page.
* @param boolean true when hyphenation is on, false when it's off
* @see Hyphenator.config
* @private
*/
toggleBox = function (s) {
var myBox, bdy, myIdAttribute, myTextNode, myClassAttribute;
if (!!(myBox = document.getElementById('HyphenatorToggleBox'))) {
if (s) {
myBox.firstChild.data = 'Hy-phe-na-ti-on';
} else {
myBox.firstChild.data = 'Hyphenation';
}
} else {
bdy = document.getElementsByTagName('body')[0];
myBox = document.createElement('div');
myIdAttribute = document.createAttribute('id');
myIdAttribute.nodeValue = 'HyphenatorToggleBox';
myClassAttribute = document.createAttribute('class');
myClassAttribute.nodeValue = dontHyphenateClass;
myTextNode = document.createTextNode('Hy-phe-na-ti-on');
myBox.appendChild(myTextNode);
myBox.setAttributeNode(myIdAttribute);
myBox.setAttributeNode(myClassAttribute);
myBox.onclick = Hyphenator.toggleHyphenation;
myBox.style.position = 'absolute';
myBox.style.top = '0px';
myBox.style.right = '0px';
myBox.style.margin = '0';
myBox.style.backgroundColor = '#AAAAAA';
myBox.style.color = '#FFFFFF';
myBox.style.font = '6pt Arial';
myBox.style.letterSpacing = '0.2em';
myBox.style.padding = '3px';
myBox.style.cursor = 'pointer';
myBox.style.WebkitBorderBottomLeftRadius = '4px';
myBox.style.MozBorderRadiusBottomleft = '4px';
bdy.appendChild(myBox);
}
},
/**
* @name Hyphenator-hyphenateWord
* @methodOf Hyphenator
* @description
* This function is the heart of Hyphenator.js. It returns a hyphenated word.
*
* If there's already a {@link Hyphenator-hypen} in the word, the word is returned as it is.
* If the word is in the exceptions list or in the cache, it is retrieved from it.
* If there's a '-' put a zeroWidthSpace after the '-' and hyphenate the parts.
* @param string The language of the word
* @param string The word
* @returns string The hyphenated word
* @public
*/
hyphenateWord = function (lang, word) {
var lo = Hyphenator.languages[lang],
parts, i, l, w, wl, s, hypos, p, maxwins, win, pat = false, patk, patl, c, digits, z, numb3rs, n, inserted, hyphenatedword;
if (word === '') {
return '';
}
if (word.indexOf(hyphen) !== -1) {
//word already contains shy; -> leave at it is!
return word;
}
if (enableCache && lo.cache.hasOwnProperty(word)) { //the word is in the cache
return lo.cache[word];
}
if (lo.exceptions.hasOwnProperty(word)) { //the word is in the exceptions list
return lo.exceptions[word].replace(/-/g, hyphen);
}
if (word.indexOf('-') !== -1) {
//word contains '-' -> hyphenate the parts separated with '-'
parts = word.split('-');
for (i = 0, l = parts.length; i < l; i++) {
parts[i] = hyphenateWord(lang, parts[i]);
}
return parts.join('-');
}
//finally the core hyphenation algorithm
w = '_' + word + '_';
wl = w.length;
s = w.split('');
w = w.toLowerCase();
hypos = [];
numb3rs = {'0': true, '1': true, '2': true, '3': true, '4': true, '5': true, '6': true, '7': true, '8': true, '9': true}; //check for member is faster then isFinite()
n = wl - lo.shortestPattern;
for (p = 0; p <= n; p++) {
maxwins = Math.min((wl - p), lo.longestPattern);
for (win = lo.shortestPattern; win <= maxwins; win++) {
if (lo.patterns.hasOwnProperty(patk = w.substr(p, win))) {
pat = lo.patterns[patk];
} else {
continue;
}
digits = 1;
patl = pat.length;
for (i = 0; i < patl; i++) {
c = pat.charAt(i);
if (numb3rs[c]) {
if (i === 0) {
z = p - 1;
if (!hypos[z] || hypos[z] < c) {
hypos[z] = c;
}
} else {
z = p + i - digits;
if (!hypos[z] || hypos[z] < c) {
hypos[z] = c;
}
}
digits++;
}
}
}
}
inserted = 0;
for (i = lo.leftmin; i <= (word.length - lo.rightmin); i++) {
if (!!(hypos[i] & 1)) {
s.splice(i + inserted + 1, 0, hyphen);
inserted++;
}
}
hyphenatedword = s.slice(1, -1).join('');
if (enableCache) {
lo.cache[word] = hyphenatedword;
}
return hyphenatedword;
},
/**
* @name Hyphenator-hyphenateURL
* @methodOf Hyphenator
* @description
* Puts {@link Hyphenator-urlhyphen} after each no-alphanumeric char that my be in a URL.
* @param string URL to hyphenate
* @returns string the hyphenated URL
* @public
*/
hyphenateURL = function (url) {
return url.replace(/([:\/\.\?#&_,;!@]+)/gi, '$&' + urlhyphen);
},
/**
* @name Hyphenator-hyphenateElement
* @methodOf Hyphenator
* @description
* Takes the content of the given element and - if there's text - replaces the words
* by hyphenated words. If there's another element, the function is called recursively.
* When all words are hyphenated, the visibility of the element is set to 'visible'.
* @param object The element to hyphenate
* @param string The language used in this element
* @public
*/
hyphenateElement = function (el) {
var hyphenatorSettings = Expando.getDataForElem(el),
lang = hyphenatorSettings.language, hyphenate, n, i;
if (Hyphenator.languages.hasOwnProperty(lang)) {
hyphenate = function (word) {
if (urlOrMailRE.test(word)) {
return hyphenateURL(word);
} else {
return hyphenateWord(lang, word);
}
};
i = 0;
while (!!(n = el.childNodes[i++])) {
if (n.nodeType === 3 && n.data.length >= min) { //type 3 = #text -> hyphenate!
n.data = n.data.replace(Hyphenator.languages[lang].genRegExp, hyphenate);
}
}
}
if (hyphenatorSettings.isHidden && intermediateState === 'hidden') {
el.style.visibility = 'visible';
if (!hyphenatorSettings.hasOwnStyle) {
el.setAttribute('style', ''); // without this, removeAttribute doesn't work in Safari (thanks to molily)
el.removeAttribute('style');
} else {
if (el.style.removeProperty) {
el.style.removeProperty('visibility');
} else if (el.style.removeAttribute) { // IE
el.style.removeAttribute('visibility');
}
}
}
if (hyphenatorSettings.isLast) {
state = 3;
onHyphenationDone();
}
},
/**
* @name Hyphenator-removeHyphenationFromElement
* @methodOf Hyphenator
* @description
* Removes all hyphens from the element. If there are other elements, the function is
* called recursively.
* Removing hyphens is usefull if you like to copy text. Some browsers are buggy when the copy hyphenated texts.
* @param object The element where to remove hyphenation.
* @public
*/
removeHyphenationFromElement = function (el) {
var h, i = 0, n;
switch (hyphen) {
case '|':
h = '\\|';
break;
case '+':
h = '\\+';
break;
case '*':
h = '\\*';
break;
default:
h = hyphen;
}
while (!!(n = el.childNodes[i++])) {
if (n.nodeType === 3) {
n.data = n.data.replace(new RegExp(h, 'g'), '');
n.data = n.data.replace(new RegExp(zeroWidthSpace, 'g'), '');
} else if (n.nodeType === 1) {
removeHyphenationFromElement(n);
}
}
},
/**
* @name Hyphenator-hyphenateDocument
* @methodOf Hyphenator
* @description
* Calls hyphenateElement() for all members of elements. This is done with a setTimout
* to prevent a "long running Script"-alert when hyphenating large pages.
* Therefore a tricky bind()-function was necessary.
* @public
*/
hyphenateDocument = function () {
function bind(fun, arg) {
return function () {
return fun(arg);
};
}
var i = 0, el;
while (!!(el = elements[i++])) {
window.setTimeout(bind(hyphenateElement, el), 0);
}
},
/**
* @name Hyphenator-removeHyphenationFromDocument
* @methodOf Hyphenator
* @description
* Does what it says ;-)
* @public
*/
removeHyphenationFromDocument = function () {
var i = 0, el;
while (!!(el = elements[i++])) {
removeHyphenationFromElement(el);
}
state = 4;
};
return {
/**
* @name Hyphenator.version
* @memberOf Hyphenator
* @description
* String containing the actual version of Hyphenator.js
* [major release].[minor releas].[bugfix release]
* major release: new API, new Features, big changes
* minor release: new languages, improvements
* @public
*/
version: '2.4.0',
/**
* @name Hyphenator.languages
* @memberOf Hyphenator
* @description
* Objects that holds key-value pairs, where key is the language and the value is the
* language-object loaded from (and set by) the pattern file.
* The language object holds the following members:
*
* key | desc> |
* leftmin | The minimum of chars to remain on the old line |
* rightmin | The minimum of chars to go on the new line |
* shortestPattern | The shortes pattern (numbers don't count!) |
* longestPattern | The longest pattern (numbers don't count!) |
* specialChars | Non-ASCII chars in the alphabet. |
* patterns | the patterns |
*
* And optionally (or after prepareLanguagesObj() has been called):
*
* exceptions | Excpetions for the secified language |
*
* @public
*/
languages: {},
/**
* @name Hyphenator.config
* @methodOf Hyphenator
* @description
* Config function that takes an object as an argument. The object contains key-value-pairs
* containig Hyphenator-settings. This is a shortcut for calling Hyphenator.set...-Methods.
* @param object
* key | values | default |
* classname | string | 'hyphenate' |
* minwordlength | integer | 6 |
* hyphenchar | string | '­' |
* urlhyphenchar | string | 'zero with space' |
* togglebox | function | see code |
* displaytogglebox | boolean | false |
* remoteloading | boolean | true |
* onhyphenationdonecallback | function | empty function |
* onerrorhandler | function | alert(onError) |
* intermediatestate | string | 'hidden' |
*
* @public
* @example <script src = "Hyphenator.js" type = "text/javascript"></script>
* <script type = "text/javascript">
* Hyphenator.config({'minwordlength':4,'hyphenchar':'|'});
* Hyphenator.run();
* </script>
*/
config: function (obj) {
var assert = function (name, type) {
if (typeof obj[name] === type) {
return true;
} else {
onError(new Error('Config onError: ' + name + ' must be of type ' + type));
return false;
}
},
key;
for (key in obj) {
if (obj.hasOwnProperty(key)) {
switch (key) {
case 'classname':
if (assert('classname', 'string')) {
hyphenateClass = obj.classname;
}
break;
case 'donthyphenateclassname':
if (assert('donthyphenateclassname', 'string')) {
dontHyphenateClass = obj.donthyphenateclassname;
}
break;
case 'minwordlength':
if (assert('minwordlength', 'number')) {
min = obj.minwordlength;
}
break;
case 'hyphenchar':
if (assert('hyphenchar', 'string')) {
if (obj.hyphenchar === '') {
obj.hyphenchar = String.fromCharCode(173);
}
hyphen = obj.hyphenchar;
}
break;
case 'urlhyphenchar':
if (obj.hasOwnProperty('urlhyphenchar')) {
if (assert('urlhyphenchar', 'string')) {
urlhyphen = obj.urlhyphenchar;
}
}
break;
case 'togglebox':
if (assert('togglebox', 'function')) {
toggleBox = obj.togglebox;
}
break;
case 'displaytogglebox':
if (assert('displaytogglebox', 'boolean')) {
displayToggleBox = obj.displaytogglebox;
}
break;
case 'remoteloading':
if (assert('remoteloading', 'boolean')) {
enableRemoteLoading = obj.remoteloading;
}
break;
case 'enablecache':
if (assert('enablecache', 'boolean')) {
enableCache = obj.enablecache;
}
break;
case 'onhyphenationdonecallback':
if (assert('onhyphenationdonecallback', 'function')) {
onHyphenationDone = obj.onhyphenationdonecallback;
}
break;
case 'onerrorhandler':
if (assert('onerrorhandler', 'function')) {
onError = obj.onerrorhandler;
}
break;
case 'intermediatestate':
if (assert('intermediatestate', 'string')) {
intermediateState = obj.intermediatestate;
}
break;
case 'selectorfunction':
if (assert('selectorfunction', 'function')) {
selectorFunction = obj.selectorfunction;
}
break;
default:
onError(new Error('Hyphenator.config: property ' + key + ' not known.'));
}
}
}
},
/**
* @name Hyphenator.run
* @methodOf Hyphenator
* @description
* Bootstrap function that starts all hyphenation processes when called.
* @public
* @example <script src = "Hyphenator.js" type = "text/javascript"></script>
* <script type = "text/javascript">
* Hyphenator.run();
* </script>
*/
run: function () {
var process = function () {
try {
autoSetMainLanguage();
gatherDocumentInfos();
prepare(hyphenateDocument);
if (displayToggleBox) {
toggleBox(true);
}
} catch (e) {
onError(e);
}
};
if (!documentLoaded) {
runOnContentLoaded(window, process);
}
if (Hyphenator.isBookmarklet() || documentLoaded) {
process();
}
},
/**
* @name Hyphenator.addExceptions
* @methodOf Hyphenator
* @description
* Adds the exceptions from the string to the appropriate language in the
* {@link Hyphenator-languages}-object
* @param string The language
* @param string A comma separated string of hyphenated words WITH spaces.
* @public
* @example <script src = "Hyphenator.js" type = "text/javascript"></script>
* <script type = "text/javascript">
* Hyphenator.addExceptions('de','ziem-lich, Wach-stube');
* Hyphenator.run();
* </script>
*/
addExceptions: function (lang, words) {
if (lang === '') {
lang = 'global';
}
if (exceptions.hasOwnProperty[lang]) {
exceptions[lang] += ", " + words;
} else {
exceptions[lang] = words;
}
},
/**
* @name Hyphenator.hyphenate
* @methodOf Hyphenator
* @public
* @description
* Hyphenates the target. The language patterns must be loaded.
* If the target is a string, the hyphenated string is returned,
* if it's an object, the values are hyphenated directly.
* @param mixed the target to be hyphenated
* @param string the language of the target
* @returns string
* @example <script src = "Hyphenator.js" type = "text/javascript"></script>
* <script src = "en.js" type = "text/javascript"></script>
* <script type = "text/javascript">
* var t = Hyphenator.hyphenate('Hyphenation', 'en'); //Hy|phen|ation
* </script>
*/
hyphenate: function (target, lang) {
var hyphenate, n, i;
if (Hyphenator.languages.hasOwnProperty(lang)) {
if (!Hyphenator.languages[lang].prepared) {
prepareLanguagesObj(lang);
}
hyphenate = function (word) {
if (urlOrMailRE.test(word)) {
return hyphenateURL(word);
} else {
return hyphenateWord(lang, word);
}
};
if (typeof target === 'string' || target.constructor === String) {
return target.replace(Hyphenator.languages[lang].genRegExp, hyphenate);
} else if (typeof target === 'object') {
i = 0;
while (!!(n = target.childNodes[i++])) {
if (n.nodeType === 3 && n.data.length >= min) { //type 3 = #text -> hyphenate!
n.data = n.data.replace(Hyphenator.languages[lang].genRegExp, hyphenate);
} else if (n.nodeType === 1) {
if (n.lang !== '') {
lang = n.lang;
}
Hyphenator.hyphenate(n, lang);
}
}
}
} else {
onError(new Error('Language "' + lang + '" is not loaded.'));
}
},
/**
* @name Hyphenator.isBookmarklet
* @methodOf Hyphenator
* @description
* Returns {@link Hyphenator-isBookmarklet}.
* @returns boolean
* @public
*/
isBookmarklet: function () {
return isBookmarklet;
},
/**
* @name Hyphenator.toggleHyphenation
* @methodOf Hyphenator
* @description
* Checks the current state of the ToggleBox and removes or does hyphenation.
* @public
*/
toggleHyphenation: function () {
switch (state) {
case 3:
removeHyphenationFromDocument();
toggleBox(false);
break;
case 4:
hyphenateDocument();
toggleBox(true);
break;
}
}
};
}());
if (Hyphenator.isBookmarklet()) {
Hyphenator.config({displaytogglebox: true, intermediatestate: 'visible'});
Hyphenator.run();
}