<caution>

Caution notice

Specifies information that warns the user about a potential loss of data.

Syntax.

   <caution>

   text of caution

   <\caution>

The default heading for the caution is "Caution". To specify a different heading, use the <head> tag as shown here:

   <caution><head>alternate heading

   text of caution

   <\caution>

The <\caution> end tag is required.

To specify that an icon be displayed with the caution, define a file entity at the top of your help volume as follows:

   <!entity CautionElementDefaultIconFile FILE "filename">

Where filename is the name of the icon graphic. A sample caution icon named cauticon.pm is provided in the /usr/vhelp/helptag/icons/ directory.

Example. Here is a caution message:

   <caution>

   Do not press the DELETE key at this time.

   <\caution>

For an example that shows how to use the <head> element to specify a non-default heading, refer to “<note>”.

See Also.

“<note>” includes an example of changing a heading.
“<warning>”
“<figure>”
“<head>”

<caution>

Technical documentation

» Table of Contents

» Glossary

» Index