Template:Deprecated parameters/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
keep documentation page from being categorized into the deprecate categories
Ganaram inukshuk (talk | contribs)
No edit summary
Line 7: Line 7:
}}
}}


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 23:
}}
}}


One or more new parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>.
One or more replacement parameters can be passed in using the parameter <code><nowiki>newparams</nowiki></code>.
:<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 31:
}}
}}


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 38:
| 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>