Screenshots
Screenshots provide concise explanations of complex concepts in a visual format.
Due to regular changes in the user interface, the life of a screenshot is short. Use screenshots only when the content is difficult to describe concisely. Even for a how-to article, a screenshot is not necessary to illustrate every step of the process.
Use the screenshot tool of your choice to take a screenshot. If you do not have a dedicated screenshot tool, use the Mac OS keyboard shortcut Command+Shift+4 to take a screenshot of a region.
What to include in a screenshot
Include the relevant content in a screenshot with some context if needed. Do not include the entire screen unless the entire screen is relevant (for example, a UI tour).
If you need to fill out fields in a screenshot, see Placeholders for guidance.
Do not use an image editor to add extra text to a screenshot.
Do not include a screenshot that contains only text. Type the text out instead.
Blur out any information that displays real names, testing URLs, and confidential Lucidworks content.
Alternative text
Alternative text (or alt text) displays when the element it is applied to cannot be displayed. A screen reader can also read the alt text. While alt text is used in various HTML elements, the Docs site limits alt text use to images. Using alt text improves the docs site’s accessibility and search engine optimization.
To include alt text with Asciidoc, use the following sample:
image:/assets/images/spark/SparkOps_driver.png[Alt text]Replace /assets/images/spark/SparkOps_driver.png with the relative path of your image and Alt text with your image’s alt text.
To include alt text and other image attributes, list the alt attribute first. The following example uses alt text and sets the image’s width and height to 80%.
image:/assets/images/spark/SparkOps_driver.png[Alt text, 80%]Resources
The following resources discuss specific screenshot topics: