Template:廃止されたテンプレート/sandbox/doc
 | これはTemplate:廃止されたテンプレート/sandboxの解説サブページです。 使用方法、カテゴリ、およびその他テンプレートページ自体に含まれない情報を収容しています。 |
 | Luaモジュールを使用しています: |
（サンドボックス）
廃止が決まったテンプレートに貼り付けるお知らせメッセージテンプレートです。このテンプレートを貼りつけると、貼り付けたテンプレートが使用されているページがCategory:廃止されたテンプレートを使用中のページにカテゴライズされ、さらに編集時にページ冒頭にて「警告：テンプレート {{テンプレート1}} は廃止されました。代わりに {{テンプレート2}} を使用してください。」などのメッセージが表示されるため、誤用の確認が容易になります。
テンプレートの廃止については、Wikipedia:テンプレート・モジュール作成の目安#廃止・削除をご覧下さい。
注意事項
[編集]- 廃止されたテンプレートは削除依頼に出さないでください。
- 廃止されたテンプレートの内容を白紙化しないでください。
テンプレートを「廃止」する意義はWikipedia:テンプレート・モジュール作成の目安#廃止・削除に説明してあるように、過去の版で表示されていた方が有効であるためです。削除や白紙化を行うと過去の版で表示されなくなるため、「廃止」の意味がなくなります。
使い方
[編集]このテンプレートを使用する際は<noinclude>…</noinclude> で括らないでください。
移行先がない場合
[編集]入力例
{{廃止されたテンプレート/sandbox |廃止するテンプレート名（指定必須） |議論ページ=廃止議論のあったノートページ（指定推奨） |doing=yes（省略可）}}
表示例（「Template:廃止されたテンプレート」「Template:廃止されたテンプレート/doc」は現在使用中であり、廃止予定はありません）
出力例1 - doing引数を省略した場合。
出力例2 - 「doing = yes」を指定した場合。
補足
- 廃止するテンプレート名の指定は必須です。省略した場合にはエラーメッセージが表示されます。
移行先がある場合
[編集]入力例
{{廃止されたテンプレート/sandbox |廃止するテンプレート名（指定必須） |移行先のテンプレート名 |arg=移行先のテンプレートの引数（省略可） |議論ページ=廃止議論のあったノートページ（指定推奨） |doing=yes（省略可）}}
出力例
出力例3 - arg引数とdoing引数に値を指定しない場合。
 | 「Template:廃止されたテンプレート/sandbox/doc」このテンプレート {{廃止されたテンプレート/sandbox/doc}} は、Template‐ノート:テンプレート1での議論を受けて廃止されました。代わりに {{テンプレート2}} を使用してください。（このテンプレートのリンク元・呼び出し元・/doc） |
出力例4 - 「arg = 引数1{{!}}〜」を指定した場合。
| 「Template:廃止されたテンプレート/doc」このテンプレート {{廃止されたテンプレート/doc}} は、Template‐ノート:テンプレート1での議論を受けて廃止されました。代わりに {{テンプレート2|引数1{{!}}〜}} を使用してください。（このテンプレートのリンク元・呼び出し元・/doc） |
出力例5 - 「doing = yes」を指定した場合。
 | 「Template:廃止されたテンプレート」このテンプレート {{廃止されたテンプレート}} は、Template‐ノート:テンプレート1での議論を受けて将来的に廃止される予定です。現在、 {{テンプレート2}} への移行作業が行われています。（このテンプレートのリンク元・呼び出し元・/doc） |
引数
[編集]引数の省略については「使い方」の節を参考にしてください。
| 引数名 | 省略時の値 | 説明 | 省略の可否 |
|---|---|---|---|
| 1 | 廃止対象のテンプレート名を指定します（名前空間プレフィックスは含まない）。{{NAMESPACE}}のようなマジックワードは使わないでください。 |
指定必須 | |
| 2 | 移行先のテンプレート名を指定します（名前空間プレフィックスは含まない）。 | 省略可 | |
| arg | 移行先のテンプレートの引数を指定します。引数が複数ある場合は、マジックワードの{{!}}で区切ってください。 |
省略可 | |
| 議論ページ | 廃止議論があったページを指定します。 | 指定推奨 | |
|
no | 対象のテンプレートが廃止予定である場合もしくは移行作業が行われている場合に、yes・y・true・t・1のいずれかを指定してください。 | 省略可 |
|
no | yes・y・true・t・1のいずれかを指定すると、廃止されたテンプレートを使用中のページに対する警告文表示とカテゴリ付与の機能が無効化されます。ノートページで使用されていたテンプレートや、テンプレートの内部でのみ使用されていたテンプレートに対して使用することを想定しています。 | 省略可 |
|
no | yes・y・true・t・1のいずれかを指定すると、廃止された／廃止予定のテンプレート自身にカテゴリを付与しなくなります。このテンプレートをデモ表示させる場合に使用することを想定しています。 | 省略可 |
カテゴリ
[編集]本テンプレートを呼び出したテンプレートは、doing引数にyesなどの値が指定されていればCategory:移行中のテンプレートに、そうでない場合にはCategory:廃止されたテンプレートに（第2引数を使用している場合はCategory:移行先のあるテンプレートにも）収集されます。
本テンプレートにより廃止されたことが明示されている（doing引数もしくはquiet引数にyesなどの値が指定されている場合は含まない）テンプレートを呼び出しているページは、Category:廃止されたテンプレートを使用中のページに収集されます。