Stripping CVS keywords
[project/porterstemmer.git] / README.txt
1
2 GENERAL INFORMATION
3 -------------------
4
5 This module implements the Porter-Stemmer algorithm, version 2, to
6 improve English-language searching with the Drupal built-in
7 Search module. Information about the algorithm can be found at
8 http://snowball.tartarus.org/algorithms/english/stemmer.html
9
10 Stemming reduces a word to its basic root or stem (e.g. 'blogging' to
11 'blog') so that variations on a word ('blogs', 'blogger', 'blogging',
12 'blog') are considered equivalent when searching. This generally
13 results in more relevant results.
14
15 Note that a few parts of the Porter Stemmer algorithm work better for American
16 English than British English, so some British spellings will not be stemmed
17 correctly.
18
19 This module will use the PECL "stem" library's implementation of the Porter
20 Stemmer algorithm, if it is installed on your server. If the PECL "stem"
21 library is not available, the module uses its own PHP implementation of the
22 algorithm. The output is the same in either case. More information about the
23 PECL "stem" library: http://pecl.php.net/package/stem
24
25
26 INSTALLATION
27 ------------
28 See the INSTALL.txt file for installation instructions.
29
30
31 TESTING
32 -------
33
34 The Porter Stemmer module includes tests for the stemming algorithm.
35 If you would like to run the tests, install the SimpleTest module from
36 http://drupal.org/project/simpletest, and then navigate to Administer
37 > Site building > Testing. 
38
39 Each "Stemming output" test for the Porter Stemmer module includes
40 approximately 2000 individual word stemming tests (which test the
41 module against a standard word list downloaded from the site above).
42 Due to the way output is displayed in SimpleTest, you may run into
43 browser timeout or memory issues if you try to run all 16 of the
44 "Stemming output" tests during the same test run.
45
46 Tests are provided both for the internal algorithm and the PECL library.