Help:ページ状態インジケーター

From mediawiki.org
This page is a translated version of the page Help:Page status indicators and the translation is 86% complete.

ページ状態インジケータとはアイコン(または短い文のスニペット)で、記事の主な内容の領域外に表示され、記事の状態(たとえば当該ページが保護済み か、注目記事かなど)を示すもののこと。

呼び名もトップアイコン、ページアイコン、見出しアイコンあるいはタイトルアイコンとさまざまです。

この機能がGerrit change 162609MediaWiki 1.25 に追加された理由は、タスク T25796解消とこの問題に対応するため暫定的に加えられた、英語版ウィキペディアの‘top icon‘テンプレートを代表とする複数の解決策を一掃するためです。

ページ状態インジケータを表示する

ベクター外装ではインジケータは赤く囲ったところに表示。

ページ状態インジケータは通常、画面の右上角、主な内容の外側もしくはページ題名の直前に表示されます。 外装 によって位置は多少、変わります。

ページ状態インジケーターを追加

次の構文を使用すると、name属性とタグの内容を利用者の好みに変更し、インジケータをページに追加します。

その場合、直接、記事にタグ構文を挿入するのではなく、利用者が求めるインジケータごとにテンプレート を作成することが強く推奨されます。

ウィキテキスト構文:

<indicator name="foo">[[File:Foo.svg|20px]]</indicator>

Lua モジュール構文:

mw.getCurrentFrame():extensionTag {
	name = "indicator",
	content = '[[File:Foo.svg|20px]]',
	args = {
		name = "foo"
	}
}

以下にご注意ください:

  • When using a caption on the image, the caption automatically becomes a title attribute with the contents of the caption.
  • Any wikitext can be added, not just images. (TemplateStyles is only supported starting with MediaWiki 1.39 , see T188443.)
  • インジケータは必ず1件ずつ独自の識別子(名称)をつけること。 同一の名前を複数のインジケータに命名することはできません – 重複と見なされると、いちばん最後に生成されたタグのみ有効です。
  • インジケータの表示は登録順ではなく、名称順(大文字小文字認識)。 これにより複数ページ間の統一性が保たれ、簡単に順序付けまたはグループ化する方法となります。
  • インジケータは監視の対象外。 これらの用途はすでにページ内に表現された内容もしくはメタデータを単に反映することであり、データそのものではないからです。 もちろん適する追跡用カテゴリ やテンプレート参照読み込み リスト、特別ページ レポートまたはその他の方法を用いて、当該のインジケーターを含むページを抽出できるはずです。

既知の問題点

ウィキでの表示のカスタマイズ

もしご利用の外装で「ページ状態インジケータ」をサポートするなら (既定の外装はすべてサポート) 、サイトおよび利用者CSSを使って表示方法を調整できます。 スタイルに対応するCSSクラスは.mw-indicators (インジケータを含むブロック領域全体) と.mw-indicator (単体のインジケータ) です。

単体のインジケータはまた、#mw-indicator-nameIDが振られ、<indicator name="foo">構文によって与えられるnameがその名称を示します。

外装にインジケータのサポートを追加

Manual:SkinMustache.php array-indicators を参照してください。

PHPコードとインジケータの使用

OutputPage オブジェクトを開き、表示したいIDとHTML文字列を使ってsetIndicators()メソッドを呼び出します。 もし説明文書にヘルプへのリンクを追加する場合は、addHelpLink()メソッドを呼び出すと、それがSpecialPage に加えてその他のクラスも実施していることが確認できます。 するとインジケータ領域にヘルプリンクが追加されます。例えばSpecial:WhatLinksHereを参照してください。