diff --git a/doc/map.jax b/doc/map.jax index 4a6d86e76..b000f2f1a 100644 --- a/doc/map.jax +++ b/doc/map.jax @@ -1,4 +1,4 @@ -*map.txt* For Vim バージョン 9.2. Last change: 2026 Feb 14 +*map.txt* For Vim バージョン 9.2. Last change: 2026 May 02 VIM リファレンスマニュアル by Bram Moolenaar @@ -1671,8 +1671,22 @@ Note: いくつかの補完方法は環境変数を展開します。 "custom" を使った場合は、補完候補のリストを一つずつ改行で区切ってください。 *E1303* -"customlist" を使った場合は、補完候補のリストを |List| で返してください。リス -ト中の文字列以外の変数は無視されます。 +"customlist" を使った場合は、補完候補のリストを |List| で返すこと。各項目は文 +字列または |Dictionary| のいずれかである。 +辞書の項目は、以下のキーを持つことができる: + word (必須) 項目が選択されたときにコマンドラインに挿入されるテキス + ト。 + abbr 'wildoptions' に "pum" が含まれている場合、ポップアップメニュー + に "word" の代わりに代替テキストが表示される。挿入されたテキス + トと表示されるテキストが異なる必要がある場合に便利である + kind 'wildoptions' に "pum" が含まれている場合にポップアップメニュー + に表示される、短い種類のテキスト (1 文字または 2 文字) + menu ポップアップメニューの、マッチした項目の後ろに表示される追加テ + キスト + info 詳しい説明が情報ポップアップに表示される。表示するには + |+popupwin| 機能が必要である。 +文字列でも辞書でもない項目、および "word" キーを持たない辞書項目は無視される。 +「'wildoptions' に "pum" が含まれていない場合、"word" のみが表示される。 引数には次の意味があります: ArgLead すでに入力されている補完対象の文字列。note "-nargs=1" diff --git a/en/map.txt b/en/map.txt index 118e2d44e..a79c0388c 100644 --- a/en/map.txt +++ b/en/map.txt @@ -1,4 +1,4 @@ -*map.txt* For Vim version 9.2. Last change: 2026 Feb 14 +*map.txt* For Vim version 9.2. Last change: 2026 May 02 VIM REFERENCE MANUAL by Bram Moolenaar @@ -1693,7 +1693,21 @@ For the "custom" argument, the function should return the completion candidates one per line in a newline separated string. *E1303* For the "customlist" argument, the function should return the completion -candidates as a Vim List. Non-string items in the list are ignored. +candidates as a Vim List. Each item may be either a string or a |Dictionary|. +A Dictionary item may have the following keys: + word (required) the text inserted into the command line when the + item is selected + abbr alternative text shown in the popup menu in place of "word", + when 'wildoptions' contains "pum"; useful when the inserted + text and the displayed text should differ + kind short kind text (one or two characters), shown in the popup + menu when 'wildoptions' contains "pum" + menu extra text shown after the match in the popup menu + info long description shown in the info popup; the |+popupwin| + feature is required to display it +Items that are neither a string nor a Dictionary, and Dictionary items without +a "word" key, are ignored. When 'wildoptions' does not contain "pum", only +"word" is shown. The function arguments are: ArgLead the leading portion of the argument currently being