Module:Main

Revision as of 17:55, 1 October 2024 by Pcoombe (talk | contribs) (refactor to use a shared fallback_pages function)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Documentation

get_appeal

Includes the best localised appeal subpage of Template:Appeal, based on appeal name, language, and country given. Also passes the parameters to the selected appeal template for their use (e.g. in localising amounts with {{AppealAmountSwitch}})

Parameters:

  • appeal - initial "Appeal-" (which was required for older links) is stripped off if present
  • language
  • country
  • Any other parameters to pass through to the appeal template (e.g. sitename)

Example:

{{#invoke:Main|get_appeal|appeal=Alan|country=CA|language=fr}}

Replaces {{2012FR/Switch/Appeal}}

get_infobox

Does basically the same thing for subpages of Template:Infobox

Replaces {{2012FR/Switch/Infobox}}

get_tax_message

Code should be fairly self explanatory. Allows overriding the default message for certain countries.

page_language

Return the language code of the current subpage. If it isn't a subpage, or isn't a valid language code, return 'en'.


-- Single utility module. Break this into separate modules if it gets too large.

local p = {} -- p stands for package

-- Given an array of titles as strings, check them in order and return the first page which exists
function p.fallback_pages( list )
	for key, value in ipairs( list ) do
		local p = mw.title.new( value )
		if p.exists then
			return p
		end
	end
end

function p.get_appeal( frame )

    local appeal_name = string.gsub( frame.args.appeal , 'Appeal%-', '' )
    local language = frame.args.language
    local country = frame.args.country
    
    local page = p.fallback_pages({
    	'Template:Appeal/' .. appeal_name .. '/' .. language .. '/' .. country,
		'Template:Appeal/' .. appeal_name .. '/' .. language,
		'Template:Appeal/' .. appeal_name .. '/en',
		'Template:Appeal/default/' .. language,
		'Template:Appeal/default/en'
    })

    local expanded = frame:expandTemplate{ title = page, args = frame.args }
    return expanded

end

function p.get_infobox( frame )

    local infobox_name = frame.args.infobox
    local language = frame.args.language
    local country = frame.args.country
    
    local page = p.fallback_pages({
    	'Template:Infobox/' .. infobox_name .. '/' .. language .. '/' .. country,
		'Template:Infobox/' .. infobox_name .. '/' .. language,
		'Template:Infobox/' .. infobox_name .. '/en',
		'Template:Infobox/Default/' .. language,
		'Template:Infobox/Default/en'
    })

    local expanded = frame:expandTemplate{ title = page, args = frame.args }
    return expanded

end

function p.get_tax_message( frame )

    local tax_message = frame.args.tax_message
    local language = frame.args.language
    local country = frame.args.country
    local page

    if ( country == 'US' ) then
        page = mw.title.new( 'Template:Tax/LinkOnly' )
    else
    	page = p.fallback_pages({
    		'Template:Tax/' .. tax_message .. '/' .. language, -- custom message
			'Template:Tax/' .. country .. '/' .. language, -- special countries e.g. FR/NL
			'Template:Tax/Default/' .. language,
			'Template:Tax/LinkOnly'
    	})
    end

    local expanded = frame:expandTemplate{ title = page, args = frame.args }
    return expanded
    
end

function p.page_language( frame )

    local full_title = mw.title.getCurrentTitle().prefixedText
    local t = mw.text.split( full_title, '/' )
    local lang = t[#t]

    if mw.language.isKnownLanguageTag( lang ) then
        return lang
    else
        return 'en'
    end

end

return p