Template:For nowiki/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Expanded document to include the module
m (typo?) |
BrandonXLF (talk | contribs) (Expanded document to include the module) |
||
Line 1:
{{Documentation subpage}}
{{#ifeq:{{NAMESPACENUMBER}}|10|{{lua|Module:For nowiki}}|}}
This is the documentation for [[Template:For nowiki]] and [[Module:For nowiki]]. This module or template implements a [[foreach loop]]. It interprets a given wikitext (unlike {{tl|For loop}}, which calls a specified template) once for each item in the list.
== Usage ==
{{tlp|For nowiki|''separator''|{{tag|nowiki|content=''wikitext''}}|''item1''|''item2''|...}}
{{tlp|For nowiki|''separator''|{{tag|nowiki|content=''wikitext''}}|count{{=}}''count''}}
{{((}}#invoke:For nowiki|template|''separator''|{{tag|nowiki|content=''wikitext''}}|''force one loop''}}
;General parameters
* <code>''separator''</code> is inserted ''between'' the results of <code>''wikitext''</code> interpretation. Whitespace is preserved.
* <code>''wikitext''</code> is interpreted once for each item in the list. It then may use {{code|<nowiki>{{{1}}}</nowiki>}} to get the item value, and {{code|<nowiki>{{{i}}}</nowiki>}} to get its position in the list (starting from 1), as well as any parameters that were passed to {{tl|for nowiki}}. It may also contain template calls. To use a parameter passed to the calling template, surround it with {{nowrap|<code></nowiki>...<no<!---->wiki></code>}} (the opening and closing tags are swapped) or pass the parameter directly to {{tl|for nowiki}} if its name doesn't conflict with any reserved parameters.
;Use 1 specific
The second form of this template using a {{para|count}} parameter interprets the given wikitext count times, passing each integer between 1 and that count as both {{para|1}} and {{para|i}} each time.▼
* <code>''item1''</code>, <code>''item2''</code>, <code>''...''</code> are the items to iterate through, with {{code|<nowiki>{{{1}}}</nowiki>}} being replaced with the value and {{code|<nowiki>{{{i}}}</nowiki>}} with the name of the parameter/index.
;Use 2 specific
▲
;Use 3 specific
* <code>''force one loop''</code> forces the module to perform at least one loop, this is useful when you provide a default value for {{code|<nowiki>{{{1}}}</nowiki>}}.
* When using the module, numbered/unnamed parameters sent to the template (the page the module is used on) will be iterated through, with {{code|<nowiki>{{{1}}}</nowiki>}} being replaced with the value and {{code|<nowiki>{{{i}}}</nowiki>}} with the name of the parameter/index.
== Example ==
| |||
