Majestix: Created page with "{{Documentation subpage}} {{COinS safe|n}} {{High-use}} {{Bot use warning|bots=User:AAlertBot}} {{Lua|Module:Check for unknown parameters}} {{Uses TemplateStyles|Template:Tooltip/styles.css}} This template may be used to generate a tooltip when hovering over marked text. '''Note:''' this template is #When not to use|§ ..."

2026-06-18T11:37:22Z

Created page with "{{Documentation subpage}}  {{COinS safe|n}} {{High-use}} {{Bot use warning|bots=User:AAlertBot}} {{Lua|Module:Check for unknown parameters}} {{Uses TemplateStyles|Template:Tooltip/styles.css}} This template may be used to generate a tooltip when hovering over marked text. '''Note:''' this template is #When not to use|§&nbsp..."

New page

{{Documentation subpage}}

{{COinS safe|n}}
{{High-use}}
{{Bot use warning|bots=[[User:AAlertBot]]}}
{{Lua|Module:Check for unknown parameters}}
{{Uses TemplateStyles|Template:Tooltip/styles.css}}

This template may be used to generate a [[tooltip]] when hovering over marked text.

'''Note:''' this template is [[#When not to use|§ not to be used]] for expanding [[initialism]]s or [[acronyms]]; see template {{t|abbr}} for that instead. See {{slink||Notes}} for more details on access limitations for mobile and screen reader users.

== Usage ==

* {{tlc|{{BASEPAGENAME}}|''inline text''|''hover text''}}
* {{tlc|{{BASEPAGENAME}}|''inline text''|''hover text''|dotted{{=}}no|link{{=}}yes|class{{=}}...|style{{=}}...|id{{=}}...}}

=== When not to use ===

'''Abbreviations''' – The {{Tl|Tooltip}} template is {{em|not}} intended for use with abbreviations, including [[acronyms]] and [[initialisms]]; use template {{t|abbr}} for that instead.

'''Body text''' – The tooltip template should not be used within the body text of an article if possible (see [[MOS:NOTOOLTIPS]]).

'''As footnotes''' – Tooltips are not a substitute for [[Help:Footnotes|footnotes]]. They are intended to be used for navigational and other secondary features where space is limited. See [[Template:Glossary link]] or [[Template:Cite book/doc#Usage]] for practical examples.

'''In citations''' – Tooltips cannot be used inside [[Wikipedia:Citation templates|citation templates]]. If you're tempted to put a tooltip in a citation, it may be better to place a plaintext note after the citation template but before the closing {{tag|ref|c}} tag, or use a [[WP:Nested footnotes|nested footnote]].

== Parameters ==

There are two required positional parameters, and five optional named parameters:

* {{para|1}} – the term to be explained; displays as text. [[Wiki markup]] is allowed but works more consistently when wrapping the template, see below for linking examples.
* {{para|2}} – the tooltip/pop-up ('''no wiki or HTML markup allowed'''). The popup is created by an HTML <code>title=</code> attribute, so it cannot contain HTML (or markup that resolves to HTML when rendered). This includes simple things like <code><nowiki>''italics''</nowiki></code>.
* {{para|dotted}} – set to {{pval|no}} to remove dotted underline decoration (default: use dotted underline)
* {{para|link}} – set to {{pval|yes}} to link the tooltip to the value in param {{pval|1}} (default: tooltip is unlinked)

These three parameters take the standard values as defined by [[HTML]] and [[CSS]]:
* {{para|class}} – one or more CSS classes (space-separated, enclosed in quotes)
* {{para|id}} – an HTML ID must be unique on the entire page.
* {{para|style}} – CSS to apply to the displayed text (no effect on tooltip/popup). Any style values with embedded blanks must be single-quoted, e.g. {{para|style|font-family: 'Times New Roman', serif;}}

== Examples ==

* {{demo-inline|<nowiki>{{tooltip|TKO|technical knockout}}</nowiki>}}
* {{demo-inline|<nowiki>{{tooltip|conflict of interest|COI as used in Wikipedia policy|dotted=no}}</nowiki>}}
* {{demo-inline|<nowiki>{{tooltip|תוכן נִסתָר|תוכן ברור|dotted=no}}</nowiki>}}
* {{demo-inline|<nowiki>{{tooltip|Sex gap|Difference in life expectancy for female and male}}</nowiki> }}
* {{demo-inline|<nowiki>{{tooltip|'''$31,152,975'''|Career prize money}}</nowiki> }}
* {{demo-inline|<nowiki>{{tooltip|male|Assigned male at birth}}</nowiki>}}
* {{demo-inline|<nowiki>{{tooltip|Cupronickel|75% copper, 25% nickel}}</nowiki> }}
* {{demo-inline|<nowiki>{{tooltip|ई|ī|dotted=no}}</nowiki>}}
* {{demo-inline|<nowiki>{{tooltip|''Voyage with a Tail Wind''|simplified Chinese: 顺风相送; traditional Chinese: 順風相送; pinyin: Shùnfēng Xiāngsòng|dotted=no}}</nowiki> }}

== Template data ==
{{TemplateData header}}
<TemplateData>
{
"description": "A pop-up tooltip displayed on mouse-over.",
"params": {
"1": {
"label": "Term",
"description": "Rendered in-line as normal text",
"type": "string/line",
"required": true
},
"2": {
"label": "Tooltip",
"description": "Shows as a pop-up, mouse-over tooltip",
"type": "string",
"required": true
},
"link": {
"label": "Link",
"description": "set to 'yes' to link the term to the article specified by Term",
"example": "yes",
"type": "boolean",
"default": "no",
"required": false
},
"dotted": {
"label": "Dotted",
"description": "applies the specified CSS directives to the content of parameter 1",
"example": "yes",
"type": "boolean",
"default": "no",
"required": false
},
"style": {
"label": "Style",
"description": "applies the specified CSS directives to the content of parameter 1",
"type": "string",
"required": false
},
"class": {
"label": "Class",
"description": "Adds one or more CSS classes, separated by a blank",
"type": "string",
"required": false
},
"id": {
"label": "ID",
"description": "Adds an HTML id (must be unique in the page)",
"type": "string",
"required": false
}
}
}
</TemplateData>

== Notes ==

* This template is not available in the [[Wikipedia:mobile app|mobile view of Wikipedia]], which lacks the hover feature. As of 2023, [https://stats.wikimedia.org/#/en.wikipedia.org/reading/total-page-views/normal|bar|2-year|access~desktop*mobile-app*mobile-web|monthly more English Wikipedia page views occur on mobile than on desktop browsers].
* [[Screen readers]] often have difficulty with plain hover pop-up text.

== Maintenance categories ==
* {{clc|Pages using tooltip with unknown parameters}}

== See also ==
* {{t|Abbr}}
* {{t|Dfn}}
<includeonly>{{Sandbox other||

[[Category:Abbreviation templates| ]]
[[Category:Wikipedia HTML tag-replacing templates]]
[[Category:Semantic markup templates]]

}}</includeonly>

Template:Tooltip/doc - Revision history