Help:Variable/ja

翻訳ノート

以下に示したものは英語で書かれた Meta-Wiki "m:Help:Variable" (17:43, 11 Feb 2005) の和訳文である。

さらに、2007/1/6頃のデータで加筆しています。

さらに2007/04/14頃のデータで加筆しています。

本来は英語版の「ヘルプ」である以上、その内容が、そのまま日本語版のウィキに当てはまるとは限らないのは当然である。逆に、日本語化によって、英語文脈でのみ意味を持つ内容は、失われたり、変質したりする。

従って、本ヘルプは、英語版 Wiki の動作の説明を保証するものでも、日本語版ウィキの動作の説明を保証するものでもない。

本ヘルプは単に、英語文を読むのに強い抵抗を感じるユーザーが、原文の内容に就いての概括的な知見を得るのを助けるためだけのものである。日本語版ウィキの対応機能に就いて、実際に即した詳しいヘルプが書かれた時には、速やかに削除されねばならない。

訳文の始まり

MediaWiki ハンドブック: 目次、読者、編集者、中間管理者、システム管理者 +/-

変数とはパラメーターのない あらかじめ設定済みのテンプレートと考えることができる。Help:パーサ関数を参照。

以下は、ウィキテキスト中で使うことができる変数のリストである。こうした変数に与えられる具体値は、その時刻 (時刻そのものに直接依拠する場合のほか、その他の記事の作成によってはたとえば記事件数も) や、置かれているプロジェクト (ウィキテキストが複写されると変更される) 及び記事 (ウィキテキストの複写やページの改名、ページが他のページに統合されたとき変化) に依存する。

リスト左側には、変数が示されている。右側には、このプロジェクトのこのページにおいて、現時点での変数の具体値が示されている。

変数の名前はシステムが使用するいわゆる「マジックワード」の組み合わせの一部を形成する。

特別ページ:テンプレートを展開を利用すると、変数の具体値、つまり展開に向けた中間段階として、展開されたウィキテキストを呼び出す変数または変数を含むテンプレートそして／あるいはテンプレート単体を生成する。

定数

{{SITENAME}}	Meta
{{SERVER}}	//meta.wikimedia.org
{{SERVERNAME}}	meta.wikimedia.org
{{CONTENTLANGUAGE}}	en	サイトの既存のインターフェース言語のコード ($wgLanguageCode)

プロジェクト及びパラメータにのみ依存し、時間変化しないもの

{{ns:-2}} 又は {{ns:Media}}	Media
{{ns:-1}} 又は {{ns:Special}}	Special
{{ns:1}} 又は {{ns:Talk}}	Talk
{{ns:2}} 又は {{ns:User}}	User
{{ns:3}} 又は {{ns:User_talk}}	User talk
{{ns:4}} 又は {{ns:Project}}	Meta
{{ns:5}} 又は {{ns:Project_talk}}	Meta talk
{{ns:6}} 又は {{ns:Image}}	File
{{ns:7}} 又は {{ns:Image_talk}}	File talk
{{ns:8}} 又は {{ns:MediaWiki}}	MediaWiki
{{ns:9}} 又は {{ns:MediaWiki_talk}}	MediaWiki talk
{{ns:10}} 又は {{ns:Template}}	Template
{{ns:11}} 又は {{ns:Template_talk}}	Template talk
{{ns:12}} 又は {{ns:Help}}	Help
{{ns:13}} 又は {{ns:Help_talk}}	Help talk
{{ns:14}} 又は {{ns:Category}}	Category
{{ns:15}} 又は {{ns:Category_talk}}	Category talk
定番外に特別構成された名前空間に応じて: {{ns:100}} - {{ns:121}}	-
{{SITENAME}}	Meta
{{SERVER}}	//meta.wikimedia.org
{{localurl:pagename}}	/wiki/Pagename
{{localurl:pagename|問い合わせ文字列}}	/w/index.php?title=Pagename&問い合わせ文字列
{{int:fromwikipedia}}	⧼fromwikipedia⧽

"INT:" は、"internal" の略語であって、wfMsg から、LanguageXx.php ファイル中のメッセージなどのテキストを得るのに使われる(直上の例参照)。

訳注: 「定番外に特別構成された名前空間」は "custom namespaces:" の訳。「カスタムナイフ」や「カスタムカー」の例もあるので、「カスタム名前空間」と訳すことも考えたが、現状では意味の喚起力が不足していると判断した。また、「カスタム名前空間」では、プリフィックス "Custom:" に対応する名前空間であるとミスリードする可能性がある。よって、「カスタム名前空間」は却下。

時間変化するもの

See also: ja:Category:日付計算テンプレート

時刻

w:ja:協定世界時の時刻のこと。同じユーザーがページを表示し、最後に表示してからページが変更されていない（ページが編集されていない）場合は、ユーザーのブラウザが (ページを) キャッシュするため、表示される時刻と日付が変わらない場合がある。また頻繁に使用されるページについて、ソフトウェアがページ生成のたび毎回新しくレンダリングする代わりに、キャッシュシステムからページを取得する場合 (ウィキペディアのメインページなど)、日付または時刻は最後の日付と同じで変わることはない。なぜなら、ページはもともとキャッシュしたハードウェアまたはソフトウェアによって取得されているためである。

Word	Example	Explanation
{{CURRENTDAY}}	8	Displays the current day in numeric form.
{{CURRENTDAY2}}	08	[MW1.6+] Same as {{CURRENTDAY}}, but with leading zero (01 .. 31).
{{CURRENTDAYNAME}}	Saturday	Name of the day in the language of the project or English.
{{CURRENTDOW}}	6	Same as {{CURRENTDAYNAME}}, but as a number (0=Sunday, 1=Monday...).
{{CURRENTMONTH}}	05	The number 01 .. 12 of the month.
{{CURRENTMONTHABBREV}}	May	[MW1.5+] Same as {{CURRENTMONTH}}, but in abbreviated form as Jan .. Dec.
{{CURRENTMONTHNAME}}	May	Same as {{CURRENTMONTH}}, but in named form January .. December.
{{CURRENTTIME}}	20:46	The current time (00:00 .. 23:59).
{{CURRENTHOUR}}	20	The current hour (00 .. 23).
{{CURRENTWEEK}}	18	Number of the current week (1-53) according to ISO 8601 with no leading zero.
{{CURRENTYEAR}}	2021	Returns the current year.
{{CURRENTTIMESTAMP}}	20210508204611	[MW1.7+] ISO 8601 time stamp.

現地時間

現地時間はユーザー設定のタイムゾーンではなく、ウィキの現地タイムゾーンに依存する。 ParserFunctionsをインストールしてある場合、これらは一般的に{{#time:}}を使うべきで、MediaWiki 1.8以降は以下の従来の変数からも利用可能。

{{CURRENTMONTH}}	05
{{CURRENTMONTHNAME}}	May
{{CURRENTMONTHNAMEGEN}}	May
{{CURRENTDAY}}	8
{{CURRENTDAYNAME}}	Saturday
{{CURRENTYEAR}}	2021
{{CURRENTTIME}}	20:46
{{NUMBEROFARTICLES}}	103,707

NUMBEROFARTICLES: 基本名前空間中、リンクは含むが、リダイレクトは含まないページのページ数。つまり、記事とリンクを含むスタブと曖昧さ回避のためのページの総数である。

訳注: この NUMBEROFARTICLES と云う変数名は、「記事数」を連想させるものであることに注意。これが、次のパラグラフにつながる。

この変数は、システム変数 $wgUseCommaCount に依存する。それが「真」であるなら、記事数には、コンマ (",") を伴うものだけが含められる。「偽」であるなら、リンク ("[[") 伴うものだけが数えられる。 DefaultSettings.php で設定されているデフォルト値は、「偽」であるが、これは、 LocalSettings.php で変更可能である。

訳注: 「伴う」とは、「記事」中に含まれていることを意味するか否か、未確認。$wgUseCommaCount は、MediaWiki が利用している、php 変数らしいが、どのような使われかたをしているのか確認できなかった。Wg variable など笑ってしまう。

CURRENTMONTHNAMEGEN: は、月の名称の、文法上の属格形式である(フィンランド語で使用される)。

Word	Example	Explanation
{{LOCALDAY}}	8	Displays the local day of the month in numeric form.
{{LOCALDAY2}}	08	Same as {{LOCALDAY}}, but with a leading zero (01 .. 31).
{{LOCALDAYNAME}}	Saturday	Name of the day in the language of the project or English.
{{LOCALDOW}}	6	Same as {{LOCALDAYNAME}}, but as a number (0=Sunday, 1=Monday...).
{{LOCALMONTH}}	05	The number 01 .. 12 of the month.
{{LOCALMONTHABBREV}}	May	Same as {{LOCALMONTH}}, but in abbreviated form as Jan .. Dec.
{{LOCALMONTHNAME}}	May	Same as {{LOCALMONTH}}, but in named form as January .. December.
{{LOCALTIME}}	20:46	The local time (00:00 .. 23:59).
{{LOCALHOUR}}	20	The local hour (00 .. 23).
{{LOCALWEEK}}	18	Number of the local week (1-53) according to ISO 8601 with no leading zero.
{{LOCALYEAR}}	2021	Returns the local year.
{{LOCALTIMESTAMP}}	20210508204611	ISO 8601 time stamp.

MediaWikiやほとんどのブラウザはHTMLページをキャッシュしており、その方法の影響で頻繁 (1日に2回以上) に変わるtime変数は通常、現在の時刻ではなくページが最後にキャッシュされた時刻を示す。

ページに応じて変化するもの

{{NAMESPACE}} と {{NAMESPACEE}} は、記事の名前空間{{ns:0}}に空の文字列を返す。上記と NS:0を参照。

PAGENAMEE は、URL 欄で使用される形式、つまり、スペースの代わりにアンダースコアを当て、特殊文字の代わりにエスケープコードを当てて、URL を構成するのに使われる形式で、ページのタイトルを表示する (クエリ文字列を含む)。例えば、"Another test" と云うページならば、PAGENAMEE は、"Another test" ではなく "Another_test" を与えることになる。

{{NAMESPACE}}	Help
{{PAGENAME}}	Variable/ja
{{PAGENAMEE}}	Variable/ja

あるいは別の例として、Template talk:!ではSUBJECTPAGENAMEE からTemplate:%21が生成される。この場合、PAGENAMEE その他をふたたび定義する必要はなく、つまりたとえば fullurl: などのパーサ関数の1番目のパラメータに用いないこと。{{urlencode:%21}} = %2521 は回避できない。ただし PURL 移動に用いるクエリ文字列  は例外である。「変数 PAGENAME と PAGENAMEE」も参照されたい。

上記のサンプルでは「EE」エンコードはあまり目立った動きをしないが、TALKPAGENAMEE と TALKSPACEE の違いは、それぞれTALKPAGENAME と TALKSPACEであることに限定される。「Help:Link」や「 Help:Magic words」も参照。

これらの3つの変数は、テンプレートで使用される場合には、テンプレート・ページではなく、そのテンプレートが含まれているページに就いての値を与える。

下位ページ[[../]]は親ページへのリンクとして表示され、たとえば m:Link/a/bではm:Link/aという内部リンクを示す。詳細は Help:Link#Subpage featureを参照。

"{{REVISIONID}}" → "-" [1] を用いると、現在の 保存してあるファイルに対してユニークな変更番号が与えられ、 履歴表示に示される差分であり、プリビュー画面で機能しないこと、代替ができないことから根本的には 役に立たない。

統計

統計を参照。

Subst展開

Main article: Help:Substitution

{{<includeonly>subst:</includeonly>CURRENTTIMESTAMP}} が含まれサブスト展開が実行されると、その行為のタイムスタンプはウィキテキストに取り込まれ、その他の変数も同様に扱われる。例を示す。

{{CURRENTTIMESTAMP}}

20210508204611 - テンプレートを含むページの一定の変数

{{subst:CURRENTTIMESTAMP}}

20060526024210 - テンプレート内でサブスト定数になった

{{<includeonly>subst:</includeonly>CURRENTTIMESTAMP}}

20210508204611 - 包まれる時に定数として利用

テンプレートで「includeonly subst magic」を指定してある場合はサブスト展開する。

その他

文字列	例	出力の例	説明
{{PAGESINCATEGORY:category}} {{PAGESINCATEGORY:category|R}}	{{PAGESINCATEGORY:User en}}{{PAGESINCATEGORY:User en|R}}	9,4289428	[MW1.13+] 戻し値は指定されたカテゴリ内のページ数。 |- | {{PAGESINCAT:category}} {{PAGESINCAT:category|R}} | {{PAGESINCAT:User en}} {{PAGESINCAT:User en|R}} | 9,428 9428 | [MW1.13+] はPAGESINCATEGORYの別名。 |}

パーサ関数との組み合わせの例

{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}}	//meta.wikimedia.org/w/index.php?title=Help:Variable/ja&action=edit
{{SERVER}}{{localurl:Special:Whatlinkshere|target={{NAMESPACE}}:{{PAGENAME}}}}	//meta.wikimedia.org/w/index.php?title=Special:Whatlinkshere&target=Help:Variable/ja
[[{{NAMESPACE}}:{{PAGENAME}}_1]]	Help:Variable/ja_1
{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}_1}}	//meta.wikimedia.org/wiki/Help:Variable/ja_1

localurl 内においては、E が1つだけの PAGENAME を使わねばならないことに留意されたい。そうしないと、特殊文字がある場合に動作しなくなる。例えば、ページ名が É と云うページに就いては、{{localurl:É}} とすると、正しく /wiki/%C3%89 が得られる(前に、{{SERVER}} を付けて //meta.wikimedia.org/wiki/%C3%89 とすると、ページ É にリンクする)。一方、{{PAGENAMEE}} の場合は、%C9 となって、{{localurl:%C9}} からは、{{localurl:%C9}} が得られる。つまり、レンダリングされても変化がなく、関数 localurl は適用できない。前に {{SERVER}} を付けると、//meta.wikimedia.org{{localurl:%C9}} となるが、サーバは、そうしたページには辿りつけないので、ブラウザに「リング切れ」を通告される。

m:Template:UTC も参照のこと。

テンプレートでは、テンプレート・パラメータに依存するページへのリンクに就いては、そうしたページが存在するのに関わらずシステムが編集ページにリンクしてしまうことのないよう、内部リンク相当であっても外部リンクの形が取られる。外部リンクを構成するにも、変数は有用でありうる。

{{fullurl:{{FULLPAGENAME}}|action=edit}}

//meta.wikimedia.org/w/index.php?title=Help:Variable/ja&action=edit 

{{fullurl:w:en:Special:Whatlinkshere|target={{NAMESPACE}}:Contents}}

https://en.wikipedia.org/wiki/en:Special:Whatlinkshere?target=Help:Contents 

{{fullurl:m:Special:Whatlinkshere|target={{FULLPAGENAME}}}}

https://meta.wikimedia.org/wiki/Special:Whatlinkshere?target=Help:Variable/ja 

[[{{NAMESPACE}} talk:{{PAGENAME}}]]

Help talk:Variable/ja 

{{fullurl:{{NAMESPACE}} talk:{{PAGENAME}}}}

//meta.wikimedia.org/wiki/Help_talk:Variable/ja

  The old form {{SERVER}}{{localurl:ページ名 }} では挙動は恒常的ではない。 {{SERVER}}{{localurl:Wikipedia:Category }} と記述すると、戻し値は //meta.wikimedia.orgによるhttps://en.wikipedia.org/wiki/Category

訳注

1. 「システムが編集ページにリンクしないよう」の原文は、"to avoid that the system links to the edit page" だが、これは、あまり見かけない言い方。"to avoid the system from linking to the edit page" と読み替えて訳してある。
2. このパラグラフに対応するテンプレートの実例は未確認。すぐ上に言及されている [[m:Template:UTC]] は、パラメータを含まず、関連性を持ちえない。改定履歴 (history) から推測するならば、その言及は、{{UTC}} がテンプレートであって、時間変化する変数ではないことに注意を喚起するためのものと思われる。

関連項目

• テンプレートにおける画像.
• Help:テンプレート#subst 変数又は変数を用いるテンプレートへの "subst" の適用について。
  • Magic words メディアウィキのヘルプページ
  • Extension:Variables: クエリ文字列。 {{CURRENTUSER}}など新しいマジックワードを追加。
  • MagicWord.php
  • JavaScript variables supplied by the server {{h:f|en page=Variable}}

• Help:パーサ関数: version 1.7.0以降。パーサーとより緊密に統合する方法。

• Extending wiki markup#Parser_ functions|Adding parser functions

• Help:ParserFunctions拡張機能 (#expr:, #if:, #ifeq:, etc.; #titleparts:)