Template:Deprecated parameters/doc: Difference between revisions

(8 intermediate revisions by 3 users not shown)

Line 1:

The '''Deprecated parameters''' template notifies users that a template's parameters has been replaced by a different one or ones within the same template, or as part of a new template, or simply deprecated (advised to no longer be used) without a replacement.

=== Parameters ===

By default, the template will appear as such.

:<code><nowiki>{{Deprecated parameters}}</nowiki></code>

Line 23:

Line 27:

}}

One or more replacement parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>.

One or more replacement parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>. This assumes the new parameters are part of the same template.

:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</nowiki></code>

{{Mbox

Line 46:

Line 50:

| text = The following parameters of '''Template:Example Template''' have been deprecated: Scale Info.<br>{{#if:Step Pattern, Step Ratio|{{#if:Scale Info|Please use the following parameters in [[Template:Scale Info]] instead: Step Pattern, Step Ratio|Please use the following parameters instead: Step Pattern, Step Ratio}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:Note to editors: please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"|<br>Note to editors: please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}

}}

=== Usage ===

This template can be added as a standalone template to a page or a template's page.

== See also ==

* [[Template:Deprecated]] – for pages whose material is no longer valid.

* [[Template:Deprecated template]] – for templates whose use is no longer advised.

* [[:Category:Deprecated parameters]]

* [[:Category:Pages with deprecated parameters]]

@@ Line 1: / Line 1: @@
+{{dochead}}{{substitute|no}}
+The '''Deprecated parameters''' template notifies users that a template's parameters has been replaced by a different one or ones within the same template, or as part of a new template, or simply deprecated (advised to no longer be used) without a replacement.
+=== Parameters ===
 By default, the template will appear as such.
 :<code><nowiki>{{Deprecated parameters}}</nowiki></code>
@@ Line 23: / Line 27: @@
 }}
-One or more replacement parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>.
+One or more replacement parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>. This assumes the new parameters are part of the same template.
 :<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</nowiki></code>
 {{Mbox
@@ Line 46: / Line 50: @@
 | text = The following parameters of '''Template:Example Template''' have been deprecated: Scale Info.<br>{{#if:Step Pattern, Step Ratio|{{#if:Scale Info|Please use the following parameters in [[Template:Scale Info]] instead: Step Pattern, Step Ratio|Please use the following parameters instead: Step Pattern, Step Ratio}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:Note to editors: please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"|<br>Note to editors: please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}
 }}
+=== Usage ===
+This template can be added as a standalone template to a page or a template's page.
+== See also ==
+* [[Template:Deprecated]] – for pages whose material is no longer valid.
+* [[Template:Deprecated template]] – for templates whose use is no longer advised.
+* [[:Category:Deprecated parameters]]
+* [[:Category:Pages with deprecated parameters]]