Module:GetShortDescription - Revision history

Fred Gandt: applied coding conventions now I have to look at it less often

2023-02-15T20:29:21Z

applied coding conventions now I have to look at it less often

Fred Gandt: added indicator for explicit short descriptions being derived from the target of a redirected title

2023-02-12T17:52:24Z

added indicator for explicit short descriptions being derived from the target of a redirected title

← Previous revision		Revision as of 17:52, 12 February 2023
Line 68:		Line 68:
	local function getShortDescription( args_name, args_name_title_table, title, title_table, fallback )		local function getShortDescription( args_name, args_name_title_table, title, title_table, fallback )
	local contents_of_all_short_description_templates = {}		local contents_of_all_short_description_templates = {}
			local redirected

	-- Check for short description templates on redirect pages.		-- Check for short description templates on redirect pages.
Line 73:		Line 74:
	contents_of_all_short_description_templates = getShortDescriptionTemplates( args_name_title_table )		contents_of_all_short_description_templates = getShortDescriptionTemplates( args_name_title_table )
	if contents_of_all_short_description_templates.redlink then return contents_of_all_short_description_templates end		if contents_of_all_short_description_templates.redlink then return contents_of_all_short_description_templates end
			redirected = false
	end		end

	if #contents_of_all_short_description_templates < 1 then		if #contents_of_all_short_description_templates < 1 then
	contents_of_all_short_description_templates = getShortDescriptionTemplates( title_table )		contents_of_all_short_description_templates = getShortDescriptionTemplates( title_table )
			if notEmpty( redirected ) then redirected = true end
	end		end

Line 140:		Line 143:
	-- Pop!		-- Pop!
	local short_description = short_descriptions[ #short_descriptions ].description		local short_description = short_descriptions[ #short_descriptions ].description
	if notEmpty( short_description ) then return { explicit = short_description, fellback = fallback } end		if notEmpty( short_description ) then return { explicit = short_description, fellback = fallback, redirected = redirected } end
	end		end

Fred Gandt: so many changes: now output is tables unless optionally |stringify=true (tables good for other modules; strings good for templates) + multiple detection and report improvements + understands explicit "none" better

2023-02-12T03:38:22Z

so many changes: now output is tables unless optionally |stringify=true (tables good for other modules; strings good for templates) + multiple detection and report improvements + understands explicit "none" better

Show changes

Fred Gandt: now returning indication if an explicit none is falling back to wikidata

2023-02-07T23:48:37Z

now returning indication if an explicit none is falling back to wikidata

← Previous revision		Revision as of 23:48, 7 February 2023
Line 4:		Line 4:

	local function pipedLink( name ) return '[[:' .. name .. '\|' .. name .. ']]' end		local function pipedLink( name ) return '[[:' .. name .. '\|' .. name .. ']]' end

			local function isNone( desc ) return type( desc ) == 'string' and desc:match( '^[Nn]one$' ) end

	local function isEmpty( value ) return value == nil or value == '' end		local function isEmpty( value ) return value == nil or value == '' end
Line 36:		Line 38:
	if isEmpty( wikidata_id ) then return nil end		if isEmpty( wikidata_id ) then return nil end
	local wikidata_description, wikidata_description_lang = mw.wikibase.getDescriptionWithLang( wikidata_id )		local wikidata_description, wikidata_description_lang = mw.wikibase.getDescriptionWithLang( wikidata_id )
	if isEmpty( wikidata_description ) or ~~wikidata_description:match~~( ~~'^[Nn]one$'~~ ) then return nil end		if isEmpty( wikidata_description ) or isNone( wikidata_description ) then return nil end
	if isEmpty( lang.no ) and notEmpty( wikidata_description_lang ) and wikidata_description_lang ~= 'en' then		if isEmpty( lang.no ) and notEmpty( wikidata_description_lang ) and wikidata_description_lang ~= 'en' then
	wikidata_description = mLang._lang {		wikidata_description = mLang._lang {
Line 97:		Line 99:
	if not has_equals or param:match( '^1' ) then		if not has_equals or param:match( '^1' ) then
	if has_equals then param = mw.ustring.gsub( param, '^1%s=%s', '' ) end		if has_equals then param = mw.ustring.gsub( param, '^1%s=%s', '' ) end
	if not param:match( '^[Nn]one$' ) then
	-- If we made it this far; grab the short description.		-- If we made it this far; grab the short description.
	-- If the template has both a numbered and an unnumbered short description;		-- If the template has both a numbered and an unnumbered short description;
Line 104:		Line 105:
	-- But we want to know the total quantity of descriptions being declared.		-- But we want to know the total quantity of descriptions being declared.
	quantity_of_things.descriptions = quantity_of_things.descriptions + 1		quantity_of_things.descriptions = quantity_of_things.descriptions + 1
⚫	end
	end		end
	end		end
Line 171:		Line 171:
	}		}
	local result		local result

	if only == 'explicit' then result = getExplicitDescription( name )		if only == 'explicit' then result = getExplicitDescription( name )
	elseif only == 'wikidata' then result = getWikidataDescription( name, lang )		elseif only == 'wikidata' then result = getWikidataDescription( name, lang )
	elseif prefer == 'explicit' then result = getExplicitDescription( name ) or getWikidataDescription( name, lang, true )		elseif prefer == 'explicit' then
			result = getExplicitDescription( name )
			if isEmpty( result ) then result = getWikidataDescription( name, lang, true )
			elseif isNone( result ) then
⚫	elseif prefer == 'wikidata' then result = getWikidataDescription( name, lang ) or getExplicitDescription( name )
			local wikidata_description = getWikidataDescription( name, lang, true )
⚫	end
			if notEmpty( wikidata_description ) then
			wikidata_description.none = true
			result = wikidata_description
		⚫	end
		⚫	end
		⚫	elseif prefer == 'wikidata' then result = getWikidataDescription( name, lang ) or getExplicitDescription( name ) end

			if isNone( result ) then result = nil end

	return result or fallback		return result or fallback
	end		end

Fred Gandt: return wikidata descriptions as a table value when they're a fallback + improved logic for applying potential wikidata foreign language descriptions

2023-02-06T19:46:53Z

return wikidata descriptions as a table value when they're a fallback + improved logic for applying potential wikidata foreign language descriptions

← Previous revision		Revision as of 19:46, 6 February 2023
Line 1:		Line 1:

	local getArgs = require( 'Module:Arguments' ).getArgs		local getArgs = require( 'Module:Arguments' ).getArgs
	local mLang = require( 'Module:Lang' )		local mLang = require( 'Module:Lang' )
Line 31:		Line 32:
	end		end

	local function getWikidataDescription( name, lang )		local function getWikidataDescription( name, lang, not_explicit )
	local wikidata_id = mw.wikibase.getEntityIdForTitle( name )		local wikidata_id = mw.wikibase.getEntityIdForTitle( name )
	if isEmpty( wikidata_id ) then return nil end		if isEmpty( wikidata_id ) then return nil end
	local wikidata_description, wikidata_description_lang = mw.wikibase.getDescriptionWithLang( wikidata_id )		local wikidata_description, wikidata_description_lang = mw.wikibase.getDescriptionWithLang( wikidata_id )
	if isEmpty( wikidata_description ) or wikidata_description:match( '^[Nn]one$' ) then return nil end		if isEmpty( wikidata_description ) or wikidata_description:match( '^[Nn]one$' ) then return nil end
	if ~~notEmpty~~( lang.no ) or wikidata_description_lang == 'en' then ~~return wikidata_description end~~		if isEmpty( lang.no ) and notEmpty( wikidata_description_lang ) and wikidata_description_lang ~= 'en' then
		⚫	wikidata_description = mLang._lang {
	~~if isEmpty(~~ wikidata_description_lang ~~) then return nil end~~		wikidata_description_lang,
	return mLang._lang {
			wikidata_description,
	wikidata_description_lang,
		⚫	italic = lang.italic,
⚫	wikidata_description,
	~~italic~~ = lang.~~italic~~,		nocat = lang.nocat,
	~~nocat~~ = lang.~~nocat~~,		size = lang.size,
	~~size~~ = lang.~~size~~,		cat = lang.cat,
	~~cat~~ = lang.~~cat,~~		rtl = lang.rtl
			}
⚫	~~rtl~~ = lang.~~rtl~~
	}		end
			if notEmpty( not_explicit ) then wikidata_description = { wikidata = wikidata_description } end
			return wikidata_description
	end		end

Line 170:		Line 173:
	if only == 'explicit' then result = getExplicitDescription( name )		if only == 'explicit' then result = getExplicitDescription( name )
	elseif only == 'wikidata' then result = getWikidataDescription( name, lang )		elseif only == 'wikidata' then result = getWikidataDescription( name, lang )
	elseif prefer == 'explicit' then result = getExplicitDescription( name ) or getWikidataDescription( name, lang )		elseif prefer == 'explicit' then result = getExplicitDescription( name ) or getWikidataDescription( name, lang, true )
	elseif prefer == 'wikidata' then result = getWikidataDescription( name, lang ) or getExplicitDescription( name )		elseif prefer == 'wikidata' then result = getWikidataDescription( name, lang ) or getExplicitDescription( name )
	end		end

Fred Gandt: removed test logging

2023-02-05T22:28:50Z

removed test logging

← Previous revision		Revision as of 22:28, 5 February 2023
Line 181:		Line 181:
	local args = getArgs( frame )		local args = getArgs( frame )
	if isEmpty( args ) then return alarmingMessage( 'could not getArgs' ) end		if isEmpty( args ) then return alarmingMessage( 'could not getArgs' ) end
	~~local d =~~ getShortDescription( args ) or ''		return getShortDescription( args ) or ''
	mw.log( d )
	return d
	end		end

Fred Gandt: turns out Wikidata can return "none" as a description; filtering out

2023-02-05T22:27:13Z

turns out Wikidata can return "none" as a description; filtering out

← Previous revision		Revision as of 22:27, 5 February 2023
Line 35:		Line 35:
	if isEmpty( wikidata_id ) then return nil end		if isEmpty( wikidata_id ) then return nil end
	local wikidata_description, wikidata_description_lang = mw.wikibase.getDescriptionWithLang( wikidata_id )		local wikidata_description, wikidata_description_lang = mw.wikibase.getDescriptionWithLang( wikidata_id )
	if isEmpty( wikidata_description ) then return nil end		if isEmpty( wikidata_description ) or wikidata_description:match( '^[Nn]one$' ) then return nil end
	if notEmpty( lang.no ) or wikidata_description_lang == 'en' then return wikidata_description end		if notEmpty( lang.no ) or wikidata_description_lang == 'en' then return wikidata_description end
	if isEmpty( wikidata_description_lang ) then return nil end		if isEmpty( wikidata_description_lang ) then return nil end
Line 181:		Line 181:
	local args = getArgs( frame )		local args = getArgs( frame )
	if isEmpty( args ) then return alarmingMessage( 'could not getArgs' ) end		if isEmpty( args ) then return alarmingMessage( 'could not getArgs' ) end
	~~return~~ getShortDescription( args ) or ''		local d = getShortDescription( args ) or ''
			mw.log( d )
			return d
	end		end

Fred Gandt: added filter against unnecessary processing of sister project links

2023-02-05T14:23:05Z

added filter against unnecessary processing of sister project links

@@ Line 121: / Line 121: @@
 	if #short_descriptions >= 1 then return short_descriptions[ #short_descriptions ].description end
 	return nil
 end
@@ Line 128: / Line 155: @@
 	local name = args.name
 	if isEmpty( name ) then return alarmingMessage( 'requires a page name (including namespace)' ) end
-	local result
+	local fallback = args.fallback
 	local only = args.only
 	local lang = {
 		italic = args.lang_italic,
@@ Line 140: / Line 167: @@
 		no = args.lang_no
+	}
 	if only == 'explicit' then result = getExplicitDescription( name )
 	elseif only == 'wikidata' then result = getWikidataDescription( name, lang )
@@ Line 145: / Line 173: @@
 	elseif prefer == 'wikidata' then result = getWikidataDescription( name, lang ) or getExplicitDescription( name )
 	end
-	return result or args.fallback
+	return result or fallback
 end

Fred Gandt: + new_title = new_title.redirectTarget or new_title (resolve redirects)

2023-02-04T19:44:42Z

+ new_title = new_title.redirectTarget or new_title (resolve redirects)

← Previous revision		Revision as of 19:44, 4 February 2023
Line 51:		Line 51:
	local function getExplicitDescription( name )		local function getExplicitDescription( name )
	local new_title = mw.title.new( name )		local new_title = mw.title.new( name )
			new_title = new_title.redirectTarget or new_title
	local page_content = new_title:getContent()		local page_content = new_title:getContent()
	if isEmpty( page_content ) then		if isEmpty( page_content ) then

Fred Gandt: replaced unnecessary ustring.gmatch with string:gmatch

2023-02-03T11:03:56Z

replaced unnecessary ustring.gmatch with string:gmatch

← Previous revision		Revision as of 11:03, 3 February 2023
Line 59:		Line 59:
	local contents_of_all_short_description_templates = {}		local contents_of_all_short_description_templates = {}
	-- Because there could be any number of short description templates, and not all where there should be; get all the templates.		-- Because there could be any number of short description templates, and not all where there should be; get all the templates.
	for template in ~~mw.ustring.~~gmatch( ~~page_content,~~ '{%b{}}' ) do		for template in page_content:gmatch( '{%b{}}' ) do
	local short_description_content = mw.ustring.match( template, '^{{%s[Ss]hort description%s\|%s(.-)%s}}' )		local short_description_content = mw.ustring.match( template, '^{{%s[Ss]hort description%s\|%s(.-)%s}}' )
	if notEmpty( short_description_content ) then		if notEmpty( short_description_content ) then