Module:documentation: Difference between revisions

From Linguifex
Jump to navigation Jump to search
No edit summary
(Undo revision 299260 by Sware (talk))
Tag: Undo
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
-- This module implements {{documentation}}.
local export = {}


-- Get required modules.
-- it is either here, or in [[Module:ugly hacks]], and it is not in ugly hacks.
local getArgs = require('Module:Arguments').getArgs
function export.CONTENTMODEL()
 
return mw.title.getCurrentTitle().contentModel
-- Get the config table.
end
local cfg = mw.loadData('Module:Documentation/config')
 
local p = {}


-- Often-used functions.
local skins = {
local ugsub = mw.ustring.gsub
["common"    ] = "";
["vector"    ] = "Vector";
["monobook"  ] = "Monobook";
["cologneblue"] = "Cologne Blue";
["modern"    ] = "Modern";
}


----------------------------------------------------------------------------
local Array = require "Module:array"
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------


local function message(cfgKey, valArray, expectType)
local function compare_pages(page1, page2, text)
--[[
return "[" .. tostring(
-- Gets a message from the cfg table and formats it if appropriate.
mw.uri.fullUrl("Special:ComparePages", { page1 = page1, page2 = page2 }))
-- The function raises an error if the value from the cfg table is not
.. " " .. text .. "]"
-- of the type expectType. The default type for expectType is 'string'.
-- If the table valArray is present, strings such as $1, $2 etc. in the
-- message are substituted with values from the table keys [1], [2] etc.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end
 
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
 
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
end
end


p.message = message
local function page_exists(title)
 
local success, title_obj = pcall(mw.title.new, title)
local function makeWikilink(page, display)
return success and title_obj.exists
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end
end


p.makeWikilink = makeWikilink
-- Avoid transcluding [[Module:languages/cache]] everywhere.
local lang_cache = setmetatable({}, { __index = function (self, k)
return require "Module:languages/cache"[k]
end })


local function makeCategoryLink(cat, sort)
local function zh_link(word)
local catns = mw.site.namespaces[14].name
return require("Module:links").full_link{
return makeWikilink(catns .. ':' .. cat, sort)
lang = lang_cache.zh,
term = word
}
end
end


p.makeCategoryLink = makeCategoryLink
local function make_Unicode_data_documentation(title, cats)
 
local subpage, first_three_of_code_point
local function makeUrlLink(url, display)
= title.fullText:match("^Module:Unicode data/([^/]+)/(%x%x%x)$")
return mw.ustring.format('[%s %s]', url, display)
if subpage == "names" or subpage == "images" then
local low, high =
tonumber(first_three_of_code_point .. "000", 16),
tonumber(first_three_of_code_point .. "FFF", 16)
return string.format(
"This data module contains the %s of " ..
"[[Appendix:Unicode|Unicode]] code points within the range U+%04X to U+%04X.",
subpage == "images" and "titles of images" or "names",
low, high)
end
end
end


p.makeUrlLink = makeUrlLink
-- This provides categories and documentation for various data modules, so that
-- [[Category:Uncategorized modules]] isn’t unnecessarily cluttered.
-- It is a list of tables, each of which have the following possible fields:


local function makeToolbar(...)
-- `regex` (required): A Lua pattern to match the module's title. If it matches, the data in this entry will be used.
local ret = {}
-- Any captures in the pattern can by referenced in the `cat` field using %1 for the first capture, %2 for the
local lim = select('#', ...)
-- second, etc. (often used for creating the sortkey for the category). In addition, the captures are passed to the
if lim < 1 then
-- `process` function as the third and subsequent parameters.
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
-- 'documentation-toolbar'
return '<span class="' .. message('toolbar-class') .. '">('
.. table.concat(ret, ' &#124; ') .. ')</span>'
end


p.makeToolbar = makeToolbar
-- `process` (optional): This may be a function or a string. If it is a function, it is called as follows:
--    process(TITLE, CATS, CAPTURE1, CAPTURE2, ...)
-- where:
--    * TITLE is a title object describing the module's title; see [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Title_objects].
--    * CATS is an array object (see [[Module:array]]) of categories that the module will be added to.
--    * CAPTURE1, CAPTURE2, ... contain any captures in the `regex` field.
-- The return value of `process` should be a string and will be used as the module's documentation.
-- If `process` is a string, it is the name of a submodule under 'Module:documentation/functions/' which returns a
-- function, of the same type as described above. If `process` is omitted entirely, the module will have no
-- documentation.


----------------------------------------------------------------------------
-- `cat` (optional): A string naming the category into which the module should be placed. Captures specified in `regex`
-- Argument processing
-- may be referenced in this string using %1 for the first capture, %2 for the second, etc. Currently, in order to put
----------------------------------------------------------------------------
-- the module into multiple categories, you need to write a `process` function that adds categories to the CATS
 
-- parameter passed in.
local function makeInvokeFunc(funcName)
local module_regex = {
return function (frame)
{
local args = getArgs(frame, {
regex = "^Module:languages/.+$",
valueFunc = function (key, value)
cat = "Language and script modules",
if type(value) == 'string' then
},
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
{
if key == 'heading' or value ~= '' then
regex = "^Module:scripts/.+$",
return value
cat = "Language and script modules",
else
},
return nil
{
regex = "^Module:data tables/data..?.?.?$",
cat = "Reference module sharded data tables",
},
{
regex = "^Module:Quotations/...?.?.?.?.?.?$",
cat = "Quotation data modules",
},
{
regex = "^Module:zh/data/dial%-pron/.+$",
cat = "Chinese dialectal pronunciation data modules",
process = "zh dial or syn",
},
{
regex = "^Module:zh/data/dial%-syn/.+$",
cat = "Chinese dialectal synonyms data modules",
process = "zh dial or syn",
},
{
regex = "^Module:zh/data/glyph%-data/.+$",
cat = "Chinese historical character forms data modules",
process = function(title, cats)
local character = title.fullText:match("^Module:zh/data/glyph%-data/(.+)")
if character then
return ("This module contains data on historical forms of the Chinese character %s.")
:format(zh_link(character))
end
end,
},
{
regex = "^Module:zh/data/ltc%-pron/(.+)$",
cat = "Middle Chinese pronunciation data modules|%1",
process = "zh data",
},
{
regex = "^Module:zh/data/och%-pron%-BS/(.+)$",
cat = "Old Chinese (Baxter-Sagart) pronunciation data modules|%1",
process = "zh data",
},
{
regex = "^Module:zh/data/och%-pron%-ZS/(.+)$",
cat = "Old Chinese (Zhengzhang) pronunciation data modules|%1",
process = "zh data",
},
{
-- capture rest of zh/data submodules
regex = "^Module:zh/data/(.+)$",
cat = "Chinese data modules|%1",
},
{
regex = "^Module:mul/guoxue%-data/cjk%-?(.*)$",
process = "guoxue-data",
},
{
regex = "^Module:Unicode data/(.+)$",
cat = "Unicode data modules|%1",
process = make_Unicode_data_documentation,
},
{
regex = "^Module:number list/data/(.+)$",
process = "number list",
},
{
regex = "^Module:accel/(.+)$",
process = function(title, cats)
local lang_code = title.subpageText
local lang = lang_cache[lang_code]
if lang then
cats:insert(lang:getCanonicalName() .. " modules|accel")
cats:insert(("Accel submodules|%s"):format(lang:getCanonicalName()))
return ("This module contains new entry creation rules for %s; see [[WT:ACCEL]] for an overview, and [[Module:accel]] for information on creating new rules.")
:format(lang:makeCategoryLink())
end
end,
},
{
regex = "^Module:inc%-ash/dial/data/(.+)$",
cat = "Ashokan Prakrit modules|%1",
process = function(title, cats)
local word = title.fullText:match("^Module:inc%-ash/dial/data/(.+)$")
if word then
local lang = lang_cache["inc-ash"]
return ("This module contains data on the pronunciation of %s in dialects of %s.")
:format(require("Module:links").full_link({ term = word, lang = lang }, "term"),
lang:makeCategoryLink())
end
end,
},
{
regex = "^Module:[%l-]+:Dialects$",
process = function(title, cats)
local content = title:getContent()
local has_aliases = content:find("aliases") ~= nil
return mw.getCurrentFrame():expandTemplate {
title = "dialectal data module",
args = { ["labels-aliases"] = has_aliases },
}
end,
},
{
regex = "^.+%-translit$",
process = "translit",
},
{
regex = "^Module:category tree/poscatboiler/data/lang%-specific/(.+)$",
process = function(title, cats, lang_code)
local lang = lang_cache[lang_code]
if lang then
local langname = lang:getCanonicalName()
cats:insert("Category tree data modules/poscatboiler|" .. langname)
cats:insert(langname .. " modules")
cats:insert(langname .. " data modules")
return "This module handles generating the descriptions and categorization for " .. langname .. " category pages "
.. "of the format \"" .. langname .. " LABEL\" where LABEL can be any text. Examples are "
.. "[[:Category:Bulgarian conjugation 2.1 verbs]] and [[:Category:Russian velar-stem neuter-form nouns]]. "
.. "This module is part of the poscatboiler system, which is a general framework for generating the "
.. "descriptions and categorization of category pages.\n\n"
.. "For more information, see [[Module:category tree/poscatboiler/data/lang-specific/documentation]]."
end
end
},
{
regex = "^Module:category tree/poscatboiler/data/(.+)$",
cat = "Category tree data modules/poscatboiler|%1",
},
{
regex = "^Module:ja/data/(.+)$",
cat = "Japanese data modules|%1",
},
{
regex = "^Module:Swadesh/data/(.+)$",
cat = "Swadesh modules|%1",
},
{
regex = "^Module:typing%-aids",
process = function(title, cats)
local data_suffix = title.fullText:match("^Module:typing%-aids/data/(.+)$")
if data_suffix then
cats:insert("Data modules")
if data_suffix:find "^[%l-]+$" then
local lang = require "Module:languages".getByCode(data_suffix)
if lang then
cats:insert(lang:getCanonicalName() .. " modules")
end
elseif data_suffix:find "^%u%l%l%l$" then
local script = require "Module:scripts".getByCode(data_suffix)
if script then
cats:insert(script:getCategoryName())
end
end
else
return value
end
end
end
end
})
end,
return p[funcName](args)
},
end
{
end
regex = "^Module:R:([a-z%-]+):(.+)$",
process = function(title, cats, lang_code, refname)
local lang = lang_cache[lang_code]
if lang then
cats:insert(lang:getCanonicalName() .. " modules|" .. refname)
cats:insert(("Reference modules|%s"):format(lang:getCanonicalName()))
return mw.getCurrentFrame():preprocess("This module implements the reference template {{temp|R:" ..
lang_code .. ":" .. refname .. "}}.")
end
end,
},
}


----------------------------------------------------------------------------
function export.show(frame)
-- Entry points
local params = {
----------------------------------------------------------------------------
["hr"] = {},
 
["for"] = {},
function p.nonexistent(frame)
["from"] = {},
if mw.title.getCurrentTitle().subpageText == 'testcases' then
["notsubpage"] = { type = "boolean", default = false },
return frame:expandTemplate{title = 'module test cases notice'}
["nodoc"] = { type = "boolean", default = false },
else
}
return p.main(frame)
local args = require("Module:parameters").process(frame.args, params)
local output = Array('\n<div class="documentation" style="display:block; clear:both">\n')
local cats = Array()
local nodoc = args.nodoc
if (not args.hr) or (args.hr == "above") then
output:insert("----\n")
end
end
end
p.main = makeInvokeFunc('_main')
function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p._getModuleWikitext(args, env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:tag('div')
-- 'documentation-container'
:addClass(message('container'))
:newline()
:tag('div')
-- 'documentation'
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
-- 'documentation-clear'
:addClass(message('clear'))
:done()
:newline()
:done()
:wikitext(p._endBox(args, env))
:done()
:wikitext(p.addTrackingCategories(env))
-- 'Module:Documentation/styles.css'
return mw.getCurrentFrame():extensionTag (
'templatestyles', '', {src=cfg['templatestyles']
}) .. tostring(root)
end
----------------------------------------------------------------------------
-- Environment settings
----------------------------------------------------------------------------
function p.getEnvironment(args)
--[[
-- Returns a table with information about the environment, including title
-- objects and other namespace- or path-related data.
-- @args - table of arguments passed by the user
--
-- Title objects include:
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
--
-- Data includes:
-- env.protectionLevels - the protection levels table of the title object.
-- env.subjectSpace - the number of the title's subject namespace.
-- env.docSpace - the number of the namespace the title puts its documentation in.
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]
local env, envFuncs = {}, {}
local title = ((args['for'] ~= "") and args['for']) and mw.title.new(args['for'])
 
or mw.title.getCurrentTitle()
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
local doc_title = mw.title.new((args['from'] ~= "") and args['from']
-- returned by that function is memoized in the env table so that we don't call any of the functions
or (title.fullText .. '/doc'))
-- more than once. (Nils won't be memoized.)
local contentModel = title.contentModel
setmetatable(env, {
__index = function (t, key)
local pagetype = mw.getContentLanguage():lcfirst(title.nsText) .. " page"
local envFunc = envFuncs[key]
local preload, fallback_docs, doc_content, doc_content_module,
if envFunc then
old_doc_title, user_name, skin_name, needs_doc
local success, val = pcall(envFunc)
if success then
if contentModel == "javascript" then
env[key] = val -- Memoise the value.
pagetype = "script"
return val
if title.nsText == 'MediaWiki' then
end
if title.text:find('Gadget-') then
preload = 'Template:documentation/preloadGadget'
else
preload = 'Template:documentation/preloadMediaWikiJavaScript'
end
end
return nil
else
preload  = 'Template:documentation/preloadTemplate' -- XXX
end
end
})
if title.nsText == 'User' then
 
user_name = title.rootText
function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
end
return title
elseif contentModel == "css" then
end
pagetype = "style sheet"
 
preload  = 'Template:documentation/preloadTemplate' -- XXX
function envFuncs.templateTitle()
if title.nsText == 'User' then
--[[
user_name = title.rootText
-- The template (or module, etc.) title object.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end
end
elseif contentModel == "Scribunto" then
 
pagetype = "module"
function envFuncs.docTitle()
user_name = title.rootText:match("^[Uu]ser:(.+)")
--[[
if user_name then
-- Title object of the /doc subpage.
preload  = 'Template:documentation/preloadModuleSandbox'
-- Messages:
-- 'doc-subpage' --> 'doc'
--]]
local title = env.title
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
preload  = 'Template:documentation/preloadModule'
end
end
return mw.title.new(docpage)
elseif title.nsText == "Template" then
pagetype = "template"
preload  = 'Template:documentation/preloadTemplate'
elseif title.nsText == "Wiktionary" then
pagetype = "project page"
preload  = 'Template:documentation/preloadTemplate' -- XXX
end
end
function envFuncs.sandboxTitle()
if doc_title.isRedirect then
--[[
old_doc_title = doc_title
-- Title object for the /sandbox subpage.
doc_title = mw.title.new(string.match(doc_title:getContent(),
-- Messages:
"^#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]]-)%]%]"))
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end
function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end
end


function envFuncs.protectionLevels()
output:insert("<dl class=\"plainlinks\" style=\"font-size: smaller;\">")
-- The protection levels table of the title object.
if doc_title.exists then
return env.title.protectionLevels
output:insert(
end
"<dd><i style=\"font-size: larger;\">The following " ..
"[[wikt:Help:Documenting templates and modules|documentation]] is located at [[" ..
doc_title.fullText .. "]]. " ..
"<sup>[[" .. doc_title:fullUrl { action = 'edit' } .. " edit]]</sup> </i></dd>")
else
if contentModel == "Scribunto" then
local automatic_cats = nil
if user_name then
fallback_docs = "documentation/fallback/user module"
automatic_cats = {"User sandbox modules"}
else
for _, data in ipairs(module_regex) do
        local captures = {mw.ustring.match(title.fullText, data.regex)}
        if #captures > 0 then
local cat
local process_function
if type(data.process) == "function" then
process_function = data.process
elseif type(data.process) == "string" then
doc_content_module = "Module:documentation/functions/" .. data.process
process_function = require(doc_content_module)
end
if process_function then
doc_content = process_function(title, cats, unpack(captures))
end
cat = data.cat
if cat then
if type(cat) == "string" then
cat = {cat}
end
for _, c in ipairs(cat) do
-- gsub() and Lua :gsub() return two arguments, which causes all sorts of problems.
-- Terrible design, there should have been a separate two-argument function.
local gsub_sucks = mw.ustring.gsub(title.fullText, data.regex, c)
table.insert(cats, gsub_sucks)
end
end
break
end
end
end
 
if not automatic_cats then
local success, auto_cats =
pcall(require("Module:module categorization").categorize, frame, true)
if success then
for _, category in ipairs(auto_cats) do
cats:insert(category)
end
end
end


function envFuncs.subjectSpace()
if title.subpageText == "templates" then
-- The subject namespace number.
cats:insert("Template interface modules")
return mw.site.namespaces[env.title.namespace].subject.id
end
end


function envFuncs.docSpace()
if automatic_cats then
-- The documentation namespace number. For most namespaces this is the
for _, c in ipairs(automatic_cats) do
-- same as the subject namespace. However, pages in the Article, File,
cats:insert(c)
-- MediaWiki or Category namespaces must have their /doc, /sandbox and
end
-- /testcases pages in talk space.
end
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
-- meaning module is not in user’s sandbox or one of many datamodule boring series
return subjectSpace + 1
needs_doc = not (automatic_cats or doc_content or fallback_docs)
else
elseif title.nsText == "Template" then
return subjectSpace
--cats:insert("Uncategorized templates")
needs_doc = not (fallback_docs or nodoc)
elseif (contentModel == "css") or (contentModel == "javascript") then
if user_name then
skin_name = skins[title.text:sub(#title.rootText + 1):match("^/([a-z]+)%.[jc]ss?$")]
if skin_name then
fallback_docs = 'documentation/fallback/user ' .. contentModel
end
end
end
if doc_content then
output:insert(
"<dd><i style=\"font-size: larger;\">The following " ..
"[[wikt:Help:Documenting templates and modules|documentation]] is " ..
"generated by [[" .. (doc_content_module or "Module:documentation") .. "]]. <sup>[[" ..
mw.title.new("Module:documentation"):fullUrl { action = 'edit' } ..
" edit]]</sup> </i></dd>")
elseif not nodoc then
output:insert(
"<dd><i style=\"font-size: larger;\">This " .. pagetype ..
" lacks a [[wikt:Help:Documenting templates and modules|documentation subpage]]. " ..
(fallback_docs and "You may " or "Please ") ..
"[" .. doc_title:fullUrl { action = 'edit', preload = preload }
.. " create it].</i></dd>\n")
end
end
end
function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
local templateTitle = env.templateTitle
local docSpace = env.docSpace
local docSpaceText = mw.site.namespaces[docSpace].name
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
return docSpaceText .. ':' .. templateTitle.text
end
end
function envFuncs.compareUrl()
if title.fullText:match("^MediaWiki:Gadget%-") then
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
local is_gadget = false
local templateTitle = env.templateTitle
local gadget_list = mw.title.new("MediaWiki:Gadgets-definition"):getContent()
local sandboxTitle = env.sandboxTitle
if templateTitle.exists and sandboxTitle.exists then
for line in mw.text.gsplit(gadget_list, "\n") do
local compareUrl = mw.uri.fullUrl(
local gadget, opts, items = line:match("^%*%s*([A-Za-z][A-Za-z0-9_%-]*)%[(.-)%]|(.+)$") -- opts is unused
'Special:ComparePages',
if not gadget then
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
gadget, items = line:match("^%*%s*([A-Za-z][A-Za-z0-9_%-]*)|(.+)$")
)
end
return tostring(compareUrl)
else
if gadget then
return nil
items = Array(mw.text.split(items, "|"))
end
for i, item in ipairs(items) do
end
if title.fullText == ("MediaWiki:Gadget-" .. item) then
is_gadget = true


return env
output:insert("<dd> ''This script is a part of the <code>")
end
output:insert(gadget)
output:insert("</code> gadget ([")
output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadgets-definition', 'action=edit')))
output:insert(" edit definitions])'' <dl>")
output:insert("<dd> ''Description ([")
output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadget-' .. gadget, 'action=edit')))
output:insert(" edit])'': ")
local gadget_description = mw.message.new('Gadget-' .. gadget):plain()
gadget_description = frame:preprocess(gadget_description)
output:insert(gadget_description)
output:insert(" </dd>")


----------------------------------------------------------------------------
items:remove(i)
-- Auxiliary templates
if #items > 0 then
----------------------------------------------------------------------------
for j, item in ipairs(items) do
items[j] = '[[MediaWiki:Gadget-' .. item .. '|' .. item .. ']]'
end
output:insert("<dd> ''Other parts'': ")
output:insert(mw.text.listToText(items))
output:insert("</dd>")
end


p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')
output:insert("</dl></dd>")


function p._getModuleWikitext(args, env)
break
local currentTitle = mw.title.getCurrentTitle()
end
if currentTitle.contentModel ~= 'Scribunto' then return end
end
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care
end
local moduleWikitext =  package.loaded["Module:Module wikitext"]
end
if moduleWikitext then
return moduleWikitext.main()
if not is_gadget then
output:insert("<dd> ''This script is not a part of any [")
output:insert(tostring(mw.uri.fullUrl('Special:Gadgets', 'uselang=en')))
output:insert(' gadget] ([')
output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadgets-definition', 'action=edit')))
output:insert(' edit definitions]).</dd>')
-- else
-- cats:insert("Wiktionary gadgets")
end
end
end
end
 
if old_doc_title then
function p.sandboxNotice(args, env)
output:insert("<dd> ''Redirected from'' [")
--[=[
output:insert(old_doc_title:fullUrl { redirect = 'no' })
-- Generates a sandbox notice for display above sandbox pages.
output:insert(" ")
-- @args - a table of arguments passed by the user
output:insert(old_doc_title.fullText)
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
output:insert("] ([")
--
output:insert(old_doc_title:fullUrl { action = 'edit' })
-- Messages:
output:insert(" edit]).</dd>\n")
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
--]=]
local title = env.title
local sandboxTitle = env.sandboxTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle
and mw.title.equals(title, sandboxTitle)) then
return nil
end
end
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
local omargs = {}
local links = Array()
omargs.image = message('sandbox-notice-image')
-- Get the text. We start with the opening blurb, which is something like
if title.isSubpage and not args.notsubpage then
-- "This is the template sandbox for [[Template:Foo]] (diff)."
links:insert("[[:" .. title.nsText .. ":" .. title.rootText .. "|root page]]")
local text = ''
links:insert("[[Special:PrefixIndex/" .. title.nsText .. ":" .. title.rootText .. "/|root page’s subpages]]")
local pagetype
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
else
else
pagetype = message('sandbox-notice-pagetype-other')
links:insert("[[Special:PrefixIndex/" .. title.fullText .. "/|subpage list]]")
end
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
links:insert(
if compareUrl then
'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
local compareDisplay = message('sandbox-notice-compare-link-display')
'hidetrans=1&hideredirs=1')) .. ' links]')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
else
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
omargs.text = text .. makeCategoryLink(message('sandbox-category'))
 
-- 'documentation-clear'
return '<div class="' .. message('clear') .. '"></div>'
.. require('Module:Message box').main('ombox', omargs)
end


function p.protectionTemplate(env)
if contentModel ~= "Scribunto" then
-- Generates the padlock icon in the top right.
links:insert(
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
-- Messages:
'hidelinks=1&hidetrans=1')) .. ' redirects]')
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
end
local editProt = protectionLevels.edit and protectionLevels.edit[1]
local moveProt = protectionLevels.move and protectionLevels.move[1]
if editProt then
-- The page is edit-protected.
return require('Module:Protection banner')._main{
message('protection-reason-edit'), small = true
}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
return require('Module:Protection banner')._main{
action = 'move', small = true
}
else
return nil
end
end


----------------------------------------------------------------------------
if (contentModel == "javascript") or (contentModel == "css") then
-- Start box
if user_name then
----------------------------------------------------------------------------
links:insert("[[Special:MyPage" .. title.text:sub(#title.rootText + 1) .. "|your own]]")
 
p.startBox = makeInvokeFunc('_startBox')
 
function p._startBox(args, env)
--[[
-- This function generates the start box.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- which generate the box HTML.
--]]
env = env or p.getEnvironment(args)
local links
local content = args.content
if not content or args[1] then
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
if linksData then
links = p.renderStartBoxLinks(linksData)
end
end
end
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
else
-- User specified no heading.
links:insert(
return nil
'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
'hidelinks=1&hideredirs=1')) .. ' transclusions]')
end
end
end
 
if contentModel == "Scribunto" then
function p.makeStartBoxLinksData(args, env)
local is_testcases = title.isSubpage and title.subpageText == "testcases"
--[[
local without_subpage = title.nsText .. ":" .. title.baseText
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
if is_testcases then
-- @args - a table of arguments passed by the user
links:insert("[[:" .. without_subpage .. "|tested module]]")
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
else
--
links:insert("[[" .. title.fullText .. "/testcases|testcases]]")
-- Messages:
end
-- 'view-link-display' --> 'view'
-- 'edit-link-display' --> 'edit'
if user_name then
-- 'history-link-display' --> 'history'
links:insert("[[User:" .. user_name .. "|user page]]")
-- 'purge-link-display' --> 'purge'
links:insert("[[User talk:" .. user_name .. "|user talk page]]")
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
links:insert("[[Special:PrefixIndex/User:" .. user_name .. "/|userspace]]")
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'create-link-display' --> 'create'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local docTitle = env.docTitle
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then  
docTitle = docTitle.redirectTarget
end
 
local data = {}
data.title = title
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = message('view-link-display')
data.editLinkDisplay = message('edit-link-display')
data.historyLinkDisplay = message('history-link-display')
data.purgeLinkDisplay = message('purge-link-display')
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
else
preload = message('docpage-preload')
-- If sandbox module, add a link to the module that this is a sandbox of.
-- Exclude user sandbox modules like [[User:Dine2016/sandbox]].
if title.text:find("/sandbox%d*%f[/%z]") then
cats:insert("Sandbox modules")
-- Sandbox modules don’t really need documentation.
needs_doc = false
-- Will behave badly if “/sandbox” occurs twice in title!
local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
local diff
if page_exists(sandbox_of) then
diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
end
links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
-- If not a sandbox module, add link to sandbox module.
-- Sometimes there are multiple sandboxes for a single module:
-- [[Module:sa-pronunc/sandbox]],  [[Module:sa-pronunc/sandbox2]].
-- Occasionally sandbox modules have their own subpages that are also
-- sandboxes: [[Module:grc-decl/sandbox/decl]].
else
local sandbox_title
if title.fullText:find("^Module:grc%-decl/") then
sandbox_title = title.fullText:gsub("^Module:grc%-decl/", "Module:grc-decl/sandbox/")
elseif is_testcases then
sandbox_title = title.fullText:gsub("/testcases", "/sandbox/testcases")
else
sandbox_title = title.fullText .. "/sandbox"
end
local sandbox_link = "[[:" .. sandbox_title .. "|sandbox]]"
local diff
if page_exists(sandbox_title) then
diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
end
links:insert(sandbox_link .. (diff or ""))
end
end
end
end
end
data.preload = preload
data.createLinkDisplay = message('create-link-display')
return data
end
function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create][purge] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]
local function escapeBrackets(s)
if title.nsText == "Template" then
-- Escapes square brackets with HTML entities.
-- Error search: all(any namespace), hastemplate (show pages using the template), insource (show source code), incategory (any/specific error) -- [[mw:Help:CirrusSearch]], [[w:Help:Searching/Regex]]
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
-- apparently same with/without: &profile=advanced&fulltext=1
s = s:gsub('%]', '&#93;')
local errorq = 'searchengineselect=mediawiki&search=all: hastemplate:\"'..title.rootText..'\" insource:\"'..title.rootText..'\" incategory:'
return s
local eincategory = "Pages_with_module_errors|ParserFunction_errors|DisplayTitle_errors|Pages_with_ISBN_errors|Pages_with_ISSN_errors|Pages_with_reference_errors|Pages_with_syntax_highlighting_errors|Pages_with_TemplateStyles_errors"
end
 
links:insert(
local ret
'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..eincategory )) .. ' errors]'
local docTitle = data.docTitle
.. ' (' ..
local title = data.title
'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..'ParserFunction_errors' )) .. ' parser]'
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
.. '/' ..
if docTitle.exists then
'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..'Pages_with_module_errors' )) .. ' module]'
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
.. ')'
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
)
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
ret = '[%s] [%s] [%s] [%s]'
if title.isSubpage and title.text:find("/sandbox%d*%f[/%z]") then -- This is a sandbox template.
ret = escapeBrackets(ret)
-- At the moment there are no user sandbox templates with subpage
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
-- “/sandbox”.
else
cats:insert("Sandbox templates")
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
ret = '[%s] [%s]'
-- Sandbox templates don’t really need documentation.
ret = escapeBrackets(ret)
needs_doc = false
ret = mw.ustring.format(ret, createLink, purgeLink)
end
-- Will behave badly if “/sandbox” occurs twice in title!
return ret
local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
end
 
local diff
function p.makeStartBoxData(args, env, links)
if page_exists(sandbox_of) then
--[=[
diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
end
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
else -- This is a template that can have a sandbox.
--
local sandbox_title = title.fullText .. "/sandbox"
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
local diff
-- 'template-namespace-heading' --> 'Template documentation'
if page_exists(sandbox_title) then
-- 'module-namespace-heading' --> 'Module documentation'
diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
-- 'file-namespace-heading' --> 'Summary'
end
-- 'other-namespaces-heading' --> 'Documentation'
-- 'testcases-create-link-display' --> 'create'
links:insert("[[:" .. sandbox_title .. "|sandbox]]" .. (diff or ""))
--]=]
end
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
end
local data = {}
-- Heading
if #links > 0 then
local heading = args.heading -- Blank values are not removed.
output:insert("<dd> ''Useful links'': " .. links:concat(" • ") .. "</dd>")
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
if heading then
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
data.heading = message('file-namespace-heading')
else
data.heading = message('other-namespaces-heading')
end
end
-- Heading CSS
output:insert("</dl>\n")
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
else
-- 'documentation-heading'
data.headingClass = message('main-div-heading-class')
end
-- Data for the [view][edit][history][purge] or [create] links.
-- Show error from [[Module:category tree/topic cat/data]] on its submodules'
if links then
-- documentation to, for instance, warn about duplicate labels.
-- 'mw-editsection-like plainlinks'
if title.fullText:find("Module:category tree/topic cat/data", 1, true) == 1 then
data.linksClass = message('start-box-link-classes')
local ok, err = pcall(require, "Module:category tree/topic cat/data")
data.links = links
if not ok then
output:insert('<span class="error">' .. err .. '</span>\n\n')
end
end
end
return data
if doc_title.exists then
end
-- Override automatic documentation, if present.
 
doc_content = frame:expandTemplate { title = doc_title.fullText }
function p.renderStartBox(data)
elseif not doc_content and fallback_docs then
-- Renders the start box html.
doc_content = frame:expandTemplate {
-- @data - a table of data generated by p.makeStartBoxData.
title = fallback_docs;
local sbox = mw.html.create('div')
args = {
sbox
['user'] = user_name;
-- 'documentation-startbox'
['page'] = title.fullText;
:addClass(message('start-box-class'))
['skin name'] = skin_name;
:newline()
}
:tag('span')
}
:addClass(data.headingClass)
:cssText(data.headingStyleText)
:wikitext(data.heading)
local links = data.links
if links then
sbox:tag('span')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
end
return tostring(sbox)
end
----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------


p.content = makeInvokeFunc('_content')
if doc_content then
 
output:insert(doc_content)
function p._content(args, env)
-- Displays the documentation contents
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
local content = args.content
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
end
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'
end


p.contentTitle = makeInvokeFunc('_contentTitle')
output:insert(('\n<%s style="clear: both;" />'):format(args.hr == "below" and "hr" or "br"))
 
function p._contentTitle(args, env)
if not cats[1] and not doc_content then
env = env or p.getEnvironment(args)
if contentModel == "Scribunto" then
local docTitle = env.docTitle
cats:insert("Uncategorized modules")
if not args.content and docTitle and docTitle.exists then
-- elseif title.nsText == "Template" then
return docTitle.prefixedText
-- cats:insert("Uncategorized templates")
else
end
return ''
end
end
end
----------------------------------------------------------------------------
-- End box
----------------------------------------------------------------------------
p.endBox = makeInvokeFunc('_endBox')
function p._endBox(args, env)
--[=[
-- This function generates the end box (also known as the link box).
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
--]=]
-- Get environment data.
if needs_doc then
env = env or p.getEnvironment(args)
cats:insert("Templates and modules needing documentation")
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
end
end
-- Check whether we should output the end box at all. Add the end
for _, cat in ipairs(cats) do
-- box by default if the documentation exists or if we are in the
output:insert("[[Category:" .. cat .. "]]")
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
end
 
-- Assemble the link box.
local text = ''
if linkBox then
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
-- We are in the user, template or module namespaces.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- as then it is unclear where to add the categories.
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
end
end
end
local box = mw.html.create('div')
output:insert("</div>\n")
-- 'documentation-metadata'
box:attr('role', 'note')
:addClass(message('end-box-class'))
-- 'plainlinks'
:addClass(message('end-box-plainlinks'))
:wikitext(text)
:done()


return '\n' .. tostring(box)
return output:concat()
end
end


function p.makeDocPageBlurb(args, env)
-- Used by {{translit module documentation}}.
--[=[
function export.translitModuleLangList(frame)
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
local pagename, subpage
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
if frame.args[1] then
--
pagename = frame.args[1]
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[Wikipedia:Template documentation|documentation]]
-- is [[Help:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local ret
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message('edit-link-display')
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message('history-link-display')
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. '<br />'
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. '<br />'
end
return ret
end
 
function p.makeExperimentBlurb(args, env)
--[[
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-link-display' --> 'sandbox'
-- 'sandbox-edit-link-display' --> 'edit'
-- 'compare-link-display' --> 'diff'
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'sandbox-create-link-display' --> 'create'
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
-- 'mirror-link-display' --> 'mirror'
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- 'sandbox-link-display' --> 'sandbox'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display'--> 'edit'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display' --> 'edit'
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
else
local sandboxPreload
local title = mw.title.getCurrentTitle()
if subjectSpace == 828 then
subpage = title.subpageText
sandboxPreload = message('module-sandbox-preload')
pagename = title.text
else
sandboxPreload = message('template-sandbox-preload')
if subpage ~= pagename then
pagename = title.rootText
end
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
end
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local translitModule = pagename
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local languageObjects = require("Module:languages/byTranslitModule")(translitModule)
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
local codeInPagename = pagename:match("^([%l-]+)%-.*translit$")
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
local categories = Array()
local codeInPagenameInList = false
if codeInPagename then
if languageObjects[1] and subpage ~= "documentation" then
local agreement = languageObjects[2] and "s" or ""
categories:insert("[[Category:Transliteration modules used by " ..
#languageObjects .. " language" .. agreement .. "]]")
end
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
languageObjects = Array(languageObjects)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
:filter(
function (lang)
local result = lang:getCode() ~= codeInPagename
codeInPagenameInList = codeInPagenameInList or result
return result
end)
end
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
if subpage ~= "documentation" then
local testcasesDisplay = message('testcases-link-display')
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local script = require "Module:scripts".getByCode(script_code)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
if script then
local testcasesEditDisplay = message('testcases-edit-link-display')
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
end
-- for Modules, add testcases run link if exists
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
end
local messageName
if subjectSpace == 828 then
if subpage ~= "documentation" and not page_exists("Module:" .. pagename .. "/testcases") then
messageName = 'experiment-blurb-module'
categories:insert("[[Category:Transliteration modules without a testcases subpage]]")
else
messageName = 'experiment-blurb-template'
end
end
return message(messageName, {sandboxLinks, testcasesLinks})
end
if not languageObjects[1] then
 
return categories:concat()
function p.makeCategoriesBlurb(args, env)
--[[
-- Generates the text "Please add categories to the /doc subpage."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end
function p.makeSubpagesBlurb(args, env)
--[[
-- Generates the "Subpages of this template" link.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
local langs = Array(languageObjects)
-- 'template-pagetype' --> 'template'
:sort(
-- 'module-pagetype' --> 'module'
function(lang1, lang2)
-- 'default-pagetype' --> 'page'
return lang1:getCode() < lang2:getCode()
-- 'subpages-link-display' --> 'Subpages of this $1'
end)
--]]
-- This will not error because languageObjects is not empty.
local subjectSpace = env.subjectSpace
:map(languageObjects[1].makeCategoryLink)
local templateTitle = env.templateTitle
:serial_comma_join()
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
pagetype = message('default-pagetype')
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end
 
----------------------------------------------------------------------------
-- Tracking categories
----------------------------------------------------------------------------
 
function p.addTrackingCategories(env)
--[[
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
return "It is " .. ( codeInPagenameInList and "also" or "" ) ..
-- 'display-strange-usage-category' --> true
" used to transliterate " .. langs .. "." .. categories:concat()
-- 'doc-subpage' --> 'doc'
-- 'testcases-subpage' --> 'testcases'
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
--
-- /testcases pages in the module namespace are not categorised, as they may have
-- {{documentation}} transcluded automatically.
--]]
local title = env.title
local subjectSpace = env.subjectSpace
if not title or not subjectSpace then
return nil
end
local subpage = title.subpageText
local ret = ''
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
ret = ret .. makeCategoryLink(message('strange-usage-category'))
end
return ret
end
end


return p
return export

Latest revision as of 18:34, 5 April 2023

The following documentation is located at Module:documentation/doc.[edit]
Useful links: subpage list • links • transclusions • testcases • sandbox

local export = {}

-- it is either here, or in [[Module:ugly hacks]], and it is not in ugly hacks.
function export.CONTENTMODEL()
	return mw.title.getCurrentTitle().contentModel
end

local skins = {
	["common"     ] = "";
	["vector"     ] = "Vector";
	["monobook"   ] = "Monobook";
	["cologneblue"] = "Cologne Blue";
	["modern"     ] = "Modern";
}

local Array = require "Module:array"

local function compare_pages(page1, page2, text)
	return "[" .. tostring(
		mw.uri.fullUrl("Special:ComparePages", { page1 = page1, page2 = page2 }))
		.. " " .. text .. "]"
end

local function page_exists(title)
	local success, title_obj = pcall(mw.title.new, title)
	return success and title_obj.exists
end

-- Avoid transcluding [[Module:languages/cache]] everywhere.
local lang_cache = setmetatable({}, { __index = function (self, k)
	return require "Module:languages/cache"[k]
end })

local function zh_link(word)
	return require("Module:links").full_link{
		lang = lang_cache.zh,
		term = word
	}
end

local function make_Unicode_data_documentation(title, cats)
	local subpage, first_three_of_code_point
		= title.fullText:match("^Module:Unicode data/([^/]+)/(%x%x%x)$")
	if subpage == "names" or subpage == "images" then
		local low, high =
			tonumber(first_three_of_code_point .. "000", 16),
			tonumber(first_three_of_code_point .. "FFF", 16)
		return string.format(
			"This data module contains the %s of " ..
			"[[Appendix:Unicode|Unicode]] code points within the range U+%04X to U+%04X.",
			subpage == "images" and "titles of images" or "names",
			low, high)
	end
end

-- This provides categories and documentation for various data modules, so that
-- [[Category:Uncategorized modules]] isn’t unnecessarily cluttered.
-- It is a list of tables, each of which have the following possible fields:

-- `regex` (required): A Lua pattern to match the module's title. If it matches, the data in this entry will be used.
-- Any captures in the pattern can by referenced in the `cat` field using %1 for the first capture, %2 for the
-- second, etc. (often used for creating the sortkey for the category). In addition, the captures are passed to the
-- `process` function as the third and subsequent parameters.

-- `process` (optional): This may be a function or a string. If it is a function, it is called as follows:
--    process(TITLE, CATS, CAPTURE1, CAPTURE2, ...)
-- where:
--    * TITLE is a title object describing the module's title; see [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Title_objects].
--    * CATS is an array object (see [[Module:array]]) of categories that the module will be added to.
--    * CAPTURE1, CAPTURE2, ... contain any captures in the `regex` field.
-- The return value of `process` should be a string and will be used as the module's documentation.
-- If `process` is a string, it is the name of a submodule under 'Module:documentation/functions/' which returns a
-- function, of the same type as described above. If `process` is omitted entirely, the module will have no
-- documentation.

-- `cat` (optional): A string naming the category into which the module should be placed. Captures specified in `regex`
-- may be referenced in this string using %1 for the first capture, %2 for the second, etc. Currently, in order to put
-- the module into multiple categories, you need to write a `process` function that adds categories to the CATS
-- parameter passed in.
local module_regex = {
	{
		regex = "^Module:languages/.+$",
		cat = "Language and script modules",
	},
	{
		regex = "^Module:scripts/.+$",
		cat = "Language and script modules",
	},
	{
		regex = "^Module:data tables/data..?.?.?$",
		cat = "Reference module sharded data tables",
	},
	{
		regex = "^Module:Quotations/...?.?.?.?.?.?$",
		cat = "Quotation data modules",
	},
	{
		regex = "^Module:zh/data/dial%-pron/.+$",
		cat = "Chinese dialectal pronunciation data modules",
		process = "zh dial or syn",
	},
	{
		regex = "^Module:zh/data/dial%-syn/.+$",
		cat = "Chinese dialectal synonyms data modules",
		process = "zh dial or syn",
	},
	{
		regex = "^Module:zh/data/glyph%-data/.+$",
		cat = "Chinese historical character forms data modules",
		process = function(title, cats)
			local character = title.fullText:match("^Module:zh/data/glyph%-data/(.+)")
			if character then
				return ("This module contains data on historical forms of the Chinese character %s.")
					:format(zh_link(character))
			end
		end,
	},
	{
		regex = "^Module:zh/data/ltc%-pron/(.+)$",
		cat = "Middle Chinese pronunciation data modules|%1",
		process = "zh data",
	},
	{
		regex = "^Module:zh/data/och%-pron%-BS/(.+)$",
		cat = "Old Chinese (Baxter-Sagart) pronunciation data modules|%1",
		process = "zh data",
	},
	{
		regex = "^Module:zh/data/och%-pron%-ZS/(.+)$",
		cat = "Old Chinese (Zhengzhang) pronunciation data modules|%1",
		process = "zh data",
	},
	{
		-- capture rest of zh/data submodules
		regex = "^Module:zh/data/(.+)$",
		cat = "Chinese data modules|%1",
	},
	{
		regex = "^Module:mul/guoxue%-data/cjk%-?(.*)$",
		process = "guoxue-data",
	},
	{
		regex = "^Module:Unicode data/(.+)$",
		cat = "Unicode data modules|%1",
		process = make_Unicode_data_documentation,
	},
	{
		regex = "^Module:number list/data/(.+)$",
		process = "number list",
	},
	{
		regex = "^Module:accel/(.+)$",
		process = function(title, cats)
			local lang_code = title.subpageText
			local lang = lang_cache[lang_code]
			if lang then
				cats:insert(lang:getCanonicalName() .. " modules|accel")
				cats:insert(("Accel submodules|%s"):format(lang:getCanonicalName()))
				return ("This module contains new entry creation rules for %s; see [[WT:ACCEL]] for an overview, and [[Module:accel]] for information on creating new rules.")
					:format(lang:makeCategoryLink())
			end
		end,
	},
	{
		regex = "^Module:inc%-ash/dial/data/(.+)$",
		cat = "Ashokan Prakrit modules|%1",
		process = function(title, cats)
			local word = title.fullText:match("^Module:inc%-ash/dial/data/(.+)$")
			if word then
				local lang = lang_cache["inc-ash"]
				return ("This module contains data on the pronunciation of %s in dialects of %s.")
					:format(require("Module:links").full_link({ term = word, lang = lang }, "term"),
						lang:makeCategoryLink())
			end
		end,
	},
	{
		regex = "^Module:[%l-]+:Dialects$",
		process = function(title, cats)
			local content = title:getContent()
			local has_aliases = content:find("aliases") ~= nil
			return mw.getCurrentFrame():expandTemplate {
				title = "dialectal data module",
				args = { ["labels-aliases"] = has_aliases },
			}
		end,
	},
	{
		regex = "^.+%-translit$",
		process = "translit",
	},
	{
		regex = "^Module:category tree/poscatboiler/data/lang%-specific/(.+)$",
		process = function(title, cats, lang_code)
			local lang = lang_cache[lang_code]
			if lang then
				local langname = lang:getCanonicalName()
				cats:insert("Category tree data modules/poscatboiler|" .. langname)
				cats:insert(langname .. " modules")
				cats:insert(langname .. " data modules")
				return "This module handles generating the descriptions and categorization for " .. langname .. " category pages "
					.. "of the format \"" .. langname .. " LABEL\" where LABEL can be any text. Examples are "
					.. "[[:Category:Bulgarian conjugation 2.1 verbs]] and [[:Category:Russian velar-stem neuter-form nouns]]. "
					.. "This module is part of the poscatboiler system, which is a general framework for generating the "
					.. "descriptions and categorization of category pages.\n\n"
					.. "For more information, see [[Module:category tree/poscatboiler/data/lang-specific/documentation]]."
			end
		end
	},
	{
		regex = "^Module:category tree/poscatboiler/data/(.+)$",
		cat = "Category tree data modules/poscatboiler|%1",
	},
	{
		regex = "^Module:ja/data/(.+)$",
		cat = "Japanese data modules|%1",
	},
	{
		regex = "^Module:Swadesh/data/(.+)$",
		cat = "Swadesh modules|%1",
	},
	{
		regex = "^Module:typing%-aids",
		process = function(title, cats)
			local data_suffix = title.fullText:match("^Module:typing%-aids/data/(.+)$")
			if data_suffix then
				cats:insert("Data modules")
				if data_suffix:find "^[%l-]+$" then
					local lang = require "Module:languages".getByCode(data_suffix)
					if lang then
						cats:insert(lang:getCanonicalName() .. " modules")
					end
				elseif data_suffix:find "^%u%l%l%l$" then
					local script = require "Module:scripts".getByCode(data_suffix)
					if script then
						cats:insert(script:getCategoryName())
					end
				end
			end
		end,
	},
	{
		regex = "^Module:R:([a-z%-]+):(.+)$",
		process = function(title, cats, lang_code, refname)
			local lang = lang_cache[lang_code]
			if lang then
				cats:insert(lang:getCanonicalName() .. " modules|" .. refname)
				cats:insert(("Reference modules|%s"):format(lang:getCanonicalName()))
				return mw.getCurrentFrame():preprocess("This module implements the reference template {{temp|R:" ..
					lang_code .. ":" .. refname .. "}}.")
			end
		end,
	},
}

function export.show(frame)
	local params = {
		["hr"] = {},
		["for"] = {},
		["from"] = {},
		["notsubpage"] = { type = "boolean", default = false },
		["nodoc"] = { type = "boolean", default = false },
	}
	
	local args = require("Module:parameters").process(frame.args, params)
	
	local output = Array('\n<div class="documentation" style="display:block; clear:both">\n')
	local cats = Array()
	
	local nodoc = args.nodoc
	
	if (not args.hr) or (args.hr == "above") then
		output:insert("----\n")
	end
	
	local title = ((args['for'] ~= "") and args['for']) and mw.title.new(args['for'])
		or mw.title.getCurrentTitle()
	local doc_title = mw.title.new((args['from'] ~= "") and args['from']
		or (title.fullText .. '/doc'))
	local contentModel = title.contentModel
	
	local pagetype = mw.getContentLanguage():lcfirst(title.nsText) .. " page"
	local preload, fallback_docs, doc_content, doc_content_module,
		old_doc_title, user_name, skin_name, needs_doc
	
	if contentModel == "javascript" then
		pagetype = "script"
		if title.nsText == 'MediaWiki' then
			if title.text:find('Gadget-') then
				preload = 'Template:documentation/preloadGadget'
			else
				preload = 'Template:documentation/preloadMediaWikiJavaScript'
			end
		else
			preload  = 'Template:documentation/preloadTemplate' -- XXX
		end
		if title.nsText == 'User' then
			user_name = title.rootText
		end
	elseif contentModel == "css" then
		pagetype = "style sheet"
		preload  = 'Template:documentation/preloadTemplate' -- XXX
		if title.nsText == 'User' then
			user_name = title.rootText
		end
	elseif contentModel == "Scribunto" then
		pagetype = "module"
		user_name = title.rootText:match("^[Uu]ser:(.+)")
		if user_name then
			preload  = 'Template:documentation/preloadModuleSandbox'
		else
			preload  = 'Template:documentation/preloadModule'
		end
	elseif title.nsText == "Template" then
		pagetype = "template"
		preload  = 'Template:documentation/preloadTemplate'
	elseif title.nsText == "Wiktionary" then
		pagetype = "project page"
		preload  = 'Template:documentation/preloadTemplate' -- XXX
	end
	
	if doc_title.isRedirect then
		old_doc_title = doc_title
		doc_title = mw.title.new(string.match(doc_title:getContent(),
			"^#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]]-)%]%]"))
	end

	output:insert("<dl class=\"plainlinks\" style=\"font-size: smaller;\">")
	if doc_title.exists then
		output:insert(
			"<dd><i style=\"font-size: larger;\">The following " ..
			"[[wikt:Help:Documenting templates and modules|documentation]] is located at [[" ..
			doc_title.fullText .. "]]. " ..
			"<sup>[[" .. doc_title:fullUrl { action = 'edit' } .. " edit]]</sup> </i></dd>")
	else
		if contentModel == "Scribunto" then
			local automatic_cats = nil
			if user_name then
				fallback_docs = "documentation/fallback/user module"
				automatic_cats = {"User sandbox modules"}
			else
				for _, data in ipairs(module_regex) do
			        local captures = {mw.ustring.match(title.fullText, data.regex)}
			        if #captures > 0 then
						local cat
						local process_function
						if type(data.process) == "function" then
							process_function = data.process
						elseif type(data.process) == "string" then
							doc_content_module = "Module:documentation/functions/" .. data.process
							process_function = require(doc_content_module)
						end
						
						if process_function then
							doc_content = process_function(title, cats, unpack(captures))
						end
						cat = data.cat
						
						if cat then
							if type(cat) == "string" then
								cat = {cat}
							end
							for _, c in ipairs(cat) do
								-- gsub() and Lua :gsub() return two arguments, which causes all sorts of problems.
								-- Terrible design, there should have been a separate two-argument function.
								local gsub_sucks = mw.ustring.gsub(title.fullText, data.regex, c)
								table.insert(cats, gsub_sucks)
							end
						end
						break
					end
				end
			end

			if not automatic_cats then
				local success, auto_cats =
					pcall(require("Module:module categorization").categorize, frame, true)
				if success then
					for _, category in ipairs(auto_cats) do
						cats:insert(category)
					end
				end
			end

			if title.subpageText == "templates" then
				cats:insert("Template interface modules")
			end

			if automatic_cats then
				for _, c in ipairs(automatic_cats) do
					cats:insert(c)
				end
			end
			
			-- meaning module is not in user’s sandbox or one of many datamodule boring series
			needs_doc = not (automatic_cats or doc_content or fallback_docs)
		elseif title.nsText == "Template" then
			--cats:insert("Uncategorized templates")
			needs_doc = not (fallback_docs or nodoc)
		elseif (contentModel == "css") or (contentModel == "javascript") then
			if user_name then
				skin_name = skins[title.text:sub(#title.rootText + 1):match("^/([a-z]+)%.[jc]ss?$")]
				if skin_name then
					fallback_docs = 'documentation/fallback/user ' .. contentModel
				end
			end
		end
		
		if doc_content then
			output:insert(
				"<dd><i style=\"font-size: larger;\">The following " ..
				"[[wikt:Help:Documenting templates and modules|documentation]] is " ..
				"generated by [[" .. (doc_content_module or "Module:documentation") .. "]]. <sup>[[" ..
				mw.title.new("Module:documentation"):fullUrl { action = 'edit' } ..
				" edit]]</sup> </i></dd>")
		elseif not nodoc then
			output:insert(
				"<dd><i style=\"font-size: larger;\">This " .. pagetype ..
				" lacks a [[wikt:Help:Documenting templates and modules|documentation subpage]]. " ..
				(fallback_docs and "You may " or "Please ") ..
				"[" .. doc_title:fullUrl { action = 'edit', preload = preload }
				.. " create it].</i></dd>\n")
		end
	end
	
	if title.fullText:match("^MediaWiki:Gadget%-") then
		local is_gadget = false
		local gadget_list = mw.title.new("MediaWiki:Gadgets-definition"):getContent()
		
		for line in mw.text.gsplit(gadget_list, "\n") do
			local gadget, opts, items = line:match("^%*%s*([A-Za-z][A-Za-z0-9_%-]*)%[(.-)%]|(.+)$") -- opts is unused
			if not gadget then
				gadget, items = line:match("^%*%s*([A-Za-z][A-Za-z0-9_%-]*)|(.+)$")
			end
			
			if gadget then
				items = Array(mw.text.split(items, "|"))
				for i, item in ipairs(items) do
					if title.fullText == ("MediaWiki:Gadget-" .. item) then
						is_gadget = true

						output:insert("<dd> ''This script is a part of the <code>")
						output:insert(gadget)
						output:insert("</code> gadget ([")
						output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadgets-definition', 'action=edit')))
						output:insert(" edit definitions])'' <dl>")
						
						output:insert("<dd> ''Description ([")
						output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadget-' .. gadget, 'action=edit')))
						output:insert(" edit])'': ")
						
						local gadget_description = mw.message.new('Gadget-' .. gadget):plain()
						gadget_description = frame:preprocess(gadget_description)
						output:insert(gadget_description)
						output:insert(" </dd>")

						items:remove(i)
						if #items > 0 then
							for j, item in ipairs(items) do
								items[j] = '[[MediaWiki:Gadget-' .. item .. '|' .. item .. ']]'
							end
							output:insert("<dd> ''Other parts'': ")
							output:insert(mw.text.listToText(items))
							output:insert("</dd>")
						end

						output:insert("</dl></dd>")

						break
					end
				end
			end
		end
		
		if not is_gadget then
			output:insert("<dd> ''This script is not a part of any [")
			output:insert(tostring(mw.uri.fullUrl('Special:Gadgets', 'uselang=en')))
			output:insert(' gadget] ([')
			output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadgets-definition', 'action=edit')))
			output:insert(' edit definitions]).</dd>')
		-- else
			-- cats:insert("Wiktionary gadgets")
		end
	end
	
	if old_doc_title then
		output:insert("<dd> ''Redirected from'' [")
		output:insert(old_doc_title:fullUrl { redirect = 'no' })
		output:insert(" ")
		output:insert(old_doc_title.fullText)
		output:insert("] ([")
		output:insert(old_doc_title:fullUrl { action = 'edit' })
		output:insert(" edit]).</dd>\n")
	end
	
	local links = Array()
	
	if title.isSubpage and not args.notsubpage then
		links:insert("[[:" .. title.nsText .. ":" .. title.rootText .. "|root page]]")
		links:insert("[[Special:PrefixIndex/" .. title.nsText .. ":" .. title.rootText .. "/|root page’s subpages]]")
	else
		links:insert("[[Special:PrefixIndex/" .. title.fullText .. "/|subpage list]]")
	end
	
	links:insert(
		'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
			'hidetrans=1&hideredirs=1')) .. ' links]')

	if contentModel ~= "Scribunto" then
		links:insert(
			'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
			'hidelinks=1&hidetrans=1')) .. ' redirects]')
	end

	if (contentModel == "javascript") or (contentModel == "css") then
		if user_name then
			links:insert("[[Special:MyPage" .. title.text:sub(#title.rootText + 1) .. "|your own]]")
		end
	else
		links:insert(
			'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
				'hidelinks=1&hideredirs=1')) .. ' transclusions]')
	end
	
	if contentModel == "Scribunto" then
		local is_testcases = title.isSubpage and title.subpageText == "testcases"
		local without_subpage = title.nsText .. ":" .. title.baseText
		if is_testcases then
			links:insert("[[:" .. without_subpage .. "|tested module]]")
		else
			links:insert("[[" .. title.fullText .. "/testcases|testcases]]")
		end
		
		if user_name then
			links:insert("[[User:" .. user_name .. "|user page]]")
			links:insert("[[User talk:" .. user_name .. "|user talk page]]")
			links:insert("[[Special:PrefixIndex/User:" .. user_name .. "/|userspace]]")
		else
			-- If sandbox module, add a link to the module that this is a sandbox of.
			-- Exclude user sandbox modules like [[User:Dine2016/sandbox]].
			if title.text:find("/sandbox%d*%f[/%z]") then
				cats:insert("Sandbox modules")
				
				-- Sandbox modules don’t really need documentation.
				needs_doc = false
				
				-- Will behave badly if “/sandbox” occurs twice in title!
				local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
				
				local diff
				if page_exists(sandbox_of) then
					diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
				end
				
				links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
			
			-- If not a sandbox module, add link to sandbox module.
			-- Sometimes there are multiple sandboxes for a single module:
			-- [[Module:sa-pronunc/sandbox]],  [[Module:sa-pronunc/sandbox2]].
			-- Occasionally sandbox modules have their own subpages that are also
			-- sandboxes: [[Module:grc-decl/sandbox/decl]].
			else
				local sandbox_title
				if title.fullText:find("^Module:grc%-decl/") then
					sandbox_title = title.fullText:gsub("^Module:grc%-decl/", "Module:grc-decl/sandbox/")
				elseif is_testcases then
					sandbox_title = title.fullText:gsub("/testcases", "/sandbox/testcases")
				else
					sandbox_title = title.fullText .. "/sandbox"
				end
				local sandbox_link = "[[:" .. sandbox_title .. "|sandbox]]"
				
				local diff
				if page_exists(sandbox_title) then
					diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
				end
				
				links:insert(sandbox_link .. (diff or ""))
			end
		end
	end
	
	if title.nsText == "Template" then
		-- Error search: all(any namespace), hastemplate (show pages using the template), insource (show source code), incategory (any/specific error) -- [[mw:Help:CirrusSearch]], [[w:Help:Searching/Regex]]
		-- apparently same with/without: &profile=advanced&fulltext=1
		local errorq = 'searchengineselect=mediawiki&search=all: hastemplate:\"'..title.rootText..'\" insource:\"'..title.rootText..'\" incategory:'
		local eincategory = "Pages_with_module_errors|ParserFunction_errors|DisplayTitle_errors|Pages_with_ISBN_errors|Pages_with_ISSN_errors|Pages_with_reference_errors|Pages_with_syntax_highlighting_errors|Pages_with_TemplateStyles_errors"
		
		links:insert(
			'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..eincategory )) .. ' errors]'
			.. ' (' ..
			'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..'ParserFunction_errors' )) .. ' parser]'
			.. '/' ..
			'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..'Pages_with_module_errors' )) .. ' module]'
			.. ')'
		)
		
		if title.isSubpage and title.text:find("/sandbox%d*%f[/%z]") then -- This is a sandbox template.
			-- At the moment there are no user sandbox templates with subpage
			-- “/sandbox”.
			cats:insert("Sandbox templates")
			
			-- Sandbox templates don’t really need documentation.
			needs_doc = false
			
			-- Will behave badly if “/sandbox” occurs twice in title!
			local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
			
			local diff
			if page_exists(sandbox_of) then
				diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
			end
			
			links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
		else -- This is a template that can have a sandbox.
			local sandbox_title = title.fullText .. "/sandbox"
			
			local diff
			if page_exists(sandbox_title) then
				diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
			end
			
			links:insert("[[:" .. sandbox_title .. "|sandbox]]" .. (diff or ""))
		end
	end
	
	if #links > 0 then
		output:insert("<dd> ''Useful links'': " .. links:concat(" • ") .. "</dd>")
	end
	
	output:insert("</dl>\n")
	
	-- Show error from [[Module:category tree/topic cat/data]] on its submodules'
	-- documentation to, for instance, warn about duplicate labels.
	if title.fullText:find("Module:category tree/topic cat/data", 1, true) == 1 then
		local ok, err = pcall(require, "Module:category tree/topic cat/data")
		if not ok then
			output:insert('<span class="error">' .. err .. '</span>\n\n')
		end
	end
	
	if doc_title.exists then
		-- Override automatic documentation, if present.
		doc_content = frame:expandTemplate { title = doc_title.fullText }
	elseif not doc_content and fallback_docs then
		doc_content = frame:expandTemplate {
			title = fallback_docs;
			args = {
				['user'] = user_name;
				['page'] = title.fullText;
				['skin name'] = skin_name;
			}
		}
	end

	if doc_content then
		output:insert(doc_content)
	end

	output:insert(('\n<%s style="clear: both;" />'):format(args.hr == "below" and "hr" or "br"))
	
	if not cats[1] and not doc_content then
		if contentModel == "Scribunto" then
			cats:insert("Uncategorized modules")
		-- elseif title.nsText == "Template" then
			-- cats:insert("Uncategorized templates")
		end
	end
	
	if needs_doc then
		cats:insert("Templates and modules needing documentation")
	end
	
	for _, cat in ipairs(cats) do
		output:insert("[[Category:" .. cat .. "]]")
	end
	
	output:insert("</div>\n")

	return output:concat()
end

-- Used by {{translit module documentation}}.
function export.translitModuleLangList(frame)
	local pagename, subpage
	
	if frame.args[1] then
		pagename = frame.args[1]
	else
		local title = mw.title.getCurrentTitle()
		subpage = title.subpageText
		pagename = title.text
		
		if subpage ~= pagename then
			pagename = title.rootText
		end
	end
	
	local translitModule = pagename
	
	local languageObjects = require("Module:languages/byTranslitModule")(translitModule)
	local codeInPagename = pagename:match("^([%l-]+)%-.*translit$")
	
	local categories = Array()
	local codeInPagenameInList = false
	if codeInPagename then
		if languageObjects[1] and subpage ~= "documentation" then
			local agreement = languageObjects[2] and "s" or ""
			categories:insert("[[Category:Transliteration modules used by " ..
				#languageObjects .. " language" .. agreement .. "]]")
		end
		
		languageObjects = Array(languageObjects)
			:filter(
				function (lang)
					local result = lang:getCode() ~= codeInPagename
					codeInPagenameInList = codeInPagenameInList or result
					return result
				end)
	end
	
	if subpage ~= "documentation" then
		for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
			local script = require "Module:scripts".getByCode(script_code)
			if script then
				categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
			end
		end
	end
	
	if subpage ~= "documentation" and not page_exists("Module:" .. pagename .. "/testcases") then
		categories:insert("[[Category:Transliteration modules without a testcases subpage]]")
	end
	
	if not languageObjects[1] then
		return categories:concat()
	end
	
	local langs = Array(languageObjects)
		:sort(
			function(lang1, lang2)
				return lang1:getCode() < lang2:getCode()
			end)
		-- This will not error because languageObjects is not empty.
		:map(languageObjects[1].makeCategoryLink)
		:serial_comma_join()
	
	return "It is " .. ( codeInPagenameInList and "also" or "" ) ..
		" used to transliterate " .. langs .. "." .. categories:concat()
end

return export
Retrieved from "https://linguifex.com/w/index.php?title=Module:documentation&oldid=299261"