WordPressプラグインのreadme.txtを書く

昨夜2:00くらいにリポジトリ申請出したプラグインに
早速21:00頃、「いいよ!」の連絡が来ました。
あれ?一週間かかるんじゃなかったのか。

プラグインのURLとか入れてないけど
説明文も勘の英語ですけど
しかも一文(20ワード程度)ですけど
あっさりOK。行間を読んでくれてありがとう、WPの人!
(てか読んでんのか?)

Subversionなるものでアップするのはなんか大変そうなので
とりあえずreadme.txtを書きましょうか。
実際のreadmeに何を書くかはわからなかったので、訳してみました。

readme.txt

=== Plugin Name ===

Contributors:
作った人の名前(wordpress.orgのuseridで)。複数人のときはカンマで区切る
Donate link:
カンパ先のURL
Tags:
タグ。こーゆーやつ。複数あるときはカンマで区切る
Requires at least:
作ったプラグインのインストールに必要なWPのバージョン(一番古いバージョン)
Tested up to:
検証してOKだった最新のバージョン(一番新しいバージョン)
Stable tag:
作ったプラグインのバージョンの数字。Subversionのタグとしても使われるので、ちゃんと同期をとっておいてくださいね。1とか0.1とか0.0.1とか、Subversionのタグと合っていれば、フォーマットは何でもいいらしい。
Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
作ったプラグインの簡単な説明。150文字以内で。HTMLタグは使えません


== Description ==

詳細な説明を書きます(字数制限なし)。
これ以降のセクションではMarkdownが使えます

なかったらないで上の簡単な説明が入ります。Markdownもちゃんと反映させますよ

== Installation ==

作ったプラグインのインストール方法を書きます。
例:

1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
2. Activate the plugin through the ‘Plugins’ menu in WordPress
3. Place `<?php do_action(‘plugin_name_hook’); ?>` in your templates


== Frequently Asked Questions ==

= A question that someone might have =
よくある質問を入れます
An answer to that question.
その答え。


== Screenshots ==

画面キャプチャの短い説明。
例:

1. 一つ目のスクリーンショットですよ
2. 二つ目のスクリーンショットですよ


拡張子は(png|jpg|jpeg|gif)が使える。
画像は、指定した最新バージョンのタグと同じフォルダに入れてね。
名前はscreenshot-1.png、screenshot-2.pngという感じで
例:

/tags/4.3/screenshot-3.png


== Changelog ==

更新履歴を書いていきます。
最新が一番上、最古(最初のリリース)が一番下にくるように
例:

= 1.0 =
* A change since the previous version.
* Another change.


== Upgrade Notice ==

アップグレードの概要、なぜユーザーがこのアップグレードをする必要があるか書きます。
300文字以内。
例:

= 0.5 =
This version fixes a security related bug. Upgrade immediately.
(セキュリティの問題に対処しました。今すぐアップグレードしてください)


== Arbitrary section ==

自由入力のセクション。
説明、インストール方法のセクションに入れる内容ではないけれど、
作ったプラグインが複雑で、追加情報が必要な場合にはここを使う。




はい、こんな感じでreadmeが書けました。
markdownが楽しいので、もっといろいろ使ってみたいけど、
特に使いどころがない悲しみに襲われつつ。

ちなみに日本語も使えて、ちゃんとプラグインディレクトリに反映されます。
例(Vacant Line BReaker)

次回はSubversionをやってみるをお送りしますね