Jump to content

Template:For/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
Blanked the page
Tags: Blanking Manual revert Reverted Mobile edit Mobile web edit
m Reverted edits by 201.108.8.143 (talk) (HG) (3.4.12)
Line 1: Line 1:
{{for|the template to
create a for loop|Template:For loop}}
{{documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{high-use| 149560 }}
{{Lua|Module:For}}

== Usage ==
This template yields a [[WP:Hatnote|hatnote]] similar to {{tl|Other uses}}, but allowing more flexible text with links to multiple articles or disambiguation pages. It accepts one or more parameters (zero is not allowed).

=== With one parameter (rare) ===
The first parameter sets the hatnote itself and should be plain text. Without any further parameter, it will link to a default disambiguation page for the article title, e.g. {{tlc|For|other entities}} yields on page Foo:
{{hatnote|For other entities, see [[:Foo (disambiguation)]].}}

This kind of usage with exactly one parameter is rare, as in most instances {{tl|Other uses}} (and in this case, {{tl|About}} with the same result) can be used more easily, and without any parameter. But it makes sense in some cases for disambiguation pages with the same type of other meanings, e.g. in [[Treaty of Lisbon]]:
{{hatnote|For earlier treaties known as Treaty of Lisbon, see [[Treaty of Lisbon (disambiguation)]].}}
However, for many such cases specific new templates have been implemented, like {{tl|Other people}}, {{tl|Other places}} etc. - see hatnote template overview box below.

=== With two parameters ===
The second parameter is used to change the resultant link, e.g. {{tlc|For|the acronym|FOO}} yields (wherever it is set, now independent of the article title):
{{For|the acronym|FOO}}

=== With more parameters ===
The third, fourth and fifth parameters are used to give one, two, or three additional resultant 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}}.

The {{para|selfref|yes}} option marks the entire hatnote as a Wikipedia self-reference, causing it to be omitted when the page content is reused outside of Wikipedia (see {{tl|self reference}} and [[MOS:SELFREF]] for more details).

=== Styling in italics ===
Please see {{section link|Wikipedia:Hatnote|Hatnotes with italics in the links}} ([[WP:ITHAT]]) for details about how to use italics in hatnotes.

==Tracking category==
Pages with errors reported by this template are added to [[:Category:Hatnote templates using unusual parameters]].

==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
},
"selfref": {
"label": "Is self-reference?",
"description": "Set to yes to make this hatnote invisible on e.g. printed versions, for [[WP:SELFREF]]s",
"type": "boolean",
"default": "no",
"autovalue": "yes"
}
},
"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 14:15, 28 July 2024

Usage

This template yields a hatnote similar to {{Other uses}}, but allowing more flexible text with links to multiple articles or disambiguation pages. It accepts one or more parameters (zero is not allowed).

With one parameter (rare)

The first parameter sets the hatnote itself and should be plain text. Without any further parameter, it will link to a default disambiguation page for the article title, e.g. {{For|other entities}} yields on page Foo:

This kind of usage with exactly one parameter is rare, as in most instances {{Other uses}} (and in this case, {{About}} with the same result) can be used more easily, and without any parameter. But it makes sense in some cases for disambiguation pages with the same type of other meanings, e.g. in Treaty of Lisbon:

However, for many such cases specific new templates have been implemented, like {{Other people}}, {{Other places}} etc. - see hatnote template overview box below.

With two parameters

The second parameter is used to change the resultant link, e.g. {{For|the acronym|FOO}} yields (wherever it is set, now independent of the article title):

With more parameters

The third, fourth and fifth parameters are used to give one, two, or three additional resultant links:

the last being produced by e.g. {{For|similar terms|Foobar|Bar|Baz|Quux}}.

The |selfref=yes option marks the entire hatnote as a Wikipedia self-reference, causing it to be omitted when the page content is reused outside of Wikipedia (see {{self reference}} and MOS:SELFREF for more details).

Styling in italics

Please see Wikipedia:Hatnote § Hatnotes with italics in the links (WP:ITHAT) for details about how to use italics in hatnotes.

Tracking category

Pages with errors reported by this template are added to Category:Hatnote templates using unusual parameters.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:For in articles based on its 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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Description1

a phrase describing the major alternative, or a general term for all alternative meanings

Example
other people with the surname Smith
Stringrequired
First link2

A page to link to; usually a disambiguation page or the most likely other meaning.

Default
{{PAGENAME}} (disambiguation)
Page nameoptional
Second link3

A page to link to for another meaning, if any.

Page nameoptional
Third link4

A page to link to for another meaning, if any.

Page nameoptional
Fourth link5

A page to link to for another meaning, if any.

Page nameoptional
Is self-reference?selfref

Set to yes to make this hatnote invisible on e.g. printed versions, for [[WP:SELFREF]]s

Default
no
Auto value
yes
Booleanoptional