Quick Info Tooltips

Top  Previous  Next

Quick info tooltips for objects, properties, methods, and events come from the platform files.

You can create tooltips for your own procedures, variables, constants, etc.

For this, place a comment directly after the declaration. You can even use simple HTML formatting!

 

Tibbo BASIC:

Tibbo C:

sub blink(pat as string) 'Blinks the status LEDs.
'<br><b>pat</b>- the pattern to play.
'<br><font color=red>Do not set to NULL</font>
...

void blink(string pat){ //Blinks the status LEDs.
//<br><b>pat</b>- the pattern to play.
//<br><font color=red>Do not set to NULL</font>
...

 

The above will yield this tooltip:

 

tooltip_comment

 

Tooltip comment rules

Your comment must be on the same line with the declaration or definition, or on the line immediately following it (additional rules).

There must be no blank lines between the declaration/definition and the beginning of the "tooltip" comment.

Additionally, in case of multi-line comments:

For BASIC, there must be no blank lines between the lines of the "tooltip" comment.

For one-line ("//") comments of C, there also must be no blank lines between the lines of the "tooltip" comment.

For multi-line ("/* */") comments of C, there may be blank lines between the lines of the "tooltip" comment.

If there is a "tooltip" comment both in the definition and the declaration, then the one in the definition wins.

 

Using HTML in tooltips

Here are the HTML tags (elements) that you can use to spruce up your tooltips:

Presentation markup tags: <b>, <i>, <big>, <small>, <s>, <u>, <font [color=color] [size=size] [face=face]>

Headings <h1>...<h6>

Line break <br>

Comments: <!-- -->

 

All other tags (elements) cannot be used. Most unsupported tags are simply ignored, but some lead to scrambled text output.

 

note_tip-wtOne peculiarity of the HTML engine of TIDE is that it requires you to place the space character before the closing tag in the tag pair.

For example, if you write "<b>Bold</b> text" then you will get this output: "Boldtext". Writing "<b>Bold </b>text" will produce the correct result: "Bold text".