Wiki: Short Description Directive

The {{ShortDescription}} directive defines a concise one-line summary for the article.

Syntax

{{ShortDescription A concise summary of this article under 160 characters.}}

				

Purpose and Usage

• SEO & Social Sharing: Stored in the ShortDescription document metadata and rendered into page <meta name="description"> and Open Graph tags.
• Search Results: Displayed in article cards, search listings, and link previews across the site.
• No Direct Body Output: As a metadata directive, it does not print directly into the visible article body text.

Rules

• Length: Keep descriptions concise—ideally between 80 and 160 characters.
• First Block Wins: Only the first occurrence in the document is used.
• Single Line: Must be written on a single line.

Example

{{ShortDescription September 1975 inaugural issue of BYTE, covering microcomputer kits and early software.}}

				

Return to the Formatting Guide.