Xenharmonic Wiki

Module:Dochead: Difference between revisions

← Older editNewer edit →
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
m remove test code
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
split main function into three
Line 61: Line 61:
end
end


-- Main function
-- Helper function
function p._dochead(args)
-- Creates an additional hatnote denoting which functions are invoked from which
local namespace = args["namespace"]
-- modules, if a has more than one invoke.
local pagename  = args["pagename" ]
local function make_invocation_hatnote(invokes)
local header    = args["header"  ] or "none"
local hatnote = ""
local corr_template = args["temp"] or ("Template:" .. pagename)
if #invokes == 0 then
local corr_module  = args["mod" ] or ("Module:"   .. pagename)
return ""
 
else
-- Normalize corresponding template/module to include their namespaces
hatnote = "This template invokes the following functions:"
if not corr_template:match("^Template:") then
local calls = {}
corr_template = "Template:" .. corr_template
for _, call in ipairs(invokes) do
end
table.insert(calls, string.format("'''%s''' from [[Module:%s]]", call.func, call.module))
if not corr_module:match("^Module:") then
end
corr_module = "Module:" .. corr_module
return string.format(":''%s %s''\n", hatnote, table.concat(calls, ", "))
end
 
-- If header is none, don't bother
if header == "none" then
return categorize(namespace, pagename)
end
end
end
-- Remove doc subpage if present
corr_template = corr_template:gsub("/doc$", "")
corr_module  = corr_module  :gsub("/doc$", "")
 
local result = ""
local has_template = page_exists(corr_template)
local has_module  = page_exists(corr_module)


-- Handle each header type first, then namespace, then if applicable,  
-- Helper function to handle modules
-- presence of a corresponding template or module.
function p.make_module_hatnote(header, corr_template, has_template)
if header == "dualuse" then
if header == "dualuse" then
-- A dual-use module MUST have a corresponding template; if not, say
if has_template then
-- it's missing.
return string.format(
-- A dual-use template MUST link to its corresponding module; if not,
"This module may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.",
-- say it's missing (even though it wouldn't work without its module).
corr_template
if namespace == "Module" then
)
if has_template then
result = string.format("This module may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.", corr_template)
else
result = string.format("This module has a template that is currently missing. [[Special:EditPage/%s]]", corr_template)
end
elseif namespace == "Template" then
if has_module then
result = string.format("This template is implemented by the Lua module [[%s]]. See its module page for Lua-based template implementation.", corr_module)
else
result = string.format("This template is implemented by a module that is currently missing. [[Special:EditPage/%s]]", corr_module)
end
else
else
result = "This template is in the wrong namespace. It should be within the Template or Module namespaces."
return string.format(
"This module has a template that is currently missing. [[Special:EditPage/%s]]",
corr_template
)
end
end


elseif header == "metatemplate" then
elseif header == "metatemplate" then
-- A metatemplate-implementing module does not necessarly need to have a
if has_template then
-- template (as infobox was this way before).
return string.format(
-- A metatemplate does not need to be made using Lua.
"This module implements a metatemplate, and may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.",
if namespace == "Module" then
corr_template
if has_template then
)
result = string.format("This module implements a metatemplate, and may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.", corr_template)
else
result = "This module is used to create other Lua-based templates and has no corresponding template."
end
elseif namespace == "Template" then
if has_module then
result = string.format("This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[%s]].", corr_module)
else
result = "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end
else
else
result = "This template is in the wrong namespace. It should be within the Template or Module namespaces."
return "This module is used to create other Lua-based templates and has no corresponding template."
end
end


elseif header == "noinvoke" then
elseif header == "noinvoke" then
-- A noinvoke module MUST have a corresponding template. Since this is
if has_template then
-- the default for modules, it should say it's missing a template if it
return string.format(
-- doesn't exist.
"This module should not be invoked directly; use its corresponding [[%s|template]] instead.",
-- This type doesn't work on templates, as those are non-Lua templates.
corr_template
if namespace == "Module" then
)
if has_template then
result = string.format("This module should not be invoked directly; use its corresponding [[%s|template]] instead.", corr_template)
else
result = string.format("This module implements a template that is currently missing. [[Special:EditPage/%s]]", corr_template)
end
else
else
result = "This template or its settings is in the wrong namespace. It should be used within the Module namespace."
return string.format(
"This module implements a template that is currently missing. [[Special:EditPage/%s]]",
corr_template
)
end
end


elseif header == "library" or header == "metamodule" then
elseif header == "library" or header == "metamodule" then
-- A metamodule should NOT have a corresponding template. This type only
return "This module primarily serves as a library for other modules and has no corresponding template."
-- works on modules.
 
if namespace == "Module" then
else
result = "This module primarily serves as a library for other modules and has no corresponding template."
if has_template and header ~= "" then
return string.format("%s. This module implements [[%s]].", header, corr_template)
elseif has_template and header == "" then
return string.format("This module implements [[%s]].", corr_template)
else
else
result = "This template or its settings is in the wrong namespace. It should be used within the Module namespace."
return header
end
end
end
end
-- Helper function to handle templates
function p.make_template_hatnote(header, corr_module, has_module)
if header == "dualuse" then
if has_module then
return string.format(
"This template is implemented by the Lua module [[%s]]. See its module page for Lua-based template implementation.",
corr_module
)
else
return string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/%s]]",
corr_module
)
end
elseif header == "metatemplate" then
if has_module then
return string.format(
"This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module [[%s]].",
corr_module
)
else
return "This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage."
end
elseif header == "noinvoke" or header == "library" or header == "metamodule" then
return "This template has a header option in the wrong namespace. It should be used within the Module namespace."


else
else
-- For any other case, just say that the module implements a template,
if has_module and header ~= "" then
-- or a template invokes a module's function.
return string.format("%s. This template is implemented by the Lua module [[%s]].", header, corr_module)
if namespace == "Module" then
elseif has_module and header == "" then
if has_template and header ~= "" then
return string.format("This template is implemented by the Lua module [[%s]].", corr_module)
result = string.format("%s. This module implements [[%s]].", header, corr_template)
elseif has_template and header == "" then
result = string.format("This module implements [[%s]].", corr_template)
else
result = header
end
elseif namespace == "Template" then
if has_module and header ~= ""  then
result = string.format("%s. This template is implemented by the Lua module [[%s]].", header, corr_module)
elseif has_module and header == "" then
result = string.format("This template is implemented by the Lua module [[%s]].", corr_module)
else
result = header
end
else
else
result = "This template is in the wrong namespace. It should be within the Template or Module namespaces."
return header
end
end
end
end
-- Main function
function p._dochead(args)
local namespace = args["namespace"]
local pagename  = args["pagename"]
local header    = args["header"] or "none"
local corr_template = args["temp"] or ("Template:" .. pagename)
local corr_module  = args["mod"]  or ("Module:"  .. pagename)
-- Normalize namespace prefixes
if not corr_template:match("^Template:") then
corr_template = "Template:" .. corr_template
end
if not corr_module:match("^Module:") then
corr_module = "Module:" .. corr_module
end
-- If header is none, skip everything
if header == "none" then
return categorize(namespace, pagename)
end
-- Remove /doc suffix, if this is on a /doc page
corr_template = corr_template:gsub("/doc$", "")
corr_module  = corr_module:gsub("/doc$", "")
-- Call appropriate hatnote-making function
local has_template = page_exists(corr_template)
local has_module  = page_exists(corr_module)
local result = ""
if namespace == "Module" then
result = p.make_module_hatnote(header, corr_template, has_template)
elseif namespace == "Template" then
result = p.make_template_hatnote(header, corr_module, has_module)
else
result = "This template is in the wrong namespace. It should be within the Template or Module namespaces."
end
end


-- Append categorization info to hatnote
-- Categorization and output
-- Check whether hatnote is blank; if so, don't bother with hatnote, just
-- output categories
local has_link = namespace == "Template" and has_module
local has_link = namespace == "Template" and has_module
if result == "" then
if result == "" then
Retrieved from "https://en.xen.wiki/w/Module:Dochead"