View source for Template:Annotated link/doc

{{Documentation subpage}}
{{High-use}}
{{Template shortcut|anl|anli}}

==Usage==
Used in lists to provide an annotated link using the [[ Wikipedia:Short_description |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 {{tlx|Short description}} template exists in the targeted article, but is empty, or contains a space, non-breaking space, the word <code>blank</code>, <code>none</code>, <code>null</code>, 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 {{tlx|Short description}} template.

The template should not be used for annotating links on disambiguation pages. The relevant discussion is at [[Wikipedia_talk:Disambiguation/Archive_50#Use_of_annotated_links|Wikipedia talk:Disambiguation §&nbsp;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.)

===Syntax===
:<code><nowiki>{{Annotated link|Article title|piped link|abbreviation= |aka= |dash= }}</nowiki></code>

===Examples===
Null case: Short description template present in article but indicates short description not needed by using one of the null descriptions
:<code><nowiki>{{Annotated link|Template:Annotated link/demo}}</nowiki></code>
:{{Annotated link|Template:Annotated link/demo}}
Basic
:<code><nowiki>{{Annotated link|Confédération Mondiale des Activités Subaquatiques}}</nowiki></code>
:{{Annotated link|Confédération Mondiale des Activités Subaquatiques}}
Piped for alternative link display
:<code><nowiki>{{Annotated link|Confédération Mondiale des Activités Subaquatiques|<big>World Underwater Federation</big>}}</nowiki></code>
:{{Annotated link|Confédération Mondiale des Activités Subaquatiques|<big>World Underwater Federation</big>}}
Piped to use [[:template:lang]] per [[MOS:FOREIGNITALIC]]
:<code><nowiki>{{Annotated link|Confédération Mondiale des Activités Subaquatiques |{{lang|fr |Confédération Mondiale des Activités Subaquatiques |nocat=yes}}}}</nowiki></code>
:{{Annotated link|Confédération Mondiale des Activités Subaquatiques|{{lang|fr|Confédération Mondiale des Activités Subaquatiques |nocat=yes}}}}
Abbreviation added
:<code><nowiki>{{Annotated link|Confédération Mondiale des Activités Subaquatiques|World Underwater Federation|abbreviation=CMAS}}</nowiki></code>
:{{Annotated link|Confédération Mondiale des Activités Subaquatiques|World Underwater Federation|abbreviation=CMAS}}
Alias added
:<code><nowiki>{{Annotated link|Confédération Mondiale des Activités Subaquatiques|World Underwater Federation|abbreviation=CMAS |aka=''Confédération Mondiale des Activités Subaquatiques''}}</nowiki></code>
:{{Annotated link|Confédération Mondiale des Activités Subaquatiques|World Underwater Federation|abbreviation=CMAS |aka=''Confédération Mondiale des Activités Subaquatiques''}}
Dash replaced
:<code><nowiki>{{Annotated link|Confédération Mondiale des Activités Subaquatiques|World Underwater Federation|abbreviation=CMAS |aka=''Confédération Mondiale des Activités Subaquatiques''|dash=,&amp;#32;}}</nowiki></code>
:{{Annotated link|Confédération Mondiale des Activités Subaquatiques|World Underwater Federation|abbreviation=CMAS |aka=''Confédération Mondiale des Activités Subaquatiques''|dash=,&#32;}}

==Notes==
* If you are porting this template to other Wikipedia sites, you may want to modify this template to read [[Wikidata]] for [[Wikipedia:Short description|short descriptions]] depending on your local policies on placing such descriptions. To do so, you will need to run some [[WP:Lua|Lua]] code along the lines of <code>return mw.<wbr/>wikibase.<wbr/>description(mw.<wbr/>wikibase.<wbr/>getEntityIdForTitle(<wbr/>frame.<wbr/>args[1]))</code> in a module. [[Module:ResolveEntityId]] may be used for the entity ID if you wish to handle redirects too.
** For an example of such a template, see [[:zh:Template:Annotated_link|the Chinese Wikipedia version]].

==Parameters==
{{TemplateData header}}
<templatedata>
{
	"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"
}
</templatedata>

== See also ==

* {{tlx|AnnotatedListOfLinks}} - wraps {{tlb|nolink=y|Annotated link}} around multiple links at once
* {{tlx|SDlink}} - a version that checks for and fixes a bug in the handling of a numbered parameter
* {{tlx|laal}} – displays an article's pagelinks alongside its short description
* [[Wikipedia:Short description]] − General information about short descriptions
* [[WP:HOWTOSD]] − Detailed guidance on writing short descriptions.

<includeonly>{{Sandbox other||
[[Category:Documentation assistance templates]]
[[Category:Link templates]]
}}</includeonly>