View source for Template:Loop/doc

{{high-use}}
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{lua|Module:String}}
This template is used to produce a simple loop. It is based on [[Module:String]], and there is no limit to the number of iterations it can perform.

== Usage ==

<syntaxhighlight lang="wikitext">{{loop|times to repeat|string}}</syntaxhighlight>

If '''string''' contains an equals sign, you must put "|2=string" instead of "|string".

== Examples ==
{|class="wikitable"
! Code
! Output
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|4|n}}</syntaxhighlight>
| {{loop|4|n}}
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|25|test me}}</syntaxhighlight>
| {{loop|25|test me}}
|-
| <syntaxhighlight lang="wikitext" inline>{{#expr:2{{loop|50|*2}}}}</syntaxhighlight>
| {{#expr:2{{loop|50|*2}}}}
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|3|{{CURRENTYEAR}}}}</syntaxhighlight>
| {{loop|3|{{CURRENTYEAR}}}}
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|{{#expr:7*2}}|&nbsp; '''MUDA}}!</syntaxhighlight>
| {{loop|{{#expr:7*2}}|&nbsp; '''MUDA}}!
|}

When the string being replicated includes "=", we have to precede the second parameter with "<syntaxhighlight lang="wikitext" inline>2=</syntaxhighlight>", or use {{tl|1==}}.
{|class="wikitable"
! Code
! Output
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|9|2==}}</syntaxhighlight>
| {{loop|9|2==}}
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|9|{{=}}}}</syntaxhighlight>
| {{loop|9|{{=}}}}
|}

Surrounding whitespace is always stripped; you must use {{ml|string|rep|section=#rep}} instead to preserve it.

{|class="wikitable"
! Code
! Output
|-
| <syntaxhighlight lang="wikitext" inline>{{#invoke:String|rep| hello |3}}</syntaxhighlight>
| {{#invoke:String|rep| hello |3}}
|-
| <syntaxhighlight lang="wikitext" inline>{{loop|3| hello }}</syntaxhighlight>
| {{loop|3| hello }}
|}

==Template data==
{{TemplateDataHeader}}
<templatedata>
{
        "description": "The template is used to produce a simple loop of repeated strings.",
        "params": {
                "1": {
                        "label": "Number",
                        "description": "Number of times to repeat",
                        "type": "number",
                        "required": true
                },
                "2": {
                        "label": "String",
                        "description": "The string to be repeated. Use {{=}} if the string contains an equals sign.",
                        "type": "string",
                        "required": true
                }
        }
}
</templatedata>

==See also==
*{{lt|For loop}}
*{{lt|Simple recursion}}

<includeonly>{{Sandbox other||
[[Category:Repetition templates]]
}}</includeonly>