Template:Tooltip/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎top: clean up, replaced: {{documentation subpage → {{Doc/subpage)
(Described parameters. Used {{tlc}}.)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
==Examples==
 
Example: <nowiki>{{Tooltip|This is mouse-over text|Hover here}}</nowiki>
== Parameters ==
 
* {{param|1}} - The hover text, which is displayed only when hovering over the normal text.
* {{param|2}} - The normal text that the hover text may be displayed on.
* {{param|link}} - ''Optional:'' The page that the normal text should link to.
* {{param|line}} - ''Optional:'' The type of bottom-line that should be under the normal text, for example {{code|solid}}, {{code|dashed}}, {{code|dotted}}.
* {{param|style}} - ''Optional:'' Additional style parameters for the normal text.
 
== Examples ==
 
Example: {{tlc|Tooltip|This is mouse-over text|Hover here}}


Result: {{Tooltip|This is mouse-over text|Hover here}}
Result: {{Tooltip|This is mouse-over text|Hover here}}




Example: <nowiki>{{Tooltip|line=dashed|This is mouse-over text|Hover here}}</nowiki>
Example: {{tlc|Tooltip|line=dashed|This is mouse-over text|Hover here}}


Result: {{Tooltip|line=dashed|This is mouse-over text|Hover here}}
Result: {{Tooltip|line=dashed|This is mouse-over text|Hover here}}




Example: <nowiki>{{Tooltip|line=dotted|link=Main Page|This is mouse-over text}}</nowiki>
Example: {{tlc|Tooltip|line{{=}}dotted|link{{=}}Main Page|This is mouse-over text}}


Result: {{Tooltip|line=dotted|link=Main Page|This is mouse-over text}}
Result: {{Tooltip|line=dotted|link=Main Page|This is mouse-over text}}




Example: <nowiki>{{Tooltip|line=dotted|link=Main Page|This is mouse-over text|Hover here}}</nowiki>
Example: {{tlc|Tooltip|line{{=}}dotted|link{{=}}Main Page|This is mouse-over text|Hover here}}


Result: {{Tooltip|line=dotted|link=Main Page|This is mouse-over text|Hover here}}
Result: {{Tooltip|line=dotted|link=Main Page|This is mouse-over text|Hover here}}




Example: <nowiki>{{Tooltip|line=solid|This is mouse-over text|Hover here}}</nowiki>
Example: {{tlc|Tooltip|line{{=}}solid|This is mouse-over text|Hover here}}


Result: {{Tooltip|line=solid|This is mouse-over text|Hover here}}
Result: {{Tooltip|line=solid|This is mouse-over text|Hover here}}




Example: <nowiki>{{Tooltip|line=; border:2px solid #BD0; color:orange|This is mouse-over text|Hover here}}</nowiki>
Example: {{tlc|Tooltip|line{{=}}; border:2px solid #BD0; color:orange|This is mouse-over text|Hover here}}


Result: {{Tooltip|line=; border:2px solid #BD0; color:orange|This is mouse-over text|Hover here}}
Result: {{Tooltip|line=; border:2px solid #BD0; color:orange|This is mouse-over text|Hover here}}

Revision as of 15:30, 25 April 2024

Edit-copy.png
This is a documentation subpage for Template:Tooltip.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Parameters

  • {{{1}}} - The hover text, which is displayed only when hovering over the normal text.
  • {{{2}}} - The normal text that the hover text may be displayed on.
  • {{{link}}} - Optional: The page that the normal text should link to.
  • {{{line}}} - Optional: The type of bottom-line that should be under the normal text, for example solid, dashed, dotted.
  • {{{style}}} - Optional: Additional style parameters for the normal text.

Examples

Example: {{Tooltip|This is mouse-over text|Hover here}}

Result: Hover here


Example: {{Tooltip|This is mouse-over text|Hover here}}

Result: Hover here


Example: {{Tooltip|line=dotted|link=Main Page|This is mouse-over text}}

Result: Main Page


Example: {{Tooltip|line=dotted|link=Main Page|This is mouse-over text|Hover here}}

Result: Hover here


Example: {{Tooltip|line=solid|This is mouse-over text|Hover here}}

Result: Hover here


Example: {{Tooltip|line=; border:2px solid #BD0; color:orange|This is mouse-over text|Hover here}}

Result: Hover here