my_help 0.6.2 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -1
  3. data/.ruby-version +1 -1
  4. data/Gemfile +0 -3
  5. data/Gemfile.lock +10 -9
  6. data/README.html +362 -0
  7. data/README.org +58 -157
  8. data/README.rdoc +6 -0
  9. data/README_en.org +131 -0
  10. data/Rakefile_gli +44 -0
  11. data/bin/my_help +67 -0
  12. data/lib/my_help.rb +5 -204
  13. data/lib/my_help/my_help_controll.rb +139 -0
  14. data/lib/my_help/org2yml.rb +8 -2
  15. data/lib/my_help/version.rb +1 -1
  16. data/lib/templates/org_help.org +18 -15
  17. data/my_help.gemspec +23 -33
  18. data/my_help.rdoc +5 -0
  19. metadata +85 -55
  20. data/Dockerfile.template +0 -13
  21. data/bin/console +0 -14
  22. data/bin/setup +0 -8
  23. data/docs/README_en.org +0 -164
  24. data/docs/diff_against_org_mode.org +0 -38
  25. data/docs/path_setting.org +0 -47
  26. data/exe/e_h +0 -4
  27. data/exe/emacs_help +0 -4
  28. data/exe/m_t +0 -4
  29. data/exe/my_help +0 -6
  30. data/exe/my_todo +0 -4
  31. data/exe/o_h +0 -4
  32. data/exe/org_help +0 -4
  33. data/lib/emacs_help.rb +0 -137
  34. data/lib/my_help/test.rb +0 -29
  35. data/lib/my_help/yml2org.rb +0 -34
  36. data/lib/my_help_thor.rb +0 -170
  37. data/lib/specific_help.rb +0 -171
  38. data/lib/specific_help_bu.rb +0 -233
  39. data/lib/specific_help_opt.rb +0 -71
  40. data/lib/specific_help_thor.rb +0 -172
  41. data/make_docker.sh +0 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7d034615843f2ce0ae8ca406736a276595f02489
4
- data.tar.gz: a6068a28a01c640c442f427369c77f030b9cb400
3
+ metadata.gz: 78430acb2bc6f65ff113d7a47b2f5fdf2b551e01
4
+ data.tar.gz: 84abb9edb126223e9f3fa7b27dc56a8d43a8fe30
5
5
  SHA512:
6
- metadata.gz: 98b472efcaf1106fd365d7bc2017b0c48c41e182c9bf0ca5f73a03a6e5152b56b2bf4c8a814a8c0701898b1b8f5dd99ce3514b72d51049b572d088ea053bbb34
7
- data.tar.gz: b122d71ae12ab654c3079aa09404f451aff465bc6cc8ec8ad95007e5fc1a86a1cd20916183d8d77fc21c079bd7af3b4169b3a7fd334a8ce098edc994817e364f
6
+ metadata.gz: b8a75b42b847175b05a95d0283f1cab34678b0785a45bb22c6db56ba1830c17a49d717ea2bea3f6064afb3cbc14b997a2eeb12a50285ad68938681e2919a3e5f
7
+ data.tar.gz: 0d8a81bc080f5291a64646f2eab576e76f73293d53a40b903d231655310b21dd156a1489cc4d5b4d55c3b1f98d1bf09d1c7e3d08d99a6218e6fdb2566ac24666
data/.gitignore CHANGED
@@ -6,6 +6,6 @@
6
6
  /pkg/
7
7
  *~
8
8
  \#*
9
-
9
+ /before_gli/
10
10
  Dockerfile
11
11
 
data/.ruby-version CHANGED
@@ -1 +1 @@
1
- system
1
+ 2.4.3
data/Gemfile CHANGED
@@ -1,5 +1,2 @@
1
1
  source 'https://rubygems.org'
2
-
3
- # Specify your gem's dependencies in my_help.gemspec
4
2
  gemspec
5
- gem 'aruba', '~> 0.14.2'
data/Gemfile.lock CHANGED
@@ -1,9 +1,9 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- my_help (0.6.1)
4
+ my_help (0.0.1)
5
5
  colorize
6
- systemu
6
+ gli (= 2.17.1)
7
7
 
8
8
  GEM
9
9
  remote: https://rubygems.org/
@@ -15,7 +15,7 @@ GEM
15
15
  ffi (~> 1.9.10)
16
16
  rspec-expectations (>= 2.99)
17
17
  thor (~> 0.19)
18
- backports (3.11.1)
18
+ backports (3.11.3)
19
19
  builder (3.2.3)
20
20
  childprocess (0.9.0)
21
21
  ffi (~> 1.0, >= 1.0.11)
@@ -34,30 +34,31 @@ GEM
34
34
  backports (>= 3.8.0)
35
35
  cucumber-tag_expressions (~> 1.1.0)
36
36
  gherkin (>= 5.0.0)
37
- cucumber-expressions (5.0.13)
37
+ cucumber-expressions (5.0.17)
38
38
  cucumber-tag_expressions (1.1.1)
39
39
  cucumber-wire (0.0.1)
40
40
  diff-lcs (1.3)
41
41
  ffi (1.9.23)
42
42
  gherkin (5.0.0)
43
+ gli (2.17.1)
43
44
  multi_json (1.13.1)
44
45
  multi_test (0.1.2)
45
- rake (10.5.0)
46
+ rake (12.3.1)
47
+ rdoc (6.0.3)
46
48
  rspec-expectations (3.7.0)
47
49
  diff-lcs (>= 1.2.0, < 2.0)
48
50
  rspec-support (~> 3.7.0)
49
51
  rspec-support (3.7.1)
50
- systemu (2.6.5)
51
52
  thor (0.20.0)
52
53
 
53
54
  PLATFORMS
54
55
  ruby
55
56
 
56
57
  DEPENDENCIES
57
- aruba (~> 0.14.2)
58
- bundler (~> 1.11)
58
+ aruba
59
59
  my_help!
60
- rake (~> 10.0)
60
+ rake
61
+ rdoc
61
62
 
62
63
  BUNDLED WITH
63
64
  1.16.1
data/README.html ADDED
@@ -0,0 +1,362 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" lang="jp" xml:lang="jp">
5
+ <head>
6
+ <title>my_help README</title>
7
+ <!-- 2018-04-30 月 11:24 -->
8
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
9
+ <meta name="generator" content="Org-mode" />
10
+ <meta name="author" content="Shigeto R. Nishitani" />
11
+ <style type="text/css">
12
+ <!--/*--><![CDATA[/*><!--*/
13
+ .title { text-align: center; }
14
+ .todo { font-family: monospace; color: red; }
15
+ .done { color: green; }
16
+ .tag { background-color: #eee; font-family: monospace;
17
+ padding: 2px; font-size: 80%; font-weight: normal; }
18
+ .timestamp { color: #bebebe; }
19
+ .timestamp-kwd { color: #5f9ea0; }
20
+ .right { margin-left: auto; margin-right: 0px; text-align: right; }
21
+ .left { margin-left: 0px; margin-right: auto; text-align: left; }
22
+ .center { margin-left: auto; margin-right: auto; text-align: center; }
23
+ .underline { text-decoration: underline; }
24
+ #postamble p, #preamble p { font-size: 90%; margin: .2em; }
25
+ p.verse { margin-left: 3%; }
26
+ pre {
27
+ border: 1px solid #ccc;
28
+ box-shadow: 3px 3px 3px #eee;
29
+ padding: 8pt;
30
+ font-family: monospace;
31
+ overflow: auto;
32
+ margin: 1.2em;
33
+ }
34
+ pre.src {
35
+ position: relative;
36
+ overflow: visible;
37
+ padding-top: 1.2em;
38
+ }
39
+ pre.src:before {
40
+ display: none;
41
+ position: absolute;
42
+ background-color: white;
43
+ top: -10px;
44
+ right: 10px;
45
+ padding: 3px;
46
+ border: 1px solid black;
47
+ }
48
+ pre.src:hover:before { display: inline;}
49
+ pre.src-sh:before { content: 'sh'; }
50
+ pre.src-bash:before { content: 'sh'; }
51
+ pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
52
+ pre.src-R:before { content: 'R'; }
53
+ pre.src-perl:before { content: 'Perl'; }
54
+ pre.src-java:before { content: 'Java'; }
55
+ pre.src-sql:before { content: 'SQL'; }
56
+
57
+ table { border-collapse:collapse; }
58
+ caption.t-above { caption-side: top; }
59
+ caption.t-bottom { caption-side: bottom; }
60
+ td, th { vertical-align:top; }
61
+ th.right { text-align: center; }
62
+ th.left { text-align: center; }
63
+ th.center { text-align: center; }
64
+ td.right { text-align: right; }
65
+ td.left { text-align: left; }
66
+ td.center { text-align: center; }
67
+ dt { font-weight: bold; }
68
+ .footpara:nth-child(2) { display: inline; }
69
+ .footpara { display: block; }
70
+ .footdef { margin-bottom: 1em; }
71
+ .figure { padding: 1em; }
72
+ .figure p { text-align: center; }
73
+ .inlinetask {
74
+ padding: 10px;
75
+ border: 2px solid gray;
76
+ margin: 10px;
77
+ background: #ffffcc;
78
+ }
79
+ #org-div-home-and-up
80
+ { text-align: right; font-size: 70%; white-space: nowrap; }
81
+ textarea { overflow-x: auto; }
82
+ .linenr { font-size: smaller }
83
+ .code-highlighted { background-color: #ffff00; }
84
+ .org-info-js_info-navigation { border-style: none; }
85
+ #org-info-js_console-label
86
+ { font-size: 10px; font-weight: bold; white-space: nowrap; }
87
+ .org-info-js_search-highlight
88
+ { background-color: #ffff00; color: #000000; font-weight: bold; }
89
+ /*]]>*/-->
90
+ </style>
91
+ <link rel="stylesheet" type="text/css" href="https://www.pirilampo.org/styles/readtheorg/css/htmlize.css"/>
92
+ <link rel="stylesheet" type="text/css" href="https://www.pirilampo.org/styles/readtheorg/css/readtheorg.css"/>
93
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
94
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
95
+ <script type="text/javascript" src="https://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js"></script>
96
+ <script type="text/javascript" src="https://www.pirilampo.org/styles/readtheorg/js/readtheorg.js"></script>
97
+ <script type="text/javascript">
98
+ /*
99
+ @licstart The following is the entire license notice for the
100
+ JavaScript code in this tag.
101
+
102
+ Copyright (C) 2012-2013 Free Software Foundation, Inc.
103
+
104
+ The JavaScript code in this tag is free software: you can
105
+ redistribute it and/or modify it under the terms of the GNU
106
+ General Public License (GNU GPL) as published by the Free Software
107
+ Foundation, either version 3 of the License, or (at your option)
108
+ any later version. The code is distributed WITHOUT ANY WARRANTY;
109
+ without even the implied warranty of MERCHANTABILITY or FITNESS
110
+ FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
111
+
112
+ As additional permission under GNU GPL version 3 section 7, you
113
+ may distribute non-source (e.g., minimized or compacted) forms of
114
+ that code without the copy of the GNU GPL normally required by
115
+ section 4, provided you include this license notice and a URL
116
+ through which recipients can access the Corresponding Source.
117
+
118
+
119
+ @licend The above is the entire license notice
120
+ for the JavaScript code in this tag.
121
+ */
122
+ <!--/*--><![CDATA[/*><!--*/
123
+ function CodeHighlightOn(elem, id)
124
+ {
125
+ var target = document.getElementById(id);
126
+ if(null != target) {
127
+ elem.cacheClassElem = elem.className;
128
+ elem.cacheClassTarget = target.className;
129
+ target.className = "code-highlighted";
130
+ elem.className = "code-highlighted";
131
+ }
132
+ }
133
+ function CodeHighlightOff(elem, id)
134
+ {
135
+ var target = document.getElementById(id);
136
+ if(elem.cacheClassElem)
137
+ elem.className = elem.cacheClassElem;
138
+ if(elem.cacheClassTarget)
139
+ target.className = elem.cacheClassTarget;
140
+ }
141
+ /*]]>*///-->
142
+ </script>
143
+ </head>
144
+ <body>
145
+ <div id="content">
146
+ <h1 class="title">my_help README</h1>
147
+ <div id="table-of-contents">
148
+ <h2>Table of Contents</h2>
149
+ <div id="text-table-of-contents">
150
+ <ul>
151
+ <li><a href="#">1. 概要</a></li>
152
+ <li><a href="#my_help">2. (my_helpで解決しようとする)問題点</a></li>
153
+ <li><a href="#">3. 特徴</a></li>
154
+ <li><a href="#">4. 使用法</a>
155
+ <ul>
156
+ <li><a href="#sec-4-1">4.1. インストール</a></li>
157
+ <li><a href="#">4.2. 簡単な使用法</a></li>
158
+ <li><a href="#help">4.3. 独自のhelpを作る方法</a></li>
159
+ </ul>
160
+ </li>
161
+ </ul>
162
+ </div>
163
+ </div>
164
+
165
+ <div id="outline-container-概要" class="outline-2">
166
+ <h2 id="概要"><a id="sec-1" name="sec-1"></a><span class="section-number-2">1</span> 概要</h2>
167
+ <div class="outline-text-2" id="text-概要">
168
+
169
+ <p>
170
+ CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
171
+ </p>
172
+ </div>
173
+ </div>
174
+
175
+
176
+ <div id="outline-container-my_helpで解決しようとする問題点" class="outline-2">
177
+ <h2 id="my_helpで解決しようとする問題点"><a id="sec-2" name="sec-2"></a><span class="section-number-2">2</span> (my_helpで解決しようとする)問題点</h2>
178
+ <div class="outline-text-2" id="text-my_helpで解決しようとする問題点">
179
+
180
+ <p>
181
+ CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
182
+ commandや文法を覚えるのに苦労します．少しのkey(とっかかり)があると
183
+ 思い出すんですが，うろ覚えでは間違えて路頭に迷います．問題点は，
184
+ </p>
185
+ <ul class="org-ul">
186
+ <li>manは基本的に英語
187
+ </li>
188
+ <li>manualでは重たい
189
+ </li>
190
+ <li>いつもおなじことをwebで検索して
191
+ </li>
192
+ <li>同じとこ見ている
193
+ </li>
194
+ <li>memoしても，どこへ置いたか忘れる
195
+ </li>
196
+ </ul>
197
+ <p>
198
+ などです．
199
+ </p>
200
+ </div>
201
+ </div>
202
+
203
+ <div id="outline-container-特徴" class="outline-2">
204
+ <h2 id="特徴"><a id="sec-3" name="sec-3"></a><span class="section-number-2">3</span> 特徴</h2>
205
+ <div class="outline-text-2" id="text-特徴">
206
+
207
+ <p>
208
+ これらをCLA環境として提供しようというのが，このgemの目的です．
209
+ 仕様としては，
210
+ </p>
211
+ <ul class="org-ul">
212
+ <li>userが自分にあったmanを作成
213
+ </li>
214
+ <li>雛形を提供
215
+ </li>
216
+ <li>おなじformat, looks, 操作, 階層構造
217
+ </li>
218
+ <li>すぐに手が届く
219
+ </li>
220
+ <li>それらを追加・修正・削除できる
221
+ </li>
222
+ </ul>
223
+
224
+ <p>
225
+ memoソフトでは，検索が必要となりますが，my_helpは
226
+ key(記憶のとっかかり)を提供することが目的です．
227
+ RPGでレベル上げとかアイテムを貯めるようにして，
228
+ プログラミングでスキルを発展させてください．
229
+ </p>
230
+
231
+ <p>
232
+ 物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
233
+ </p>
234
+ </div>
235
+ </div>
236
+
237
+ <div id="outline-container-使用法" class="outline-2">
238
+ <h2 id="使用法"><a id="sec-4" name="sec-4"></a><span class="section-number-2">4</span> 使用法</h2>
239
+ <div class="outline-text-2" id="text-使用法">
240
+ </div>
241
+ <div id="outline-container-sec-4-1" class="outline-3">
242
+ <h3 id="sec-4-1"><span class="section-number-3">4.1</span> インストール</h3>
243
+ <div class="outline-text-3" id="text-4-1">
244
+ <pre class="example">
245
+ $ gem install my_help
246
+ </pre>
247
+ <p>
248
+ です．
249
+ </p>
250
+ </div>
251
+ </div>
252
+
253
+ <div id="outline-container-簡単な使用法" class="outline-3">
254
+ <h3 id="簡単な使用法"><a id="sec-4-2" name="sec-4-2"></a><span class="section-number-3">4.2</span> 簡単な使用法</h3>
255
+ <div class="outline-text-3" id="text-簡単な使用法">
256
+
257
+ <p>
258
+ まずは，
259
+ </p>
260
+ <pre class="example">
261
+ &gt; my_help
262
+ NAME
263
+ my_help - make own help and list.
264
+
265
+ SYNOPSIS
266
+ my_help [global options] command [command options] [arguments...]
267
+
268
+ VERSION
269
+ 0.7.0
270
+
271
+ GLOBAL OPTIONS
272
+ --help - Show this message
273
+ --version - Display the program version
274
+
275
+ COMMANDS
276
+ delete - delete HELP_NAME help
277
+ edit - edit HELP_NAME help
278
+ help - Shows a list of commands or help for one command
279
+ list - list all helps, specific HELP, or item
280
+ new - make new HELP_NAME
281
+ </pre>
282
+ <p>
283
+ としてください．このlistにargsやitemを加えて行くとわかると思います．
284
+ </p>
285
+
286
+ <pre class="example">
287
+ my_help list
288
+ my_help list emacs_help
289
+ my_help list emacs_help -f
290
+ my_help list emacs_help file
291
+ </pre>
292
+ <p>
293
+ として動かしてみてください．
294
+ </p>
295
+
296
+
297
+ <pre class="example">
298
+ - emacsのキーバインド
299
+ -
300
+ 特殊キー操作
301
+ - C-f, controlキーを押しながら 'f'
302
+ - M-f, escキーを押した後一度離して'f'
303
+ - 操作の中断C-g, 操作の取り消し(Undo) C-x u
304
+ , head : head
305
+ , license : license
306
+ -c, cursor : cursor
307
+ -e, edit : edit
308
+ -s, short_cut : short_cut
309
+ -f, file : file
310
+ -q, quit : quit
311
+ -p, page : page
312
+ -w, window : window
313
+ -b, buffer : buffer
314
+ -m, mode : mode
315
+ , query_replace : query_replace
316
+ -r, ruby-mode : ruby-mode
317
+ -d, dired : ファイラとして使う
318
+ </pre>
319
+ </div>
320
+ </div>
321
+
322
+ <div id="outline-container-独自のhelpを作る方法" class="outline-3">
323
+ <h3 id="独自のhelpを作る方法"><a id="sec-4-3" name="sec-4-3"></a><span class="section-number-3">4.3</span> 独自のhelpを作る方法</h3>
324
+ <div class="outline-text-3" id="text-独自のhelpを作る方法">
325
+
326
+ <p>
327
+ さて，独自のhelpを作る方法です．まずは，
328
+ </p>
329
+
330
+ <pre class="example">
331
+ my_help new new_help
332
+ </pre>
333
+
334
+ <p>
335
+ で，new_helpというtemplateが用意されます．
336
+ </p>
337
+ <pre class="example">
338
+ my_help edit new_help
339
+ </pre>
340
+ <p>
341
+ で編集してください． emacs org形式で，格納されています．
342
+ </p>
343
+
344
+ <pre class="example">
345
+ my_help delete new_help
346
+ </pre>
347
+
348
+ <p>
349
+ すると消されます．
350
+ </p>
351
+ </div>
352
+ </div>
353
+ </div>
354
+ </div>
355
+ <div id="postamble" class="status">
356
+ <p class="author">Author: Shigeto R. Nishitani</p>
357
+ <p class="date">Created: 2018-04-30 月 11:24</p>
358
+ <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.3.1 (<a href="http://orgmode.org">Org</a> mode 8.2.10)</p>
359
+ <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
360
+ </div>
361
+ </body>
362
+ </html>