Template:Deprecated parameters/doc: Difference between revisions
Created page with "By default, the template will appear as such. :<code><nowiki>{{Deprecated parameters}}</nowiki></code> {{subst:Deprecated parameters}} A template name and template parameter..." |
template must be substituted on its own documentation page or else it will flag itself as containing deprecated params! |
||
| (10 intermediate revisions by 3 users not shown) | |||
| 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. | By default, the template will appear as such. | ||
:<code><nowiki>{{Deprecated parameters}}</nowiki></code> | :<code><nowiki>{{Deprecated parameters}}</nowiki></code> | ||
| Line 5: | Line 9: | ||
| type = delete | | 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}}}}} | | 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}}}}} | ||
}} | |||
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> | :<code><nowiki>{{Deprecated parameters|Example Template|Scale Info}}</nowiki></code> | ||
{{Mbox | {{Mbox | ||
| Line 13: | Line 17: | ||
| type = delete | | 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}}}}} | | 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}}}}} | ||
}} | |||
Multiple deprecated template parameters are passed into the second unnamed parameter. | Multiple deprecated template parameters are passed into the second unnamed parameter. | ||
| Line 21: | Line 25: | ||
| type = delete | | 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}}}}} | | 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}}}}} | ||
}} | |||
One or more | 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> | :<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</nowiki></code> | ||
{{Mbox | {{Mbox | ||
| Line 29: | Line 33: | ||
| type = delete | | 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}}}}} | | 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}}}}} | ||
}} | |||
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><nowiki>newtemplate</nowiki></code>. | ||
:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</nowiki></code> | :<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</nowiki></code> | ||
{{Mbox | {{Mbox | ||
| Line 37: | Line 41: | ||
| type = delete | | 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}}}}} | | 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}}}}} | ||
}} | |||
Further details can be given using the parameter <code><nowiki>details</nowiki></code>. | Further details can be given using the parameter <code><nowiki>details</nowiki></code>. | ||
| Line 45: | Line 49: | ||
| type = delete | | 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: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"}} | | 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]] | |||