diff options
author | Yegappan Lakshmanan <yegappan@yahoo.com> | 2021-10-16 15:41:29 +0100 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2021-10-16 15:41:29 +0100 |
commit | 160e994d768d03a3c826b58115cde94df8fce607 (patch) | |
tree | 38f6ec253633b656db1be92790c26fc71eb72eee /runtime/doc | |
parent | 2286304cdbba53ceb52b3ba2ba4a521b0a2f8d0f (diff) |
patch 8.2.3520: cannot define a function for thesaurus completionv8.2.3520
Problem: Cannot define a function for thesaurus completion.
Solution: Add 'thesaurusfunc'. (Yegappan Lakshmanan, closes #8987,
closes 8950)
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/insert.txt | 8 | ||||
-rw-r--r-- | runtime/doc/options.txt | 12 | ||||
-rw-r--r-- | runtime/doc/quickref.txt | 1 |
3 files changed, 20 insertions, 1 deletions
diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index 31b820f7b1..8d47a7e962 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -842,6 +842,12 @@ CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses Other uses include translation between two languages, or grouping API functions by keyword. + If the 'thesaurusfunc' option is set, then the user + specified function is invoked to get the list of + completion matches and the 'thesaurus' option is not + used. See |complete-functions| for an explanation of + how the function is invoked and what it should return. + CTRL-T or CTRL-N Search forward for next matching keyword. This keyword replaces the previous matching keyword. @@ -1052,7 +1058,7 @@ CTRL-X CTRL-Z Stop completion without changing the text. FUNCTIONS FOR FINDING COMPLETIONS *complete-functions* -This applies to 'completefunc' and 'omnifunc'. +This applies to 'completefunc', 'thesaurusfunc' and 'omnifunc'. The function is called in two different ways: - First the function is called to find the start of the text to be completed. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 41d710529e..67504795b6 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -8028,6 +8028,18 @@ A jump table for the options with a short description can be found at |Q_op|. uses another default. Backticks cannot be used in this option for security reasons. + *'thesaurusfunc'* *tsrfu'* +'thesaurusfunc' 'tsrfu' string (default: empty) + local to buffer + {not available when compiled without the |+eval| + feature} + This option specifies a function to be used for thesaurus completion + with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| + See |complete-functions| for an explanation of how the function is + invoked and what it should return. + This option cannot be set from a |modeline| or in the |sandbox|, for + security reasons. + *'tildeop'* *'top'* *'notildeop'* *'notop'* 'tildeop' 'top' boolean (default off) global diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt index fcdd5a7fe2..f7c5c1789e 100644 --- a/runtime/doc/quickref.txt +++ b/runtime/doc/quickref.txt @@ -948,6 +948,7 @@ Short explanation of each option: *option-list* 'textmode' 'tx' obsolete, use 'fileformat' 'textwidth' 'tw' maximum width of text that is being inserted 'thesaurus' 'tsr' list of thesaurus files for keyword completion +'thesaurusfunc' 'tsrfu' function to be used for thesaurus completion 'tildeop' 'top' tilde command "~" behaves like an operator 'timeout' 'to' time out on mappings and key codes 'timeoutlen' 'tm' time out time in milliseconds |