README
1ADDING OR REMOVING ENTRIES IN THE DICTIONARY:
2
3To edit the dictionary use "edit-dictionary" and than copy the
4resulting "en-US.dic" file info place.
5
6UPGRADING TO A NEW UPSTREAM VERSION:
7
8In order to upgrade to the latest dictionary some scripts found in
9SCOWL (the source of the en_US Hunspell dictionary) are used. The
10en_US dictionary is also generated from the SCOWL source.
11
121) Unpack the tarball (tar.gz) version of the latest version of SCOWL
13in the current directory and rename the directory from
14"scowl-YYYY.MM.DD" to "scowl". You can find the latest version at
15http://wordlist.aspell.net/ or
16http://sourceforge.net/projects/wordlist/files/SCOWL/
17
182) Run the script "./make-new-dict" to generate a new dictionary and
19make sure it runs without any errors.
20
213) Do a quick sanity check on the resulting dictionary
22"en_US-mozilla.dic". For example make sure the size is about the same
23(it should likely be slightly large) as the original dictionary.
24
254) Once everything is okay copy the new dictionary in place using
26"./install-new-dict" and commit the changes.
27
28NOTES ON UPGRADE PROCESS:
29
30The dictionary upgrade scripts work by expanding (i.e. unmunching) the
31affix compression dictionaries to create simple wordlists and use
32those to generate a new dictionary.
33
34The upgrade script expects the original upstream version to be kept in
35the directory "orig".
36
37The install script renames "orig" to "orig-bk" and copies the new
38upstream version to "orig". The install script also copies the
39original Mozilla dictionary to the "mozilla-bk".
40
41SUBMITTING MOZILLA SPECIFIC CHANGES UPSTREAM:
42
43The upgrade script creates two files that can be reviewed and possible
44submitted upstream. The file "5-mozilla-removed" lists words that were
45removed in the Mozilla dictionary and the file "5-mozilla-added"
46contains the list of words that were added. When submitting new words
47upstream Mozilla specific words that are found in "5-mozilla-specific"
48(expanded from mozilla-specific.txt) should likely be removed from the list.
49
50ABOUT mozilla-specific.txt:
51
52This file contains Mozilla-specific words that should not be submitted
53upstream. For example, "Firefox" goes here. (See bug 237921).
54
55Note that the file 5-mozilla-specific is generated by expanding
56mozilla-specific.txt and should not be edited directly.
57