View source for Template:For/doc

<noinclude>{{Documentationpage}}</noinclude>
{{for|a template which adds a navigation prompt at the beginning of an article, listing a similarly named page which users may be attempting to find|Template:For}}
A template which adds a navigation prompt at the beginning of an article, listing a similarly named page which users may be attempting to find.

Based on {{tl|directionbox}}.{{clear}}

==Usage==
* Place the following at the very top of the page:
<div style="width:100%;">
<pre>{{for|description|page name}}</pre>
<pre>{{for|description1|page name1|description2|page name2}}</pre>
<pre>{{for|description|page name|t1=visible page name link}}</pre>
</div>

* This template currently supports up to five navigation links.
<pre>
{{for|{{{1}}}|{{{2}}}|{{{3}}}|{{{4}}}|{{{5}}}|{{{6}}}|{{{7}}}|{{{8}}}|{{{9}}}|{{{10}}}}}
</pre>

===Copy paste===
<div style="width:150px;">
'''1 link'''<pre>
{{for||}}
</pre>
'''2 links'''<pre>
{{for||||}}
</pre>
'''3 links'''<pre>
{{for||||||}}
</pre>
'''4 links'''<pre>
{{for||||||||}}
</pre>
'''5 links'''<pre>
{{for||||||||||}}
</pre>
'''Full parameters'''<pre>
{{for<!--
-->|||t1=<!--
-->|||t2=<!--
-->|||t3=<!--
-->|||t4=<!--
-->|||t5=<!--
-->}}
</pre>
</div>

==Parameters==
{{Docparam
|name="Description" - pipes <code>{{{1}}}</code>, <code>{{{3}}}</code>, <code>{{{5}}}</code>, <code>{{{7}}}</code>, <code>{{{9}}}</code>
|req=yes
|default=
|desc=
Describes article(s) with similar name. The first part of a pair, describes the page in the navigation box, linking it after. All odd numbered unnamed pipes.
}}
{{Docparam
|name="Destination" - pipes <code>{{{2}}}</code>, <code>{{{4}}}</code>, <code>{{{6}}}</code>, <code>{{{8}}}</code>, <code>{{{10}}}</code>
|req=yes
|default=
|desc=
A link of the intended article. The second part of a pair, linking to an article after the description. All even numbered unnamed pipes.
}}
{{Docparam
|name="Alternate link text" - <code>{{{t1}}}</code>, <code>{{{t2}}}</code>, <code>{{{t3}}}</code>, <code>{{{t4}}}</code>, <code>{{{t5}}}</code>
|req=semi
|default=
|desc=
Alternate display text for a "destination" link. Should always be used for hiding anchored links (using #) or those with parenthesis. Used after a description/page name pair (all even numbered unnamed pipes). For example, <code>t1</code> changes the display text for the first page link, if multiple.
* <code>t1=</code> → Corresponds with pipe 2 (<code>{{{2}}}</code>)
* <code>t2=</code> → Corresponds with pipe 4 (<code>{{{4}}}</code>)
* <code>t3=</code> → Corresponds with pipe 6 (<code>{{{6}}}</code>)
* <code>t4=</code> → Corresponds with pipe 8 (<code>{{{8}}}</code>)
* <code>t5=</code> → Corresponds with pipe 10 (<code>{{{10}}}</code>)
}}
{{Docparam
|name=about
|req=no
|default=
|desc=
Inserts "This page is about <code>about</code>" text before the first "for, see" sentence (and behind the <code>redirect</code> text if present).
}}
{{Docparam
|name=redirect
|req=no
|default=
|desc=
Inserts "<code>redirect</code> redirects here" text at the beginning.
}}

==Examples==
; '''Single link'''
{{for|a list of all ore [[resources]]|Ore}}
<pre>{{for|a list of all ore [[resources]]|Ore}}</pre>

; '''Multiple links'''
{{for|a list of all ore [[resources]]|Ore|the [[resources]] that can moved on [[dumper]] trucks|Ore|t1=Raw ores}}
<pre>{{for|a list of all ore [[resources]]|Ore|the [[resources]] that can moved on [[dumper]] trucks|Ore|t1=Raw ores}}</pre>

; '''Hiding links - single'''
{{for|a list of all ore [[resources]]|Ore|t1=Raw ores}}
<pre>{{for|a list of all ore [[resources]]|Ore|t1=Raw ores}}</pre>

; '''Hiding links - multiple'''
{{for|a list of all ore [[resources]]|Ore|t1=Raw ore|the [[resources]] that can [[dumper]] trucks move|Road vehicles#Dumper|t2=Dumper trucks|covered hull [[road vehicles]]|Road vehicles#Covered hull|t3=Covered hull trucks}}
<pre>{{for|a list of all ore [[resources]]|Ore|t1=Raw ore|the [[resources]] that can [[dumper]] trucks move|Road vehicles#Dumper|t2=Dumper trucks|covered hull [[road vehicles]]|Road vehicles#Covered hull|t3=Covered hull trucks}}</pre>

; '''Maximum complexity'''
{{for<!--
-->|a list of all ore [[resources]]|Ore<!--
-->|the [[resources]] that can moved on [[dumper]] trucks|Ore|t1=Raw ores<!--
-->|the [[vehicles]] that can move on [[roads]]|Road vehicles<!--
-->|the list of road vehicles with covered hulls|Covered hull|t4=Covered hull trucks<!--
-->|the [[buildings]] used on farming|Farming|t5=Farming equipment<!--
-->}}
<pre>
{{for<!--
-->|a list of all ore [[resources]]|Ore<!--
-->|the [[resources]] that can moved on [[dumper]] trucks|Ore|t1=Raw ores<!--
-->|the [[vehicles]] that can move on [[roads]]|Road vehicles<!--
-->|the list of road vehicles with covered hulls|Covered hull|t4=Covered hull trucks<!--
-->|the [[buildings]] used on farming|Farming|t5=Farming equipment<!--
-->}}
</pre>
<pre>
{{for|a list of all ore [[resources]]|Ore|the [[resources]] that can moved on [[dumper]] trucks|Ore|t1=Raw ores|the [[vehicles]] that can move on [[roads]]|Road vehicles|the list of road vehicles with covered hulls|Covered hull|t4=Covered hull trucks|the [[buildings]] used on farming|Farming|t5=Farming equipment}}
</pre>