Difference between revisions of "Template:For/doc"
(←Blanked the page) |
imported>Andrybak |
||
| (One intermediate revision by one other user not shown) | |||
| 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}}. | ||
| + | |||
| + | ==Tracking category== | ||
| + | Pages with errors reported by this template are added to [[:Category:Hatnote templates using unusual parameters]]. | ||
| + | |||
| + | ==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> | ||
Latest revision as of 18:56, 13 January 2021
| This is a documentation subpage for Template:For. It contains usage information, categories and other content that is not part of the original template page. |
| This template is used on approximately 158,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| This template uses Lua: |
(The above was produced by: {{For|the template to create a for loop|Template:For loop}}.)
This template yields a 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. {{For|similar terms}} yields on page Foo:
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 one, two, or three supplementary links:
the last being produced by e.g. {{For|similar terms|Foobar|Bar|Baz|Quux}}.
Tracking category
Pages with errors reported by this template are added to Category:Hatnote templates using unusual parameters.
See also
TemplateData
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Description | 1 | a phrase describing the major alternative, or a general term for all alternative meanings
| String | required |
| First link | 2 | A page to link to; usually a disambiguation page or the most likely other meaning.
| Page | optional |
| Second link | 3 | A page to link to for another meaning, if any. | Page | optional |
| Third link | 4 | A page to link to for another meaning, if any. | Page | optional |
| Fourth link | 5 | A page to link to for another meaning, if any. | Page | optional |