模板:Deprecated template/doc
 | 此页面是Template:Deprecated template的模板文档。 此页面可能包含了模板的使用说明、分类和其他内容。 |
{{Deprecated template}}模板用于在其他模板的程式码中（而非其 /doc子页面）标示该模板已被取代或不建议再使用。当该模板被嵌入或检视时，会显示提示，通知使用者该模板已被其他模板取代，当模板只是单纯被弃用且无新模板作为替代时，也可以使用此模板。 这个模板在以下情况最有帮助：
- 若由于用途差异而无法将旧模板直接重新导向至新模板；
- 或希望减少重新导向数量以方便机器人处理。
如该模板已“完全弃用”，可在其他页面嵌入时，让{{Deprecated template}}的提示讯息完全取代其内容，方法是在模板内容全部替换为<includeonly>{{Deprecated template}</includeonly>。这样使用者在套用该模板时，只会见到提示讯息，而不会实际执行该已弃用的模板。
{{Historical template}} 则是另一个相关模板，适用于社群已达成共识认为该模板应停止使用，但若移除会导致历史专案页面出现严重错误的情况。
{{Deleted template}} 则提供一种方式，可在删除模板的同时保留其旧版本供历史页面显示正确内容之用。
用法
[编辑]尚未完全弃用的模板
[编辑]若某个模板仍被使用中（即仍有页面在嵌入它），因此尚未准备好完全弃用，可在该模板源代码中的{{Deprecated template}}外加上 <noinclude>...</noinclude>标签。
这样可确保弃用提示只会显示在模板的说明页面，而不会出现在所有使用该模板的页面上。
若模板尚未完全弃用，可在其程式码中加入以下内容：
<noinclude>
{{Deprecated template}}<!-- 當模板完全棄用後，請改為 {{Deprecated template|舊模板名稱|新模板名稱}}並移除 <noinclude> 標籤。詳情請參見 [[Template:Deprecated template]]。-->
</noinclude>
已完全弃用的模板
[编辑]当某个模板已经完全弃用，并且不再被任何页面嵌入时，可以移除该模板程式码中包围{{Deprecated template}}的<noinclude>...</noinclude>标签。
这样做后，任何仍在使用该已弃用模板的页面都会自动显示弃用提示。
之后，可考虑透过WP:AFD提名删除该模板，或以{{Historical template}}取代，以标示该模板已属历史用途。
{{Deprecated template|已棄用模板名稱|新模板名稱}}
若未提供第二个（即替代模板名称）参数，则仅会显示一般的弃用提示，如下所示：
 | Template:Deprecated template/doc已停用。 |
参数
[编辑]标准用法
[编辑]{{Deprecated template|已棄用模板名稱|新模板名稱}}
| Template:已弃用模板名称已停用。请使用Template:新模板名称代替。 |
额外说明
[编辑]模板可透过下述方式显示新模板应使用的参数：
{{Deprecated template|已棄用模板名稱|新模板名稱|parameter}}
| Template:已弃用模板名称已停用。请使用{{新模板名稱|parameter}}代替。 |
{{Deprecated template|已棄用模板名稱|新模板名稱|<nowiki>parameter=foo</nowiki>}}
| Template:已弃用模板名称已停用。请使用{{新模板名稱|parameter=foo}}代替。 |
此模板亦可显示附注说明，例如：
{{Deprecated template|舊模板名稱|新模板名稱|note=此處可加入更多詳情，例如為何保留該模板、替換過程的具體情況，或在有兩個以上新模板時的詳細說明。}}
| Template:Old已停用。请使用Template:New代替。此处可加入更多详情，例如为何保留该模板、替换过程的具体情况，或在有两个以上新模板时的详细说明。 |
参数|note=亦可改用|reason=或|result=。
用于模板命名空间以外页面的特殊参数
[编辑]参数|old=和|new=可搭配完整名称（包含命名空间）使用，例如：
{{Deprecated template|old=Template:已棄用模板名稱|new=Wikipedia:新模板說明}}
| Template:已弃用模板名称已停用。请参见Wikipedia:新模板说明。 |
若要连结至一个包含多个模板的分类页，请使用加上冒号的语法：
:Category:此處填寫分類名稱（冒号“:”必须置于最前方）。
另外，|new= 参数不能与第三个未命名参数（即用来示范第三个模板的参数）同时使用。
例如，下列语法是无效的：
{{Deprecated template|已棄用模板名稱|new=User:Example/MyTemplate|<nowiki>chickens=yes</nowiki>}}
理论上此模板可以加入这项功能，但截至目前并没有需要这样用法的情况。
关闭分类功能
[编辑]可在模板后加入 |nocat=true 以避免自动加入分类。当模板的展示仅供范例用途，例如在模板自身的说明页中使用时，可以加入此参数。启用此参数后，该页面本身不会被加入Category:已停用模板，而且嵌入该页面的其他页面亦不会被加入至 Category:使用已停用模板的页面分类中。
请不要以此参数来抗议模板被弃用。若对模板的弃用状态或说明内容有异议，请前往该模板的讨论页，或相关社群讨论页面（例如Wikipedia:互助客栈/技术）提出。
完整参数
[编辑]{{Deprecated template|旧模板名称|新模板名称|date=被废弃的时间}}
所有参数都是可选的。
new：未过时的模板。date：被废弃的时间，必须是ISO格式，如2026-03-25。historical：是否是由于历史原因保留。nocat：是否关闭分类。
| 代码 | 显示效果 | ||
|---|---|---|---|
| {{Deprecated template}} |
| ||
| {{Deprecated template|date=2026-03-25}} |
| ||
| {{Deprecated template|Deprecated template |date=2026-03-25}} |
| ||
| {{Deprecated template|Deprecated template |new=Template:Update after|date=2026-03-25}} |
| ||
| {{Deprecated template|Deprecated template |new=Template:Update after |note=你也可以用其他模板。|date=2026-03-25}} |
|
模板资料
[编辑]提示使用者某个模板已被其他模板取代，当模板只是单纯被弃用且无新模板作为替代时，也可以使用此模板。
| 参数 | 描述 | 类型 | 状态 | |
|---|---|---|---|---|
| 已弃用模板名称 | old 1 | 要被取代的模板名称。
| 单行文本 | 推荐 |
| 替代模板 | new 2 | 取代该已弃用模板的模板页名称。一般无需加上命名空间前缀，但如有需要也可加入，甚至可指向其他命名空间。若要连结至包含多个模板的分类，请使用以冒号开头的语法，如“:Category:此处填写分类名称”。 | 单行文本 | 推荐 |
| 参数 | 3 | 显示新模板的参数，必须使用 <nowiki></nowiki> 标签包住。
| 内容 | 推荐 |
| 附注 | note reason result | 说明该模板被弃用的原因、如何替换为新模板说明，或任何其他有用资讯。 | 内容 | 推荐 |
| 弃用者／原因来源 | by | 指出由谁或由什么原因使该模板被弃用。 | 单行文本 | 可选 |
| 是否因历史原因而保留？ | historical | 如填入任何值，会显示“并仅因历史原因而保留”。
| 布尔 | 可选 |
| 关闭分类功能 | nocat | 设定为true以避免自动加入分类。当模板的展示仅供范例用途，例如在模板自身的说明页中使用时，可以加入此参数。启用此参数后，该页面本身不会被加入“Category:已停用模板”，而且嵌入该页面的其他页面亦不会被加入至 “Category:使用已停用模板的页面”分类中。
| 布尔 | 可选 |
参见
[编辑]