Skip to content

Commit 09176fa

Browse files
committed
Document full text search
1 parent 9912355 commit 09176fa

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/user_guide.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,22 @@ You may manually write URLS that contain these arguments, like so
375375
@filters=status,keyword&
376376
@columns=title,status,fixer
377377

378+
Full text search using the xapian, whoosh and native indexers treats
379+
the search query as a series of space separated words. Any word less
380+
than 2 characters or more than 25 characters is discarded. Also a
381+
stoplist is used to remove common words like "with", "and"
382+
etc. Additional stoplist words can be added in the tracker's
383+
config.ini file. Once filtering of the word list is done, each indexed
384+
item (e.g. title, file or message content ...) is searched and if all
385+
the terms are found in the item the item is returned. Then the items
386+
are mapped to an issue and the list of matching issues is generated.
387+
388+
Other searching backends such as native-fts can be used in which case
389+
the filtering above is not used. The search query can support
390+
structure such as quoted phrases, matching one term or another rather
391+
than both (or search), prefixes etc. In this case you should look at
392+
the documentation for the native-fts backend to find the supported
393+
format and features.
378394

379395
Access Controls
380396
---------------

0 commit comments

Comments
 (0)