If you're following accessibility best practices, informative images in your documentation should include an Alternative Text (also known as alt text) to provide a short description conveying the essential information presented by the image. This text can be used by screen readers and other assistive devices to help convey the information the image presents.
To add an alternative text to an image in your content:
- Select the image to open the image pop-up menu.
- Select the "i" icon for Alternative Text.
The Alternative Text icon is a small "i" in the image pop-up menu - This will open a small pop-up where you can you enter the text description.
- Once you've entered your text description, select Update to apply the text to the image.
Once you've entered Alternative Text, select "Update" to save the text - Be sure to Save your article once you're done!
Decorative images--those that don't convey information but just add decoration--should include an empty Alternative Text. Our editor currently doesn't do this automatically, so to set it manually yourself:
- Select the image to open the image pop-up menu.
- Select the "i" icon for Alternative Text.
The Alternative Text icon is a small "i" in the image pop-up menu - This will open a small pop-up where you can you enter the text description.
- Don't enter any text in the text box, and remove any that might exist.
- Select Update. This will save an
alt=""behind the scenes, which designates the image as for presentation rather than information. - Be sure to Save your article once you're done!
