Module:File
From FamiWiki
Documentation for this module may be created at Module:File/doc
local f = {}
function f.main(frame)
local result = {}
local game = frame:getParent().args["game"] or ""
local description = frame:getParent().args["description"] or ""
local type = mw.ustring.lower(frame:getParent().args["type"] or "")
local meta = mw.ustring.lower(frame:getParent().args["meta"] or "")
local user = frame:getParent().args["user"] or ""
local source = frame:getParent().args["source"] or nil
local license = frame:getParent().args["license"] or nil
local resized = frame:getParent().args["resized"] or nil
local youtube = frame:getParent().args["youtube"] or nil
local fandom = frame:getParent().args["fandom"] or nil
function TEXT(X)
local artwork = "Artwork"
local audio = "Audio"
local animated = "Animated image"
local music = "Music"
local boxart = "Box artwork"
local cartridge = "Cartridge"
local conceptart = "Concept artwork"
local commercial = "Commercial"
local css = "<span style='color: red'>This image is used within the site's [[MediaWiki:Common.css|CSS stylesheet]]. This file should not be moved or modified without first checking how it will affect the CSS.</span>"
local diagram = "Diagram"
local flag = "Flag"
local icon = "Icon"
local logo = "Logo"
local map = "Map"
local photo = "Real-world photo"
local prerelease = "Pre-release image"
local person = "Real life person"
local publication = "Publication"
local rating = "Rating icon"
local texture = "Texture"
local screenshot = "Screenshot"
local titlescreen = "Title screen"
local sprite = "Sprite"
local system = "System images"
local user = "Personal file"
local template = "Template image"
local video = "Video"
local wallpaper = "Wallpaper"
local wiki = "FamiWiki image"
local main = "Game image"
local mainimage = "Game image"
local none = "<span style='color: red'>Error: Invalid type entered, please</span> [[Module:File/doc|consult the list of types]]."
local t = {}
t = {
['2d'] = artwork,
['2dart'] = artwork,
['2d art'] = artwork,
['2d artwork'] = artwork,
['art'] = artwork,
['artwork'] = artwork,
['art work'] = artwork,
['anim'] = animated,
['animated'] = animated,
['animation'] = animated,
['animated image'] = animated,
['animated images'] = animated,
['animated img'] = animated,
['gif'] = animated,
['music'] = music,
['song'] = music,
['songs'] = music,
['audio'] = audio,
['sound'] = audio,
['voice clip'] = audio,
['voice'] = audio,
['flag'] = flag,
['box'] = boxart,
['boxart'] = boxart,
['boxartwork'] = boxart,
['box art'] = boxart,
['box artwork'] = boxart,
['cartridge'] = cartridge,
['cart'] = cartridge,
['conceptart'] = conceptart,
['conceptartwork'] = conceptart,
['concept art'] = conceptart,
['concept artwork'] = conceptart,
['early art'] = conceptart,
['early artwork'] = conceptart,
['earlyart'] = conceptart,
['earlyartwork'] = conceptart,
['button'] = control,
['buttons'] = control,
['control'] = control,
['controller'] = control,
['controller button'] = control,
['joystick'] = control,
['controllerphoto'] = controllerphoto,
['controller photo'] = controllerphoto,
['controlphoto'] = controllerphoto,
['control photo'] = controllerphoto,
['commercial'] = commercial,
['css'] = css,
['site styling'] = css,
['sitestyling'] = css,
['diagram'] = diagram,
['graph'] = diagram,
['graphs'] = diagram,
['chart'] = diagram,
['ico'] = icon,
['icon'] = icon,
['icons'] = icon,
['logo'] = logo,
['logomark'] = logo,
['logos'] = logo,
['logotype'] = logo,
['wordmark'] = logo,
['map'] = map,
['maps'] = map,
['main'] = main,
['mainimage'] = mainimage,
['mainimages'] = mainimage,
['photo'] = photo,
['photos'] = photo,
['photography'] = photo,
['reallife'] = photo,
['real life'] = photo,
['prerelease'] = prerelease,
['pre-release'] = prerelease,
['p-r'] = prerelease,
['beta'] = prerelease,
['person'] = person,
['real person'] = person,
['human person'] = person,
['people'] = person,
['real people'] = person,
['article'] = publication,
['book'] = publication,
['journal'] = publication,
['magazine'] = publication,
['manuscript'] = publication,
['newspaper'] = publication,
['publication'] = publication,
['publications'] = publication,
['cero'] = rating,
['esrb'] = rating,
['pegi'] = rating,
['rating'] = rating,
['ratings'] = rating,
['prtscr'] = screenshot,
['printscreen'] = screenshot,
['print screen'] = screenshot,
['scr'] = screenshot,
['screen'] = screenshot,
['screenshot'] = screenshot,
['scrshot'] = screenshot,
['screen shot'] = screenshot,
['pixelart'] = sprite,
['pixel art'] = sprite,
['sprite'] = sprite,
['sprites'] = sprite,
['sys'] = system,
['sysimg'] = system,
['system'] = system,
['system image'] = system,
['system images'] = system,
['template'] = template,
['texture'] = texture,
['titlescreen'] = titlescreen,
['title screen'] = titlescreen,
['ts'] = titlescreen,
['title'] = titlescreen,
['personal'] = user,
['personal img'] = user,
['personal image'] = user,
['user'] = user,
['userimg'] = user,
['user image'] = user,
['video'] = video,
['videos'] = video,
['famiwiki'] = wiki,
['wiki'] = wiki,
['wallpaper'] = wallpaper,
['wall paper'] = wallpaper,
['screensaver'] = wallpaper,
['background'] = wallpaper,
}
if not t[X]
then return none
else return t[X]
end
end
function CAT(X,Y)
if Y == true then Y = game .. ' ' else Y = "" end
local artwork = "[[Category:".. Y .."artwork]]"
local animated = "[[Category:".. Y .."animated images]]"
local music = "[[Category:".. Y .."music]]"
local audio = "[[Category:".. Y .."audio]]"
local boxart = "[[Category:".. Y .."box artwork]]"
local cartridge = "[[Category:".. Y .."cartridge images]]"
local commercial = "[[Category:".. Y .."Commercials]]"
local control = "[[Category:".. Y .."controller icons]]"
local controllerphoto = "[[Category:".. Y .."Controller photos]]"
local conceptart = "[[Category:".. Y .."concept artwork]]"
local css = "[[Category:Images used in site styling]]"
local diagram = "[[Category:".. Y .."diagrams]]"
local icon = "[[Category:".. Y .."icons]]"
local flag = "[[Category:".. Y .."flags]]"
local logo = "[[Category:".. Y .."logos]]"
local main = "[[Category:".. Y .."]]"
local mainimage = "[[Category:".. Y .."images]]"
local map = "[[Category:".. Y .."maps]]"
local prerelease = "[[Category:".. Y .."pre-release images]]"
local photo = "[[Category:".. Y .."real life images]]"
local person = "[[Category:Real people images]]"
local publication = "[[Category:".. Y .."publication images]]"
local rating = "[[Category:".. Y .."rating icons]]"
local screenshot = "[[Category:".. Y .."screenshots]]"
local titlescreen = "[[Category:".. Y .."title screens]]"
local sprite = "[[Category:".. Y .."sprites]]"
local system = "[[Category:".. Y .."system images]]"
local texture = "[[Category:".. Y .."textures]]"
local user = "[[Category:".. Y .."User images]]"
local template = "[[Category:".. Y .."Template images]]"
local video = "[[Category:".. Y .."videos]]"
local wiki = "[[Category:".. Y .."Wiki images]]"
local wallpaper = "[[Category:".. Y .."wallpapers]]"
local none = "[[Category:Files with invalid types]]"
local t = {}
t = {
['2d'] = artwork,
['2dart'] = artwork,
['2d art'] = artwork,
['2d artwork'] = artwork,
['art'] = artwork,
['artwork'] = artwork,
['art work'] = artwork,
['anim'] = animated,
['animated'] = animated,
['animation'] = animated,
['animated image'] = animated,
['animated images'] = animated,
['animated img'] = animated,
['gif'] = animated,
['music'] = music,
['song'] = music,
['songs'] = music,
['audio'] = audio,
['sound'] = audio,
['voice clip'] = audio,
['voice'] = audio,
['flag'] = flag,
['box'] = boxart,
['boxart'] = boxart,
['boxartwork'] = boxart,
['box art'] = boxart,
['box artwork'] = boxart,
['cartridge'] = cartridge,
['cart'] = cartridge,
['conceptart'] = conceptart,
['conceptartwork'] = conceptart,
['concept art'] = conceptart,
['concept artwork'] = conceptart,
['early art'] = conceptart,
['early artwork'] = conceptart,
['earlyart'] = conceptart,
['earlyartwork'] = conceptart,
['button'] = control,
['buttons'] = control,
['control'] = control,
['controller'] = control,
['controller button'] = control,
['joystick'] = control,
['controllerphoto'] = controllerphoto,
['controller photo'] = controllerphoto,
['controlphoto'] = controllerphoto,
['control photo'] = controllerphoto,
['css'] = css,
['site styling'] = css,
['sitestyling'] = css,
['diagram'] = diagram,
['graph'] = diagram,
['graphs'] = diagram,
['chart'] = diagram,
['ico'] = icon,
['icon'] = icon,
['icons'] = icon,
['logo'] = logo,
['logomark'] = logo,
['logos'] = logo,
['logotype'] = logo,
['wordmark'] = logo,
['map'] = map,
['maps'] = map,
['main'] = main,
['mainimage'] = mainimage,
['mainimages'] = mainimage,
['photo'] = photo,
['photos'] = photo,
['photography'] = photo,
['reallife'] = photo,
['real life'] = photo,
['prerelease'] = prerelease,
['pre-release'] = prerelease,
['p-r'] = prerelease,
['beta'] = prerelease,
['person'] = person,
['real person'] = person,
['human person'] = person,
['people'] = person,
['real people'] = person,
['article'] = publication,
['book'] = publication,
['journal'] = publication,
['magazine'] = publication,
['manuscript'] = publication,
['newspaper'] = publication,
['publication'] = publication,
['publications'] = publication,
['cero'] = rating,
['esrb'] = rating,
['pegi'] = rating,
['rating'] = rating,
['ratings'] = rating,
['prtscr'] = screenshot,
['printscreen'] = screenshot,
['print screen'] = screenshot,
['scr'] = screenshot,
['screen'] = screenshot,
['screenshot'] = screenshot,
['scrshot'] = screenshot,
['screen shot'] = screenshot,
['pixelart'] = sprite,
['pixel art'] = sprite,
['sprite'] = sprite,
['sprites'] = sprite,
['sys'] = system,
['sysimg'] = system,
['system'] = system,
['system image'] = system,
['system images'] = system,
['template'] = template,
['texture'] = texture,
['titlescreen'] = titlescreen,
['title screen'] = titlescreen,
['ts'] = titlescreen,
['title'] = titlescreen,
['personal'] = user,
['personal img'] = user,
['personal image'] = user,
['user'] = user,
['userimg'] = user,
['user image'] = user,
['video'] = video,
['videos'] = video,
['commercial'] = commercial,
['famiwiki'] = wiki,
['wiki'] = wiki,
['wallpaper'] = wallpaper,
['wall paper'] = wallpaper,
['screensaver'] = wallpaper,
['background'] = wallpaper,
}
if not t[X]
then return none
else return t[X]
end
end
function SRC(X)
local myself = "Media created by the uploader"
local user2 = "Media created by [[user:".. user .."|".. user .."]]"
local fandom = "FANDOM image [[Category:FANDOM sourced images]]"
local youtube = "YouTube image [[Category:YouTube sourced images]]"
local presskit = "Press kit image [[Category:Non-public press kit images]]"
local missing = "<span style='color: red'>''This file is missing a source.''</span>[[Category:Missing source]]"
local prima = "This file has been taken from a Prima guide. [[Category:Prima source files]]"
local t = {}
t = {
['me'] = myself,
['my'] = myself,
['myself'] = myself,
['self'] = myself,
['Me'] = myself,
['My'] = myself,
['Myself'] = myself,
['Self'] = myself,
['other'] = user2,
['someone'] = user2,
['someone else'] = user2,
['user'] = user2,
['Other'] = user2,
['Someone'] = user2,
['Someone else'] = user2,
['User'] = user2,
['gamepedia'] = fandom,
['fandom'] = fandom,
['wikia'] = fandom,
['gamefaqs'] = fandom,
['Gamepedia'] = fandom,
['Fandom'] = fandom,
['Wikia'] = fandom,
['Gamefaqs'] = fandom,
['GameFAQs'] = fandom,
['youtube'] = youtube,
['yt'] = youtube,
['Youtube'] = youtube,
['YT'] = youtube,
['YouTube'] = youtube,
['kit'] = presskit,
['press'] = presskit,
['presskit'] = presskit,
['press kit'] = presskit,
['Kit'] = presskit,
['Press'] = presskit,
['Presskit'] = presskit,
['Press kit'] = presskit,
['Prima Official Starter Guide'] = prima,
['Prima Guide'] = prima,
['prima guide'] = prima,
['prima official starter guide'] = prima,
['Prima'] = prima,
['prima'] = prima,
}
if source and source ~= "" then
if not t[X] then
return X
else return t[X]
end
else return missing
end
end
function LIC(X)
local ccbysa10 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-sa/1.0/deed.en Creative Commons Attribution-ShareAlike 1.0]''' license.''[[Category:Media licensed under CC BY-SA 1.0]]"
local ccby20 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by/2.0/deed.en Creative Commons Attribution 2.0]''' license.''[[Category:Media licensed under CC BY-SA 2.0]]"
local ccbysa21jp = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-sa/2.1/jp/deed.en Creative Commons Attribution-ShareAlike 2.1 Japan]''' license.''[[Category:Media licensed under CC BY-SA 2.1]]"
local ccby25 = "''This file is distributed under the '''[http://creativecommons.org/licenses/by/2.5/deed.en Creative Commons Attribution 2.5]''' license.''[[Category:Media licensed under CC BY 2.5]]"
local ccbysa25 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-sa/2.5/deed.en Creative Commons Attribution-ShareAlike 2.5]''' license.''[[Category:Media licensed under CC BY-SA 2.5]]"
local ccby30 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by/3.0/deed.en Creative Commons Attribution 3.0]''' license.''[[Category:Media licensed under CC BY 3.0]]"
local ccbync30 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution Non-Commercial 3.0]''' license.''[[Category:Media licensed under CC BY-NC 3.0]]"
local ccbysa30 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-sa/3.0/deed.en Creative Commons Attribution-ShareAlike 3.0]''' license.''[[Category:Media licensed under CC BY-SA 3.0]]"
local ccbysa40 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-sa/4.0/deed.en Creative Commons Attribution-ShareAlike 4.0]''' license.''[[Category:Media licensed under CC BY-SA 4.0]]"
local lgpl = "This library is free software; you can redistribute it and/or modify it under the terms of the '''[[wikipedia:GNU Lesser General Public License|GNU Lesser General Public License]]''' as published by the [[wikipedia:Free Software Foundation|Free Software Foundation]]; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See [http://www.gnu.org/licenses/lgpl.html the GNU Lesser General Public License] for more details."
local pd = "''This file has been released into the '''[[Wikipedia:Public domain|public domain]]''' by the copyright holder, its copyright has expired, or it is ineligible for copyright. This applies worldwide.''[[Category:Media released to public domain]]"
local pds = "''This file has been released into the '''[[Wikipedia:Public domain|public domain]]''' by the uploading user. This applies worldwide.''[[Category:Media released to public domain]]"
local fairuse = "''This file is subject to [[FamiWiki:Copyrights|copyright]]. Copyright is most likely held by the company that published the game or the media portrayed. FamiWiki's use of this work qualifies as '''fair use''' under '''[[Wikipedia:Fair use#U.S. fair use factors|United States copyright law]]''', or the author's permission is given. It is used on the wiki only in the belief that the information the file portrays is designed to be an accompaniment to playing the game or media, and its use here will not:''<ol><li>''Detract from the experience of playing the game or using the media in question.''</li><li>''Harm the author's sales or reputation.''</li></ol>[[Category:Media assumed fair use]]"
local t = {}
t = {
['ccbysa10'] = ccbysa10,
['ccybysa1.0'] = ccbysa10,
['cc by sa 1.0'] = ccbysa10,
['cc-by-sa-1.0'] = ccbysa10,
['cc-by-sa 1.0'] = ccbysa10,
['ccby20'] = ccby20,
['ccyby2.0'] = ccby20,
['cc by 2.0'] = ccby20,
['cc-by-2.0'] = ccby20,
['cc-by 2.0'] = ccby20,
['ccbysa21jp'] = ccbysa21jp,
['ccybysa2.1jp'] = ccbysa21jp,
['cc by sa 2.1 jp'] = ccbysa21jp,
['cc-by-sa-2.1 jp'] = ccbysa21jp,
['cc-by-sa 2.1 jp'] = ccbysa21jp,
['cc-by-sa 2.1 japan'] = ccbysa21jp,
['ccby25'] = ccby25,
['ccyby2.5'] = ccby25,
['cc by 2.5'] = ccby25,
['cc-by-2.5'] = ccby25,
['cc-by-2.5'] = ccby25,
['ccbysa25'] = ccbysa25,
['ccybysa2.5'] = ccbysa25,
['cc by sa 2.5'] = ccbysa25,
['cc-by-sa-2.5'] = ccbysa25,
['cc-by-sa 2.5'] = ccbysa25,
['ccby30'] = ccbysa30,
['ccyby3.0'] = ccby30,
['cc by 3.0'] = ccby30,
['cc-by-3.0'] = ccby30,
['cc-by-3.0'] = ccby30,
['ccbysa30'] = ccbysa30,
['ccybysa3.0'] = ccbysa30,
['cc by sa 3.0'] = ccbysa30,
['cc-by-sa-3.0'] = ccbysa30,
['cc-by-sa 3.0'] = ccbysa30,
['ccbync30'] = ccbync30,
['ccybync3.0'] = ccbync30,
['cc by nc 3.0'] = ccbync30,
['cc-by-nc-3.0'] = ccbync30,
['cc-by-nc 3.0'] = ccbync30,
['ccbysa40'] = ccbysa40,
['ccybysa4.0'] = ccbysa40,
['cc by sa 4.0'] = ccbysa40,
['cc-by-sa-4.0'] = ccbysa40,
['cc-by-sa 4.0'] = ccbysa40,
['pd'] = pd,
['public'] = pd,
['publicdomain'] = pd,
['public domain'] = pd,
['lgpl'] = lgpl,
['GNU Lesser'] = lgpl,
['pds'] = pds,
['publicself'] = pds,
['publicdomain self'] = pds,
['public domain self'] = pds,
['public domain by myself'] = pds,
}
if not t[X]
then return fairuse
else return t[X]
end
end
local panel_type = ""
local panel_meta = ""
if not type or type == ""
then type = {}
else
type = mw.text.split(type, ',%s*')
for i = 1, #type do
type[i] = TEXT(type[i]) .. CAT(type[i],true)
end
if #type > 4
then panel_type = '<tr><th>Type(s)</th><td style="color: red">Way too many types!<br />Try using up to 4 types max.</td></tr>'
else panel_type = '<tr><th>Type(s)</th><td>'.. table.concat(type,", ") ..'</td></tr>'
end
end
if not meta or meta == ""
then meta = {}
else
meta = mw.text.split(meta, ',%s*')
for i = 1, #meta do
meta[i] = TEXT(meta[i]) .. CAT(meta[i],false)
end
if #meta > 4
then panel_meta = '<tr><th>Meta Type(s)</th><td style="color: red">Way too many types!<br />Try using up to 4 types max.</td></tr>'
else panel_meta = '<tr><th>Meta Type(s)</th><td>'.. table.concat(meta,", ") ..'</td></tr>'
end
end
local panel_game = '<tr><th>Game</th><td>[['.. game ..']]</td></tr>'
local panel_description = '<tr><th>Description</th><td>'.. description ..'</td></tr>'
local panel_user = '<tr><th>User</th><td>[[user:'.. user ..'|'.. user ..']]</td></tr>'
local panel_source = '<tr><th>Source</th><td>'.. SRC(source) ..'</td></tr>'
local panel_license = '<tr><th>License</th><td>'.. LIC(license) ..'</td></tr>'
local panel_resized = '<tr><th>Resized</th><td>This file has been resized.[[Category:Resized files]]</td></tr>'
local panel_youtube = '<tr><th>YouTube</th><td>This file has been taken from YouTube, and should be re-captured in-game when possible.[[Category:YouTube sourced images]]</td></tr>'
local panel_fandom = '<tr><th>FANDOM</th><td>This file has been taken from FANDOM (or a subsidiary) and should be re-captured as soon as possible.[[Category:FANDOM sourced images]]</td></tr>'
if game == "" then panel_game = "" end
if description == "" then panel_description = "" end
if user == "" then panel_user = "" end
if resized ~= "yes" then panel_resized = "" end
if youtube ~= "yes" then panel_youtube = "" end
if fandom ~= "yes" then panel_fandom = "" end
local panel = '<table class="wikitable" style="width: 100%"><tr><th colspan="2">File information</th></tr>'.. panel_game .. panel_description .. panel_type .. panel_meta .. panel_user .. panel_source .. panel_resized .. panel_youtube .. panel_fandom .. panel_license ..'</table>'
table.insert(result, panel)
return table.concat(result, "")
end
return f
