Template:Annotated link/doc

Usage
Used in lists to provide an annotated link using the short description from the linked page for annotation. Useful for disambiguation and providing an idea of what the link is about, without having to hover on the link. The link may be piped to adjust appearance. An abbreviation/acronym/initialism may be included as an optional parameter, and an alias as another optional parameter. The annotation follows a spaced ndash by default, but this can be replaced by other separators as an optional parameter.

If a template exists in the targeted article, but is empty, or contains a space, non-breaking space, the word ,  ,  , or other indication that a short description is not appropriate or needed, the output should  be an un-annotated link. If it is not, list such cases on the talk page for attention, or fix it if you can. Note that this template does not take short descriptions from Wikidata even if the article lacks a template.

The template should not be used for annotating links on disambiguation pages. The relevant discussion is at Wikipedia talk:Disambiguation § Use of annotated links and concludes:
 * They contain formatting that is not in line with the long-established formatting for disambiguation entries at MOS:DAB.
 * The text of the descriptions is frequently not optimal for disambiguation pages, as it may be neither distinguishing nor succinct.
 * They would remove control of the text from the disambiguation page itself, and allow disambiguation pages to be modified without appearing in the edit history of the page itself, or in notifications relating to the page. (This reason is not fixable, and is sufficient reason not to use the template or any modification thereof.)

Examples
Null case: Short description template present in article but indicates short description not needed by using one of the null descriptions

Basic

Piped for alternative link display

Piped to use template:lang per MOS:FOREIGNITALIC

Abbreviation added

Alias added

Dash replaced

Parameters
{	"params": { "1": {			"label": "Article title", "description": "Title of the article where the short description template and value exist.\t", "type": "wiki-page-name", "required": true },		"2": {			"label": "Display title", "description": "The text to be displayed in the link", "type": "content", "default": "Article title" },		"abbreviation": { "description": "abbreviation to be displayed in parentheses after the display title", "type": "string" },		"aka": { "label": "alternative name", "description": "alternative names to display after the link as: also known as alternative name", "type": "string" },		"dash": { "description": "Replace the dash with something else", "example": ",&#32;", "type": "string" }	},	"format": "inline", "description": "a link annotated using the short description" }