Template:Deprecated template/doc
 | 此頁面是Template:Deprecated template的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格式，如2025-12-13。historical：是否是由于历史原因保留。nocat：是否關閉分類。
| 代码 | 显示效果 | ||
|---|---|---|---|
| {{Deprecated template}} |
| ||
| {{Deprecated template|date=2025-12-13}} |
| ||
| {{Deprecated template|Deprecated template |date=2025-12-13}} |
| ||
| {{Deprecated template|Deprecated template |new=Template:Update after|date=2025-12-13}} |
| ||
| {{Deprecated template|Deprecated template |new=Template:Update after |note=你也可以用其他模板。|date=2025-12-13}} |
|
模板資料
[编辑]提示使用者某個模板已被其他模板取代，當模板只是單純被棄用且無新模板作為替代時，也可以使用此模板。
| 参数 | 描述 | 类型 | 状态 | |
|---|---|---|---|---|
| 已棄用模板名稱 | old 1 | 要被取代的模板名稱。
| 单行文本 | 推荐 |
| 替代模板 | new 2 | 取代該已棄用模板的模板頁名稱。一般無需加上命名空間前綴，但如有需要也可加入，甚至可指向其他命名空間。若要連結至包含多個模板的分類，請使用以冒號開頭的語法，如「:Category:此處填寫分類名稱」。 | 单行文本 | 推荐 |
| 參數 | 3 | 顯示新模板的參數，必須使用 <nowiki></nowiki> 標籤包住。
| 内容 | 推荐 |
| 附註 | note reason result | 說明該模板被棄用的原因、如何替換為新模板說明，或任何其他有用資訊。 | 内容 | 推荐 |
| 棄用者／原因來源 | by | 指出由誰或由甚麼原因使該模板被棄用。 | 单行文本 | 可选 |
| 是否因歷史原因而保留？ | historical | 如填入任何值，會顯示「並僅因歷史原因而保留」。
| 布尔 | 可选 |
| 關閉分類功能 | nocat | 設定為true以避免自動加入分類。當模板的展示僅供範例用途，例如在模板自身的說明頁中使用時，可以加入此參數。啟用此參數後，該頁面本身不會被加入「Category:已停用模板」，而且嵌入該頁面的其他頁面亦不會被加入至 「Category:使用已停用模板的頁面」分類中。
| 布尔 | 可选 |
參見
[编辑]