image

Identifies artwork or images in a topic.

The <image> element has optional attributes that indicate whether the graphic or artwork should be:

• Inline, such as a button or icon

• On a separate line, such as a larger image

An href attribute is required on the <image> element. The href attribute creates a pointer to the image, and allows the output formatting processor to bring the image into the text flow.

To make the intent of the image more accessible for users using screen readers or text-only readers, always include a description of the image content in the <alt> element. If you want to include a description of the image for reuse, include the <image> and a <desc> element inside a <fig> element.

important

As defined in the Avaya Style Guide, use the <important> element to call attention to a situation that can cause serious inconvenience.

indexterm

Defines an index entry.

The text in an <indexterm> element is not output as part of topic content.

When you're adding index entries, any index entries that relate to the whole topic should be inserted in the prolog section of the topic. Index entries that apply to a specific section of the topic should be inserted in that element as an inline. This ensures that the link to that index entry goes to the right location in the topic (helpful in cases where the topic is not all contained on the same page in an output). It also ensures that the index entry is moved or deleted with the content that it relates to.

To create multi-level indexes, nest the elements as follows:

<indexterm>users

<indexterm>adding</indexterm>

</indexterm>

Nest index entries to one level only.

info

Provides additional information about a step.

Always use the <info> element inside a <step> element.