my_help 0.3.2 → 0.3.3

data/my_help.wiki/README_en.md

@@ -53,12 +53,13 @@ Supplied commands are
 bob%  bundle exec exe/my_help
 Usage: my_help [options]
     -v, --version                    show program Version.
-    -l, --list                       list specific help.
-    -e, --edit NAME                  edit NAME(cf test_help).
-    -i, --init NAME                  initialize NAME(cf, test_help) template.
-    -m, --make                       make and install:local all helps.
+    -l, --list                       list specific helps
+    -e, --edit NAME                  edit NAME help(eg test_help)
+    -i, --init NAME                  initialize NAME help(eg test_help).
+    -m, --make                       make executables for all helps.
     -c, --clean                      clean up exe dir.
         --install_local              install local after edit helps
+        --delete NAME                delete NAME help
 ```
 
 At first, see the list of supplied helps by the option of -l.
@@ -74,6 +75,32 @@ Specific help file:
 emacs_help, e_h, test_help, t_h are ready to use.
 Play them by a command such as 'bundle exec exe/e_h'.
 
+emacsのキーバインド
+
+```
+特殊キー操作
+  c-f, controlキーを押しながら    'f'
+  M-f, escキーを押した後一度離して'f'
+    操作の中断c-g, 操作の取り消し(Undo) c-x u
+     cc by Shigeto R. Nishitani, 2016
+Usage: e_h [options]
+    -v, --version                    show program Version.
+    -c, --cursor                     Cursor移動
+    -e, --編集                         Edit操作
+    -f, --ファイル                       File操作
+    -q, --終了                         終了操作
+    -p, --ページ                        Page移動
+    -w, --ウィンドウ                      Window操作
+    -b, --バッファ                       Buffer操作
+    -m, --mode                       モード切り替え
+        --edit                       edit help contents
+        --to_hiki                    convert to hikidoc format
+        --all                        display all helps
+        --store [item]               store [item] in back
+        --remove [item]              remove [item] in back
+        --add [item]                 add new [item]
+```
+
 ## Make own help
 The next step is making own help.  
 For this, -i NAME supplies new NAME help.

data/my_help.wiki/README_ja.md

@@ -30,6 +30,11 @@ commandや文法を覚えるのに苦労します．少しのkey(とっかかり
 hikiでやろうとしていることの半分くらいはこのあたりのことなの
 かもしれません．memoソフトでは，検索が必要となりますが，my_helpは
 key(記憶のとっかかり)を提供することが目的です．
+RPGでレベル上げとかアイテムを貯めるようにして，
+プログラミングでスキルを発展させてください．
+
+物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
+
 
 # 使用法
 ## インストール
@@ -56,6 +61,7 @@ Usage: my_help [options]
     -m, --make                       make executables for all helps.
     -c, --clean                      clean up exe dir.
         --install_local              install local after edit helps
+        --delete NAME                delete NAME help
 ```
 です．まず，-lでdefaultで入っているリストを見てください．
 
@@ -65,9 +71,35 @@ bob%  bundle exec exe/my_help -l
 ["-l"]
 Specific help file:
   emacs_help
-  test_help
 ```
-これで，CUIでemacs_help, e_h, template_help, t_hが用意されています．少し振る舞いに慣れてください．
+これで，CUIでemacs_help, e_hが用意されています．
+
+```
+emacsのキーバインド
+
+特殊キー操作
+  c-f, controlキーを押しながら    'f'
+  M-f, escキーを押した後一度離して'f'
+    操作の中断c-g, 操作の取り消し(Undo) c-x u
+     cc by Shigeto R. Nishitani, 2016
+Usage: e_h [options]
+    -v, --version                    show program Version.
+    -c, --cursor                     Cursor移動
+    -e, --編集                         Edit操作
+    -f, --ファイル                       File操作
+    -q, --終了                         終了操作
+    -p, --ページ                        Page移動
+    -w, --ウィンドウ                      Window操作
+    -b, --バッファ                       Buffer操作
+    -m, --mode                       モード切り替え
+        --edit                       edit help contents
+        --to_hiki                    convert to hikidoc format
+        --all                        display all helps
+        --store [item]               store [item] in back
+        --remove [item]              remove [item] in back
+        --add [item]                 add new [item]
+```
+少し振る舞いに慣れてください．
 
 ## 独自のhelpを作る方法
 さて，独自のhelpを作る方法です．まずは，
@@ -78,7 +110,12 @@ bob%  bundle exec exe/my_help -i new_help
 "/Users/bob/Github/my_help/lib/daddygongon/template_help"
 cp /Users/bob/Github/my_help/lib/daddygongon/template_help /Users/bob/.my_help/new_help
 ```
-で，new_helpというtemplateが用意されます．-e new_helpで編集してください．そのあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
+で，new_helpというtemplateが用意されます．-e new_helpで編集してください．
+YAML形式で，格納されています．サンプルが，
+```
+my_help/lib/daddygongon
+```
+にあります．このあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
 
 ## 独自helpを使えるように
 (これは，-mで自動的に行われるように修正されています)
@@ -98,8 +135,8 @@ cp /Users/bob/Github/my_help/lib/daddygongon/template_help /Users/bob/.my_help/n
 - @target dirをmy_help/lib/daddygongonからENV['HOME']/.my_helpに変更
 
 exe中のファイルをrakeで自動生成．
-@target_dirにそれらのdataを保存．以下ではその名前から
-exe中に実行ファイルを自動生成させている．
+@target_dirにそれらのdataを保存．
+その名前からexe中に実行ファイルを自動生成させている．
 ```
 lib/daddygongon/
 └── emacs_help
@@ -123,34 +160,32 @@ rake install:local
 gem uninstall my_help
 gem uninstall emacs_help
 ```
-でそのdirをcleanにしておくことが望ましい．
+でそのdirをcleanにしておくことが望ましい．下のuninstallの項目を参照．
 
-中身は以下の通り．
+-mでやっている中身は以下の通り．
 ```ruby
-desc "make own help from lib/daddygongon/files"
-task :my_help do
-  exe_cont="#!/usr/bin/env ruby\n"
-  user_name = 'daddygongon'
-  p entries=Dir.entries(File.join('.','lib',user_name))[2..-1]
-  entries.each{|file|
-    p file
-    p file_name=file.split('_')
-    target_files = [file, file_name[0][0]+"_"+file_name[1][0]]
-    p cont_name = File.join('lib',user_name,file)
-    exe_cont << "require 'my_help'\n"
-    exe_cont << "help_file = File.expand_path(\"../../#{cont_name}\", __FILE__)\n"
-    exe_cont << "MyHelp::Command.run(help_file, ARGV)\n"
-    target_files.each{|name|
-      p ''
-      p target=File.join('exe',name)
-      File.open(target,'w'){|file|
-        print exe_cont
-        file.print exe_cont
+    def make_help
+      Dir.entries(@target_dir)[2..-1].each{|file|
+        next if file[0]=='#' or file[-1]=='~'
+        exe_cont="#!/usr/bin/env ruby\nrequire 'specific_help'\n"
+        exe_cont << "help_file = File.join(ENV['HOME'],'.my_help','#{file}')\n"
+        exe_cont << "SpecificHelp::Command.run(help_file, ARGV)\n"
+        [file, short_name(file)].each{|name|
+          p target=File.join('exe',name)
+          File.open(target,'w'){|file| file.print exe_cont}
+          FileUtils.chmod('a+x', target, :verbose => true)
+        }
       }
-      FileUtils.chmod('a+x', target, :verbose => true)
-    }
-  }
-end
+      install_local
+    end
+
+    def install_local
+      #中略
+      system "git add -A"
+      system "git commit -m 'update exe dirs'"
+      system "Rake install:local"
+    end
+
 ```
 
 実装方法は，emacs_helpに
@@ -162,10 +197,30 @@ end
 今の所，No.1の方を実装．No.2のためのhushデータは，
 
 ```ruby
+# -*- coding: utf-8 -*-
 require 'yaml'
 require 'pp'
-
-pp YAML.load(File.read(ARGV[0]))
+yaml =<<EOF
+:file:
+  :opts:
+    :short: "-f"
+  :cont:
+  - c-x c-f, Find file, ファイルを開く
+  - c-x c-s, Save file, ファイルを保存
+EOF
+pp data=YAML.load(yaml)
+print YAML.dump(data)
+
+
+data0={:file=>
+  {:opts=>{:short=>"-f", :long=>"--ファイル", :desc=>"File操作"},
+   :title=>"ファイル操作file",
+   :cont=>
+    ["c-x c-f, Find file, ファイルを開く
+     c-x c-s, Save file, ファイルを保存
+     c-x c-w, Write file NAME, ファイルを別名で書き込む"]}}
+
+print YAML.dump(data0)
 ```
 
 ```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Shigeto R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,8 +126,11 @@ description: Emulating CUI(CLI) help, an user makes and displays his own helps.
 email:
 - shigeto_nishitani@me.com
 executables:
+- e_h
 - emacs_help
 - my_help
+- t_h
+- template_help
 extensions: []
 extra_rdoc_files: []
 files:
@@ -142,8 +145,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/e_h
 - exe/emacs_help
 - exe/my_help
+- exe/t_h
+- exe/template_help
 - hikis/README_en.hiki
 - hikis/README_ja.hiki
 - hikis/emacs_help.hiki
@@ -151,7 +157,12 @@ files:
 - latexes/handout_pre.tex
 - lib/daddygongon/emacs_help
 - lib/daddygongon/template_help
+- lib/emacs_help.rb
 - lib/my_help.rb
+- lib/my_help.rb~
+- lib/my_help/#test.rb#
+- lib/my_help/.#test.rb
+- lib/my_help/test.rb
 - lib/my_help/version.rb
 - lib/specific_help.rb
 - my_help.gemspec