Skip to content

Commit cb2c50c

Browse files
committed
Doc updates for indexers.
change word size max from 25 to 50 phrase search syntax updated clear up wording for automatic selection of xapian/whoosh link user_guide to admin_guide for finding syntax for native_fts searches.
1 parent 89a980c commit cb2c50c

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

doc/admin_guide.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ https://www.sqlite.org/fts5.html#full_text_query_syntax. This
305305
supports:
306306

307307
* plain word search (joined with and similar to other search methods)
308-
* phrase search with terms enclosed in ``"`` quotes
308+
* phrase search with terms enclosed in quotes (``"``)
309309
* proximity search with varying distances using ``NEAR()``
310310
* boolean operations by grouping with parentheses and using ``AND``
311311
and ``OR``
@@ -346,7 +346,7 @@ languages are supported.
346346
Websearch provides a more natural style of search and supports:
347347

348348
* plain word search (stemmed in most cases)
349-
* phrase search with terms enclosed in quotes
349+
* phrase search with terms enclosed in quotes (``"``)
350350
* exclusion by prefixing a term/phrase with ``-``
351351
* alternative/or searching with ``or`` between terms
352352
* ignores non-word characters including punctuation

doc/upgrading.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,16 @@ that have both of those words (an AND search) in a text-field (like
119119
title) or in a message (or file) attached to the issue.
120120

121121
One thing to note is that native-fts searches do not ignore words
122-
longer than 25 characters or less than 2 characters. Also SQLite does
123-
not filter out common works (i.e. there is no stopword list). So words
122+
longer than 50 characters or less than 2 characters. Also SQLite does
123+
not filter out common words (i.e. there is no stopword list). So words
124124
like "and", "or", "then", "with" ... are included in the FTS5 search.
125125

126126
You must explicitly enable this search mechanism by changing the
127-
``indexer`` setting in ``config.ini`` to ``native-fts``. Native-fts is
128-
never chosen by default like xapian or whoosh. This prevents the
129-
existing native indexing from being discarded if ``indexer`` is not
130-
set.
127+
``indexer`` setting in ``config.ini`` to ``native-fts``. Native-fts
128+
must be explicitly chosen. This is different from Xapian or Whoosh
129+
indexers, which are chosen if they are installed in the Python
130+
environment. This prevents the existing native indexing from being
131+
discarded if ``indexer`` is not set.
131132

132133
Next re-index your data with ``roundup-admin -i tracker_home
133134
reindex``. This can take a while depending on the size of the tracker.

doc/user_guide.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ You may manually write URLS that contain these arguments, like so
377377

378378
Full text search using the xapian, whoosh and native indexers treats
379379
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
380+
than 2 characters or more than 50 characters is discarded. Also a
381381
stoplist is used to remove common words like "with", "and"
382382
etc. Additional stoplist words can be added in the tracker's
383383
config.ini file. Once filtering of the word list is done, each indexed
@@ -389,8 +389,10 @@ Other searching backends such as native-fts can be used in which case
389389
the filtering above is not used. The search query can support
390390
structure such as quoted phrases, matching one term or another rather
391391
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.
392+
the `documentation for configuring the native-fts`_ backend to find
393+
the supported format and features.
394+
395+
.. _`documentation for configuring the native-fts`: admin_guide.html#configuring-native-fts-full-text-search
394396

395397
Access Controls
396398
---------------

0 commit comments

Comments
 (0)