Linguifex

Module:documentation: Difference between revisions

← Older edit
No edit summary
No edit summary
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
local export = {}
local export = {}


local array_module = "Module:array"
local debug_track_module = "Module:debug/track"
local frame_module = "Module:frame"
local fun_is_callable_module = "Module:fun/isCallable"
local languages_module = "Module:languages"
local links_module = "Module:links"
local load_module = "Module:load"
local module_categorization_module = "Module:module categorization"
local number_list_show_module = "Module:number list/show"
local chemical_element_list_show_module = "Module:chemical element list/show"
local pages_module = "Module:pages"
local pages_module = "Module:pages"
local parameters_module = "Module:parameters"
local scripts_module = "Module:scripts"
local string_endswith_module = "Module:string/endswith"
local string_gline_module = "Module:string/gline"
local string_insert_module = "Module:string/insert"
local string_startswith_module = "Module:string/startswith"
local string_utilities_module = "Module:string utilities"
local template_parser_module = "Module:template parser"
local title_exists_module = "Module:title/exists"
local title_new_title_module = "Module:title/newTitle"


local m_pages = require(pages_module)
local concat = table.concat
local error = error
local full_url = mw.uri.fullUrl
local get_current_title = mw.title.getCurrentTitle
local insert = table.insert
local ipairs = ipairs
local list_to_text = mw.text.listToText
local new_message = mw.message.new
local pcall = pcall
local require = require
local tonumber = tonumber
local tostring = tostring
local type = type
local unpack = unpack or table.unpack -- Lua 5.2 compatibility


local get_pagetype = m_pages.get_pagetype
local function Array(...)
local is_documentation = m_pages.is_documentation
Array = require(array_module)
local is_sandbox = m_pages.is_sandbox
return Array(...)
end
 
local function categorize_module(...)
categorize_module = require(module_categorization_module).categorize
return categorize_module(...)
end
 
local function debug_track(...)
debug_track = require(debug_track_module)
return debug_track(...)
end
 
local function endswith(...)
endswith = require(string_endswith_module)
return endswith(...)
end
 
local function expand_template(...)
expand_template = require(frame_module).expandTemplate
return expand_template(...)
end
 
local function find_templates(...)
find_templates = require(template_parser_module).find_templates
return find_templates(...)
end
 
local function full_link(...)
full_link = require(links_module).full_link
return full_link(...)
end
 
local function get_lang(...)
get_lang = require(languages_module).getByCode
return get_lang(...)
end


-- it is either here, or in [[Module:ugly hacks]], and it is not in ugly hacks.
local function get_pagetype(...)
function export.CONTENTMODEL()
get_pagetype = require(pages_module).get_pagetype
return mw.title.getCurrentTitle().contentModel
return get_pagetype(...)
end
 
local function get_script(...)
get_script = require(scripts_module).getByCode
return get_script(...)
end
 
local function gline(...)
gline = require(string_gline_module)
return gline(...)
end
 
local function is_callable(...)
is_callable = require(fun_is_callable_module)
return is_callable(...)
end
 
local function is_documentation(...)
is_documentation = require(pages_module).is_documentation
return is_documentation(...)
end
 
local function is_sandbox(...)
is_sandbox = require(pages_module).is_sandbox
return is_sandbox(...)
end
 
local function new_title(...)
new_title = require(title_new_title_module)
return new_title(...)
end
 
local function number_list_show_table(...)
number_list_show_table = require(number_list_show_module).table
return number_list_show_table(...)
end
 
local function chemical_element_list_show_table(...)
chemical_element_list_show_table = require(chemical_element_list_show_module).table
return chemical_element_list_show_table(...)
end
 
local function preprocess(...)
preprocess = require(frame_module).preprocess
return preprocess(...)
end
 
local function process_params(...)
process_params = require(parameters_module).process
return process_params(...)
end
 
local function safe_load_data(...)
safe_load_data = require(load_module).safe_load_data
return safe_load_data(...)
end
 
local function split(...)
split = require(string_utilities_module).split
return split(...)
end
 
local function startswith(...)
startswith = require(string_startswith_module)
return startswith(...)
end
 
local function string_insert(...)
string_insert = require(string_insert_module)
return string_insert(...)
end
 
local function title_exists(...)
title_exists = require(title_exists_module)
return title_exists(...)
end
 
local function ugsub(...)
ugsub = require(string_utilities_module).gsub
return ugsub(...)
end
 
local function umatch(...)
umatch = require(string_utilities_module).match
return umatch(...)
end
end


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


local Array = require "Module:array"
local function track(page)
debug_track("documentation/" .. page)
return true
end


local function compare_pages(page1, page2, text)
local function compare_pages(page1, page2, text)
return "[" .. tostring(
return "[" .. tostring(
mw.uri.fullUrl("Special:ComparePages", {page1 = page1, page2 = page2}))
full_url("Special:ComparePages", { page1 = page1, page2 = page2 }))
.. " " .. text .. "]"
.. " " .. text .. "]"
end
local function page_exists(title)
local success, title_obj = pcall(mw.title.new, title)
return success and title_obj.exists
end
end


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


local function zh_link(word)
local function zh_link(word)
return require("Module:links").full_link{
return full_link {
lang = lang_cache.zh,
lang = lang_cache.zh,
term = word
term = word
Line 49: Line 203:
local function make_languages_data_documentation(title, cats, division)
local function make_languages_data_documentation(title, cats, division)
local doc_template, module_cat
local doc_template, module_cat
if division:find("/extra$") then
if endswith(division, "/extra") then
division = division:gsub("/extra$", "")
division = division:sub(1, -7)
doc_template = "language extradata documentation"
doc_template = "language extradata documentation"
module_cat = "Language extra data modules"
module_cat = "Language extra data modules"
Line 71: Line 225:
local function make_Unicode_data_documentation(title, cats)
local function make_Unicode_data_documentation(title, cats)
local subpage, first_three_of_code_point
local subpage, first_three_of_code_point
= title.fullText:match("^Module:Unicode data/([^/]+)/(%x%x%x)$")
= title.fullText:match("^Module:Unicode data/([^/]+)/(%x%x%x)$")
if subpage == "names" or subpage == "images" or subpage == "emoji images" then
if subpage == "names" or subpage == "images" or subpage == "emoji images" then
local low, high =
local low, high =
Line 86: Line 240:
text = string.format(
text = string.format(
"This data module contains the " .. text_type .. " of " ..
"This data module contains the " .. text_type .. " of " ..
"[[Appendix:Unicode|Unicode]] code points within the range U+%04X to U+%04X.",
"[[wikt:Appendix:Unicode|Unicode]] code points within the range U+%04X to U+%04X.",
low, high)
low, high)
if subpage == "images" and pcall(mw.loadData, "Module:Unicode data/emoji images/" .. first_three_of_code_point) then
if subpage == "images" and safe_load_data("Module:Unicode data/emoji images/" .. first_three_of_code_point) then
text = text .. " This list includes the text variants of emojis. For the list of emoji variants of those characters, see [[Module:Unicode data/emoji images/" .. first_three_of_code_point .. "]]."
text = text ..
" This list includes the text variants of emojis. For the list of emoji variants of those characters, see [[Module:Unicode data/emoji images/" ..
first_three_of_code_point .. "]]."
elseif subpage == "emoji images" then
elseif subpage == "emoji images" then
text = text .. " For text-style images, see [[Module:Unicode data/images/" .. first_three_of_code_point .. "]]."
text = text ..
" For text-style images, see [[Module:Unicode data/images/" .. first_three_of_code_point .. "]]."
end
end
return text
return text
Line 100: Line 257:
local lang = lang_cache[langcode]
local lang = lang_cache[langcode]
if lang then
if lang then
local langname = lang:getCanonicalName()
local langname
if lang._fullCode then
langname = lang_cache[lang._fullCode]:getCanonicalName()
else
langname = lang:getCanonicalName()
end
cats:insert(overall_data_module_cat .. "|" .. langname)
cats:insert(overall_data_module_cat .. "|" .. langname)
cats:insert(langname .. " modules")
cats:insert(langname .. " modules")
Line 121: Line 283:
where:
where:
  * TITLE is a title object describing the module's title; see
  * TITLE is a title object describing the module's title; see
    [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Title_objects].
[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.
  * 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.
  * CAPTURE1, CAPTURE2, ... contain any captures in the `regex` field.
Line 147: Line 309:
local module_regex = {
local module_regex = {
{
{
regex = "^Module:languages/data/(3/[a-z]/extra)$",
regex = "^Module:languages/data/(3/%l/extra)$",
process = make_languages_data_documentation,
process = make_languages_data_documentation,
},
},
{
{
regex = "^Module:languages/data/(3/[a-z])$",
regex = "^Module:languages/data/(3/%l)$",
process = make_languages_data_documentation,
process = make_languages_data_documentation,
},
},
Line 235: Line 397:
regex = "^Module:number list/data/(.+)$",
regex = "^Module:number list/data/(.+)$",
process = function(title, cats, lang_code)
process = function(title, cats, lang_code)
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Number data modules")
local lang = insert_lang_data_module_cats(cats, lang_code, "Number data modules")
if lang then
if lang then
return ("This module contains data on various types of numbers in %s.\n%s")
return ("This module contains data on various types of numbers in %s.\n%s")
:format(lang:makeCategoryLink(), require("Module:number list/show").table() or "")
:format(lang:makeCategoryLink(), number_list_show_table() or "")
end
end
end,
end,
},
},
{
regex = "^Module:chemical element list/data/(.+)$",
process = function(title, cats, lang_code)
local lang = insert_lang_data_module_cats(cats, lang_code, "Chemical element data modules")
if lang then
return ("This module contains data on chemical elements in %s.\n%s")
:format(lang:makeCategoryLink(), chemical_element_list_show_table() or "")
end
end,
},
{
{
regex = "^Module:accel/(.+)$",
regex = "^Module:accel/(.+)$",
Line 250: Line 422:
cats:insert(lang:getCanonicalName() .. " modules|accel")
cats:insert(lang:getCanonicalName() .. " modules|accel")
cats:insert(("Accel submodules|%s"):format(lang:getCanonicalName()))
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.")
return ("This module contains new entry creation rules for %s; see [[wikt:WT:ACCEL|WT:ACCEL]] for an overview, and [[Module:accel]] for information on creating new rules.")
:format(lang:makeCategoryLink())
:format(lang:makeCategoryLink())
end
end
Line 263: Line 435:
local lang = lang_cache["inc-ash"]
local lang = lang_cache["inc-ash"]
return ("This module contains data on the pronunciation of %s in dialects of %s.")
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"),
:format(full_link({ term = word, lang = lang }, "term"),
lang:makeCategoryLink())
lang:makeCategoryLink())
end
end
Line 286: Line 458:
regex = "^Module:labels/data/lang/(.+)$",
regex = "^Module:labels/data/lang/(.+)$",
process = function(title, cats, lang_code)
process = function(title, cats, lang_code)
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Language-specific label data modules")
local lang = insert_lang_data_module_cats(cats, lang_code, "Language-specific label data modules")
if lang then
if lang then
return {
return {
Line 296: Line 468:
},
},
{
{
regex = "^Module:category tree/poscatboiler/data/lang%-specific/(.+)$",
regex = "^Module:category tree/lang/(.+)$",
process = function(title, cats, lang_code)
process = function(title, cats, lang_code)
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Category tree data modules/poscatboiler")
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Category tree data modules/lang")
if lang then
if lang then
return "This module handles generating the descriptions and categorization for " .. langname .. " category pages "
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 "
.. "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]]. "
.. "[[: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 "
.. "This module is part of the category tree system, which is a general framework for generating the "
.. "descriptions and categorization of category pages.\n\n"
.. "descriptions and categorization of category pages.\n\n"
.. "For more information, see [[Module:category tree/poscatboiler/data/lang-specific/documentation]].\n\n"
.. "For more information, see [[wikt:Module:category tree/lang/documentation|Module:category tree/lang/documentation]].\n\n"
.. "'''NOTE:''' If you add a new language-specific module, you must add the language code to the "
.. "'''NOTE:''' If you add a new language-specific module, you must add the language code to the "
.. "list at the top of [[Module:category tree/poscatboiler/data/lang-specific]] in order for the module to be "
.. "list at the top of [[Module:category tree/lang]] in order for the module to be recognized."
.. "recognized."
end
end
end
end
},
},
{
{
regex = "^Module:category tree/poscatboiler/data/(.+)$",
regex = "^Module:category tree/topic/(.+)$",
process = function(title, cats, submodule)
process = function(title, cats, submodule)
cats:insert("Category tree data modules/poscatboiler| ")
cats:insert("Category tree data modules/topic| ")
return {
return {
title = "poscatboiler data submodule documentation"
title = "topic cat data submodule documentation"
}
}
end
end
},
},
{
{
regex = "^Module:category tree/topic cat/data/(.+)$",
regex = "^Module:category tree/(.+)$",
process = function(title, cats, submodule)
process = function(title, cats, submodule)
cats:insert("Category tree data modules/topic cat| ")
cats:insert("Category tree data modules| ")
return {
return {
title = "topic cat data submodule documentation"
title = "category tree data submodule documentation"
}
}
end
end
Line 353: Line 525:
},
},
{
{
regex = "^Module:Swadesh/data/([a-z-]+)$",
regex = "^Module:Swadesh/data/([%l-]+)$",
process = function(title, cats, lang_code)
process = function(title, cats, lang_code)
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Swadesh modules")
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Swadesh modules")
if lang then
if lang then
return "This module contains the [[Swadesh list]] of basic vocabulary in " .. langname .. "."
return "This module contains the [[wikt:Swadesh list|Swadesh list]] of basic vocabulary in " .. langname .. "."
end
end
end
end
},
},
{
{
regex = "^Module:Swadesh/data/([a-z-]+)/([^/]*)$",
regex = "^Module:Swadesh/data/([%l-]+)/([^/]*)$",
process = function(title, cats, lang_code, variety)
process = function(title, cats, lang_code, variety)
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Swadesh modules")
local lang, langname = insert_lang_data_module_cats(cats, lang_code, "Swadesh modules")
if lang then
if lang then
local prefix = "This module contains the [[Swadesh list]] of basic vocabulary in the "
local prefix = "This module contains the [[wikt:Swadesh list|Swadesh list]] of basic vocabulary in the "
local etym_lang = require("Module:languages").getByCode(variety, nil, "allow etym")
local etym_lang = get_lang(variety, nil, "allow etym")
if etym_lang then
if etym_lang then
return ("%s %s variety of %s."):format(prefix, etym_lang:getCanonicalName(), langname)
return ("%s %s variety of %s."):format(prefix, etym_lang:getCanonicalName(), langname)
end
end
local script = require("Module:scripts").getByCode(variety)
local script = get_script(variety)
if script then
if script then
return ("%s %s %s script."):format(prefix, langname, script:getCanonicalName())
return ("%s %s %s script."):format(prefix, langname, script:getCanonicalName())
Line 386: Line 558:
if data_suffix then
if data_suffix then
if data_suffix:find "^[%l-]+$" then
if data_suffix:find "^[%l-]+$" then
local lang = require("Module:languages").getByCode(data_suffix)
local lang = get_lang(data_suffix)
if lang then
if lang then
sortkey = lang:getCanonicalName()
sortkey = lang:getCanonicalName()
Line 392: Line 564:
end
end
elseif data_suffix:find "^%u%l%l%l$" then
elseif data_suffix:find "^%u%l%l%l$" then
local script = require("Module:scripts").getByCode(data_suffix)
local script = get_script(data_suffix)
if script then
if script then
sortkey = script:getCanonicalName()
sortkey = script:getCanonicalName()
Line 403: Line 575:
},
},
{
{
regex = "^Module:R:([a-z%-]+):(.+)$",
regex = "^Module:R:([%l-]+):(.+)$",
process = function(title, cats, lang_code, refname)
process = function(title, cats, lang_code, refname)
local lang = lang_cache[lang_code]
local lang = lang_cache[lang_code]
Line 409: Line 581:
cats:insert(lang:getCanonicalName() .. " modules|" .. refname)
cats:insert(lang:getCanonicalName() .. " modules|" .. refname)
cats:insert(("Reference modules|%s"):format(lang:getCanonicalName()))
cats:insert(("Reference modules|%s"):format(lang:getCanonicalName()))
return "This module implements the reference template {{temp|R:" .. lang_code .. ":" .. refname .. "}}."
return "This module implements the reference template {{temp|R:" .. lang_code .. ":" .. refname .. "}}."
end
end
end,
end,
},
},
{
{
regex = "^Module:Quotations/([a-z-]+)/?(.*)",
regex = "^Module:Quotations/([%l-]+)/?(.*)",
process = "Quotation",
process = "Quotation",
},
},
{
{
regex = "^Module:affix/lang%-data/([a-z-]+)",
regex = "^Module:affix/lang%-data/([%l-]+)",
process = "affix lang-data",
process = "affix lang-data",
},
},
{
{
regex = "^Module:dialect synonyms/([a-z-]+)$",
regex = "^Module:dialect synonyms/([%l-]+)$",
process = function(title, cats, lang_code)
process = function(title, cats, lang_code)
local lang = lang_cache[lang_code]
local lang = lang_cache[lang_code]
Line 430: Line 602:
cats:insert(langname .. " dialect synonyms data modules| ")
cats:insert(langname .. " dialect synonyms data modules| ")
return "This module contains data on specific varieties of " .. langname .. ", for use by " ..
return "This module contains data on specific varieties of " .. langname .. ", for use by " ..
"{{tl|dialect synonyms}}. The actual synonyms themselves are contained in submodules."
"{{tl|dialect synonyms}}. The actual synonyms themselves are contained in submodules.\n\n" ..
"==== Language data module structure ====\n" ..
"* <code>export.title</code> — optional; table title template (e.g. \"Regional synonyms of %s\").\n" ..
"* <code>export.columns</code> — optional; list of column headers for location hierarchy (e.g. {\"Dialect group\", \"Dialect\", \"Location\"}).\n" ..
"* <code>export.notes</code> — optional; table of note keys to text.\n" ..
"* <code>export.sources</code> — optional; table of source keys to text.\n" ..
"* <code>export.note_aliases</code> — optional; alias map for notes.\n" ..
"* <code>export.varieties</code> — required; nested table of variety nodes. Each node must have <code>name</code>; array part holds children. Node keys can include <code>text_display</code>, <code>color</code>, <code>code</code>, <code>wikidata</code>, <code>lat</code>, <code>long</code>, and language-specific keys (e.g. <code>persian</code>, <code>armenian</code>, <code>chinese</code>).\n\n" ..
expand_template({ title = 'dial syn', args = { lang_code, ["demo mode"] = "y" } })
end
end
end,
end,
},
},
{
{
regex = "^Module:dialect synonyms/([a-z-]+)/(.+)$",
regex = "^Module:dialect synonyms/([%l-]+)/([^/]+)$",
process = function(title, cats, lang_code, term)
process = function(title, cats, lang_code, term)
local lang = lang_cache[lang_code]
local lang = lang_cache[lang_code]
Line 442: Line 622:
cats:insert("Dialect synonyms data modules|" .. langname)
cats:insert("Dialect synonyms data modules|" .. langname)
cats:insert(langname .. " dialect synonyms data modules|" .. term)
cats:insert(langname .. " dialect synonyms data modules|" .. term)
return ("This module contains dialectal %s synonyms for {{m|%s|%s}}."):format(langname, lang_code, term)
return ("%s\n\n%s"):format(
"==== Term/sense module structure ====\n" ..
"* <code>export.title</code> — optional; custom table title (e.g. \"Realization of 'strong R' between vowels\"). Overrides the language default.\n" ..
"* <code>export.meaning</code> — optional; meaning/gloss (alternative to <code>gloss</code>).\n" ..
"* <code>export.gloss</code> — optional; short meaning for the table.\n" ..
"* <code>export.note</code> — optional; single note key or string, or list of note keys.\n" ..
"* <code>export.notes</code> — optional; list of note keys.\n" ..
"* <code>export.source</code> / <code>export.sources</code> — optional; source keys.\n" ..
"* <code>export.last_column</code> — optional; label for the data column (default \"Words\"; e.g. \"Realization\").\n" ..
"* <code>export.syns</code> — required; table mapping variety/location names (keys from the language data module) to a list of term entries. Each entry can be a string or a table (e.g. <code>{ ipa = \"[ɽ]\" }</code> or <code>{ term = \"word\" }</code>).\n\n" ..
"Example (custom title and data column, IPA realizations):\n" ..
"<pre>\nlocal export = {}\n\nexport.title = \"Realization of 'strong R' between vowels\"\n" ..
"export.meaning = \"\"\nexport.note = \"realization of 'strong R' between vowels\"\n" ..
"export.last_column = \"Realization\"\n\nexport.syns = {\n\t[\"ALERS-158\"] = { { ipa = \"[ɽ]\" } },\n\t[\"ALERS-175\"] = { { ipa = \"[x]\" } },\n}\n\nreturn export\n</pre>\n\n",
expand_template({ title = 'dial syn', args = { lang_code, term } }))
end
end,
},
{
regex = "^Module:dialect synonyms/([%l-]+)/([^/]+)/([^/]+)$",
process = function(title, cats, lang_code, term, id)
local lang = lang_cache[lang_code]
if lang then
local langname = lang:getCanonicalName()
cats:insert("Dialect synonyms data modules|" .. langname)
cats:insert(langname .. " dialect synonyms data modules|" .. term)
return ("%s\n\n%s"):format(
"==== Term/sense module structure ====\n" ..
"* <code>export.title</code> — optional; custom table title (e.g. \"Realization of 'strong R' between vowels\"). Overrides the language default.\n" ..
"* <code>export.meaning</code> — optional; meaning/gloss (alternative to <code>gloss</code>).\n" ..
"* <code>export.gloss</code> — optional; short meaning for the table.\n" ..
"* <code>export.note</code> — optional; single note key or string, or list of note keys.\n" ..
"* <code>export.notes</code> — optional; list of note keys.\n" ..
"* <code>export.source</code> / <code>export.sources</code> — optional; source keys.\n" ..
"* <code>export.last_column</code> — optional; label for the data column (default \"Words\"; e.g. \"Realization\").\n" ..
"* <code>export.syns</code> — required; table mapping variety/location names (keys from the language data module) to a list of term entries. Each entry can be a string or a table (e.g. <code>{ ipa = \"[ɽ]\" }</code> or <code>{ term = \"word\" }</code>).\n\n" ..
"Example (custom title and data column, IPA realizations):\n" ..
"<pre>\nlocal export = {}\n\nexport.title = \"Realization of 'strong R' between vowels\"\n" ..
"export.meaning = \"\"\nexport.note = \"realization of 'strong R' between vowels\"\n" ..
"export.last_column = \"Realization\"\n\nexport.syns = {\n\t[\"ALERS-158\"] = { { ipa = \"[ɽ]\" } },\n\t[\"ALERS-175\"] = { { ipa = \"[x]\" } },\n}\n\nreturn export\n</pre>\n\n",
expand_template({ title = 'dial syn', args = { lang_code, term, id = id } }))
end
end
end,
},
{
regex = "^Module:bibliography/data/([%l-]+)$",
process = function(title, cats, lang_code)
if lang_code == "preload" then
return 'Used as a base model for other languages when the button "create new language submodule" is clicked.'
end
local page = require(title.fullText).bib_page
if not page then
page = lang_cache[lang_code]:getCanonicalName()
if page then
cats:insert(page .. " modules")
end
end
cats:insert("Reference modules")
return "This module holds bibliographical data for " ..
page .. ". For the formatted bibliography see '''[[wikt:Appendix:Bibliography/" .. page .. "|Appendix:Bibliography/" .. page .. "]]'''."
end,
end,
},
},
Line 449: Line 687:


function export.show(frame)
function export.show(frame)
local boolean_default_false = {type = "boolean", default = false}
local boolean_default_false = { type = "boolean", default = false }
local args = require("Module:parameters").process(frame.args, {
local args = process_params(frame.args, {
["hr"] = true,
["hr"] = true,
["for"] = true,
["for"] = true,
Line 460: Line 698:
["nosandbox"] = boolean_default_false, -- supress sandbox
["nosandbox"] = boolean_default_false, -- supress sandbox
})
})
 
local output = Array('\n<div class="documentation" style="display:block; clear:both">\n')
local output = Array('\n<div class="documentation" style="display:block; clear:both">\n')
local cats = Array()
local cats = Array()
 
local nodoc = args.nodoc
local nodoc = args.nodoc
 
if (not args.hr) or (args.hr == "above") then
if (not args.hr) or (args.hr == "above") then
output:insert("----\n")
output:insert("----\n")
end
end
 
local title = args["for"] and mw.title.new(args["for"]) or mw.title.getCurrentTitle()
local title = args["for"] and new_title(args["for"]) or get_current_title()
local doc_title = args.from ~= "-" and mw.title.new(args.from or title.fullText .. '/doc') or nil
local doc_title = args.from ~= "-" and new_title(args.from or title.fullText .. '/doc') or nil
local contentModel = title.contentModel
local contentModel = title.contentModel
local pagetype, is_script_or_stylesheet = get_pagetype(title)
local pagetype, is_script_or_stylesheet = get_pagetype(title)
Line 478: Line 716:
local auto_generated_cat_source
local auto_generated_cat_source
local cats_auto_generated = false
local cats_auto_generated = false
 
if not args.allowondoc and is_documentation(title) then
if not args.allowondoc and is_documentation(title) then
-- TODO: merge with {{documentation subpage}}, and choose behaviour based on the page type.
-- TODO: merge with {{documentation subpage}}, and choose behaviour based on the page type.
Line 494: Line 732:
preload = "Template:documentation/preloadMediaWikiJavaScript"
preload = "Template:documentation/preloadMediaWikiJavaScript"
else
else
preload = "Template:documentation/preloadTemplate" -- XXX
preload = "Template:documentation/preloadTemplate" -- XXX
if title.nsText == "User" then
if title.nsText == "User" then
user_name = title.rootText
user_name = title.rootText
Line 501: Line 739:
is_script_or_stylesheet = true
is_script_or_stylesheet = true
elseif pagetype:match("%f[%w]stylesheet%f[%W]") then -- .css
elseif pagetype:match("%f[%w]stylesheet%f[%W]") then -- .css
preload = "Template:documentation/preloadTemplate" -- XXX
preload = "Template:documentation/preloadTemplate" -- XXX
if title.nsText == "User" then
if title.nsText == "User" then
user_name = title.rootText
user_name = title.rootText
Line 507: Line 745:
is_script_or_stylesheet = true
is_script_or_stylesheet = true
elseif contentModel == "Scribunto" then -- Exclude pages in Module: which aren't Scribunto.
elseif contentModel == "Scribunto" then -- Exclude pages in Module: which aren't Scribunto.
preload = "Template:documentation/preloadModule"
preload = "Template:documentation/preloadModule"
elseif pagetype:match("%f[%w]template%f[%W]") or pagetype:match("%f[%w]project%f[%W]") then
elseif pagetype:match("%f[%w]template%f[%W]") or pagetype:match("%f[%w]project%f[%W]") then
preload = "Template:documentation/preloadTemplate"
preload = "Template:documentation/preloadTemplate"
end
end


Line 524: Line 762:
if user_name then
if user_name then
fallback_docs = "documentation/fallback/user module"
fallback_docs = "documentation/fallback/user module"
automatic_cats = {"User sandbox modules"}
automatic_cats = { "User sandbox modules" }
else
else
for _, data in ipairs(module_regex) do
for _, data in ipairs(module_regex) do
local captures = {mw.ustring.match(title.fullText, data.regex)}
local captures = { umatch(title.fullText, data.regex) }
if #captures > 0 then
if #captures > 0 then
local cat
local cat, process_function
local process_function
if is_callable(data.process) then
if type(data.process) == "function" then
process_function = data.process
process_function = data.process
elseif type(data.process) == "string" then
elseif type(data.process) == "string" then
Line 543: Line 780:
if type(doc_content) == "table" then
if type(doc_content) == "table" then
doc_content_source = doc_content.title and "Template:" .. doc_content.title or doc_content_source
doc_content_source = doc_content.title and "Template:" .. doc_content.title or doc_content_source
doc_content = mw.getCurrentFrame():expandTemplate(doc_content)
doc_content = expand_template(doc_content)
elseif doc_content and doc_content:find("{{") then
elseif doc_content ~= nil then
doc_content = mw.getCurrentFrame():preprocess(doc_content)
doc_content = preprocess(doc_content)
end
end
cat = data.cat
cat = data.cat
 
if cat then
if cat then
if type(cat) == "string" then
if type(cat) == "string" then
cat = {cat}
cat = { cat }
end
end
for _, c in ipairs(cat) do
for _, c in ipairs(cat) do
-- gsub() and Lua :gsub() return two arguments, which causes all sorts of problems.
insert(cats, (ugsub(title.fullText, data.regex, c)))
-- 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
end
end
Line 574: Line 808:
end
end
end
end
 
if #cats == 0 then
if #cats == 0 then
local auto_cats = require("Module:module categorization").categorize(frame, "return raw", "noerror")
local auto_cats = categorize_module(frame, "return raw", "noerror")
if #auto_cats > 0 then
if #auto_cats > 0 then
auto_generated_cat_source = "Module:module categorization"
auto_generated_cat_source = "Module:module categorization"
Line 593: Line 827:
local cats_auto_generated_text = ""
local cats_auto_generated_text = ""
if contentModel == "Scribunto" then
if contentModel == "Scribunto" then
local doc_page_content = doc_title:getContent()
local doc_page_content = doc_title.content
-- Track then do nothing if there are uses of includeonly. The
-- Track then do nothing if there are uses of includeonly. The
-- pattern is slightly too permissive, but any false-positives are
-- pattern is slightly too permissive, but any false-positives are
-- obvious typos that should be corrected.
-- obvious typos that should be corrected.
if doc_page_content:lower():match("</?includeonly%f[%s/>][^>]*>") then
if doc_page_content:lower():match("</?includeonly%f[%s/>][^>]*>") then
track("module-includeonly")
else
else
-- Check for uses of {{module cat}}. find_templates treats the
-- Check for uses of {{module cat}}. find_templates treats the
Line 603: Line 838:
-- which will be transcluded through to the module page).
-- which will be transcluded through to the module page).
local module_cat
local module_cat
for template in require("Module:template parser").find_templates(doc_page_content) do
for template in find_templates(doc_page_content) do
if template:get_name() == "module cat" then
if template:get_name() == "module cat" then
module_cat = true
module_cat = true
Line 612: Line 847:
get_module_doc_and_cats("categories only")
get_module_doc_and_cats("categories only")
auto_generated_cat_source = auto_generated_cat_source or doc_content_source
auto_generated_cat_source = auto_generated_cat_source or doc_content_source
cats_auto_generated_text = " Categories were auto-generated by [[" .. auto_generated_cat_source .. "]]. <sup>[[" ..
cats_auto_generated_text = " Categories were auto-generated by [[" ..
mw.title.new(auto_generated_cat_source):fullUrl{action = "edit"} .. " edit]]</sup>"
auto_generated_cat_source .. "]]. <sup>[[" ..
new_title(auto_generated_cat_source):fullUrl { action = "edit" } .. " edit]]</sup>"
end
end
end
end
Line 621: Line 857:
"<dd><i style=\"font-size: larger;\">The following " ..
"<dd><i style=\"font-size: larger;\">The following " ..
"[[wikt:Help:Documenting templates and modules|documentation]] is located at [[" ..
"[[wikt:Help:Documenting templates and modules|documentation]] is located at [[" ..
doc_title.fullText .. "]]. " .. "<sup>[[" .. doc_title:fullUrl{action = "edit"} .. " edit]]</sup>" ..
doc_title.fullText .. "]]. " .. "<sup>[[" .. doc_title:fullUrl { action = "edit" } .. " edit]]</sup>" ..
cats_auto_generated_text .. "</i></dd>")
cats_auto_generated_text .. "</i></dd>")
else
else
Line 630: Line 866:
needs_doc = not (fallback_docs or nodoc)
needs_doc = not (fallback_docs or nodoc)
elseif user_name and is_script_or_stylesheet then
elseif user_name and is_script_or_stylesheet then
skin_name = skins[title.text:sub(#title.rootText + 1):match("^/([a-z]+)%.[jc]ss?$")]
skin_name = skins[title.text:sub(#title.rootText + 1):match("^/(%l+)%.[jc]ss?$")]
if skin_name then
if skin_name then
fallback_docs = "documentation/fallback/user " .. contentModel
fallback_docs = "documentation/fallback/user " .. contentModel
end
end
end
end
 
if doc_content then
if doc_content then
output:insert(
output:insert(
Line 641: Line 877:
"[[wikt:Help:Documenting templates and modules|documentation]] is " ..
"[[wikt:Help:Documenting templates and modules|documentation]] is " ..
"generated by [[" .. doc_content_source .. "]]. <sup>[[" ..
"generated by [[" .. doc_content_source .. "]]. <sup>[[" ..
mw.title.new(doc_content_source):fullUrl{action = "edit"} ..
new_title(doc_content_source):fullUrl { action = "edit" } ..
" edit]]</sup> </i></dd>")
" edit]]</sup> </i></dd>")
elseif not nodoc then
elseif not nodoc then
Line 649: Line 885:
" lacks a [[wikt:Help:Documenting templates and modules|documentation subpage]]. " ..
" lacks a [[wikt:Help:Documenting templates and modules|documentation subpage]]. " ..
(fallback_docs and "You may " or "Please ") ..
(fallback_docs and "You may " or "Please ") ..
"[" .. doc_title:fullUrl{action = "edit", preload = preload}
"[" .. doc_title:fullUrl { action = "edit", preload = preload }
.. " create it].</i></dd>\n")
.. " create it].</i></dd>\n")
else
else
output:insert(
output:insert(
"<dd><i style=\"font-size: larger; color: #FF0000;\">Unable to auto-generate " ..
"<dd><i style=\"font-size: larger; color: var(--wikt-palette-red-9,#FF0000);\">Unable to auto-generate " ..
"documentation for this " .. pagetype ..".</i></dd>\n")
"documentation for this " .. pagetype .. ".</i></dd>\n")
end
end
end
end
end
end
 
if title.fullText:match("^MediaWiki:Gadget%-") then
if startswith(title.fullText, "MediaWiki:Gadget-") then
local is_gadget = false
local is_gadget = false
local gadget_list = mw.title.new("MediaWiki:Gadgets-definition"):getContent()
for line in gline(new_title("MediaWiki:Gadgets-definition").content) do
local gadget, items = line:match("^%*%s*(%a[%w_-]*)%[.-%]|(.+)$")
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
if not gadget then
gadget, items = line:match("^%*%s*([A-Za-z][A-Za-z0-9_%-]*)|(.+)$")
gadget, items = line:match("^%*%s*(%a[%w_-]*)|(.+)$")
end
end
if gadget then
if gadget then
items = Array(mw.text.split(items, "|"))
items = Array(split(items, "|"))
for i, item in ipairs(items) do
for i, item in ipairs(items) do
if title.fullText == ("MediaWiki:Gadget-" .. item) then
if title.fullText == ("MediaWiki:Gadget-" .. item) then
Line 678: Line 911:
output:insert(gadget)
output:insert(gadget)
output:insert("</code> gadget ([")
output:insert("</code> gadget ([")
output:insert(tostring(mw.uri.fullUrl("MediaWiki:Gadgets-definition", {action = "edit"})))
output:insert(tostring(full_url("MediaWiki:Gadgets-definition", { action = "edit" })))
output:insert(" edit definitions])'' <dl>")
output:insert(" edit definitions])'' <dl>")
 
output:insert("<dd> ''Description ([")
output:insert("<dd> ''Description ([")
output:insert(tostring(mw.uri.fullUrl("MediaWiki:Gadget-" .. gadget, {action = "edit"})))
output:insert(tostring(full_url("MediaWiki:Gadget-" .. gadget, { action = "edit" })))
output:insert(" edit])'': ")
output:insert(" edit])'': ")
 
local gadget_description = mw.message.new('Gadget-' .. gadget):plain()
output:insert(preprocess(new_message('Gadget-' .. gadget):plain()))
gadget_description = frame:preprocess(gadget_description)
output:insert(gadget_description)
output:insert(" </dd>")
output:insert(" </dd>")


Line 696: Line 927:
end
end
output:insert("<dd> ''Other parts'': ")
output:insert("<dd> ''Other parts'': ")
output:insert(mw.text.listToText(items))
output:insert(list_to_text(items))
output:insert("</dd>")
output:insert("</dd>")
end
end
Line 707: Line 938:
end
end
end
end
 
if not is_gadget then
if not is_gadget then
output:insert("<dd> ''This script is not a part of any [")
output:insert("<dd> ''This script is not a part of any [")
output:insert(tostring(mw.uri.fullUrl("Special:Gadgets", {uselang = "en"})))
output:insert(tostring(full_url("Special:Gadgets", { uselang = "en" })))
output:insert(' gadget] ([')
output:insert(' gadget] ([')
output:insert(tostring(mw.uri.fullUrl("MediaWiki:Gadgets-definition", {action = "edit"})))
output:insert(tostring(full_url("MediaWiki:Gadgets-definition", { action = "edit" })))
output:insert(' edit definitions]).</dd>')
output:insert(' edit definitions]).</dd>')
-- else
-- else
-- cats:insert("Wiktionary gadgets")
-- cats:insert("Wiktionary gadgets")
end
end
end
end
 
if old_doc_title then
if old_doc_title then
output:insert("<dd> ''Redirected from'' [")
output:insert("<dd> ''Redirected from'' [")
output:insert(old_doc_title:fullUrl{redirect = "no"})
output:insert(old_doc_title:fullUrl { redirect = "no" })
output:insert(" ")
output:insert(" ")
output:insert(old_doc_title.fullText)
output:insert(old_doc_title.fullText)
output:insert("] ([")
output:insert("] ([")
output:insert(old_doc_title:fullUrl{action = "edit"})
output:insert(old_doc_title:fullUrl { action = "edit" })
output:insert(" edit]).</dd>\n")
output:insert(" edit]).</dd>\n")
end
end
 
if not args.nolinks then
if not args.nolinks then
local links = Array()
local links = Array()


Line 738: Line 969:
links:insert("[[Special:PrefixIndex/" .. title.fullText .. "/|subpage list]]")
links:insert("[[Special:PrefixIndex/" .. title.fullText .. "/|subpage list]]")
end
end
 
links:insert(
links:insert(
"[" .. tostring(mw.uri.fullUrl("Special:WhatLinksHere/" .. title.fullText, {hidetrans = true, hideredirs = true})) .. " links]")
"[" ..
tostring(full_url("Special:WhatLinksHere/" .. title.fullText, { hidetrans = true, hideredirs = true })) ..
" links]")
 
if contentModel ~= "Scribunto" then
if contentModel ~= "Scribunto" then
links:insert(
links:insert(
"[" .. tostring(mw.uri.fullUrl("Special:WhatLinksHere/" .. title.fullText, {hidelinks = true, hidetrans = true})) .. " redirects]")
"[" ..
tostring(full_url("Special:WhatLinksHere/" .. title.fullText, { hidelinks = true, hidetrans = true })) ..
" redirects]")
end
end
 
if is_script_or_stylesheet then
if is_script_or_stylesheet then
if user_name then
if user_name then
Line 753: Line 988:
else
else
links:insert(
links:insert(
"[" .. tostring(mw.uri.fullUrl("Special:WhatLinksHere/" .. title.fullText, {hidelinks = true, hideredirs = true})) .. " transclusions]")
"[" ..
tostring(full_url("Special:WhatLinksHere/" .. title.fullText, { hidelinks = true, hideredirs = true })) ..
" transclusions]")
end
end
 
if contentModel == "Scribunto" then
if contentModel == "Scribunto" then
local is_testcases = title.isSubpage and title.subpageText == "testcases"
local is_testcases = title.isSubpage and title.subpageText == "testcases"
Line 764: Line 1,001:
links:insert("[[" .. title.fullText .. "/testcases|testcases]]")
links:insert("[[" .. title.fullText .. "/testcases|testcases]]")
end
end
 
if user_name then
if user_name then
links:insert("[[User:" .. user_name .. "|user page]]")
links:insert("[[User:" .. user_name .. "|user page]]")
links:insert("[[User talk:" .. user_name .. "|user talk page]]")
links:insert("[[User talk:" .. user_name .. "|user talk page]]")
links:insert("[[Special:PrefixIndex/User:" .. user_name .. "/|userspace]]")
links:insert("[[Special:PrefixIndex/User:" .. user_name .. "/|userspace]]")
else
-- If sandbox module, add a link to the module that this is a sandbox of.
-- If sandbox module, add a link to the module that this is a sandbox of.
-- Exclude user sandbox modules like [[User:Dine2016/sandbox]].
-- Exclude user sandbox modules like [[User:Dine2016/sandbox]].
if title.text:find("/sandbox%d*%f[/%z]") then
elseif title.text:find("^sandbox%d*/") or title.text:find("/sandbox%d*%f[/%z]") then
cats:insert("Sandbox modules")
cats:insert("Sandbox modules")
 
-- Sandbox modules don’t really need documentation.
-- Sandbox modules don’t really need documentation.
needs_doc = false
needs_doc = false
 
-- Will behave badly if “/sandbox” occurs twice in title!
-- Don't track user sandbox modules.
local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
local text_title = new_title(title.text)
if not (text_title and text_title.nsText == "User") then
local diff
local diff
if page_exists(sandbox_of) then
local sandbox_of = title.text:match("^(.*)/sandbox%d*%f[/%z]")
if sandbox_of then
track("sandbox to be moved")
else
sandbox_of = title.text:match("^sandbox%d*/(.*)$")
end
if not sandbox_of then
error(("Internal error: Something wrong, couldn't extract sandbox-of module from title '%s'")
:format(title.text))
end
sandbox_of = title.nsText .. ":" .. sandbox_of
if title_exists(sandbox_of) then
diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
else
track("no sandbox of")
end
end
 
links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
end
-- If not a sandbox module, add link to sandbox module.
-- If not a sandbox module, add link to sandbox module.
-- Sometimes there are multiple sandboxes for a single module:
-- Sometimes there are multiple sandboxes for a single module:
-- [[Module:sa-pronunc/sandbox]],  [[Module:sa-pronunc/sandbox2]].
-- [[Module:sandbox/sa-pronunc]],  [[Module:sandbox2/sa-pronunc]].
-- Occasionally sandbox modules have their own subpages that are also
else
-- sandboxes: [[Module:grc-decl/sandbox/decl]].
local sandbox_title
else
local user_prefix, user_rest = title.text:match("^(User:.-/)(.*)$")
local sandbox_title
if not user_prefix then
if title.fullText:find("^Module:grc%-decl/") then
user_prefix = ""
sandbox_title = title.fullText:gsub("^Module:grc%-decl/", "Module:grc-decl/sandbox/")
user_rest = title.text
elseif is_testcases then
end
sandbox_title = title.fullText:gsub("/testcases", "/sandbox/testcases")
sandbox_title = title.nsText .. ":" .. user_prefix .. "sandbox/" .. user_rest
else
local sandbox_link = "[[:" .. sandbox_title .. "|sandbox]]"
sandbox_title = title.fullText .. "/sandbox"
 
end
local diff
local sandbox_link = "[[:" .. sandbox_title .. "|sandbox]]"
if title_exists(sandbox_title) then
diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
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
links:insert(sandbox_link .. (diff or ""))
end
end
end
end
 
if title.nsText == "Template" then
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]]
-- 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
-- apparently same with/without: &profile=advanced&fulltext=1
local errorq = 'searchengineselect=mediawiki&search=all: hastemplate:\"'..title.rootText..'\" insource:\"'..title.rootText..'\" incategory:'
local errorq = 'searchengineselect=mediawiki&search=all: hastemplate:\"' ..
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"
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(
links:insert(
'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..eincategory )) .. ' errors]'
'[' .. tostring(full_url('Special:Search', errorq .. eincategory)) .. ' errors]'
.. ' (' ..
.. ' (' ..
'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..'ParserFunction_errors' )) .. ' parser]'
'[' .. tostring(full_url('Special:Search', errorq .. 'ParserFunction_errors')) .. ' parser]'
.. '/' ..
.. '/' ..
'[' .. tostring(mw.uri.fullUrl('Special:Search', errorq..'Pages_with_module_errors' )) .. ' module]'
'[' .. tostring(full_url('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.
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
-- At the moment there are no user sandbox templates with subpage
-- “/sandbox”.
-- “/sandbox”.
cats:insert("Sandbox templates")
cats:insert("Sandbox templates")
 
-- Sandbox templates don’t really need documentation.
-- Sandbox templates don’t really need documentation.
needs_doc = false
needs_doc = false
 
-- Will behave badly if “/sandbox” occurs twice in title!
-- Will behave badly if “/sandbox” occurs twice in title!
local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
local sandbox_of = title.fullText:gsub("/sandbox%d*%f[/%z]", "")
 
local diff
local diff
if page_exists(sandbox_of) then
if title_exists(sandbox_of) then
diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
else
track("no sandbox of")
end
end
 
links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
links:insert("[[:" .. sandbox_of .. "|sandbox of]]" .. (diff or ""))
-- This is a template that can have a sandbox.
-- This is a template that can have a sandbox.
elseif not args.nosandbox then -- unless we tell it not to
elseif not args.nosandbox then -- unless we tell it not to
local sandbox_title = title.fullText .. "/sandbox"
local sandbox_title = title.fullText .. "/sandbox"
 
local diff
local diff
if page_exists(sandbox_title) then
if title_exists(sandbox_title) then
diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
end
end
 
links:insert("[[:" .. sandbox_title .. "|sandbox]]" .. (diff or ""))
links:insert("[[:" .. sandbox_title .. "|sandbox]]" .. (diff or ""))
end
end
end
end
 
if #links > 0 then
if #links > 0 then
output:insert("<dd> ''Useful links'': " .. links:concat(" • ") .. "</dd>")
output:insert("<dd> ''Useful links'': " .. links:concat(" • ") .. "</dd>")
end
end
end
end
 
output:insert("</dl>\n")
output:insert("</dl>\n")
 
-- Show error from [[Module:category tree/topic cat/data]] on its submodules'
-- Show error from [[Module:category tree/topic cat/data]] on its submodules'
-- documentation to, for instance, warn about duplicate labels.
-- documentation to, for instance, warn about duplicate labels.
if title.fullText:find("Module:category tree/topic cat/data", 1, true) == 1 then
if startswith(title.fullText, "Module:category tree/topic/") then
local ok, err = pcall(require, "Module:category tree/topic cat/data")
local ok, err = pcall(require, "Module:category tree/topic/data")
if not ok then
if not ok then
output:insert('<span class="error">' .. err .. '</span>\n\n')
output:insert('<span class="error">' .. err .. '</span>\n\n')
end
end
end
end
 
if doc_title and doc_title.exists then
if doc_title and doc_title.exists then
-- Override automatic documentation, if present.
-- Override automatic documentation, if present.
doc_content = frame:expandTemplate { title = doc_title.fullText }
doc_content = expand_template { title = doc_title.fullText }
elseif not doc_content and fallback_docs then
elseif not doc_content and fallback_docs then
doc_content = frame:expandTemplate {
doc_content = expand_template {
title = fallback_docs,
title = fallback_docs,
args = {
args = {
Line 894: Line 1,143:


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


Line 919: Line 1,168:
local parts = {}
local parts = {}
local function ins(text)
local function ins(text)
table.insert(parts, text)
insert(parts, text)
end
end
ins('{|class="wikitable"')
ins('{|class="wikitable"')
Line 929: Line 1,178:
local cat_parts = {}
local cat_parts = {}
if type(cats) == "string" then
if type(cats) == "string" then
cats = {cats}
cats = { cats }
end
end
for _, cat in ipairs(cats) do
for _, cat in ipairs(cats) do
table.insert(cat_parts, ("<code>%s</code>"):format((cat:gsub("|", "&#124;"))))
insert(cat_parts, ("<code>%s</code>"):format((cat:gsub("|", "&#124;"))))
end
end
cat_text = table.concat(cat_parts, ", ")
cat_text = concat(cat_parts, ", ")
else
else
cat_text = "''(unspecified)''"
cat_text = "''(unspecified)''"
Line 940: Line 1,189:
ins("|-")
ins("|-")
ins(("| <code>%s</code> || %s || %s"):format(spec.regex, cat_text,
ins(("| <code>%s</code> || %s || %s"):format(spec.regex, cat_text,
type(spec.process) == "function" and "''(handled internally)''" or
is_callable(spec.process) and "''(handled internally)''" or
type(spec.process) == "string" and ("[[Module:documentation/functions/%s]]"):format(spec.process) or
type(spec.process) == "string" and ("[[Module:documentation/functions/%s]]"):format(spec.process) or
"''(no documentation generator)''"))
"''(no documentation generator)''"))
end
end
ins("|}")
ins("|}")
return table.concat(parts, "\n")
return concat(parts, "\n")
end
end


Line 951: Line 1,200:
function export.translitModuleLangList(frame)
function export.translitModuleLangList(frame)
local pagename, subpage
local pagename, subpage
 
if frame.args[1] then
if frame.args[1] then
pagename = frame.args[1]
pagename = frame.args[1]
else
else
local title = mw.title.getCurrentTitle()
local title = get_current_title()
subpage = title.subpageText
subpage = title.subpageText
pagename = title.text
pagename = title.text
 
if subpage ~= pagename then
if subpage ~= pagename then
pagename = title.rootText
pagename = title.rootText
end
end
end
end
 
local translitModule = pagename
local translitModule = pagename
 
local languageObjects = require("Module:languages/byTranslitModule")(translitModule)
local languageObjects = require("Module:languages/byTranslitModule")(translitModule)
local codeInPagename = pagename:match("^([%l-]+)%-.*translit$")
local codeInPagename = pagename:match("^([%l-]+)%-.*translit$")
 
local categories = Array()
local categories = Array()
local codeInPagenameInList = false
local codeInPagenameInList = false
Line 977: Line 1,226:
#languageObjects .. " language" .. agreement .. "]]")
#languageObjects .. " language" .. agreement .. "]]")
end
end
 
languageObjects = Array(languageObjects)
languageObjects = Array(languageObjects)
:filter(
:filter(
function (lang)
function(lang)
local result = lang:getCode() ~= codeInPagename
local result = lang:getCode() ~= codeInPagename
codeInPagenameInList = codeInPagenameInList or result
codeInPagenameInList = codeInPagenameInList or result
Line 986: Line 1,235:
end)
end)
end
end
 
if subpage ~= "documentation" then
if subpage ~= "documentation" then
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
local script = require "Module:scripts".getByCode(script_code)
local script = get_script(script_code)
if script then
if script then
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
Line 995: Line 1,244:
end
end
end
end
 
if subpage ~= "documentation" and not page_exists("Module:" .. pagename .. "/testcases") then
if subpage ~= "documentation" and not title_exists("Module:" .. pagename .. "/testcases") then
categories:insert("[[Category:Transliteration modules without a testcases subpage]]")
categories:insert("[[Category:Transliteration modules without a testcases subpage]]")
end
end
 
if not languageObjects[1] then
if not languageObjects[1] then
return categories:concat()
return categories:concat()
end
end
 
local langs = Array(languageObjects)
local langs = Array(languageObjects)
:sort(
:sort(
Line 1,012: Line 1,261:
:map(languageObjects[1].makeCategoryLink)
:map(languageObjects[1].makeCategoryLink)
:serialCommaJoin()
:serialCommaJoin()
 
return "It is " .. ( codeInPagenameInList and "also" or "" ) ..
return "It is " .. (codeInPagenameInList and "also" or "") ..
" used to transliterate " .. langs .. "." .. categories:concat()
" used to transliterate " .. langs .. "." .. categories:concat()
end
end


-- Used by {{entry name module documentation}}.
-- Used by {{strip diacritics module documentation}}.
function export.entryNameModuleLangList(frame)
function export.stripDiacriticsModuleLangList(frame)
local pagename, subpage
local pagename, subpage
 
if frame.args[1] then
if frame.args[1] then
pagename = frame.args[1]
pagename = frame.args[1]
else
else
local title = mw.title.getCurrentTitle()
local title = get_current_title()
subpage = title.subpageText
subpage = title.subpageText
pagename = title.text
pagename = title.text
 
if subpage ~= pagename then
if subpage ~= pagename then
pagename = title.rootText
pagename = title.rootText
end
end
end
end
 
local entryNameModule = pagename
local stripDiacriticsModule = pagename
 
local languageObjects = require("Module:languages/byEntryNameModule")(entryNameModule)
local languageObjects = require("Module:languages/byStripDiacriticsModule")(stripDiacriticsModule)
local codeInPagename = pagename:match("^([%l-]+)%-.*entryname$")
local codeInPagename = pagename:match("^([%l-]+)%-.*stripdiacritics$")
 
local categories = Array()
local categories = Array()
local codeInPagenameInList = false
local codeInPagenameInList = false
Line 1,043: Line 1,292:
if languageObjects[1] and subpage ~= "documentation" then
if languageObjects[1] and subpage ~= "documentation" then
local agreement = languageObjects[2] and "s" or ""
local agreement = languageObjects[2] and "s" or ""
categories:insert("[[Category:Entry name-generating modules used by " ..
categories:insert("[[Category:Diacritic-stripping modules used by " ..
#languageObjects .. " language" .. agreement .. "]]")
#languageObjects .. " language" .. agreement .. "]]")
end
end
 
languageObjects = Array(languageObjects)
languageObjects = Array(languageObjects)
:filter(
:filter(
function (lang)
function(lang)
local result = lang:getCode() ~= codeInPagename
local result = lang:getCode() ~= codeInPagename
codeInPagenameInList = codeInPagenameInList or result
codeInPagenameInList = codeInPagenameInList or result
Line 1,055: Line 1,304:
end)
end)
end
end
 
if subpage ~= "documentation" then
if subpage ~= "documentation" then
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
local script = require "Module:scripts".getByCode(script_code)
local script = get_script(script_code)
if script then
if script then
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
Line 1,064: Line 1,313:
end
end
end
end
 
if subpage ~= "documentation" and not page_exists("Module:" .. pagename .. "/testcases") then
if subpage ~= "documentation" and not title_exists("Module:" .. pagename .. "/testcases") then
categories:insert("[[Category:Entry name-generating modules without a testcases subpage]]")
categories:insert("[[Category:Diacritic-stripping modules without a testcases subpage]]")
end
end
 
if not languageObjects[1] then
if not languageObjects[1] then
return categories:concat()
return categories:concat()
end
end
 
local langs = Array(languageObjects)
local langs = Array(languageObjects)
:sort(
:sort(
Line 1,081: Line 1,330:
:map(languageObjects[1].makeCategoryLink)
:map(languageObjects[1].makeCategoryLink)
:serialCommaJoin()
:serialCommaJoin()
 
return "It is " .. ( codeInPagenameInList and "also" or "" ) ..
return "It is " .. (codeInPagenameInList and "also" or "") ..
" used to generate entry names for " .. langs .. "." .. categories:concat()
" used to strip diacritics for " .. langs .. "." .. categories:concat()
end
end


Line 1,089: Line 1,338:
function export.sortkeyModuleLangList(frame)
function export.sortkeyModuleLangList(frame)
local pagename, subpage
local pagename, subpage
 
if frame.args[1] then
if frame.args[1] then
pagename = frame.args[1]
pagename = frame.args[1]
else
else
local title = mw.title.getCurrentTitle()
local title = get_current_title()
subpage = title.subpageText
subpage = title.subpageText
pagename = title.text
pagename = title.text
 
if subpage ~= pagename then
if subpage ~= pagename then
pagename = title.rootText
pagename = title.rootText
end
end
end
end
 
local sortkeyModule = pagename
local sortkeyModule = pagename
 
local languageObjects = require("Module:languages/bySortkeyModule")(sortkeyModule)
local languageObjects = require("Module:languages/bySortkeyModule")(sortkeyModule)
local codeInPagename = pagename:match("^([%l-]+)%-.*sortkey$")
local codeInPagename = pagename:match("^([%l-]+)%-.*sortkey$")
 
local categories = Array()
local categories = Array()
local codeInPagenameInList = false
local codeInPagenameInList = false
Line 1,115: Line 1,364:
#languageObjects .. " language" .. agreement .. "]]")
#languageObjects .. " language" .. agreement .. "]]")
end
end
 
languageObjects = Array(languageObjects)
languageObjects = Array(languageObjects)
:filter(
:filter(
function (lang)
function(lang)
local result = lang:getCode() ~= codeInPagename
local result = lang:getCode() ~= codeInPagename
codeInPagenameInList = codeInPagenameInList or result
codeInPagenameInList = codeInPagenameInList or result
Line 1,124: Line 1,373:
end)
end)
end
end
 
if subpage ~= "documentation" then
if subpage ~= "documentation" then
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
for script_code in pagename:gmatch("%f[^-%z]%u%l%l%l%f[-]") do
local script = require "Module:scripts".getByCode(script_code)
local script = get_script(script_code)
if script then
if script then
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
categories:insert("[[Category:" .. script:getCategoryName() .. "]]")
Line 1,133: Line 1,382:
end
end
end
end
 
if subpage ~= "documentation" and not page_exists("Module:" .. pagename .. "/testcases") then
if subpage ~= "documentation" and not title_exists("Module:" .. pagename .. "/testcases") then
categories:insert("[[Category:Sortkey-generating modules without a testcases subpage]]")
categories:insert("[[Category:Sortkey-generating modules without a testcases subpage]]")
end
end
 
if not languageObjects[1] then
if not languageObjects[1] then
return categories:concat()
return categories:concat()
end
end
 
local langs = Array(languageObjects)
local langs = Array(languageObjects)
:sort(
:sort(
Line 1,150: Line 1,399:
:map(languageObjects[1].makeCategoryLink)
:map(languageObjects[1].makeCategoryLink)
:serialCommaJoin()
:serialCommaJoin()
 
return "It is " .. ( codeInPagenameInList and "also" or "" ) ..
return "It is " .. (codeInPagenameInList and "also" or "") ..
" used to sort " .. langs .. "." .. categories:concat()
" used to sort " .. langs .. "." .. categories:concat()
end
end


return export
return export
Retrieved from "https://linguifex.com/wiki/Module:documentation"