A

Last Updated : Dec 19, 2022 |

abstract

Use to provide a brief overview of the topic to help the user decide whether this topic is relevant to them. Introduce the topic and provide a concise answer to the question "What is this?" and in some cases "Why do I care about this?" Avoid using the abstract to lead in or build up to a topic. Use complete sentence rather than sentence fragments, and do not repeat the title. Avoid starting abstracts with phrases such as "This topic describes . . . ." or "This topic is about . . . ."
Use the shortdesc element for single paragraph with within 50 words.

alt

Use to describe visual elements to users who cannot see them, either because the image failed to load or because they are using a screen-reader.
Use to describe the contents of an image that makes the image accessible to users who use a screen reader.
Use to describe the contents of an image to:
  • Make the image accessible to users who cannot see it and use a screen reader.
  • Enable search engines to better crawl and rank your website.
  • Enable translation tools access alt text easily for translation than the alt attribute.
    Therefore, do not use the alt attribute for alternative image text.

apiname

Indicates the name of an application programming interface (API).
For example, wrap the <apiname> element around a Java class name or method name.

application

Use the <application> element for names of applications, include names of mobile applications, and interfaces within a product. Rather than typing each occurrence of an application, reuse the defined application elements from the reusable elements topic.