Module:NewDYKnomination/sandbox2 explained

-- This module implements .

local lang = mw.language.getContentLanguage

--------------------------------------------------------------------------------- Output template-------------------------------------------------------------------------------

-- This template contains the final output of the module. Parameters like-- $ are substituted with the results of the output template-- parameter functions below.

local OUTPUT_TEMPLATE = [=[ {{DYKsubpage |monthyear=${MONTH_AND_YEAR} |passed=<!--When closing discussion, enter yes, no, or withdrawn --> |2=${INPUT_ERRORS} {{DYK conditions}} {{DYK header|${HEADING}}} {{DYK nompage links|nompage=${NOM_SUBPAGE}|${NOMPAGE_LINK_ARGS}}} ${IMAGE}${DYK_LISTEN}${DYK_WATCH}<!-- Please do not edit above this line unless you are a DYK volunteer who is closing the discussion. --> * ${HOOK}${ALT_HOOKS}${REVIEWED}${COMMENT} <small>${STATUS} by ${AUTHORS}. ${NOMINATED} at ~~~~~.</small> <!--${CHECK_CREDITS_WARNING} ${CREDITS} --> :* <!-- REPLACE THIS LINE TO WRITE FIRST COMMENT, KEEPING :* --> ${FILE_BREAK}}}<!--Please do not write below this line or remove this line. Place comments above this line.-->]=]

--------------------------------------------------------------------------------- Helper functions-------------------------------------------------------------------------------

-- Creates a formatted error message that can be used with substitution.local function formatError(msg) return string.format('', msg)end

-- Creates a boilerplate error message for invalid titles.local function formatInvalidTitleError(page, pageType) local msg = string.format('"%s" is not a valid %s; check for bad characters', page, pageType ) return formatError(msg)end

-- Same as . If the page is an invalid title, returns nil.local function getRootPageText(page) local title = mw.title.new(page) if title then return title.rootPageTitle.text endend

-- Makes template invocations for templates like and-- .local function makeFileTemplateInvocation(name, first, second) if not first then return nil end local ret = ret[#ret + 1] = '' return table.concat(ret)end

-- Normalize positional parameters for a template invocation. If any of the-- parameters contain equals signs, the parameters are all prefixed with-- numbers.local function normalizeTemplateParameters(params) local ret = local hasEquals = false for i, param in ipairs(params) do if param:find('=') then hasEquals = true break end end if hasEquals then for i, param in ipairs(params) do ret[i] = string.format('%d=%s', i, param) end else for i, param in ipairs(params) do ret[i] = param end end return retend

-- Makes a link to a user's user page and talk page, like found in a standard-- signature.local function makeUserLinks(user) return string.format('%s (talk)', user, user, user )end

-- Returns an array of authors. If the user didn't specify any authors, the-- first one is the result of .local function getNormalisedAuthors(data) local authors = for i, author in ipairs(data.authors) do authors[i] = author end authors[1] = authors[1] or data.revisionUser return authorsend

-- Removes gaps from sparse arrays. This is used to process numbered arguments-- like author2 and ALT4.local compressSparseArray = require("Module:TableTools").compressSparseArray

-- Splits numbered arguments by their prefixes. A table of arguments like this:-- -- Would be turned into this:-- -- Note that the subtables of the returned tables are not normal arrays, but-- sparse arrays (there can be gaps between values).local function splitByPrefix(args) local ret = for key, val in pairs(args) do if type(key)

'string' then local prefix, num = key:match('^(.-)([1-9][0-9]*)$') if prefix then num = tonumber(num) ret[prefix] = ret[prefix] or ret[prefix][num] = val end end end return retend

-- Returns an array of numbered arguments with the given prefixes. Earlier-- prefixes have precedence, and args[prefix] will overwrite args[prefix .. 1].-- For example, for this arguments table:-- -- The function call getPrefixedArgs(args, splitArgs,)-- will produce:-- ---- Parameters:-- args - the table of arguments specified by the user-- splitArgs - the table of arguments as processed by splitByPrefix-- prefixes - an array of prefixeslocal function getPrefixedArgs(args, splitArgs, prefixes) local ret = for i, prefix in ipairs(prefixes) do if splitArgs[prefix] then for num, val in pairs(splitArgs[prefix]) do if not ret[num] then ret[num] = val end end end end -- Allow prefix to overwrite prefix1. for _, prefix in ipairs(prefixes) do local val = args[prefix] if val then ret[1] = val break end end return compressSparseArray(ret)end

--------------------------------------------------------------------------------- Output template parameter functions-------------------------------------------------------------------------------

-- The results of these functions are substituted into parameters in the-- output template. The parameters look like $. Trying to use-- a parameter that doesn't have a function defined here will result in an-- error.---- The functions take a data table as a single argument. This table contains-- the following fields:-- * errors - a table of formatted error messages that were found when-- processing the input.-- * args - the table of arguments supplied by the user.-- * articles - an array of the article names found in the arguments.-- * authors - an array of the expanders/creators/writers/authors found in the-- arguments.-- * revisionUser - the user that last edited the page. As this module is only-- substitited, this is always the current user.-- * alts - an array of the ALT hooks found in the arguments.-- * title - the mw.title object for the current page.---- Template parameter functions should return a string, false, or nil.-- Functions returning false or nil will be treated as outputting the empty-- string "".

local params =

-- Renders any errors that were found when processing the input.function params.INPUT_ERRORS(data) local nErrors = #data.errors if nErrors > 1 then return '\n* ' .. table.concat(data.errors, '\n* ') elseif nErrors

1 then return '\n' .. data.errors[1] endend

-- The current month and year, e.g. "March 2015".function params.MONTH_AND_YEAR return lang:formatDate('F Y')end

-- The contents of the heading.function params.HEADING(data) return table.concat(data.articles, ', ')end

-- The current subpage name.function params.NOM_SUBPAGE(data) if string.match(data.title.text,"/") then return string.gsub(data.title.text,data.title.rootText .. "/","") else return data.title.text endend

-- Other arguments for the nompage link template, separated by pipes.function params.NOMPAGE_LINK_ARGS(data) local vals = normalizeTemplateParameters(data.articles) return table.concat(vals, '|')end

-- All of the image display code.function params.IMAGE(data) local args = data.args if not args.image then return nil end local image = getRootPageText(args.image) if not image then image = formatInvalidTitleError(args.image, 'image name') end local caption = args.caption or args.rollover local template = [=[ <div style="float:right; margin-left:0.5em;" id="mp-dyk-img"> {{main page image|image=%s|caption=%s|width=120 <!-- Use 120 for vertical images, 140 for square images, and 160 for horizontal images-->}}<!--See [[Template:Main page image]] for other parameters-->