Module:Documentation: Difference between revisions

From Coral Island Wiki
Jump to navigation Jump to search
(copy genshin impact wiki's iteration)
(Copied from Coral Island Wiki)
Line 1: Line 1:
--------------------------------------------------------------------------------
--<pre>
-- Copied from Genshin Impact Wiki.
----------------------------------------------------------------------------------------------------
-- This module implements {{T|Documentation}}.
--
--
-- @module documentation
--                         '''Configuration for [[Module:Documentation]]'''
-- @alias p
-- @release stable
-- @require [[Global Lua Modules/Arguments|Dev:Arguments]]
-- @require [[Global Lua Modules/Config|Dev:Config]]
-- @require [[Global Lua Modules/I18n|Dev:I18n]]
-- @require [[Global Lua Modules/Loanguages|Dev:Languages]]
-- @require [[Global Lua Modules/Message box|Dev:Message box]]
-- @require [[Global Lua Modules/Yesno|Dev:Yesno]]
-- @require Module:Documentation/config
-- @require Module:Documentation/i18n
-- @require [[MediaWiki:Module:Documentation.css]]
-- @attribution [[wikipedia:Module:Documentation|Module:Documentation]] (Wikipedia)
-- @see [[wikipedia:Module:Documentation|Original module on Wikipedia]]
-- @see {{T|Documentation}}
--------------------------------------------------------------------------------
 
local libraryUtil = require('libraryUtil');
local checkType = libraryUtil.checkType;
local lib = require('Module:Feature')
 
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local checkExists = require('Module:Exists').checkExists
local yesno = require('Module:Yesno')
 
-- Get the config table.
local cfg = require('Module:Config').loadConfig('Documentation')
local i18n = require('Module:I18n').loadMessages('Documentation')
local languages = require('Module:Languages')
 
local p = {}
p.i18n = i18n
 
-- Capitalizes first letter of strings
-- src: https://stackoverflow.com/questions/2421695/first-character-uppercase-lua
local function firstToUpper(str)
    return (str:gsub("^%l", string.upper))
end
 
-- --------------------------------------------------------------------------
-- Helper functions
--
--
-- These are defined as local functions, but are made available in the p
-- Here you can set the values of the parameters and messages used in [[Module:Documentation]]
-- table for testing purposes.
-- to localise it to your wiki and your language. Unless specified otherwise, values given here
-- --------------------------------------------------------------------------
-- should be string values.
 
--[[
-- Gets a message from the cfg table and formats it if appropriate.
-- The function raises an error if the value from the cfg table is not
-- 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.',
-- p.message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--
--
-- @function p.message
-- @submodule documentation.config
-- @private
-- @alias cfg
-- @param {string} cfgKey
----------------------------------------------------------------------------------------------------
-- @param[opt] {table} valArray
-- @param[opt] {string} expectType
-- @return {string|number|boolean|table|nil}
--]]
function p.message(cfgKey, valArray, expectType)
local msg = cfg:getValue(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
 
function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
 
local ret = mw.ustring.gsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end
 
function p.makeWikilink(page, display)
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end
 
function p.makeUrlWikilink(page, display)
-- This code prevents redlinks, but doesn't work for categories, and those
-- are always blue-linked by the CategoryBlueLinks extension anyway.
return mw.ustring.format('[%s %s]', tostring(mw.uri.fullUrl(page)), display or page)
end
 
 
function p.makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return p.makeWikilink(catns .. ':' .. cat, sort)
end
 
function p.makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
end
 
function p.makeToolbar(...)
local lim = select('#', ...)
if lim < 1 then
return nil
end
 
local frame = mw.getCurrentFrame()
local ret = mw.html.create('small'):wikitext('(')
 
local isFirst = true
for i = 1, lim do
local v = select(i, ...)
if v then
if isFirst then
isFirst = false
else
ret:wikitext(' ', frame:preprocess('{{int:pipe-separator}}'), '&nbsp;')
end
ret:wikitext(v)
end
end
 
return not isFirst and ret:wikitext(')'):done() or nil
end


--[[
local cfg = {} -- Do not edit this line.
-- @function p.resolveNamespace
-- @private
-- @param {int} subjectSpace
-- @return {string}
--]]
function p.resolveNamespace(subjectSpace, upperPlural)
if subjectSpace == 10 then -- Template namespace
if upperPlural then return 'Templates'
else return 'template' end
elseif subjectSpace == 828 then -- Module namespace
if upperPlural then return 'Modules'
else return 'module' end
elseif subjectSpace == 6 then -- File namespace
if upperPlural then return 'Files'
else return 'file' end
end
return 'other'
end


-- --------------------------------------------------------------------------
-- -------------------------------------------------------------------------------------------------
-- Argument processing
-- Protection template configuration
-- --------------------------------------------------------------------------
-- -------------------------------------------------------------------------------------------------


function p.makeInvokeFunc(funcName)
--- The protection reason for edit-protected templates to pass
return function (frame)
--  to Module:Protection banner.
local args = getArgs(frame, {
--  @property {string} cfg['protection-reason-edit']
valueFunc = function (key, value)
cfg['protection-reason-edit'] = 'template'
if type(value) == 'string' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == 'heading' or value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
return tostring(p[funcName](args))
end
end


-- --------------------------------------------------------------------------
-- -------------------------------------------------------------------------------------------------
-- Main function
-- Templates
-- --------------------------------------------------------------------------
-- -------------------------------------------------------------------------------------------------
--- A name of the template for Table of Contents in right alignment.
--  @property {string} cfg['template-tocright']
cfg['template-tocright'] = 'Tocright'


--[[
-- -------------------------------------------------------------------------------------------------
-- This function defines logic flow for the module.
-- Sandbox notice configuration
--
-- ; Messages:
-- : 'main-div-id' --> 'template-documentation'
-- : 'main-div-classes' --> 'template-documentation iezoomfix'
--
--
-- @function p.main
-- On sandbox pages the module can display a template notifying users that the current page is a
-- @param {table|Frame} args - table of arguments passed by the user
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
-- @return {string}
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the
--]]
-- messages that the notices contains.
p.main = p.makeInvokeFunc('_main')
-- -------------------------------------------------------------------------------------------------


function p._main(args)
-- Not yet converted to the new format
local env = p.getEnvironment(args)
if env.title == env.testcasesTitle then
if env.title.namespace == 828 then
-- we are in module namespace, the testcase title is equal, so expand the testcase header
local root = mw.html.create()
root:wikitext(mw.getCurrentFrame():expandTemplate{title = 'Documentation/Testcase Header'})
return root
end
else
local root = mw.html.create()
root
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:tag('div')
:attr('id', p.message('main-div-id'))
:addClass(p.message('main-div-classes'))
:newline()
:node(p._startBox(args, env))
:node(p._navigation(args, env))
:node(p._content(args, env))
:node(p._endBox(args, env))
:done()
:wikitext(p.addTrackingCategories(env))
:wikitext(p.addTypeCategory(args))
return root
end
end


-- --------------------------------------------------------------------------
--- Whether to show the sandbox notice on `/sandbox` subpages
-- Environment settings
-- @property {boolean} cfg['sandbox-notice-show']
-- --------------------------------------------------------------------------
cfg['sandbox-notice-show'] = true


--- A table with information about the environment, including title objects and
--- The file displayed in the sandbox notice.
-- other namespace- or path-related data.
-- @property {string} cfg['sandbox-notice-image']
-- @type Environment
cfg['sandbox-notice-image'] = 'Hinoki_bookcase.png'
--
-- @note All table lookups are passed through pcall so that errors are caught.
-- If an error occurs, the value returned will be nil.
--
-- ; Title objects include:
--- @property {Title|nil} Environment.title - the page we are making documentation for (usually the current title)
--- @property {Title|nil} Environment.templateTitle - the template (or module, file, etc.)
--- @property {Title|nil} Environment.docTitle - the /doc subpage.
--- @property {Title|nil} Environment.sandboxTitle - the /sandbox subpage.
--- @property {Title|nil} Environment.testcasesTitle - the /testcases subpage.
--- @property {Title|nil} Environment.printTitle - the print version of the template, located at the /Print subpage.
--
-- ; Data includes:
--- @property {Title.protectionLevels|nil} Environment.protectionLevels - the protection levels table of the title object.
--- @property {int|nil} Environment.subjectSpace - the number of the title's subject namespace.
--- @property {int|nil} Environment.docSpace - the number of the namespace the title puts its documentation in.
--- @property {string|nil} Environment.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
--- @property {string|nil} Environment.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.


--[[
--[[
-- Returns a table with information about the environment, including title objects and other namespace- or
-- cfg['sandbox-notice-pagetype-template']
-- path-related data.
-- cfg['sandbox-notice-pagetype-module']
--
-- cfg['sandbox-notice-pagetype-other']
-- @function p.getEnvironment
-- The page type of the sandbox page. The message that is displayed depends on the current subject
-- @private
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
-- @param {table} args - table of arguments passed by the user
-- cfg['sandbox-notice-diff-blurb'].
-- @return {Environment}
--]]
--]]
function p.getEnvironment(args)
cfg['sandbox-notice-pagetype-template'] = 'template draft page'
local env, envFuncs = {}, {}
cfg['sandbox-notice-pagetype-module'] =  'module draft page'
 
cfg['sandbox-notice-pagetype-other'] = 'draft page'
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- more than once. (Nils won't be memoized.)
setmetatable(env, {
__index = function (t, key)
local envFunc = envFuncs[key]
if envFunc then
local success, val = pcall(envFunc)
if success then
env[key] = val -- Memoise the value.
return val
end
end
return nil
end
})
 
-- The title object for the current page, or a test page passed with args.page.
function envFuncs.title()
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end
 
-- The template (or module, etc.) title object.
-- ; Messages:
-- : 'sandbox-subpage' --> 'sandbox'
-- : 'testcases-subpage' --> 'testcases'
function envFuncs.templateTitle()
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == p.message('sandbox-subpage') or subpage == p.message('testcases-subpage') or subpage == p.message('doc-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end
 
-- Title object of the /doc subpage.
-- ; Messages:
-- : 'doc-subpage' --> 'doc'
function envFuncs.docTitle()
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. p.message('doc-subpage')
end
return mw.title.new(docpage)
end
 
function envFuncs.subpages()
local docTitle = env.docTitle
return languages.subpages(docTitle.text, docTitle.nsText)
end
 
function envFuncs.hasSubpages()
local subpages = env.subpages
return #subpages > 1 or subpages[1] ~= ''
end
 
function envFuncs.docTitleCreate()
local hasSubpages = env.hasSubpages
local docTitle = env.docTitle
return docTitle
end
 
function envFuncs.docTitleCurrentLang()
local currentLang = i18n:getLang()
if currentLang == 'en' or yesno(args.ignoreCurrentLang) then
return env.docTitleCreate
else
local docTitle = env.docTitle
return mw.title.new(docTitle.text .. '/' .. currentLang, docTitle.nsText)
end
end
 
-- Title object for the /sandbox subpage.
-- ; Messages:
-- : 'sandbox-subpage' --> 'sandbox'
function envFuncs.sandboxTitle()
    -- return nil
return mw.title.new(env.docpageBase .. '/' .. p.message('sandbox-subpage'))
end
 
-- Title object for the /testcases subpage.
-- ; Messages:
-- : 'testcases-subpage' --> 'testcases'
function envFuncs.testcasesTitle()
    -- return nil
return mw.title.new(env.docpageBase .. '/' .. p.message('testcases-subpage'))
end
 
-- Title object for the /Print subpage.
-- ; Messages:
-- : 'print-subpage' --> 'Print'
function envFuncs.printTitle()
if p.message('print-show') then
return env.templateTitle:subPageTitle(p.message('print-subpage'))
end
end
 
-- The protection levels table of the title object.
function envFuncs.protectionLevels()
return env.title.protectionLevels
end
 
-- The subject namespace number.
function envFuncs.subjectSpace()
return mw.site.namespaces[env.title.namespace].subject.id
end
 
-- The documentation namespace number. For most namespaces this is the same as the
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
function envFuncs.docSpace()
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
return subjectSpace + 1
else
return subjectSpace
end
end
 
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
function envFuncs.docpageBase()
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
 
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
function envFuncs.compareUrl()
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
if checkExists(templateTitle.prefixedText) and checkExists(sandboxTitle.prefixedText) then
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
else
return nil
end
end
 
function envFuncs.docStatus()
local docTitle = env.docTitle
if not args.content then
if not checkExists(docTitle.prefixedText) and not env.hasSubpages then
return 'nodoc'
elseif not checkExists(docTitle.prefixedText) and env.hasSubpages then
return 'baddoc'
end
end
end
 
function envFuncs.docIcon()
local docStatus = env.docStatus
if not docStatus then
return p.message('documentation-icon')
end
return p.message('documentation-icon-' .. docStatus)
end
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
return title
end
return env
end
 
-- --------------------------------------------------------------------------
-- Auxiliary templates
-- --------------------------------------------------------------------------
 
---
-- Generates a sandbox notice for display above sandbox pages.
--
-- ; Messages:
-- : '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'
--
-- @function p.sandboxNotice
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string|nil}
function p.sandboxNotice(args, env)
if not p.message('sandbox-notice-show', nil, 'boolean') then
return nil
end
 
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
-- Build the table of arguments to pass to {{T|ombox}}. We need just two fields, "image" and "text".
local omargs = {}
omargs.image = p.message('sandbox-notice-image')
-- Get the text. We start with the opening blurb, which is something like
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local header = ''
local text = ''
local frame = mw.getCurrentFrame()
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
local pagetype
if subjectSpace == 10 then
pagetype = p.message('sandbox-notice-pagetype-template')
elseif subjectSpace == 828 then
pagetype = p.message('sandbox-notice-pagetype-module')
else
pagetype = p.message('sandbox-notice-pagetype-other')
end
local templateLink = p.makeUrlWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if isPreviewing or not compareUrl then
header = header .. p.message('sandbox-notice-blurb', {pagetype, templateLink})
else
local compareDisplay = p.message('sandbox-notice-compare-link-display')
local compareLink = p.makeUrlLink(compareUrl, compareDisplay)
header = header .. p.message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
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 checkExists(testcasesTitle.prefixedText) then
if testcasesTitle.namespace == mw.site.namespaces.Module.id then
local testcasesLinkDisplay = p.message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = p.message('sandbox-notice-testcases-run-link-display')
local testcasesLink = p.makeUrlWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local runTitle = testcasesTitle.talkPageTitle
local testcasesRunLink
if checkExists(runTitle.prefixedText) then
testcasesRunLink = p.makeUrlWikilink(runTitle.prefixedText, testcasesRunLinkDisplay)
else
testcasesRunLink = p.makeUrlLink(runTitle:fullUrl({
action = 'edit',
redlink = '1',
preload = p.message('module-testcases-run-preload'),
}), testcasesRunLinkDisplay)
end
local testcasesRunLink = p.makeUrlWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. p.message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = p.message('sandbox-notice-testcases-link-display')
local testcasesLink = p.makeUrlWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. p.message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
if title.namespace == 828 then
text = text .. p.makeCategoryLink(p.message('sandbox-module-category'))
else
text = text .. p.makeCategoryLink(p.message('sandbox-category'))
end
omargs.header = header
omargs.text = text
omargs.imagewidth = '50px'
omargs.class = 'sandbox'
local ret = '<div style="clear: both;"></div>'
ret = ret .. frame:expandTemplate{ title = 'Mbox', args = omargs}
return ret
end


--[[
--[[
-- Generates the padlock icon in the top right.
-- cfg['sandbox-notice-blurb']
--
-- cfg['sandbox-notice-diff-blurb']
-- ; Messages:
-- cfg['sandbox-notice-diff-display']
-- : 'protection-template' --> 'pp-template'
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
-- : 'protection-template-args' --> {docusage = 'yes'}
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
--
-- type, which is either cfg['sandbox-notice-pagetype-template'],
-- @function p.protectionTemplate
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
-- @private
-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- the sandbox and the main template. The display value of the diff link is set by
-- @return {string|nil}
-- cfg['sandbox-notice-compare-link-display'].
--]]
--]]
function p.protectionTemplate(env)
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'
-- This depends on [[Module:Protection banner]]
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
do return end
cfg['sandbox-notice-compare-link-display'] = 'diff'
 
local protectionLevels, mProtectionBanner
local title = env.title
if title.namespace ~= 10 and title.namespace ~= 828 then
-- Don't display the protection template if we are not in the template or module namespaces.
return nil
end
protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
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.
mProtectionBanner = require('Dev:Protection banner')
local reason = p.message('protection-reason-edit')
return mProtectionBanner._main{reason, 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.
mProtectionBanner = require('Dev:Protection banner')
return mProtectionBanner._main{action = 'move', small = true}
else
return nil
end
end
 
-- --------------------------------------------------------------------------
-- Start box
-- --------------------------------------------------------------------------


--[[
--[[
-- This function generates the start box.
-- cfg['sandbox-notice-testcases-blurb']
--
-- cfg['sandbox-notice-testcases-link-display']
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- cfg['sandbox-notice-testcases-run-blurb']
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- cfg['sandbox-notice-testcases-run-link-display']
-- which generate the box HTML.
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
--
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- @function p.startBox
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
-- @param {table|Frame} args - a table of arguments passed by the user
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
-- @param[opt] {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
-- @return {string|nil}
-- cases page, and $2 is a link to the page to run it.
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
-- cases.
--]]
--]]
p.startBox = p.makeInvokeFunc('_startBox')
cfg['sandbox-notice-testcases-show'] = true
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
cfg['sandbox-notice-testcases-run-link-display'] = 'run'


function p._startBox(args, env)
--- A category to add to all template sandboxes.
env = env or p.getEnvironment(args)
-- @property {string} cfg['sandbox-category']
local links
cfg['sandbox-category'] = 'Template drafts'
local content = args.content
cfg['sandbox-module-category'] = 'Module drafts'
if not content 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
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
-- User specified no heading.
return nil
end
end


--[[
-- -------------------------------------------------------------------------------------------------
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- Start box configuration
--
-- -------------------------------------------------------------------------------------------------
-- ; Messages:
-- : 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
-- : 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- : 'docpage-preload' --> 'Template:Documentation/preload'
--
-- @function p.makeStartBoxLinksData
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {table|nil}
--]]
function p.makeStartBoxLinksData(args, env)
local subjectSpace = env.subjectSpace
local title = env.title
local docTitleCurrentLang = env.docTitleCurrentLang
if not title or not docTitleCurrentLang then
return nil
end


local frame = mw.getCurrentFrame()
--- The wikitext for the icon shown at the top of the template.
local data = {}
-- @property {string} cfg['documentation-icon-wikitext']
data.title = title
cfg['documentation-icon-wikitext'] = '[[File:$1|30px|link=|alt=Documentation icon]]'
data.docTitle = docTitleCurrentLang
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = frame:preprocess('{{lc:{{int:view}}}}')
data.editLinkDisplay = frame:preprocess('{{lc:{{int:edit}}}}')
data.historyLinkDisplay = frame:preprocess('{{lc:{{int:history_short}}}}')
data.purgeLinkDisplay = frame:preprocess('{{lc:{{int:page-header-action-button-purge}}}}')
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 6 then -- File namespace
preload = p.message('file-docpage-preload')
elseif subjectSpace == 828 then -- Module namespace
preload = p.message('module-preload')
else
preload = p.message('docpage-preload')
end
end
data.preload = preload
data.createLinkDisplay = frame:preprocess('{{lc:{{int:create}}}}')
return data
end


--[[
--- The file name for the icon shown at the top of the template.
-- Generates the [view][edit][history][purge] or [create] links from the data table.
-- @property {string} cfg['documentation-icon']
--
cfg['documentation-icon'] = 'Hinoki_bookcase.png'
-- @function p.renderStartBoxLinks
-- @private
-- @param {table} data - a table of data generated by p.makeStartBoxLinksData
-- @return {string}
--]]
function p.renderStartBoxLinks(data)
 
function escapeBrackets(s)
-- Escapes square brackets with HTML entities.
s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
s = s:gsub('%]', '&#93;')
return s
end
 
local ret
local docTitle = data.docTitle
local title = data.title
if checkExists(docTitle.prefixedText) then
local viewLink = p.makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = p.makeUrlLink(docTitle:fullUrl({ action = 'edit' }, 'https'), data.editLinkDisplay)
local historyLink = p.makeUrlLink(docTitle:fullUrl({ action = 'history' }, 'https'), data.historyLinkDisplay)
local purgeLink = p.makeUrlLink(title:fullUrl({ action = 'purge' }, 'https'), data.purgeLinkDisplay)
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
else
local createLink = p.makeUrlLink(docTitle:fullUrl({
action = 'edit',
redlink = '1',
preload = data.preload,
}, 'https'), data.createLinkDisplay)
local purgeLink = p.makeUrlLink(title:fullUrl({ action = 'purge' }, 'https'), data.purgeLinkDisplay)
ret = '[%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, createLink, purgeLink)
end
return ret
end
 
---
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
--
-- ; Messages:
-- : 'documentation-icon-wikitext' --> '[[File:$1|50px|link=|alt=Documentation icon]]'
-- : 'documentation-icon' --> 'Template-info.svg'
-- : 'documentation-icon-nodoc' --> 'Template-noinfo.svg'
-- : 'documentation-icon-baddoc' --> 'Template-badinfo.svg'
-- : 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- : 'start-box-link-id' --> 'doc_editlinks'
--
-- @function p.makeStartBoxData
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @param {string|nil} links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
-- @return {table}
function p.makeStartBoxData(args, env, links)
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
local data = {}
 
-- Heading
local heading = args.heading -- Blank values are not removed.
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 = p.message('documentation-icon-wikitext', {env.docIcon}) .. ' ' .. i18n:msg('documentation-heading')
data.subHeading = i18n:msg('documentation-visibility')
elseif subjectSpace == 828 then -- Module namespace
data.heading = p.message('documentation-icon-wikitext', {env.docIcon}) .. ' ' .. i18n:msg('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
data.heading = i18n:msg('file-namespace-heading')
else
data.heading = i18n:msg('other-namespaces-heading')
end
 
-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
elseif subjectSpace == 10 then
-- We are in the template or template talk namespaces.
data.headingFontWeight = 'bold'
data.headingFontSize = '100%'
else
data.headingFontSize = '100%'
end
 
-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = p.message('start-box-linkclasses')
data.linksId = p.message('start-box-link-id')
data.links = links
end
 
return data
end
 
--[[
-- Renders the start box html.
--
-- ; Messages
-- : 'start-box-div-classes' --> 'template-documentation-header'
--
-- @function p.renderStartBox
-- @private
-- @param {table} data - a table of data generated by p.makeStartBoxData.
-- @return {string}
--]]
function p.renderStartBox(data)
local sbox = mw.html.create('div')
sbox
:addClass(p.message('start-box-div-classes'))
:newline()
:tag('span')
:cssText(data.headingStyleText)
:css('font-weight', data.headingFontWeight)
:css('font-size', data.headingFontSize)
:wikitext(data.heading)
local links = data.links
if links then
sbox
:tag('div')
:css('font-size', data.headingFontSize)
:css('float', 'right')
:tag('span')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
local subHeading = data.subHeading
if subHeading then
sbox
:tag('br')
:css('clear', 'right')
sbox
:tag('i')
:wikitext(subHeading)
end
return sbox
end
 
p.navigation = p.makeInvokeFunc('_navigation')
 
function p._navigation(args, env)
-- Get environment data.
env = env or p.getEnvironment(args)
local frame = mw.getCurrentFrame()
local nav = mw.html.create('table')
nav
:addClass('doctable')
:css('width', '100%')
local navhead = mw.html.create('tr')
:tag('th')
:addClass('doc-header')
local colspan = 0
if args.navHeader ~= nil then
navhead:wikitext(args.navHeader):done()
end
local lnkdta = mw.html.create('tr'):addClass('links')
local tags = {}
tags[1] = lnkdta:tag('td')
tags[1]:wikitext('[[' .. env.templateTitle.prefixedText .. '|Main]]')
colspan = colspan + 1
if checkExists(env.docTitle.prefixedText) then
tags[2] = lnkdta:tag('td')
tags[2]:wikitext('[[' .. env.docTitle.prefixedText .. '|' .. firstToUpper(p.message('doc-link-display')) .. ']]')
colspan = colspan + 1
end
if checkExists(env.sandboxTitle.prefixedText) then
tags[3] = lnkdta:tag('td')
tags[3]:wikitext('[[' .. env.sandboxTitle.prefixedText .. '|' .. firstToUpper(i18n:msg('sandbox-link-display')) .. ']]')
colspan = colspan + 1
end
if checkExists(env.testcasesTitle.prefixedText) then
tags[4] = lnkdta:tag('td')
tags[4]:wikitext('[[' .. env.testcasesTitle.prefixedText ..  '|' .. firstToUpper(i18n:msg('testcases-link-display')) .. ']]')
colspan = colspan + 1
end
tags[5] = lnkdta:tag('td')
tags[5]:wikitext('[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere', 'hidelinks=1&hideredirs=1&target=' .. env.templateTitle.prefixedText)) .. ' Usage]')
colspan = colspan + 1
for k,v in pairs(tags) do
v:css('width', (100 / colspan) .. '%')
end
navhead:attr('colspan', colspan)
if args.navHeader ~= nil then
nav:node(navhead)
end
nav:node(lnkdta)
nav:allDone()
return nav
end
 
-- --------------------------------------------------------------------------
-- Documentation content
-- --------------------------------------------------------------------------
 
--[[
-- Displays the documentation contents
--
-- ; Messages
-- : 'content-box-div-classes' --> 'template-documentation-content'
--
-- @function p.content
-- @param {table|Frame} args - a table of arguments passed by the user
-- @param[opt] {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string}
--]]
p.content = p.makeInvokeFunc('_content')
 
function p._content(args, env)
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
local content = args.content
local root = mw.html.create()
local frame = mw.getCurrentFrame()
if not content and docTitle then
local subjectSpace = env.subjectSpace
local preload = args.preload
if not preload then
if subjectSpace == 6 then -- File namespace
preload = p.message('file-docpage-preload')
elseif subjectSpace == 828 then -- Module namespace
preload = p.message('module-preload')
else
preload = p.message('docpage-preload')
end
end
 
local hasSubpages = env.hasSubpages
local docTitleCreate = env.docTitleCreate
 
local docMissing = i18n:msg(
p.resolveNamespace(subjectSpace) .. '-documentation-missing',
docTitleCreate:fullUrl({
action = 'edit',
redlink = '1',
preload = mw.uri.encode(preload, 'WIKI'),
}, 'https'):gsub('%%', '%%%%')
)
 
if not checkExists(docTitle.prefixedText) and not hasSubpages then
content = docMissing
else
if yesno(args.i18n, false) or hasSubpages then
local currentLang = i18n:getLang()
root:node(languages.langs{
'en',
currentLang,
format = 'list',
page = docTitle.prefixedText,
class = p.message('languages-list-div-classes'),
select = currentLang,
editintro = 'Template:Documentation/editintro',
})
end
if not pcall(function()
content = args._content or frame:expandTemplate{title = docTitle.prefixedText}
end) then
content = '[[' .. docTitle.prefixedText .. ']]'
end
end
end
local cbox = root:tag('div')
cbox
:addClass(p.message('content-box-div-classes'))
:css("display", "flow-root")
-- The line breaks are necessary so that "=== Headings ===" at the start
-- and end of docs are interpreted correctly.
:wikitext(mw.getCurrentFrame():expandTemplate{title = p.message('template-tocright')})
:newline()
:wikitext(content or '')
:newline()
return root
end
 
--[[
-- Gets the content title
--
-- @function p.contentTitle
-- @param {table|Frame} args - a table of arguments passed by the user
-- @param[opt] {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string}
--]]
p.contentTitle = p.makeInvokeFunc('_contentTitle')


function p._contentTitle(args, env)
--- The file name for the icon shown at the top of the template when no /doc subpage exists.
env = env or p.getEnvironment(args)
--  @property {string} cfg['documentation-icon-nodoc']
local docTitle = env.docTitle
cfg['documentation-icon-nodoc'] = 'Hinoki_bookcase.png'
if not args.content and docTitle and checkExists(docTitle.prefixedText) then
return docTitle.prefixedText
else
return ''
end
end


-- --------------------------------------------------------------------------
--- The file name for the icon shown at the top of the template when the documentation is marked as bad.
-- End box
-- @property {string} cfg['documentation-icon-baddoc']
-- --------------------------------------------------------------------------
cfg['documentation-icon-baddoc'] = 'Hinoki_bookcase.png'


---
-- -------------------------------------------------------------------------------------------------
-- This function generates the end box (also known as the link box).
-- Sandbox link configuration
--
-- -------------------------------------------------------------------------------------------------
-- The HTML is generated by the {{T|fmbox}} template, courtesy of [[Module:Message box]].
--
-- ; Messages:
-- : 'fmbox-id' --> 'documentation-meta-data'
-- : 'fmbox-style' --> 'background-color: #ecfcf4'
-- : 'fmbox-textstyle' --> 'font-style: italic'
--
-- @function p.endBox
-- @param {table|Frame} args - a table of arguments passed by the user
-- @param[opt] {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string}
p.endBox = p.makeInvokeFunc('_endBox')


function p._endBox(args, env)
--- Whether to show a link to the sandbox subpage
-- Get environment data.
-- @property {boolean} cfg['sandbox-subpage-show']
env = env or p.getEnvironment(args)
cfg['sandbox-subpage-show'] = true


local subjectSpace = env.subjectSpace
--- The name of the template subpage typically used for sandboxes.
local docTitle = env.docTitleCurrentLang
--  @property {string} cfg['sandbox-subpage']
cfg['sandbox-subpage'] = 'Draft'


local root = mw.html.create('div')
--- Preload file for template sandbox pages.
:attr('id', p.message('end-box-div-id'))
--  @property {string} cfg['template-sandbox-preload']
:addClass(p.message('end-box-div-classes'))
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
:css('clear', 'both')


local hasDocPage  = subjectSpace and docTitle and checkExists(docTitle.prefixedText)
--- Preload file for Lua module sandbox pages.
local linkBoxSpace = subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828
--  @property {string} cfg['module-sandbox-preload']
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'


-- Check whether we should output the end box at all. Add the end
--- The page to preload when a user clicks the "mirror" link.
-- box by default if the documentation exists or if we are in the
-- @property {string} cfg['mirror-link-preload']
-- user, module or template namespaces.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'
local linkBox = args['link box']
local expandedLinkBox = yesno(linkBox, true)


if (
-- -------------------------------------------------------------------------------------------------
not hasDocPage and not linkBoxSpace
-- Test cases link configuration
and not (linkBox and yesno(linkBox) == nil)
-- -------------------------------------------------------------------------------------------------
) then
return root
:attr('id', nil)
:attr('class', nil)
:allDone()
end


local customLanguagesNotice = i18n:msg('custom-languages-notice', docTitle.prefixedText,
--- The name of the template subpage typically used for test cases.
docTitle:fullUrl({ action = 'edit' }, 'https'):gsub("%%", "%%%%"), 'bottom')
--  @property {string} cfg['testcases-subpage']
cfg['testcases-subpage'] = 'testcases'


if expandedLinkBox == false then
--- Preload file for template test cases pages.
return root:wikitext(customLanguagesNotice):allDone()
--  @property {string} cfg['template-testcases-preload']
end
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'


if linkBox and yesno(linkBox) == nil then
--- Preload file for Lua module test cases pages.
root:wikitext(linkBox)
--  @property {string} cfg['module-testcases-preload']
else
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
local isFirstLine = true
if (not args.content) and hasDocPage then
isFirstLine = false
root:wikitext(customLanguagesNotice)
end


if linkBoxSpace then
--- Preload file for Lua module test cases talk pages.
-- We are in the user, template or module namespaces.
-- @property {string} cfg['module-testcases-run-preload']
-- Add sandbox and testcases links:
cfg['module-testcases-run-preload'] = 'Template:Documentation/preload-module-testcases-run'
-- "Editors can experiment in this template's sandbox (edit | history / create | mirror) and testcases (edit/create) pages."
local experimentBlurb = p.makeExperimentBlurb(args, env)
if experimentBlurb then
if isFirstLine then
isFirstLine = false
else
root:tag('br')
end
root:node(experimentBlurb)
end


-- "Please add categories to the /doc subpage."
-- -------------------------------------------------------------------------------------------------
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- Add categories blurb configuration
-- as then it is unclear where to add the categories.
-- -------------------------------------------------------------------------------------------------
local categoriesBlurb
if not args.content and not args[1] then
categoriesBlurb = p.makeCategoriesBlurb(args, env)
end


-- "Subpages of this template"
--- The text to display when linking to the /doc subpage.
local subpagesBlurb = p.makeSubpagesBlurb(args, env)
--  @property {string} cfg['doc-link-display']
cfg['doc-link-display'] = 'documentation'


if categoriesBlurb or subpagesBlurb then
-- -------------------------------------------------------------------------------------------------
if isFirstLine then
-- Doc link configuration
isFirstLine = false
-- -------------------------------------------------------------------------------------------------
else
root:tag('br'):done()
end


root:node(categoriesBlurb)
--- The name of the subpage typically used for documentation pages.
--  @property {string} cfg['doc-subpage']
cfg['doc-subpage'] = 'doc'


if categoriesBlurb and subpagesBlurb then
--- Preload file for documentation page in the file namespace.
root:wikitext(' ');
--  @property {string} cfg['file-docpage-preload']
end
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'


root:node(subpagesBlurb)
--- Preload file for template documentation pages in all namespaces.
end
--  @property {string} cfg['docpage-preload']
cfg['docpage-preload'] = 'Template:Documentation/preload'


-- TODO: consider adding the print blurb
--- Preload file for Lua module documentation pages.
end
--  @property {string} cfg['module-preload']
end
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'


return root:allDone()
-- -------------------------------------------------------------------------------------------------
end
-- Print version configuration
-- -------------------------------------------------------------------------------------------------


--[[
--- Disables or enabled /print content
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- @property {boolean} cfg['print-show']
--
cfg['print-show'] = false
-- ; Messages:
-- : 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- : 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- : 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- : 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- : 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- : 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
--
-- @function p.makeExperimentBlurb
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string|nil}
--]]
function p.makeExperimentBlurb(args, env)
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle


if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
--- The name of the template subpage used for print versions.
return nil
--  @property {string} cfg['print-subpage']
end
cfg['print-subpage'] = 'Print'


local templatePage = templateTitle.prefixedText
--- The text to display when linking to the /Print subpage.
--  @property {string} cfg['print-link-display']
cfg['print-link-display'] = '/Print'


-- Make links.
-- cfg['print-blurb']
local frame = mw.getCurrentFrame()
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
local sandboxLinks = mw.html.create()
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
local testcasesLinks = mw.html.create()
.. ' If you make a change to this template, please update the print version as well.'


if checkExists(sandboxTitle.prefixedText) then
--- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
sandboxLinks:wikitext(
--  This should be a boolean value (either true or false).
p.makeUrlWikilink(sandboxTitle.prefixedText, i18n:msg('sandbox-link-display')),
--  @property {boolean} cfg['display-print-category']
' '
cfg['display-print-category'] = false
)


local sandboxEditLink = p.makeUrlLink(
--- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
sandboxTitle:fullUrl({ action = 'edit' }, 'https'),
--  @property {string} cfg['print-category']
frame:preprocess('{{lc:{{int:edit}}}}')
cfg['print-category'] = 'Templates with print versions'
)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
compareLink = p.makeUrlLink(
compareUrl,
frame:preprocess('{{lc:{{int:diff}}}}')
)
end


sandboxLinks:node(p.makeToolbar(sandboxEditLink, compareLink))
-- -------------------------------------------------------------------------------------------------
elseif p.message('sandbox-subpage-show', nil, 'boolean') then
-- HTML and CSS configuration
sandboxLinks:wikitext(
-- -------------------------------------------------------------------------------------------------
i18n:msg('sandbox-link-display'),
' '
)


local sandboxCreateLink = p.makeUrlLink(
--- The "id" attribute of the main HTML "div" tag.
sandboxTitle:fullUrl({
--  @property {string} cfg['main-div-id']
action  = 'edit',
cfg['main-div-id'] = 'template-documentation'
redlink = '1',
preload = subjectSpace == 828
and p.message('module-sandbox-preload')
or p.message('template-sandbox-preload'),
}, 'https'),
frame:preprocess('{{lc:{{int:create}}}}')
)
local mirrorPreload = p.message('mirror-link-preload')
if templateTitle.namespace == 828 then
mirrorPreload = templateTitle.prefixedText
end
local mirrorLink = p.makeUrlLink(
sandboxTitle:fullUrl({
action  = 'edit',
redlink = '1',
preload = mirrorPreload,
summary = i18n:msg('mirror-edit-summary', p.makeWikilink(templatePage)),
}, 'https'),
i18n:msg('mirror-link-display')
)


sandboxLinks:node(p.makeToolbar(sandboxCreateLink, mirrorLink))
--- The CSS classes added to the main HTML "div" tag.
else
--  @property {string} cfg['main-div-classes']
sandboxLinks = nil
cfg['main-div-classes'] = 'template-documentation iezoomfix'
end


if checkExists(testcasesTitle.prefixedText) then
--- The CSS classes used for the start box "div" tag.
testcasesLinks:wikitext(
--  @property {string} cfg['start-box-div-classes']
p.makeUrlWikilink(testcasesTitle.prefixedText, i18n:msg('testcases-link-display')),
cfg['start-box-div-classes'] = 'template-documentation-header'
' '
)


local testcasesEditLink = p.makeUrlLink(
--- The CSS classes used for the [view][edit][history] or [create] links in the start box.
testcasesTitle:fullUrl({ action = 'edit' }, 'https'),
--  @property {string} cfg['start-box-linkclasses']
frame:preprocess('{{lc:{{int:edit}}}}')
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
)


if env.subjectSpace == 828 then
--- The HTML "id" attribute for the links in the start box.
local testcasesRunLink
-- @property {string} cfg['start-box-link-id']
local testcasesRunLinkDisplay = p.message('sandbox-notice-testcases-run-link-display')
cfg['start-box-link-id'] = 'doc_editlinks'
local runTitle = testcasesTitle.talkPageTitle
if checkExists(runTitle.prefixedText) then
testcasesRunLink = p.makeUrlWikilink(runTitle.prefixedText, testcasesRunLinkDisplay)
else
testcasesRunLink = p.makeUrlLink(runTitle:fullUrl({
action = 'edit',
redlink = '1',
preload = p.message('module-testcases-run-preload'),
}), testcasesRunLinkDisplay)
end
testcasesLinks:node(p.makeToolbar(testcasesEditLink, testcasesRunLink))
else
testcasesLinks:node(p.makeToolbar(testcasesEditLink))
end
else
testcasesLinks:wikitext(
i18n:msg('testcases-link-display'),
' '
)


local testcasesCreateLink = p.makeUrlLink(
--- The CSS classes used for the languages list.
testcasesTitle:fullUrl({
--  @property {string} cfg['languages-list-div-classes']
action  = 'edit',
cfg['languages-list-div-classes'] = 'template-documentation-langs'
redlink = '1',
preload = subjectSpace == 828
and p.message('module-testcases-preload')
or  p.message('template-testcases-preload'),
}, 'https'),
frame:preprocess('{{lc:{{int:create}}}}')
)


testcasesLinks:node(p.makeToolbar(testcasesCreateLink))
--- The CSS classes used for the content box "div" tag.
end
--  @property {string} cfg['content-box-div-classes']
cfg['content-box-div-classes'] = 'template-documentation-content'


local msgArgs = { tostring(testcasesLinks):gsub('%%', '%%%%') or '' }
--- The "id" attribute of the end box HTML "div" tag.
--  @property {string} cfg['end-box-div-id']
cfg['end-box-div-id'] = 'documentation-meta-data'


local messageName =
--- The CSS classes used for the end box "div" tag.
subjectSpace == 828
--  @property {string} cfg['end-box-div-classes']
and 'experiment-blurb-module'
cfg['end-box-div-classes'] = 'template-documentation-footer transclude-notice-bottom plainlinks'
or  'experiment-blurb-template'


if sandboxLinks then
-- -------------------------------------------------------------------------------------------------
table.insert(msgArgs, 1, tostring(sandboxLinks):gsub('%%', '%%%%') or '')
-- Tracking category configuration
else
-- -------------------------------------------------------------------------------------------------
messageName = messageName .. '-nosandbox'
end


return i18n:msg{
--- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
key = messageName,
-- or a /testcases subpage. This should be a boolean value (either true or false).
args = msgArgs,
--  @property {boolean} cfg['display-strange-usage-category']
}
cfg['display-strange-usage-category'] = true
end


--[[
--- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- Generates the text "Please add categories to the /doc subpage."
-- /doc subpage or a /testcases subpage.
--
-- @property {string} cfg['strange-usage-category']
-- ; Messages:
cfg['strange-usage-category'] = 'Pages with Strange ((documentation)) Usage'
-- : 'doc-link-display' --> '/doc'
-- : 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--
-- @function p.makeCategoriesBlurb
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string|nil}
--]]
function p.makeCategoriesBlurb(args, env)
local docTitle = env.docTitle
if not docTitle then
return nil
end


local docPathLink = p.makeUrlWikilink(
--- Category to output if the /doc subpage is missing and the 'content' parameter is not specified
docTitle.prefixedText,
--  @property {string} cfg['nodoc-category-{template,module,file,other}']
p.message('doc-link-display')
cfg['nodoc-category-template'] = 'Templates with no documentation'
):gsub("%%", "%%%%")
cfg['nodoc-category-module'] = 'Modules with no documentation'
cfg['nodoc-category-file'] = 'Files with no summary'
cfg['nodoc-category-other'] = 'Pages with no documentation'


return i18n:msg('add-categories-blurb', docPathLink)
--- Category to output if the documentation is marked as bad
end
--  @property {string} cfg['baddoc-category-{template,module,file,other}']
cfg['baddoc-category-template'] = 'Templates with bad documentation'
cfg['baddoc-category-module'] = 'Modules with bad documentation'
cfg['baddoc-category-file'] = 'Files with bad summary'
cfg['baddoc-category-other'] = 'Pages with bad documentation'


--[[
-- -------------------------------------------------------------------------------------------------
-- Generates the "Subpages of this template" link.
-- End configuration
--
-- ; Messages:
-- : 'template-pagetype' --> 'template'
-- : 'module-pagetype' --> 'module'
-- : 'default-pagetype' --> 'page'
-- : 'subpages-link-display' --> 'Subpages of this $1'
--
--
-- @function p.makeSubpagesBlurb
-- Don't edit anything below this line.
-- @private
-- -------------------------------------------------------------------------------------------------
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string|nil}
--]]
function p.makeSubpagesBlurb(args, env)
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
 
local namespaceName = p.resolveNamespace(subjectSpace)
assert(namespaceName ~= 'file')
 
return i18n:msg(
p.resolveNamespace(subjectSpace) .. '-subpages-link',
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/'
)
end
 
---
-- Generates the blurb displayed when there is a print version of the template available.
--
-- ; Messages:
-- : 'print-link-display' --> '/Print'
-- : 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'
-- .. ' of this template exists at $1.'
-- .. ' If you make a change to this template, please update the print version as well.'
-- : 'display-print-category' --> true
-- : 'print-category' --> 'Templates with print versions'
--
-- @function p.makePrintBlurb
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string|nil}
function p.makePrintBlurb(args, env)
local printTitle = env.printTitle
if not printTitle then
return nil
end
local ret
if checkExists(printTitle.prefixedText) then
local printLink = p.makeWikilink(printTitle.prefixedText, p.message('print-link-display'))
ret = p.message('print-blurb', {printLink})
local displayPrintCategory = p.message('display-print-category', nil, 'boolean')
if displayPrintCategory then
ret = ret .. p.makeCategoryLink(p.message('print-category'))
end
end
return ret
end
 
-- --------------------------------------------------------------------------
-- Tracking categories
-- --------------------------------------------------------------------------
 
--[[
-- Check if {{T|documentation}} is transcluded on a /doc or /testcases page.
--
-- ; Messages:
-- : 'display-strange-usage-category' --> true
-- : 'doc-subpage' --> 'doc'
-- : 'testcases-subpage' --> 'testcases'
-- : 'strange-usage-category' --> 'Pages with strange ((documentation)) usage'
-- : 'nodoc-category-template' --> 'Templates with no documentation'
-- : 'nodoc-category-module' --> 'Modules with no documentation'
-- : 'nodoc-category-file' --> 'Files with no summary'
-- : 'nodoc-category-other' --> 'Pages with no documentation'
-- : 'baddoc-category-template' --> 'Templates with bad documentation'
-- : 'baddoc-category-module' --> 'Modules with bad documentation'
-- : 'baddoc-category-file' --> 'Files with bad summary'
-- : 'baddoc-category-other' --> 'Pages with bad documentation'
--
-- /testcases pages in the module namespace are not categorised, as they may have
-- {{T|documentation}} transcluded automatically.
--
-- @function p.addTrackingCategories
-- @private
-- @param {Environment} env - environment table containing title objects, etc., generated with p.getEnvironment
-- @return {string|nil}
--]]
function p.addTrackingCategories(env)
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 p.message('display-strange-usage-category', nil, 'boolean')
and (
subpage == p.message('doc-subpage')
or subjectSpace ~= 828 and subpage == p.message('testcases-subpage')
)
then
ret = ret .. p.makeCategoryLink(p.message('strange-usage-category'))
end
local docStatus = env.docStatus
if docStatus then
ret = ret .. p.makeCategoryLink(p.message(docStatus .. '-category-' .. p.resolveNamespace(subjectSpace)))
end
if p.resolveNamespace(subjectSpace) ~= 'other' and subpage ~= p.message('sandbox-subpage') then
ret = ret .. p.makeCategoryLink(p.resolveNamespace(subjectSpace, true))
end
return ret
end
 
-- --------------------------------------------------------------------------
-- Type category
-- --------------------------------------------------------------------------
--[[
-- Add type if in arguments
-- @function p.addTypeCategory
-- @private
-- @param {table} args - a table of arguments passed by the user
-- @return {string}
--]]
function p.addTypeCategory(args)
if lib.isEmpty(args['type']) then return '' end
local templateTypes = lib.split(args['type'], ';')
local ret = ''
if templateTypes then
for _,Type in ipairs(templateTypes) do
ret = ret .. p.makeCategoryLink(Type .. ' Templates')
end
end
return ret
end


return p
return cfg

Revision as of 13:05, 17 December 2023

Documentation for this module may be created at Module:Documentation/doc 

--<pre>
----------------------------------------------------------------------------------------------------
--
--                         '''Configuration for [[Module:Documentation]]'''
--
-- Here you can set the values of the parameters and messages used in [[Module:Documentation]]
-- to localise it to your wiki and your language. Unless specified otherwise, values given here
-- should be string values.
--
-- @submodule documentation.config
-- @alias cfg
----------------------------------------------------------------------------------------------------

local cfg = {} -- Do not edit this line.

-- -------------------------------------------------------------------------------------------------
-- Protection template configuration
-- -------------------------------------------------------------------------------------------------

--- The protection reason for edit-protected templates to pass
--  to Module:Protection banner.
--  @property {string} cfg['protection-reason-edit']
cfg['protection-reason-edit'] = 'template'

-- -------------------------------------------------------------------------------------------------
-- Templates
-- -------------------------------------------------------------------------------------------------
--- A name of the template for Table of Contents in right alignment.
--  @property {string} cfg['template-tocright']
cfg['template-tocright'] = 'Tocright'

-- -------------------------------------------------------------------------------------------------
-- Sandbox notice configuration
--
-- On sandbox pages the module can display a template notifying users that the current page is a
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the
-- messages that the notices contains.
-- -------------------------------------------------------------------------------------------------

-- Not yet converted to the new format

--- Whether to show the sandbox notice on `/sandbox` subpages
--  @property {boolean} cfg['sandbox-notice-show']
cfg['sandbox-notice-show'] = true

--- The file displayed in the sandbox notice.
--  @property {string} cfg['sandbox-notice-image']
cfg['sandbox-notice-image'] = 'Hinoki_bookcase.png'

--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-module']
-- cfg['sandbox-notice-pagetype-other']
-- The page type of the sandbox page. The message that is displayed depends on the current subject
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
-- cfg['sandbox-notice-diff-blurb'].
--]]
cfg['sandbox-notice-pagetype-template'] = 'template draft page'
cfg['sandbox-notice-pagetype-module'] =   'module draft page'
cfg['sandbox-notice-pagetype-other'] = 'draft page'

--[[
-- cfg['sandbox-notice-blurb']
-- cfg['sandbox-notice-diff-blurb']
-- cfg['sandbox-notice-diff-display']
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
-- type, which is either cfg['sandbox-notice-pagetype-template'],
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between
-- the sandbox and the main template. The display value of the diff link is set by
-- cfg['sandbox-notice-compare-link-display'].
--]]
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
cfg['sandbox-notice-compare-link-display'] = 'diff'

--[[
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg['sandbox-notice-testcases-run-blurb']
-- cfg['sandbox-notice-testcases-run-link-display']
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
-- cases page, and $2 is a link to the page to run it.
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
-- cases.
--]]
cfg['sandbox-notice-testcases-show'] = true
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
cfg['sandbox-notice-testcases-run-link-display'] = 'run'

--- A category to add to all template sandboxes.
--  @property {string} cfg['sandbox-category']
cfg['sandbox-category'] = 'Template drafts'
cfg['sandbox-module-category'] = 'Module drafts'

-- -------------------------------------------------------------------------------------------------
-- Start box configuration
-- -------------------------------------------------------------------------------------------------

--- The wikitext for the icon shown at the top of the template.
--  @property {string} cfg['documentation-icon-wikitext']
cfg['documentation-icon-wikitext'] = '[[File:$1|30px|link=|alt=Documentation icon]]'

--- The file name for the icon shown at the top of the template.
--  @property {string} cfg['documentation-icon']
cfg['documentation-icon'] = 'Hinoki_bookcase.png'

--- The file name for the icon shown at the top of the template when no /doc subpage exists.
--  @property {string} cfg['documentation-icon-nodoc']
cfg['documentation-icon-nodoc'] = 'Hinoki_bookcase.png'

--- The file name for the icon shown at the top of the template when the documentation is marked as bad.
--  @property {string} cfg['documentation-icon-baddoc']
cfg['documentation-icon-baddoc'] = 'Hinoki_bookcase.png'

-- -------------------------------------------------------------------------------------------------
-- Sandbox link configuration
-- -------------------------------------------------------------------------------------------------

--- Whether to show a link to the sandbox subpage
--  @property {boolean} cfg['sandbox-subpage-show']
cfg['sandbox-subpage-show'] = true

--- The name of the template subpage typically used for sandboxes.
--  @property {string} cfg['sandbox-subpage']
cfg['sandbox-subpage'] = 'Draft'

--- Preload file for template sandbox pages.
--  @property {string} cfg['template-sandbox-preload']
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'

--- Preload file for Lua module sandbox pages.
--  @property {string} cfg['module-sandbox-preload']
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'

--- The page to preload when a user clicks the "mirror" link.
--  @property {string} cfg['mirror-link-preload']
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'

-- -------------------------------------------------------------------------------------------------
-- Test cases link configuration
-- -------------------------------------------------------------------------------------------------

--- The name of the template subpage typically used for test cases.
--  @property {string} cfg['testcases-subpage']
cfg['testcases-subpage'] = 'testcases'

--- Preload file for template test cases pages.
--  @property {string} cfg['template-testcases-preload']
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'

--- Preload file for Lua module test cases pages.
--  @property {string} cfg['module-testcases-preload']
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'

--- Preload file for Lua module test cases talk pages.
--  @property {string} cfg['module-testcases-run-preload']
cfg['module-testcases-run-preload'] = 'Template:Documentation/preload-module-testcases-run'

-- -------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
-- -------------------------------------------------------------------------------------------------

--- The text to display when linking to the /doc subpage.
--  @property {string} cfg['doc-link-display']
cfg['doc-link-display'] = 'documentation'

-- -------------------------------------------------------------------------------------------------
-- Doc link configuration
-- -------------------------------------------------------------------------------------------------

--- The name of the subpage typically used for documentation pages.
--  @property {string} cfg['doc-subpage']
cfg['doc-subpage'] = 'doc'

--- Preload file for documentation page in the file namespace.
--  @property {string} cfg['file-docpage-preload']
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'

--- Preload file for template documentation pages in all namespaces.
--  @property {string} cfg['docpage-preload']
cfg['docpage-preload'] = 'Template:Documentation/preload'

--- Preload file for Lua module documentation pages.
--  @property {string} cfg['module-preload']
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'

-- -------------------------------------------------------------------------------------------------
-- Print version configuration
-- -------------------------------------------------------------------------------------------------

--- Disables or enabled /print content
--  @property {boolean} cfg['print-show']
cfg['print-show'] = false

--- The name of the template subpage used for print versions.
--  @property {string} cfg['print-subpage']
cfg['print-subpage'] = 'Print'

--- The text to display when linking to the /Print subpage.
--  @property {string} cfg['print-link-display']
cfg['print-link-display'] = '/Print'

-- cfg['print-blurb']
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
	.. ' If you make a change to this template, please update the print version as well.'

--- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
--  This should be a boolean value (either true or false).
--  @property {boolean} cfg['display-print-category']
cfg['display-print-category'] = false

--- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
--  @property {string} cfg['print-category']
cfg['print-category'] = 'Templates with print versions'

-- -------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
-- -------------------------------------------------------------------------------------------------

--- The "id" attribute of the main HTML "div" tag.
--  @property {string} cfg['main-div-id']
cfg['main-div-id'] = 'template-documentation'

--- The CSS classes added to the main HTML "div" tag.
--  @property {string} cfg['main-div-classes']
cfg['main-div-classes'] = 'template-documentation iezoomfix'

--- The CSS classes used for the start box "div" tag.
--  @property {string} cfg['start-box-div-classes']
cfg['start-box-div-classes'] = 'template-documentation-header'

--- The CSS classes used for the [view][edit][history] or [create] links in the start box.
--  @property {string} cfg['start-box-linkclasses']
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'

--- The HTML "id" attribute for the links in the start box.
--  @property {string} cfg['start-box-link-id']
cfg['start-box-link-id'] = 'doc_editlinks'

--- The CSS classes used for the languages list.
--  @property {string} cfg['languages-list-div-classes']
cfg['languages-list-div-classes'] = 'template-documentation-langs'

--- The CSS classes used for the content box "div" tag.
--  @property {string} cfg['content-box-div-classes']
cfg['content-box-div-classes'] = 'template-documentation-content'

--- The "id" attribute of the end box HTML "div" tag.
--  @property {string} cfg['end-box-div-id']
cfg['end-box-div-id'] = 'documentation-meta-data'

--- The CSS classes used for the end box "div" tag.
--  @property {string} cfg['end-box-div-classes']
cfg['end-box-div-classes'] = 'template-documentation-footer transclude-notice-bottom plainlinks'

-- -------------------------------------------------------------------------------------------------
-- Tracking category configuration
-- -------------------------------------------------------------------------------------------------

--- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
--  or a /testcases subpage. This should be a boolean value (either true or false).
--  @property {boolean} cfg['display-strange-usage-category']
cfg['display-strange-usage-category'] = true

--- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
--  /doc subpage or a /testcases subpage.
--  @property {string} cfg['strange-usage-category']
cfg['strange-usage-category'] = 'Pages with Strange ((documentation)) Usage'

--- Category to output if the /doc subpage is missing and the 'content' parameter is not specified
--  @property {string} cfg['nodoc-category-{template,module,file,other}']
cfg['nodoc-category-template'] = 'Templates with no documentation'
cfg['nodoc-category-module'] = 'Modules with no documentation'
cfg['nodoc-category-file'] = 'Files with no summary'
cfg['nodoc-category-other'] = 'Pages with no documentation'

--- Category to output if the documentation is marked as bad
--  @property {string} cfg['baddoc-category-{template,module,file,other}']
cfg['baddoc-category-template'] = 'Templates with bad documentation'
cfg['baddoc-category-module'] = 'Modules with bad documentation'
cfg['baddoc-category-file'] = 'Files with bad summary'
cfg['baddoc-category-other'] = 'Pages with bad documentation'

-- -------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
-- -------------------------------------------------------------------------------------------------

return cfg
Retrieved from "https://coralisland.wiki/w/index.php?title=Module:Documentation&oldid=9923"