Module:Annotated link/doc: Difference between revisions

Revision as of 13:56, 6 February 2023

Revision as of 01:01, 8 February 2023

Line 3:

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

{{info|This module is invoked by {{tlx|annotated link}}.}}

{{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:AnnotatedLinkAnnotated link]].}}

== Usage ==

Line 88:

=== 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:AnnotatedLinkAnnotated 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:AnnotatedLinkAnnotated 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.