-
Notifications
You must be signed in to change notification settings - Fork 6
/
ddu-source-help.txt
92 lines (63 loc) · 2.39 KB
/
ddu-source-help.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
*ddu-source-help.txt* help source for ddu.vim
Author: matsui54 <haru.matu9168 at gmail.com>
License: MIT license
CONTENTS *ddu-source-help-contents*
Introduction |ddu-source-help-introduction|
Install |ddu-source-help-install|
Examples |ddu-source-help-examples|
Params |ddu-source-help-params|
Actions |ddu-kind-help-actions|
==============================================================================
INTRODUCTION *ddu-source-help-introduction*
This source collects help tags from `&runtimepath/docs/tags`.
This also have help-kind.
==============================================================================
INSTALL *ddu-source-help-install*
Please install both "ddu.vim" and "denops.vim".
https://github.com/Shougo/ddu.vim
https://github.com/vim-denops/denops.vim
==============================================================================
EXAMPLES *ddu-source-help-examples*
==============================================================================
PARAMS *ddu-source-help-params*
*ddu-source-help-param-helpLang*
helpLang (string)
The same format as |'helplang'|.
Useful for overriding Vim's option value.
Default: undefined
*ddu-source-help-param-style*
style (string)
Style of how items are shown.
Valid values are the following.
minimal: Shows only one tag even if multiple languages
are available.
allLang: Shows tags for all available languages.
Default: "minimal"
==============================================================================
ACTIONS *ddu-kind-help-actions*
*ddu-kind-help-action-open*
open
Open help.
Params:
{command}: (string)
Command appended before `help` command. Valid values are like
"virtical" and "tab".
Note: If you pass "sp[lit], vs[plit] and tabe[dit]", they are
converted to valid open command, so that you can use the same
action as ddu-kind-file like the following. >
call ddu#ui#ff#do_action('itemAction',
\ {'name': 'open', 'params': {'command': 'vsplit'}})
<
*ddu-kind-help-action-vsplit*
vsplit
Open help in splited window.
*ddu-kind-help-action-tabopen*
tabopen
Open help in a new tab.
==============================================================================
KIND PARAMS *ddu-kind-help-params*
*ddu-kind-help-params-histadd*
histadd (boolean)
Add cmdline history.
Default: false
vim:tw=78:ts=8:ft=help:norl:noet:fen:noet: