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 improve
6 English-language searching with the Drupal built-in Search module. Information
7 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 'blog') so
11 that variations on a word ('blogs', 'blogger', 'blogging', 'blog') are
12 considered equivalent when searching. This generally results in more relevant
13 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" library
21 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
29 See the INSTALL.txt file for installation instructions.
30
31
32 TESTING
33 -------
34
35 The Porter Stemmer module includes tests for the stemming algorithm and
36 functionality.  If you would like to run the tests, enable the core Testing
37 module, and then navigate to Administer > Configuration / Development / Testing.
38
39 Each "Stemming output" test for the Porter Stemmer module includes approximately
40 2000 individual word stemming tests (which test the module against a standard
41 word list downloaded from the site above).  Due to the way output is displayed
42 in SimpleTest, you may run into browser timeout or memory issues if you try to
43 run all 16 of the "Stemming output" tests during the same test run.
44
45 Tests are provided both for the internal algorithm and the PECL library.
46
47 There are also functional tests and tests for some of the internal steps of the
48 stemming algorithm.