Template:Step/doc: Difference between revisions
Template page
More actions
mNo edit summary |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
The {{tlg|step}} formats an ordered list for the walkthrough. | The template {{tlg|step}} formats an ordered list for the walkthrough. | ||
== Usage == | == Usage == | ||
| Line 47: | Line 47: | ||
If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page. | If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page. | ||
If the value of the {{para|content}} parameter contains an equals sign “=”, you {{strong|must}} use a named parameter (e.g. {{para| | If the value of the {{para|step content}} parameter contains an equals sign “=”, you {{strong|must}} use a named parameter (e.g. {{para|step content|2=“E=MC<sup>2</sup>”}}, not a blank‐name positional parameter. The text before the equals sign gets misinterpreted as a named parameter otherwise. Be wary of URLs, which frequently contain this character. Named parameters are always safer, in this and other templates. | ||
[[Category:Templates]][[Category:Templates documentation]] | [[Category:Templates]][[Category:Templates documentation]] | ||
Latest revision as of 17:35, 23 July 2020
The template {{step}} formats an ordered list for the walkthrough.
Usage
{{step|step number=number of the step|step content=content of the numbered step}}
Parameters
|step number=or|1=- The number of the step.
|step content=or|2=- The content labbeled by the step.
Examples
| Markup | Renders as |
|---|---|
{{steplist|
{{step|step number=1|step content=Content 1}}
{{step|step number=2|step content=Content 2}}
{{step|step number=3|step content=Content 3}}
}}
|
|
{{steplist|
{{step|1|Content 3}}
{{step|2|Content 4}}
{{step|3|Content 5}}
}}
|
|
Limitations
If you do not provide text, the template generates a parser error message, which will appear in red text in the rendered page.
If the value of the |step content= parameter contains an equals sign “=”, you must use a named parameter (e.g. |step content=“E=MC2”, not a blank‐name positional parameter. The text before the equals sign gets misinterpreted as a named parameter otherwise. Be wary of URLs, which frequently contain this character. Named parameters are always safer, in this and other templates.