• View
• Edit
• History
• Attach
• Print
• Backlinks

JustHyp

Questions answered by this recipe

• How can I fill paragraphs as tightly as possible?
• How can I hyphenate multiple languages in the same page?
• Is there an automatic way to hyphenate words?

All sections are optional, you can remove those that do not apply to your recipe, and add new ones.

Description

JustHyp uses Hyphenator.js to hyphenate blocks of page text. It supports multiple languages. JustHyp also sets CSS styles to justify the page text.

When JustHyp is enabled by default all page text is hyphenated and justified. If you want to format just some text use markup (:justhypblock:).

Some browsers display hyphenated text incorrectly, so hyphenation is disabled by default for such browsers. Justification is always enabled for all browsers.

Acknowledgments

This cookbook would not be possible without Mathias Nater's excellent hyphenation script (version 4.1.0) which is the gist of what this cookbook provides. Browser detection is based on Peter-Paul Koch's BrowserDetect.js as of 2011-08-05. JustHyp liberally reuses code from Dave Gilbert's excellent BlogIt cookbook. I am indebted to all testers who report browser-dependent issues and document supported versions. There are just too many browser combinations for me to test alone.

Download and Install

1. Download the archive file and unzip it into PmWiki's top folder.
2. Add to your local config.php or farmconfig.php files:
   include_once("$FarmD/cookbook/justhyp.php");
3. Optionally customize cookbook settings before including justhyp.php.
   1. If your site uses multilanguage cookbooks it is recommended to set at least:
      $jh_Lang = '{$Lang}'; #set by MultiLanguageViews/MultiLanguage cookbooks
   2. If your site loads jQuery before justhyp.php you can reuse the existing jQuery by setting:
      $jh_Load_jQuery = 0; #reuse a previously loaded instance such as BlogIt's
4. Optionally add suitable translations for 'Fit text' and 'Test browser' to your local XL page.

Configuration

Optionally you may customize cookbook behavior by changing any of its user settings before including the cookbook file.

User Settings

Advanced User Settings

Supported Language Hyphenation Patterns

By default JustHyp assumes that the input text is English (en). Set a different language with PHP variable $jh_Lang, which affects the whole page, or markup (:justhypblock lang=LANGUAGE:) ... (:justhypblockend:), which affects just the included text block. You can place different language blocks in the same page.

JustHyp bundles version 4.1.0 of Hyphenator.js which supports the following languages: English (US and GB), German, French, Dutch, Swedish, Spanish, Malayalam, Tamil, Hindi, Oriya, Kannda, Telugu, Bengali, Gujarati and Panjabi, Italian, Finnish, Russian, Polish, Danish, Portuguese, Hungarian, Czech, Ukrainian, Turkish, Armenian, Lithuanian, Slovenian, Latin, Greek (monoton, polyton and ancient), Belarusian, Norwegian, Latvian, Catalan, Serbian Latin script, Esperanto, Estonian.

Usage

Markup

Page Variables

Wikistyles

Examples

example 1 · example 2

Advanced Topics

Browser Support

Some browsers have issues in displaying hyphenated text and/or copy-pasting hyphenated text (a.k.a. safecopying) as follows:

• Hyphenation issues: not showing ­ hyphens at end of line and/or showing &8203; invisible hyphens
• Safecopy issues: copying ­ and/or &8203; to the clipboard and consequently pasting such characters into other applications.

Since hyphenation issues affect the look of the page, this cookbook does not perform hyphenation for browsers which have recognized hyphenation issues. For testing purposes hyphenation can be forced by means of markup (:justhyp test=1:).

Since safecopy issues are less important because they do not affect the look of the page but instead affect copying and pasting text from the browser into other applications, this cookbook leaves hyphenation on for browsers which have safecopy issues. For clipboard usability purposes hyphenation and justification can be toggled by means of markup (:justhyp toggle=1:).

Potentially any browser/OS pair could have issues in dealing with hyphenated text, so combinations need to be tested one by one. Such testing relies on users' reports and is summarized in the work-in-progress table below. When reporting new issues please include the output of markup (:justhyp test=2:). It is also useful to report no issues, that is when a browser/OS pair works correctly both for hyphenating and safecopying. Feel free to edit the table below to add new data.

edit this table

Optimizing Hyphenator

The Hyphenator website includes information on how to merge and pack selected language patterns and Hyphenator.js into a single, smaller file. If you have created such a file you can use it in place of the bundled Hyphenator.js by setting PHP variable $jh_HyphenatorJsPath.

Fixing Hyphenation Exceptions

For now you can manually specify (fix) how a word is to be hyphenated by writing ­ at each break point like this: man­u­script. Further methods to fix hyphenation may be added in the future.

Affecting Descendants

This is a short explanation of how descendant elements are affected when justification/hyphenation is applied to their containing ancestors. This might be changed in the future.

Automatic Mode

• Initially justification is applied to hyphenated elements (targets)
• Justification always propagates to targets' descendants
• Hyphenation affects direct targets only when it is applied as wikystyle or CSS class (no)hyp
• Justification propagates to descendants when it is applied automatically or by markup (:justhypblock hyp=1|0:) or as wikystyle/CSS class pnohyp.

Manual Mode

Not implemented and probably will not be.

TODO

• Document more supported browsers.
• Method to specify hyphenation exceptions from PHP or from a page.
• Probably will not implement a manual mode (not needed).

Notes

Change log / Release notes

2012-11-14: first alpha release.

If the recipe has multiple releases, then release notes can be placed here. Note that it's often easier for people to work with "release dates" instead of "version numbers".

See also

Hyphenopoly

Contributors

Comments

See discussion at JustHyp-Talk