diff doc/user_guide.txt @ 6592:828e2eaee7cd

Document full text search
author John Rouillard <rouilj@ieee.org>
date Mon, 24 Jan 2022 23:23:27 -0500
parents 24e2eeb2ed9a
children 2eec7a500333
line wrap: on
line diff
--- a/doc/user_guide.txt	Mon Jan 24 21:29:44 2022 -0500
+++ b/doc/user_guide.txt	Mon Jan 24 23:23:27 2022 -0500
@@ -375,6 +375,22 @@
         @filters=status,keyword&
         @columns=title,status,fixer
 
+Full text search using the xapian, whoosh and native indexers treats
+the search query as a series of space separated words. Any word less
+than 2 characters or more than 25 characters is discarded. Also a
+stoplist is used to remove common words like "with", "and"
+etc. Additional stoplist words can be added in the tracker's
+config.ini file. Once filtering of the word list is done, each indexed
+item (e.g. title, file or message content ...) is searched and if all
+the terms are found in the item the item is returned. Then the items
+are mapped to an issue and the list of matching issues is generated.
+
+Other searching backends such as native-fts can be used in which case
+the filtering above is not used. The search query can support
+structure such as quoted phrases, matching one term or another rather
+than both (or search), prefixes etc. In this case you should look at
+the documentation for the native-fts backend to find the supported
+format and features.
 
 Access Controls
 ---------------

Roundup Issue Tracker: http://roundup-tracker.org/