Merge pull request #869 from xiaoyifang/doc/update-fulltext

doc: update fulltext document
This commit is contained in:
xiaoyifang 2023-06-17 18:05:46 +08:00 committed by GitHub
commit 891e7a9315
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 2 additions and 10 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

View file

@ -6,24 +6,16 @@ Full-text search allow to search words or sentences not in dictionary headwords
The dictionary will index for full-text search in background and started immediately after program start, name of the currently indexing dictionary is displayed in the status line. This process can take a long time and require many computing resources.You may turn off indexing for huge dictionaries like Wikipedias or Wiktionaries in preferences. To find dictionary which can't be indexed check GoldenDict with `--log-to-file` or check `stdout`.
![full text serach](img/fulltext.webp){ width="450" }
![full text serach](img/fulltext.png){ width="450" }
Type the desired word in "Search line" to search.
Search modes
* "Whole words" - for every word contains more then 4 characters in search line the exact match will be found. The "Max distance between words" element define the maximum unmatched words number between matched words. It is the fastest search mode. The search line must contain at least one word from 4 or more characters.
* "Whole words" - This follow the xapian search syntax . check [query syntax](https://xapian.org/docs/queryparser.html).
* "Plain text" - mode like "Whole words" but every word in search line can be treated as word fragment.
* "Wildcards" - the search line contains a Unix-like template. Such template can contain wildcard symbols `?` (matches any one character), `*` (matches any characters number) or ranges of characters `[...]` To find characters `?`, `*`, `[` and `]` it should be escaped by backslash like `\?`, `\*`, `\[`, `\]`.
* "RegExp" - the search line contains a regular expression.
"Max articles per dictionary" - the search in dictionary will be stopped when this articles number is found in that dictionary.
"Match case" - if this option is turned on the matches search will be completed in the case-sensitive mode, otherwise in case-insensitive mode.
"Ignore words order" - if this option is enabled, the words specified in the search string will be searched in any order in dictionaries. Otherwise ones will be searched in the order stated in the search string.
"Ignore diacritics" - if this option is enabled, the diacritic symbols will be searched as its base ones.
"Available dictionaries in group" - here you can view how many dictionaries in current group are suitable for full-text search, how many dictionaries already indexed and how many dictionaries wait for indexing.