[Solr Wiki] Update of "SpellCheckerRequestHandler" by MikeKlaas

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by MikeKlaas:
http://wiki.apache.org/solr/SpellCheckerRequestHandler

The comment on the change is:
updated spell checker page with new parameters

------------------------------------------------------------------------------
  
  === termSourceField ===
  
+ (sp.dictionary.termSourceField in <!> ["Solr1.3"])
+ 
  The field in your schema that you want to be able to build your spell index on. This should be a field that uses a very simple FieldType without a lot of Analysis (e.g. string):
  
  {{{
@@ -108, +110 @@

  
  The default field is 'word' and can be configured in SolrConfigXml.
  
+ == dictionary-related parameters ==
+ 
  === spellcheckerIndexDir ===
+ 
+ (sp.dictionary.indexDir in <!> ["Solr1.3"])
  
  The directory where your spell checker index should live and defaults to 'spell' in SolrConfigXml.  May be absolute or relative to the Solr "dataDir" directory. If this option is not specified, a RAM directory will be used.
  
- === suggestionCount ===
+ === sp.dictionary.threshold ===
  
- Determines how many spelling suggestions are returned.  The default value is 1 but can be configured in SolrConfigXml.  The order of the returned results is determined by both the [http://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance] (or accuracy) of the suggestion and the popularity (the frequency) of the suggested word in the termSourceField.
+ Determines what terms will be used for creating the dictionary from the source field.  The threshold is in terms of ''document frequency'', i.e., what fraction of documents contain this term (not term frequency).  This can be used to create a smaller, more accurate dictionary.
  
+ The default value is '`0`'. <!> ["Solr1.3"]
- === accuracy ===
- 
- A float value between 1.0 and 0.0 on how close the suggested words should match the original word being checked (calculated using the [http://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance] algorithm).  The default value is 0.5 but can be configured in SolrConfigXml.
- 
- === onlyMorePopular ===
- 
- When "onlyMorePopular" is set to true and the misspelled word exists in the user field, only words that occur more frequently in the termSourceField than the one given will be returned.  The default value is false.
  
  === cmd ===
  
@@ -132, +132 @@

  
  If an external process is responsible for building the spell checker index, you must issue '&cmd=reopen' to force the spell checker index directory to be re-opened .
  
+ == query-related parameters ==
+ 
+ === suggestionCount ===
+ 
+ (sp.query.suggestionCount in <!> ["Solr1.3"])
+ 
+ Determines how many spelling suggestions are returned.  The default value is 1 but can be configured in SolrConfigXml.  The order of the returned results is determined by both the [http://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance] (or accuracy) of the suggestion and the popularity (the frequency) of the suggested word in the termSourceField.
+ 
+ === accuracy ===
+ 
+ (sp.query.accurary in <!> ["Solr1.3"])
+ 
+ A float value between 1.0 and 0.0 on how close the suggested words should match the original word being checked (calculated using the [http://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance] algorithm).  The default value is 0.5 but can be configured in SolrConfigXml.
+ 
+ === onlyMorePopular ===
+ 
+ (sp.query.onlyMorePopular in <!> ["Solr1.3"])
+ 
+ When "onlyMorePopular" is set to true and the misspelled word exists in the user field, only words that occur more frequently in the termSourceField than the one given will be returned.  The default value is false.
+ 
+ == sp.query.extendedResults ==
+ 
+ Whether to use the extended response format, which is more complicated but richer.  Returns the document frequency for each suggestion and returns one suggestion block for each term in the query string.
+ 
+ The default value is '`false`'. <!> ["Solr1.3"]
  
  == Examples ==