Template:For nowiki/doc

From blackwiki
< Template:For nowiki
Revision as of 03:26, 21 January 2020 by imported>BrandonXLF (Expanded document to include the module)
Jump to navigation Jump to search

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

{{For nowiki|separator|<nowiki>wikitext</nowiki>|item1|item2|...}}
{{For nowiki|separator|<nowiki>wikitext</nowiki>|count=count}}
{{#invoke:For nowiki|template|separator|<nowiki>wikitext</nowiki>|force one loop}}
General parameters
  • separator is inserted between the results of wikitext interpretation. Whitespace is preserved.
  • wikitext is 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=count is 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 loop forces 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

Markup Renders as
{{For nowiki|
|<nowiki>* Item {{{i}}}: {{3x|{{{1}}} }}</nowiki> |dog|cat|bird}}
  • Item 1: dog dog dog
  • Item 2: cat cat cat
  • Item 3: bird bird bird

See also