Manual:Developing extensions/ja



各拡張機能は、3つの部分からなります：


 * 1) セットアップ
 * 2) 実行
 * 3) 地域化

最小限の拡張機能は、以下の構造で構成されます:


 * MyExtension/extension.json: セットアップの指示を格納するファイルです. ファイル名は必ずextension.jsonにします.  （MediaWiki 1.25以前では、セットアップの指示は拡張機能から名前を取った   ファイル内に記述されていました.  依然として拡張機能の多くには、このPHPファイルに下位互換性のあるシム (shim) があります. )
 * MyExtension/includes/: 拡張機能のための PHP 実行コードを格納します. ;
 * MyExtension/resources/: 拡張機能に必要となるJavaScript、CSSやLESSのようなクライアント側に必要なリソースを保存します.
 * MyExtension/i18n/*.json: これは拡張機能の地域化に関わる情報を格納したページです.

拡張機能の開発時には上記のMyExtensionの代わりにご利用の拡張機能名を記入します. ディレクトリ名とPHP名はアッパーキャメルケースにします. これは標準的なファイル命名規約に準じています. (ご利用の拡張機能の処理の導入としてはが適しています. )

セットアップ
セットアップ部分を書く目的は拡張機能をできるだけ簡単にインストールできるようにすることです. そのため、ユーザーが以下の行を LocalSettings.php に追加するだけで済みます.

ユーザーが拡張機能の設定を変更できるようにするには設定パラメータの設定と説明文書作成が必要で、ユーザ設定はたとえば下記の例のようになります.

ここまで単純化するには、セットアップファイルにいくつかの修正を行う必要があります (詳細は以下の節で説明します).


 * 拡張機能が使用するメディアハンドラ、パーサ関数、特別ページ、カスタムXMLタグ、変数をすべて登録.
 * 拡張機能用に定義した設定変数を定義と/もしくは検証.
 * 拡張機能のオートロード用に使用するクラスの準備.
 * セットアップ部分で、至急実行すべき部分と、MediaWikiコアの初期化と設定の終了後まで待つべき部分を定義する.
 * 必要なその他のフックの定義
 * 必要なデータベーステーブルの作成もしくは検証.
 * 拡張機能の地域化のための設定.

MediaWikiに拡張機能を登録する
MediaWikiの ページには、インストールされているすべての拡張機能が列挙されています. たとえばこのウィキにインストールされた拡張機能はすべて、Special:Versionで参照できます.

これを実現するには、拡張機能の詳細を extension.json に記します. 内容は以下のようになります.

項目の多くは設定任意ですが、すべて指定しておく方がいいでしょう. は のファイルが書き込まれるスキーマのバージョンを示しています. 設定可能なバージョン値は1と2です. この機能に関する文書はこちらを参照してください. 以前のMediaWikiバージョンをサポートする必要がない限り、最新バージョンを選択してください.

上記の登録に加え、MediaWikiにあなたがつくった機能を「フック」しておくことも必要です. 上記の内容は Special:Version page だけに関する設定です. これを行う方法はあなたがつくった拡張機能の種類に依存します. 詳しくは、拡張機能の種別ごとの説明文書を参照してください.

Making your extension user configurable
If you want your user to be able to configure your extension, you'll need to provide one or more configuration variables. It is a good idea to give those variables a unique name. They should also follow MediaWiki naming conventions (e.g. global variables should begin with $wg).

For example, if your extension is named "MyExtension", you might want to name all your configuration variables to begin with. It is important that none of the MediaWiki core begins its variables this way and you have done a reasonable job of checking to see that none of the published extensions begin their variables this way. Users won't take kindly to having to choose between your extension and some other extensions because you chose overlapping variable names.

It is also a good idea to include extensive documentation of any configuration variables in your installation notes.

Here is an example boiler plate that can be used to get started:

Note that after calling  the global variable   does not exist. If you set the variable, e.g. in  then the default value given in extension.json will not be used.

For more details on how to use global variable inside custom extensions, please refer to.

Preparing classes for autoloading
If you choose to use classes to implement your extension, MediaWiki provides a simplified mechanism for helping PHP find the source file where your class is located. 多くの場合、 の手順を自作しなくて済みます.

To use MediaWiki's autoloading mechanism, you add entries to the field. The key of each entry is the class name; the value is the file that stores the definition of the class. For a simple one class extension, the class is usually given the same name as the extension, so your autoloading section might look like this (extension is named MyExtension):

The filename is relative to the directory the extension.json file is in.

For more complex extensions, namespaces should be considered. See Manual:Extension.json/Schema#AutoloadNamespaces for details.

追加的なフックの定義
を参照してください.

データベース テーブルの追加
Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

If your extension needs to add its own database tables, use the hook. See the manual page for more information on usage.

地域化のセットアップ
関連項目:
 * 地域化 (要約)
 * 地域化 (詳細)
 * Namespaces

Add logs
On MediaWiki, all actions by users on wiki are tracked for transparency and collaboration. See for how to do it.

地域化
If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

Store messages in .json
Store message definitions in a localisation JSON file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. Each key should begin with the lowercased extension name. An example you can find in the MobileFrontend extension. Here is an example of a minimal JSON file (in this case en.json:

en.json

Store message documentation in qqq.json
The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. A documentation of the example above can be:

qqq.json:

地域化ファイルの読み込み
In your extension.json, define the location of your messages files (e.g. in directory i18n/):

PHP での wfMessage の使用
In your setup and implementation code, replace each literal use of the message with a call to. In classes that implement (as well as some others such as subclasses of SpecialPage), you can use   instead. 例:

JavaScript での mw.message の使用
It's possible to use i18n functions in JavaScript too. 詳細は を参照してください.

拡張機能の種類
拡張機能は、その機能を実現するために使われているプログラミング手法によって分類できます. 複雑な拡張機能の多くは複数の手法を用いることになるでしょう.
 * 下位クラス: MediaWikiは、MediaWikiが提供する基本クラスの下位クラスとして実装されるある特定種類の拡張機能を想定しています.
 *  – Subclasses of the class are used to build pages whose content is dynamically generated using a combination of the current system state, user input parameters, and database queries. Both reports and data entry forms can be generated. They are used for both reporting and administration purposes.
 *  – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class.
 *  – A technique for injecting custom PHP code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
 *  – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds Google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
 *  – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see  for more information.
 *  – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as or  are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
 *  – .  Similar to tag extensions, parser functions process arguments and returns a value. Unlike tag extensions, the result of parser functions is wikitext.
 *  – you can add custom modules to MediaWiki's action API, that can be invoked by JavaScript, bots or third-party clients.
 *  – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new.

Support other core versions
There are two widespread conventions for supporting older versions of MediaWiki core:

Extension maintainers should declare with the  parameter of the Extension template which convention they follow.
 * Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
 * Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki need to use the  branch of the extension. (For extensions hosted on gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Publishing
To autocategorize and standardize the documentation of your existing extension, please see. To add your new extension to this Wiki:

Deploying and registering
If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. を参照してください.

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at.

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.

ヘルプの説明文書
You should provide public domain help documentation for features provided by your extension. is a good example. You should give users a link to the documentation via the function.

Providing support / collaboration
Extension developers should open an account on Wikimedia's, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

関連項目

 * – 豊富なインライン説明文書を備えた数件のサンプル機能を実装
 * – 自作の拡張機能の出発点として有用な、定型ボイラープレート用拡張機能
 * 拡張機能のサンプルを読み込み、ボイラープレート拡張機能を自作のコードの基準に使う.
 * cookiecutter-mediawiki-extension – ボイラープレート拡張機能を生成する python ツール cookiecutter 用テンプレート (変数その他が付属)
 * 自作の拡張機能を急速に展開するため役立つ.
 * これによってもボイラープレート拡張機能の作成が可能.
 * - 特定のコードを複写して使用
 * – 自作の拡張機能によりクライアント向けAPIを提供する方法を解説
 * 拡張機能に関する最善の手法
 * 拡張機能に関する最善の手法
 * 拡張機能に関する最善の手法
 * 拡張機能に関する最善の手法
 * 拡張機能に関する最善の手法