Module:Annotated link/doc: Difference between revisions

Revision as of 01:01, 8 February 2023

Latest revision as of 19:49, 9 July 2025

(8 intermediate revisions by 7 users not shown)

Line 1:

{{Module rating|protected}}

{{High-use}}

{{Lua|Module:GetShortDescription|Module:Arguments|Module:Lang}}

<includeonly>{{#ifeq:{{FULLBASEPAGENAME}}|Module:AnnotatedLink|{{important|This module is redundant to [[Module:Annotated link]] which should be used and referred to instead.}}}}</includeonly>

Line 8 ⟶ 9:

<pre><nowiki>{{#invoke:Annotated link|main

|name= |display= |quote= |abbr= |abbr_title= |template_link= |aka= |wedge= |dash= |desc_first_letter_case= |space_cat= |red_catprefix_parentheses=

|link_lang= |link_lang_italic= |link_lang_nocat= |link_lang_size= |link_lang_cat= |link_lang_rtl=

Line 23 ⟶ 24:

=== name ===

By providing only the '''required''' page name (including namespace), the module will use [[Module:GetShortDescription]] to look for an explicit {{tlx|short description}} in that page, butand if not found, will try to fetch the wikidata description. This is equivalent to stating {{para|prefer|explicit}}; see [[#prefer]]display (below)nothing. 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''English) 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 [[#Foreign language text]] (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 [[#Module:GetShortDescription parameters]] (below).

Line 86 ⟶ 87:

=== desc_first_letter_case ===

Short descriptions on en Wikipedia [[WP:SDFORMAT|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 {{para|desc_first_letter_case|upper}} or {{para|desc_first_letter_case|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 {{para|prefix_parentheses|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 {{tl|annotated link}} for disambiguation pages; see [[Template:Annotated link/doc#Usage]].

=== 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 {{tlc|short description}} 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 {{para|space_cat}} in the 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 {{tlx|annotated link}}, rather than in the template code.

=== red_cat and red_cat_no ===

In the event that the page name provided is for a nonexistent page, and the module directs Module:GetShortDescription to search for an explicit short description for the page; upon receipt of the notice from GetShortDescription, it will add the page transcluding the annotation to [[:Category:Pages displaying redlinks processed by Module:Annotated link]]. If it is determined that annotating the redlink is appropriate (e.g. it's not in a ''[[MOS:SEEALSO|See also]]'' section); this may be disabled by adding {{para|red_cat|no}} to the ivocation. 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 {{tlc|annotated link}}, rather than in the template code.

A blanket effect may be achieved automatically for selected pages by providing a <code>#</code> delimited list of page titles to exclude from categorisation. For example; if <code>red_cat_no=List of#Outline of</code>, the module will allow redlinks on pages with titles starting with those prefixes to be annotated without categorisation.

=== Module:GetShortDescription parameters ===

Line 105 ⟶ 110:

Providing a value for {{para|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 [[#fallback]] (below).

:Stating {{para|only|explicit}} will limit the search to only short descriptions set by use of {{tlc|short description}} on the searched page.

:Stating {{para|only|wikidata}} will limit the search to only wikidata descriptions.

==== prefer ====

Providing a value for {{para|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 [[#fallback]] (below).

:State {{para|prefer|explicit}} to use the explicit short description if available, or try for the wikidata description if not.

:State {{para|prefer|wikidata}} to use the wikidata description if available, or try for an explicit short description if not.

==== fallback ====

If a {{para|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 {{tlx|lang}}). The appropriate language code will be set automatically, but all other parameters of {{tlc|lang}} are available to affect the formatting of the returned description:

Use {{para|lang_italic}}, {{para|lang_nocat}}, {{para|lang_size}}, {{para|lang_cat}} and {{para|lang_rtl}}; see [[Template:Lang/doc|lang's documentation]] for details.

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

==== link_lang ====

Line 133 ⟶ 129:

<includeonly>{{Sandbox other||

<!-- Categories below this line; interwikis at Wikidata -->

[[Category:Short description related modules]]

[[Category:WikiProjectLink Short descriptionsmodules]]

}}</includeonly>

<noinclude>

[[Category:Module documentation pages]]

</noinclude>