Module:Annotated link/doc

name
By providing only the required page name (including namespace), the module will use Module:GetShortDescription to look for an explicit in that page, but if not found, will try to fetch the wikidata description. This is equivalent to stating explicit; see (below). If a description is found, it will be appended to a link created for the named page in the style expected for the likes of MOS:SEEALSO. If no description is found, the link will be created but no extra information will be appended – unless the extensive following parameters are employed.

Any foreign language (i.e. not en) text supplied to this module or retrieved by Module:GetShortDescription may be appropriately formatted, in accordance with MOS:OTHERLANG, via the parameters for Module:Lang; see (below).

As this module is responsible for the use of all features of Module:GetShortDescription; all the parameters for that module are available through this module; see (below).
 * Markup:
 * Result:

This and the following example song titles should be double quoted per MOS:POPMUSIC; that will be handled by (below), and you will see the parameters in use where appropriate from here on.

display
Providing a value for display will format the piped link with a display string:
 * Markup:
 * Result:

quote
Stating yes will double quote the link:
 * Markup:
 * Result:
 * Markup:
 * Result:

abbr
Providing a value for abbr will append the link with the provided parenthesized abbreviation with  semantic markup:
 * Markup:
 * Result:

An optional abbr_title may be provided:
 * Markup:
 * Result:

template_link
If the linked page is in the Template namespace; the link will be formatted in the manner expected by :
 * Markup:
 * Result:

Stating code will display the link formatted with :
 * Markup:
 * Result:

The previously described parameters – display, quote, abbr and abbr_title – and all foreign language link options under link_lang (see (below)) will be ignored if the link is in the Template namespace.

Stating no will disable this special link formatting and the ignorance of the above-mentioned parameters:
 * Markup:
 * Result:

aka
Providing a value for aka will append the link (and abbr if provided) with a useful alternative name:
 * Markup:
 * Result:
 * Markup:
 * Result:

These and some following examples contain foreign language text that, per MOS:OTHERLANG, should be appropriately displayed and declared via HTML markup as being of that language; this will be handled by various parameters; see (below) for full details, and you will see the parameters in use where appropriate from here on.

wedge
Providing a value for wedge will append the link (and abbr and aka in that order if either or both is provided) with any extra details felt suitable:
 * Markup:
 * Result:

For complementary foreign language params; see (below).

dash
For list consistency, per MOS:LISTFORMAT; by providing a value for dash; the dash between the short description and the preceding text may be exchanged for a suitable alternative:
 * Markup:
 * Result:

desc_first_letter_case
Short descriptions on en Wikipedia should be formatted with an uppercase first letter, but the typical application of this module will require the first character to be lowercase. By default; this module will ensure all the short descriptions retrieved by Module:GetShortDescription are transformed to start with a lowercase first letter, but this may be overridden if required using upper or lower.

prefix_parentheses
Sometimes date ranges in short descriptions are included in a suffixed parenthetical, per WP:SDDATES e.g. for Jimmy Wales: "Co-founder of Wikipedia (born 1966)".

However when listing people in disambiguation pages per MOS:DABPEOPLE, birth and death dates in parentheticals should precede the comma, as in "Jimmy Wales (born 1966), co-founder of Wikipedia".

If the optional parameter y is provided, this behavior will be performed, so any suffixed parenthetical text will be moved to before the dash (or comma) separator.

Note that current consensus is to not use annotated link for disambiguation pages; see Template:Annotated link/doc.

space_cat
In the event that a short description with no spaces is retrieved and displayed; pages transcluding the annotation will be added to Category:Pages displaying short descriptions with no spaces via Module:Annotated link for interested editors to monitor for potential issues. Potential issues might include: garbage keyboard mashings, a typo of "none" while attempting to disable an explicit or some misunderstanding on the part of an editor placing one.

If the transclusion on a page in this category is checked and it is determined to be okay; stating a value for space_cat in the invocation will disable the categorisation. This should only be done on a case by cases basis, as opposed to as a default, or no potentially inappropriate annotations will be categorised; i.e. allow this parameter to be set in individual transclusions of templates which invoke this module, like, rather than in the template code.

Module:GetShortDescription parameters
The value provided with name is passed through this module to Module:GetShortDescription where it is also required; the expectations of this module are described in (above). Module:GetShortDescription uses the value to find a in the named page, or various alternatives depending on parameter values.

only
Providing a value for only will limit the search to being only for the stated description. If no description is found, the result will be an empty string, unless a fallback is provided; see (below).
 * Stating explicit will limit the search to only short descriptions set by use of on the searched page.
 * Stating wikidata will limit the search to only wikidata descriptions.

prefer
Providing a value for prefer will initiate the search for the stated description, but try for the alternative if none is found. If no description is found, the result will be an empty string, unless a fallback is provided; see (below).
 * State explicit to use the explicit short description if available, or try for the wikidata description if not.
 * State wikidata to use the wikidata description if available, or try for an explicit short description if not.

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

Foreign language text
Module:GetShortDescription may return a foreign language (i.e. not en) wikidata description; editor discretion determines if that should be displayed. If it is displayed; it will be in accordance with MOS:OTHERLANG, by Module:Lang (the module powering ). The appropriate language code will be set automatically, but all other parameters of are available to affect the formatting of the returned description:

Use lang_italic, lang_nocat, lang_size, lang_cat and lang_rtl; see lang's documentation for details.

If the editor determines that formatting is not appropriate; it may be disabled with yes. The following formatting parameters are optional, so there is no off-switch required.

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

aka_lang
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

wedge_lang
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