Module:Annotated link/doc: Difference between revisions

Revision as of 11:47, 2 February 2023

Revision as of 18:04, 2 February 2023

Line 2:

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

{{info|This module may, by design, output alarming informational messages under certain circumstances; if these messages are displayed on any page invoking this module directly, or via any other module or template using it, the page will be added to [[:Category:Pages displaying alarming messages about Module:AnnotatedLink]].}}

{{info|If an invocation of this module directly, or via any other module or template using it, annotates a link with a short description containing no spaces, the page containing the annotation will be added to [[:Category:Pages displaying short descriptions with no spaces via Module:AnnotatedLink]].}}

== Usage ==

<pre><nowiki>{{#invoke:AnnotatedLink|main

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

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

Line 90 ⟶ 89:

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 ===

In the event that the page name provided is for a nonexistent page, and the module is directed to search for an explicit short description for the page, it will add the page transcluding the annotation to [[:Category:Pages displaying redlinks processed by Module:AnnotatedLink]]. 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.

=== Module:GetShortDescription parameters ===