Manual:カスタム名前空間の使用方法

From mediawiki.org
This page is a translated version of the page Manual:Using custom namespaces and the translation is 95% complete.

組み込みの名前空間に加えて、内容を分離してより論理的に整理できるようにするために、カスタムの名前空間を MediaWiki に追加できます。

$wgExtraNamespaces 構成ディレクティブを使用することで、カスタムの名前空間は管理が簡単です。 $wgNamespaceAliases 構成ディレクティブを使用して、カスタム (および定義済み) 名前空間のエイリアスを定義することも可能です。 Some extensions make it easy for you to create custom namespaces. Examples include NamespaceManager and BlueSpiceNamespaceManager .

名前空間を操作する前にジョブ キューに保留中のジョブがないのを確認することをお勧めします。これはジョブの対象ページが、削除または名称変更しようとしている名前空間に属している場合に、そのジョブが失敗してしまうのを回避するためです。 runJobs.php を使用して、すべての保留中のジョブを実行し、名前空間構成を操作する前にキューをクリアします。

カスタム名前空間の作成

名前空間を追加登録するには、 "LocalSettings.php" ファイルの $wgExtraNamespaces グローバル変数に追加して登録します。 すべての名前空間は、この配列内で一意の数値インデックスを必要とします。 単純なカスタム名前空間の作成の例として、「Foo」名前空間 3000 とそれに付随する「Foo_talk」名前空間を定義するには、以下の数行を "LocalSettings.php" ファイルに追加します:

// 追加の名前空間の定数を定義する。
define("NS_FOO", 3000); // これは必ず偶数でなければならない。
define("NS_FOO_TALK", 3001); // これは、奇数であり、整数でなければならない。

// 名前空間を追加する。
$wgExtraNamespaces[NS_FOO] = "Foo";
$wgExtraNamespaces[NS_FOO_TALK] = "Foo_talk"; // 名前空間名に含まれるアンダースコアに注意。
未使用の番号を選択
慣習として、100-199の番号の名前空間はサイト固有の名前空間として予約されていますが、この慣習に従わないいくつかの拡張機能も存在します。 拡張書き込み機能では、最大 32767 までの数値を使用します。 インデックスを選ぶ際には、既に拡張機能の既定の名前空間に入っている番号は避けるべきです。 3000から4999までの数字は、システム管理者が独自の名前空間を定義するために予約されています。 (また、すでに拡張機能で使用されている既定の名前空間にある名前空間nameは避けたいところです)。
偶数と次の奇数
上の例では、名前空間の配列のインデックスが 3000 であることに注意してください。
トーク名前空間も作成
通常、議論の「トーク」名前空間は、各カスタム名前空間と共に作成します。 この例では、ページの移動 を "Foo" 名前空間に移動すると、関連するトークページがあれば移動するように促され、移動することを選択すると、MediaWiki はそのトークページを "Foo talk" に配置します。
空白を含めない
名前空間を登録する際は、スペースの代わりにアンダースコアを使ってください。 “My Namespace”は、名前空間の登録においては無効ですので、代わりに“My_Namespace”を使ってください。
ハイフンを含めない

大文字の部分ではハイフンを使用できませんが、接頭辞タイトルに安全に追加できます。 例:

$wgExtraNamespaces[NS_FOOFOO] = "Foo-Foo";
選択した番号に名前を付ける
この例では、名前空間IDに定数を定義しています。これは、後ほど $wgNamespaceProtection $wgNamespacesWithSubpages $wgExtraGenderNamespaces などの設定で、これらの名前空間を参照できるようにするためのものです。

新しい名前空間の追加設定を構成することもできます。

$wgNamespaceProtection[NS_FOO] = array( 'editfoo' ); // foo 名前空間 の編集に必要な "editfoo" 権限
$wgNamespacesWithSubpages[NS_FOO] = true;            // foo 名前空間で有効な下位ページ
$wgGroupPermissions['sysop']['editfoo'] = true;      // "sysop" グループの利用者に許可された "editfoo" 権限
早めに行う
$wgExtraNamespaces の操作はMediaWikiの初期設定の間に完了しなければなりません。すなわち、拡張機能などが新しく作成されたカスタム名前空間で動作する場合、それぞれの拡張機能を呼び出す前にそれらを定義し名前を付けることを確認します。たとえば、それは $wgExtensionFunctions のような初期化後のフックで操作されることはありません。
URLプロトコルとの衝突に注意
MediaWikiのリンクコードは $wgUrlProtocols 変数で定義された、いくつかのURLプロトコルについて知っています。 名前空間名がこれらのプロトコルと同一である場合、カスタム名前空間のページへの [[wikilinks]] を作成するのに苦労するでしょう。 これは、誰かが "News" 名前空間を作成しようとしたときに最もよく発生するもので、news: は NNTP ニュースグループの URL プロトコルだからです。
この問題を回避するには、LocalSettings.php ファイルに以下のコードを追加して、関連するURLプロトコルの登録を解除します(newsを削除したいプロトコルの小文字の名前で置き換えます)。
$wgUrlProtocols = array_diff( $wgUrlProtocols, array( 'news:' ) );

拡張機能

拡張機能では、Flow 拡張機能の "Topic" 名前空間のように、独自の名前空間を追加することがよくあります。 拡張機能は、上記のように無条件に $wgExtraNamespaces に追加できます。または、名前空間の登録が条件付きである場合 (たとえば、EventLogging はスキーマを保存する wiki で "Schema" 名前空間を定義するだけ)、何をすべきか決定する CanonicalNamespaces フックのハンドラ関数を追加することができます。

拡張子を登録するタイミングは微妙です。 拡張機能が $wgExtensionFunctions で登録する関数は、名前空間を追加登録するには実行が遅すぎます (タスク T47031) 。 そのため、拡張機能はファイルスコープでCanonicalNamespacesフックをバインドする必要があります。(in MyExtension.php)そして、wikiが余分な名前空間を有効にするかどうか、そこでチェックします。 拡張機能は、名前空間を実際に作成する必要がないため、ファイルスコープで無条件に名前空間許可とコンテンツハンドラを設定することができます。

MediaWiki バージョン:
1.25
Gerrit change 166705

新しい extension.json 登録システムには、常に存在すべき名前空間をリストアップするための拡張機能用の namespaces キーがあります。 拡張機能 Gadgets から:

"namespaces": [
		{
			"id": 2300,
			"constant": "NS_GADGET",
			"name": "Gadget",
			"protection": "gadgets-edit"
		},
		{
			"id": 2301,
			"constant": "NS_GADGET_TALK",
			"name": "Gadget_talk"
		},
]

また、CanonicalNamespacesフックもサポートしています。

コンテンツ名前空間

サイトの統計ページを構築するとき(Special:Statisticsを参照)、MediaWikiはある合計値を計算するためにデータベースに保存された変数を使用します。 一つの特定の合計値は"記事の数"もしくは"内容ページの数"の合計値です。

記事もしくは適切な内容としてページがみなされるようにするために、次のことをしなければなりません:

When creating custom namespaces to hold additional content, it is a good idea to indicate this in the configuration. これは $wgContentNamespaces 構成ディレクティブ経由で行われます。

上記の例を拡張するために、次の内容を "LocalSettings.php" ファイルに追加します:

$wgContentNamespaces[] = 3000;
または
$wgContentNamespaces[] = NS_FOO;

これでMediaWikiはページが含んでいる基準(criteria)と合う場合に"Foo"名前空間にあるページを記事と見なすようになり、サイト統計カウンターをアップデートするときにインクルードされます。

メンテナンス スクリプトの実行

  • 構成パラメーター $wgContentNamespaces の値を調整するとき、内部の統計キャッシュをアップデートする "path/to/maintenance/updateArticleCount.php や "path/to/maintenance/initSiteStats.php" のスクリプトを実行することはよいアイディアです (Manual:メンテナンススクリプト を参照)。

カスタム名前空間が必要な場合

これを必要とする理由はいくつかあります。

  • カスタム名前空間は、検索結果ページに表示されるべきでないコンテンツ、例えばtransclusionにのみ使用されるページなどを保持するために使用できます。
  • 特定の名前空間では、編集に追加権限が必要です。
  • 特定の名前空間に特定の制限や既定の設定を適用させたくない場合 (たとえば $wgNoFollowNsExceptions など)
  • 特定のコンテンツに対して、その名前空間のみで検索可能な統一プレフィックス
  • MWの開発者であれば、時にはカスタムで拡張機能の名前空間 を用意する必要があります。

既存のページを取り扱う

ページレコードを保存するとき、MediaWikiはタイトルのテキストに加えて、名前空間の数値インデックスを使用します。 ページが存在しない名前空間に作成されたとき、例えば、"Bar:Some page"、メインの名前空間にあるものとして取り扱われます。

"Bar"のためにカスタムの名前空間を後で追加する場合、このことによって問題を起こす可能性があります。MediaWikiは適切な名前空間経由でインデックスされたページを探しますが、見つからないので、内容にアクセスできません。

この問題を修正するために、3つの主要なアプローチがあります。

衝突するページを移動させる

If the number of pages affected is small (e.g. "Bar" held five pages created before the namespace was defined in the site configuration), then the following approach might be suitable:

  1. コンフィギュレーションファイルにある名前空間の定義をコメントアウトする
  2. それぞれ影響されるページにアクセスをして、擬似名前空間に移動させる、例えば、Bar:Some page"を"Bar2:Some page"に移動させる
  3. 名前空間の定義のコメントを解除する
  4. 影響されるページを新しい名前空間に戻す

メンテナンス スクリプトの使用

maintenanceディレクトリ内に、大規模のページに対してより効果的に上記のオペレーションを実行するメンテナンススクリプトがあります; NamespaceDupes.php 。 シンプルですが、すべてのMediaWikiメンテナンススクリプトと同様に、最初に利用可能な使い方情報(--helpを使用します)をオプションとして最初に尋ねることができます。

データベース クエリを使用する

すべてのページ "Bar:Some page" を名前空間3000に移動するには、次のデータベースクエリを作成します。

UPDATE page SET
page_title = REPLACE(page_title, 'Bar:', ''),
page_namespace = 3000
WHERE page_title LIKE 'Bar:%' AND page_namespace=0

議論ページを取り扱う:

UPDATE page SET
page_title = REPLACE(page_title, 'Bar_talk:', ''),
page_namespace = 3001
WHERE page_title LIKE 'Bar_talk:%' AND page_namespace=1

このように設定した後、refreshLinks.php スクリプトとupdateSearchIndex.php スクリプトを実行して、Wikiの内部リンクと検索結果を更新してください。 Googleなどの外部検索エンジンは、インデックスの更新に時間がかかることに注意してください。

カスタム名前空間の除去

上記で書かれた問題はカスタム名前空間が削除されるときにも起こります; MediaWikiは名前空間のための数値インデックスをもはや認識しないので、望むページのためにメインの名前空間を探そうとしますが、内容にアクセスできません。 多くのサイトではremoved名前空間が必要ではないので、これはほとんど起こりません。しかし問題があります。 (参照: メーリングリストの議論).

次の例は Flow と Topic 名前空間を削除する方法です:

  • 削除の流れ
  • 設定に$wgExtraNamespaces[2600] = 'Topic';を一時的に追加する。
  • Topic名前空間内のすべてのページを削除するにはdeleteBatch.phpを使用します。
  • $wgExtraNamespacesの設定を削除します。

カスタム名前空間の名前変更

ページの大量移動を行わずに、カスタム名前空間「Foo」を「New」に改名する必要があるとします。 これを実現する最も簡単な方法は、名前空間ID(ここでは"3000")と名前空間定数(ここでは"NS_FOO")を保持し、(目に見える)名前空間タイトルを変更して、古いものをエイリアスとして追加することです。

define("NS_FOO", 3000);
$wgExtraNamespaces[NS_FOO] = "Foo";

define("NS_FOO", 3000);
$wgExtraNamespaces[NS_FOO] = "New";
$wgNamespaceAliases['Foo'] = NS_FOO;

に変更します

名前空間の衝突の回避

In order for you to avoid namespace conflicts e.g. your namespace has the same number as a namespace defined by an extension, the extension namespace list shows you which numbers to avoid to prevent conflicts.

$wgExtraNamespaces の既存の名前空間に関連しないIDのために$wgNamespacesToBeSearchedDefault $wgNamespacesWithSubpages 、$wgContentNamespacesもしくは$wgNamespaceAliases を定義することはwikiを壊しません; MediaWikiはそのような設定を無視します。

名前空間のスタイル設定

たとえば、特定の名前空間(と、それに関連するトーク名前空間)のページの背景色を設定するには、次のコードをcommon.cssに追加します。

.ns-3000 #content, .ns-3001 #content { background-color: #f3f3ff; }
.ns-3000 div.thumb, .ns-3001 div.thumb { border-color: #f3f3ff; }

ここで、3000は名前空間のインデックス、#f3f3ff背景色として使用したい色です

関連項目