Manual:拡張機能

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Extensions and the translation is 72% complete.

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Esperanto • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎čeština • ‎Ελληνικά • ‎български • ‎мокшень • ‎русский • ‎العربية • ‎سنڌي • ‎پښتو • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
OOjs UI icon puzzle-ltr.svg 拡張機能: 開発 タグ拡張機能 パーサー関数 フック 特別ページ 外装 マジックワード API Content models

拡張機能とは、MediaWiki の外観や動作をカスタマイズさせるものです。

拡張機能には、MediaWiki の開発者によって保守されているものもありますが、サードパーティーの開発者によって書かれたものもあります。 その結果、拡張機能の多くがバグを有し、相互に互換性があることを保証されているわけではありません。 一部のものはメンテナンスがされていません。したがって、すべての拡張機能が、MediaWikiのすべてのバージョンで動作するわけではありません。 どの拡張機能であっても、特に安全ではないというタグが付けられたものについては、自己責任で使用して下さい。 If you are using an extension that requires patches to the core software, be sure to backup your database. This helps avoid the risk of breaking your wiki.

拡張機能の種類

OOjs UI icon markup.svg パーサー タグ

Parser tags extend the built-in wiki markup with additional capabilities, whether simple string processing, or full-blown information retrieval.


Learn more about parser tags

OOjs UI icon code.svg パーサー関数

Parser functions are special wiki markup syntax that can 'interact' with other wiki elements in the page, and give a specific output.


Learn more about parser functions

Plug-in Noun project 4032.svg フック

Hooks allow custom code to be executed when some defined event (such as saving a page or a user logging in) occurs.


Learn more about hooks

OOjs UI icon pageSettings.svg 特別ページ

Special pages are pages that are created by the software on demand to perform a specific function.


Learn more about special pages

OOjs UI icon browser-ltr.svg 外装

Skins allow users to customize the look and feel of MediaWiki.


Learn more about skins

OOjs UI icon quotes-ltr.svg マジックワード

Magic words are a technique for mapping a variety of wiki text strings to a single ID that is associated with a function.


Learn more about magic words

API - The Noun Project.svg API

MediaWiki provides an action API, a web service that allows access to some wiki-features like authentication, page operations, and search.


Learn more about the MediaWiki API

OOjs UI icon article-ltr.svg ページのコンテンツ モデル

The ContentHandler introduced in MediaWiki 1.21 makes it possible for wiki pages to be composed of data other than wikitext, such as JSON or Markdown.


Learn more about content models

OOjs UI icon lock.svg 認証

MediaWiki provides SessionManager and AuthManager, two authentication-related frameworks to enhance security via custom authentication mechanisms.


Learn more about authentication

拡張機能の参照

カテゴリ:Extensions by category では、これまで書かれたあらゆる種類の拡張機能を閲覧することができます。 これらの拡張機能をインストールしたり、独自に拡張機能を作ったりするための情報については、下記をご覧下さい。

インストールされた拡張機能の確認

MediaWikiに拡張機能をインストールできるのは、サーバのファイルシステム(データベースを含む場合も多い)にアクセスできる管理者に限られますが、誰でも Special:Version ページにアクセスすることで、MediaWikiのインスタンスでどの拡張機能がアクティブになっているかを確認することができます。 たとえば、ここにあげている拡張機能は、英語版ウィキペディアでは有効です。

拡張機能のインストール

MediaWiki はインストールが終わった直後に既に拡張機能を受け入れる用意ができています。 拡張機能を追加するために以下のステップに従います:

  1. 始める前に
    いくつかの拡張機能はパッチのインストールが要求されます。それらの多くはunixコマンドの使用によるインストールのために設計された手引きを提供しています。 拡張機能ヘルプページにリスト表示されたこれらのコマンドを入力するためにシェルアクセス(SSH)の権限が要求されることもあります。
  2. 拡張機能をダウンロードする。
    Extension Distributorは、よく用いられている拡張機能を選び、ダウンロードする手助けをしてくれます。
    通常、拡張機能はモジュール パッケージとして配布されます。 それらは一般的に $IP /extensions/ の独自のサブディレクトリに入ります。 ウィキメディアの Git リポジトリに保存された拡張機能の一覧は git:mediawiki/extensions にあります。 拡張機能の中には、履歴管理をしていないものがあり、使用は推奨されません。
    拡張機能のなかにはbundlescomposer package repositoriesで利用可能なものもあります。
  3. 拡張機能をインストール.
    LocalSettings.php ファイルの末尾に、以下を追加します:
    wfLoadExtension( 'ExtensionName' );
    
    この行はPHPインタプリタに拡張機能ファイルを読み込むことを強制し、その結果MediaWikiにアクセス可能にします。
    拡張機能の中には、メンテナンススクリプトと衝突するものもあります。例えば $_SERVER に直接アクセスする(非推奨)場合です。
    この場合、メンテナンススクリプトが動作するように、条件文で包むことができます。
if ( !$wgCommandLineMode ) {
   wfLoadExtension ( 'ExtensionName' );
}
上記の条件文の中で加えられる特別な名前空間を必要とするすべての拡張機能に対して、メンテナンススクリプト importDump.php は失敗します。そのような拡張機能は、例えば Extension:Semantic MediaWiki Extension:Semantic Forms です。
拡張機能用に必要な権限が設定されていることを確認してください!
このインストール手順は、ほとんどの拡張機能にあてはまりますが、異なったインストール手順が必要なものもあります。 詳細は、拡張機能のドキュメントを確認して下さい。
LocalSettings.php で設定の変数を変更したい場合は、通常は拡張機能のインクルードの後で行う必要があります。 そのようにしない場合、拡張機能内で定義されている既定値があなたの設定を上書きします。


拡張機能のアップグレード

拡張機能のなかには、複数のバージョンで動作するものもありますが、MediaWikiの更新ごとにアップデートしなければならないものもあります。 拡張機能を新しいバージョンにアップグレードするためには:

  1. 新しいバージョンの拡張機能をダウンロードします。
  2. extension/ExtensionName ディレクトリにある拡張機能のすべてのファイルを、新しいファイルに置き換えます。 LocalSettings.phpにある拡張機能の設定は、削除しないで下さい。
  1. 拡張機能によっては、メンテナンススクリプトのUpdate.phpを実行しなければならないかもしれません。

ほとんどの拡張機能は、このスクリプトを実行する必要があるかどうかについて言及しています。 (スクリpト実行前にデー他のバックアップを取ってください)。 もしコマンドラインにアクセスできない場合には、web updaterを使うこともできます。

この説明は、拡張機能の99%にあてはまります。 もし、あなたがアップグレードしようとしている特殊な拡張機能が、上と異なる説明をしていたならば、その拡張機能の説明に従うべきだろうと思います。

拡張機能のアンインストール

Remove the line from LocalSettings.php with the extension name to uninstall it:

wfLoadExtension( 'ExtensionName' );
  • You must remove any lines pertaining to the configuration of the extension.
  • If the extension provides any database changes, you must run update.php to remove them.

関連項目

拡張機能 : カテゴリ すべて 依頼タグ拡張機能 拡張機能 FAQ 拡張機能のフック登録所拡張機能の既定の名前空間