View source for Template:For loop/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
==Preamble==
This template is based on {{tim|for}}.  The template name was changed because there already is {{tiw|for}} with a different purpose.

See also {{tiw|loop}}.

{{tim|for}}

Uses {{tiw|for/aux}}.

== Description ==
The template calls a specified template up to 150 times, where one parameter takes each of a list of values; in addition to the variable parameter, for up to 5 parameters a fixed value can be specified.

== Usage ==

<pre>
{{for loop
  |call=template to call
  |what to separate the entries with (unnamed parameter; required, but can be the empty string)
  |pc1n=name of first parameter with constant value 
  |pc1v=first constant value
  |pc2n=name of second parameter with constant value
  |pc2v=second constant value
  |pc3n=name of third parameter with constant value
  |pc3v=third constant value
  |pc4n=name of fourth parameter with constant value
  |pc4v=fourth constant value
  |pv=name of variable parameter
  |prefix=constant first part of the value of pv
  |postfix=constant last part of the value of pv
  |list of 1 to 150 parameter values (without prefixes and postfixes), with separator "|"
     (empty parameter values work in the regular way, they are ''not'' ignored like undefined ones)

}}
</pre>

The separator is unnamed, allowing it to start and/or end with [[Help:newlines and spaces|newlines and spaces]]. This parameter should be put before the list. If a parameter value in the list contains an equals sign the list should use named parameters, at least from that point, where it should be noted that e.g. the third item in the list is parameter 4, because parameter 1 is the separator. If the separator contains an equals sign it is  similarly prefixed with "1=", but in that case it cannot contain newlines and spaces at the start and end.

===Changes from old preprocessor===
To make a previous call to "for loop" work with the new preprocessor:
*replace <code>pc1=X=Y</code> with <code>pc1n=X | pc1v=Y</code>, etc.
*use an unnamed parameter for the separator; if empty, just enter an extra "|"

==Examples==
{| class="wikitable", border=1
!Code
!Result
|-
|
<pre>1{{for loop|, 1|00|01|02|03|04|05|06|07|08|09
|10|11|12|13|14|15|16|17|18|19
|20|21|22|23|24|25|26|27|28|29
|30|31|32|33|34|35|36|37|38|39
|40|41|42|43|44|45|46|47|48|49
|50|51|52|53|54|55|56|57|58|59
|60|61|62|63|64|65|66|67|68|69
|70|71|72|73|74|75|76|77|78|79
|80|81|82|83|84|85|86|87|88|89
|90|91|92|93|94|95|96|97|98|99
  |call=1x
}}</pre>
|1{{for loop|, 1|00|01|02|03|04|05|06|07|08|09
|10|11|12|13|14|15|16|17|18|19
|20|21|22|23|24|25|26|27|28|29
|30|31|32|33|34|35|36|37|38|39
|40|41|42|43|44|45|46|47|48|49
|50|51|52|53|54|55|56|57|58|59
|60|61|62|63|64|65|66|67|68|69
|70|71|72|73|74|75|76|77|78|79
|80|81|82|83|84|85|86|87|88|89
|90|91|92|93|94|95|96|97|98|99
  |call=1x
}}
|}

Note that the last part of the separator is used as a prefix; the first prefix needs to be put separately.

----

<nowiki>{{for loop|-|a|3||c|g|call=3x}}</nowiki> using {{tiw|3x}} gives

{{for loop|-|a|3||c|g|call=3x}}

<nowiki>{{for loop|</nowiki>

<nowiki>|a|3||c|g|call=3x}}</nowiki> gives

{{for loop|

|a|3||c|g|call=3x}}

<pre>
{|class="wikitable sortable"
|-
!Test
|-
| {{for loop|
{{!}}-
{{!}} |a|b|c|d|e|call=3x}}
|}
</pre>

gives:

{|class="wikitable sortable"
|-
!Test
|-
| {{for loop|
{{!}}-
{{!}} |a|b|c|d|e|call=3x}}
|}

<pre>
{{for loop| |01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19
|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39
|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|56|57|58|59
|60|61|62|63|64|65|66|67|68|69|70|71|72|73|74|75|76|77|78|79
|80|81|82|83|84|85|86|87|88|89|90|91|92|93|94|95|96|97|98|99
|100|101|102|103|104|105|106|107|108|109|110|111|112|113|114|115|116|117|118|119
|120|121|122|123|124|125|126|127|128|129|130|131|132|133|134|135|136|137|138|139
|140|141|142|143|144|145|146|147|148|149|150|151|152|153|154|call=1x}}
</pre>
gives:

{{for loop| |01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19
|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39
|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|56|57|58|59
|60|61|62|63|64|65|66|67|68|69|70|71|72|73|74|75|76|77|78|79
|80|81|82|83|84|85|86|87|88|89|90|91|92|93|94|95|96|97|98|99
|100|101|102|103|104|105|106|107|108|109|110|111|112|113|114|115|116|117|118|119
|120|121|122|123|124|125|126|127|128|129|130|131|132|133|134|135|136|137|138|139
|140|141|142|143|144|145|146|147|148|149|150|151|152|153|154|call=1x}}

==Substitution==
For successive levels of substitution use one or more or the following (the first, the first two, the first three, the first four, or all) 

*"subst:" in front of "for loop":  substitute the call of {{tim|for loop}}
*substf=subst: - substitute the parser functions in {{tim|for}}
*substfa=subst: - substitute the call of auxiliary {{tim|for/aux}}
*substa=subst: - substitute the parser functions in for/aux (reduces the number of items from 150 to the actual number)
*substc=subst: - substitute the calls of the user template

If at least the first four are applied, and the separator contains <nowiki>{{!}}</nowiki>, one can replace it with <nowiki>{{subst:!}}</nowiki> to substitute that too.

For full substitution [[Special:ExpandTemplates]] can also be used.

==Old version==
Note that formerly this template had a named separator parameter ''sep''.

{{tl|for/aux5}} and {{tiw|for loop 6}} may not have been adapted to the new preprocessor yet.

==See also==
*{{tim|foreach}}
*{{tim|tblb}}
*{{tiw|loop}}
*{{tiw|repeat}}
*{{tiw|simple recursion}}
*[[Help:Parameter default]]
*[[Help:Array]]
*[[mw:Extension:LoopFunctions]]

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]

[[ca:Template:For loop]]
[[dsb:Pśedłoga:For]]
[[eo:Ŝablono:For]]
[[hsb:Předłoha:For]]
[[pl:Szablon:For2]]
[[ru:Шаблон:For]]
[[sk:Šablóna:For]]
[[sl:Predloga:For3]]
</includeonly>