modules/porterstemmer/README.txt

// $Id$

GENERAL INFORMATION
-------------------

This module implements the Porter-Stemmer algorithm, version 2, to
improve English-language searching with the Drupal built-in
Search module. Information about the algorithm can be found at
http://snowball.tartarus.org/algorithms/english/stemmer.html

Stemming reduces a word to its basic root or stem (e.g. 'blogging' to
'blog') so that variations on a word ('blogs', 'blogger', 'blogging',
'blog') are considered equivalent when searching. This generally
results in more relevant results.

Note that the Porter Stemmer algorithm is specific to American
English, so some British spellings will not be stemmed correctly.


INSTALLATION
------------
See the INSTALL.txt file for installation instructions.


TESTING
-------

The Porter Stemmer module includes tests for the stemming algorithm.
If you would like to run the tests, install the SimpleTest module from
http://drupal.org/project/simpletest, and then navigate to Administer
> Site building > Testing. 

Each "Stemming output" test for the Porter Stemmer module includes
approximately 2000 individual word stemming tests (which test the
module against a standard word list downloaded from the site above).
Due to the way output is displayed in SimpleTest, you may run into
browser timeout or memory issues if you try to run all 16 of the
"Stemming output" tests during the same test run.
1	// $Id$
2
3	GENERAL INFORMATION
4	-------------------
5
6	This module implements the Porter-Stemmer algorithm, version 2, to
7	improve English-language searching with the Drupal built-in
8	Search module. Information about the algorithm can be found at
9	http://snowball.tartarus.org/algorithms/english/stemmer.html
10
11	Stemming reduces a word to its basic root or stem (e.g. 'blogging' to
12	'blog') so that variations on a word ('blogs', 'blogger', 'blogging',
13	'blog') are considered equivalent when searching. This generally
14	results in more relevant results.
15
16	Note that the Porter Stemmer algorithm is specific to American
17	English, so some British spellings will not be stemmed correctly.
18
19
20	INSTALLATION
21	------------
22	See the INSTALL.txt file for installation instructions.
23
24
25	TESTING
26	-------
27
28	The Porter Stemmer module includes tests for the stemming algorithm.
29	If you would like to run the tests, install the SimpleTest module from
30	http://drupal.org/project/simpletest, and then navigate to Administer
31	> Site building > Testing.
32
33	Each "Stemming output" test for the Porter Stemmer module includes
34	approximately 2000 individual word stemming tests (which test the
35	module against a standard word list downloaded from the site above).
36	Due to the way output is displayed in SimpleTest, you may run into
37	browser timeout or memory issues if you try to run all 16 of the
38	"Stemming output" tests during the same test run.