Nats tooltip
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Applies to NATS 4.0.25 and greater.
nats_tooltip
Displays a help message in the admin and allows you to link the message to a knowledge base article.
Aliases: tooltip.
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
text | The text to be displayed in the tooltip | Any HTML-encoded text | None. | text="Calculate & Display Results" |
url | The URL the link points to (overrides kb parameter) | Any valid URL | None. | url="http://example.com" |
no_wrap | Flag to prevent text wrapping | 1 | None. Text is wrapped | no_wrap="1" |
wrap | The number of characters per line | Any integer greater than 0 | 60 | wrap="75" |
img | The URL of the image to used for the tooltip | Any valid URL; may be a relative URL | nats_images/help_16.gif | img="http://nats.example.com/tooltip.jpg" |
kb (deprecated) | The path to a knowledge base article (Use url instead) | Any valid URL starting with http://kb.toomuchmedia.com/idx/0/ | None. | kb="193/691/Template_Functions/article/natstooltip.html" |
Output
Outputs HTML code to create a tooltip in your NATS administration interface.
Notes
- A line break (\n) provided to the text parameter will be replaced with an HTML line break (<br>)
- Uses the PHP function wordwrap to add automatic line breaks. Wordwrap intelligently breaks lines at the end of words.
- If no_wrap is set to "1", then wrap is ignored.
- the kb parameter is deprecated in NATS v4.0. Using url overrides any value found in kb. Do not use kb.'
- A URL specified using the url parameter makes your link clickable. For example, the following code will produce the image and HTML below:
{nats_tooltip text="This is a tooltip" url="http://kb.toomuchmedia.com/193/691/"}
<a target="_blank" href="http://kb.toomuchmedia.com/idx/193/691/"> <img border="0" onmouseout="HintHide();" onmouseover="HintShow('This is a tooltip<br /><B>Click for more information</B>');" src="nats_images/help_16.gif"/> </a>