]> git.donarmstrong.com Git - deb_pkgs/scowl.git/blob - speller/README_en.txt.sh
New upstream version 2018.04.16
[deb_pkgs/scowl.git] / speller / README_en.txt.sh
1 : ${SCOWL:=..}
2
3 echo $WHAT
4
5 if [ "$SCOWL_VERSION" ] && [ -e $SCOWL/../.git ] > /dev/null; then
6   echo "Version $SCOWL_VERSION"
7   ( cd $SCOWL/speller && git log --pretty=format:'%cd [%h]' -n 1 -- .. )
8   echo
9 elif [ -e $SCOWL/../.git ] > /dev/null; then
10   ( cd $SCOWL/speller && git log --pretty=format:'%cd [%h]' -n 1 -- .. )
11   echo
12 elif [ -e $SCOWL/VERSION ]; then
13   echo "Generated from SCOWL Version `cat $SCOWL/VERSION`"
14   date
15   echo
16 else
17   echo "Unknown Version"
18   date
19   echo
20 fi
21
22 cat <<EOF
23 http://wordlist.sourceforge.net
24
25 README file for English Hunspell dictionaries derived from SCOWL.
26
27 These dictionaries are created using the speller/make-hunspell-dict
28 script in SCOWL.
29
30 The following dictionaries are available:
31
32   en_US (American)
33   en_CA (Canadian)
34   en_GB-ise (British with "ise" spelling)
35   en_GB-ize (British with "ize" spelling)
36   en_AU (Australian)
37
38   en_US-large
39   en_CA-large
40   en_GB-large (with both "ise" and "ize" spelling)
41   en_AU-large
42
43 The normal (non-large) dictionaries correspond to SCOWL size 60 and,
44 to encourage consistent spelling, generally only include one spelling
45 variant for a word.  The large dictionaries correspond to SCOWL size
46 70 and may include multiple spelling for a word when both variants are
47 considered almost equal.  The larger dictionaries however (1) have not
48 been as carefully checked for errors as the normal dictionaries and
49 thus may contain misspelled or invalid words; and (2) contain
50 uncommon, yet valid, words that might cause problems as they are
51 likely to be misspellings of more common words (for example, "ort" and
52 "calender").
53
54 To get an idea of the difference in size, here are 25 random words
55 only found in the large dictionary for American English:
56
57   Bermejo Freyr's Guenevere Hatshepsut Nottinghamshire arrestment
58   crassitudes crural dogwatches errorless fetial flaxseeds godroon
59   incretion jalapeño's kelpie kishkes neuroglias pietisms pullulation
60   stemwinder stenoses syce thalassic zees
61
62 The en_US, en_CA and en_AU are the official dictionaries for Hunspell.
63 The en_GB and large dictionaries are made available on an experimental
64 basis.  If you find them useful please send me a quick email at
65 kevina@gnu.org.
66
67 If none of these dictionaries suite you (for example, maybe you want
68 the normal dictionary that also includes common variants) additional
69 dictionaries can be generated at http://app.aspell.net/create or by
70 modifying speller/make-hunspell-dict in SCOWL.  Please do let me know
71 if you end up publishing a customized dictionary.
72
73 If a word is not found in the dictionary or a word is there you think
74 shouldn't be, you can lookup the word up at http://app.aspell.net/lookup
75 to help determine why that is.
76
77 General comments on these list can be sent directly to me at
78 kevina@gnu.org or to the wordlist-devel mailing lists
79 (https://lists.sourceforge.net/lists/listinfo/wordlist-devel).  If you
80 have specific issues with any of these dictionaries please file a bug
81 report at https://github.com/kevina/wordlist/issues.
82
83 IMPORTANT CHANGES INTRODUCED In 2016.11.20:
84
85 New Australian dictionaries thanks to the work of Benjamin Titze
86 (btitze@protonmail.ch).
87
88 IMPORTANT CHANGES INTRODUCED IN 2016.04.24:
89
90 The dictionaries are now in UTF-8 format instead of ISO-8859-1.  This
91 was required to handle smart quotes correctly.
92
93 IMPORTANT CHANGES INTRODUCED IN 2016.01.19:
94
95 "SET UTF8" was changes to "SET UTF-8" in the affix file as some
96 versions of Hunspell do not recognize "UTF8".
97
98 ADDITIONAL NOTES:
99
100 The NOSUGGEST flag was added to certain taboo words.  While I made an
101 honest attempt to flag the strongest taboo words with the NOSUGGEST
102 flag, I MAKE NO GUARANTEE THAT I FLAGGED EVERY POSSIBLE TABOO WORD.
103 The list was originally derived from Németh László, however I removed
104 some words which, while being considered taboo by some dictionaries,
105 are not really considered swear words in today's society.
106
107 COPYRIGHT, SOURCES, and CREDITS:
108
109 The English dictionaries come directly from SCOWL $LEVEL
110 and is thus under the same copyright of SCOWL.  The affix file is
111 a heavily modified version of the original english.aff file which was
112 released as part of Geoff Kuenning's Ispell and as such is covered by
113 his BSD license.  Part of SCOWL is also based on Ispell thus the
114 Ispell copyright is included with the SCOWL copyright.
115
116 EOF
117
118 cat $SCOWL/Copyright
119 echo
120 echo "Build Date: `date`"