Manual:$wgExtensionCredits/ja
From MediaWiki.org
| 拡張機能: $wgExtensionCredits | |
|---|---|
| 拡張機能のクレジットのグローバルリスト |
|
| 導入されたバージョン: | 1.5.0 |
| 削除されたバージョン: | 使用中 |
| 可能な値: | See details |
| デフォルトの値: | array() |
[edit] 詳細
拡張機能のタイプの配列と拡張機能の名前、バージョン、著者とURLが内部に含まれます。このクレジット情報はwikiのSpecial:Versionページに追加されるので、ユーザーはどの拡張機能がインストールされたのか、そしてそれらに関する詳細な情報を見ることができるようになります。
これはLocalSettings.phpで説明されているコンフィギュレーション設定ではありません。典型的な拡張機能の開発者はこのグローバル変数に含まれる配列に追加するコードを書きます。
Manual:Extensions/ja#MediaWikiで機能を登録するをご覧下さい
[edit] 使い方
拡張機能の開発者は次のコードを持つ配列を追加できます:
$wgExtensionCredits[$type][] = array( 'name' => "", // 拡張機能の名前 - 文字列 'description' => "", // 拡張機能が行うことの説明 - 文字列 'descriptionmsg' => "", // 国際化のためのメッセージの名前以外は上記と同じ - 文字列、1.12.0で追加 'version' => 0, // 拡張機能のバージョンの数字 - 数字もしくは文字列 'author' => "", // 拡張機能の作者の名前 - 文字列 'url' => "", // 拡張機能のURL(通常はインストラクション) - 文字列 );
versionとurlキーはオプションで、省略できます。
バージョン1.12とそれ以降では、descriptionmsgはdescriptionを上書きします。descriptionmsgの値はdescriptionのために使われるメッセージの名前として取り扱われます。
$typeは次のうちのどれか1つでなければなりません:
- specialpage - 特別ページを追加する拡張機能
- parserhook - MediaWikiのパーサーに機能を追加するもしくは置き換える拡張機能
- variable (1.6.0で追加)
- media (1.11で追加) - メディアハンドラ
- other
Descriptionとauthorフィールドはwiki構文として解析されます。
[edit] 例
$wgExtensionCredits['specialpage'][] = array( 'name' => 'Example extension', 'version' => 1.9, 'author' => 'Foo Barstein', 'url' => 'http://www.mediawiki.org/wiki/Extension:MyExtension', 'description' => 'Performs some action, by way of example.', 'descriptionmsg' => 'foobar-desc', );
