Module:GetShortDescription/doc සඳහා මුලාශ්‍රය නරඹන්න

පහත හේතුව නිසා, ඔබ හට මෙම පිටුව සංස්කරණය කරන්න සඳහා අවසර නොමැත:

Your IP address is in a range that has been blocked on all Wikimedia Foundation wikis.

The block was made by ‪EPIC‬. The reason given is Open proxy/Webhost: See the help page if you are affected.

Start of block: 08:48, 2 ජූලි 2024
Expiry of block: 08:48, 2 ජූලි 2025

Your current IP address is 206.189.44.186. The blocked range is 206.189.32.0/20.

Please include all above details in any queries you make. If you believe you were blocked by mistake, you can find additional information and instructions in the No open proxies global policy.

Otherwise, to discuss the block please post a request for review on Meta-Wiki. You could also send an email to the stewards VRT queue at stewards@wikimedia.org including all above details.

මෙම පිටුවෙහි මූලාශ්‍රය නැරඹීමට හා පිටපත් කිරීමට ඔබ හට හැකිය.

{{Module rating|protected}}
{{High-use}}
{{Lua|Module:Arguments|Module:Lang}}
{{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]].}}

== Usage ==
<code><nowiki>{{#invoke:GetShortDescription|main |name= |only= |prefer= |fallback= |lang_italic= |lang_nocat= |lang_size= |lang_cat= |lang_rtl= |lang_no= }}</nowiki></code>
	
=== name ===
By providing only the '''required''' page name (including namespace), the module will look for an explicit {{tlx|short description}} in that page, but if not found, will try to fetch the wikidata description. If neither are found, the result will be an empty string.

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=Wikipedia}}</nowiki></code>
:'''Result:''' {{#invoke:GetShortDescription|main|name=Wikipedia}}
This is equivalent to stating {{para|prefer|explicit}}; see [[#prefer]] (below).

=== only ===
Providing a value for {{para|only}} will limit the search to being only for the stated description. If no description is found, the result will be an empty string, unless a fallback is provided; see [[#fallback]] (below).

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

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

=== prefer ===
Providing a value for {{para|prefer}} will initiate the search for the stated description, but try for the alternative if none is found. If no description is found, the result will be an empty string, unless a fallback is provided; see [[#fallback]] (below).

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

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

=== fallback ===
If a value for {{para|fallback}} is provided, and no description is found by the expressed route, the result will be the stated fallback.

==== only or fallback ====
:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription|main |name=Example |only=explicit |fallback=This is a fallback }}</nowiki></code>
:'''Result:''' {{#invoke:GetShortDescription|main|name=Example|only=explicit|fallback=This is a fallback}}

==== prefer or fallback ====
:'''Markup:''' <code><nowiki>{{#invoke:GetShortDescription|main |name=Example |prefer=wikidata |fallback=This is a fallback }}</nowiki></code>
:'''Result:''' {{#invoke:GetShortDescription|main|name=Example|prefer=wikidata|fallback=This is a fallback}}

=== Foreign language wikidata descriptions ===
Should a wikidata description be retrieved, which is declared (at the source) as being of a foreign language (i.e. not ''en''), per [[MOS:OTHERLANG]], the return will be formatted as appropriate by Module:Lang by default. This may be disabled with {{para|lang_no|yes}} or adjusted via the parameters for {{tlc|lang}}: {{para|lang_italic}}, {{para|lang_nocat}}, {{para|lang_size}}, {{para|lang_cat}} and {{para|lang_rtl}}; see [[Template:Lang/doc|lang's documentation]] for details.

== Requiring this module ==
=== 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]].

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

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

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

    objectify_alarm = true,
    report_redlinks = true,

    lang_no = 'yes',

    -- {{lang}} options
    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 type( short_description ) == 'table' then
  if short_description.alarm then
    -- An alarming message has been returned
    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 descriptions]]

}}</includeonly>

මෙම පිටුවෙහි භාවිත සැකිලි:

Module:GetShortDescription/doc වෙත නැවත යන්න.

"https://si.wikipedia.org/wiki/Module:GetShortDescription/doc" වෙතින් සම්ප්‍රවේශනය කෙරිණි