www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/porterstemmer/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 run the tests following instructions on
  38 https://www.drupal.org/docs/8/phpunit/running-phpunit-tests. Commands below:
  39
  40 cd core
  41 ../vendor/bin/phpunit --group porterstemmer
  42
  43
  44 Each test for the Porter Stemmer module includes approximately
  45 5000 individual word stemming tests (which test the module against a standard
  46 word list).
  47
  48 Tests are provided both for the internal algorithm and the PECL library.
  49
  50 There is also a functional test for integration with Drupal search.