Documentation for this module may be created at Module:Cargobox song/doc
--------------------------
-- Module for [[Template:Cargobox Song]]
------------------------
local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local builder = require('Module:CargoboxBuilder')
local constants = require('Module:Constants')
local utils = require('Module:Utilities')
local cargo = mw.ext.cargo
local p = {}
local categories = ""
local function formatImage(image_name)
return string.format("[[File:%s|220px]]", image_name)
end
local function formatUnits(units)
if units then
local split_units = mw.text.split(units, ';')
return table.concat(split_units, "<br>")
end
return nil
end
local function formatNames(names)
if names then
local split_names = utils.split(names, ",")
for i,v in ipairs(split_names) do
split_names[i] = v:match( "^%s*(.-)%s*$" )
end
return table.concat(split_names, "<br>")
end
return nil
end
local function formatMv(mv)
local val = yesno(mv, nil)
-- probably should not use == with bool, but this is more explicit
if val == true then
return '✓'
elseif val == false then
return '✗'
end
return nil
end
local function getMvCss(mv)
local val = yesno(mv, nil)
-- probably should not use == with bool, but this is more explicit
if val == true then
return {
['background-color'] = 'lightgreen',
['font-weight'] = 'bold'
}
elseif val == false then
return {
['background-color'] = 'pink',
['font-weight'] = 'bold'
}
end
return nil
end
local function formatCommissioned(comm)
local val = yesno(comm, nil)
if val == true then
return 'Yes'
elseif val == false then
return 'No'
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 = {
['text-align'] = 'center',
['color'] = '#FFFFFF',
['border-radius'] = '5px',
['background-color'] = constants.get_difficulty_color(v)
}
}
)
end
return row
end
function p.main(frame)
local args = getArgs(frame, { wrappers = { 'Template:Cargobox song' } })
local infobox = builder.new();
infobox:setName('Cargobox song')
:setWidth("330px")
:setParams{
{ name = 'song name', field = 'song_name', default = mw.title.getCurrentTitle().text },
{ name = 'image', func = formatImage, field = 'image', default = 'Dummyalbumart.png' },
{ name = 'image alt', func = formatImage },
{ name = 'japanese', field = 'japanese' },
{ name = 'romaji', field = 'romaji' },
{ name = 'english', field = 'english' },
{ name = 'singer', field = 'singer', func = formatNames },
{ name = 'producer', field = 'producer', func = formatNames },
{ name = 'unit', field = 'unit', func = formatUnits },
{ name = 'arranger', field = 'arranger', func = formatNames },
{ name = 'composer', field = 'composer', func = formatNames },
{ name = 'lyricist', func = formatNames },
{ name = 'commissioned', field = 'commissioned', func = formatCommissioned },
{ name = 'bpm', field = 'bpm' },
{ name = 'duration', field = 'duration' },
{ name = 'date', field = 'date' },
{ name = '3d mv', field = '3d_mv', func = formatMv },
{ name = '2d mv', field = '2d_mv', func = formatMv },
{ name = 'original mv', field = 'original_mv', func = formatMv },
{ name = 'easy difficulty', field = 'easy_difficulty' },
{ name = 'normal difficulty', field = 'normal_difficulty' },
{ name = 'hard difficulty', field = 'hard_difficulty' },
{ name = 'expert difficulty', field = 'expert_difficulty' },
{ name = 'master difficulty', field = 'master_difficulty' },
{ name = 'easy notes', field = 'easy_notes' },
{ name = 'normal notes', field = 'normal_notes' },
{ name = 'hard notes', field = 'hard_notes' },
{ name = 'expert notes', field = 'expert_notes' },
{ name = 'master notes', field = 'master_notes' },
}
:setArgs(args)
:setTable('Songs')
:setWhere('Songs.song_id = ' .. (args['song id'] or 0))
infobox
:addHeader({ tag = 'argth', content = 'song name' })
:addImage(
{
{ tag = 'argtd', content = 'image', title = 'Original' },
{ tag = 'argtd', content = 'image alt', title = 'Alternate' }
}
)
:addRow(
{
{ tag = 'th', content = 'Japanese', colspan = 12 },
{ tag = 'argtd', content = 'japanese', colspan = 18 }
},
{ hideIfEmpty = { 'japanese' } }
)
:addRow(
{
{ tag = 'th', content = 'Romaji', colspan = 12 },
{ tag = 'argtd', content = 'romaji', colspan = 18 }
},
{ hideIfEmpty = { 'romaji' } }
)
:addRow(
{
{ tag = 'th', content = 'English', colspan = 12 },
{ tag = 'argtd', content = 'english', colspan = 18 }
},
{ hideIfEmpty = { 'english' } }
)
:addHeader({ tag = 'th', content = 'Song Information' }, { subheader = true })
:addRow(
{
{ tag = 'th', content = 'Original Singer(s)', colspan = 12 },
{ tag = 'argtd', content = 'singer', colspan = 18 }
},
{ hideIfEmpty = { 'singer' } }
)
:addRow(
{
{ tag = 'th', content = 'Producer(s)', colspan = 12 },
{ tag = 'argtd', content = 'producer', colspan = 18 }
}
)
:addHeader({ tag = 'th', content = 'In-game Information' }, { subheader = true })
:addRow(
{
{ tag = 'th', content = 'Unit(s)', colspan = 12 },
{ tag = 'argtd', content = 'unit', colspan = 18 }
}
)
:addRow(
{
{ tag = 'th', content = 'Arranger(s)', colspan = 12 },
{ tag = 'argtd', content = 'arranger', colspan = 18 }
},
{ hideIfEmpty = { 'arranger' } }
)
:addRow(
{
{ tag = 'th', content = 'Composer(s)', colspan = 12 },
{ tag = 'argtd', content = 'composer', colspan = 18 }
},
{ hideIfEmpty = { 'composer' } }
)
:addRow(
{
{ tag = 'th', content = 'Lyricist(s)', colspan = 12 },
{ tag = 'argtd', content = 'lyricist', colspan = 18 }
},
{ hideIfEmpty = { 'lyricist' } }
)
:addRow(
{
{ tag = 'th', content = 'Commissioned', colspan = 12 },
{ tag = 'argtd', content = 'commissioned', colspan = 18 }
}
)
:addRow(
{
{ tag = 'th', content = 'BPM', colspan = 12 },
{ tag = 'argtd', content = 'bpm', colspan = 18 }
}
)
:addRow(
{
{ tag = 'th', content = 'Duration', colspan = 12 },
{ tag = 'argtd', content = 'duration', colspan = 18 }
}
)
:addRow(
{
{ tag = 'th', content = 'Release Date', colspan = 12 },
{ tag = 'argtd', content = 'date', colspan = 18 }
}
)
:addHeader({ tag = 'th', content = 'Music Video' }, { subheader = true })
:addRow(
{
{ tag = 'th', content = '3D' },
{ tag = 'th', content = '2D' },
{ tag = 'th', content = 'Original' }
},
{ default_css = { ['text-align'] = 'center' } }
)
:addRow(
{
{ tag = 'argtd', content = '3d mv', param_css = { getMvCss } },
{ tag = 'argtd', content = '2d mv', param_css = { getMvCss } },
{ tag = 'argtd', content = 'original mv', param_css = { getMvCss } }
},
{ default_css = { ['text-align'] = 'center' } }
)
:addHeader({ tag = 'th', content = 'Difficulties' }, { subheader = true })
:addRow(difficultiesRow())
: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' }
},
{ default_css = { ['text-align'] = 'center' } }
)
:addHeader({ tag = 'th', content = 'Notes' }, { subheader = true })
:addRow(difficultiesRow())
: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' }
},
{ default_css = { ['text-align'] = 'center' } }
)
if mw.title.getCurrentTitle().namespace == 0 then
categories = "[[Category:Songs]]" .. categories
local procVals = infobox:getVals('processed')
local cargoVals = infobox:getVals('cargo')
if cargoVals['unit'] then
local units = mw.text.split(cargoVals['unit'], ',')
for i,v in ipairs(units) do
local unit = constants.get_unit(mw.text.trim(v))
if unit then
categories = categories .. "[[Category:" .. unit .. " songs]]"
elseif v == 'other' then
categories = categories .. "[[Category:Other songs]]"
end
end
end
if yesno(cargoVals['commissioned'], nil) then
categories = categories .. "[[Category:Commissioned songs]]"
end
if yesno(cargoVals['3d mv'], nil) then
categories = categories .. "[[Category:Songs with 3D MV]]"
end
if yesno(cargoVals['2d mv'], nil) then
categories = categories .. "[[Category:Songs with 2D MV]]"
end
if yesno(cargoVals['original mv'], nil) then
categories = categories .. "[[Category:Songs with Original MV]]"
end
end
return infobox:tostring().. categories
end
return p