my_help 1.2.3 → 1.2.4p1
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/.yardoc/checksums +1 -1
- data/.yardoc/objects/root.dat +0 -0
- data/Gemfile.lock +10 -11
- data/README.org +117 -84
- data/README_e.org +110 -0
- data/development_memo.org +5 -0
- data/doc/MyHelp/CLI.html +751 -0
- data/doc/MyHelp/Config.html +693 -0
- data/doc/MyHelp/Error.html +124 -0
- data/doc/MyHelp/GetConfig.html +196 -0
- data/doc/MyHelp/Git.html +291 -0
- data/doc/MyHelp/Init.html +449 -0
- data/doc/MyHelp/List.html +581 -0
- data/doc/MyHelp/Md2Hash.html +632 -0
- data/doc/MyHelp/Modify.html +393 -0
- data/doc/MyHelp/Org2Hash.html +544 -0
- data/doc/MyHelp.html +135 -0
- data/doc/Org2Yaml.html +497 -0
- data/doc/_index.html +230 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +181 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +181 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +451 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/my_help/cli.rb +28 -2
- data/lib/my_help/org2hash.rb +2 -1
- data/lib/my_help/version.rb +1 -1
- data/lib/templates/emacs.org +2 -1
- data/lib/templates/emacs_j.org +76 -0
- data/lib/templates/example.org +3 -2
- data/lib/templates/my_help_j.org +24 -0
- data/lib/templates/org_j.org +25 -0
- data/my_help_install.org +33 -0
- metadata +34 -5
- data/README_j.org +0 -143
- data/tmp.txt +0 -14
|
@@ -0,0 +1,449 @@
|
|
|
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
|
+
Class: MyHelp::Init
|
|
8
|
+
|
|
9
|
+
— my_help
|
|
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 = "MyHelp::Init";
|
|
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 (I)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../MyHelp.html" title="MyHelp (module)">MyHelp</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Init</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>Class: MyHelp::Init
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">MyHelp::Init</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/my_help/init.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<h2>
|
|
111
|
+
Instance Method Summary
|
|
112
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
113
|
+
</h2>
|
|
114
|
+
|
|
115
|
+
<ul class="summary">
|
|
116
|
+
|
|
117
|
+
<li class="public ">
|
|
118
|
+
<span class="summary_signature">
|
|
119
|
+
|
|
120
|
+
<a href="#check_conf_exist-instance_method" title="#check_conf_exist (instance method)">#<strong>check_conf_exist</strong> ⇒ Object </a>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</span>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
135
|
+
|
|
136
|
+
</li>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#cp_templates-instance_method" title="#cp_templates (instance method)">#<strong>cp_templates</strong> ⇒ Object </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
157
|
+
|
|
158
|
+
</li>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<li class="public ">
|
|
162
|
+
<span class="summary_signature">
|
|
163
|
+
|
|
164
|
+
<a href="#help_dir_exist%3F-instance_method" title="#help_dir_exist? (instance method)">#<strong>help_dir_exist?</strong> ⇒ Boolean </a>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(config) ⇒ Init </a>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="note title constructor">constructor</span>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<span class="summary_desc"><div class='inline'>
|
|
203
|
+
<p>A new instance of Init.</p>
|
|
204
|
+
</div></span>
|
|
205
|
+
|
|
206
|
+
</li>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<li class="public ">
|
|
210
|
+
<span class="summary_signature">
|
|
211
|
+
|
|
212
|
+
<a href="#mk_help_dir-instance_method" title="#mk_help_dir (instance method)">#<strong>mk_help_dir</strong> ⇒ Object </a>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
</span>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</ul>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<div id="constructor_details" class="method_details_list">
|
|
235
|
+
<h2>Constructor Details</h2>
|
|
236
|
+
|
|
237
|
+
<div class="method_details first">
|
|
238
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
239
|
+
|
|
240
|
+
#<strong>initialize</strong>(config) ⇒ <tt><span class='object_link'><a href="" title="MyHelp::Init (class)">Init</a></span></tt>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</h3><div class="docstring">
|
|
247
|
+
<div class="discussion">
|
|
248
|
+
|
|
249
|
+
<p>Returns a new instance of Init.</p>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
</div>
|
|
253
|
+
</div>
|
|
254
|
+
<div class="tags">
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</div><table class="source_code">
|
|
258
|
+
<tr>
|
|
259
|
+
<td>
|
|
260
|
+
<pre class="lines">
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
3
|
|
264
|
+
4
|
|
265
|
+
5</pre>
|
|
266
|
+
</td>
|
|
267
|
+
<td>
|
|
268
|
+
<pre class="code"><span class="info file"># File 'lib/my_help/init.rb', line 3</span>
|
|
269
|
+
|
|
270
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
|
|
271
|
+
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span>
|
|
272
|
+
<span class='kw'>end</span></pre>
|
|
273
|
+
</td>
|
|
274
|
+
</tr>
|
|
275
|
+
</table>
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
</div>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<div id="instance_method_details" class="method_details_list">
|
|
282
|
+
<h2>Instance Method Details</h2>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<div class="method_details first">
|
|
286
|
+
<h3 class="signature first" id="check_conf_exist-instance_method">
|
|
287
|
+
|
|
288
|
+
#<strong>check_conf_exist</strong> ⇒ <tt>Object</tt>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
</h3><table class="source_code">
|
|
295
|
+
<tr>
|
|
296
|
+
<td>
|
|
297
|
+
<pre class="lines">
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
11
|
|
301
|
+
12
|
|
302
|
+
13</pre>
|
|
303
|
+
</td>
|
|
304
|
+
<td>
|
|
305
|
+
<pre class="code"><span class="info file"># File 'lib/my_help/init.rb', line 11</span>
|
|
306
|
+
|
|
307
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_conf_exist'>check_conf_exist</span>
|
|
308
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:conf_file</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
309
|
+
<span class='kw'>end</span></pre>
|
|
310
|
+
</td>
|
|
311
|
+
</tr>
|
|
312
|
+
</table>
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
<div class="method_details ">
|
|
316
|
+
<h3 class="signature " id="cp_templates-instance_method">
|
|
317
|
+
|
|
318
|
+
#<strong>cp_templates</strong> ⇒ <tt>Object</tt>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
</h3><table class="source_code">
|
|
325
|
+
<tr>
|
|
326
|
+
<td>
|
|
327
|
+
<pre class="lines">
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
19
|
|
331
|
+
20
|
|
332
|
+
21
|
|
333
|
+
22
|
|
334
|
+
23
|
|
335
|
+
24
|
|
336
|
+
25
|
|
337
|
+
26</pre>
|
|
338
|
+
</td>
|
|
339
|
+
<td>
|
|
340
|
+
<pre class="code"><span class="info file"># File 'lib/my_help/init.rb', line 19</span>
|
|
341
|
+
|
|
342
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cp_templates'>cp_templates</span>
|
|
343
|
+
<span class='id identifier rubyid_target_dir'>target_dir</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:local_help_dir</span><span class='rbracket'>]</span>
|
|
344
|
+
<span class='id identifier rubyid_src_dir'>src_dir</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:template_dir</span><span class='rbracket'>]</span>
|
|
345
|
+
<span class='id identifier rubyid_ext'>ext</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:ext</span><span class='rbracket'>]</span>
|
|
346
|
+
<span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_src_dir'>src_dir</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ext'>ext</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span>
|
|
347
|
+
<span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_cp'>cp</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_target_dir'>target_dir</span><span class='comma'>,</span> <span class='label'>verbose:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
348
|
+
<span class='kw'>end</span>
|
|
349
|
+
<span class='kw'>end</span></pre>
|
|
350
|
+
</td>
|
|
351
|
+
</tr>
|
|
352
|
+
</table>
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
<div class="method_details ">
|
|
356
|
+
<h3 class="signature " id="help_dir_exist?-instance_method">
|
|
357
|
+
|
|
358
|
+
#<strong>help_dir_exist?</strong> ⇒ <tt>Boolean</tt>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
</h3><div class="docstring">
|
|
365
|
+
<div class="discussion">
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</div>
|
|
369
|
+
</div>
|
|
370
|
+
<div class="tags">
|
|
371
|
+
|
|
372
|
+
<p class="tag_title">Returns:</p>
|
|
373
|
+
<ul class="return">
|
|
374
|
+
|
|
375
|
+
<li>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</li>
|
|
383
|
+
|
|
384
|
+
</ul>
|
|
385
|
+
|
|
386
|
+
</div><table class="source_code">
|
|
387
|
+
<tr>
|
|
388
|
+
<td>
|
|
389
|
+
<pre class="lines">
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
7
|
|
393
|
+
8
|
|
394
|
+
9</pre>
|
|
395
|
+
</td>
|
|
396
|
+
<td>
|
|
397
|
+
<pre class="code"><span class="info file"># File 'lib/my_help/init.rb', line 7</span>
|
|
398
|
+
|
|
399
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_help_dir_exist?'>help_dir_exist?</span>
|
|
400
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:local_help_dir</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
401
|
+
<span class='kw'>end</span></pre>
|
|
402
|
+
</td>
|
|
403
|
+
</tr>
|
|
404
|
+
</table>
|
|
405
|
+
</div>
|
|
406
|
+
|
|
407
|
+
<div class="method_details ">
|
|
408
|
+
<h3 class="signature " id="mk_help_dir-instance_method">
|
|
409
|
+
|
|
410
|
+
#<strong>mk_help_dir</strong> ⇒ <tt>Object</tt>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
</h3><table class="source_code">
|
|
417
|
+
<tr>
|
|
418
|
+
<td>
|
|
419
|
+
<pre class="lines">
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
15
|
|
423
|
+
16
|
|
424
|
+
17</pre>
|
|
425
|
+
</td>
|
|
426
|
+
<td>
|
|
427
|
+
<pre class="code"><span class="info file"># File 'lib/my_help/init.rb', line 15</span>
|
|
428
|
+
|
|
429
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_mk_help_dir'>mk_help_dir</span>
|
|
430
|
+
<span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_mkdir'>mkdir</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:local_help_dir</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
431
|
+
<span class='kw'>end</span></pre>
|
|
432
|
+
</td>
|
|
433
|
+
</tr>
|
|
434
|
+
</table>
|
|
435
|
+
</div>
|
|
436
|
+
|
|
437
|
+
</div>
|
|
438
|
+
|
|
439
|
+
</div>
|
|
440
|
+
|
|
441
|
+
<div id="footer">
|
|
442
|
+
Generated on Thu Sep 26 14:20:52 2024 by
|
|
443
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
444
|
+
0.9.36 (ruby-3.0.2).
|
|
445
|
+
</div>
|
|
446
|
+
|
|
447
|
+
</div>
|
|
448
|
+
</body>
|
|
449
|
+
</html>
|