Module:Annotated link/doc - Revision history

Musiconeologist: More specific category

2025-04-06T17:59:48Z

More specific category

← Previous revision		Revision as of 17:59, 6 April 2025
Line 138:		Line 138:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->		<!-- Categories below this line; interwikis at Wikidata -->
	[[Category:~~WikiProject~~ Short ~~descriptions~~]]		[[Category:Short description related modules]]
	[[Category:Link modules]]		[[Category:Link modules]]
	}}</includeonly>		}}</includeonly>

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:14:12Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:14, 29 August 2024
Line 141:		Line 141:
	[[Category:Link modules]]		[[Category:Link modules]]
	}}</includeonly>		}}</includeonly>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Andrybak: Category:Link modules

2024-06-16T15:30:52Z

Category:Link modules

← Previous revision		Revision as of 15:30, 16 June 2024
Line 138:		Line 138:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->		<!-- Categories below this line; interwikis at Wikidata -->

	[[Category:WikiProject Short descriptions]]		[[Category:WikiProject Short descriptions]]
			[[Category:Link modules]]

	}}</includeonly>		}}</includeonly>

Habst: /* prefix_parentheses */ add note about current consensus

2024-01-02T17:13:56Z

prefix_parentheses: add note about current consensus

← Previous revision		Revision as of 17:13, 2 January 2024
Line 94:		Line 94:

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

Habst: add documentation for new optional prefix_parentheses parameter

2024-01-02T16:54:08Z

add documentation for new optional prefix_parentheses parameter

← Previous revision		Revision as of 16:54, 2 January 2024
Line 9:		Line 9:
	<pre><nowiki>{{#invoke:Annotated link\|main		<pre><nowiki>{{#invoke:Annotated link\|main

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

	\|link_lang= \|link_lang_italic= \|link_lang_nocat= \|link_lang_size= \|link_lang_cat= \|link_lang_rtl=		\|link_lang= \|link_lang_italic= \|link_lang_nocat= \|link_lang_size= \|link_lang_cat= \|link_lang_rtl=
Line 87:		Line 87:
	=== desc_first_letter_case ===		=== 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}}.		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.

	=== space_cat ===		=== space_cat ===

2600:1700:A2A0:FB50:E519:5980:B1A3:C1C3 at 01:40, 10 November 2023

2023-11-10T01:40:11Z

← Previous revision		Revision as of 01:40, 10 November 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
			{{High-use}}
	{{Lua\|Module:GetShortDescription\|Module:Arguments\|Module:Lang}}		{{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>		<includeonly>{{#ifeq:{{FULLBASEPAGENAME}}\|Module:AnnotatedLink\|{{important\|This module is redundant to [[Module:Annotated link]] which should be used and referred to instead.}}}}</includeonly>

John of Reading: /* space_cat */Typo fixing, replaced: the the → the

2023-03-12T16:16:47Z

space_cat: Typo fixing, replaced: the the → the

← Previous revision		Revision as of 16:16, 12 March 2023
Line 90:		Line 90:
	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.		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.		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 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.

	=== Module:GetShortDescription parameters ===		=== Module:GetShortDescription parameters ===

Fred Gandt: removed retired |red_cat= (more to do)

2023-02-12T20:25:56Z

removed retired |red_cat= (more to do)

← Previous revision		Revision as of 20:25, 12 February 2023
Line 8:		Line 8:
	<pre><nowiki>{{#invoke:Annotated link\|main		<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~~=		\|name= \|display= \|quote= \|abbr= \|abbr_title= \|template_link= \|aka= \|wedge= \|dash= \|desc_first_letter_case= \|space_cat=

	\|link_lang= \|link_lang_italic= \|link_lang_nocat= \|link_lang_size= \|link_lang_cat= \|link_lang_rtl=		\|link_lang= \|link_lang_italic= \|link_lang_nocat= \|link_lang_size= \|link_lang_cat= \|link_lang_rtl=
Line 91:		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.		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 ===		=== Module:GetShortDescription parameters ===

Fred Gandt: link fixes; a lot more actual work needs to be done when things settle down

2023-02-08T01:01:49Z

link fixes; a lot more actual work needs to be done when things settle down

← Previous revision		Revision as of 01:01, 8 February 2023
Line 3:		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>		<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 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:~~AnnotatedLink~~]].}}		{{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:Annotated link]].}}

	== Usage ==		== Usage ==
Line 88:		Line 88:

	=== space_cat ===		=== 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:~~AnnotatedLink~~]] 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.		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.		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 ===		=== 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:~~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.		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.		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.

Fred Gandt: "Module:{{BASEPAGENAME}}" --> "{{FULLBASEPAGENAME}}" derp

2023-02-06T13:56:32Z

"Module:{{BASEPAGENAME}}" --> "{{FULLBASEPAGENAME}}" *derp*

← Previous revision		Revision as of 13:56, 6 February 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:GetShortDescription\|Module:Arguments\|Module:Lang}}		{{Lua\|Module:GetShortDescription\|Module:Arguments\|Module:Lang}}
	<includeonly>{{#ifeq~~:Module~~:{{~~BASEPAGENAME~~}}\|Module:AnnotatedLink\|{{important\|This module is redundant to [[Module:Annotated link]] which should be used and referred to instead.}}}}</includeonly>		<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 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:AnnotatedLink]].}}		{{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]].}}

← Previous revision		Revision as of 01:40, 10 November 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
			{{High-use}}
	{{Lua\|Module:GetShortDescription\|Module:Arguments\|Module:Lang}}		{{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>		<includeonly>{{#ifeq:{{FULLBASEPAGENAME}}\|Module:AnnotatedLink\|{{important\|This module is redundant to [[Module:Annotated link]] which should be used and referred to instead.}}}}</includeonly>

← Previous revision		Revision as of 13:56, 6 February 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:GetShortDescription\|Module:Arguments\|Module:Lang}}		{{Lua\|Module:GetShortDescription\|Module:Arguments\|Module:Lang}}
	<includeonly>{{#ifeq~~:Module~~:{{~~BASEPAGENAME~~}}\|Module:AnnotatedLink\|{{important\|This module is redundant to [[Module:Annotated link]] which should be used and referred to instead.}}}}</includeonly>		<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 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:AnnotatedLink]].}}		{{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]].}}