Template:Deprecated parameters/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
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..."
 
Ganaram inukshuk (talk | contribs)
keep documentation page from being categorized into the deprecate categories
Line 5: Line 5:
| 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}}}}}
}}{{#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.
Line 13: Line 13:
| 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}}}}}
}}{{#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.
Multiple deprecated template parameters are passed into the second unnamed parameter.
Line 21: Line 21:
| 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}}}}}
}}{{#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 new parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>.
Line 29: Line 29:
| 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}}}}}
}}{{#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 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>.
Line 37: Line 37:
| 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}}}}}
}}{{#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>.
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 44:
| 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"}}
}}{{#ifeq:Template:{{ucfirst:Example Template}}|{{FULLPAGENAME}}|[[Category:Deprecated parameters]]|[[Category:Pages with deprecated parameters]]}}
}}

Revision as of 23:02, 11 November 2024

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.

{{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 new parameters can be passed in using the parameter newparams.

{{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 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"