Xenharmonic Wiki

Module:Dochead: Difference between revisions

← Older editNewer edit →
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
split main function into three
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
No edit summary
Line 1: Line 1:
-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
local getArgs = require("Module:Arguments").getArgs
local getArgs = require("Module:Arguments").getArgs
local iutils  = require("Module:Introspection utils")


local p = {}
local p = {}
Line 12: Line 13:
--  - whether a template has an accompanying module (overridable)
--  - whether a template has an accompanying module (overridable)
--  - what functions from which modules are invoked
--  - what functions from which modules are invoked
-- Options for specific types of templates and modules include:
-- - (TEMPLATES) whether it's a metatemplate
-- - (MODULES) whether it's a metamodule (used the same way as a metatemplate,
--  but direct use of module code is allowed)
-- Helper function
-- Detect whether a page exists, where fullpagename is "Namespace:Title"
local function page_exists(fullpagename)
local title = mw.title.new(fullpagename)
if title and title.exists then
return true
else
return false
end
end


-- Helper function
-- Helper function
Line 72: Line 56:
local calls = {}
local calls = {}
for _, call in ipairs(invokes) do
for _, call in ipairs(invokes) do
table.insert(calls, string.format("'''%s''' from [[Module:%s]]", call.func, call.module))
local module_link = iutils.make_module_link(call.module)
table.insert(calls, string.format("'''%s''' from %s", call.func, module_link))
end
end
return string.format(":''%s %s''\n", hatnote, table.concat(calls, ", "))
return string.format(":''%s %s''\n", hatnote, table.concat(calls, ", "))
Line 79: Line 64:


-- Helper function to handle modules
-- Helper function to handle modules
function p.make_module_hatnote(header, corr_template, has_template)
function p.make_module_hatnote(header, pagename, corr_template)
-- Check whether corresponding template exists
-- Then check whether it invokes the module
local has_template = iutils.page_exists(corr_template)
if has_template then
local wikitext = iutils.get_and_preprocess_content("Template", pagename)
has_template = has_template and iutils.invocation_exists(wikitext, pagename)
end
local result = ""
if header == "dualuse" then
if header == "dualuse" then
if has_template then
if has_template then
return string.format(
result = string.format(
"This module may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.",
"This module may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.",
corr_template
corr_template
)
)
else
else
return string.format(
result = string.format(
"This module has a template that is currently missing. [[Special:EditPage/%s]]",
"This module has a template that is currently missing or does not use this module. ([[Special:EditPage/%s | edit template]])",
corr_template
corr_template
)
)
Line 95: Line 89:
elseif header == "metatemplate" then
elseif header == "metatemplate" then
if has_template then
if has_template then
return string.format(
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.",
"This module implements a metatemplate, and may be invoked by templates using its corresponding [[%s|template]], or used directly from other modules.",
corr_template
corr_template
)
)
else
else
return "This module is used to create other Lua-based templates and has no corresponding template."
result = "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
if has_template then
if has_template then
return string.format(
result = string.format(
"This module should not be invoked directly; use its corresponding [[%s|template]] instead.",
"This module should not be invoked directly; use its corresponding [[%s|template]] instead.",
corr_template
corr_template
)
)
else
else
return string.format(
result = string.format(
"This module implements a template that is currently missing. [[Special:EditPage/%s]]",
"This module implements a template that is currently missing or does not use this module. ([[Special:EditPage/%s | edit template]])",
corr_template
corr_template
)
)
Line 117: Line 111:


elseif header == "library" or header == "metamodule" then
elseif header == "library" or header == "metamodule" then
return "This module primarily serves as a library for other modules and has no corresponding template."
result = "This module primarily serves as a library for other modules and has no corresponding template."


else
else
if has_template and header ~= "" then
if has_template and header ~= "" then
return string.format("%s. This module implements [[%s]].", header, corr_template)
result = string.format("%s. This module implements [[%s]].", header, corr_template)
elseif has_template and header == "" then
elseif has_template and header == "" then
return string.format("This module implements [[%s]].", corr_template)
result = string.format("This module implements [[%s]].", corr_template)
else
else
return header
result = header
end
end
end
end
return string.format(":''%s''\n", result)
end
end




-- Helper function to handle templates
-- Helper function to handle templates
function p.make_template_hatnote(header, corr_module, has_module)
function p.make_template_hatnote(header, pagename, corr_module)
-- Check whether corresponding module exists
-- Then check whether this template invokes the module
local has_module = iutils.page_exists(corr_module)
local wikitext = iutils.get_and_preprocess_content("Template", pagename)
local is_module_invoked = iutils.invocation_exists(wikitext, pagename)
 
-- Find all invocations for the template
local invokes = iutils.find_invokes(wikitext)
local invocation_hatnote = make_invocation_hatnote(invokes)
local result = ""
if header == "dualuse" then
if header == "dualuse" then
if has_module then
if has_module and is_module_invoked then
return string.format(
result = string.format(
"This template is implemented by the Lua module [[%s]]. See its module page for Lua-based template implementation.",
"This template is implemented by the Lua module [[%s]]. See its module page for Lua-based template implementation.",
corr_module
corr_module
)
elseif has_module and not is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[%s]] but does not use it. ([[Special:EditPage/%s | edit template]])",
corr_module,
"Template:" .. pagename
)
)
else
else
return string.format(
result = string.format(
"This template is implemented by a module that is currently missing. [[Special:EditPage/%s]]",
"This template is implemented by a module that is currently missing. [[Special:EditPage/%s]]",
corr_module
corr_module
Line 147: Line 160:


elseif header == "metatemplate" then
elseif header == "metatemplate" then
if has_module then
if has_module and is_module_invoked then
return string.format(
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]].",
"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
corr_module
)
elseif has_module and not is_module_invoked then
result = string.format(
"This metatemplate is implemented by the Lua module [[%s]] but does not use it. ([[Special:EditPage/%s | edit template]])",
corr_module,
"Template:" .. pagename
)
)
else
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."
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
end


elseif header == "noinvoke" or header == "library" or header == "metamodule" then
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."
result = "This template has a header option in the wrong namespace. It should be used within the Module namespace."


else
else
if has_module and header ~= "" then
if has_module and header ~= "" and is_module_invoked then
return string.format("%s. This template is implemented by the Lua module [[%s]].", header, corr_module)
result = string.format(
elseif has_module and header == "" then
"%s. This template is implemented by the Lua module [[%s]].",
return string.format("This template is implemented by the Lua module [[%s]].", corr_module)
header,
corr_module
)
elseif has_module and header ~= "" and not is_module_invoked then
result = string.format(
"%s. This template is implemented by the Lua module [[%s]] but does not use it. ([[Special:EditPage/%s | edit template]])",
header,
corr_module,
"Template:" .. pagename
)
elseif has_module and header == "" and is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[%s]].",
corr_module
)
elseif has_module and header == "" and not is_module_invoked then
result = string.format(
"This template is implemented by the Lua module [[%s]] but does not use it. ([[Special:EditPage/%s | edit template]])",
corr_module,
"Template:" .. pagename
)
else
else
return header
result = header
end
end
end
end
return string.format(":''%s''\n", result) .. invocation_hatnote
end
end


Line 197: Line 238:


-- Call appropriate hatnote-making function
-- Call appropriate hatnote-making function
local has_template = page_exists(corr_template)
local has_module  = page_exists(corr_module)
local result = ""
local result = ""
if namespace == "Module" then
if namespace == "Module" then
result = p.make_module_hatnote(header, corr_template, has_template)
result = p.make_module_hatnote(header, pagename, corr_template)
elseif namespace == "Template" then
elseif namespace == "Template" then
result = p.make_template_hatnote(header, corr_module, has_module)
result = p.make_template_hatnote(header, pagename, corr_module)
else
else
result = "This template is in the wrong namespace. It should be within the Template or Module namespaces."
result = ":''This template is in the wrong namespace. It should be within the Template or Module namespaces.''\n"
end
end


Line 213: Line 252:
return categorize(namespace, pagename, has_link)
return categorize(namespace, pagename, has_link)
else
else
return string.format(":''%s'' %s\n", result, categorize(namespace, pagename, has_link))
return string.format("%s%s", result, categorize(namespace, pagename, has_link))
end
end
end
end
Line 239: Line 278:
args["mod" ] = args["mod" ] or ("Module:"  .. args["pagename"])
args["mod" ] = args["mod" ] or ("Module:"  .. args["pagename"])


return p._dochead(args)
end
function p.tester()
local args = {}
args["namespace"] = "Template"
args["pagename" ] = "Module introspection"
args["temp"] = "Template:" .. args["pagename"]
args["mod" ] = "Module:"  .. args["pagename"]
args["header"] = ""
return p._dochead(args)
return p._dochead(args)
end
end


return p
return p
Retrieved from "https://en.xen.wiki/w/Module:Dochead"