Manual:$wgExtensionCredits/ja

From MediaWiki.org
Jump to: navigation, search
拡張機能: $wgExtensionCredits
拡張機能のクレジットのグローバルリスト
導入されたバージョン: 1.5.0 (r10074)
除去されたバージョン: 使用中
可能な値: See details
既定値: array()
他の設定: アルファベット順 | 機能順


詳細[edit]

拡張機能のタイプの配列と拡張機能の名前、バージョン、著者とURLが内部に含まれます。このクレジット情報はwikiのSpecial:Versionページに追加されるので、ユーザーはどの拡張機能がインストールされたのか、そしてそれらに関する詳細な情報を見ることができるようになります。

This credit information gets added to the wiki's Special:Version page, allowing users to see which extensions are installed, and to find more information about them.

これはLocalSettings.phpで説明されているコンフィギュレーション設定ではありません。典型的な拡張機能の開発者はこのグローバル変数に含まれる配列に追加するコードを書きます。

Special:MyLanguage/Manual:Extensions#MediaWikiで機能を登録するをご覧下さい

使用法[edit]

拡張機能の開発者は次のコードを持つ配列を追加できます:

$wgExtensionCredits[$type][] = array(
	'path' => __FILE__,     // 拡張機能自身のファイル名であり、SVN からリビジョン番号を取得する際に必要 - 文字列、1.15.0 で追加。Since 1.23 also used to create the link to the extension's license file
	'name' => "",           // 拡張機能の名前 - 文字列
	'description' => "",    // 拡張機能が行うことの説明 - 文字列。Omit in favour of descriptionmsg.
	'descriptionmsg' => "", // 国際化のためのメッセージの名前以外は上記と同じ - 文字列、1.12.0 で追加
	'version' => 0,         // 拡張機能のバージョンの数字 - 数字または文字列
	'author' => "",         // 拡張機能の作者の名前 - 文字列
	'url' => "",            // 拡張機能のURL(通常はインストラクション) - 文字列
        'license-name' => "",   // ライセンスの短い名前であり、LICENSE ファイルや COPYING ファイルが存在する場合はそれにリンクする - 文字列、1.23.0 で追加
 );

The description and author fields get parsed as wiki syntax. This is often used to provide links to the author's homepage in the author field. In version 1.12 and newer, descriptionmsg will override description.

type[edit]

$type は以下のいずれかにしてください:

descriptionmsg[edit]

The value of descriptionmsg will be treated as the message key for the extension description: see Special:MyLanguage/Manual:Developing extensions#Localisation. As a standard, it's in the form extensionname-desc (all lower case), or the prefix used for the message keys of the extension, followed by the -desc suffix.

The description:

  • Must be a single brief sentence: it has no closing period and implies "this extension" as a subject when needed.
  • Is usually in one of the following forms:
    • "Does"/"Adds"/"Allows to do" something (e.g. "Adds <poem> tag for poem formatting");
    • "Allow to do"/"Do" something, with the wiki or the users as subject (e.g. "Hide individual revisions from all users for legal reasons, etc.");
    • "Special page to do" something, or other noun-sentence to describe what the extension is composed of (e.g. "Special page to view global file usage", "Wikimedia specific messages").
  • Includes a link to the (main) added special page(s) if any, using "special page" or "do something" etc. as link labels.
TODO: Clarify guidelines and standardize.

author[edit]

Since r81549 (mw 1.18?), the author list can contain the special hackish '...' to denote other authors. The triple dot will make MediaWiki insert the version-poweredby-others message.

Example:

$wgExtensionCredits['other'][] = array(
	'author' => array( 'Mr Smith', '...' ),
);

license[edit]

This page also looks for a file named either COPYING or LICENSE (optional .txt extension) and provides a link to view said file. When the 'license-name' key is specified, this file is interpreted as wikitext.

"license-name" uses the short name of the license (used as label for the link), such as "GPL-2.0" or "MIT" adhering to the list of identifiers at spdx.org.

Example:

$wgExtensionCredits['other'][] = array(
	'license-name' => 'GPL-2.0+' // GNU General Public License v2.0 or later
);
Currently the COPYING or LICENSE file must be in wikitext to show properly (see bug 66767)

[edit]

$wgExtensionCredits['specialpage'][] = array(
	'path' => __FILE__,
	'name' => 'Example extension',
	'version' => '1.9.0',
	'author' => 'Foo Barstein',
	'url' => 'https://www.mediawiki.org/wiki/Extension:MyExtension',
	'descriptionmsg' => 'exampleextension-desc',
	'license-name' => 'GPL-2.0+'
);

関連項目[edit]

Gnome-preferences-other.svg 拡張機能:Manual:Extensions 開発Manual:Developing extensions タグ拡張機能Manual:Tag extensions パーサー関数Manual:Parser functions フックManual:Hooks 特別ページManual:Special pages 外装Manual:Skins マジックワードManual:Magic words APIAPI:Extensions
言語:Project:Language policy English  • 日本語