You are here

Home » API reference » Fuzzy Search 6

README.txt in Fuzzy Search 6

Same filename in this branch
  1. 6 readme.txt
  2. 6 stopwords/README.txt
The directory fuzzysearch/stopwords contains text files that can be used to keep
common words out of the fuzzysearch index. Stop words are also stripped from
search terms. This has performance benefits and can make search results more
useful.

Do not modify files in this directory. First move them as described below.

How to use stopwords files:
The files here will have no effect until they are copied to the directory
sites/all/libraries/fuzzysearch/stopwords. Only when copied to that directory
will fuzzysearch be aware of them.

You can modify stopwords files after you copy them to
sites/all/libraries/fuzzysearch/stopwords, and you can also add your own
custom stopwords files there. You might want to keep offensive words out of your
index and create a file of these bad words.

How to name stopwords files:
Stopwords files must follow this naming convention to be recognized by
fuzzysearch: fuzzysearch_stopwords_xx.txt, where "xx" is any number of file-safe
characters that you use to identify your file. Some examples:

fuzzysearch_stopwords_en.txt for English stop words
fuzzysearch_stopwords_de.txt for German stop words
fuzzysearch_stopwords_dirty.txt for offensive stop words

How to build stopwords files:
See fuzzysearch_stopwords_en.txt for an example. Separate words with spaces.
Words should be all lowercase, with no punctuation. If you want to
stop "doesn't" include "doesnt" in your file. Do not use commas or quote marks.

How to contribute stopwords files:
If you have made a stopwords file for a language that is missing, please
contribute it in the fuzzysearch issue queue.

File

stopwords/README.txt
View source 
  1. 

  2. The directory fuzzysearch/stopwords contains text files that can be used to keep

  3. common words out of the fuzzysearch index. Stop words are also stripped from

  4. search terms. This has performance benefits and can make search results more

  5. useful.

  6. 

  7. Do not modify files in this directory. First move them as described below.

  8. 

  9. How to use stopwords files:

  10. The files here will have no effect until they are copied to the directory

  11. sites/all/libraries/fuzzysearch/stopwords. Only when copied to that directory

  12. will fuzzysearch be aware of them.

  13. 

  14. You can modify stopwords files after you copy them to

  15. sites/all/libraries/fuzzysearch/stopwords, and you can also add your own

  16. custom stopwords files there. You might want to keep offensive words out of your

  17. index and create a file of these bad words.

  18. 

  19. How to name stopwords files:

  20. Stopwords files must follow this naming convention to be recognized by

  21. fuzzysearch: fuzzysearch_stopwords_xx.txt, where "xx" is any number of file-safe

  22. characters that you use to identify your file. Some examples:

  23. 

  24. fuzzysearch_stopwords_en.txt for English stop words

  25. fuzzysearch_stopwords_de.txt for German stop words

  26. fuzzysearch_stopwords_dirty.txt for offensive stop words

  27. 

  28. How to build stopwords files:

  29. See fuzzysearch_stopwords_en.txt for an example. Separate words with spaces.

  30. Words should be all lowercase, with no punctuation. If you want to

  31. stop "doesn't" include "doesnt" in your file. Do not use commas or quote marks.

  32. 

  33. How to contribute stopwords files:

  34. If you have made a stopwords file for a language that is missing, please

  35. contribute it in the fuzzysearch issue queue.