読者です 読者をやめる 読者になる 読者になる

Vimperator プラグインヘルプ書き方メモ

Twittperator のヘルプを書きなおした時にやったことをふと思い出して書いてみた.
関係ないけど,はてなブログの書き方がわからなくてすごく見にくくなってる.


結果

最初に書いたときの差分
https://github.com/vimpr/vimperator-plugins/commit/42e68c67dde82f2c90752ddf546237302005c5c8

こんなんなってる
f:id:nise_nabe:20120624135900p:plain

参考文献

ドキュメント書くときに見てたヘルプ

:help developer-information

ほかのヘルプの表示も見てみながら.

:helpall

あとは本体のヘルプのソースとか
http://code.google.com/p/vimperator-labs/source/browse/#hg%2Fcommon%2Flocale%2Fja
http://code.google.com/p/vimperator-labs/source/browse/common/locale/ja/developer.xml



実際にやったこと

  1. PLUGIN_INFO だったものは INFO になる.
  2. 複数の言語に対応する場合は <> で囲んでそれぞれ plugin タグに書いて lang 属性を使う
  3. VimperatorPlugin タグ は plugin タグに変える
    1. name, description, version タグは plugin の属性に入れる
  4. author タグの homepage 属性は href 属性に変える
  5. コマンドのヘルプは item タグで囲む
    1. コマンド自体は spec タグで囲む
    2. なんか右に出てくるものは tags で囲む
    3. コマンドの説明は description タグで囲む

あとは書き直しては表示してみて code タグとか h3 タグとか p タグでなんとか体裁を整える.
ヘルプ書き直したあとにプラグインリロードする方法がよくわからなかったので Firefox で別プロファイル作ってから 編集&再起動 の繰り返ししてた.



疑問点

ヘルプの例

 48 <item>                                           
 49     <tags><![CDATA[<F1> :help :h help]]></tags>
 50     <spec>:h<oa>elp</oa> <a>subject</a></spec>
 51     <spec><![CDATA[<F1>]]></spec>
 52     <description>
 53         <p>
 54             Open help window.
 55             The default section is shown unless <a>subject</a> is specified.
 56             If you need help for a specific topic, try <ex>:help overview</ex>.
 57         </p>
 58     </description>
 59 </item>

f:id:nise_nabe:20120624131149p:plain

実際に書いてみた内容

 191     <item>
 192       <tags><![CDATA[:twittperator :tw]]></tags>
 193       <spec>:tw<oa>ittperator</oa> -getPIN</spec>
 194       <description>
 195         <p>PINコード取得ページを開きます。</p>
 196       </description>
 197     </item>
 198     <item>
 199       <spec>:tw<oa>ittperator</oa> -setPIN <a>PINcode</a></spec>
 200       <description>
 201         <p>PINcodeを設定します。</p>
 202       </description>
 203     </item> 

f:id:nise_nabe:20120624131531p:plain

なんで oa タグの前後にスペース入るんだろう?