my_help 1.2.3 → 1.2.4p1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a86f6d2f3dabef582a9c43dca24554b1dda2f5d773d0f7f8c9907c1dd205f8
-  data.tar.gz: 7010d97c58171b9606db261705a93deb7d6f23e546baeb32d25869e99ec1bfc7
+  metadata.gz: 57dd2017348f4f767f150ed04a72e315727f12ed631e8659ea53f23331fcd0a7
+  data.tar.gz: d107a0dbe00c1a982e09120baeb54987b41bd81fd225f4024d225c01857d9f0e
 SHA512:
-  metadata.gz: 1e0aaf779bb22e17ebd06d6d4277e323619b054120cb56ba8eab1e33c33d1ab2f8df9b71245f769276ce3c2de7d7c99804c5fd55710164cbef20eb063d8f235e
-  data.tar.gz: ec825103b28a678f0dcc7f2c94ec9afdfc836f69deae5b763279b61bb38ace3295a4be45f04956d87b118f95ce8af964cf89c629f5288ea9bc6cc42164228f90
+  metadata.gz: b289228ae5c9813e240624f729dbb02587ea289c02c3964281ce430f0d61ac300343e163a4353333ccdd1e8d4a0a0e035eada749703de3d68ac460bce8989899
+  data.tar.gz: c768e59554b37376df9e3307d212cabdd30518c7bd6af215b4f8ea555a6b01ac68f0ea05c2d940d57011f82fe404a9343d03ff2b859e96811a74388beb1051cc

data/.yardoc/checksums

@@ -8,4 +8,4 @@ lib/my_help/git_cli.rb bb04396f0b9d54ecb13100fe5cde029f7dbb0ea7
 lib/my_help/md2hash.rb 35ebd32d3f545b40cd9ebb1972dc60d53b58b22a
 lib/my_help/org2yml.rb 334d0a7b648dc75b1d9504ec6d68937c70e96343
 lib/my_help/version.rb 618ac9ac5ac451afc28fc6bae7bd657fc71a915a
-lib/my_help/org2hash.rb 939fea903abb5247959d74e18afc8db30fb5f6c8
+lib/my_help/org2hash.rb a6e90f0a910b16f54765d06c1fbb034ded267720

data/Gemfile.lock

@@ -18,9 +18,9 @@ GEM
       thor (~> 1.0)
     builder (3.2.4)
     childprocess (4.1.0)
-    colorize (0.8.1)
+    colorize (1.0.1)
     command_line (2.0.1)
-    contracts (0.16.1)
+    contracts (0.17)
     cucumber (8.0.0)
       builder (~> 3.2, >= 3.2.4)
       cucumber-ci-environment (~> 9.0, >= 9.0.4)
@@ -33,7 +33,7 @@ GEM
       mime-types (~> 3.4, >= 3.4.1)
       multi_test (~> 1.1, >= 1.1.0)
       sys-uname (~> 1.2, >= 1.2.2)
-    cucumber-ci-environment (9.1.0)
+    cucumber-ci-environment (9.2.0)
     cucumber-core (11.0.0)
       cucumber-gherkin (~> 23.0, >= 23.0.1)
       cucumber-messages (~> 18.0, >= 18.0.0)
@@ -49,29 +49,28 @@ GEM
     ffi (1.15.5)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    mime-types-data (3.2023.0218.1)
     multi_test (1.1.0)
     rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    sys-uname (1.2.2)
+    sys-uname (1.2.3)
       ffi (~> 1.1)
-    thor (1.2.1)
+    thor (1.2.2)
 
 PLATFORMS
   arm64-darwin-20
-  x86_64-linux
 
 DEPENDENCIES
   aruba (~> 2.1.0)
@@ -80,4 +79,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.3.23
+   2.4.14

data/README.org

@@ -1,80 +1,96 @@
-#+STARTUP: indent nolineimages content
+# my_help
+#+AUTHOR:  Shigeto R. Nishitani
+#+EMAIL:     (concat "nishitani@kwansei.ac.jp")
+#+LANGUAGE:  jp
+#+OPTIONS:   H:4 toc:t num:2
+#+SETUPFILE: /Users/bob/.emacs.d/org-mode/theme-readtheorg.setup
+#+STARTUP: indent nolineimages
 #+OPTIONS: ^:{}
-* Name
-- my_help :: manual like help for each user
-
-* Summary
-This gem makes and supplies user specific helps, emulating CUI(CLI) help
-usage.
-
-* Target
-A very novice of learning a specific operation, 
-such as CUI, shell, or emacs, 
-has a difficulty in remembering commands and grammers. 
-Some simple `key' reminds all, but no key brings nothing. 
-Especially a non-English-native has a strong difficulty 
-on the key remembering. 
-The problems are,
--  a man(ual) is in English
--  a man is heavily documented
--  On web, searching the same key word,
--  and reading the same URI repeatedly
--  but a memo goes away somewhere...
-
-* Specs
-This gem aims to supply own help by gem environment. 
-Specs are, 
-- user makes his own help 
-- supplies a template 
-- a same format, looks, operation, and hierarchy 
-- easily see, read 
-- supplies editing and install commands.
-
-Wiki targets the whole engineer, my_help targets a specific person.
-Half of the wiki aim should be covered by my_help. 
-Making own manual is one of the best practices for remembering operations. 
-Memo applications are good, if you remember the key word. 
-my_help supplies the key for remembering the word.
-
-* Usage
-** Install
-
-: $ gem install my_help
-
-** Simple Usage
-At first, you can see the commands supplied by my_help.
-#+begin_example
-> my_help
-NAME
-    my_help - make own help and list.
-
-SYNOPSIS
-    my_help [global options] command [command options] [arguments...]
-
-VERSION
-    0.7.0
-
-GLOBAL OPTIONS
-    --help    - Show this message
-    --version - Display the program version
-
-COMMANDS
-    delete - delete HELP_NAME help
-    edit   - edit HELP_NAME help
-    help   - Shows a list of commands or help for one command
-    list   - list all helps, specific HELP, or item
-     new   - make new HELP_NAME
-#+end_example
-
-When you add HELP_NAME and item (-o)wo'
-
-: my_help list
-: my_help list emacs_help
-: my_help list emacs_help -f
-: my_help list emacs_help file
 
-
-#+BEGIN_EXAMPLE
+* 概要
+  :PROPERTIES:
+  :CUSTOM_ID: 概要
+  :END:
+
+CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
+
+
+* (my_helpで解決しようとする)問題点
+  :PROPERTIES:
+  :CUSTOM_ID: my_helpで解決しようとする問題点
+  :END:
+
+CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
+commandや文法を覚えるのに苦労します．
+少しのkey(とっかかり)があると思い出すんですが，
+うろ覚えでは間違えて路頭に迷います．
+問題点は， 
++ manは基本的に英語 
++ manualでは重たい 
++ いつもおなじことをwebで検索して 
++ 同じとこ見ている 
++ memoしても，どこへ置いたか忘れる
+などです．
+
+* 特徴
+  :PROPERTIES:
+  :CUSTOM_ID: 特徴
+  :END:
+
+これらをCLAとして提供しようというのが，このgemの目的です．
+仕様としては， 
+- userが自分にあったmanを作成 
+- 雛形を提供 
+- おなじformat, looks, 操作, 階層構造 
+- すぐに手が届く 
+- それらを追加・修正・削除できる
+
+memoソフトでは，検索が必要となりますが，my_helpは
+key(記憶のとっかかり)を提供することが目的です．
+RPGでレベル上げとかアイテムを貯めるようにして，
+プログラミングでスキルを発展させてください．
+
+VSCodeやGithub Copilotではcodeの候補を挙げてくれますが，
+物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
+
+* 使用法
+  :PROPERTIES:
+  :CUSTOM_ID: 使用法
+  :END:
+** インストール
+
+: > gem install my_help
+です．
+
+** 簡単な使用法
+   :PROPERTIES:
+   :CUSTOM_ID: 簡単な使用法
+   :END:
+
+まずは，
+#+begin_src bash
+> my_help
+Commands:
+  my_help delete HELP             # delete HELP
+  my_help edit HELP               # edit HELP
+  my_help help [COMMAND]          # Describe available commands or one specific command
+  my_help list [HELP] [ITEM]      # list all helps, specific HELP, or ITEM
+  my_help new HELP                # make new HELP
+  my_help set_editor EDITOR_NAME  # set editor to EDITOR_NAME
+  my_help setup                   # set up the test database
+  my_help version                 # show version
+#+end_src
+としてください．このlistにNAMEやITEMを加えて行くとわかると思います．
+
+#+begin_src bash
+> my_help list
+> my_help list emacs
+> my_help list emacs -f
+> my_help list emacs file
+#+end_src
+として動かしてみてください．
+
+#+begin_src bash
 - emacsのキーバインド
 - 
 特殊キー操作
@@ -95,16 +111,33 @@ When you add HELP_NAME and item (-o)wo'
      , query_replace  : query_replace
    -r, ruby-mode      : ruby-mode
    -d, dired          : ファイラとして使う
-#+END_EXAMPLE
+#+end_src
+
+** my_helpがやっていること
+my_helpの個々のヘルプファイルは'~/.my_help'に置かれています．
+ヘルプファイルのフォーマットはEmacsのorg-modeです．
+これをEditorで叩いて編集したり，
+そこから情報を取り出したりしています．
+単にファイル操作を集約しているだけなのですが，
+これが面倒で．．．
+
+
+** 独自のhelpを作る方法
+独自のhelpを作る方法です．まずは，
+
+: $ my_help new new_help
 
-** Make your own help
-For making your new help, you can do tha as follows:
-: my_help new new_help
+で，new_helpというtemplateが用意されます．
+: $ my_help edit new_help
+で編集してください． Emacs org形式で，格納されています．
 
-A templeate is compied, then you can edit as 
-: my_help edit new_help
-The file is stored in emacs org mode.
+: $ my_help delete new_help
 
-You can delete if as follows:
-: my_help delete new_help
+すると消されます．
+** editorの変更
+: $ my_help set_editor vim
+でeditorを変更できます．codeとかは確認していますが，
+それ以外で動いたり，動かなかったりを報告してください．
 
+OS Xで'emacs'とした時にGUI版が立ち上がって嫌だという場合は，
+'emacs -nw'として下さい．

data/README_e.org

@@ -0,0 +1,110 @@
+#+STARTUP: indent nolineimages content
+#+OPTIONS: ^:{}
+* Name
+- my_help :: manual like help for each user
+
+* Summary
+This gem makes and supplies user specific helps, emulating CUI(CLI) help
+usage.
+
+* Target
+A very novice of learning a specific operation, 
+such as CUI, shell, or emacs, 
+has a difficulty in remembering commands and grammers. 
+Some simple `key' reminds all, but no key brings nothing. 
+Especially a non-English-native has a strong difficulty 
+on the key remembering. 
+The problems are,
+-  a man(ual) is in English
+-  a man is heavily documented
+-  On web, searching the same key word,
+-  and reading the same URI repeatedly
+-  but a memo goes away somewhere...
+
+* Specs
+This gem aims to supply own help by gem environment. 
+Specs are, 
+- user makes his own help 
+- supplies a template 
+- a same format, looks, operation, and hierarchy 
+- easily see, read 
+- supplies editing and install commands.
+
+Wiki targets the whole engineer, my_help targets a specific person.
+Half of the wiki aim should be covered by my_help. 
+Making own manual is one of the best practices for remembering operations. 
+Memo applications are good, if you remember the key word. 
+my_help supplies the key for remembering the word.
+
+* Usage
+** Install
+
+: $ gem install my_help
+
+** Simple Usage
+At first, you can see the commands supplied by my_help.
+#+begin_example
+> my_help
+NAME
+    my_help - make own help and list.
+
+SYNOPSIS
+    my_help [global options] command [command options] [arguments...]
+
+VERSION
+    0.7.0
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --version - Display the program version
+
+COMMANDS
+    delete - delete HELP_NAME help
+    edit   - edit HELP_NAME help
+    help   - Shows a list of commands or help for one command
+    list   - list all helps, specific HELP, or item
+     new   - make new HELP_NAME
+#+end_example
+
+When you add HELP_NAME and item (-o)wo'
+
+: my_help list
+: my_help list emacs_help
+: my_help list emacs_help -f
+: my_help list emacs_help file
+
+
+#+BEGIN_EXAMPLE
+- emacsのキーバインド
+- 
+特殊キー操作
+-   C-f, controlキーを押しながら    'f'
+-   M-f, escキーを押した後一度離して'f'
+-     操作の中断C-g, 操作の取り消し(Undo) C-x u
+     , head           : head
+     , license        : license
+   -c, cursor         : cursor
+   -e, edit           : edit
+   -s, short_cut      : short_cut
+   -f, file           : file
+   -q, quit           : quit
+   -p, page           : page
+   -w, window         : window
+   -b, buffer         : buffer
+   -m, mode           : mode
+     , query_replace  : query_replace
+   -r, ruby-mode      : ruby-mode
+   -d, dired          : ファイラとして使う
+#+END_EXAMPLE
+
+** Make your own help
+For making your new help, you can do tha as follows:
+: my_help new new_help
+
+A templeate is compied, then you can edit as 
+: my_help edit new_help
+The file is stored in emacs org mode.
+
+You can delete if as follows:
+: my_help delete new_help
+

data/development_memo.org

@@ -12,6 +12,11 @@
 #+TWITTER: off
 #+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-readtheorg.setup
 
+* new development <2024-09-26 Thu>
+- test作ろう
+- '* ' 問題の解決
+- Japanese版の用意
+
 * <2023-01-07 Sat> Thor
 いくつかのaliasをThorで実現したい
 - my_help -v