CatNet Systems CH-1 Help

HTML Help

Supported HTML tags for Text Label formatting are:

Bold Text -

Example: This is bold text.
Effect: This is bold text.

Italic Text -

Example: This is italic text.
Effect: This is italic text.

Underline Text -

Example: This is underlined text.
Effect: This is underlined text.

Multiple Tags

Example: This is bold and underlined text.
Effect: This is bold and underlined text.

Font Size

Example: This is size 4 text.
Effect: This is size 4 text.

Font Color

Example: This is red text.
Effect: This is red text.

The color must be specified as an RGB (red,green,blue) value. Most color picker dialogs will display this number as the mouse is moved over the colors. Here are a few common color values:

#000000 - Black
#FF0000 - Red
#00FF00 - Green
#0000FF - Blue
#FFFF00 - Yellow
#00FFFF - Cyan
#FF00FF - Magenta
#808080 - Grey
#FFFFFF - (White)

Font Face

Example: This is ArialBlack font.
Effect: This is ArialBlack font.

Although the font face tag is supported, it is not recommended for use. If the user does not have the selected font installed, it will not be used. This could cause the text to look quite different to them.

Combined Font Tags

The font format tags may be combined:

Example: This is red, size 4 text.
Effect: This is red, size 4 text.

Line Break -

The tag embeds a line break (carriage return) in the text. It does not require a closing tag.

Example: Here are three lines: Line 1 Line 2 Line 3
Effect: Here are three lines:
Line 1
Line 2
Line 3

Limited HTML

Limited HTML is used for custom help on graphic screens. Because help screens are displayed in a browser window, almost all standard HTML tags are supported, but some tags may not give the desired results because of pre-formatting and the restricted size of the help window. All of the above HTML tags are supported and are usually enough for basic custom help files.

Unlike simple formatting, limited HTML requires the use of the tag anywhere a carriage return should appear. The paragraph tags may also be used.

Some useful tags include:

Horizontal Bar:
Example: <hr>

Make a link to a web page:
Example: <a href="http://www.google.com" target="_blank">Google (or any text)</a>
Effect: Google (or any text)

Embed an image from a web site:
Example: <img src="http://www.MyWebSite.com/MyImage.jpg"/>

Embed an image uploaded from the graphic properties screen:
Example: <img src="../../images/MyImageFile.jpg"/>

Embed an animation uploaded from the Animation component properties screen:
Example: <img src="../../animations/MyAnimation.gif"/>

Custom Help Files

To make custom help files seamlessly integrate with the rest of the help system, the following tags may be used. Using these tags helps ensure that custom help files will look like built-in help, even if the formatting of the help files changes.

To mark a major heading:
Example: <div class="tabHeading">This is a major heading</div> 
Effect:

This is a major heading

To mark a minor heading:
Example: <div class="heading">This is a minor heading</div>
Effect:

This is a minor heading

To show a useful tip:
Example: <img src="images/tip.png">This is a useful tip.
Effect:

This is a useful tip.

To show an important note:
Example: <img src="images/important.png">This is an important note!
Effect:

This is an important note!