Contents

!template_helpの出力結果

<<<
  ヘルプのサンプル雛形.
    headに常に表示される内容を記述.

単元
  c-f, move Forwrard,    前or右へ
  フォーマットは自由です.

単元2
  c-f, move Forwrard,    前or右へ
  フォーマットは自由です.
>>>

!template_helpの中身
helpの実態は~/.my_helpに保存されたYAML形式のfileです．書き方はコメントを参照ください．

<<< yaml
---
#start header, which appears every time.
:head:         #never change
- "ヘルプのサンプル雛形.\n"  #describe the contents breafly.
- "  headに常に表示される内容を記述.\n" #head '- ' is necessary

# start the first item
:item:         #change snake word
  :opts:          #never change
    :short: "-i"      #change short option
    :long: "--item"   #change long option
    :desc: 単元(item) #describe what for in help list
  :title: "\n単元\n"  #describe what for in each help
  :cont:              #the following lines are appeared.
  - c-f, move Forwrard,    前or右へ  #top '  - ' are necessary for yaml format
  - フォーマットは自由です. 

# start the second item... and so on.
:item2: 
  :opts: 
    :short: "-j" 
    :long: "--item2"
    :desc: 単元2(item2)
  :title: "\n単元2\n"
  :cont:
  - c-f, move Forwrard,    前or右へ
  - フォーマットは自由です. 
>>>

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
my_help-0.3.1	hikis/test_help.hiki