README.md in mongoid_fulltext-0.4.3 vs README.md in mongoid_fulltext-0.4.4
- old
+ new
@@ -209,9 +209,15 @@
* `max_ngrams_to_search`: maximum number of ngrams to query at any given time, default is `6`
* `max_candidate_set_size`: maximum number of candidate ngrams to examine for a given query.
Defaults to 1000. If you're seeing poor results, you can try increasing this value to consider
more ngrams per query (changing this parameter does not require a re-index.) The amount of time
a search takes is directly proportional to this parameter's value.
+* `remove_accents`: remove accents on accented characters or not. Defaults to true. If a string
+ is encoded in UTF-8, we strip the accents using NFKD normalization (via an external library,
+ `unicode_utils`. If a string is encoded in ASCII-8BIT, we assume it has been passed via a
+ URL, for instance we might have "%C3%A9" which is how an "e-accute" ("é") gets passed
+ through a web-browser. These are then changed to their UTF-8 equivalents (via the `CGI` gem)
+ and then finally stripped, as before.
Array filters
-------------
A filter may also return an Array. Consider the following example.