ウィキペディア:テンプレート名前空間

ウィキペディアから、無料の百科事典
ナビゲーションにジャンプ 検索にジャンプ

ウィキペディアテンプレート名前空間、通常はトランスクルージョンを介して複数のページに含めることを目的としたウィキマークアップを含むテンプレートを格納するために使用されます。テンプレート名前空間はほとんどのテンプレートの保存に使用されますが、他の名前空間からトランスクルージョンおよび置換することが可能であるため[1]、一部のテンプレートページはユーザー名前空間などの他の名前空間に配置されます

テンプレートは、一貫したフォーマットを維持し、記事間のナビゲーションを支援します。それらはしばしば、特殊な使用を可能にするためにパラメータによって制御されるオプションおよび/または可変要素を含みます。テンプレートは、さまざまなウィキペディアのメンテナンスタスクを支援するためにも使用されます。各テンプレートには、Template talk:編集者が関連するテンプレートの設計と実装について話し合うことができる一致するページがあります(トークページのディスカッションに参加する方法については、ヘルプ:トークページの使用を参照してください)。

テンプレートは、そのページのコンテンツにテンプレートタグを含めることにより、別のページにトランスクルージョンされます。テンプレートタグには、二重中括弧で囲まれたテンプレートページ名が含まれます{{Disambiguation}}テンプレートのページ名が名前空間とコロンで始まらない場合、テンプレート名前空間にあると見なされます。

テンプレートページへの内部リンクは、Template:プレフィックスを使用して作成でき[[Template:Disambiguation]]ます。これらのリンクは、基本テンプレートと多くの場合ドキュメントを直接含むページに移動します

ガイドライン

  • テンプレートは通常記事のテキストを保存するために使用しないでください。これにより、コンテンツの編集がより困難になります。またコンテンツをリーダーから「折りたたむ」または「隠す」ために使用しないでください
  • 記事で使用されるテンプレートは、ナビゲーションエイド、フォーマット、コンテンツが標準以下であることの警告など、読者を支援するための情報を提供するように設計されています。編集者にサービスの情報のみを提供するテンプレートは、記事ページに表示しないでください。記事のトークページまたはその他の記事以外の名前空間を使用してください。
  • テンプレート機能は、より明確にする必要があり、テンプレート名が、リダイレクトは非常に人気のあるテンプレートの毎日の使用を支援するために作成することができます。
  • リスクの高いテンプレート、必要に応じて、半保護、テンプレート保護、または完全に保護する必要があります(Wikipedia:保護ポリシーを参照)。これは、使用頻度の高いテンプレートリダイレクトにも当てはまります。
  • テンプレートは、その使用法と範囲について明確に文書化する必要があります。
  • カテゴリリストページ、または「関連項目」セクションリストで同じ機能を実行できる場合は、テンプレートを使用して他の記事へのリンクのリストを作成しないでください
  • すぐに削除される(User_talk:ページなど)、または変更される可能性が低いテキストを含む短い一時メッセージのテンプレートは、置換(subst :)で呼び出す必要があります長期間の使用を目的としており、変更が必要になる可能性が高い一般的なテンプレートは、将来の更新を容易にするためにトランスクルージョンする必要があります。
  • このページのガイドラインに違反する、機能が十分に定義されていない、冗長である、孤立する、または1つのページでのみ使用される、または他のWikipediaポリシーに違反するテンプレートはWikipedia:Templates fordiscussionで削除するように指名される場合があります

推奨される方法

テンプレートの参照

テンプレートを実際に呼び出すのではなく、参照たい場合がありますこれを行う簡単な方法は、Template:Tl(「テンプレートリンク」の略)を呼び出すことです。たとえば、クリーンアップテンプレートを参照するには、{{tl|Cleanup}}結果を{{ Cleanup }}と入力しますTemplate:Tlpを使用してパラメーターを追加することもできますたとえば、{{ Convert | 1 | m}}{{tlp|Convert|1|m}}表示されます

{{ tlb }}(太字)、(コード)、(斜体パラメーター)などの他のオプションについては、Template:Tlのテンプレートドキュメントを確認してください{{tlx}}{{tlxi|param1|param2}}

テンプレート名

テンプレート名は、などの1つ以上の単語で構成できます{{Train topics}}最初の文字(のみ)では大文字と小文字が区別されないため{{cleanup}}、と{{Cleanup}}は同じテンプレートですが{{cfd}}、で{{cfD}}はありません。テンプレート名は、標準の英語のスペル、間隔、および大文字と小文字を区別する場合に覚えるのが最も簡単です(記事の命名規則も参照してください)。大文字と小文字、間隔、句読点のみが異なる名前のテンプレートは使用しないでください。

実験用サンドボックス

テンプレートを試してみたい場合(そして、テンプレートを使用する前に実験を削除したくない場合)は、テンプレートサンドボックスで行うことができます。テンプレートX1X2X3X4X5X6X7X8X9X10X11、およびX12を実験目的で使用することもできます。テストテンプレートを含めるには、{{X1}}テンプレートX1、{{X2}}テンプレートX2などのフォーム使用します

多くの場合、既存のテンプレートにはそれぞれ独自のサンドボックスページとテストケースページがあります(特に{{ドキュメント}}を使用するテンプレート)。多くのページへの意図しない損傷を防ぐために、変更をメインテンプレートに適用する前に、そこで徹底的にテストする必要があります。

読みやすさ

多数のパラメーターを使用するテンプレートの場合、各パラメーターを別々の行に配置し、等号を揃えると便利です。これは、将来の編集者がウィキコードをより簡単に読むのに役立ちます。

{{テンプレート名の例
| first_parameter = first_valueのテキスト
| second_parameter = second_valueのテキスト
| third_parameter = third_parameterのテキスト
| など=など
}}

改行

一部のテンプレートは、レンダリングされた記事で誤って余分な改行を引き起こす可能性があります。これは、追加の行がテンプレートページに表示されないため、通常は記事の右側に浮かぶインフォボックステンプレートやその他のテンプレートボックスに特に当てはまります。詳細については、Wikipedia:改行処理を参照してください

一般的なガイドラインとして、テンプレートで2つの改行を一緒にしないでください。これらは、記事内の他の改行と「合算」され、不要な空白として表示される場合があります。

置換

フォームを使用してテンプレートを呼び出す

{{subst:name of template (|parameters |...)}}

(つまりsubst:、中括弧の最初のペアの直後に挿入すると)テンプレートテキストのコピーが作成され、ソースで表示できるページに配置されます。テンプレートはトランスクルージョンされなくなり、テンプレートを今後変更してもテキストは変更されません。ガイドラインとして、このメソッドは、User_talk:ページなど、すぐに削除される短い一時的なメッセージに使用する必要があります。標準の新規ユーザーメッセージが良い例です。 {{Welcome}}

ページにメッセージを含めた後でメッセージを編集する必要がある場合にも、subst:を使用します。編集する必要がなく、テンプレートに加えられた変更とともにメッセージが自動的に更新される場合は、subst:を使用しないでください。

ドキュメンテーション

テンプレートは初心者の編集者にとって難易度のステップアップを表すため、その使用法(オプションのパラメーター)と範囲(使用する場所)を説明するドキュメントを提供する必要があります。これを行うには、2つの異なる方法があります。

1つの代替方法は、<noinclude>を使用して、テンプレートに直接マイナーな説明を追加することです。次に例を示します。

'' 'これは{{{1}}}の記事です。' '' <noinclude>
説明が必要な記事にこのテンプレートを配置します。それ
冠詞を説明するために使用される形容詞である1つのパラメーターを取ります。 
たとえば、{{article-describe | bad}}はテキストを生成します。 
「これは悪い記事です。」
</ noinclude>

もう1つの方法は、ドキュメント用の正式な/ docサブページを作成し(複数のパラメーターを持つテンプレートなどに推奨)、実際のテンプレートの後に追加することです。最初の「noinclude」タグは、次の方法で実際のテンプレートの終了中括弧と同じ行に配置する必要があります。 <noinclude>{{Documentation}}</noinclude>

{{(テンプレート名)
(パイプパラメータ)
}} <noinclude>..。

「noinclude」タグがテンプレートの閉じ中括弧の下の行で始まる場合、記事や他のページで使用されるときに、テンプレートの下部に不要な空白が導入されます。

モジュール

テンプレートの代わりにLuaモジュールを使用して、再利用可能な素材を保存することがあります。この理由には、ループや格納された値などのモジュール固有の機能の使用が含まれ、複雑なコードはモジュール内で読み取りおよび保守するのが簡単なことがよくあります。モジュールをテンプレートに簡単に実装できる場合は、テンプレートの編集経験を持つユーザーが多いため、通常は実装する必要があります。

モジュールが記事やトークページで使用されることを意図している場合は、通常、#invokeパーサー関数を直接必要とせずに使用を簡素化するためにテンプレートラッパーを作成する必要があります。その場合、ドキュメントは主にテンプレートの/ docページにあり、モジュールのドキュメントはテンプレートを指しているか、プライマリテンプレートのドキュメントでは不要な技術的な詳細を説明しています。

ただし、テンプレートの制限で潜在的な問題が発生するなど、テンプレートラッパーを使用しない理由がある場合がありますモジュールに渡すパラメーターが多すぎるテンプレートラッパーは、直接呼び出しに比べて効率がはるかに低くなります。さらに、他のテンプレートでテンプレートラッパーを使用することは一般的に望ましくありません。

歴史

従来、ページで使用する場合は、テンプレート名の前に「msg:」プレフィックスを追加する必要がありました。たとえば、{{stub}}の代わりに{{msg:stub}}が入力されました。これはもう必要ありません。

ウィキペディアの最初の35か月では、テンプレートやトランスクルージョンのメカニズムはまったくありませんでした。ウィキペディア:ボイラープレートテキストのページは、さまざまなウィキペディアのプロセスで頻繁に使用されるテキストを収集するために2002年9月に作成されました。MediaWikiの名前空間は2003年12月6日にはMediaWiki 1.2.6で導入されました、そしてユーザーインターフェースのためだけでなく、{{MSG:...}}を使用して記事に挿入する定型テキストメッセージを作成するためだけでなく、使用された構文を。この関数は、2004年5月30日のMediaWiki 1.3へのソフトウェアアップグレード中にテンプレート名前空間置き換えられました。「テンプレート名前空間初期化スクリプト」の関数として"、すべての非システムメッセージが新しい名前空間に移動されました。初期化スクリプトは、MediaWiki:記事内の参照をTemplate:に置き換え、移動によって作成されたリダイレクトをバイパスしました。

しばらくの間、Wikipedia:削除の記事(当時は削除の投票またはVfDとして知られていました)はMediaWiki:「MediaWiki:VfD -articlename」の形式で名前が付けられたメッセージを使用していましたこれらは2004年6月にTemplate:スペースに移動され、「Template:VfD -articlenameという名前が付けられましたこの使用法は非推奨になり、サブページが優先されます。

2005年頃、テンプレート関数の複雑さが増し、同様のテンプレートを統合したいという要望から、ネストされたテンプレートCSSトリックなどの非常に複雑な条件付きハックが作成されましたこれらの望ましくない方法は、2006年にMediaWiki 1.7で追加されたm:Extension:ParserFunctionsの開発につながりました2009年までに、テンプレートの可読性と複雑さに関する多くの問題が依然として残っていました(テンプレートとプログラミング言語について)。2013年に、主にテンプレートのレンダリングが遅いためにページの読み込み時間に対処するために、Luaが有効になり、プログラマーが使用できるModule:名前空間が作成されました(新しいLuaテンプレートは、より高速で柔軟なページをWikiにもたらします)。

テンプレートの検索

このフォームを使用して、Template:またはTemplate_talk:名前空間を検索します。詳細については、ヘルプ:検索参照してください。

一般的に使用されるテンプレートに関する情報を含むページ:

自分の状況に合った既存のテンプレートが見つからないが、自分でテンプレートを作成することに抵抗がある場合は、Wikipedia:Requestedtemplatesでヘルプを求めることができます

も参照してください

ノート

  1. ^ トランスクルージョンが許可されていない名前空間は、ウィキで変数$ wgNonincludableNamespacesによって指定されます。