my_help 0.7.4 → 0.8.6

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,512 @@
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
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.19
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
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="file_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</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><?xml version="1.0" encoding="utf-8"?>
61
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
62
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
63
+ <html xmlns="http://www.w3.org/1999/xhtml" lang="jp" xml:lang="jp">
64
+ <head>
65
+ <!-- 2019-04-26 金 12:47 -->
66
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
67
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
68
+ <title>my_help README</title>
69
+ <meta name="generator" content="Org mode" />
70
+ <meta name="author" content="Shigeto R. Nishitani" />
71
+ <style type="text/css">
72
+ <!--/*--><![CDATA[/*><!--*/
73
+ .title { text-align: center;
74
+ margin-bottom: .2em; }
75
+ .subtitle { text-align: center;
76
+ font-size: medium;
77
+ font-weight: bold;
78
+ margin-top:0; }
79
+ .todo { font-family: monospace; color: red; }
80
+ .done { font-family: monospace; color: green; }
81
+ .priority { font-family: monospace; color: orange; }
82
+ .tag { background-color: #eee; font-family: monospace;
83
+ padding: 2px; font-size: 80%; font-weight: normal; }
84
+ .timestamp { color: #bebebe; }
85
+ .timestamp-kwd { color: #5f9ea0; }
86
+ .org-right { margin-left: auto; margin-right: 0px; text-align: right; }
87
+ .org-left { margin-left: 0px; margin-right: auto; text-align: left; }
88
+ .org-center { margin-left: auto; margin-right: auto; text-align: center; }
89
+ .underline { text-decoration: underline; }
90
+ #postamble p, #preamble p { font-size: 90%; margin: .2em; }
91
+ p.verse { margin-left: 3%; }
92
+ pre {
93
+ border: 1px solid #ccc;
94
+ box-shadow: 3px 3px 3px #eee;
95
+ padding: 8pt;
96
+ font-family: monospace;
97
+ overflow: auto;
98
+ margin: 1.2em;
99
+ }
100
+ pre.src {
101
+ position: relative;
102
+ overflow: visible;
103
+ padding-top: 1.2em;
104
+ }
105
+ pre.src:before {
106
+ display: none;
107
+ position: absolute;
108
+ background-color: white;
109
+ top: -10px;
110
+ right: 10px;
111
+ padding: 3px;
112
+ border: 1px solid black;
113
+ }
114
+ pre.src:hover:before { display: inline;}
115
+ /* Languages per Org manual */
116
+ pre.src-asymptote:before { content: 'Asymptote'; }
117
+ pre.src-awk:before { content: 'Awk'; }
118
+ pre.src-C:before { content: 'C'; }
119
+ /* pre.src-C++ doesn't work in CSS */
120
+ pre.src-clojure:before { content: 'Clojure'; }
121
+ pre.src-css:before { content: 'CSS'; }
122
+ pre.src-D:before { content: 'D'; }
123
+ pre.src-ditaa:before { content: 'ditaa'; }
124
+ pre.src-dot:before { content: 'Graphviz'; }
125
+ pre.src-calc:before { content: 'Emacs Calc'; }
126
+ pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
127
+ pre.src-fortran:before { content: 'Fortran'; }
128
+ pre.src-gnuplot:before { content: 'gnuplot'; }
129
+ pre.src-haskell:before { content: 'Haskell'; }
130
+ pre.src-hledger:before { content: 'hledger'; }
131
+ pre.src-java:before { content: 'Java'; }
132
+ pre.src-js:before { content: 'Javascript'; }
133
+ pre.src-latex:before { content: 'LaTeX'; }
134
+ pre.src-ledger:before { content: 'Ledger'; }
135
+ pre.src-lisp:before { content: 'Lisp'; }
136
+ pre.src-lilypond:before { content: 'Lilypond'; }
137
+ pre.src-lua:before { content: 'Lua'; }
138
+ pre.src-matlab:before { content: 'MATLAB'; }
139
+ pre.src-mscgen:before { content: 'Mscgen'; }
140
+ pre.src-ocaml:before { content: 'Objective Caml'; }
141
+ pre.src-octave:before { content: 'Octave'; }
142
+ pre.src-org:before { content: 'Org mode'; }
143
+ pre.src-oz:before { content: 'OZ'; }
144
+ pre.src-plantuml:before { content: 'Plantuml'; }
145
+ pre.src-processing:before { content: 'Processing.js'; }
146
+ pre.src-python:before { content: 'Python'; }
147
+ pre.src-R:before { content: 'R'; }
148
+ pre.src-ruby:before { content: 'Ruby'; }
149
+ pre.src-sass:before { content: 'Sass'; }
150
+ pre.src-scheme:before { content: 'Scheme'; }
151
+ pre.src-screen:before { content: 'Gnu Screen'; }
152
+ pre.src-sed:before { content: 'Sed'; }
153
+ pre.src-sh:before { content: 'shell'; }
154
+ pre.src-sql:before { content: 'SQL'; }
155
+ pre.src-sqlite:before { content: 'SQLite'; }
156
+ /* additional languages in org.el's org-babel-load-languages alist */
157
+ pre.src-forth:before { content: 'Forth'; }
158
+ pre.src-io:before { content: 'IO'; }
159
+ pre.src-J:before { content: 'J'; }
160
+ pre.src-makefile:before { content: 'Makefile'; }
161
+ pre.src-maxima:before { content: 'Maxima'; }
162
+ pre.src-perl:before { content: 'Perl'; }
163
+ pre.src-picolisp:before { content: 'Pico Lisp'; }
164
+ pre.src-scala:before { content: 'Scala'; }
165
+ pre.src-shell:before { content: 'Shell Script'; }
166
+ pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
167
+ /* additional language identifiers per "defun org-babel-execute"
168
+ in ob-*.el */
169
+ pre.src-cpp:before { content: 'C++'; }
170
+ pre.src-abc:before { content: 'ABC'; }
171
+ pre.src-coq:before { content: 'Coq'; }
172
+ pre.src-groovy:before { content: 'Groovy'; }
173
+ /* additional language identifiers from org-babel-shell-names in
174
+ ob-shell.el: ob-shell is the only babel language using a lambda to put
175
+ the execution function name together. */
176
+ pre.src-bash:before { content: 'bash'; }
177
+ pre.src-csh:before { content: 'csh'; }
178
+ pre.src-ash:before { content: 'ash'; }
179
+ pre.src-dash:before { content: 'dash'; }
180
+ pre.src-ksh:before { content: 'ksh'; }
181
+ pre.src-mksh:before { content: 'mksh'; }
182
+ pre.src-posh:before { content: 'posh'; }
183
+ /* Additional Emacs modes also supported by the LaTeX listings package */
184
+ pre.src-ada:before { content: 'Ada'; }
185
+ pre.src-asm:before { content: 'Assembler'; }
186
+ pre.src-caml:before { content: 'Caml'; }
187
+ pre.src-delphi:before { content: 'Delphi'; }
188
+ pre.src-html:before { content: 'HTML'; }
189
+ pre.src-idl:before { content: 'IDL'; }
190
+ pre.src-mercury:before { content: 'Mercury'; }
191
+ pre.src-metapost:before { content: 'MetaPost'; }
192
+ pre.src-modula-2:before { content: 'Modula-2'; }
193
+ pre.src-pascal:before { content: 'Pascal'; }
194
+ pre.src-ps:before { content: 'PostScript'; }
195
+ pre.src-prolog:before { content: 'Prolog'; }
196
+ pre.src-simula:before { content: 'Simula'; }
197
+ pre.src-tcl:before { content: 'tcl'; }
198
+ pre.src-tex:before { content: 'TeX'; }
199
+ pre.src-plain-tex:before { content: 'Plain TeX'; }
200
+ pre.src-verilog:before { content: 'Verilog'; }
201
+ pre.src-vhdl:before { content: 'VHDL'; }
202
+ pre.src-xml:before { content: 'XML'; }
203
+ pre.src-nxml:before { content: 'XML'; }
204
+ /* add a generic configuration mode; LaTeX export needs an additional
205
+ (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
206
+ pre.src-conf:before { content: 'Configuration File'; }
207
+
208
+ table { border-collapse:collapse; }
209
+ caption.t-above { caption-side: top; }
210
+ caption.t-bottom { caption-side: bottom; }
211
+ td, th { vertical-align:top; }
212
+ th.org-right { text-align: center; }
213
+ th.org-left { text-align: center; }
214
+ th.org-center { text-align: center; }
215
+ td.org-right { text-align: right; }
216
+ td.org-left { text-align: left; }
217
+ td.org-center { text-align: center; }
218
+ dt { font-weight: bold; }
219
+ .footpara { display: inline; }
220
+ .footdef { margin-bottom: 1em; }
221
+ .figure { padding: 1em; }
222
+ .figure p { text-align: center; }
223
+ .inlinetask {
224
+ padding: 10px;
225
+ border: 2px solid gray;
226
+ margin: 10px;
227
+ background: #ffffcc;
228
+ }
229
+ #org-div-home-and-up
230
+ { text-align: right; font-size: 70%; white-space: nowrap; }
231
+ textarea { overflow-x: auto; }
232
+ .linenr { font-size: smaller }
233
+ .code-highlighted { background-color: #ffff00; }
234
+ .org-info-js_info-navigation { border-style: none; }
235
+ #org-info-js_console-label
236
+ { font-size: 10px; font-weight: bold; white-space: nowrap; }
237
+ .org-info-js_search-highlight
238
+ { background-color: #ffff00; color: #000000; font-weight: bold; }
239
+ .org-svg { width: 90%; }
240
+ /*]]>*/-->
241
+ </style>
242
+ <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/htmlize.css"/>
243
+ <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/readtheorg.css"/>
244
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
245
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
246
+ <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script>
247
+ <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/readtheorg/js/readtheorg.js"></script>
248
+ <script type="text/javascript">
249
+ /*
250
+ @licstart The following is the entire license notice for the
251
+ JavaScript code in this tag.
252
+
253
+ Copyright (C) 2012-2018 Free Software Foundation, Inc.
254
+
255
+ The JavaScript code in this tag is free software: you can
256
+ redistribute it and/or modify it under the terms of the GNU
257
+ General Public License (GNU GPL) as published by the Free Software
258
+ Foundation, either version 3 of the License, or (at your option)
259
+ any later version. The code is distributed WITHOUT ANY WARRANTY;
260
+ without even the implied warranty of MERCHANTABILITY or FITNESS
261
+ FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
262
+
263
+ As additional permission under GNU GPL version 3 section 7, you
264
+ may distribute non-source (e.g., minimized or compacted) forms of
265
+ that code without the copy of the GNU GPL normally required by
266
+ section 4, provided you include this license notice and a URL
267
+ through which recipients can access the Corresponding Source.
268
+
269
+
270
+ @licend The above is the entire license notice
271
+ for the JavaScript code in this tag.
272
+ */
273
+ <!--/*--><![CDATA[/*><!--*/
274
+ function CodeHighlightOn(elem, id)
275
+ {
276
+ var target = document.getElementById(id);
277
+ if(null != target) {
278
+ elem.cacheClassElem = elem.className;
279
+ elem.cacheClassTarget = target.className;
280
+ target.className = "code-highlighted";
281
+ elem.className = "code-highlighted";
282
+ }
283
+ }
284
+ function CodeHighlightOff(elem, id)
285
+ {
286
+ var target = document.getElementById(id);
287
+ if(elem.cacheClassElem)
288
+ elem.className = elem.cacheClassElem;
289
+ if(elem.cacheClassTarget)
290
+ target.className = elem.cacheClassTarget;
291
+ }
292
+ /*]]>*///-->
293
+ </script>
294
+ </head>
295
+ <body>
296
+ <div id="content">
297
+ <h1 class="title">my_help README</h1>
298
+ <div id="table-of-contents">
299
+ <h2>Table of Contents</h2>
300
+ <div id="text-table-of-contents">
301
+ <ul>
302
+ <li><a href="#概要">1. 概要</a></li>
303
+ <li><a href="#my_helpで解決しようとする問題点">2. (my_helpで解決しようとする)問題点</a></li>
304
+ <li><a href="#特徴">3. 特徴</a></li>
305
+ <li><a href="#使用法">4. 使用法</a>
306
+ <ul>
307
+ <li><a href="#org3ddc9ea">4.1. インストール</a></li>
308
+ <li><a href="#簡単な使用法">4.2. 簡単な使用法</a></li>
309
+ <li><a href="#独自のhelpを作る方法">4.3. 独自のhelpを作る方法</a></li>
310
+ </ul>
311
+ </li>
312
+ </ul>
313
+ </div>
314
+ </div>
315
+
316
+ <div id="outline-container-orga76e8f5" class="outline-2">
317
+ <h2 id="概要"><a id="orga76e8f5"></a><span class="section-number-2">1</span> 概要</h2>
318
+ <div class="outline-text-2" id="text-概要">
319
+ <p>
320
+ CUI(CLA)ヘルプのUsage出力を真似て,user独自のhelpを作成・提供するgem.
321
+ </p>
322
+ </div>
323
+ </div>
324
+
325
+
326
+ <div id="outline-container-org230661d" class="outline-2">
327
+ <h2 id="my_helpで解決しようとする問題点"><a id="org230661d"></a><span class="section-number-2">2</span> (my_helpで解決しようとする)問題点</h2>
328
+ <div class="outline-text-2" id="text-my_helpで解決しようとする問題点">
329
+ <p>
330
+ CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は,
331
+ commandや文法を覚えるのに苦労します.少しのkey(とっかかり)があると
332
+ 思い出すんですが,うろ覚えでは間違えて路頭に迷います.問題点は,
333
+ </p>
334
+ <ul class="org-ul">
335
+ <li>manは基本的に英語</li>
336
+ <li>manualでは重たい</li>
337
+ <li>いつもおなじことをwebで検索して</li>
338
+ <li>同じとこ見ている</li>
339
+ <li>memoしても,どこへ置いたか忘れる</li>
340
+ </ul>
341
+ <p>
342
+ などです.
343
+ </p>
344
+ </div>
345
+ </div>
346
+
347
+ <div id="outline-container-org63e30d5" class="outline-2">
348
+ <h2 id="特徴"><a id="org63e30d5"></a><span class="section-number-2">3</span> 特徴</h2>
349
+ <div class="outline-text-2" id="text-特徴">
350
+ <p>
351
+ これらをCLA環境として提供しようというのが,このgemの目的です.
352
+ 仕様としては,
353
+ </p>
354
+ <ul class="org-ul">
355
+ <li>userが自分にあったmanを作成</li>
356
+ <li>雛形を提供</li>
357
+ <li>おなじformat, looks, 操作, 階層構造</li>
358
+ <li>すぐに手が届く</li>
359
+ <li>それらを追加・修正・削除できる</li>
360
+ </ul>
361
+
362
+ <p>
363
+ memoソフトでは,検索が必要となりますが,my_helpは
364
+ key(記憶のとっかかり)を提供することが目的です.
365
+ RPGでレベル上げとかアイテムを貯めるようにして,
366
+ プログラミングでスキルを発展させてください.
367
+ </p>
368
+
369
+ <p>
370
+ 物覚えの悪い作者は,人の名前をitem分けして,こそっと使っています.
371
+ </p>
372
+ </div>
373
+ </div>
374
+
375
+ <div id="outline-container-org03968c9" class="outline-2">
376
+ <h2 id="使用法"><a id="org03968c9"></a><span class="section-number-2">4</span> 使用法</h2>
377
+ <div class="outline-text-2" id="text-使用法">
378
+ </div>
379
+ <div id="outline-container-org3ddc9ea" class="outline-3">
380
+ <h3 id="org3ddc9ea"><span class="section-number-3">4.1</span> インストール</h3>
381
+ <div class="outline-text-3" id="text-4-1">
382
+ <pre class="example">
383
+ $ gem install my_help
384
+
385
+ </pre>
386
+ <p>
387
+ です.
388
+ </p>
389
+ </div>
390
+ </div>
391
+
392
+ <div id="outline-container-org157ee1b" class="outline-3">
393
+ <h3 id="簡単な使用法"><a id="org157ee1b"></a><span class="section-number-3">4.2</span> 簡単な使用法</h3>
394
+ <div class="outline-text-3" id="text-簡単な使用法">
395
+ <p>
396
+ まずは,
397
+ </p>
398
+ <pre class="example">
399
+ &gt; my_help
400
+ NAME
401
+ my_help - make own help and list.
402
+
403
+ SYNOPSIS
404
+ my_help [global options] command [command options] [arguments...]
405
+
406
+ VERSION
407
+ 0.7.0
408
+
409
+ GLOBAL OPTIONS
410
+ --help - Show this message
411
+ --version - Display the program version
412
+
413
+ COMMANDS
414
+ delete - delete HELP_NAME help
415
+ edit - edit HELP_NAME help
416
+ help - Shows a list of commands or help for one command
417
+ list - list all helps, specific HELP, or item
418
+ new - make new HELP_NAME
419
+ </pre>
420
+ <p>
421
+ としてください.このlistにargsやitemを加えて行くとわかると思います.
422
+ </p>
423
+
424
+ <pre class="example">
425
+ my_help list
426
+ my_help list emacs
427
+ my_help list emacs -f
428
+ my_help list emacs file
429
+
430
+ </pre>
431
+ <p>
432
+ として動かしてみてください.
433
+ </p>
434
+
435
+
436
+ <pre class="example">
437
+ - emacsのキーバインド
438
+ -
439
+ 特殊キー操作
440
+ - C-f, controlキーを押しながら 'f'
441
+ - M-f, escキーを押した後一度離して'f'
442
+ - 操作の中断C-g, 操作の取り消し(Undo) C-x u
443
+ , head : head
444
+ , license : license
445
+ -c, cursor : cursor
446
+ -e, edit : edit
447
+ -s, short_cut : short_cut
448
+ -f, file : file
449
+ -q, quit : quit
450
+ -p, page : page
451
+ -w, window : window
452
+ -b, buffer : buffer
453
+ -m, mode : mode
454
+ , query_replace : query_replace
455
+ -r, ruby-mode : ruby-mode
456
+ -d, dired : ファイラとして使う
457
+ </pre>
458
+ </div>
459
+ </div>
460
+
461
+ <div id="outline-container-orgc3249b5" class="outline-3">
462
+ <h3 id="独自のhelpを作る方法"><a id="orgc3249b5"></a><span class="section-number-3">4.3</span> 独自のhelpを作る方法</h3>
463
+ <div class="outline-text-3" id="text-独自のhelpを作る方法">
464
+ <p>
465
+ さて,独自のhelpを作る方法です.まずは,
466
+ </p>
467
+
468
+ <pre class="example">
469
+ my_help new new_help
470
+
471
+ </pre>
472
+
473
+ <p>
474
+ で,new_helpというtemplateが用意されます.
475
+ </p>
476
+ <pre class="example">
477
+ my_help edit new_help
478
+
479
+ </pre>
480
+ <p>
481
+ で編集してください. emacs org形式で,格納されています.
482
+ </p>
483
+
484
+ <pre class="example">
485
+ my_help delete new_help
486
+
487
+ </pre>
488
+
489
+ <p>
490
+ すると消されます.
491
+ </p>
492
+ </div>
493
+ </div>
494
+ </div>
495
+ </div>
496
+ <div id="postamble" class="status">
497
+ <p class="author">Author: Shigeto R. Nishitani</p>
498
+ <p class="date">Created: 2019-04-26 金 12:47</p>
499
+ <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
500
+ </div>
501
+ </body>
502
+ </html></div></div>
503
+
504
+ <div id="footer">
505
+ Generated on Fri Apr 26 13:03:28 2019 by
506
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
507
+ 0.9.19 (ruby-2.4.3).
508
+ </div>
509
+
510
+ </div>
511
+ </body>
512
+ </html>