Skip to content
This repository has been archived by the owner. It is now read-only.
Javascript that implements client-side hyphenation of HTML-Documents
Branch: master
Clone or download
Latest commit d796f31 Nov 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Update issue_template.md Sep 24, 2018
patterns Add Georgian Aug 6, 2017
testsuite fix test35 Oct 13, 2017
Hyphenator.js eval Oct 13, 2017
Hyphenator_Loader.js fixes #307 Aug 26, 2017
LICENSE.txt Change license Apr 13, 2015
Loader_Example.html Add example page for Hyphenator_Loader.js Mar 26, 2015
README.md Update README.md Nov 28, 2018
WorkingExample.html fixing links Mar 18, 2015
bower.json fixing bower name May 12, 2017
compressor.html clean up Mar 4, 2017
favicon.ico
index.html Use current Loader Dec 10, 2015
mergeAndPack.html Add Georgian Oct 13, 2017
package.json adds "main" field to package.json Aug 4, 2017
reducePatternSet.html Replace hyphenator_logo by svg Mar 21, 2015

README.md

DEPRECATED

⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️

Warning: This project is no longer maintained. Have a look at its successor: https://github.com/mnater/Hyphenopoly.

⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️

Overview

Hyphenator.js is a free open source Javascript library that automatically hyphenates text on websites. It comes in handy as a polyfill for legacy browsers that don't support CSS 3 hyphenation at all or for modern browsers that do hyphenation, but do not provide hyphenation dictionaries for a particular language.

Hyphenator.js …

Quick links

Quick guide

  1. Download the recent version of Hyphenator.js
  2. Use mergeAndPack.html to configure and minify Hyphenator.js and hyphenation patterns.
  3. Prepare your .html documents (i.e. add hyphenate-classes, set lang and add Hyphenator.js)
  4. Test it!

Get detailed instructions.

The bad parts

As with most things, there's a downside, too. Consider the following drawbacks before using Hyphenator.js:

  • Hyphenator.js and the hyphenation patterns are quite large. Good compression and caching is vital.
  • Automatic hyphenation can not be perfect: it may lead to misleading hyphenation like leg-ends (depends on the pattern quality)
  • There's no support for special (aka non-standard) hyphenation (e.g. omaatje->oma-tje)
  • There's no way for Javascript to influence the algorithm for laying out text in the browser. Thus we can't control how many hyphens occur on subsequent lines nor can we know which words have actually been hyphenated. Hyphenator.js just hyphenates all of them.

Philosophy

There is text and there is beautiful text

This beauty becomes manifest in content and representation. I'm firmly convinced that all written text (well, most of it) deserves fine typography, that we deserve it. While hyphenation is just one of many tesserae that forms the appearance of text, it may be an important one.

There is code and there is sound code

In code there is readability, maintainability, performance and genius – and some constraints of technology. As a hobbyist programmer I often feel like a hobbit surrounded by wizards who campaign for these values. But being an agile hobbit gives me the freedom to find my own way through the woods (thankfully free from evil in this area). I'm constantly in search of the most performant path to circumvent the constraints of technology while maintaining readability and maintainability of my code. Sometimes this path is illuminated by a wizard1.

Issues and Requests

Each release is tested in various browsers with an automated testsuite. Nevertheless, there will always be bugs. Please don't hesitate to submit them.

If you have a special use case and Hyphenator.js doesn't provide a solution, feel free to submit a feature request.

And please, be patient. Hyphenator.js is a hobby of mine and sometimes other things have precedence…


(1) Some of my coding wizards are:

You can’t perform that action at this time.