Template:Deprecated parameters/doc: Difference between revisions
Jump to navigation
Jump to search
keep documentation page from being categorized into the deprecate categories |
template must be substituted on its own documentation page or else it will flag itself as containing deprecated params! |
||
| (9 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 7: | Line 11: | ||
}} | }} | ||
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 23: | Line 27: | ||
}} | }} | ||
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 31: | Line 35: | ||
}} | }} | ||
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 38: | Line 42: | ||
| 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>. | ||
:<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> | :<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> | ||
| Line 45: | 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"}} | | 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]] | |||
Latest revision as of 05:18, 7 October 2025
|
This template should not be substituted. |
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.
{{Deprecated parameters}}
|
The following parameters of Template:NoTemplateGiven have been deprecated: NoParamsGiven. It is advised to save or relocate any information passed into these parameters to avoid information loss. |
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.
{{Deprecated parameters|Example Template|Scale Info}}
|
|
The following parameters of Template:Example Template have been deprecated: Scale Info. It is advised to save or relocate any information passed into these parameters to avoid information loss. |
Multiple deprecated template parameters are passed into the second unnamed parameter.
{{Deprecated parameters|Example Template|Scale Info, Key Signature}}
|
|
The following parameters of Template:Example Template have been deprecated: Scale Info, Key Signature. It is advised to save or relocate any information passed into these parameters to avoid information loss. |
One or more replacement parameters can be passed in using the parameter newparams. This assumes the new parameters are part of the same template.
{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}
|
|
The following parameters of Template:Example Template have been deprecated: Scale Info. Please use the following parameters instead: Step Pattern, Step Ratio |
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 newtemplate.
{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}
|
|
The following parameters of Template:Example Template have been deprecated: Scale Info. Please use the following parameters in Template:Scale Info instead: Step Pattern, Step Ratio |
Further details can be given using the parameter details.
{{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"}}
|
|
The following parameters of Template:Example Template have been deprecated: Scale Info. Please use the following parameters in Template:Scale Info instead: Step Pattern, Step Ratio 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