Difference between revisions of "Template:Tdeprecated/doc"

← Older edit

Template:Tdeprecated/doc (view source)

Revision as of 15:12, 3 February 2009

2,868 bytes added , 15:12, 3 February 2009

m

1 revision

Budlight

Bots, Bureaucrats, Administrators

529

edits

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
-This is the {{tl|template shortcut}} template.
+This is the {{tl|tdeprecated}} template.
-It can be used to show the names of shortcuts to a 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."
-It can take up to three shortcuts as parameters.
+{{tl|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 ===
-If you want to indicate that {{tl|uw-vandalism1}} has shortcuts named {{tl|uw-v1}}, {{tl|uw-vandal1}}, and {{tl|uw-vand1}}, then you could use one of:
+: <code><nowiki>{{tdeprecated|old template name|new template name}}</nowiki></code>
-{{template shortcut|uw-v1}}
+: <code><nowiki>{{tdeprecated|old template name|new template name|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>
-{{tlc|template shortcut|uw-v1}}
-{{clear}}
-{{template shortcut|uw-v1|uw-vand1}}
+==== Normal usage ====
-{{tlc|template shortcut|uw-v1|uw-vand1}}
-{{clear}}
-{{template shortcut|uw-v1|uw-vand1|uw-vandal1}}
+Normal usage categorises templates to [[:Category:Deprecated templates]].
-{{tlc|template shortcut|uw-v1|uw-vand1|uw-vandal1}}
-{{clear}}
-=== Additional parameters ===
+<pre>
+{{tdeprecated|old|new}}
+{{tdeprecated|old|new|parameter}}
+{{tdeprecated|old|new|&lt;nowiki&gt;parameter|fuu&lt;/nowiki&gt;}}
+</pre>
+{{tdeprecated|old|new|category=}}
+{{tdeprecated|old|new|parameter|category=}}
+{{tdeprecated|old|new|<nowiki>parameter|fuu</nowiki>|category=}}
-This template has some additional parameters.
+==== With a date ====
-"float=left" makes this template flow to the left of the page instead:
+Adding the 'date' parameter subcategorises the template to [[:Category:Templates deprecated since {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]].
-{{template shortcut | float=left | uw-v1 }}
+<div style="{{quote style}} font-family:monospace;"><nowiki>{{tdeprecated|old|new|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></div>
-<code><nowiki>{{template shortcut | float=left | uw-v1 }}</nowiki></code>
+{{tdeprecated|old|new|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|category=}}
-{{clear}}
-"pre=something", "pre2=something" and "pre3=something" feeds some text to show before the shortcut links but within the braces. This is mostly used to indicate that the template should be used with substitution. Then you can do like this:
+=== Technical details ===
-{{template shortcut | pre=subst: | uw-v1 | uw-vand1 }}
+This template changes style depending on what kind of page it is show on. Thus it adheres to the standardised looks for the different pages. For instance if this template becomes visible in an article it looks like this:
-<code><nowiki>{{template shortcut | pre=subst: | uw-v1 | uw-vand1 }}</nowiki></code>
-{{clear}}
-{{template shortcut | uw-v1 | pre2=subst: | uw-vand1 | pre3=subst: | uw-vandal1 }}
+{{tdeprecated|demospace=main|old|new|category=}}
-<code><nowiki>{{template shortcut | uw-v1 | pre2=subst: | uw-vand1 | pre3=subst: | uw-vandal1 }}</nowiki></code>
-{{clear}}
 === See also ===
-* {{tl|shortcut}} – The normal shortcut.
+* {{tl|sdeprecated}} – For deprecated shortcuts.
-* {{tl|shortcut-l}} – For left aligned normal shortcuts.
+* [[:Category:Deprecated templates]] – The category where this template lists templates it is used on.
-* {{tl|policy shortcut}} – For shortcuts to sections of policy pages.
-<includeonly>
-<!-- ADD CATEGORIES BELOW THIS LINE -->
-[[Category:Disambiguation and redirection templates]]
-<!-- ADD INTERWIKIS BELOW THIS LINE -->
+<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
-[[ka:თარგი:თარგის მალხმობა]]
+[[Category:Template namespace templates|{{PAGENAME}}]]
-[[mk:Шаблон:Кратенка за шаблон]]
+[[Category:Redirect templates|{{PAGENAME}}]]
+[[de:Vorlage:Veraltete Vorlage]]
+[[es:Plantilla:Plantilla en desuso]]
+[[hsb:Předłoha:Zestarjena předłoha]]
+[[it:Template:Template obsoleto]]
+[[ka:თარგი:თმოძველდა]]
+[[ja:Template:移行中のテンプレート]]
+[[sq:Stampa:Stampa të vjetruar]]
+[[sl:Predloga:Todsvetovana]]
+[[tr:Şablon:Geçersizş]]
 </includeonly>