LP#1893997: mention new settings in the release notes
authorGalen Charlton <gmc@equinoxinitiative.org>
Mon, 15 Mar 2021 14:54:18 +0000 (10:54 -0400)
committerGalen Charlton <gmc@equinoxinitiative.org>
Mon, 15 Mar 2021 14:55:25 +0000 (10:55 -0400)
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
docs/RELEASE_NOTES_NEXT/OPAC/Did_You_Mean.adoc

index e22324c..ecdcad3 100644 (file)
@@ -15,6 +15,23 @@ misspelled words (as defined by existence in the bibliographic corpus),
 terms that are spelled properly but occur very few times, or on every
 single-term search.
 
+Settings
+++++++++
+
+The following new library settings control the behavior of the suggestions:
+
+* Maximum search result count at which spelling suggestions may be offered
+* Minimum required uses of a spelling suggestions that may be offered
+* Maximum number of spelling suggestions that may be offered
+* Pg_trgm score weighting in OPAC spelling suggestions
+* Soundex score weighting in OPAC spelling suggestions
+* QWERTY Keyboard similarity score weighting in OPAC spelling suggestions 
+
+There are also two new internal flags:
+
+* symspell.prefix_length
+* symspell.max_edit_distance
+
 Upgrading
 +++++++++++++++++++
 This feature requires the addition of new Perl module dependencies.  Please