Wikipedia:テンプレート・モジュール作成の目安

この文書はウィキペディア日本語版の方針やガイドラインとして提案中です。内容に関してノートページで議論を行っています。

ショートカット:

WP:MODULE

ウィキペディアでは誰でもテンプレート・モジュールを作成することができます。この文章ではそれらを作成または廃止・削除する基準を紹介します。

テンプレートの作成

ユーザーボックスの作成については「Wikipedia:ユーザーボックス#作成の指針」を、スタブテンプレートの作成については「Wikipedia:スタブカテゴリ#新規作成について」を参照

テンプレートは、以下に挙げる目的・理由のいずれかに当てはまる場合に、作成できます。不必要なテンプレートは作成しないでください。

定型メッセージを挿入するため（例：{{aimai}}、{{sakujo}}、{{告知}}）
- さまざまな問題（出典、中立性など）に関する定型文も含みます（例：{{複数の問題}}、{{要検証}}）。
特定のスタイルを簡単に挿入するため（例：{{reflist}}、{{0}}、{{div col}}）
- 基礎情報を見やすくまとめ、統一された形で表示する場合なども含みます（例：Infobox、{{生物分類表}}）。
関連する記事をまとめたリンク集への誘導テンプレートやサイドバーを作成するため（例：ナビゲーションテンプレート）
有益なモジュールまたは有益なマジックワード・条件文の組み合わせを呼び出すため（例：{{val}}、{{生年月日と年齢}}）
上記4項目のうちいずれかを満たすテンプレートを成立させるため（メタテンプレートまたは内部テンプレート）

標準名前空間（記事）に使用するテンプレートは読者の理解を促す情報を提供します。これらは関連するページへのリンクを支援したり、内容が不足していることを警告する情報を示すのに使います。編集者にのみ関係するテンプレートの情報は記事のノートページに使用します。名前空間に依らないテンプレートは主に編集者の利便を提供します。

なお、標準名前空間の記事の一部をテンプレート名前空間においてはいけません。これらは直接記事内に記入してください。

カテゴリや関連項目で充分に補える場合は、他の記事へのリンク集を作成するためにテンプレートを作らないでください。編集者個々の主観にもよりますが、項目の数が数個程度なら関連項目、10個程度になってからカテゴリを作るとよいでしょう。カテゴリは1つあればかなりの項目に対応できるので、カテゴリを使っても見にくくなってきてから、テンプレートを作ることを検討しましょう。

登録利用者が新たなテンプレートの下書きを書くときは利用者サンドボックス（解説）、テンプレートを試すときは特別:テンプレートサンドボックスを使用できます。

モジュールの作成

モジュールは、上述の#テンプレートの作成を認める場合、かつ、以下に挙げる目的・理由のいずれかに当てはまる場合に、作成できます。不必要なモジュールは作成しないでください。テンプレートをモジュール化する場合は議論で合意を得てから行ってください。

テンプレートで行っていた処理を高速化するため
- 同一のページで繰り返し使用されることが想定され、結果的にページの読み込みが高速になる場合も含みます。
内部テンプレートに頼っていた処理を1つにまとめるため（例：Module:Tracklist）
テンプレートでは不可能または複雑すぎる処理をするため（例：Module:String）
無限個の引数に対応するため（例：Module:定義リスト2）
上記4項目のうちいずれかを満たすモジュールを成立させるため（メタモジュール）
特別にモジュールを解説するため（例：Module:HelloWorld）

モジュールに使用するLuaは高速な言語ですが、テンプレートのみの状態でも構造が簡単な場合は、モジュールを経由することで逆に読み込みに時間がかかることもあります。モジュール化の際は、テンプレートとモジュールの利点と欠点を考慮しましょう。

登録利用者が新たなモジュールの下書きを書くときはモジュール:サンドボックス/自分の利用者名/任意のモジュール名を使用してください。

作成済みモジュールサンドボックスの一覧

廃止・削除

まれに、廃止または削除するべきと思うテンプレート・モジュールがあるかも知れません。テンプレート・モジュールを廃止する事は影響が大きいので、慎重に考えるべきです。コメント依頼を提出して広く意見を求めましょう。

テンプレートの場合は、削除以外に廃止の選択肢があります。

削除した場合、呼び出しているページには赤リンクが表示される状態になります。
廃止した場合、呼び出しているページにはテンプレートがそのまま表示されます。

これらは最新版のみならず過去の版においても同様の状態となります。

不要と判断された以上は除去されるべきなので、削除・廃止のどちらを選んでも最新版における表示状態は変わりませんが、かつてテンプレートが使用されていた過去の版における表示の違いがあります。

廃止

廃止を選択する目安は、テンプレートが過去の版において表示される方が望ましい場合です。

廃止は当該テンプレートのノートページでの議論で廃止の合意を得てから行ってください。

廃止されたテンプレートには、それまでの機能を維持したまま{{廃止されたテンプレート}}を貼って下さい。削除や白紙化は過去の版に影響するので行わないでください。

削除

削除を選択する目安は、テンプレートが過去の版にほとんど影響を与えない場合です。例えば、テンプレートが

subst展開でのみ使用される場合や内部テンプレートである場合
使用されている過去の版がWikipedia:削除の方針に合致する場合

などです。2の場合は、その版が削除依頼を経て削除され、その後にテンプレートについて削除を依頼するという手順が望ましいでしょう。なお、法的に問題がある場合は速やかに削除依頼を提出してください。

削除依頼は当該テンプレートのノートページでの議論で削除の合意を得てから、行ってください。削除依頼の理由には、議論による旨を伝え、議論したページのリンクを示しましょう。