Module:File

2025-08-20T15:01:37Z

Lakelimbo: Created page with "-- This is an updated version of Inkipedia's File module, less bloated and easier to add features if needed. In fact, the way it works might as well be used as a base/generic module for other things. -- local license = require("Module:File/Licenses") local f = {} local container = mw.html .create("table") :tag("tr") :tag("th") :attr({ ["colspan"] = 2 }) :css({ ["text-align"] = "center" }) :wikitext("File information") :done() :done() ---Will conv..."

--[[
This is an updated version of Inkipedia's File module, less bloated
and easier to add features if needed.
In fact, the way it works might as well be used as a base/generic module for
other things.
]]--

local license = require("Module:File/Licenses")

local f = {}
local container = mw.html
.create("table")
:tag("tr")
:tag("th")
:attr({
["colspan"] = 2
})
:css({
["text-align"] = "center"
})
:wikitext("File information")
:done()
:done()

---Will convert a string with some delimiter into an iterable array,
---trimming spaces as well.
---The default delimiter is a comma (`",%s*"`), but it's possible to
---change to something else.
---
---Examples:
--- "foo,bar,baz" -> { "foo", "bar", "baz" }
--- "green, Yellow ,Blue" -> { "green", "yellow", "blue" }
---
---@param str string
---@param delimiter string
---@return string[]
local function array_from_string(str, delimiter)
delimiter = delimiter or ",%s*"

if not str or #str == 0 then
return nil
end

local result = {}
local parts = mw.text.split(str, delimiter)

for _, s in ipairs(parts) do
table.insert(result, mw.text.trim(s))
end

return result
end

---Creates a row for an HTML table.
---Alongside with `rows.list()` down below, if it notices it's a one-dimensional
---table (array), likely from `array_from_string()`, it will split each element
---and add an appropriate space and comma to it.
---
---@param name string
---@content string | string[]
---@return table
local function table_row(name, content)
local row = container
:tag("tr")
:tag("th")
:wikitext(name)
:done()
:tag("td")

if type(content) == "table" then
for k, v in ipairs(content) do
if k == #content then
row:wikitext(v)
else
row:wikitext(v .. ", ")
end
end
else
row:wikitext(content)
end

row:done()
return row
end

---Error message for some elements, if needed.
---
---@type message
---@return string
local function error_message(message)
local span = mw.html.create("span")
:css({
["color"] = "red",
})
:wikitext(message)
:done()

return tostring(span)
end

---The list of elements to create a row.
---You can add any custom items with your own logic, as long as it returns
---`table_row()`.
---Even though on MW it's not necessary, it's good to adapt the parameter types
---if you happen to need something different other than args that have string
---values (e.g: `table<string, string | number>`).
---
---@type table<string, fun(content: string, args: table<string, string>)>
---@return table
local rows = {
list = function(content, args)
local lists = array_from_string(content)

if not lists or #lists == 0 then
return table_row(args.name, error_message(args.error))
end

for _, list in ipairs(lists) do
container:wikitext("[[Category:" .. list .. " files]]")
end

return table_row(args.name, lists)
end,
text = function(content, args)
local error = args.error or "Not provided"

if not content or content == "" then
content = "''" .. error .. "''"
end

table_row(args.name, content)
end,
}

function f.main(frame)
local param = frame.args

rows.list(param.work, { name = "Work", error = "ERROR: invalid or empty work" })
rows.text(param.description, { name ="Description" })
rows.list(param.author, { name = "Author", error = "ERROR: invalid author" })
rows.list(param.characters, { name = "Characters", error = "ERROR: invalid character" })
rows.text(param.source, { name = "Source" })
rows.text(license.get_license(param.license), { name = "License" })

return tostring(container)
end

return f

Module:File/Licenses

2025-08-20T15:01:07Z

Lakelimbo: Created page with "local l = {} ---The list of licenses. ---As you may see below (on the `l.get_license()` function), the key NEEDS to ---not have spaces, dashes, dots, or underscores. --- ---@type table<string, string> local licenses = { 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", ccby20 = "''This file is distributed..."

local l = {}

---The list of licenses.
---As you may see below (on the `l.get_license()` function), the key NEEDS to
---not have spaces, dashes, dots, or underscores.
---
---@type table<string, string>
local licenses = {
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]]",
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]]",
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]]",
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]]",
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]]",
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]]",
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]]",
ccbyncsa30 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by-nc-sa/3.0/ Creative Commons Attribution Non-Commercial 3.0]''' license.''[[Category:Media licensed under CC BY-NC-SA 3.0]]",
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]]",
ccby40 = "''This file is distributed under the '''[https://creativecommons.org/licenses/by/4.0/deed.en Creative Commons Attribution 4.0]''' license.''[[Category:Media licensed under CC BY 4.0]]",
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]]",
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.",
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]]",
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]]",
fairuse = "''This file is subject to [[Inkipedia:Copyrights|copyright]]. Copyright is most likely held by the company that published the game or the media portrayed. Inkipedia'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]]",
}

---Because licenses are important, the idea here is to prevent as much as possible
---any spacing issues, dashes, underscores, among others, when typing the license
---name.
---
---Examples:
--- "cc-by-sa" -> "ccbysa"
--- "fair use" -> "fairuse"
--- "LGp_l" -> "lgpl"
--- "cc BY-4.0" -> "ccby40"
---
---@param input string
---@return string | nil
function l.get_license(input)
if not input then
return nil
end

local license = input:lower():gsub("[^%w]", "")

return licenses[input]
end

return l

Splatoon Fanon - User contributions [en]

Module:File

Module:File/Licenses