Module:Documentation and Module:Documentation/config: Difference between pages

From Frontierpedia, the Microsoft Agent encyclopedia
(Difference between pages)
w>MusikAnimal
m (Protected "Module:Documentation": High-risk Lua module ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
 
en>Mr. Stradivarius
(add cfg.titleArg)
 
Line 1: Line 1:
-- This module implements {{documentation}}.
----------------------------------------------------------------------------------------------------
--
--                              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.
----------------------------------------------------------------------------------------------------
 
local cfg = {} -- Do not edit this line.
 
----------------------------------------------------------------------------------------------------
-- Environment configuration
----------------------------------------------------------------------------------------------------


-- Get required modules.
-- cfg.titleArg
local getArgs = require('Module:Arguments').getArgs
-- An argument to specify what page to make links for. For testing purposes.
local messageBox = require('Module:Message box')
cfg.titleArg = 'page'


-- Get the config table.
----------------------------------------------------------------------------------------------------
local cfg = mw.loadData('Module:Documentation/config')
-- Protection template configuration
----------------------------------------------------------------------------------------------------


local p = {}
-- cfg.protectionTemplate
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg.protectionTemplate = 'pp-template'


-- Often-used functions.
-- cfg.protectionTemplateArgs
local ugsub = mw.ustring.gsub
-- Any arguments to send to the protection template.
cfg.protectionTemplateArgs = {docusage = 'yes'}


----------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Helper functions
-- Sandbox template configuration
--
--
-- These are defined as local functions, but are made available in the p
-- On sandbox pages the module can display a template notifying users that the current page is a
-- table for testing purposes.
-- 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.sandboxSubpage. The following settings configure which
-- template is displayed and what the arguments passed to it are.
----------------------------------------------------------------------------------------------------


local function message(cfgKey, valArray, expectType)
-- cfg.sandboxNoticeTemplate
--[[
-- The name of the template to display at the top of sandbox pages.
-- Gets a message from the cfg table and formats it if appropriate.
cfg.sandboxNoticeTemplate = 'template sandbox notice'
-- 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.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end


local function getMessageVal(match)
-- cfg.sandboxNoticeLivepageParam
match = tonumber(match)
-- The parameter of the sandbox notice template to send the cfg.livepageArg to.
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
cfg.sandboxNoticeLivepageParam = 1
end


local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
-- cfg.livepageArg
return ret
-- The name of one of the module arguments. The value of this argument should be the main template
end
-- page (i.e. the "live" template). This is passed to the parameter cfg.sandboxNoticeLivepageParam of
-- the template cfg.sandboxNoticeTemplate.
cfg.livepageArg = 'livepage'


p.message = message
----------------------------------------------------------------------------------------------------
-- Start box configuration
----------------------------------------------------------------------------------------------------


local function makeWikilink(page, display)
-- cfg.documentationIconWikitext
if display then
-- The wikitext for the icon shown at the top of the template.
return mw.ustring.format('[[%s|%s]]', page, display)
cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
else
return mw.ustring.format('[[%s]]', page)
end
end


p.makeWikilink = makeWikilink
-- cfg.headingArg
-- Custom heading used in the start box.
cfg.headingArg = 'heading'


local function makeCategoryLink(cat, sort)
-- cfg.headingStyleArg
local catns = mw.site.namespaces[14].name
-- Custom CSS style for the start box heading.
return makeWikilink(catns .. ':' .. cat, sort)
cfg.headingStyleArg = 'heading-style'
end


p.makeCategoryLink = makeCategoryLink
-- cfg.templateNamespaceHeading
-- The heading shown in the template namespace.
cfg.templateNamespaceHeading = 'Template documentation'


local function makeUrlLink(url, display)
-- cfg.moduleNamespaceHeading
return mw.ustring.format('[%s %s]', url, display)
-- The heading shown in the module namespace.
end
cfg.moduleNamespaceHeading = 'Module documentation'


p.makeUrlLink = makeUrlLink
-- cfg.fileNamespaceHeading
-- The heading shown in the file namespace.
cfg.fileNamespaceHeading = 'Summary'


local function makeToolbar(...)
-- cfg.otherNamespacesHeading
local ret = {}
-- The heading shown in other namespaces.
local lim = select('#', ...)
cfg.otherNamespacesHeading = 'Documentation'
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
end


p.makeToolbar = makeToolbar
-- cfg.viewLinkDisplay
-- The text to display for "view" links.
cfg.viewLinkDisplay = 'view'


----------------------------------------------------------------------------
-- cfg.editLinkDisplay
-- Argument processing
-- The text to display for "edit" links.
----------------------------------------------------------------------------
cfg.editLinkDisplay = 'edit'


local function makeInvokeFunc(funcName)
-- cfg.historyLinkDisplay
return function (frame)
-- The text to display for "history" links.
local args = getArgs(frame, {
cfg.historyLinkDisplay = 'history'
valueFunc = function (key, value)
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 p[funcName](args)
end
end


----------------------------------------------------------------------------
-- cfg.purgeLinkDisplay
-- Main function
-- The text to display for "purge" links.
----------------------------------------------------------------------------
cfg.purgeLinkDisplay = 'purge'


p.main = makeInvokeFunc('_main')
-- cfg.createLinkDisplay
-- The text to display for "create" links.
cfg.createLinkDisplay = 'create'


function p._main(args)
----------------------------------------------------------------------------------------------------
--[[
-- Preload configuration
-- This function defines logic flow for the module.
----------------------------------------------------------------------------------------------------
-- @args - table of arguments passed by the user
--  
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
:css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
:newline()
:done()
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
return tostring(root)
end


----------------------------------------------------------------------------
-- cfg.preloadArg
-- Environment settings
-- Custom preload page for creating documentation.
----------------------------------------------------------------------------
cfg.preloadArg = 'preload'


function p.getEnvironment(args)
----------------------------------------------------------------------------------------------------
--[[
-- Documentation content configuration
-- Returns a table with information about the environment, including title objects and other namespace- or
----------------------------------------------------------------------------------------------------
-- path-related data.
-- @args - table of arguments passed by the user
--
-- Title objects include:
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
-- env.printTitle - the print version of the template, located at the /Print subpage.
--
-- Data includes:
-- env.protectionLevels - the protection levels table of the title object.
-- env.subjectSpace - the number of the title's subject namespace.
-- env.docSpace - the number of the namespace the title puts its documentation in.
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--  
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]
local env, envFuncs = {}, {}


-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- cfg.contentArg
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- Passes documentation content directly from the {{documentation}} invocation.
-- more than once. (Nils won't be memoized.)
cfg.contentArg = 'content'
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
})


function envFuncs.title()
----------------------------------------------------------------------------------------------------
-- The title object for the current page, or a test page passed with args.page.
-- Link box (end box) configuration
local title
----------------------------------------------------------------------------------------------------
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end


function envFuncs.templateTitle()
-- cfg.linkBoxArg
--[[
-- Specifies a custom link box (end box) or prevents it from being generated.
-- The template (or module, etc.) title object.
cfg.linkBoxArg = 'link box'
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end


function envFuncs.docTitle()
-- cfg.linkBoxOff
--[[
-- The value to send to cfg.linkBoxArg to turn the link box off.
-- Title object of the /doc subpage.
cfg.linkBoxOff = 'off'
-- Messages:
-- 'doc-subpage' --> 'doc'
--]]
local title = env.title
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
end
return mw.title.new(docpage)
end
function envFuncs.sandboxTitle()
--[[
-- Title object for the /sandbox subpage.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end
function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end
function envFuncs.printTitle()
--[[
-- Title object for the /Print subpage.
-- Messages:
-- 'print-subpage' --> 'Print'
--]]
return env.templateTitle:subPageTitle(message('print-subpage'))
end


function envFuncs.protectionLevels()
-- cfg.transcludedFromBlurb
-- The protection levels table of the title object.
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
return env.title.protectionLevels
cfg.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
end


function envFuncs.subjectSpace()
-- cfg.createModuleDocBlurb
-- The subject namespace number.
-- Notice displayed in the module namespace when the documentation subpage does not exist.
return mw.site.namespaces[env.title.namespace].subject.id
-- $1 is a link to create the documentation page with the preload cfg.modulePreload and the
end
-- display cfg.createLinkDisplay.
cfg.createModuleDocBlurb = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'


function envFuncs.docSpace()
----------------------------------------------------------------------------------------------------
-- The documentation namespace number. For most namespaces this is the same as the
-- Experiment blurb configuration
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
----------------------------------------------------------------------------------------------------
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
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


function envFuncs.docpageBase()
-- cfg.experimentBlurb
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- This is the text inviting editors to experiment in sandbox and test cases pages. It is only
-- For some namespaces this is the talk page, rather than the template page.
-- shown in the template and module namespaces. With the default English settings, it might look
local templateTitle = env.templateTitle
-- like this:
local docSpace = env.docSpace
--
local docSpaceText = mw.site.namespaces[docSpace].name
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
--
return docSpaceText .. ':' .. templateTitle.text
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
end
--  
-- Parameters:
function envFuncs.compareUrl()
--
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
-- $1 is the possessive name for "module" or "template", set by cfg.templatePossessive or
local templateTitle = env.templateTitle
-- cfg.modulePossessive depending on what namespace we are in.
local sandboxTitle = env.sandboxTitle
--
if templateTitle.exists and sandboxTitle.exists then
-- $2 is a link to the sandbox page. If the sandbox exists, it is in the following format:
local compareUrl = mw.uri.fullUrl(
--
'Special:ComparePages',
--    cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
--
)
-- If the sandbox doesn't exist, it is in the format:
return tostring(compareUrl)
--
else
--    cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay)
return nil
--
end
-- The link for cfg.sandboxCreateLinkDisplay link preloads the page with cfg.templateSandboxPreload
end
-- or cfg.moduleSandboxPreload, depending on the current namespace. The link for cfg.mirrorLinkDisplay
-- loads a default edit summary of cfg.mirrorEditSummary.
--
-- $3 is a link to the test cases page. If the test cases page exists, it is in the following format:
--
--    cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)
--
-- If the test cases page doesn't exist, it is in the format:
--
--    cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay)
--
-- If the test cases page doesn't exist, the link for cfg.testcasesCreateLinkDisplay preloads the
-- page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload, depending on the current
-- namespace.
cfg.experimentBlurb = 'Editors can experiment in this $1 $2 and $3 pages.'
 
-- cfg.templatePossessive
-- Possessive case for "template".
cfg.templatePossessive = "template's"
 
-- cfg.modulePossessive
-- Possessive case for "module".
cfg.modulePossessive = "module's"
 
----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------


return env
-- cfg.sandboxSubpage
end
-- The name of the template subpage typically used for sandboxes.
cfg.sandboxSubpage = 'sandbox'


----------------------------------------------------------------------------
-- cfg.templateSandboxPreload
-- Auxiliary templates
-- Preload file for template sandbox pages.
----------------------------------------------------------------------------
cfg.templateSandboxPreload = 'Template:Documentation/preload-sandbox'


function p.sandboxNotice(args, env)
-- cfg.moduleSandboxPreload
--[=[
-- Preload file for Lua module sandbox pages.
-- Generates a sandbox notice for display above sandbox pages.
cfg.moduleSandboxPreload = 'Template:Documentation/preload-module-sandbox'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- 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' --> '[[w:Wikipedia:Template sandbox and test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[w:Wikipedia:Template sandbox and test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
--]=]
local title = env.title
local sandboxTitle = env.sandboxTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
return nil
end
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
local omargs = {}
omargs.image = 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 text = ''
local pagetype
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
else
pagetype = message('sandbox-notice-pagetype-other')
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if compareUrl then
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
else
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
return ret
end


function p.protectionTemplate(env)
-- cfg.sandboxLinkDisplay
-- Generates the padlock icon in the top right.
-- The text to display for "sandbox" links.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
cfg.sandboxLinkDisplay = 'sandbox'
-- Messages:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels, mProtectionBanner
local title = env.title
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('Module:Protection banner')
local reason = 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('Module:Protection banner')
return mProtectionBanner._main{action = 'move', small = true}
else
return nil
end
end


----------------------------------------------------------------------------
-- cfg.sandboxEditLinkDisplay
-- Start box
-- The text to display for sandbox "edit" links.
----------------------------------------------------------------------------
cfg.sandboxEditLinkDisplay = 'edit'


p.startBox = makeInvokeFunc('_startBox')
-- cfg.sandboxCreateLinkDisplay
-- The text to display for sandbox "create" links.
cfg.sandboxCreateLinkDisplay = 'create'


function p._startBox(args, env)
-- cfg.compareLinkDisplay
--[[
-- The text to display for "compare" links.
-- This function generates the start box.
cfg.compareLinkDisplay = 'diff'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- which generate the box HTML.
--]]
env = env or p.getEnvironment(args)
local links
local content = args.content
if not content 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


function p.makeStartBoxLinksData(args, env)
-- cfg.mirrorEditSummary
--[[
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- template page.
-- @args - a table of arguments passed by the user
cfg.mirrorEditSummary = 'Create sandbox version of $1'
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'view-link-display' --> 'view'
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'purge-link-display' --> 'purge'
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'create-link-display' --> 'create'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local docTitle = env.docTitle
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end


local data = {}
-- cfg.mirrorLinkDisplay
data.title = title
-- The text to display for "mirror" links.
data.docTitle = docTitle
cfg.mirrorLinkDisplay = 'mirror'
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = message('view-link-display')
data.editLinkDisplay = message('edit-link-display')
data.historyLinkDisplay = message('history-link-display')
data.purgeLinkDisplay = message('purge-link-display')
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 6 then -- File namespace
preload = message('file-docpage-preload')
elseif subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end
data.preload = preload
data.createLinkDisplay = message('create-link-display')
return data
end


function p.renderStartBoxLinks(data)
----------------------------------------------------------------------------------------------------
--[[
-- Test cases link configuration
-- Generates the [view][edit][history][purge] or [create] links from the data table.
----------------------------------------------------------------------------------------------------
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]
local 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
-- cfg.testcasesSubpage
local docTitle = data.docTitle
-- The name of the template subpage typically used for test cases.
local title = data.title
cfg.testcasesSubpage = 'testcases'
if docTitle.exists then
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
else
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
ret = '[%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, createLink)
end
return ret
end


function p.makeStartBoxData(args, env, links)
-- cfg.templateTestcasesPreload
--[=[
-- Preload file for template test cases pages.
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
cfg.templateTestcasesPreload = 'Template:Documentation/preload-testcases'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
--
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
--]=]
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 = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
data.heading = message('file-namespace-heading')
else
data.heading = message('other-namespaces-heading')
end
-- 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 = '125%'
else
data.headingFontSize = '150%'
end
-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message('start-box-linkclasses')
data.linksId = message('start-box-link-id')
data.links = links
end
return data
end


function p.renderStartBox(data)
-- cfg.moduleTestcasesPreload
-- Renders the start box html.
-- Preload file for Lua module test cases pages.
-- @data - a table of data generated by p.makeStartBoxData.
cfg.moduleTestcasesPreload = 'Template:Documentation/preload-module-testcases'
local sbox = mw.html.create('div')
sbox
:css('padding-bottom', '3px')
:css('border-bottom', '1px solid #aaa')
:css('margin-bottom', '1ex')
: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('span')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end


----------------------------------------------------------------------------
-- cfg.testcasesLinkDisplay
-- Documentation content
-- The text to display for "testcases" links.
----------------------------------------------------------------------------
cfg.testcasesLinkDisplay = 'testcases'


p.content = makeInvokeFunc('_content')
-- cfg.testcasesEditLinkDisplay
-- The text to display for test cases "edit" links.
cfg.testcasesEditLinkDisplay = 'edit'


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


p.contentTitle = makeInvokeFunc('_contentTitle')
----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------


function p._contentTitle(args, env)
-- cfg.addCategoriesBlurb
env = env or p.getEnvironment(args)
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
local docTitle = env.docTitle
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
if not args.content and docTitle and docTitle.exists then
-- link to the /doc subpage with a display value of cfg.docLinkDisplay.
return docTitle.prefixedText
cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.'
else
return ''
end
end


----------------------------------------------------------------------------
-- cfg.docLinkDisplay
-- End box
-- The text to display when linking to the /doc subpage.
----------------------------------------------------------------------------
cfg.docLinkDisplay = '/doc'


p.endBox = makeInvokeFunc('_endBox')
----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------


function p._endBox(args, env)
-- cfg.subpagesLinkDisplay
--[=[
-- The text to display for the "subpages of this page" link. $1 is cfg.templatePagetype,
-- This function generates the end box (also known as the link box).
-- cfg.modulePagetype or cfg.defaultPagetype, depending on whether the current page is in th
-- @args - a table of arguments passed by the user
-- e template namespace, the module namespace, or another namespace.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
cfg.subpagesLinkDisplay = 'Subpages of this $1'
--  
-- Messages:
-- 'fmbox-id' --> 'documentation-meta-data'
-- 'fmbox-style' --> 'background-color: #ecfcf4'
-- 'fmbox-textstyle' --> 'font-style: italic'
--
-- The HTML is generated by the {{fmbox}} template, courtesy of [[Module:Message box]].
--]=]
-- Get environment data.
env = env or p.getEnvironment(args)
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
end
-- Check whether we should output the end box at all. Add the end
-- box by default if the documentation exists or if we are in the
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
end


-- Assemble the arguments for {{fmbox}}.
-- cfg.templatePagetype
local fmargs = {}
-- The pagetype to display for template pages.
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
cfg.templatePagetype = 'template'
fmargs.image = 'none'
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'


-- Assemble the fmbox text field.
-- cfg.modulePagetype
local text = ''
-- The pagetype to display for Lua module pages.
if linkBox then
cfg.modulePagetype = 'module'
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
-- We are in the user, template or module namespaces.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '')
text = text .. '<br />'
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- as then it is unclear where to add the categories.
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
if printBlurb then
text = text .. '<br />' .. printBlurb
end
end
end
fmargs.text = text


return messageBox.main('fmbox', fmargs)
-- cfg.defaultPagetype
end
-- The pagetype to display for pages other than templates or Lua modules.
cfg.defaultPagetype = 'page'


function p.makeDocPageBlurb(args, env)
----------------------------------------------------------------------------------------------------
--[=[
-- Doc link configuration
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
----------------------------------------------------------------------------------------------------
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--  
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[w:Wikipedia:Template documentation|documentation]]
-- is [[w:Wikipedia:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[w:Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local ret
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message('edit-link-display')
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message('history-link-display')
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. '<br />'
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. '<br />'
end
return ret
end


function p.makeExperimentBlurb(args, env)
-- cfg.docSubpage
--[[
-- The name of the subpage typically used for documentation pages.
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
cfg.docSubpage = 'doc'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-link-display' --> 'sandbox'
-- 'sandbox-edit-link-display' --> 'edit'
-- 'compare-link-display' --> 'diff'
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'sandbox-create-link-display' --> 'create'
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
-- 'mirror-link-display' --> 'mirror'
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- 'sandbox-link-display' --> 'sandbox'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display'--> 'edit'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display' --> 'edit'
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('module-sandbox-preload')
else
sandboxPreload = message('template-sandbox-preload')
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
if testcasesTitle.contentModel == "Scribunto"  and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
if subjectSpace == 828 then
messageName = 'experiment-blurb-module'
else
messageName = 'experiment-blurb-template'
end
return message(messageName, {sandboxLinks, testcasesLinks})
end


function p.makeCategoriesBlurb(args, env)
-- cfg.fileDocpagePreload
--[[
-- Preload file for documentation page in the file namespace.
-- Generates the text "Please add categories to the /doc subpage."
cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end


function p.makeSubpagesBlurb(args, env)
-- cfg.docpagePreload
--[[
-- Preload file for template documentation pages in all namespaces.
-- Generates the "Subpages of this template" link.
cfg.docpagePreload = 'Template:Documentation/preload'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'template-pagetype' --> 'template'
-- 'module-pagetype' --> 'module'
-- 'default-pagetype' --> 'page'
-- 'subpages-link-display' --> 'Subpages of this $1'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
pagetype = message('default-pagetype')
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end


function p.makePrintBlurb(args, env)
-- cfg.modulePreload
--[=[
-- Preload file for Lua module documentation pages.
-- Generates the blurb displayed when there is a print version of the template available.
cfg.modulePreload = 'Template:Documentation/preload-module-doc'
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- 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'
--]=]
local printTitle = env.printTitle
if not printTitle then
return nil
end
local ret
if printTitle.exists then
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))
ret = message('print-blurb', {printLink})
local displayPrintCategory = message('display-print-category', nil, 'boolean')
if displayPrintCategory then
ret = ret .. makeCategoryLink(message('print-category'))
end
end
return ret
end


----------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Tracking categories
-- Print version configuration
----------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


function p.addTrackingCategories(env)
-- cfg.printSubpage
--[[
-- The name of the template subpage used for print versions.
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
cfg.printSubpage = 'Print'
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
-- cfg.printLinkDisplay
-- Messages:
-- The text to display when linking to the /Print subpage.
-- 'display-strange-usage-category' --> true
cfg.printLinkDisplay = '/Print'
-- 'doc-subpage' --> 'doc'
 
-- 'testcases-subpage' --> 'testcases'
-- cfg.printBlurb
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay.
--  
cfg.printBlurb = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
-- /testcases pages in the module namespace are not categorised, as they may have
.. ' If you make a change to this template, please update the print version as well.'
-- {{documentation}} transcluded automatically.
 
--]]
-- cfg.displayPrintCategory
local title = env.title
-- Set to true to enable output of cfg.printCategory if a /Print subpage exists.
local subjectSpace = env.subjectSpace
cfg.displayPrintCategory = true
if not title or not subjectSpace then
 
return nil
-- cfg.printCategory
end
-- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists.
local subpage = title.subpageText
cfg.printCategory = 'Templates with print versions'
local ret = ''
 
if message('display-strange-usage-category', nil, 'boolean')
----------------------------------------------------------------------------------------------------
and (
-- HTML and CSS configuration
subpage == message('doc-subpage')
----------------------------------------------------------------------------------------------------
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
 
)
-- cfg.mainDivId
then
-- The "id" attribute of the main HTML "div" tag.
ret = ret .. makeCategoryLink(message('strange-usage-category'))
cfg.mainDivId = 'template-documentation'
end
 
return ret
-- cfg.mainDivClasses
end
-- The CSS classes added to the main HTML "div" tag.
cfg.mainDivClasses = 'template-documentation iezoomfix'
 
-- cfg.startBoxLinkclasses
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg.startBoxLinkclasses = 'mw-editsection plainlinks'
 
-- cfg.startBoxLinkId
-- The HTML "id" attribute for the links in the start box.
cfg.startBoxLinkId = 'doc_editlinks'
 
----------------------------------------------------------------------------------------------------
-- {{fmbox}} template configuration
----------------------------------------------------------------------------------------------------
 
-- cfg.fmboxIdParam
-- The name of the "id" parameter of {{fmbox}}.
cfg.fmboxIdParam = 'id'
 
-- cfg.fmboxId
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg.fmboxId = 'documentation-meta-data'
 
-- cfg.fmboxImageParam
-- The name of the "image" parameter of {{fmbox}}.
cfg.fmboxImageParam = 'image'
 
-- cfg.fmboxImageNone
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
cfg.fmboxImageNone = 'none'
 
-- cfg.fmboxStyleParam
-- The name of the "style" parameter of {{fmbox}}.
cfg.fmboxStyleParam = 'style'
 
-- cfg.fmboxStyle
-- The value sent to the style parameter of {{fmbox}}.
cfg.fmboxStyle = 'background-color: #ecfcf4'
 
-- cfg.fmboxTextstyleParam
-- The name of the "textstyle" parameter of {{fmbox}}.
cfg.fmboxTextstyleParam = 'textstyle'
 
-- cfg.fmboxTextstyle
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg.fmboxTextstyle = 'font-style: italic'
 
----------------------------------------------------------------------------------------------------
-- Tracking category configuration
----------------------------------------------------------------------------------------------------
 
-- cfg.displayStrangeUsageCategory
-- Set to true to enable output of cfg.strangeUsageCategory if the module is used on a /doc subpage
-- or a /testcases subpage.
cfg.displayStrangeUsageCategory = true
 
-- cfg.strangeUsageCategory
-- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg.strangeUsageCategory = 'Wikipedia pages with strange ((documentation)) usage'
 
-- cfg.strangeUsageCategoryMainspaceSort
-- Category sort key prefix to use for cfg.strangeUsageCategory in the main namespace. The prefix
-- is followed by the full page name.
cfg.strangeUsageCategoryMainspaceSort = 'Main:'
 
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------


return p
return cfg

Revision as of 05:32, 3 January 2014

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

----------------------------------------------------------------------------------------------------
--
--                               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.
----------------------------------------------------------------------------------------------------

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

----------------------------------------------------------------------------------------------------
-- Environment configuration
----------------------------------------------------------------------------------------------------

-- cfg.titleArg
-- An argument to specify what page to make links for. For testing purposes.
cfg.titleArg = 'page'

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

-- cfg.protectionTemplate
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg.protectionTemplate = 'pp-template'

-- cfg.protectionTemplateArgs
-- Any arguments to send to the protection template.
cfg.protectionTemplateArgs = {docusage = 'yes'}

----------------------------------------------------------------------------------------------------
-- Sandbox template 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.sandboxSubpage. The following settings configure which
-- template is displayed and what the arguments passed to it are.
----------------------------------------------------------------------------------------------------

-- cfg.sandboxNoticeTemplate
-- The name of the template to display at the top of sandbox pages.
cfg.sandboxNoticeTemplate = 'template sandbox notice'

-- cfg.sandboxNoticeLivepageParam
-- The parameter of the sandbox notice template to send the cfg.livepageArg to.
cfg.sandboxNoticeLivepageParam = 1

-- cfg.livepageArg
-- The name of one of the module arguments. The value of this argument should be the main template
-- page (i.e. the "live" template). This is passed to the parameter cfg.sandboxNoticeLivepageParam of
-- the template cfg.sandboxNoticeTemplate.
cfg.livepageArg = 'livepage'

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

-- cfg.documentationIconWikitext
-- The wikitext for the icon shown at the top of the template.
cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'

-- cfg.headingArg
-- Custom heading used in the start box.
cfg.headingArg = 'heading'

-- cfg.headingStyleArg
-- Custom CSS style for the start box heading.
cfg.headingStyleArg = 'heading-style'

-- cfg.templateNamespaceHeading
-- The heading shown in the template namespace.
cfg.templateNamespaceHeading = 'Template documentation'

-- cfg.moduleNamespaceHeading
-- The heading shown in the module namespace.
cfg.moduleNamespaceHeading = 'Module documentation'

-- cfg.fileNamespaceHeading
-- The heading shown in the file namespace.
cfg.fileNamespaceHeading = 'Summary'

-- cfg.otherNamespacesHeading
-- The heading shown in other namespaces.
cfg.otherNamespacesHeading = 'Documentation'

-- cfg.viewLinkDisplay
-- The text to display for "view" links.
cfg.viewLinkDisplay = 'view'

-- cfg.editLinkDisplay
-- The text to display for "edit" links.
cfg.editLinkDisplay = 'edit'

-- cfg.historyLinkDisplay
-- The text to display for "history" links.
cfg.historyLinkDisplay = 'history'

-- cfg.purgeLinkDisplay
-- The text to display for "purge" links.
cfg.purgeLinkDisplay = 'purge'

-- cfg.createLinkDisplay
-- The text to display for "create" links.
cfg.createLinkDisplay = 'create'

----------------------------------------------------------------------------------------------------
-- Preload configuration
----------------------------------------------------------------------------------------------------

-- cfg.preloadArg
-- Custom preload page for creating documentation.
cfg.preloadArg = 'preload'

----------------------------------------------------------------------------------------------------
-- Documentation content configuration
----------------------------------------------------------------------------------------------------

-- cfg.contentArg
-- Passes documentation content directly from the {{documentation}} invocation.
cfg.contentArg = 'content'

----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------

-- cfg.linkBoxArg
-- Specifies a custom link box (end box) or prevents it from being generated.
cfg.linkBoxArg = 'link box'

-- cfg.linkBoxOff
-- The value to send to cfg.linkBoxArg to turn the link box off.
cfg.linkBoxOff = 'off'

-- cfg.transcludedFromBlurb
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'

-- cfg.createModuleDocBlurb
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- $1 is a link to create the documentation page with the preload cfg.modulePreload and the
-- display cfg.createLinkDisplay.
cfg.createModuleDocBlurb = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------

-- cfg.experimentBlurb
-- This is the text inviting editors to experiment in sandbox and test cases pages. It is only
-- shown in the template and module namespaces. With the default English settings, it might look
-- like this:
--
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
--
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
-- 
-- Parameters:
--
-- $1 is the possessive name for "module" or "template", set by cfg.templatePossessive or
-- cfg.modulePossessive depending on what namespace we are in.
--
-- $2 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
--     cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)
-- 
-- If the sandbox doesn't exist, it is in the format:
--
--     cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay)
-- 
-- The link for cfg.sandboxCreateLinkDisplay link preloads the page with cfg.templateSandboxPreload
-- or cfg.moduleSandboxPreload, depending on the current namespace. The link for cfg.mirrorLinkDisplay
-- loads a default edit summary of cfg.mirrorEditSummary.
--
-- $3 is a link to the test cases page. If the test cases page exists, it is in the following format:
--
--     cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)
--
-- If the test cases page doesn't exist, it is in the format:
-- 
--     cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay)
--
-- If the test cases page doesn't exist, the link for cfg.testcasesCreateLinkDisplay preloads the
-- page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload, depending on the current
-- namespace.
cfg.experimentBlurb = 'Editors can experiment in this $1 $2 and $3 pages.'

-- cfg.templatePossessive
-- Possessive case for "template".
cfg.templatePossessive = "template's"

-- cfg.modulePossessive
-- Possessive case for "module".
cfg.modulePossessive = "module's"

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

-- cfg.sandboxSubpage
-- The name of the template subpage typically used for sandboxes.
cfg.sandboxSubpage = 'sandbox'

-- cfg.templateSandboxPreload
-- Preload file for template sandbox pages.
cfg.templateSandboxPreload = 'Template:Documentation/preload-sandbox'

-- cfg.moduleSandboxPreload
-- Preload file for Lua module sandbox pages.
cfg.moduleSandboxPreload = 'Template:Documentation/preload-module-sandbox'

-- cfg.sandboxLinkDisplay
-- The text to display for "sandbox" links.
cfg.sandboxLinkDisplay = 'sandbox'

-- cfg.sandboxEditLinkDisplay
-- The text to display for sandbox "edit" links.
cfg.sandboxEditLinkDisplay = 'edit'

-- cfg.sandboxCreateLinkDisplay
-- The text to display for sandbox "create" links.
cfg.sandboxCreateLinkDisplay = 'create'

-- cfg.compareLinkDisplay
-- The text to display for "compare" links.
cfg.compareLinkDisplay = 'diff'

-- cfg.mirrorEditSummary
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg.mirrorEditSummary = 'Create sandbox version of $1'

-- cfg.mirrorLinkDisplay
-- The text to display for "mirror" links.
cfg.mirrorLinkDisplay = 'mirror'

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

-- cfg.testcasesSubpage
-- The name of the template subpage typically used for test cases.
cfg.testcasesSubpage = 'testcases'

-- cfg.templateTestcasesPreload
-- Preload file for template test cases pages.
cfg.templateTestcasesPreload = 'Template:Documentation/preload-testcases'

-- cfg.moduleTestcasesPreload
-- Preload file for Lua module test cases pages.
cfg.moduleTestcasesPreload = 'Template:Documentation/preload-module-testcases'

-- cfg.testcasesLinkDisplay
-- The text to display for "testcases" links.
cfg.testcasesLinkDisplay = 'testcases'

-- cfg.testcasesEditLinkDisplay
-- The text to display for test cases "edit" links.
cfg.testcasesEditLinkDisplay = 'edit'

-- cfg.testcasesCreateLinkDisplay
-- The text to display for test cases "create" links.
cfg.testcasesCreateLinkDisplay = 'create'

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

-- cfg.addCategoriesBlurb
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- link to the /doc subpage with a display value of cfg.docLinkDisplay.
cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.'

-- cfg.docLinkDisplay
-- The text to display when linking to the /doc subpage.
cfg.docLinkDisplay = '/doc'

----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------

-- cfg.subpagesLinkDisplay
-- The text to display for the "subpages of this page" link. $1 is cfg.templatePagetype,
-- cfg.modulePagetype or cfg.defaultPagetype, depending on whether the current page is in th
-- e template namespace, the module namespace, or another namespace.
cfg.subpagesLinkDisplay = 'Subpages of this $1'

-- cfg.templatePagetype
-- The pagetype to display for template pages.
cfg.templatePagetype = 'template'

-- cfg.modulePagetype
-- The pagetype to display for Lua module pages.
cfg.modulePagetype = 'module'

-- cfg.defaultPagetype
-- The pagetype to display for pages other than templates or Lua modules.
cfg.defaultPagetype = 'page'

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

-- cfg.docSubpage
-- The name of the subpage typically used for documentation pages.
cfg.docSubpage = 'doc'

-- cfg.fileDocpagePreload
-- Preload file for documentation page in the file namespace.
cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace'

-- cfg.docpagePreload
-- Preload file for template documentation pages in all namespaces.
cfg.docpagePreload = 'Template:Documentation/preload'

-- cfg.modulePreload
-- Preload file for Lua module documentation pages.
cfg.modulePreload = 'Template:Documentation/preload-module-doc'

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

-- cfg.printSubpage
-- The name of the template subpage used for print versions.
cfg.printSubpage = 'Print'

-- cfg.printLinkDisplay
-- The text to display when linking to the /Print subpage.
cfg.printLinkDisplay = '/Print'

-- cfg.printBlurb
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay.
cfg.printBlurb = '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.'

-- cfg.displayPrintCategory
-- Set to true to enable output of cfg.printCategory if a /Print subpage exists.
cfg.displayPrintCategory = true

-- cfg.printCategory
-- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists.
cfg.printCategory = 'Templates with print versions'

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

-- cfg.mainDivId
-- The "id" attribute of the main HTML "div" tag.
cfg.mainDivId = 'template-documentation'

-- cfg.mainDivClasses
-- The CSS classes added to the main HTML "div" tag.
cfg.mainDivClasses = 'template-documentation iezoomfix'

-- cfg.startBoxLinkclasses
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg.startBoxLinkclasses = 'mw-editsection plainlinks'

-- cfg.startBoxLinkId
-- The HTML "id" attribute for the links in the start box.
cfg.startBoxLinkId = 'doc_editlinks'

----------------------------------------------------------------------------------------------------
-- {{fmbox}} template configuration
----------------------------------------------------------------------------------------------------

-- cfg.fmboxIdParam
-- The name of the "id" parameter of {{fmbox}}.
cfg.fmboxIdParam = 'id'

-- cfg.fmboxId
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg.fmboxId = 'documentation-meta-data'

-- cfg.fmboxImageParam
-- The name of the "image" parameter of {{fmbox}}.
cfg.fmboxImageParam = 'image'

-- cfg.fmboxImageNone
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
cfg.fmboxImageNone = 'none'

-- cfg.fmboxStyleParam
-- The name of the "style" parameter of {{fmbox}}.
cfg.fmboxStyleParam = 'style'

-- cfg.fmboxStyle
-- The value sent to the style parameter of {{fmbox}}.
cfg.fmboxStyle = 'background-color: #ecfcf4'

-- cfg.fmboxTextstyleParam
-- The name of the "textstyle" parameter of {{fmbox}}.
cfg.fmboxTextstyleParam = 'textstyle'

-- cfg.fmboxTextstyle
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg.fmboxTextstyle = 'font-style: italic'

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

-- cfg.displayStrangeUsageCategory
-- Set to true to enable output of cfg.strangeUsageCategory if the module is used on a /doc subpage
-- or a /testcases subpage.
cfg.displayStrangeUsageCategory = true

-- cfg.strangeUsageCategory
-- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg.strangeUsageCategory = 'Wikipedia pages with strange ((documentation)) usage'

-- cfg.strangeUsageCategoryMainspaceSort
-- Category sort key prefix to use for cfg.strangeUsageCategory in the main namespace. The prefix
-- is followed by the full page name.
cfg.strangeUsageCategoryMainspaceSort = 'Main:'

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

return cfg