Template:Deprecated parameters/doc: Difference between revisions
Jump to navigation
Jump to search
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
{{dochead}} | {{dochead}} | ||
The | 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 === | === Parameters === | ||
By default, the template will appear as such. | By default, the template will appear as such. | ||
<pre>{{Deprecated parameters}}</pre> | |||
{{ {{ROOTPAGENAME}} }} | |||
}} | |||
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. | 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. | ||
<pre>{{Deprecated parameters|Example Template|Scale Info}}</pre> | |||
{{{{ROOTPAGENAME}}|Example Template|Scale Info}} | |||
}} | |||
Multiple deprecated template parameters are passed into the second unnamed parameter. | Multiple deprecated template parameters are passed into the second unnamed parameter. | ||
<pre>{{Deprecated parameters|Example Template|Scale Info, Key Signature}}</pre> | |||
{{ | {{{{ROOTPAGENAME}}|Example Template|Scale Info, Key Signature}} | ||
| | |||
}} | |||
One or more replacement parameters can be passed in using the parameter <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. | ||
<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</pre> | |||
{{ | {{{{ROOTPAGENAME}}|Example Template|Scale Info|newparams=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 <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>. | ||
<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</pre> | |||
{{ | {{{{ROOTPAGENAME}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}} | ||
| | |||
}} | |||
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>. | ||
<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> | |||
{{ | {{{{ROOTPAGENAME}}|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"}} | ||
| | |||
}} | |||
=== Usage === | === Usage === | ||
| Line 55: | Line 31: | ||
== See also == | == See also == | ||
* [[Template:Deprecated]] | * [[Template:Deprecated]] – for pages whose material is no longer valid. | ||
* [[Template:Deprecated template]] | * [[Template:Deprecated template]] – for templates whose use is no longer advised. | ||
* [[:Category:Deprecated parameters]] | * [[:Category:Deprecated parameters]] | ||
* [[:Category:Pages with deprecated parameters]] | * [[:Category:Pages with deprecated parameters]] | ||
Revision as of 22:11, 17 February 2025
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:No template given have been deprecated: No parameters given. 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: Scale Signature, Step Ratio 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