Difference between revisions of "Template:For/doc"

From blackwiki
Jump to navigation Jump to search
imported>ExcitedEngineer
(omitting the first parameter makes the module return an error since this diff: https://en.wikipedia.org/w/index.php?title=Module:For&oldid=855200211)
(Blanked the page)
Line 1: Line 1:
{{documentation subpage}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
{{high-use| 149560 }}
 
{{Lua|Module:For}}
 
  
{{for|the template to create a for loop|Template:For loop}}
 
(The above was produced by: {{tlc|For|the template to create a for loop|Template:For loop}}.)
 
 
This template yields a [[WP:Hatnote|hatnote]] with links to up to four articles or disambiguation pages. It accepts zero to five parameters.
 
The first parameter sets the hatnote itself and should be plain text, e.g. {{tlc|For|similar terms}} yields on page Foo:
 
{{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:
 
{{For|similar terms|Foobar}}
 
The third, fourth and fifth parameters are used to give one, two, or three supplementary links:
 
{{For|similar terms|Foobar|Bar}}
 
{{For|similar terms|Foobar|Bar|Baz}}
 
{{For|similar terms|Foobar|Bar|Baz|Quux}}
 
the last being produced by e.g. {{tlc|For|similar terms|Foobar|Bar|Baz|Quux}}.
 
 
==See also==
 
* {{tl|About}}
 
* {{tl|See also}}
 
 
==TemplateData==
 
{{TemplateData header}}
 
<templatedata>
 
{
 
"description": "This template lists up to four articles on alternative meanings of a term. For further details and examples see the template documentation.",
 
"params": {
 
"1": {
 
"label": "Description",
 
"description": "a phrase describing the major alternative, or a general term for all alternative meanings",
 
"type": "string",
 
"required": true,
 
"example": "other people with the surname Smith"
 
},
 
"2": {
 
"label": "First link",
 
"description": "A page to link to; usually a disambiguation page or the most likely other meaning.",
 
"default": "{{PAGENAME}} (disambiguation)",
 
"type": "wiki-page-name",
 
"required": false
 
},
 
"3": {
 
"label": "Second link",
 
"description": "A page to link to for another meaning, if any.",
 
"type": "wiki-page-name",
 
"required": false
 
},
 
"4": {
 
"label": "Third link",
 
"description": "A page to link to for another meaning, if any.",
 
"type": "wiki-page-name",
 
"required": false
 
},
 
"5": {
 
"label": "Fourth link",
 
"description": "A page to link to for another meaning, if any.",
 
"type": "wiki-page-name",
 
"required": false
 
}
 
},
 
"format": "inline"
 
}
 
</templatedata>
 
{{Hatnote templates}}
 
<includeonly>{{Sandbox other||
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Disambiguation and redirection templates|For]]
 
[[Category:Hatnote templates]]
 
 
}}</includeonly>
 

Revision as of 03:31, 8 January 2021