Template:For nowiki/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
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 ==
| |||
Revision as of 03:26, January 21, 2020
 | This is a documentation subpage for Template:For nowiki. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template uses Lua: |
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 {{For loop}}, which calls a specified template) once for each item in the list.
Usage
Template:Tlp
Template:Tlp
{{#invoke:For nowiki|template|separator|<nowiki>wikitext</nowiki>|force one loop}}
- General parameters
separatoris inserted between the results ofwikitextinterpretation. Whitespace is preserved.wikitextis interpreted once for each item in the list. It then may use{{{1}}}to get the item value, and{{{i}}}to get its position in the list (starting from 1), as well as any parameters that were passed to {{for nowiki}}. It may also contain template calls. To use a parameter passed to the calling template, surround it with</nowiki>...<nowiki>(the opening and closing tags are swapped) or pass the parameter directly to {{for nowiki}} if its name doesn't conflict with any reserved parameters.
- Use 1 specific
item1,item2,...are the items to iterate through, with{{{1}}}being replaced with the value and{{{i}}}with the name of the parameter/index.
- Use 2 specific
count=countis the number of times to interpret the provided wikitext. The template will pass each integer between 1 and that count as both|1=and|i=each time.
- Use 3 specific
force one loopforces the module to perform at least one loop, this is useful when you provide a default value for{{{1}}}.
- When using the module, numbered/unnamed parameters sent to the template (the page the module is used on) will be iterated through, with
{{{1}}}being replaced with the value and{{{i}}}with the name of the parameter/index.
Example
See also
- {{For loop}}
