Module:Annotated link/doc: Difference between revisions

Revision as of 01:01, 8 February 2023

Revision as of 20:25, 12 February 2023

Line 8:

<pre><nowiki>{{#invoke:Annotated link|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 91:

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