Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 4.49 KB

README.md

File metadata and controls

77 lines (52 loc) · 4.49 KB

Patches for Taberareloo

ここは、Taberareloo のパッチ・レポジトリです。

必要なもの

ファイル名

Taberareloo 用のパッチ・ファイルは、.tbrl.js の拡張子が必要です。これ以外の拡張子はインストールされません。

現在の Taberareloo のパッチ機構はファイル名がキーになっているので、インストールするファイル名は拡張内でユニークである必要があります。

メタデータ

パッチ・ファイルの先頭には、以下のようなパッチに関するメタデータが必要です。

// ==Taberareloo==
// {
//	 "name"        : "Patch Name"
// , "description" : "Patch Description"
// , "include"     : ["background", "content"]
// , "match"       : ["https://*/*"]
// , "version"     : "1.0.0"
// , "downloadURL" : "https://raw.github.com/taberareloo/patches-for-taberareloo/master/patches/patch_file_name.tbrl.js"
// }
// ==/Taberareloo==
  • メタデータの領域は、// ==Taberareloo== の行で始まり、// ==/Taberareloo== の行で終了しなければなりません。

  • メタデータは、行の先頭を // でコメントアウトされた JSON フォーマットです。

  • JSON のキーや値は、ダブルクォート "" で囲まれていなければなりません。

  • "name" : パッチの名前 (省略可、省略時はファイル名が名前になります)

  • "description" : パッチの説明 (省略可)

  • "include" : パッチが適用されるページを配列で指定します ("background"、"content"、"popup"、"options"、またはそれらの組み合わせ)
    "background" : Taberareloo 拡張本体の Background ページ
    "content" : ブラウザのタブで開かれたページ
    "popup" : QuickPostForm のポップアップ・ウィンドウ (v3.0.1 以降)
    "options" : Option セッティング・ページ (v3.0.3 以降)

  • "match" : "include" に "content" が指定された場合に、適用されるページの URL のパターンを配列で指定します。
    マッチングに使われるパターンの記法は、Match Patterms of Google Chrome に準拠します。
    "include" に "content" が含まれない場合は、無視されます。

  • "version" : パッチのバージョン (省略可)
    バージョンの記法は、Semantic Versioning に準拠します。

  • "downloadURL" : パッチの提供元であるインストール可能なパッチ・ファイルへの URL を指定します。 (省略可)
    Taberareloo は、この URL で示されるファイルのメタ・データの "version" とインストール済みの "version" を比較して更新の通知を行います。

インストール

パッチは、"downloadURL" で示されるようなリモートのパッチ・ファイル上で右クリックから Patch - Install this を選択することでインストール出来ます。 また、Taberareloo のオプション・ページのパッチ・タブでローカル・ファイルからもインストール出来ます。

更新の通知

メタ・データに "downloadURL""version" がある場合、"downloadURL" で示されるファイルの "version" とインストール済みの "version" を比較して自動的に更新の通知を行います。 また、Taberareloo のオプション・ページのパッチ・タブで手動にて、「更新を確認」することも出来ます。

参加の仕方

  1. フォークして、
  2. ブランチを作って、 (git checkout -b my_patch)
  3. パッチをコミットして、 (git commit -am "Added My Patch")
  4. ブランチをプッシュして、 (git push origin my_patch)
  5. Pull Request して下さい