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

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Manual:Using custom namespaces and the translation is 42% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎galego • ‎日本語 • ‎한국어 • ‎polski • ‎русский • ‎中文

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

$wgExtraNamespaceManual:$wgExtraNamespaces コンフィギュレーションディレクティブを使用することでカスタムの名前空間は管理が簡単です。 It is also possible to define alias names for custom (and also predefined) namespaces, using the $wgNamespaceAliasesManual:$wgNamespaceAliases configuration directive.

It's recommended to ensure there are no pending jobs in the job queue before manipulating namespaces, to avoid such jobs from failing if they target pages from namespaces you are about to delete or rename. Use runJobs.phpManual:RunJobs.php to run all pending jobs and clear the queue before manipulating namespace configuration.

カスタム名前空間の作成[edit]

You register additional namespaces by adding them to the $wgExtraNamespaces global variable to your LocalSettings.phpManual:LocalSettings.php file. All namespaces require a unique numerical index in this array. As an example of simple custom namespace creation, adding the following lines to LocalSettings.phpManual:LocalSettings.php defines a "Foo" namespace 3000 and its associated "Foo talk" namespace:

// Define constants for my additional namespaces.
define("NS_FOO", 3000); // This MUST be even.
define("NS_FOO_TALK", 3001); // This MUST be the following odd integer.

// 名前空間を追加する。
$wgExtraNamespaces[NS_FOO] = "Foo";
$wgExtraNamespaces[NS_FOO_TALK] = "Foo_talk"; // 名前空間名に含まれるアンダースコアに注意。
未使用の番号を選択
As a convention, the namespaces numbered 100-199 are reserved for site-specific namespaces, although there are some extensions that don't follow this convention. Extension writers use higher numbers, up to 32767. When choosing your index, you should avoid any number already in extension default namespaces, since you might want to install that extension later. Thus numbers from 3000 and higher are a good pick for system administrators to define their custom namespaces.
偶数と次の奇数
Note the namespace array index is 3000 in the above example.
トーク名前空間も作成
You typically create a discussion "Talk" namespace along with each custom namespace. With this example, if you move a page into the "Foo" namespace, will be prompted to move its associated talk page, if any, and if you choose to do so, MediaWiki will place the talk page in "Foo talk".
空白を含めない
名前空間を登録する際は、スペースの代わりにアンダースコアを使ってください。 “My Namespace”は、名前空間の登録においては無効ですので、代わりに“My_Namespace”を使ってください。
ハイフンを含めない

The uppercase part does not permit hyphens but they can still be safely added to the prefix title. 例:

$wgExtraNamespaces[NS_FOOFOO] = "Foo-Foo";
選択した番号に名前を付ける
The example defines constants for the namespace IDs, so that you can refer to these namespaces later on in the configuration, for example in $wgNamespaceProtection, $wgNamespacesWithSubpages, or $wgExtraGenderNamespaces.

You could go on to configure additional settings for your new namespace.

$wgNamespaceProtection[NS_FOO] = array( 'editfoo' ); // permission "editfoo" required to edit the foo namespace
$wgNamespacesWithSubpages[NS_FOO] = true;            // subpages enabled for the foo namespace
$wgGroupPermissions['sysop']['editfoo'] = true;      // permission "editfoo" granted to users in the "sysop" group
Do it early
Manipulation of $wgExtraNamespaces must be completed during MediaWiki initialization; for instance it cannot be manipulated in a post-initialization hook like $wgExtensionFunctions.
Watch out for collisions with URL protocols
MediaWiki's linking code knows about a number of URL protocols, defined in the $wgUrlProtocols variable. If your namespace name is identical to one of these protocols, you're going to have trouble creating [[wikilinks]] to pages in your custom namespace. This most commonly arises when someone tries to create a "News" namespace, because news: is a URL protocol for NNTP newsgroups.
To avoid this issue, you can deregister the relevant URL protocol by adding the following code to LocalSettings.php (replacing news by the lowercased name of the protocol you wish to remove):
$wgUrlProtocols = array_diff( $wgUrlProtocols, array( 'news:' ) );

In extensions[edit]

Extensions often add their own namespaces, such as the FlowExtension:Flow extension's "Topic" namespace. An extension can unconditionally add to $wgExtraNamespaces as described above, or if its namespace registration is conditional (for example EventLoggingExtension:EventLogging only defines its "Schema" namespace on the wiki where it stores schemas), then it can add a handler function for the CanonicalNamespacesManual:Hooks/CanonicalNamespaces hook that decides what to do.

The timing of registering extensions is subtle. Functions that extensions register with $wgExtensionFunctions are executed too late to register additional namespaces (bug T47031). So extensions should bind the CanonicalNamespaces hook at file scope (in MyExtension.php) and check there whether the wiki should activate the extra namespace or not. Extensions can configure namespace permissions and content handlers unconditionally at file scope since they do not require the namespace to actually be created.


MediaWiki バージョン: 1.25
Gerrit change 166705

The new extension.json registration system has a namespaces key for an extension to list its namespaces that should always exist. From the GadgetsExtension:Gadgets extension:

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

It also supports the CanonicalNamespaces hook.

コンテンツ名前空間[edit]

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

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

追加の内容を保持するカスタムの名前空間を作成するとき、コンフィギュレーションにこれを示すことはよいアイディアです。 $wgContentNamespacesコンフィギュレーションディレクティブ経由で行われます。

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

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

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

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

  • $wgContentNamespacesの値を調整するとき、内部の統計キャッシュをアップデートするmaintenance/updateArticleCount.phpスクリプトを実行することはよいアイディアです (see: Manual:Maintenance scripts)。

Why you would want a custom namespace[edit]

There are several reasons on why you would want this:

  • A custom namespace can be used to hold content that should not be shown on the search results page, for example pages that are used only for transclusion.
  • Certain namespace require additional privilege(s), i.e. for reading or editing
  • You want certain namespace not to be subjected to certain limitation or default settings ($wgNoFollowNsExceptionsManual:$wgNoFollowNsExceptions for example)
  • A uniform prefix for specific content(s), which is searchable for that namespace only
  • If you're an MW developer, sometimes you need to have a custom namespace for your extension(s)

既存のページを取り扱う[edit]

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

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

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

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

影響されるページ数が小さい場合(例えば、サイトコンフィギュレーションで名前空間が定義される前に"Bar"は5つのページを持つ場合、)次のアプローチが適用できます:

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

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

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

Use a database query[edit]

To move all pages "Bar:Some page" into namespace 3000, make the following database query:

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

To handle discussion pages:

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

The above example is wrong. It should look for "Bar_Talk:" or "Bar_talk:" or how MediaWiki saves that inside the page_title field... After such fiddling, run the refreshLinks.phpManual:refreshLinks.php script and the updateSearchIndex.phpManual:updateSearchIndex.php script to update internal links and search results in your wiki. Note that external search engines like Google will take some time to update their index.

カスタム名前空間の除去[edit]

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

Example on how to remove FlowExtension:Flow and the Topic namespace:

  • Uninstall Flow
  • Temporarily add $wgExtraNamespaces[2600] = 'Topic'; to the config
  • Use deleteBatch.php to delete all pages in the Topic namespace
  • Remove the $wgExtraNamespaces config

Renaming custom namespaces[edit]

Suppose that you need to rename custom namespace "Foo" to "New" without performing a mass move of pages. The easiest way to achieve this is to preserve the namespace ID (here "3000") as well as the namespace constant (here "NS_FOO"), modify the (visible) namespace title and add the old one as an alias.

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

名前空間の衝突の回避[edit]

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.

Defining $wgNamespacesToBeSearchedDefault, $wgNamespacesWithSubpages, $wgContentNamespaces or $wgNamespaceAliases for an ID not associated to any existing namespace in $wgExtraNamespaces doesn't break the wiki; MediaWiki gracefully ignores such configurations.

Styling namespaces[edit]

For example, to set the background color of pages in a particular namespace (and its associated talk namespace) you can add the following code to your common.css:

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

where 3000 is the namespace's index and #f3f3ff is the color you want as its background color.

関連項目[edit]