Inline images
Inline images enhance understanding by visually identifying UI elements like toolbar icons or buttons within text.
Before you include an inline image in your documentation, review Best practices for including images.
Guidelines
Follow these guidelines when using an inline image:
-
Use an inline image in a sentence to help readers identify a UI element, such as a toolbar icon or a button.
-
Enclose the image in parentheses with non-breaking spaces.
-
Ensure you include alt text for the inline image that appropriately identifies the icon.
Examples
See the following examples of inline images in context:
-
Select the settings icon (
) to show a list of settings.
-
Splunk Enterprise deployments that aren't ready to use the Splunk AI Assistant for SPL yet can turn off the AI sparkle icon (
) that appears in the Search bar in the Search app.