Template:Annotated link/doc

Usage
Typically to be used in lists to provide an annotated link using the short description for the linked page. For example: in See also sections "editors should provide a brief annotation when a link's relevance is not immediately apparent, when the meaning of the term may not be generally known, or when the term is ambiguous". By default, the short description of the linked page will be derived from the template responsible for setting the short description for that page. If a template is not in use on the page, the description will be derived from Wikidata. If no Wikidata description can be obtained, no short description will be appended. This behavior can be manipulated and other formatting options allow for the presentation of useful annotations even without a short description, which may still become available and therefore displayed at a later date.

Some pages are assigned short descriptions by automatic methods; templates that generate short descriptions include infoboxes that use the data provided to its parameters to create a suitable short description, which may overrule other short descriptions that exist for or on the page. The module responsible for fetching the description is currently not able to detect or determine this type of dynamically created short description.

This template should not be used for annotating links on disambiguation pages. The relevant discussion is at 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.)

Basic
The most basic usage is:
 * Markup:
 * Result:

The text shown for the link may be piped if desired or required:
 * Markup:
 * Result:
 * Markup:
 * Result:

Foreign language formatting options are available for the link text; see below.

If the list format is unsuitable for dash separation of the link from the description, it may be replaced with something suitable:
 * Markup:
 * Result:

The examples above use unnamed parameters 1–3. The parameters can also be named or explicitly numbered:
 * Markup:
 * Markup:

There are many possible configurations beyond this, as described below, and most parameters have aliases.

Extended
There are many available parameters, broken down into the following sections:

Template links
Links to templates will be automatically formatted as would be expected by template link:
 * Markup:
 * Result:

Formatting as would be expected by may be applied by adding code:
 * Markup:
 * Result:

If this formatting is determined to be inappropriate for the circumstance; use no to disable it:
 * Markup:
 * Result:

If the template link formatting is disabled; use the second parameter, 2 or display to affect the text display:
 * Markup:
 * Result:

Quoting link titles
Some titles of works, such as song titles, should be double quoted; this formatting may be applied using yes:
 * Markup:
 * Result:

Additional abbreviation
A parenthesized abbreviation may be added following the link using abbr if desired:
 * Markup:
 * Result:

A title for the abbreviation may be provided with abbr_title if suitable:
 * Markup:
 * Result:

Additional alternative name
An alternative name for the linked entity may be added following the link (and abbreviation if also added) using aka if desired; the alternative name will be prepended with ", also known as":
 * Markup:
 * Result:

Foreign language formatting options are available for this parameter; see below.

Additional information
Even more information may be wedged in between the previously stated information and that of the potentially following description; use wedge to add it is desired:
 * Markup:
 * Result:

Foreign language formatting options are available for this parameter; see below.

Foreign language text
Foreign language text should be formatted in accordance with MOS:OTHERLANG; this template provides all the necessary options to control the formatting. The module invoked by this template, uses Module:Lang (the module powering ) to do the formatting, and all the options are fully described on their documentation pages.

If the link text is of a foreign language (editor discretion determines if this is appropriate); control the formatting with: link_lang, link_lang_italic, link_lang_nocat, link_lang_size, link_lang_cat and link_lang_rtl

If the aka text is of a foreign language (again; editor discretion); control the formatting with: aka_lang, aka_lang_italic, aka_lang_nocat, aka_lang_size, aka_lang_cat, aka_lang_rtl

If the wedge text is of a foreign language (again; editor discretion); control the formatting with: wedge_lang, wedge_lang_italic, wedge_lang_nocat, wedge_lang_size, wedge_lang_cat, wedge_lang_rtl

This template invokes Module:Annotated link, which in turn uses Module:GetShortDescription to (as the name suggests) get the short description. It may return a foreign language (i.e. not en) Wikidata description (again; editor discretion). If it is displayed; the appropriate language code will be set automatically, but all other parameters of are available to affect the formatting of the returned description:

Use desc_lang_italic, desc_lang_nocat, desc_lang_size, desc_lang_cat and desc_lang_rtl. If the editor determines that formatting of the description is not appropriate; it may be disabled with yes.

Although this is not a realistic example; it provides an overview of this handling:
 * Markup:
 * Result:

Controlling the search for a short description
Providing a value for only or prefer will affect the search to being either only or with a preference for the stated description. If no description is found, the result will be that no description is appended to the link (and any other information provided), unless a fallback is provided.

Stating explicit will limit the search to only short descriptions set by use of on the linked page.
 * Markup:
 * Result:

Stating wikidata will limit the search to only Wikidata descriptions.
 * Markup:
 * Result:

State explicit to use the explicit short description if available, or try for the Wikidata description if not.
 * Markup:
 * Result:

State wikidata to use the Wikidata description if available, or try for an explicit short description if not.
 * Markup:
 * Result:

If a fallback value is provided, and no description is found by the expressed route, the appended description will be the stated fallback value.
 * Markup:
 * Result:

Controlling the case of the first character of a short description
Short descriptions on en Wikipedia should be formatted with an uppercase first letter. By default, the short descriptions retrieved by this template are displayed as they are typed in the page from which they are extracted, but this may be overridden if required using upper or lower.

Parameters
{	"description": "a link created and annotated using a short description and other optional additions", "params": { "1": {			"label": "Page name (including namespace)", "description": "Title of the page to be linked and annotated", "type": "wiki-page-name", "required": true, "aliases": [ "name", "title" ] },		"2": {			"label": "Link display text", "description": "The text to be displayed in the link", "type": "line", "default": "name", "aliases": [ "display", "disp" ] },		"3": {			"label": "Separator", "description": "Replace the dash with something else", "type": "line", "example": ",", "default": "–", "aliases": [ "dash", "comma" ] },		"template_link": { "label": "Template link formatting", "description": "Disable special formatting of links to pages in the Template namespace", "type" : "line", "suggestedvalues": [ "no", "code" ], "aliases": [ "template-link", "tl" ] },		"quote": { "label": "Quote links", "description": "Double quotation of the link", "type": "line", "suggestedvalues": [ "yes" ], "aliases": [ "quote_link", "quote-link", "ql" ] },		"abbr": { "label": "Abbreviation", "description": "Abbreviation to be displayed in parentheses after the link", "type": "line", "aliases": [ "abbreviation" ] },		"abbr_title": { "label": "Abbreviation title", "description": "Provide a title for an abbreviation", "type" : "line", "aliases": [ "abbr-title", "abbreviation_title", "abbreviation-title", "at" ] },		"aka": { "label": "Also known as", "description": "Alternative names to display after the link (and abbreviation if provided)", "type": "line" },		"wedge": { "label": "Additional information", "description": "Additional information to display after the link (and abbr and aka if provided)", "type": "line", "aliases": [ "insert", "extra" ] },		"desc_first_letter_case": { "label": "Description first letter case", "description": "Control to case of the first letter of a short description", "type" : "line", "suggestedvalues": [ "upper", "lower" ], "default": "lower", "aliases": [ "desc-first-letter-case", "desc_case", "desc-case", "case" ] },		"space_cat": { "label": "Categorisation of spaceless descriptions", "description": "Disable categorisation of pages displaying descriptions containing no space characters", "type" : "line", "suggestedvalues": [ "no" ], "aliases": [ "space-cat" ] },		"only": { "label": "Limit description search", "description": "Dictate the only source for a short description", "type" : "line", "suggestedvalues": [ "explicit", "wikidata" ] },		"prefer": { "label": "Description preference", "description": "Suggest a prefered source for a short description", "type" : "line", "suggestedvalues": [ "explicit", "wikidata" ], "default": "explicit" },		"fallback": { "label": "Description fallback", "description": "Provide a fallback description in the event no other is available", "type" : "line" },		"link_lang": { "label": "Link text foreign language code", "description": "Provide a language code for foreign language link text", "type" : "line", "example": "ja", "aliases": [ "link-lang", "ll" ] },		"link_lang_italic": { "label": "Link text foreign language italics", "description": "Control the italic presentation of foreign language link text", "type" : "line", "suggestedvalues": [ "yes", "no", "unset", "invert", "default" ], "aliases": [ "link-lang-italic", "lli" ] },		"link_lang_nocat": { "label": "Link text foreign language categorisation", "description": "Dictate the categorisation of foreign language link text", "type" : "line", "suggestedvalues": [ "yes", "y", "true", "t", "on", "1" ], "aliases": [ "link-lang-nocat", "llnc" ] },		"link_lang_cat": { "label": "Link text foreign language categorisation", "description": "Dictate the categorisation of foreign language link text", "type" : "line", "suggestedvalues": [ "no", "n", "false", "f", "off", "0" ], "aliases": [ "link-lang-cat", "llc" ] },		"link_lang_size": { "label": "Link text foreign language size", "description": "Control the size presentation of foreign language link text", "type" : "line", "example": "1.5em", "aliases": [ "link-lang-size", "lls" ] },		"link_lang_rtl": { "label": "Link text foreign language rtl", "description": "Control the rtl presentation of foreign language link text", "type" : "line", "suggestedvalues": [ "no", "yes" ], "default": "no", "aliases": [ "link-lang-rtl", "llr" ] },		"aka_lang": { "label": "Aka text foreign language code", "description": "Provide a language code for foreign language aka text", "type" : "line", "example": "ja", "aliases": [ "aka-lang", "al" ] },		"aka_lang_italic": { "label": "Aka text foreign language italics", "description": "Control the italic presentation of foreign language aka text", "type" : "line", "suggestedvalues": [ "yes", "no", "unset", "invert", "default" ], "aliases": [ "aka-lang-italic", "ali" ] },		"aka_lang_nocat": { "label": "Aka text foreign language categorisation", "description": "Dictate the categorisation of foreign language aka text", "type" : "line", "suggestedvalues": [ "yes", "y", "true", "t", "on", "1" ], "aliases": [ "aka-lang-nocat", "alnc" ] },		"aka_lang_cat": { "label": "Aka text foreign language categorisation", "description": "Dictate the categorisation of foreign language aka text", "type" : "line", "suggestedvalues": [ "no", "n", "false", "f", "off", "0" ], "aliases": [ "aka-lang-cat", "alc" ] },		"aka_lang_size": { "label": "Aka text foreign language size", "description": "Control the size presentation of foreign language aka text", "type" : "line", "example": "1.5em", "aliases": [ "aka-lang-size", "als" ] },		"aka_lang_rtl": { "label": "Aka text foreign language rtl", "description": "Control the rtl presentation of foreign language aka text", "type" : "line", "suggestedvalues": [ "no", "yes" ], "default": "no", "aliases": [ "aka-lang-rtl", "alr" ] },		"wedge_lang": { "label": "Additional information foreign language code", "description": "Provide a language code for foreign language wedge text", "type" : "line", "example": "ja", "aliases": [ "wedge-lang", "insert_lang", "insert-lang", "extra_lang", "extra-lang", "wl" ] },		"wedge_lang_italic": { "label": "Additional information foreign language italics", "description": "Control the italic presentation of foreign language wedge text", "type" : "line", "suggestedvalues": [ "yes", "no", "unset", "invert", "default" ], "aliases": [ "wedge-lang-italic", "insert_lang_italic", "insert-lang-italic", "extra_lang_italic", "extra-lang-italic", "wli" ] },		"wedge_lang_nocat": { "label": "Additional information foreign language categorisation", "description": "Dictate the categorisation of foreign language wedge text", "type" : "line", "suggestedvalues": [ "yes", "y", "true", "t", "on", "1" ], "aliases": [ "wedge-lang-nocat", "insert_lang_nocat", "insert-lang-nocat", "extra_lang_nocat", "extra-lang-nocat", "wlnc" ] },		"wedge_lang_cat": { "label": "Additional information foreign language categorisation", "description": "Dictate the categorisation of foreign language wedge text", "type" : "line", "suggestedvalues": [ "no", "n", "false", "f", "off", "0" ], "aliases": [ "wedge-lang-cat", "insert_lang_cat", "insert-lang-cat", "extra_lang_cat", "extra-lang-cat", "wlc" ] },		"wedge_lang_size": { "label": "Additional information foreign language size", "description": "Control the size presentation of foreign language wedge text", "type" : "line", "example": "1.5em", "aliases": [ "wedge-lang-size", "insert_lang_size", "insert-lang-size", "extra_lang_size", "extra-lang-size", "wls" ] },		"wedge_lang_rtl": { "label": "Additional information foreign language rtl", "description": "Control the rtl presentation of foreign language wedge text", "type" : "line", "suggestedvalues": [ "no", "yes" ], "default": "no", "aliases": [ "wedge-lang-rtl", "insert_lang_rtl", "insert-lang-rtl", "extra_lang_rtl", "extra-lang-rtl", "wlr" ] },		"desc_lang_no": { "label": "Foreign language description formatting", "description": "Dictate if foreign language description text should be formatted", "type" : "line", "suggestedvalues": [ "yes" ], "aliases": [ "desc-lang-no", "dlno" ] },		"desc_lang_italic": { "label": "Foreign language description italics", "description": "Control the italic presentation of foreign language description text", "type" : "line", "suggestedvalues": [ "yes", "no", "unset", "invert", "default" ], "aliases": [ "desc-lang-italic", "dli" ] },		"desc_lang_nocat": { "label": "Foreign language description categorisation", "description": "Dictate the categorisation of foreign language description text", "type" : "line", "suggestedvalues": [ "yes", "y", "true", "t", "on", "1" ], "aliases": [ "desc-lang-nocat", "dlnc" ] },		"desc_lang_cat": { "label": "Foreign language description categorisation", "description": "Dictate the categorisation of foreign language description text", "type" : "line", "suggestedvalues": [ "no", "n", "false", "f", "off", "0" ], "aliases": [ "desc-lang-cat", "dlc" ] },		"desc_lang_size": { "label": "Foreign language description size", "description": "Control the size presentation of foreign language description text", "type" : "line", "example": "1.5em", "aliases": [ "desc-lang-size", "dls" ] },		"desc_lang_rtl": { "label": "Foreign language description rtl", "description": "Control the rtl presentation of foreign language description text", "type" : "line", "suggestedvalues": [ "no", "yes" ], "default": "no", "aliases": [ "desc-lang-rtl", "dlr" ] }	} }

Preview warnings and maintenance categories
Module:GetShortDescription may create warnings about detected issues with configurations, that show above the preview content during editing. These warnings are not about the page being edited, but about the pages for which the annotated links are being created. If any preview warnings are shown; please consider visiting the indicated pages to analyse and possibly fix the issues.

It may also show alarming messages (they're red but not necessarily errors) about its function. If it is not clear how to fix the problem indicated; don't continue trying to annotate the link with this template as the messages will be visible to all readers of Wikipedia. If any alarming messages are displayed on saved pages as a result of issues, the page showing those messages will be added to the maintenance Category:Pages displaying alarming messages about Module:GetShortDescription.

Module:Annotated link may also show alarming messages about its function and in much the same way will add pages to Category:Pages displaying alarming messages about Module:Annotated link.

Several other maintenance categories exist for potential issues with the annotations:
 * Category:Pages displaying short descriptions with no spaces via Module:Annotated link will be populated by pages where the module has been invoked to provide annotations that include a description with no spaces. If a page in this category is analysed by an interested editor, and it is determined that the description is appropriate for use; add no to the to disable the categorisation. If the description is not appropriate; the interested editor can either try to fix it at the source, use only to potentially select another description, or remove the use of this template and create a custom annotation for the link manually.
 * Category:Pages displaying wikidata descriptions as a fallback via Module:Annotated link will be populated by pages where the module has been invoked to provide annotations which contain Wikidata descriptions that were not explicitly requested (with wikidata or wikidata). They may or may not be suitable and this is a matter of ongoing consideration and discussion. Please consider reviewing the instances.
 * Category:Pages displaying short descriptions matching their page name via Module:Annotated link will be populated by pages where the module has been invoked to provide annotations contain descriptions that have (case insensitive) equality with the name of the linked page i.e. "Wikipedia article" with a short description of "wikipedia article". Please consider reviewing the instances.

A handy tool for finding category intersections is available.