これはVimperatorプラグインの詳細情報orヘルプを表示するためのプラグインです。
Command
- :plugin[help] [pluginName] [-v]
- {pluginName}を入れるとそのプラグインの詳細を表示します。
省略すると全てのプラグインの詳細を表示します。
オプション -v はより細かなデータを表示します
For plugin Developers
プラグインの先頭に
var PLUGIN_INFO = ...
とE4X形式でXMLを記述してください
各要素は下記参照
要素
- name
- プラグイン名
- description
- 簡易説明
属性langに"ja"などと言語を指定するとFirefoxのlocaleに合わせたものになります。
- author
- 製作者名
属性mailにe-mail、homepageにURLを付けるとリンクされます
- license
- ライセンスについて
属性documentにURLを付けるとリンクされます
- version
- プラグインのバージョン
- maxVersion
- プラグインが使用できるVimperatorの最大バージョン
- minVersion
- プラグインが使用できるVimperatorの最小バージョン
- updateURL
- プラグインの最新リソースURL
- require
- プラグインが必要とする拡張機能や他のプラグイン
拡張機能の場合、
- type属性を"extension"
- id属性をその拡張機能のid (xxxx@example.com または UUID)
- 拡張機能名
プラグインの場合
- type属性を"plugin"
- プラグインファイル名
- detail
- ここにコマンドやマップ、プラグインの説明
CDATAセクションにwiki的に記述可能
Wiki書式
- 見出し
- == heading1 == で第一見出し(h1)
- === heading2 === で第二見出し(h2)
- ==== heading3 ==== で第三見出し(h3)
- リスト
- "- "を先頭につけると箇条書きリスト(ul)になります。
- 改行が可能
- 改行
可能
の場合
となります。
- ネスト可能
- "+ "を先頭につけると番号付きリスト(ol)になります。
仕様は箇条書きリストと同じです。
- 定義リスト
- 末尾が":"で終わる行は定義リスト(dl,dt)になります。
- 次行をネストして始めるとdd要素になります。
- これもネスト可能です。
- 整形式テキスト
- >|| と ||< で囲むと整形式テキスト(pre)になります。
コードなどを書きたい場合に使用できるでしょう。
- インライン
- mailtoとhttp、httpsスキームのURLはリンクになります
ToDo