Xenharmonic Wiki

Template:Deprecated parameters/doc: Difference between revisions

← Older edit
VisualWikitext
ArrowHead294 (talk | contribs)
15,213 edits
mNo edit summary
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
template must be substituted on its own documentation page or else it will flag itself as containing deprecated params!
 
Line 4: Line 4:
=== Parameters ===
=== Parameters ===
By default, the template will appear as such.
By default, the template will appear as such.
<pre>{{Deprecated parameters}}</pre>
:<code><nowiki>{{Deprecated parameters}}</nowiki></code>
{{ {{ROOTPAGENAMEE}} }}
{{Mbox
| 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}}}}}
}}


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>
:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info}}</nowiki></code>
{{{{ROOTPAGENAMEE}}|Example Template|Scale Info}}
{{Mbox
| 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}}}}}
}}


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>
:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info, Key Signature}}</nowiki></code>
{{{{ROOTPAGENAMEE}}|Example Template|Scale Info, Key Signature}}
{{Mbox
| 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}}}}}
}}


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.
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.
<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</pre>
:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}</nowiki></code>
{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio}}
{{Mbox
| 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}}}}}
}}


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>.
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>.
<pre>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</pre>
:<code><nowiki>{{Deprecated parameters|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}</nowiki></code>
{{{{ROOTPAGENAMEE}}|Example Template|Scale Info|newparams=Step Pattern, Step Ratio|newtemplate=Scale Info}}
{{Mbox
| 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}}}}}
}}


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>
:<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>
{{{{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"}}
{{Mbox
| 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: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 ===
=== Usage ===
Retrieved from "https://en.xen.wiki/w/Template:Deprecated_parameters/doc"