Module:GetShortDescription/doc - Revision history

Gonnym at 11:29, 29 August 2024

2024-08-29T11:29:42Z

← Previous revision		Revision as of 11:29, 29 August 2024
Line 104:		Line 104:

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->

	[[Category:Modules using data from Wikidata]]		[[Category:Modules using data from Wikidata]]
	[[Category:~~WikiProject~~ Short ~~descriptions~~]]		[[Category:Short description related modules]]
		⚫	}}</includeonly>

			<noinclude>
⚫	}}</includeonly>
			[[Category:Module documentation pages]]
			</noinclude>

Jonesey95: distinguish

2024-08-15T19:54:03Z

distinguish

← Previous revision		Revision as of 19:54, 15 August 2024
Line 1:		Line 1:
			{{distinguish\|Module:Get short description}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{High-use}}		{{High-use}}

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

2023-11-10T01:49:24Z

← Previous revision		Revision as of 01:49, 10 November 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
			{{High-use}}
	{{Lua\|Module:Arguments\|Module:Lang}}		{{Lua\|Module:Arguments\|Module:Lang}}
	{{info\|This module is required by [[Module:Annotated link]].}}		{{info\|This module is required by [[Module:Annotated link]].}}

Fred Gandt: update docs a bit

2023-02-08T16:01:51Z

update docs a bit

← Previous revision		Revision as of 16:01, 8 February 2023
Line 11:		Line 11:

	If the result is a wikidata description, and it is declared (at the source) as being of a foreign language (i.e. not ''en''), the result will be appropriately formatted by [[Module:Lang]] (the module powering {{tlx\|lang}}), in accordance with [[MOS:OTHERLANG]]; see [[#Foreign language wikidata descriptions]] (below).		If the result is a wikidata description, and it is declared (at the source) as being of a foreign language (i.e. not ''en''), the result will be appropriately formatted by [[Module:Lang]] (the module powering {{tlx\|lang}}), in accordance with [[MOS:OTHERLANG]]; see [[#Foreign language wikidata descriptions]] (below).
	:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=~~Example~~ }}</nowiki></code>		:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=Wikipedia}}</nowiki></code>
	:'''Result:''' {{#invoke:GetShortDescription\|main\|name=~~Example~~}}		:'''Result:''' {{#invoke:GetShortDescription\|main\|name=Wikipedia}}
	This is equivalent to stating {{para\|prefer\|explicit}}; see [[#prefer]] (below).		This is equivalent to stating {{para\|prefer\|explicit}}; see [[#prefer]] (below).

Line 19:		Line 19:

	==== explicit ====		==== explicit ====
	:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=~~Example~~ \|only=explicit }}</nowiki></code>		:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=Wikipedia \|only=explicit }}</nowiki></code>
	:'''Result:''' {{#invoke:GetShortDescription\|main\|name=~~Example~~\|only=explicit}}		:'''Result:''' {{#invoke:GetShortDescription\|main\|name=Wikipedia\|only=explicit}}

	==== wikidata ====		==== wikidata ====
	:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=~~Example~~ \|only=wikidata }}</nowiki></code>		:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=Wikipedia \|only=wikidata }}</nowiki></code>
	:'''Result:''' {{#invoke:GetShortDescription\|main\|name=~~Example~~\|only=wikidata}}		:'''Result:''' {{#invoke:GetShortDescription\|main\|name=Wikipedia\|only=wikidata}}

	=== prefer ===		=== prefer ===
Line 30:		Line 30:

	==== explicit or wikidata ====		==== explicit or wikidata ====
	:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=~~Example~~ \|prefer=explicit }}</nowiki></code>		:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=Wikipedia \|prefer=explicit }}</nowiki></code>
	:'''Result:''' {{#invoke:GetShortDescription\|main\|name=~~Example~~\|prefer=explicit}}		:'''Result:''' {{#invoke:GetShortDescription\|main\|name=Wikipedia \|prefer=explicit}}

	==== wikidata or explicit ====		==== wikidata or explicit ====
	:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=~~Example~~ \|prefer=wikidata }}</nowiki></code>		:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription\|main \|name=Wikipedia \|prefer=wikidata }}</nowiki></code>
	:'''Result:''' {{#invoke:GetShortDescription\|main\|name=~~Example~~\|prefer=wikidata}}		:'''Result:''' {{#invoke:GetShortDescription\|main\|name=Wikipedia \|prefer=wikidata}}

	=== fallback ===		=== fallback ===
Line 52:		Line 52:

	== Requiring this module ==		== Requiring this module ==
	=== ~~objectify_alarm~~ ~~and~~ ~~report_redlinks~~ ===		=== Instances when a table is returned ===
		⚫	Providing a value for {{para\|objectify_alarm}} will cause alarming messages (red informational messages) to be returned as [[mw:Extension:Scribunto/Lua reference manual#table\|tables]].
	'''For use via other modules'''; application of these options via template or direct invocation may cause the return of "table" as a string.

⚫	Providing a value for {{para\|objectify_alarm}} will cause alarming messages (red informational messages) to be returned as [[mw:Extension:Scribunto/Lua reference manual#table\|tables]]~~; this allows for a simple test instead of needing to parse the return value; see below for use case~~.

	Providing a value for {{para\|report_redlinks}} will cause the return of a report instead of nothing in the event that the page named is nonexistent (i.e. a [[WP:REDLINK]]) and a search for a {{tlc\|short description}} template is processed.		Providing a value for {{para\|report_redlinks}} will cause the return of a report instead of nothing in the event that the page named is nonexistent (i.e. a [[WP:REDLINK]]) and a search for a {{tlc\|short description}} template is processed.

			A table will also be returned in the event that the module is instructed to {{para\|prefer\|explicit}} (its default), and returns a Wikidata description. If the reason for there being no explicit short description is because it was set to ''[[WP:SDNONE\|none]]''; the table will include a value for <code>table.none</code>

			See below for examples of these behaviors:

	<syntaxhighlight lang="lua">local getShortDescription = require( 'Module:GetShortDescription' ).main		<syntaxhighlight lang="lua">local getShortDescription = require( 'Module:GetShortDescription' ).main
Line 83:		Line 85:
	} )		} )

	-- if we've requested to report_redlinks or to objectify_alarm then		-- If we've requested to report_redlinks or to objectify_alarm then
	if type( short_description ) == 'table' then		if type( short_description ) == 'table' then
	if short_description.alarm then		if short_description.alarm then
	-- An alarming message has been returned		-- An alarming message has been returned
	~~return~~ short_description.alarm		local alarming_message = short_description.alarm
	elseif short_description.redlink then		elseif short_description.redlink then
	-- Do something about that		-- Do something about that
			elseif short_description.wikidata then
			-- A Wikidata description was returned without being explicitly requested
			local wikidata_description = short_description.wikidata
			if short_description.none then
			-- Because the explicit short desc was 'none'
			end
	end		end
	end</syntaxhighlight>		end</syntaxhighlight>

Fred Gandt: updated module name

2023-02-04T18:17:50Z

updated module name

← Previous revision		Revision as of 18:17, 4 February 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{Lua\|Module:Arguments\|Module:Lang}}		{{Lua\|Module:Arguments\|Module:Lang}}
	{{info\|This module is required by [[Module:~~AnnotatedLink~~]].}}		{{info\|This module is required by [[Module: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:GetShortDescription]].}}		{{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:GetShortDescription]].}}

Fred Gandt: adding info for |report_redlinks=

2023-02-02T19:21:09Z

adding info for |report_redlinks=

← Previous revision		Revision as of 19:21, 2 February 2023
Line 52:		Line 52:

	== Requiring this module ==		== Requiring this module ==
	=== objectify_alarm ===		=== objectify_alarm and report_redlinks ===
	'''For use via other modules'''; application of ~~this~~ ~~option~~ via template or direct invocation ~~will~~ return "table" ~~instead of the~~ ~~alarming~~ ~~message~~.		'''For use via other modules'''; application of these options via template or direct invocation may cause the return of "table" as a string.

	Providing a value for {{para\|objectify_alarm}} will cause alarming messages (red informational messages) to be returned as [[mw:Extension:Scribunto/Lua reference manual#table\|tables]]; this allows for a simple test instead of needing to parse the return value; see below for use case.		Providing a value for {{para\|objectify_alarm}} will cause alarming messages (red informational messages) to be returned as [[mw:Extension:Scribunto/Lua reference manual#table\|tables]]; this allows for a simple test instead of needing to parse the return value; see below for use case.

			Providing a value for {{para\|report_redlinks}} will cause the return of a report instead of nothing in the event that the page named is nonexistent (i.e. a [[WP:REDLINK]]) and a search for a {{tlc\|short description}} template is processed.

	<syntaxhighlight lang="lua">local getShortDescription = require( 'Module:GetShortDescription' ).main		<syntaxhighlight lang="lua">local getShortDescription = require( 'Module:GetShortDescription' ).main
Line 61:		Line 63:
	local short_description = getShortDescription( {		local short_description = getShortDescription( {
	-- required		-- required
	name = 'page name',		name = 'page name',

	-- optional		-- optional
	prefer = 'explicit' or 'wikidata',		prefer = 'explicit' or 'wikidata',
	only = 'explicit' or 'wikidata',		only = 'explicit' or 'wikidata',
	fallback = 'fallback',		fallback = 'fallback',

⚫	~~objectify_alarm~~ = 'yes',
	~~lang_no~~ = ~~'yes'~~,		objectify_alarm = true,
			report_redlinks = true,

		⚫	lang_no = 'yes',

	-- ~~optional~~ {{lang}} options		-- {{lang}} options
	lang_italic = <yes, no, unset, invert, default>,		lang_italic = <yes, no, unset, invert, default>,
	lang_nocat = <yes, y, true, t, on, 1>,		lang_nocat = <yes, y, true, t, on, 1>,
	lang_size = <CSS font-size e.g. '1.5em'>,		lang_size = <CSS font-size e.g. '1.5em'>,
	lang_cat = <no, n, false, f, off, 0>,		lang_cat = <no, n, false, f, off, 0>,
	lang_rtl = <no (default), yes>		lang_rtl = <no (default), yes>
	} )		} )

			-- if we've requested to report_redlinks or to objectify_alarm then
	-- If objectify_alarm was true...
	if type( short_description ) == 'table' then		if type( short_description ) == 'table' then
		⚫	if short_description.alarm then
	-- An alarming message has been returned		-- An alarming message has been returned
⚫	~~return~~ short_description.alarm
			return short_description.alarm
			elseif short_description.redlink then
			-- Do something about that
			end
	end</syntaxhighlight>		end</syntaxhighlight>

Fred Gandt: {{Module rating|protected}}

2023-02-02T11:46:43Z

← Previous revision		Revision as of 11:46, 2 February 2023
Line 1:		Line 1:
	{{Module rating\|~~beta~~}}		{{Module rating\|protected}}
	{{Lua\|Module:Arguments\|Module:Lang}}		{{Lua\|Module:Arguments\|Module:Lang}}
	{{info\|This module is required by [[Module:AnnotatedLink]].}}		{{info\|This module is required by [[Module:AnnotatedLink]].}}

Fred Gandt: /* Requiring this module */ also truthy

2023-02-01T04:19:35Z

Requiring this module: also truthy

← Previous revision		Revision as of 04:19, 1 February 2023
Line 68:		Line 68:
	fallback = 'fallback',		fallback = 'fallback',
	objectify_alarm = 'yes',		objectify_alarm = 'yes',
	lang_no = ~~true or false~~,		lang_no = 'yes',

	-- optional {{lang}} options		-- optional {{lang}} options

Fred Gandt: /* objectify_alarm */ truthy option

2023-02-01T04:16:52Z

objectify_alarm: truthy option

← Previous revision		Revision as of 04:16, 1 February 2023
Line 67:		Line 67:
	only = 'explicit' or 'wikidata',		only = 'explicit' or 'wikidata',
	fallback = 'fallback',		fallback = 'fallback',
	objectify_alarm = ~~true or false~~,		objectify_alarm = 'yes',
	lang_no = true or false,		lang_no = true or false,

Fred Gandt: alter docs inline with alteration of module; now using Module:Arguments (again)

2023-02-01T03:47:11Z

alter docs inline with alteration of module; now using Module:Arguments (again)

← Previous revision		Revision as of 03:47, 1 February 2023
Line 1:		Line 1:
	{{Module rating\|beta}}		{{Module rating\|beta}}
	{{Lua\|Module:Lang}}		{{Lua\|Module:Arguments\|Module:Lang}}
	{{info\|This module is required by [[Module:AnnotatedLink]].}}		{{info\|This module is required by [[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:GetShortDescription]].}}		{{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:GetShortDescription]].}}
Line 60:		Line 60:

	local short_description = getShortDescription( {		local short_description = getShortDescription( {
			-- required
	args = {
	-- ~~required~~		name = 'page name',
	name = 'page name',

	-- optional		-- optional
	prefer = 'explicit' or 'wikidata',		prefer = 'explicit' or 'wikidata',
	only = 'explicit' or 'wikidata',		only = 'explicit' or 'wikidata',
	fallback = 'fallback',		fallback = 'fallback',
	objectify_alarm = true or false,		objectify_alarm = true or false,
	lang_no = true or false,		lang_no = true or false,

	-- optional {{lang}} options		-- optional {{lang}} options
	lang_italic = <yes, no, unset, invert, default>,		lang_italic = <yes, no, unset, invert, default>,
	lang_nocat = <yes, y, true, t, on, 1>,		lang_nocat = <yes, y, true, t, on, 1>,
	lang_size = <CSS font-size e.g. '1.5em'>,		lang_size = <CSS font-size e.g. '1.5em'>,
	lang_cat = <no, n, false, f, off, 0>,		lang_cat = <no, n, false, f, off, 0>,
	lang_rtl = <no (default), yes>		lang_rtl = <no (default), yes>
	}
	} )		} )