correction, ajout gitignore

2019-07-06 13:25:00 +02:00
commit 28d1936dee
182 changed files with 28900 additions and 0 deletions
@@ -0,0 +1,94 @@
+# Hyphenation errors
+Automatic hyphenation can not be error free! Because ...
+* ... [homographs](https://en.wikipedia.org/wiki/Homograph) may be hyphenated differently.
+    ````
+    desert (arid land) -> des‧ert
+    desert (to leave) -> de‧sert
+    ````
+    In some patterns this is solved by not hyphenating ambiguous words at all.
+* ... [neologisms](https://en.wikipedia.org/wiki/Neologism) that are not in the list of words used for pattern creation may be hyphenated incorrectly.
+    ````
+    blogosphere -> blog·o·sphere (Merriam webster)
+        // bl‧o‧gos‧phere (en-us patterns)
+        // blo‧go‧sphere (en-gb patterns)
+    ````
+* ... the rules for hyphenation may have changed or are not specified unambiguously.
+    ````
+    dictionary -> dic‧tion‧ary (Wiktionary)
+        // dic·tio·nary (Merriam-Webster)
+    ````
+* ... the patterns differ in quality. Some are very new and reflect the current state of the language others are older. Some are based on a very large list of words others are crafted by hand (which is not necessarily bad).
+
+In any case automatic hyphenation needs proofreading and may need some intervention.
+
+## Proofread
+Use a visible hyphen character to display all hyphen opportunities:
+````javascript
+<script>
+var Hyphenopoly = {
+    require: [...],
+    setup: {
+        selectors: {
+            ".hyphenate": {
+                hyphen: "•"
+            }
+        }
+    }
+};
+</script>
+````
+See also [Setup#hyphen](./Setup.md#hyphen)
+
+## Fix hyphenation
+There are three levels of fixing possibilities:
+1. [Directly in the text](#fix-hyphenation-in-the-text)
+2. [Defining hyphenation exceptions for Hyphenopoly](#define-hyphenation-exceptions)
+3. [Improve patterns](#help-to-improve-the-patterns)
+
+### Fix hyphenation in the text
+Words containing a soft hyphen (\&shy;) will not be hyphenated by Hyphenopoly.js. Therefor you can simply add soft hyphens manually to 'overwrite' automatic hyphenation.
+
+__pro:__
+- easy to do
+
+__contra:__
+- needs to be repeated for every occurence of the word
+- has no effect in the long term (others will not benefit)
+
+### Define hyphenation exceptions.
+Hyphenopoly.js has an API for hyphenation exceptions: https://github.com/mnater/Hyphenopoly/wiki/Setup#exceptions
+````javascript
+<script>
+var Hyphenopoly = {
+    require: {...},
+    setup: {
+        exceptions: {
+            "en-us": "desert, dic-tion-ary, dic-tion-aries, blog-o-sphere" //language-specific exceptions
+        },
+        selectors: {...}
+    }
+};
+</script>
+````
+In the example above Hyphenopoly.js will never hyphenate the word "desert" (exceptions are not case sensitive) and hyphenate the words "dictionary", "dictionaries" and "blogosphere" at the positions marked with a hyphen-minus.
+
+__pro:__
+- one place for all exceptions
+- exceptions apply to all occurences of the words
+
+__contra:__
+- needs carefulness
+- has no effect in the long term (others will not benefit)
+
+### Help to improve the patterns
+Go to [http://www.hyphenation.org/](http://www.hyphenation.org/) and help to improve the patterns.
+
+__pro:__
+- others will benefit (Mozilla, Apple, the whole TeX-community and many others rely on these patterns)
+- the error will be fixed in long term (sometimes, maybe)
+
+__contra:__
+- fixing patterns often takes a long time (not all patterns are actively maintained)
+- fixing the patterns often requires extended knowledge
+
+As an intermediate step to improved patterns, patterns also have the ability to include exceptions. Follow this guide ([todo](todo)) to improve the patterns Hyphenopoly.js uses.