Difference between revisions of "Template:For nowiki/doc"
Jump to navigation
Jump to search
imported>BrandonXLF (Expanded document to include the module) |
imported>Andrybak (→Example: add example for parameter "start") |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | + | {{lua|Module:For nowiki}} | |
| − | This | + | This 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 == | == Usage == | ||
| − | {{tlp|For nowiki|''separator''|{{tag|nowiki|content=''wikitext''}}| | + | {{tlp|For nowiki|''separator''|{{tag|nowiki|content=''wikitext''}}|item1|item2|...}} |
{{tlp|For nowiki|''separator''|{{tag|nowiki|content=''wikitext''}}|count{{=}}''count''}} | {{tlp|For nowiki|''separator''|{{tag|nowiki|content=''wikitext''}}|count{{=}}''count''}} | ||
| − | |||
| − | |||
| − | |||
* <code>''separator''</code> is inserted ''between'' the results of <code>''wikitext''</code> interpretation. Whitespace is preserved. | * <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. | * <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. | ||
| − | + | === Count form === | |
| − | + | The second form of this template using a {{para|count}} parameter interprets the given wikitext <code>count</code> times, passing each integer between 1 and that <code>count</code> as both {{para|1}} and {{para|i}} each time. By default, iteration starts from 1. Use parameter {{para|start|<var>number</var>}} to start from a different number. Then the iteration will go from <code>start</code> to <code>start+count-1</code>. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Example == | == Example == | ||
{{Markup | {{Markup | ||
|<nowiki>{{For nowiki| | |<nowiki>{{For nowiki| | ||
| − | |<nowiki>* Item {{{i}}}: {{3x|{{{1}}} }}</nowiki></nowiki> <nowiki>|dog|cat|bird}}</nowiki> | + | |</nowiki><<nowiki>nowiki>* Item {{{i}}}: {{3x|{{{1}}} }}</nowiki></nowiki><nowiki>|dog|cat|bird}}</nowiki> |
| + | |{{For nowiki| | ||
| + | |<nowiki>* Item {{{i}}}: {{3x|{{{1}}} }}</nowiki>|dog|cat|bird}} | ||
| + | |<nowiki>{{For nowiki| | ||
| + | |</nowiki><<nowiki>nowiki># [[:Category:{{{1}}} in spaceflight]]</nowiki></nowiki><nowiki>|count=9|start=1961}}</nowiki> | ||
|{{For nowiki| | |{{For nowiki| | ||
| − | |<nowiki> | + | |<nowiki># [[:Category:{{{1}}} in spaceflight]]</nowiki>|count=9|start=1961}} |
}} | }} | ||
Latest revision as of 14:48, 27 September 2020
| This is a documentation subpage for Template:For nowiki. It contains usage information, categories and other content that is not part of the original template page. |
| This template uses Lua: |
This 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.
Contents
Usage
{{For nowiki|separator|<nowiki>wikitext</nowiki>|item1|item2|...}} {{For nowiki|separator|<nowiki>wikitext</nowiki>|count=count}}
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.
Count form
The second form of this template using a |count= parameter interprets the given wikitext count times, passing each integer between 1 and that count as both |1= and |i= each time. By default, iteration starts from 1. Use parameter |start=number to start from a different number. Then the iteration will go from start to start+count-1.
Example
| Markup | Renders as |
|---|---|
{{For nowiki|
|<nowiki>* Item {{{i}}}: {{3x|{{{1}}} }}</nowiki>|dog|cat|bird}}
|
|
{{For nowiki|
|<nowiki># [[:Category:{{{1}}} in spaceflight]]</nowiki>|count=9|start=1961}}
|
|
See also
- {{For loop}}