my_help 1.2.3 → 1.2.4p1

data/lib/templates/emacs_j.org

@@ -0,0 +1,76 @@
+#+OPTIONS: ^:{}
+#+STARTUP: indent nolineimages overview num
+* head
+- Emacs key bindの日本語版
+* 初めに
+-特別なコマンド
+  -   c-f,「ctrl」キーと「f」を同時に押す
+　-   M-f,「Esc」キーを押した後に「f」を押す
+　-   c-g,操作を中断する
+　-   c-x u, 直前に行った操作を取り消す
+* license:      cc by Kaede Ogawa & Shigeto R. Nishitani, 2024
+* basic
+** 初期
+- emacs [FILE]
+** 終了操作
+- c-x c-c, ファイルを保存して、Emacsを終了する
+- c-z, Emacsを一時停止する, fgで再開する
+** カーソル移動
+- c-f, カーソルを1文字前に移動
+- c-b, カーソルを1文字後ろに移動
+- c-a, 行の先頭に移動
+- c-e, 行の末尾に移動
+- c-n, 次の行に移動
+- c-p, 前の行に移動
+- c-v, 次のページに移動
+- M-v, 前のページに移動
+- c-l, カーソル行を画面の中央に移動(2回目は画面の上端に、3回目は画面の下端に移動する)
+- M-<, ファイルの先頭に移動
+- M->, ファイルの末尾に移動
+** 編集操作
+- c-d, カーソルの右側の1文字を削除
+- c-k, カーソル位置から行の末尾までの文字を削除
+- c-y, 直前に削除した文字を貼り付け
+- c-w, 選択された領域を削除
+- 領域選択は、先頭 or 最後尾で c-space した後、最後尾 or 先頭へカーソル移動
+- c-s, 前へ WORD を検索
+- c-r, 後へ WORD を検索
+- M-x query-replace WORD1 <ret> WORD2, 文字列の置換(y or n で可否選択)
+* カーソル移動
+- c-f, カーソルを1文字前に移動
+- c-b, カーソルを1文字後ろに移動
+- c-a, 行の先頭に移動
+- c-e, 行の末尾に移動
+- c-n, 次の行に移動
+- c-p, 前の行に移動
+* ページ移動
+- c-v, 次のページに移動
+- M-v, 前のページに移動
+- c-l, カーソル行を画面の中央に移動(2回目は画面の上端に、3回目は画面の下端に移動する)
+- M-<, ファイルの先頭に移動
+- M->, ファイルの末尾に移動
+* ファイル操作 
+- c-x c-f, ファイルを開く
+- c-x c-s, ファイルを保存する
+- c-x c-w, ファイル名を変更して保存する
+* 編集操作
+- c-d, カーソルの右側の1文字を削除
+- c-k, カーソル位置から行の末尾までの文字を削除
+- c-y, 直前に削除した文字を貼り付け
+- c-w, 選択された領域を削除
+- 領域選択は、先頭 or 最後尾で c-space した後、最後尾 or 先頭へカーソル移動
+- c-s, 前へ WORD を検索
+- c-r, 後へ WORD を検索
+- M-x query-replace WORD1 <ret> WORD2, 文字列の置換(y or n で可否選択)
+* ウィンドウ操作
+- c-x 2, 現在のウィンドウを上下に分割
+- c-x 1, 現在のウィンドウ以外の全てのウィンドウを削除し、現在のウィンドウを最大化する
+- c-x 3, 現在のウィンドウを左右に分割
+- c-x o, 現在のウィンドウを削除し、隣接するウィンドウに移動
+* バッファー操作
+- すでに open して Emacs にバッファーされた file
+- c-x b, 指定したバッファーに切り替える
+- c-x c-b, 現在のバッファー一覧を表示
+* 終了操作
+- c-x c-c, ファイルを保存して、Emacsを終了する
+- c-z, Emacsを一時停止する, fgで再開する

data/lib/templates/example.org

@@ -1,6 +1,7 @@
-#+STARTUP: indent nolineimages overview
+#+OPTIONS: ^:{}
+#+STARTUP: indent nolineimages overview num
 * head: help_title example
-* license:      cc by Shigeto R. Nishitani, 2016-23
+* license:      cc by Shigeto R. Nishitani, 2016-24
 * a_item : item_short_description
 - content_a
 * b_item

data/lib/templates/my_help_j.org

@@ -0,0 +1,24 @@
+#+OPTIONS: ^:{}
+#+STARTUP: indent nolineimages overview num
+* head
+- my_helpの日本語版解説
+* license:      cc by Kaede Ogawa , 2024
+* my_helpのインストール
+- file:./my_help_install.org
+* emacsでの編集
+- [[file:./emacs_j.org]]
+* orgを使っているmy_helpのメモの取り方
+- file:./org.org
+* ファイルの参照方法
+- [*2 ファイル名 ]*2 とすることで他ファイルへのリンクを作成
+- c-c c-o,リンク上でコマンドを打つとそのファイルへアクセスできる
+* my_helpのよく使うコマンド
+- my_help new ファイル名, 新しいファイルを作成
+- my_help edit ファイル名, ファイルの編集画面を開く
+- my_help delete ファイル名, ファイルを削除する
+* my_helpでとったメモの参照方法
+- * headの項目は、そのファイルのタイトルのようなものである
+- ターミナル上でmy_help listと打つと、ファイル名の一覧とそのファイルのheadの中身の部分が表示されるようになっている
+- ターミナル上でmy_help list ファイル名 と打つと、そのファイルの項目がすべて表示される
+- my_help list ファイル名 項目名 と打つと、そのファイルの項目の中身を表示できる
+

data/lib/templates/org_j.org

@@ -0,0 +1,25 @@
+#+OPTIONS: ^:{}
+#+STARTUP: indent nolineimages overview num
+* head: orgを用いているmy_helpの使い方
+* license:      cc by Kaede Ogawa, 2024
+* 参考資料:
+- https://qiita.com/t4ku/items/315337745c3fa691027c
+- https://www.fabrica-com.co.jp/techblog/column/7928/
+* org
+- emacs上で動作するアウトライナー
+* アウトライナー
+- 文章の見出しを考えるときに使うツール
+- 見出しの下に小見出しを作成し、階層を深くしていくことができる
+- 階層的に記述できるため、タスク管理やメモ帳として便利である
+* TODOを用いたタスク管理
+- 「* TODO タスク」でやるべきことの見出しを記述
+- 「- 小タスク」TODOの下に記述することで小見出しを記述
+- c-c c-t, TODOタスクのTODOをDONEに変更
+- 「-[ ]　小タスク」, 小タスクの前に-[ ]を付けることで小タスクにチェックリストを作ることができる
+- c-c c-c,[ ]小タスクの[ ]にチェックを付ける
+- 「* TODO タスク [/]」でTODOのタスクに[完了タスク数/全てのタスク数]と表示できる
+- c-c ., カレンダーを表示して日付を追加(shift+矢印キーで日付を選択)
+* 階層的なメモの取り方
+- * space, 新しい項目の追加
+- - space, *の項目の中に要素を追加する
+- (shift+tab)*3, *の中身を表示する

data/my_help_install.org

@@ -0,0 +1,33 @@
+#+STARTUP: indent nolineimages overview
+* head
+- my_helpのインストール方法と動作環境の設定
+* license:      cc by Shigeto R. Nishitani, 2016-23
+* 参考文献:
+- https://qiita.com/fdui/items/6f28eebd60bb052d872a
+* my_helpのインストール
+-ターミナル上で「gem install my_help」と打つ
+-インストール後、ターミナル上で「my_help」と打つ
+ Commands:
+   my_help delete HELP             # delete HELP
+   my_help edit HELP               # edit HELP
+   my_help git [push|pull]         # git push or pull
+   my_help help [COMMAND]          # Describe available commands or one specif.
+   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
+
+ このように、コマンド一覧が表示されれば、インストールは完了
+
+* エディタの選択
+- my_helpを使用するために、エディタの選択をする
+- 「my_help set_editor emacs」と打ち、エディタをemacsにする
+
+* my_helpでよく使うコマンド
+- 「my_help new ファイル名」 で新しいメモファイルを作成する
+- 「my_help edit ファイル名」で指定したファイルを開き、編集できる
+- 「my_help list」で自分が作成したファイルのリストを表示する
+- 「my_help list ファイル名」で自分が作成したファイルの中の項目を表示する
+- 「my_help list ファイル名　そのファイルの中にある項目の名前」で項目の中身を表示する
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4p1
 platform: ruby
 authors:
 - Shigeto R. Nishiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -104,9 +104,35 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.org
-- README_j.org
+- README_e.org
 - Rakefile
 - development_memo.org
+- doc/MyHelp.html
+- doc/MyHelp/CLI.html
+- doc/MyHelp/Config.html
+- doc/MyHelp/Error.html
+- doc/MyHelp/GetConfig.html
+- doc/MyHelp/Git.html
+- doc/MyHelp/Init.html
+- doc/MyHelp/List.html
+- doc/MyHelp/Md2Hash.html
+- doc/MyHelp/Modify.html
+- doc/MyHelp/Org2Hash.html
+- doc/Org2Yaml.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - exe/my_help
 - lib/my_help.rb
 - lib/my_help/cli.rb
@@ -120,10 +146,13 @@ files:
 - lib/my_help/org2yml.rb
 - lib/my_help/version.rb
 - lib/templates/emacs.org
+- lib/templates/emacs_j.org
 - lib/templates/example.md
 - lib/templates/example.org
+- lib/templates/my_help_j.org
+- lib/templates/org_j.org
 - my_help.gemspec
-- tmp.txt
+- my_help_install.org
 homepage: https://github.com/daddygongon/my_help
 licenses:
 - MIT
@@ -143,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: user building help

data/README_j.org

@@ -1,143 +0,0 @@
-# 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: ^:{}
-
-* 概要
-  :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のキーバインド
-- 
-特殊キー操作
--   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_src
-
-** my_helpがやっていること
-my_helpの個々のヘルプファイルは'~/.my_help'に置かれています．
-ヘルプファイルのフォーマットはEmacsのorg-modeです．
-これをEditorで叩いて編集したり，
-そこから情報を取り出したりしています．
-単にファイル操作を集約しているだけなのですが，
-これが面倒で．．．
-
-
-** 独自のhelpを作る方法
-独自のhelpを作る方法です．まずは，
-
-: $ my_help new new_help
-
-で，new_helpというtemplateが用意されます．
-: $ my_help edit new_help
-で編集してください． Emacs org形式で，格納されています．
-
-: $ my_help delete new_help
-
-すると消されます．
-** editorの変更
-: $ my_help set_editor vim
-でeditorを変更できます．codeとかは確認していますが，
-それ以外で動いたり，動かなかったりを報告してください．
-
-OS Xで'emacs'とした時にGUI版が立ち上がって嫌だという場合は，
-'emacs -nw'として下さい．

data/tmp.txt

@@ -1,14 +0,0 @@
-Commands:
-  my_help delete HELP             # delete HELP
-  my_help edit HELP               # edit HELP
-  my_help git [push|pull]         # git push or pull
-  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
-
-Options:
-  d, [--dir=DIR]  
-