* Enhance documentation (serve minified hyphenopoly in [https://mnate…

…r.github.io/Hyphenopoly/min/](https://mnater.github.io/Hyphenopoly/min/) and move examples to examples directory) (issue #104) * exclude .DS_Store from npm package * bumpDevDependencies Fixes #104
mnater · Mar 31, 2020 · 983f5a9 · 983f5a9
1 parent 482981c
commit 983f5a9
Show file tree

Hide file tree

Showing 131 changed files with 5,931 additions and 741 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Version History
 
+## Version 4.2.1 (2020-03-31)
+### Fixed
+*   Enhance documentation (serve minified hyphenopoly in [https://mnater.github.io/Hyphenopoly/min/](https://mnater.github.io/Hyphenopoly/min/) and move examples to examples directory) (issue #104)
+*   exclude .DS_Store from npm package
+*   bumpDevDependencies
+
+
 ## Version 4.2.0 (2020-03-27)
 ### Added
 *   Added support for Macedonian

diff --git a/Hyphenopoly.js b/Hyphenopoly.js
@@ -1,5 +1,5 @@
 /**
- * @license Hyphenopoly 4.2.0 - client side hyphenation for webbrowsers
+ * @license Hyphenopoly 4.2.1 - client side hyphenation for webbrowsers
  * ©2020  Mathias Nater, Güttingen (mathiasnater at gmail dot com)
  * https://github.com/mnater/Hyphenopoly
  *

diff --git a/Hyphenopoly_Loader.js b/Hyphenopoly_Loader.js
@@ -1,5 +1,5 @@
 /**
- * @license Hyphenopoly_Loader 4.2.0 - client side hyphenation
+ * @license Hyphenopoly_Loader 4.2.1 - client side hyphenation
  * ©2020  Mathias Nater, Güttingen (mathiasnater at gmail dot com)
  * https://github.com/mnater/Hyphenopoly
  *

diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Place all code for Hyphenopoly at the top of the header (immediately after the `
 You'll have to insert two script blocks. In the first block provide the initial configurations for Hyphenopoly_Loader as inline script. In the second block load Hyphenopoly_Loader.js as external script.
 Also, don't forget to enable CSS hyphenation.
 
-[Example](http://mnater.github.io/Hyphenopoly/example1.html):
+[Example](http://mnater.github.io/Hyphenopoly/min/example.html):
 ```html
 <!DOCTYPE html>
 <html>

diff --git a/docs/min/Hyphenopoly.js b/docs/min/Hyphenopoly.js
diff --git a/docs/min/Hyphenopoly_Loader.js b/docs/min/Hyphenopoly_Loader.js
diff --git a/example1.html → docs/min/example.html b/example1.html → docs/min/example.html
diff --git a/docs/min/patterns/af.wasm b/docs/min/patterns/af.wasm
diff --git a/docs/min/patterns/as.wasm b/docs/min/patterns/as.wasm
diff --git a/docs/min/patterns/be.wasm b/docs/min/patterns/be.wasm
diff --git a/docs/min/patterns/bg.wasm b/docs/min/patterns/bg.wasm
diff --git a/docs/min/patterns/bn.wasm b/docs/min/patterns/bn.wasm
diff --git a/docs/min/patterns/ca.wasm b/docs/min/patterns/ca.wasm
diff --git a/docs/min/patterns/cop.wasm b/docs/min/patterns/cop.wasm
diff --git a/docs/min/patterns/cs.wasm b/docs/min/patterns/cs.wasm
diff --git a/docs/min/patterns/cy.wasm b/docs/min/patterns/cy.wasm
diff --git a/docs/min/patterns/da.wasm b/docs/min/patterns/da.wasm
diff --git a/docs/min/patterns/de.wasm b/docs/min/patterns/de.wasm
diff --git a/docs/min/patterns/el-monoton.wasm b/docs/min/patterns/el-monoton.wasm
diff --git a/docs/min/patterns/el-polyton.wasm b/docs/min/patterns/el-polyton.wasm
diff --git a/docs/min/patterns/en-gb.wasm b/docs/min/patterns/en-gb.wasm
diff --git a/docs/min/patterns/en-us.wasm b/docs/min/patterns/en-us.wasm
diff --git a/docs/min/patterns/eo.wasm b/docs/min/patterns/eo.wasm
diff --git a/docs/min/patterns/es.wasm b/docs/min/patterns/es.wasm
diff --git a/docs/min/patterns/et.wasm b/docs/min/patterns/et.wasm
diff --git a/docs/min/patterns/eu.wasm b/docs/min/patterns/eu.wasm
diff --git a/docs/min/patterns/fi.wasm b/docs/min/patterns/fi.wasm
diff --git a/docs/min/patterns/fr.wasm b/docs/min/patterns/fr.wasm
diff --git a/docs/min/patterns/fur.wasm b/docs/min/patterns/fur.wasm
diff --git a/docs/min/patterns/ga.wasm b/docs/min/patterns/ga.wasm
diff --git a/docs/min/patterns/gl.wasm b/docs/min/patterns/gl.wasm
diff --git a/docs/min/patterns/grc.wasm b/docs/min/patterns/grc.wasm
diff --git a/docs/min/patterns/gu.wasm b/docs/min/patterns/gu.wasm
diff --git a/docs/min/patterns/hi.wasm b/docs/min/patterns/hi.wasm
diff --git a/docs/min/patterns/hr.wasm b/docs/min/patterns/hr.wasm
diff --git a/docs/min/patterns/hsb.wasm b/docs/min/patterns/hsb.wasm
diff --git a/docs/min/patterns/hu.wasm b/docs/min/patterns/hu.wasm
diff --git a/docs/min/patterns/hy.wasm b/docs/min/patterns/hy.wasm
diff --git a/docs/min/patterns/ia.wasm b/docs/min/patterns/ia.wasm
diff --git a/docs/min/patterns/id.wasm b/docs/min/patterns/id.wasm
diff --git a/docs/min/patterns/is.wasm b/docs/min/patterns/is.wasm
diff --git a/docs/min/patterns/it.wasm b/docs/min/patterns/it.wasm
diff --git a/docs/min/patterns/ka.wasm b/docs/min/patterns/ka.wasm
diff --git a/docs/min/patterns/kmr.wasm b/docs/min/patterns/kmr.wasm
diff --git a/docs/min/patterns/kn.wasm b/docs/min/patterns/kn.wasm
diff --git a/docs/min/patterns/la.wasm b/docs/min/patterns/la.wasm
diff --git a/docs/min/patterns/lt.wasm b/docs/min/patterns/lt.wasm
diff --git a/docs/min/patterns/lv.wasm b/docs/min/patterns/lv.wasm
diff --git a/docs/min/patterns/mk.wasm b/docs/min/patterns/mk.wasm
diff --git a/docs/min/patterns/ml.wasm b/docs/min/patterns/ml.wasm
diff --git a/docs/min/patterns/mn-cyrl.wasm b/docs/min/patterns/mn-cyrl.wasm
diff --git a/docs/min/patterns/mr.wasm b/docs/min/patterns/mr.wasm
diff --git a/docs/min/patterns/mul-ethi.wasm b/docs/min/patterns/mul-ethi.wasm
diff --git a/docs/min/patterns/nb-no.wasm b/docs/min/patterns/nb-no.wasm
diff --git a/docs/min/patterns/nl.wasm b/docs/min/patterns/nl.wasm
diff --git a/docs/min/patterns/nn.wasm b/docs/min/patterns/nn.wasm
diff --git a/docs/min/patterns/oc.wasm b/docs/min/patterns/oc.wasm
diff --git a/docs/min/patterns/or.wasm b/docs/min/patterns/or.wasm
diff --git a/docs/min/patterns/pa.wasm b/docs/min/patterns/pa.wasm
diff --git a/docs/min/patterns/pi.wasm b/docs/min/patterns/pi.wasm
diff --git a/docs/min/patterns/pl.wasm b/docs/min/patterns/pl.wasm
diff --git a/docs/min/patterns/pms.wasm b/docs/min/patterns/pms.wasm
diff --git a/docs/min/patterns/pt.wasm b/docs/min/patterns/pt.wasm
diff --git a/docs/min/patterns/rm.wasm b/docs/min/patterns/rm.wasm
diff --git a/docs/min/patterns/ro.wasm b/docs/min/patterns/ro.wasm
diff --git a/docs/min/patterns/ru.wasm b/docs/min/patterns/ru.wasm
diff --git a/docs/min/patterns/sh-cyrl.wasm b/docs/min/patterns/sh-cyrl.wasm
diff --git a/docs/min/patterns/sh-latn.wasm b/docs/min/patterns/sh-latn.wasm
diff --git a/docs/min/patterns/sk.wasm b/docs/min/patterns/sk.wasm
diff --git a/docs/min/patterns/sl.wasm b/docs/min/patterns/sl.wasm
diff --git a/docs/min/patterns/sr-cyrl.wasm b/docs/min/patterns/sr-cyrl.wasm
diff --git a/docs/min/patterns/sv.wasm b/docs/min/patterns/sv.wasm
diff --git a/docs/min/patterns/ta.wasm b/docs/min/patterns/ta.wasm
diff --git a/docs/min/patterns/te.wasm b/docs/min/patterns/te.wasm
diff --git a/docs/min/patterns/th.wasm b/docs/min/patterns/th.wasm
diff --git a/docs/min/patterns/tk.wasm b/docs/min/patterns/tk.wasm
diff --git a/docs/min/patterns/tr.wasm b/docs/min/patterns/tr.wasm
diff --git a/docs/min/patterns/uk.wasm b/docs/min/patterns/uk.wasm
diff --git a/docs/min/patterns/zh-latn-pinyin.wasm b/docs/min/patterns/zh-latn-pinyin.wasm
diff --git a/docs/min/testsuite/index.html b/docs/min/testsuite/index.html
@@ -0,0 +1,68 @@
+<!DOCTYPE HTML>
+<html>
+    <head>
+        <title>Hyphenopoly.js &ndash; Testsuite</title>
+        <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+        <style type="text/css">
+            body {
+                width:80%;
+                margin-left:10%;
+                margin-right:10%;
+                font: normal 11px Verdana;
+                line-height: 18px;
+            }
+            #template {
+                display: none;
+            }
+            #testframe {
+                visibility: hidden;
+            }
+            .passed {
+                color: green;
+                background-color: lime;
+            }
+            .failed {
+                color: maroon;
+                background-color: red;
+            }
+            .obsolete {
+                color: black;
+                background-color: silver;
+            }
+            .visual {
+                color: olive;
+                background-color: yellow;
+            }
+            .omitted {
+                color: grey;
+                background-color: black;
+            }
+            .testname {
+                display: inline-block;
+                width: 6em;
+            }
+            .result {
+                display: inline-block;
+                width: 5em;
+            }
+            ul {
+                list-style-type: none;
+                padding-left: 0px;
+            }
+        </style>
+    </head>
+    <body>
+        <h1>The Hyphenopoly Testsuite</h1>
+        <ul id="template">
+            <li>
+                <span class="testname"><a href="@file@">@file@</a></span>
+                <span class="result @result@">[@result@]</span>
+                <span class="desc">@desc@</span>
+            </li>
+        </ul>
+        <ul id="testresults">
+        </ul>
+        <iframe id="testframe" src=""></iframe>
+        <script src="testdriver.js"></script>
+  </body>
+</html>
diff --git a/docs/min/testsuite/test1.html b/docs/min/testsuite/test1.html
@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+        <title>Test 001</title>
+        <script>
+        var Hyphenopoly = {
+            require: {
+                "en-us": "supercalifragilisticexpialidocious",
+                "hy": "ձայնավորձայնավոր"
+            },
+            handleEvent: {
+                hyphenopolyEnd: function (e) {
+                    assert();
+                }
+            }
+        };
+        function assert() {
+            var tests = 2;
+            var i = 1;
+            var test = "";
+            var ref = "";
+            var result = true;
+            var lang = "";
+            while (i <= tests) {
+                lang = document.getElementById("test" + i).lang;
+                if (Hyphenopoly.cf.langs[lang] === "CSS") {
+                    document.getElementById("result").innerHTML += "<p style=\"background-color: #d6ffd6\">" + i + " passed (CSS)</p>";
+                    result = result && true;
+                } else {
+                    test = document.getElementById("test" + i).innerHTML;
+                    ref = document.getElementById("ref" + i).innerHTML;
+                    if (test === ref) {
+                        document.getElementById("result").innerHTML += "<p style=\"background-color: #d6ffd6\">" + i + " passed</p>";
+                        result = result && true;
+                    } else {
+                        document.getElementById("result").innerHTML += "<p style=\"background-color: #ffd6d6\">" + i + " failed</p>";
+                        result = false;
+                    }
+                }
+                i += 1;
+            }
+            if (parent != window) {
+                parent.postMessage(JSON.stringify({
+                    desc: document.getElementById("desc").innerHTML,
+                    index: 1,
+                    result: (result ? "passed" : "failed")
+                }), window.location.href);
+            }
+        }
+        </script>
+        <script src="../Hyphenopoly_Loader.js"></script>
+        <style type="text/css">
+            body {
+                width:50%;
+                margin-left:25%;
+                margin-right:25%;
+            }
+
+            .test {
+                background-color: #D8E2F9;
+            }
+            .ref {
+                background-color: #FEEFC0;
+            }
+
+            .hyphenate {
+                hyphens: auto;
+                -ms-hyphens: auto;
+                -moz-hyphens: auto;
+                -webkit-hyphens: auto;
+            }
+        </style>
+    </head>
+    <body>
+        <div id="navigate"><a href="index.html">&Larr;&nbsp;Index</a>&nbsp;|&nbsp;<a href="index.html">&larr;&nbsp;Prev</a>&nbsp;|&nbsp;<a href="test2.html">Next&nbsp;&rarr;</a></div>
+
+        <h1>Test 001</h1>
+        <p id="desc">Hyphenate two texts – en-us (where CSS-hyphenation is mostly supported) and hy (where CSS-hyphenation is unsupported).</p>
+        <div id="result"></div>
+        <hr>
+        <h2>1: en-us</h2>
+        <p id="test1" class="test hyphenate" lang="en-us">A hyphenation algorithm is a set of rules that decides at which points a word can be broken over two lines with a hyphen.</p>
+        <p id="ref1" class="ref" lang="en-us">A hy&shy;phen&shy;ation al&shy;go&shy;rithm is a set of rules that de&shy;cides at which points a word can be bro&shy;ken over two lines with a hy&shy;phen.</p>
+
+        <h2>2: hy (Armenian)</h2>
+        <p id="test2" class="test hyphenate" lang="hy">Հայերենն ունի վեց ձայնավոր, մեկ կիսաձայն և երեսուն բաղաձայն հնչյուններ</p>
+        <p id="ref2" class="ref" lang="hy">Հա&shy;յե&shy;րենն ունի վեց ձայնա&shy;վոր, մեկ կի&shy;սա&shy;ձայն և ե&shy;րե&shy;սուն բա&shy;ղա&shy;ձայն հնչյուններ</p>
+        <hr>
+        <div><span class="test">Test</span> <span class="ref">Ref</span></div>
+
+    </body>
+</html>