Module:GetShortDescription/doc: Difference between revisions

Revision as of 04:16, 1 February 2023

Latest revision as of 11:29, 29 August 2024

(7 intermediate revisions by 3 users not shown)

Line 1:

{{distinguish|Module:Get rating|betashort description}}

{{Module rating|protected}}

{{High-use}}

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

{{info|This module is required by [[Module:AnnotatedLinkAnnotated 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]].}}

Line 11 ⟶ 13:

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 Wikipedia}}</nowiki></code>

:'''Result:''' {{#invoke:GetShortDescription|main|name=ExampleWikipedia}}

This is equivalent to stating {{para|prefer|explicit}}; see [[#prefer]] (below).

Line 19 ⟶ 21:

==== explicit ====

:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription|main |name=ExampleWikipedia |only=explicit }}</nowiki></code>

:'''Result:''' {{#invoke:GetShortDescription|main|name=ExampleWikipedia|only=explicit}}

==== wikidata ====

:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription|main |name=ExampleWikipedia |only=wikidata }}</nowiki></code>

:'''Result:''' {{#invoke:GetShortDescription|main|name=ExampleWikipedia|only=wikidata}}

=== prefer ===

Line 30 ⟶ 32:

==== explicit or wikidata ====

:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription|main |name=ExampleWikipedia |prefer=explicit }}</nowiki></code>

:'''Result:''' {{#invoke:GetShortDescription|main|name=ExampleWikipedia |prefer=explicit}}

==== wikidata or explicit ====

:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription|main |name=ExampleWikipedia |prefer=wikidata }}</nowiki></code>

:'''Result:''' {{#invoke:GetShortDescription|main|name=ExampleWikipedia |prefer=wikidata}}

=== fallback ===

Line 52 ⟶ 54:

== Requiring this module ==

=== Instances when a table is returned ===

=== objectify_alarm ===

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 this option via template or direct invocation will return "table" instead of the alarming message.

Providing a value for {{para|objectify_alarmreport_redlinks}} will cause alarmingthe messagesreturn (redof informationala messages)report toinstead beof returnednothing asin [[mw:Extension:Scribunto/Luathe referenceevent manual#table|tables]];that thisthe allowspage fornamed ais simplenonexistent test(i.e. insteada of[[WP:REDLINK]]) needingand toa parsesearch thefor returna value;{{tlc|short seedescription}} below fortemplate useis caseprocessed.

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

Line 61 ⟶ 67:

local short_description = getShortDescription( {

-- required

name = 'page name',

-- optional

prefer = 'explicit' or 'wikidata',

only = 'explicit' or 'wikidata',

fallback = 'fallback',

objectify_alarm = 'yes',

lang_no = true or false,

=== objectify_alarm === true,

-- optional {{lang}} options

report_redlinks = true,

lang_italic = <yes, no, unset, invert, default>,

lang_nocat = <yes, y, true, t, on, 1>,

objectify_alarm lang_no = 'yes',

lang_size = <CSS font-size e.g. '1.5em'>,

lang_cat = <no, n, false, f, off, 0>,

-- optional {{lang}} options

lang_rtl = <no (default), yes>

lang_italic = <yes, no, unset, invert, default>,

lang_nocat = <yes, y, true, t, on, 1>,

lang_size = <CSS font-size e.g. '1.5em'>,

lang_cat = <no, n, false, f, off, 0>,

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

returnif short_description.alarm then

-- An alarming message has been returned

return short_description.alarm

local alarming_message = short_description.alarm

elseif short_description.redlink then

-- 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</syntaxhighlight>

<includeonly>{{Sandbox other||

<!-- Categories below this line; interwikis at Wikidata -->

[[Category:Modules using data from Wikidata]]

[[Category:WikiProject Short descriptionsdescription related modules]]

}}</includeonly>

<noinclude>

[[Category:Module documentation pages]]

</noinclude>