Module:Infobox song

To generate {{Infobox song}}, invoke using the main function.

---

--------------------------
-- Module for [[Template:Infobox song]]
------------------------
local getArgs   = require('Module:Arguments').getArgs
local yesno     = require('Module:Yesno')
local builder   = require('Module:InfoboxBuilder new')
local constants = require('Module:Constants')
local utils     = require('Module:Utilities')
local VariablesLua = mw.ext.VariablesLua

local p = {}

local function convertToBoolOrNil(val)
	return yesno(val, nil)
end


local function formatJacket(jacket)
	return string.format("[[File:%s|220px]]", jacket)
end

local function formatList(list)
	if #list < 2 then
		return list[1]
	end
	
	local ul = mw.html.create('ul')
	
	for i=1,#list do
		ul:tag('li')
			:wikitext(list[i])
	end
	
	return tostring(ul)
end

local function formatCommissioned(comm)
	-- probably should not use == with bool, but this is more explicit
	if comm == true then
		return 'Yes'
	elseif comm == false then
		return 'No'
	end
	
	return nil
end

local function formatMv(mv)
	-- probably should not use == with bool, but this is more explicit
	if mv == true then
		return '✓'
	elseif mv == false then
		return '✗'
	end
	
	return nil
end

local function getMvClass(mv)
	-- probably should not use == with bool, but this is more explicit
	if mv == true then
		return 'true-cell'
	elseif mv == false then
		return 'false-cell'
	end
	
	return nil
end

local function difficultiesRow()
	local difficulties = { 'Easy', 'Normal', 'Hard', 'Expert', 'Master' }

	local row = {}
	
	for _,v in ipairs(difficulties) do
		table.insert(row,
			{
				content = v,
				tag = 'th',
				css = {	['border-bottom-color'] = constants.get_difficulty_color(v)	}
			}
		)
	end
	
	return row
end


function p.main(frame)
	local args = getArgs(frame)
	local infobox = builder.new();
	
	infobox:setName('Infobox song')
		:setParams{
			{ name = 'song id' },
			{ name = 'song name', default = mw.title.getCurrentTitle().text },
			{ name = 'jacket', dFunc = formatJacket, default = 'Dummyalbumart.png' },
			{ name = 'jacket alt', dFunc = formatJacket },
			{ name = 'japanese' },
			{ name = 'romaji' },
			{ name = 'english' },
			{ name = 'singers',   pFunc = utils.splitWithDelim(','), dFunc = formatList },
			{ name = 'producers', pFunc = utils.splitWithDelim(','), dFunc = formatList },
			{ name = 'duration' },
			{ name = 'units', pFunc = utils.splitWithDelim(';'), dFunc = formatList },
			{ name = 'unlock' },
			{ name = 'arrangers', pFunc = utils.splitWithDelim(','), dFunc = formatList },
			{ name = 'composers', pFunc = utils.splitWithDelim(','), dFunc = formatList },
			{ name = 'lyricists', pFunc = utils.splitWithDelim(','), dFunc = formatList },
			{ name = 'commissioned', pFunc = convertToBoolOrNil, dFunc = formatCommissioned },
			{ name = 'contest winner', pFunc = convertToBoolOrNil, default = false },
			{ name = 'bpm' },
			{ name = 'game duration' },
			{ name = 'date' },
			{ name = '3d mv',       pFunc = convertToBoolOrNil, dFunc = formatMv },
			{ name = '2d mv',       pFunc = convertToBoolOrNil, dFunc = formatMv },
			{ name = 'original mv', pFunc = convertToBoolOrNil, dFunc = formatMv },
			{ name = 'easy difficulty' },
			{ name = 'normal difficulty' },
			{ name = 'hard difficulty' },
			{ name = 'expert difficulty' },
			{ name = 'master difficulty' },
			{ name = 'easy notes' },
			{ name = 'normal notes' },
			{ name = 'hard notes' },
			{ name = 'expert notes' },
			{ name = 'master notes' },
		}
		:setArgs(args)
		:processArgs()
		:setCategoryMap({
			['units'] = {
				['VIRTUAL SINGER']       = 'VIRTUAL SINGER songs',
				['Leo/need']             = 'Leo/need songs',
				['MORE MORE JUMP!']      = 'MORE MORE JUMP! songs',
				['Vivid BAD SQUAD']      = 'Vivid BAD SQUAD songs',
				['Wonderlands×Showtime'] = 'Wonderlands×Showtime songs',
				['25-ji, Nightcord de.'] = '25-ji, Nightcord de. songs',
				['Other']                = 'Other songs'
			},
			['unlock'] = {
				['Automatic'] = 'Songs unlocked automatically',
				['Music Shop'] = 'Songs unlocked from the Music Shop',
				['Present Box'] = 'Songs unlocked from the Present Box',
			},
			['commissioned'] = {
				[true] = 'Commissioned songs',
			},
			['contest winner'] = {
				[true] = 'Contest winning songs'	
			},
			['3d mv'] = {
				[true] = 'Songs with 3D MV'
			},
			['2d mv'] = {
				[true] = 'Songs with 2D MV'
			},
			['original mv'] = {
				[true] = 'Songs with Original MV'
			},
		})

	infobox
		:addHeader({ tag = 'argth', content = 'song name' })
		:addImage(
			{
				{ tag = 'argtd', content = 'jacket',     tabName = 'Original' },
				{ tag = 'argtd', content = 'jacket alt', tabName = 'Alternate' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Japanese' },
				{ tag = 'argtd', content = 'japanese' }
			},
			{ hideIfEmpty = { 'japanese' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Romaji' },
				{ tag = 'argtd', content = 'romaji' }
			},
			{ hideIfEmpty = { 'romaji' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'English' },
				{ tag = 'argtd', content = 'english' }
			},
			{ hideIfEmpty = { 'english' } }
		)
		:addHeader({ tag = 'th', content = 'Song Information' }, { subheader = true })
		:addRow(
			{
				{ tag = 'th', content = 'Original singer(s)' },
				{ tag = 'argtd', content = 'singers' }
			},
			{ hideIfEmpty = { 'singers' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Producer(s)' },
				{ tag = 'argtd', content = 'producers' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Duration' },
				{ tag = 'argtd', content = 'duration' }
			},
			{ hideIfEmpty = { 'duration' } }
		)
		:addHeader({ tag = 'th', content = 'In-game Information' }, { subheader = true })
		:addRow(
			{
				{ tag = 'th', content = 'Song ID' },
				{ tag = 'argtd', content = 'song id' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Unit(s)' },
				{ tag = 'argtd', content = 'units' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'How to unlock' },
				{ tag = 'argtd', content = 'unlock' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Arranger(s)' },
				{ tag = 'argtd', content = 'arrangers' }
			},
			{ hideIfEmpty = { 'arrangers' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Composer(s)' },
				{ tag = 'argtd', content = 'composers' }
			},
			{ hideIfEmpty = { 'composers' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Lyricist(s)' },
				{ tag = 'argtd', content = 'lyricists' }
			},
			{ hideIfEmpty = { 'lyricists' } }
		)
		:addRow(
			{
				{ tag = 'th', content = 'Commissioned?' },
				{ tag = 'argtd', content = 'commissioned' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'BPM' },
				{ tag = 'argtd', content = 'bpm' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Duration (game)' },
				{ tag = 'argtd', content = 'game duration' }
			}
		)
		:addRow(
			{
				{ tag = 'th', content = 'Release date' },
				{ tag = 'argtd', content = 'date' }
			}
		)
		:addHeader({ tag = 'th', content = 'Music Video' }, { subheader = true })
		:addRow(
			{
				{ tag = 'th', content = '3D' },
				{ tag = 'th', content = '2D' },
				{ tag = 'th', content = 'Original' }
			},
			{ defaultCss = { ['text-align'] = 'center'	} }
		)
		:addRow(
			{
				{ tag = 'argtd', content = '3d mv', classFunc = getMvClass },
				{ tag = 'argtd', content = '2d mv', classFunc = getMvClass },
				{ tag = 'argtd', content = 'original mv', classFunc = getMvClass },
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
		:addHeader({ tag = 'th', content = 'Difficulties' }, { subheader = true })
		:addRow(
			difficultiesRow(),
			{
				defaultCss = { 
					['text-align'] = 'center',
					['border-bottom-style'] = 'solid' 
				}
			}
		)
		:addRow(
			{
				{ tag = 'argtd', content = 'easy difficulty' },
				{ tag = 'argtd', content = 'normal difficulty' },
				{ tag = 'argtd', content = 'hard difficulty' },
				{ tag = 'argtd', content = 'expert difficulty' },
				{ tag = 'argtd', content = 'master difficulty' }
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
		:addHeader({ tag = 'th', content = 'Notes' }, { subheader = true })
		:addRow(
			difficultiesRow(),
			{
				defaultCss = { 
					['text-align'] = 'center',
					['border-bottom-style'] = 'solid' 
				}
			}
		)
		:addRow(
			{
				{ tag = 'argtd', content = 'easy notes' },
				{ tag = 'argtd', content = 'normal notes' },
				{ tag = 'argtd', content = 'hard notes' },
				{ tag = 'argtd', content = 'expert notes' },
				{ tag = 'argtd', content = 'master notes' }
			},
			{ defaultCss = { ['text-align'] = 'center' } }
		)
	
	local categories = ""
	if mw.title.getCurrentTitle().namespace == 0 then
		categories = "[[Category:Songs]]" .. infobox:getCategories()
		
		local rawArgs = infobox:getRawArgs()
		VariablesLua.vardefine( 'song id', rawArgs['song id'] )
	end

	return infobox:tostring() .. categories
end

return p