Difference between revisions of "Template:For/doc"

From blackwiki
Jump to navigation Jump to search
test>Redrose64
(→‎top: start doc)
test>Prhartcom
(Another attempt at an improvement. Doc still needs formatting.)
Line 3: Line 3:
 
(The above was produced by: {{tlx|For|the template to create a for loop|Template:For loop}}.)
 
(The above was produced by: {{tlx|For|the template to create a for loop|Template:For loop}}.)
  
This template yields a [[WP:HAT|hatnote]], and accepts up to five parameters. If used without parameters on a page named ''Foo'', the result is
+
This template yields a [[WP:HAT|hatnote]].to a single disambiguation page or to one, two, three, or four articles. It accepts zero to five parameters. If used without parameters on a page named ''Foo'', the result is
 
{{hatnote|For other uses, see [[:Foo (disambiguation)]].}}
 
{{hatnote|For other uses, see [[:Foo (disambiguation)]].}}
The first parameter should be plain text, e.g. {{tlc|for|similar terms}} yields:
+
The first parameter changes the hatnote itself and should be plain text, e.g. {{tlc|for|similar terms}} yields:
 
{{hatnote|For similar terms, see [[:Foo (disambiguation)]].}}
 
{{hatnote|For similar terms, see [[:Foo (disambiguation)]].}}
 
The second parameter is used to change the resultant link, e.g. {{tlc|for|similar terms|Foobar}} yields:
 
The second parameter is used to change the resultant link, e.g. {{tlc|for|similar terms|Foobar}} yields:
 
{{for|similar terms|Foobar}}
 
{{for|similar terms|Foobar}}
The third, fourth and fifth parameters are used to give supplemantary links:
+
The third, fourth and fifth parameters are used to give two, three, or four supplemantary links:
 
{{for|similar terms|Foobar|Bar}}
 
{{for|similar terms|Foobar|Bar}}
 
{{for|similar terms|Foobar|Bar|Baz}}
 
{{for|similar terms|Foobar|Bar|Baz}}
 
{{for|similar terms|Foobar|Bar|Baz|Quux}}
 
{{for|similar terms|Foobar|Bar|Baz|Quux}}
the last being produced by e.g. {{tlc|for|similar terms|Foobar|Bar|Baz|Quux}}.
+
the last producing e.g. {{tlc|for|similar terms|Foobar|Bar|Baz|Quux}}.
  
 
==TemplateData==
 
==TemplateData==

Revision as of 02:12, 24 September 2015

(The above was produced by: {{For|the template to create a for loop|Template:For loop}}.)

This template yields a hatnote.to a single disambiguation page or to one, two, three, or four articles. It accepts zero to five parameters. If used without parameters on a page named Foo, the result is

The first parameter changes the hatnote itself and should be plain text, e.g. {{for|similar terms}} yields:

The second parameter is used to change the resultant link, e.g. {{for|similar terms|Foobar}} yields:

The third, fourth and fifth parameters are used to give two, three, or four supplemantary links:

the last producing e.g. {{for|similar terms|Foobar|Bar|Baz|Quux}}.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for For

This template lists up to four articles on alternative meanings of a term. For further details and examples see the template documentation.

Template parameters

ParameterDescriptionTypeStatus
topic1

usually describing the major alternative or a general term for all alternative meanings

Default
other uses
Stringoptional
major alternative2

usually a disambiguation page or the most likely alternative meaning

Default
{{PAGENAME}} (disambiguation)
Pageoptional
first minor alternative3

another meaning if any

Pageoptional
second minor alternative4

another meaning if any

Pageoptional
third minor alternative5

another meaning if any

Pageoptional