Template:Deprecated parameters/doc: Difference between revisions

(9 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~~>

<pre>{{Deprecated parameters}}</pre>

{{~~Mbox~~

{{ {{ROOTPAGENAMEE}} }}

~~| icon = Icon-Deprecated.png~~

~~| type = delete~~

~~| text = The following parameters of '''Template:NoTemplateGiven''' have been deprecated: NoParamsGiven. {{#if:|{{#if:|Please use the following parameters in [[Template:~~{{~~{newtemplate}}}]] instead: {{{newparams}}}|Please use the following parameters instead: {{{newparams}~~}}~~}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:| {{{details}}}}}~~

~~}}{{#ifeq:Template:{{ucfirst:}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]~~}}

A template name and template parameter are passed in as unnamed parameters.

A template name and template parameter are passed in as unnamed parameters. This assumes that the parameters in question are deprecated and have no replacement parameters.

:<~~code><nowiki~~>{{Deprecated parameters|Example Template|Scale Info}}</~~nowiki></code~~>

<pre>{{Deprecated parameters|Example Template|Scale Info}}</pre>

{{~~Mbox~~

{{{{ROOTPAGENAMEE}}|Example Template|Scale Info}}

~~| icon = Icon-Deprecated.png~~

~~| type = delete~~

~~| text = The following parameters of '''Template:Example Template''' have been deprecated: Scale Info. {{#if:|~~{{~~#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] instead: {{{newparams}~~}}|~~Please use the following parameters instead: {{{newparams}}}}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:| {{{details}}}}}~~

~~}}{{#ifeq:Template:{{ucfirst:~~Example Template}}|~~{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]~~}}

Multiple deprecated template parameters are passed into the second unnamed parameter.

:<~~code><nowiki~~>{{Deprecated parameters|Example Template|Scale Info, Key Signature}}</~~nowiki></code~~>

<pre>{{Deprecated parameters|Example Template|Scale Info, Key Signature}}</pre>

{{~~Mbox~~

{{{{ROOTPAGENAMEE}}|Example Template|Scale Info, Key Signature}}

| ~~icon = Icon-Deprecated.png~~

~~| type = delete~~

~~| text = The following parameters of '''Template:~~Example Template~~''' have been deprecated:~~ Scale Info, Key Signature. {{#if:|{{#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] instead: {{{newparams}}}|Please use the following parameters instead: {{{newparams}}}}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:| {{{details}}}}}

~~}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]~~}}

One or more ~~new~~ 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>newparams</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~~>

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

{{~~Mbox~~

{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}

| ~~icon = Icon-Deprecated.png~~

~~| type = delete~~

~~| text = The following parameters of '''Template:~~Example Template~~''' have been deprecated:~~ Scale Info~~. {{#if:Step Pattern, Step Ratio~~|~~{{#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] 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:| {{{details}}}}}~~

~~}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]~~}}

If the parameter in question is part of a new template, such as when the functionality of a template is being split into a new template, it can be included using the parameter <code~~><nowiki~~>newtemplate~~</nowiki>~~</code>.

If the new parameter in question is part of a new template, such as when the functionality of a template is being split into a new template, it can be included using the parameter <code>newtemplate</code>.

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

<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</pre>

{{~~Mbox~~

{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}

| ~~icon = Icon-Deprecated.png~~

~~| type = delete~~

~~| text = The following parameters of '''Template:~~Example Template~~''' have been deprecated:~~ Scale Info~~. {{#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:| {{{details}}}}}

~~}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]~~}}

Further details can be given using the parameter <code><nowiki>details</nowiki></code>.

~~:<code>~~<~~nowiki~~>{{Deprecated parameters|Example Template|Scale Info|newparams=Scale Signature, Step Ratio|newtemplate=Scale Info|details=Editors, please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}</~~nowiki></code~~>

<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Scale Signature, Step Ratio|newtemplate=Scale Info|details=Editors, please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}</pre>

{{~~Mbox~~

{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Scale Signature, Step Ratio|newtemplate=Scale Info|details=Editors, please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}

~~| icon = Icon-Deprecated.png~~

~~| type = delete~~

=== Usage ===

| ~~text = The following parameters of '''Template:~~Example Template~~''' have been deprecated: Scale Info. {{#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"| Note to editors:~~ please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}

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

~~}}{{#ifeq~~:Template:~~{{ucfirst:Example Template}}|{{FULLPAGENAME}}|~~[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}

== 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>
+<pre>{{Deprecated parameters}}</pre>
-{{Mbox
+{{ {{ROOTPAGENAMEE}} }}
-| icon = Icon-Deprecated.png
-| type = delete
-| text = The following parameters of '''Template:NoTemplateGiven''' have been deprecated: NoParamsGiven.<br>{{#if:|{{#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] instead: {{{newparams}}}|Please use the following parameters instead: {{{newparams}}}}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:|<br>{{{details}}}}}
-}}{{#ifeq:Template:{{ucfirst:}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
-A template name and template parameter are passed in as unnamed parameters.
+A template name and template parameter are passed in as unnamed parameters. This assumes that the parameters in question are deprecated and have no replacement parameters.
-:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info}}</nowiki></code>
+<pre>{{Deprecated parameters|Example Template|Scale Info}}</pre>
-{{Mbox
+{{{{ROOTPAGENAMEE}}|Example Template|Scale Info}}
-| icon = Icon-Deprecated.png
-| type = delete
-| text = The following parameters of '''Template:Example Template''' have been deprecated: Scale Info.<br>{{#if:|{{#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] instead: {{{newparams}}}|Please use the following parameters instead: {{{newparams}}}}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:|<br>{{{details}}}}}
-}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
 Multiple deprecated template parameters are passed into the second unnamed parameter.
-:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info, Key Signature}}</nowiki></code>
+<pre>{{Deprecated parameters|Example Template|Scale Info, Key Signature}}</pre>
-{{Mbox
+{{{{ROOTPAGENAMEE}}|Example Template|Scale Info, Key Signature}}
-| icon = Icon-Deprecated.png
-| type = delete
-| text = The following parameters of '''Template:Example Template''' have been deprecated: Scale Info, Key Signature.<br>{{#if:|{{#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] instead: {{{newparams}}}|Please use the following parameters instead: {{{newparams}}}}}|It is advised to save or relocate any information passed into these parameters to avoid information loss.}}{{#if:|<br>{{{details}}}}}
-}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
-One or more new 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>newparams</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>
+<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</pre>
-{{Mbox
+{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}
-| icon = Icon-Deprecated.png
-| type = delete
-| text = The following parameters of '''Template:Example Template''' have been deprecated: Scale Info.<br>{{#if:Step Pattern, Step Ratio|{{#if:|Please use the following parameters in [[Template:{{{newtemplate}}}]] 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:|<br>{{{details}}}}}
-}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
-If the parameter in question is part of a new template, such as when the functionality of a template is being split into a new template, it can be included using the parameter <code><nowiki>newtemplate</nowiki></code>.
+If the new parameter in question is part of a new template, such as when the functionality of a template is being split into a new template, it can be included using the parameter <code>newtemplate</code>.
-:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</nowiki></code>
+<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</pre>
-{{Mbox
+{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}
-| icon = Icon-Deprecated.png
-| type = delete
-| 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:|<br>{{{details}}}}}
-}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
 Further details can be given using the parameter <code><nowiki>details</nowiki></code>.
-:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Scale Signature, Step Ratio|newtemplate=Scale Info|details=Editors, please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}</nowiki></code>
+<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Scale Signature, Step Ratio|newtemplate=Scale Info|details=Editors, please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}</pre>
-{{Mbox
+{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Scale Signature, Step Ratio|newtemplate=Scale Info|details=Editors, please remember to separate the step pattern from the step ratio; for example, "3331331" becomes "LLLsLLs" and "3:1"}}
-| icon = Icon-Deprecated.png
-| type = delete
+=== Usage ===
-| 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"}}
+This template can be added as a standalone template to a page or a template's page.
-}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
+== 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]]