doing 2.1.40 → 2.1.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/CHANGELOG.md +22 -0
- data/Gemfile.lock +1 -1
- data/Rakefile +4 -4
- data/bin/commands/changes.rb +1 -1
- data/bin/commands/tag_dir.rb +49 -15
- data/{Dockerfile → docker/Dockerfile} +3 -1
- data/{Dockerfile-2.6 → docker/Dockerfile-2.6} +2 -2
- data/{Dockerfile-2.7 → docker/Dockerfile-2.7} +2 -2
- data/{Dockerfile-3.0 → docker/Dockerfile-3.0} +2 -2
- data/{bash_profile → docker/bash_profile} +0 -0
- data/{inputrc → docker/inputrc} +0 -0
- data/docs/doc/Array.html +84 -2
- data/docs/doc/BooleanTermParser/Clause.html +1 -1
- data/docs/doc/BooleanTermParser/Operator.html +1 -1
- data/docs/doc/BooleanTermParser/Query.html +1 -1
- data/docs/doc/BooleanTermParser/QueryParser.html +1 -1
- data/docs/doc/BooleanTermParser/QueryTransformer.html +1 -1
- data/docs/doc/BooleanTermParser.html +1 -1
- data/docs/doc/Doing/ArrayNestedHash.html +198 -0
- data/docs/doc/Doing/ArrayTags.html +424 -0
- data/docs/doc/Doing/CSVExport.html +266 -0
- data/docs/doc/Doing/CalendarImport.html +232 -0
- data/docs/doc/Doing/Change.html +617 -0
- data/docs/doc/Doing/Changes.html +468 -0
- data/docs/doc/Doing/ChronifyArray.html +347 -0
- data/docs/doc/Doing/ChronifyNumeric.html +271 -0
- data/docs/doc/Doing/ChronifyString.html +682 -0
- data/docs/doc/Doing/Color.html +2 -2
- data/docs/doc/Doing/Completion/BashCompletions.html +445 -0
- data/docs/doc/Doing/Completion/FishCompletions.html +445 -0
- data/docs/doc/Doing/Completion/StringUtils.html +229 -0
- data/docs/doc/Doing/Completion/ZshCompletions.html +445 -0
- data/docs/doc/Doing/Completion.html +17 -3
- data/docs/doc/Doing/Configuration.html +1 -1
- data/docs/doc/Doing/DayOneRenderer.html +383 -0
- data/docs/doc/Doing/DayoneExport.html +290 -0
- data/docs/doc/Doing/DoingImport.html +391 -0
- data/docs/doc/Doing/Entry.html +381 -0
- data/docs/doc/Doing/Errors/DoingNoTraceError.html +1 -1
- data/docs/doc/Doing/Errors/DoingRuntimeError.html +1 -1
- data/docs/doc/Doing/Errors/DoingStandardError.html +1 -1
- data/docs/doc/Doing/Errors/EmptyInput.html +1 -1
- data/docs/doc/Doing/Errors/HistoryLimitError.html +1 -1
- data/docs/doc/Doing/Errors/InvalidPlugin.html +1 -1
- data/docs/doc/Doing/Errors/MissingBackupFile.html +1 -1
- data/docs/doc/Doing/Errors/NoResults.html +1 -1
- data/docs/doc/Doing/Errors/PluginException.html +1 -1
- data/docs/doc/Doing/Errors/UserCancelled.html +1 -1
- data/docs/doc/Doing/Errors/WrongCommand.html +1 -1
- data/docs/doc/Doing/Errors.html +1 -1
- data/docs/doc/Doing/HTMLExport.html +256 -0
- data/docs/doc/Doing/Hooks.html +1 -1
- data/docs/doc/Doing/Item.html +47 -3
- data/docs/doc/Doing/ItemDates.html +564 -0
- data/docs/doc/Doing/ItemQuery.html +614 -0
- data/docs/doc/Doing/ItemState.html +387 -0
- data/docs/doc/Doing/ItemTags.html +498 -0
- data/docs/doc/Doing/Items.html +460 -11
- data/docs/doc/Doing/JSONExport.html +222 -0
- data/docs/doc/Doing/Logger.html +1 -1
- data/docs/doc/Doing/MarkdownExport.html +266 -0
- data/docs/doc/Doing/MarkdownRenderer.html +383 -0
- data/docs/doc/Doing/Note.html +16 -3
- data/docs/doc/Doing/Pager.html +1 -1
- data/docs/doc/Doing/Plugins.html +1 -1
- data/docs/doc/Doing/Prompt.html +31 -682
- data/docs/doc/Doing/PromptChoose.html +484 -0
- data/docs/doc/Doing/PromptFZF.html +391 -0
- data/docs/doc/Doing/PromptInput.html +572 -0
- data/docs/doc/Doing/PromptSTD.html +293 -0
- data/docs/doc/Doing/PromptYN.html +237 -0
- data/docs/doc/Doing/Section.html +58 -2
- data/docs/doc/Doing/StringHighlight.html +533 -0
- data/docs/doc/Doing/StringNormalize.html +929 -0
- data/docs/doc/Doing/StringQuery.html +725 -0
- data/docs/doc/Doing/StringTags.html +884 -0
- data/docs/doc/Doing/StringTransform.html +565 -0
- data/docs/doc/Doing/StringTruncate.html +448 -0
- data/docs/doc/Doing/StringURL.html +409 -0
- data/docs/doc/Doing/SymbolNormalize.html +341 -0
- data/docs/doc/Doing/TaskPaperExport.html +222 -0
- data/docs/doc/Doing/TemplateExport.html +249 -0
- data/docs/doc/Doing/TemplateString.html +101 -2
- data/docs/doc/Doing/TimingImport.html +285 -0
- data/docs/doc/Doing/Types.html +1 -1
- data/docs/doc/Doing/Util/Backup.html +9 -7
- data/docs/doc/Doing/Util.html +2 -2
- data/docs/doc/Doing/Version.html +523 -0
- data/docs/doc/Doing/WWID/WWIDUtil.html +510 -0
- data/docs/doc/Doing/WWID.html +4377 -217
- data/docs/doc/Doing/WWIDDisplay.html +865 -0
- data/docs/doc/Doing/WWIDEditor.html +466 -0
- data/docs/doc/Doing/WWIDFileTools.html +359 -0
- data/docs/doc/Doing/WWIDFilter.html +466 -0
- data/docs/doc/Doing/WWIDGuess.html +299 -0
- data/docs/doc/Doing/WWIDInteractive.html +752 -0
- data/docs/doc/Doing/WWIDModify.html +1078 -0
- data/docs/doc/Doing/WWIDTags.html +302 -0
- data/docs/doc/Doing/WWIDTimers.html +359 -0
- data/docs/doc/Doing/WWIDUtil.html +510 -0
- data/docs/doc/Doing.html +9 -6
- data/docs/doc/FalseClass.html +1 -1
- data/docs/doc/GLI/Commands/Help.html +1 -1
- data/docs/doc/GLI/Commands/MarkdownDocumentListener.html +1 -1
- data/docs/doc/GLI/Commands.html +1 -1
- data/docs/doc/GLI.html +1 -1
- data/docs/doc/Hash.html +1 -1
- data/docs/doc/Numeric.html +23 -78
- data/docs/doc/Object.html +1 -1
- data/docs/doc/PhraseParser/Operator.html +1 -1
- data/docs/doc/PhraseParser/PhraseClause.html +1 -1
- data/docs/doc/PhraseParser/Query.html +1 -1
- data/docs/doc/PhraseParser/QueryParser.html +1 -1
- data/docs/doc/PhraseParser/QueryTransformer.html +1 -1
- data/docs/doc/PhraseParser/TermClause.html +1 -1
- data/docs/doc/PhraseParser.html +1 -1
- data/docs/doc/Status.html +1 -1
- data/docs/doc/String.html +58 -633
- data/docs/doc/Symbol.html +9 -224
- data/docs/doc/Time.html +119 -13
- data/docs/doc/TrueClass.html +1 -1
- data/docs/doc/_index.html +324 -8
- data/docs/doc/class_list.html +1 -1
- data/docs/doc/file.README.html +1 -1
- data/docs/doc/index.html +1 -1
- data/docs/doc/method_list.html +2326 -542
- data/docs/doc/top-level-namespace.html +2 -2
- data/doing.rdoc +13 -3
- data/lib/completion/_doing.zsh +1 -1
- data/lib/completion/doing.bash +2 -2
- data/lib/completion/doing.fish +3 -1
- data/lib/doing/array/array.rb +16 -12
- data/lib/doing/array/nested_hash.rb +1 -1
- data/lib/doing/array/tags.rb +6 -5
- data/lib/doing/changelog/changelog.rb +6 -0
- data/lib/doing/chronify/array.rb +1 -3
- data/lib/doing/chronify/chronify.rb +12 -0
- data/lib/doing/chronify/numeric.rb +3 -2
- data/lib/doing/chronify/string.rb +1 -1
- data/lib/doing/completion/completion_string.rb +25 -0
- data/lib/doing/completion.rb +1 -1
- data/lib/doing/good.rb +8 -0
- data/lib/doing/item/dates.rb +1 -1
- data/lib/doing/{item.rb → item/item.rb} +10 -5
- data/lib/doing/item/query.rb +1 -1
- data/lib/doing/item/state.rb +1 -1
- data/lib/doing/item/tags.rb +1 -1
- data/lib/doing/items/filter.rb +67 -0
- data/lib/doing/items/items.rb +57 -0
- data/lib/doing/items/modify.rb +36 -0
- data/lib/doing/items/sections.rb +83 -0
- data/lib/doing/items/util.rb +74 -0
- data/lib/doing/normalize.rb +10 -2
- data/lib/doing/plugins/export/markdown_export.rb +4 -2
- data/lib/doing/plugins/import/doing_import.rb +1 -1
- data/lib/doing/prompt/choose.rb +118 -0
- data/lib/doing/prompt/fzf.rb +84 -0
- data/lib/doing/prompt/input.rb +129 -0
- data/lib/doing/prompt/prompt.rb +41 -0
- data/lib/doing/prompt/std.rb +32 -0
- data/lib/doing/prompt/yn.rb +64 -0
- data/lib/doing/section.rb +4 -0
- data/lib/doing/string/highlight.rb +1 -1
- data/lib/doing/string/query.rb +1 -1
- data/lib/doing/string/string.rb +18 -7
- data/lib/doing/string/tags.rb +14 -3
- data/lib/doing/string/transform.rb +1 -1
- data/lib/doing/string/truncate.rb +1 -1
- data/lib/doing/string/url.rb +1 -1
- data/lib/doing/time.rb +19 -1
- data/lib/doing/util_backup.rb +2 -2
- data/lib/doing/version.rb +1 -1
- data/lib/doing/wwid/display.rb +357 -360
- data/lib/doing/wwid/editor.rb +173 -176
- data/lib/doing/wwid/filetools.rb +156 -159
- data/lib/doing/wwid/filter.rb +191 -183
- data/lib/doing/wwid/guess.rb +58 -60
- data/lib/doing/wwid/interactive.rb +332 -330
- data/lib/doing/wwid/modify.rb +509 -512
- data/lib/doing/wwid/tags.rb +38 -41
- data/lib/doing/wwid/timers.rb +293 -296
- data/lib/doing/{wwid.rb → wwid/wwid.rb} +32 -23
- data/lib/doing/wwid/wwidutil.rb +79 -82
- data/lib/doing.rb +5 -5
- data/lib/helpers/threaded_tests.rb +1 -0
- metadata +76 -14
- data/lib/doing/changelog.rb +0 -6
- data/lib/doing/completion/string.rb +0 -17
- data/lib/doing/items.rb +0 -221
- data/lib/doing/prompt.rb +0 -330
|
@@ -0,0 +1,484 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: Doing::PromptChoose
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Doing::PromptChoose";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">PromptChoose</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: Doing::PromptChoose
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="Prompt.html" title="Doing::Prompt (module)">Prompt</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/doing/prompt/choose.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
<p>Methods for creating interactive menus of options and items</p>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
</div>
|
|
97
|
+
</div>
|
|
98
|
+
<div class="tags">
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<h2>
|
|
110
|
+
Instance Method Summary
|
|
111
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
112
|
+
</h2>
|
|
113
|
+
|
|
114
|
+
<ul class="summary">
|
|
115
|
+
|
|
116
|
+
<li class="public ">
|
|
117
|
+
<span class="summary_signature">
|
|
118
|
+
|
|
119
|
+
<a href="#choose_from-instance_method" title="#choose_from (instance method)">#<strong>choose_from</strong>(options, prompt: 'Make a selection: ', multiple: false, sorted: true, fzf_args: []) ⇒ String </a>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</span>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<span class="summary_desc"><div class='inline'><p>Generate a menu of options and allow user selection.</p>
|
|
134
|
+
</div></span>
|
|
135
|
+
|
|
136
|
+
</li>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#choose_from_items-instance_method" title="#choose_from_items (instance method)">#<strong>choose_from_items</strong>(items, **opt) ⇒ Object </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'><p>Create an interactive menu to select from a set of Items.</p>
|
|
157
|
+
</div></span>
|
|
158
|
+
|
|
159
|
+
</li>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</ul>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<div id="instance_method_details" class="method_details_list">
|
|
168
|
+
<h2>Instance Method Details</h2>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div class="method_details first">
|
|
172
|
+
<h3 class="signature first" id="choose_from-instance_method">
|
|
173
|
+
|
|
174
|
+
#<strong>choose_from</strong>(options, prompt: 'Make a selection: ', multiple: false, sorted: true, fzf_args: []) ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</h3><div class="docstring">
|
|
181
|
+
<div class="discussion">
|
|
182
|
+
<p>Generate a menu of options and allow user selection</p>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
<div class="tags">
|
|
188
|
+
<p class="tag_title">Parameters:</p>
|
|
189
|
+
<ul class="param">
|
|
190
|
+
|
|
191
|
+
<li>
|
|
192
|
+
|
|
193
|
+
<span class='name'>options</span>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
—
|
|
201
|
+
<div class='inline'><p>The options from which to choose</p>
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
<li>
|
|
207
|
+
|
|
208
|
+
<span class='name'>prompt</span>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<em class="default">(defaults to: <tt>'Make a selection: '</tt>)</em>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
—
|
|
218
|
+
<div class='inline'><p>The prompt</p>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
</li>
|
|
222
|
+
|
|
223
|
+
<li>
|
|
224
|
+
|
|
225
|
+
<span class='name'>multiple</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
—
|
|
235
|
+
<div class='inline'><p>If true, allow multiple selections</p>
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
</li>
|
|
239
|
+
|
|
240
|
+
<li>
|
|
241
|
+
|
|
242
|
+
<span class='name'>sorted</span>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
—
|
|
252
|
+
<div class='inline'><p>If true, sort selections alphanumerically</p>
|
|
253
|
+
</div>
|
|
254
|
+
|
|
255
|
+
</li>
|
|
256
|
+
|
|
257
|
+
<li>
|
|
258
|
+
|
|
259
|
+
<span class='name'>fzf_args</span>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
—
|
|
269
|
+
<div class='inline'><p>Additional fzf arguments</p>
|
|
270
|
+
</div>
|
|
271
|
+
|
|
272
|
+
</li>
|
|
273
|
+
|
|
274
|
+
</ul>
|
|
275
|
+
|
|
276
|
+
<p class="tag_title">Returns:</p>
|
|
277
|
+
<ul class="return">
|
|
278
|
+
|
|
279
|
+
<li>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
—
|
|
287
|
+
<div class='inline'><p>The selected option</p>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
</li>
|
|
291
|
+
|
|
292
|
+
</ul>
|
|
293
|
+
|
|
294
|
+
</div>
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
<div class="method_details ">
|
|
298
|
+
<h3 class="signature " id="choose_from_items-instance_method">
|
|
299
|
+
|
|
300
|
+
#<strong>choose_from_items</strong>(items, **opt) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
</h3><div class="docstring">
|
|
307
|
+
<div class="discussion">
|
|
308
|
+
<p>Create an interactive menu to select from a set of Items</p>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</div>
|
|
312
|
+
</div>
|
|
313
|
+
<div class="tags">
|
|
314
|
+
<p class="tag_title">Parameters:</p>
|
|
315
|
+
<ul class="param">
|
|
316
|
+
|
|
317
|
+
<li>
|
|
318
|
+
|
|
319
|
+
<span class='name'>items</span>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
—
|
|
327
|
+
<div class='inline'><p>list of items</p>
|
|
328
|
+
</div>
|
|
329
|
+
|
|
330
|
+
</li>
|
|
331
|
+
|
|
332
|
+
<li>
|
|
333
|
+
|
|
334
|
+
<span class='name'>opt</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class='type'></span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
—
|
|
342
|
+
<div class='inline'><p>Additional options</p>
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
</ul>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<p class="tag_title">Options Hash (<tt>**opt</tt>):</p>
|
|
355
|
+
<ul class="option">
|
|
356
|
+
|
|
357
|
+
<li>
|
|
358
|
+
<span class="name">:include_section</span>
|
|
359
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
360
|
+
<span class="default">
|
|
361
|
+
|
|
362
|
+
</span>
|
|
363
|
+
|
|
364
|
+
— <div class='inline'><p>Include section name for each item in menu</p>
|
|
365
|
+
</div>
|
|
366
|
+
|
|
367
|
+
</li>
|
|
368
|
+
|
|
369
|
+
<li>
|
|
370
|
+
<span class="name">:header</span>
|
|
371
|
+
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
372
|
+
<span class="default">
|
|
373
|
+
|
|
374
|
+
</span>
|
|
375
|
+
|
|
376
|
+
— <div class='inline'><p>A custom header string</p>
|
|
377
|
+
</div>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
<li>
|
|
382
|
+
<span class="name">:prompt</span>
|
|
383
|
+
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
384
|
+
<span class="default">
|
|
385
|
+
|
|
386
|
+
</span>
|
|
387
|
+
|
|
388
|
+
— <div class='inline'><p>A custom prompt string</p>
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
</li>
|
|
392
|
+
|
|
393
|
+
<li>
|
|
394
|
+
<span class="name">:query</span>
|
|
395
|
+
<span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
396
|
+
<span class="default">
|
|
397
|
+
|
|
398
|
+
</span>
|
|
399
|
+
|
|
400
|
+
— <div class='inline'><p>Initial query</p>
|
|
401
|
+
</div>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
<li>
|
|
406
|
+
<span class="name">:show_if_single</span>
|
|
407
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
408
|
+
<span class="default">
|
|
409
|
+
|
|
410
|
+
</span>
|
|
411
|
+
|
|
412
|
+
— <div class='inline'><p>Show menu even if there's only one option</p>
|
|
413
|
+
</div>
|
|
414
|
+
|
|
415
|
+
</li>
|
|
416
|
+
|
|
417
|
+
<li>
|
|
418
|
+
<span class="name">:menu</span>
|
|
419
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
420
|
+
<span class="default">
|
|
421
|
+
|
|
422
|
+
</span>
|
|
423
|
+
|
|
424
|
+
— <div class='inline'><p>Show menu</p>
|
|
425
|
+
</div>
|
|
426
|
+
|
|
427
|
+
</li>
|
|
428
|
+
|
|
429
|
+
<li>
|
|
430
|
+
<span class="name">:sort</span>
|
|
431
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
432
|
+
<span class="default">
|
|
433
|
+
|
|
434
|
+
</span>
|
|
435
|
+
|
|
436
|
+
— <div class='inline'><p>Sort options</p>
|
|
437
|
+
</div>
|
|
438
|
+
|
|
439
|
+
</li>
|
|
440
|
+
|
|
441
|
+
<li>
|
|
442
|
+
<span class="name">:multiple</span>
|
|
443
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
444
|
+
<span class="default">
|
|
445
|
+
|
|
446
|
+
</span>
|
|
447
|
+
|
|
448
|
+
— <div class='inline'><p>Allow multiple selections</p>
|
|
449
|
+
</div>
|
|
450
|
+
|
|
451
|
+
</li>
|
|
452
|
+
|
|
453
|
+
<li>
|
|
454
|
+
<span class="name">:case</span>
|
|
455
|
+
<span class="type">(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
|
|
456
|
+
<span class="default">
|
|
457
|
+
|
|
458
|
+
— default:
|
|
459
|
+
<tt>:sensitive</tt>, <tt>:ignore</tt>, <tt>:smart</tt>
|
|
460
|
+
|
|
461
|
+
</span>
|
|
462
|
+
|
|
463
|
+
</li>
|
|
464
|
+
|
|
465
|
+
</ul>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</div>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
<div id="footer">
|
|
477
|
+
Generated on Wed Mar 16 09:42:15 2022 by
|
|
478
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
479
|
+
0.9.27 (ruby-3.0.1).
|
|
480
|
+
</div>
|
|
481
|
+
|
|
482
|
+
</div>
|
|
483
|
+
</body>
|
|
484
|
+
</html>
|