Mootools Forgeの使い方 – 登録する前にすること
Category: blog
Mootools Forgeはプラグインを開発者が公開できるサービスです。
githubにプラグインのリポジトリがある場合、インポートするだけなのですぐに公開することができます。
但し、必要なファイルやリポジトリのディレクトリ構成が決まっています。
なので、登録する前にすることをすでに、公開できるプラグインがある場合を想定して解説していきます。
1. githubにリポジトリを作る
まずはじめにgithubにリポジトリを作成します。
作成の仕方がよくわからない方はこちらを参考にしてください。
TortoiseGitの使い方(githubの場合) その1
http://sharedhat.com/blog/737/
TortoiseGitの使い方(githubの場合) その2
http://sharedhat.com/blog/801/
すでに作成してある場合は、無視してください。
2. リポジトリの直下にREAME.mdとpackage.ymlファイルを作成する。
README.md(Markdown形式)はその名前のとおり、使い方や注意事項を含めたドキュメントファイルです。
package.yml(YAML形式)はプラグインパッケージの定義ファイルです。
2つとも雛形のファイルがありますので、ダウンロードして主要部分だけ変更します。
README.md雛形
http://mootools.net/forge/how-to-add#readme-md
package.yml雛形
http://mootools.net/forge/how-to-add#package-yml
README.mdは下記のMarkdown形式ページを参考にしてください。
基本的に使用するさいの手順や指定できるオプションの記述だけで十分だと思います。
Markdown形式(原文)
http://daringfireball.net/projects/markdown/
Markdown形式(日本語訳)
http://blog.2310.net/archives/6
つぎにpackage.ymlですが、項目は下記の通りになっています。
| no. | 項目名 | 説明 |
|---|---|---|
| 1 | name | プラグイン名 |
| 2 | author | 作者名 |
| 3 | category | プラグインカテゴリ。Mootools Forgeページの右側のメニューに表示されているものから一つだけ指定する。Effects、Forms、Interface、Media、Native、Realtime、Request、Utilities、Widgets |
| 4 | tags | タグ、タグはなんでもかまいません |
| 5 | demo | デモページのURL |
| 6 | current: | 現在の最新バージョン |
| 7 | docs | ドキュメントページのURL |
docsがまだ準備できていない、デモページがないなどの場合は#でコメントアウトしておくといいと思います
作成が終わったらリポジトリの直下におきます。
3. リポジトリの直下にSourceディレクトリとDocsディレクトリを作成する。
/repogitory
/Source/
/Docs/
Sourceデイレクトリにはプラグインのソースコードを置きます。
Docsディレクトリにはプラグインのドキュメントを置きます。
ドキュメントファイルもMarkdown形式のファイルで、ファイル名をプラグイン名とかにしておけばいいと思います。
基本的にAPI仕様のドキュメントになると思います。
4. スクリプトヘッダーを記述する。
ソースコードの先頭に下記のようなスクリプトヘッダーを記述します。
形式はYAML形式です。
YAML
http://ja.wikipedia.org/wiki/YAML
/* --- description: Element class, Elements class, and basic dom methods. license: MIT-style authors: - Jimmy Dean - Buck Kingsley requires: - localComponent1 - [localComponent2, localComponent3] - externalPackage1/tag: component4 - externalPackage2/tag: [component1, component2] provides: [Element, Elements, $, $$] ... */
| no. | 項目 | 名称 |
|---|---|---|
| 1 | description | プラグインの説明 |
| 2 | license | プラグインのライセンス形式(GPL2, MIT, BSDなど) |
| 3 | authors | 作者のリスト |
| 4 | requires | あなたのプラグインが扱う必要なコンポーネントのリスト |
| 5 | provides | プラグインが提供するコンポーネントのリスト |
記述が完了したら、オンラインパーサーを利用して、正しく解析できるかチェックしてください。
http://yaml-online-parser.appspot.com/
※コメントの/*— …*/は消さないでください。プラグイン登録時にエラーになります。
※YAML形式なので、スペースやタブの扱いには注意してください。
5. タグ付けをする。
1~4までが完了し、リリースできるようになったら、コミットしてリモートにプッシュしておきましょう。
pushが終わったら、こんどはtagを付けてスナップショットを作成します。
タグ付けする前に、タグ付けする現在のブランチを確認してください。
TortoiseGitでbranchを確認するには、メニューのGit Commitの部分を見ればOKです。
下記の例では2.0となっています。
branchを作成してない場合は、masterでOKです。
問題がなければ、TortoiseGitのメニューより、Create Tagを選択します。
そうすると、tagを作成するダイアログが表示されるので、tagの名称と、コメントを入力します。
問題がなければOKをクリックしてtagを作成します。
そして最後に、tagをリモートにpushします。
pushが完了したら、githubのダウンロードページで、タグが存在するか確認します。
無事タグがあれば、成功しています。

以上でいつでも、Mootools Forgeにプラグインを登録できます。
REAME.mdやpackage.ymlでわからないところがあったら、すでにMootools Forgeに登録されているプラグインを確認してみると参考になると思います。
次は、いよいよプラグイン登録の解説です。
Related Post:
It is a list of related articles.
Trackback:
It is a comment that has been gotten before.
トラックバックを下記のURLに送ってください。
http://sharedhat.com/blog/1027/trackback/








Reply:
Please give the comment to this article.