Annotations

Annotations add hover tooltips to inline terms. When the reader hovers over an annotated term, the definition appears in a tooltip.

Basic Usage

The DOMDocument Object Model is a programming interface for web documents.

Syntax:

The ::annotation[DOM]{Document Object Model} is a programming interface.

The first part [DOM] is the visible text. The second part {Document Object Model} is the tooltip content.

Multiple Annotations

Learn HTMLHyperText Markup Language, CSSCascading Style Sheets, and JSJavaScript to build websites.

Technical Terms

RESTRepresentational State Transfer APIs use HTTPHyperText Transfer Protocol methods like GETRetrieve a resource and POSTCreate a new resource.

Abbreviations

The CMSContent Management System supports SSRServer-Side Rendering with PHPPHP: Hypertext Preprocessor templates.

Best Practices

• Annotate terms the first time they appear, not every time
• Keep tooltip text concise --- one sentence or phrase
• Use for abbreviations, technical terms, and jargon
• Don't annotate common terms that your audience already knows