Difference between revisions of "Template:Deprecated template/doc"

From blackwiki
Jump to navigation Jump to search
imported>Davidgothberg
(Updated the doc and clarified that this template itself is not deprecated.)
imported>Davidgothberg
(More brushup of this doc.)
Line 4: Line 4:
 
This is the {{tl|tdeprecated}} template.
 
This is the {{tl|tdeprecated}} template.
  
Note: This template itself is ''not'' deprecated. However using it with only one parameter is deprecated, it now takes 2-3 parameters instead. In the display above it gets no parameters, that's why it says: "This usage is deprecated."
+
'''Note: This template itself is ''not'' deprecated.''' However using it with only one parameter is deprecated, it now takes 2-3 parameters instead. In the display above it gets no parameters, that's why the small text says: "This usage is deprecated."
  
 
{{tl|deprecated template}} redirects here and can be used as an alternative name for this template.
 
{{tl|deprecated template}} redirects here and can be used as an alternative name for this template.
Line 14: Line 14:
 
=== Usage ===
 
=== Usage ===
  
: <code><nowiki>{{tdeprecated|old template name|new template name}}</nowiki></code> (categorises to [[:Category:Deprecated templates|Deprecated templates]]).
+
: <code><nowiki>{{tdeprecated|old template name|new template name}}</nowiki></code>
  
: <code><nowiki>{{tdeprecated|old template name|new template name|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code> (categorises to [[:Category:Templates deprecated since {{CURRENTMONTHNAME}} {{CURRENTYEAR}}|Templates deprecated since {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]).
+
: <code><nowiki>{{tdeprecated|old template name|new template name|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>
  
 
==== Normal usage ====
 
==== Normal usage ====
  
Normal usage categorises templates to [[:Category:Deprecated templates|Deprecated templates]].
+
Normal usage categorises templates to [[:Category:Deprecated templates]].
  
<pre>{{tdeprecated|old|new}}
+
<pre>
 +
{{tdeprecated|old|new}}
 
{{tdeprecated|old|new|parameter}}
 
{{tdeprecated|old|new|parameter}}
{{tdeprecated|old|new|&lt;nowiki&gt;parameter|fuu&lt;/nowiki&gt;}}</pre>
+
{{tdeprecated|old|new|&lt;nowiki&gt;parameter|fuu&lt;/nowiki&gt;}}
 +
</pre>
 
{{tdeprecated|old|new|category=}}
 
{{tdeprecated|old|new|category=}}
 
{{tdeprecated|old|new|parameter|category=}}
 
{{tdeprecated|old|new|parameter|category=}}
Line 31: Line 33:
 
==== With a date ====
 
==== With a date ====
  
Adding the 'date' parameter subcategorises the template to [[:Category:Templates deprecated since {{CURRENTMONTHNAME}} {{CURRENTYEAR}}|Templates deprecated since {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]].
+
Adding the 'date' parameter subcategorises the template to [[:Category:Templates deprecated since {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]].
  
 
<div style="{{quote style}} font-family:monospace;"><nowiki>{{tdeprecated|old|new|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></div>
 
<div style="{{quote style}} font-family:monospace;"><nowiki>{{tdeprecated|old|new|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></div>

Revision as of 17:30, 17 August 2008

This is the {{tdeprecated}} template.

Note: This template itself is not deprecated. However using it with only one parameter is deprecated, it now takes 2-3 parameters instead. In the display above it gets no parameters, that's why the small text says: "This usage is deprecated."

{{deprecated template}} redirects here and can be used as an alternative name for this template.

This template notifies users that a given template has been replaced by a different one. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult).

Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see the message.

Usage

{{tdeprecated|old template name|new template name}}
{{tdeprecated|old template name|new template name|date=December 2025}}

Normal usage

Normal usage categorises templates to Category:Deprecated templates.

{{tdeprecated|old|new}}
{{tdeprecated|old|new|parameter}}
{{tdeprecated|old|new|<nowiki>parameter|fuu</nowiki>}}

Template:Tdeprecated Template:Tdeprecated Template:Tdeprecated

With a date

Adding the 'date' parameter subcategorises the template to Category:Templates deprecated since December 2025.

{{tdeprecated|old|new|date=December 2025}}

Template:Tdeprecated

See also