Diff: Module:Documentation

-- This module implements {{documentation}}.

-- This module implements {{documentation}}.

-- Get required modules.

-- Get required modules.

local getArgs = require('Module:Arguments').getArgs

local getArgs = require('Module:Arguments').getArgs

-- Get the config table.

-- Get the config table.

local cfg = mw.loadData('Module:Documentation/config')

local cfg = mw.loadData('Module:Documentation/config')

local p = {}

local p = {}

-- Often-used functions.

-- Often-used functions.

local ugsub = mw.ustring.gsub

local ugsub = mw.ustring.gsub

local format = mw.ustring.format

local format = mw.ustring.format

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Helper functions

-- Helper functions

--

--

-- These are defined as local functions, but are made available in the p

-- These are defined as local functions, but are made available in the p

-- table for testing purposes.

-- table for testing purposes.

----------------------------------------------------------------------------

----------------------------------------------------------------------------

local function message(cfgKey, valArray, expectType)

local function message(cfgKey, valArray, expectType)

	--[[

	--[[

	-- Gets a message from the cfg table and formats it if appropriate.

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

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

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

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

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

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

	-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."

	--]]

	--]]

	local msg = cfg[cfgKey]

	local msg = cfg[cfgKey]

	expectType = expectType or 'string'

	expectType = expectType or 'string'

	if type(msg) ~= expectType then

	if type(msg) ~= expectType then

		error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)

		error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)

	end

	end

	if not valArray then

	if not valArray then

		return msg

		return msg

	end

	end

	local function getMessageVal(match)

	local function getMessageVal(match)

		match = tonumber(match)

		match = tonumber(match)

		return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)

		return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)

	end

	end

	return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)

	return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)

end

end

p.message = message

p.message = message

local function makeWikilink(page, display)

local function makeWikilink(page, display)

	if display then

	if display then

		return format('[[%s|%s]]', page, display)

		return format('[[%s|%s]]', page, display)

	else

	else

		return format('[[%s]]', page)

		return format('[[%s]]', page)

	end

	end

end

end

p.makeWikilink = makeWikilink

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)

local function makeCategoryLink(cat, sort)

	local catns = mw.site.namespaces[14].name

	local catns = mw.site.namespaces[14].name

	return makeWikilink(catns .. ':' .. cat, sort)

	return makeWikilink(catns .. ':' .. cat, sort)

end

end

p.makeCategoryLink = makeCategoryLink

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)

local function makeUrlLink(url, display)

	return format('[%s %s]', url, display)

	return format('[%s %s]', url, display)

end

end

p.makeUrlLink = makeUrlLink

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)

local function makeToolbar(...)

	local ret = {}

	local ret = {}

	local lim = select('#', ...)

	local lim = select('#', ...)

	if lim < 1 then

	if lim < 1 then

		return nil

		return nil

	end

	end

	for i = 1, lim do

	for i = 1, lim do

		ret[#ret + 1] = select(i, ...)

		ret[#ret + 1] = select(i, ...)

	end

	end

	-- 'documentation-toolbar'

	-- 'documentation-toolbar'

	return format(

	return format(

		'<span class="%s">(%s)</span>',

		'<span class="%s">(%s)</span>',

		message('toolbar-class'),

		message('toolbar-class'),

		table.concat(ret, ' | ')

		table.concat(ret, ' | ')

	)

	)

end	

end	

p.makeToolbar = makeToolbar

p.makeToolbar = makeToolbar

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Argument processing

-- Argument processing

----------------------------------------------------------------------------

----------------------------------------------------------------------------

local function makeInvokeFunc(funcName)

local function makeInvokeFunc(funcName)

	return function (frame)

	return function (frame)

		local args = getArgs(frame, {

		local args = getArgs(frame, {

			valueFunc = function (key, value)

			valueFunc = function (key, value)

				if type(value) == 'string' then

				if type(value) == 'string' then

					value = value:match('^%s*(.-)%s*$') -- Remove whitespace.

					value = value:match('^%s*(.-)%s*$') -- Remove whitespace.

					if key == 'heading' or value ~= '' then

					if key == 'heading' or value ~= '' then

						return value

						return value

					else

					else

						return nil

						return nil

					end

					end

				else

				else

					return value

					return value

				end

				end

			end

			end

		})

		})

		return p[funcName](args)

		return p[funcName](args)

	end

	end

end

end

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Entry points

-- Entry points

----------------------------------------------------------------------------

----------------------------------------------------------------------------

function p.nonexistent(frame)

function p.nonexistent(frame)

	if mw.title.getCurrentTitle().subpageText == 'testcases' then

	if mw.title.getCurrentTitle().subpageText == 'testcases' then

		return frame:expandTemplate{title = 'module test cases notice'}

		return frame:expandTemplate{title = 'module test cases notice'}

	else

	else

		return p.main(frame)

		return p.main(frame)

	end

	end

end

end

p.main = makeInvokeFunc('_main')

p.main = makeInvokeFunc('_main')

function p._main(args)

function p._main(args)

	--[[

	--[[

	-- This function defines logic flow for the module.

	-- This function defines logic flow for the module.

	-- @args - table of arguments passed by the user

	-- @args - table of arguments passed by the user

	--]]

	--]]

	local env = p.getEnvironment(args)

	local env = p.getEnvironment(args)

	local root = mw.html.create()

	local root = mw.html.create()

	root

	root

		:wikitext(p._getModuleWikitext(args, env))

		:wikitext(p._getModuleWikitext(args, env))

		:wikitext(p.protectionTemplate(env))

		:wikitext(p.protectionTemplate(env))

		:wikitext(p.sandboxNotice(args, env))

		:wikitext(p.sandboxNotice(args, env))

		:tag('div')

		:tag('div')

			-- 'documentation-container'

			-- 'documentation-container'

			:addClass(message('container'))

			:addClass(message('container'))

			:attr('role', 'complementary')

			:attr('role', 'complementary')

			:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)

			:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)

			:attr('aria-label', args.heading == '' and 'Documentation' or nil)

			:attr('aria-label', args.heading == '' and 'Documentation' or nil)

			:newline()

			:newline()

			:tag('div')

			:tag('div')

				-- 'documentation'

				-- 'documentation'

				:addClass(message('main-div-classes'))

				:addClass(message('main-div-classes'))

				:newline()

				:newline()

				:wikitext(p._startBox(args, env))

				:wikitext(p._startBox(args, env))

				:wikitext(p._content(args, env))

				:wikitext(p._content(args, env))

				:tag('div')

				:tag('div')

					-- 'documentation-clear'

					-- 'documentation-clear'

					:addClass(message('clear'))

					:addClass(message('clear'))

					:done()

					:done()

				:newline()

				:newline()

				:done()

				:done()

			:wikitext(p._endBox(args, env))

			:wikitext(p._endBox(args, env))

			:done()

			:done()

		:wikitext(p.addTrackingCategories(env))

		:wikitext(p.addTrackingCategories(env))

	-- 'Module:Documentation/styles.css'

	-- 'Module:Documentation/styles.css'

	return mw.getCurrentFrame():extensionTag (

	return mw.getCurrentFrame():extensionTag (

		'templatestyles', '', {src=cfg['templatestyles']

		'templatestyles', '', {src=cfg['templatestyles']

	}) .. tostring(root)

	}) .. tostring(root)

end

end

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Environment settings

-- Environment settings

----------------------------------------------------------------------------

----------------------------------------------------------------------------

function p.getEnvironment(args)

function p.getEnvironment(args)

	--[[

	--[[

	-- Returns a table with information about the environment, including title

	-- Returns a table with information about the environment, including title

	-- objects and other namespace- or path-related data.

	-- objects and other namespace- or path-related data.

	-- @args - table of arguments passed by the user

	-- @args - table of arguments passed by the user

	--

	--

	-- Title objects include:

	-- Title objects include:

	-- env.title - the page we are making documentation for (usually the current title)

	-- env.title - the page we are making documentation for (usually the current title)

	-- env.templateTitle - the template (or module, file, etc.)

	-- env.templateTitle - the template (or module, file, etc.)

	-- env.docTitle - the /doc subpage.

	-- env.docTitle - the /doc subpage.

	-- env.sandboxTitle - the /sandbox subpage.

	-- env.sandboxTitle - the /sandbox subpage.

	-- env.testcasesTitle - the /testcases subpage.

	-- env.testcasesTitle - the /testcases subpage.

	--

	--

	-- Data includes:

	-- Data includes:

	-- env.protectionLevels - the protection levels table of the title object.

	-- env.protectionLevels - the protection levels table of the title object.

	-- env.subjectSpace - the number of the title's subject namespace.

	-- env.subjectSpace - the number of the title's subject namespace.

	-- env.docSpace - the number of the namespace the title puts its documentation in.

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

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

	-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value

	-- returned will be nil.

	-- returned will be nil.

	--]]

	--]]

	local env, envFuncs = {}, {}

	local env, envFuncs = {}, {}

	-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value

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

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

	-- more than once. (Nils won't be memoized.)

	setmetatable(env, {

	setmetatable(env, {

		__index = function (t, key)

		__index = function (t, key)

			local envFunc = envFuncs[key]

			local envFunc = envFuncs[key]

			if envFunc then

			if envFunc then

				local success, val = pcall(envFunc)

				local success, val = pcall(envFunc)

				if success then

				if success then

					env[key] = val -- Memoise the value.

					env[key] = val -- Memoise the value.

					return val

					return val

				end

				end

			end

			end

			return nil

			return nil

		end

		end

	})	

	})	

	function envFuncs.title()

	function envFuncs.title()

		-- The title object for the current page, or a test page passed with args.page.

		-- The title object for the current page, or a test page passed with args.page.

		local title

		local title

		local titleArg = args.page

		local titleArg = args.page

		if titleArg then

		if titleArg then

			title = mw.title.new(titleArg)

			title = mw.title.new(titleArg)

		else

		else

			title = mw.title.getCurrentTitle()

			title = mw.title.getCurrentTitle()

		end

		end

		return title

		return title

	end

	end

	function envFuncs.templateTitle()

	function envFuncs.templateTitle()

		--[[

		--[[

		-- The template (or module, etc.) title object.

		-- The template (or module, etc.) title object.

		-- Messages:

		-- Messages:

		-- 'sandbox-subpage' --> 'sandbox'

		-- 'sandbox-subpage' --> 'sandbox'

		-- 'testcases-subpage' --> 'testcases'

		-- 'testcases-subpage' --> 'testcases'

		--]]

		--]]

		local subjectSpace = env.subjectSpace

		local subjectSpace = env.subjectSpace

		local title = env.title

		local title = env.title

		local subpage = title.subpageText

		local subpage = title.subpageText

		if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then

		if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then

			return mw.title.makeTitle(subjectSpace, title.baseText)

			return mw.title.makeTitle(subjectSpace, title.baseText)

		else

		else

			return mw.title.makeTitle(subjectSpace, title.text)

			return mw.title.makeTitle(subjectSpace, title.text)

		end

		end

	end

	end

	function envFuncs.docTitle()

	function envFuncs.docTitle()

		--[[

		--[[

		-- Title object of the /doc subpage.

		-- Title object of the /doc subpage.

		-- Messages:

		-- Messages:

		-- 'doc-subpage' --> 'doc'

		-- 'doc-subpage' --> 'doc'

		--]]

		--]]

		local title = env.title

		local title = env.title

		local docname = args[1] -- User-specified doc page.

		local docname = args[1] -- User-specified doc page.

		local docpage

		local docpage

		if docname then

		if docname then

			docpage = docname

			docpage = docname

		else

		else

			docpage = env.docpageBase .. '/' .. message('doc-subpage')

			docpage = env.docpageBase .. '/' .. message('doc-subpage')

		end

		end

		return mw.title.new(docpage)

		return mw.title.new(docpage)

	end

	end

	function envFuncs.sandboxTitle()

	function envFuncs.sandboxTitle()

		--[[

		--[[

		-- Title object for the /sandbox subpage.

		-- Title object for the /sandbox subpage.

		-- Messages:

		-- Messages:

		-- 'sandbox-subpage' --> 'sandbox'

		-- 'sandbox-subpage' --> 'sandbox'

		--]]

		--]]

		return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))

		return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))

	end

	end

	function envFuncs.testcasesTitle()

	function envFuncs.testcasesTitle()

		--[[

		--[[

		-- Title object for the /testcases subpage.

		-- Title object for the /testcases subpage.

		-- Messages:

		-- Messages:

		-- 'testcases-subpage' --> 'testcases'

		-- 'testcases-subpage' --> 'testcases'

		--]]

		--]]

		return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))

		return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))

	end

	end

	function envFuncs.protectionLevels()

	function envFuncs.protectionLevels()

		-- The protection levels table of the title object.

		-- The protection levels table of the title object.

		return env.title.protectionLevels

		return env.title.protectionLevels

	end

	end

	function envFuncs.subjectSpace()

	function envFuncs.subjectSpace()

		-- The subject namespace number.

		-- The subject namespace number.

		return mw.site.namespaces[env.title.namespace].subject.id

		return mw.site.namespaces[env.title.namespace].subject.id

	end

	end

	function envFuncs.docSpace()

	function envFuncs.docSpace()

		-- The documentation namespace number. For most namespaces this is the

		-- The documentation namespace number. For most namespaces this is the

		-- same as the subject namespace. However, pages in the Article, File,

		-- same as the subject namespace. However, pages in the Article, File,

		-- MediaWiki or Category namespaces must have their /doc, /sandbox and

		-- MediaWiki or Category namespaces must have their /doc, /sandbox and

		-- /testcases pages in talk space.

		-- /testcases pages in talk space.

		local subjectSpace = env.subjectSpace

		local subjectSpace = env.subjectSpace

		if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then

		if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then

			return subjectSpace + 1

			return subjectSpace + 1

		else

		else

			return subjectSpace

			return subjectSpace

		end

		end

	end

	end

	function envFuncs.docpageBase()

	function envFuncs.docpageBase()

		-- The base page of the /doc, /sandbox, and /testcases subpages.

		-- The base page of the /doc, /sandbox, and /testcases subpages.

		-- For some namespaces this is the talk page, rather than the template page.

		-- For some namespaces this is the talk page, rather than the template page.

		local templateTitle = env.templateTitle

		local templateTitle = env.templateTitle

		local docSpace = env.docSpace

		local docSpace = env.docSpace

		local docSpaceText = mw.site.namespaces[docSpace].name

		local docSpaceText = mw.site.namespaces[docSpace].name

		-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.

		-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.

		return docSpaceText .. ':' .. templateTitle.text

		return docSpaceText .. ':' .. templateTitle.text

	end

	end

	function envFuncs.compareUrl()

	function envFuncs.compareUrl()

		-- Diff link between the sandbox and the main template using [[Special:ComparePages]].

		-- Diff link between the sandbox and the main template using [[Special:ComparePages]].

		local templateTitle = env.templateTitle

		local templateTitle = env.templateTitle

		local sandboxTitle = env.sandboxTitle

		local sandboxTitle = env.sandboxTitle

		if templateTitle.exists and sandboxTitle.exists then

		if templateTitle.exists and sandboxTitle.exists then

			local compareUrl = mw.uri.canonicalUrl(

			local compareUrl = mw.uri.canonicalUrl(

				'Special:ComparePages',

				'Special:ComparePages',

				{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}

				{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}

			)

			)

			return tostring(compareUrl)

			return tostring(compareUrl)

		else

		else

			return nil

			return nil

		end

		end

	end		

	end		

	return env

	return env

end	

end	

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Auxiliary templates

-- Auxiliary templates

----------------------------------------------------------------------------

----------------------------------------------------------------------------

p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')

p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')

function p._getModuleWikitext(args, env)

function p._getModuleWikitext(args, env)

	local currentTitle = mw.title.getCurrentTitle()

	local currentTitle = mw.title.getCurrentTitle()

	if currentTitle.contentModel ~= 'Scribunto' then return end

	if currentTitle.contentModel ~= 'Scribunto' then return end

	pcall(require, currentTitle.prefixedText) -- if it fails, we don't care

	pcall(require, currentTitle.prefixedText) -- if it fails, we don't care

	local moduleWikitext =  package.loaded["Module:Module wikitext"]

	local moduleWikitext =  package.loaded["Module:Module wikitext"]

	if moduleWikitext then

	if moduleWikitext then

		return moduleWikitext.main()

		return moduleWikitext.main()

	end

	end

end

end

function p.sandboxNotice(args, env)

function p.sandboxNotice(args, env)

	--[=[

	--[=[

	-- Generates a sandbox notice for display above sandbox pages.

	-- Generates a sandbox notice for display above sandbox pages.

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- 

	-- 

	-- Messages:

	-- Messages:

	-- 'sandbox-notice-image' --> '[[File:Sandbox.svg|50px|alt=|link=]]'

	-- 'sandbox-notice-image' --> '[[File:Sandbox.svg|50px|alt=|link=]]'

	-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'

	-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'

	-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'

	-- '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-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'

	-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'

	-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'

	-- 'sandbox-notice-pagetype-other' --> 'sandbox page'

	-- 'sandbox-notice-pagetype-other' --> 'sandbox page'

	-- 'sandbox-notice-compare-link-display' --> 'diff'

	-- 'sandbox-notice-compare-link-display' --> 'diff'

	-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'

	-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'

	-- 'sandbox-notice-testcases-link-display' --> 'test cases'

	-- 'sandbox-notice-testcases-link-display' --> 'test cases'

	-- 'sandbox-category' --> 'Template sandboxes'

	-- 'sandbox-category' --> 'Template sandboxes'

	-- 'module-sandbox-category' --> 'Module sandboxes'

	-- 'module-sandbox-category' --> 'Module sandboxes'

	-- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace'

	-- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace'

	--]=]

	--]=]

	local title = env.title

	local title = env.title

	local sandboxTitle = env.sandboxTitle

	local sandboxTitle = env.sandboxTitle

	local templateTitle = env.templateTitle

	local templateTitle = env.templateTitle

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	if not (subjectSpace and title and sandboxTitle and templateTitle

	if not (subjectSpace and title and sandboxTitle and templateTitle

		and mw.title.equals(title, sandboxTitle)) then

		and mw.title.equals(title, sandboxTitle)) then

		return nil

		return nil

	end

	end

	-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".

	-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".

	local omargs = {}

	local omargs = {}

	omargs.image = message('sandbox-notice-image')

	omargs.image = message('sandbox-notice-image')

	-- Get the text. We start with the opening blurb, which is something like

	-- Get the text. We start with the opening blurb, which is something like

	-- "This is the template sandbox for [[Template:Foo]] (diff)."

	-- "This is the template sandbox for [[Template:Foo]] (diff)."

	local text = ''

	local text = ''

	local pagetype, sandboxCat

	local pagetype, sandboxCat

	if subjectSpace == 10 then

	if subjectSpace == 10 then

		pagetype = message('sandbox-notice-pagetype-template')

		pagetype = message('sandbox-notice-pagetype-template')

		sandboxCat = message('sandbox-category')

		sandboxCat = message('sandbox-category')

	elseif subjectSpace == 828 then

	elseif subjectSpace == 828 then

		pagetype = message('sandbox-notice-pagetype-module')

		pagetype = message('sandbox-notice-pagetype-module')

		sandboxCat = message('module-sandbox-category')

		sandboxCat = message('module-sandbox-category')

	else

	else

		pagetype = message('sandbox-notice-pagetype-other')

		pagetype = message('sandbox-notice-pagetype-other')

		sandboxCat = message('other-sandbox-category')

		sandboxCat = message('other-sandbox-category')

	end

	end

	local templateLink = makeWikilink(templateTitle.prefixedText)

	local templateLink = makeWikilink(templateTitle.prefixedText)

	local compareUrl = env.compareUrl

	local compareUrl = env.compareUrl

	if compareUrl then

	if compareUrl then

		local compareDisplay = message('sandbox-notice-compare-link-display')

		local compareDisplay = message('sandbox-notice-compare-link-display')

		local compareLink = makeUrlLink(compareUrl, compareDisplay)

		local compareLink = makeUrlLink(compareUrl, compareDisplay)

		text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})

		text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})

	else

	else

		text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})

		text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})

	end

	end

	-- Get the test cases page blurb if the page exists. This is something like

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

	-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."

	local testcasesTitle = env.testcasesTitle

	local testcasesTitle = env.testcasesTitle

	if testcasesTitle and testcasesTitle.exists then

	if testcasesTitle and testcasesTitle.exists then

		if testcasesTitle.contentModel == "Scribunto" then

		if testcasesTitle.contentModel == "Scribunto" then

			local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')

			local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')

			local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')

			local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')

			local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)

			local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)

			local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)

			local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)

			text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})

			text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})

		else

		else

			local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')

			local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')

			local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)

			local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)

			text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})

			text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})

		end

		end

	end

	end

	-- Add the sandbox to the sandbox category.

	-- Add the sandbox to the sandbox category.

	omargs.text = text .. makeCategoryLink(sandboxCat)

	omargs.text = text .. makeCategoryLink(sandboxCat)

	-- 'documentation-clear'

	-- 'documentation-clear'

	return '<div class="' .. message('clear') .. '"></div>'

	return '<div class="' .. message('clear') .. '"></div>'

		.. require('Module:Message box').main('ombox', omargs)

		.. require('Module:Message box').main('ombox', omargs)

end

end

function p.protectionTemplate(env)

function p.protectionTemplate(env)

	-- Generates the padlock icon in the top right.

	-- Generates the padlock icon in the top right.

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- Messages:

	-- Messages:

	-- 'protection-template' --> 'pp-template'

	-- 'protection-template' --> 'pp-template'

	-- 'protection-template-args' --> {docusage = 'yes'}

	-- 'protection-template-args' --> {docusage = 'yes'}

	local protectionLevels = env.protectionLevels

	local protectionLevels = env.protectionLevels

	if not protectionLevels then

	if not protectionLevels then

		return nil

		return nil

	end

	end

	local editProt = protectionLevels.edit and protectionLevels.edit[1]

	local editProt = protectionLevels.edit and protectionLevels.edit[1]

	local moveProt = protectionLevels.move and protectionLevels.move[1]

	local moveProt = protectionLevels.move and protectionLevels.move[1]

	if editProt then

	if editProt then

		-- The page is edit-protected.

		-- The page is edit-protected.

		return require('Module:Protection banner')._main{

		return require('Module:Protection banner')._main{

			message('protection-reason-edit'), small = true

			message('protection-reason-edit'), small = true

		}

		}

	elseif moveProt and moveProt ~= 'autoconfirmed' then

	elseif moveProt and moveProt ~= 'autoconfirmed' then

		-- The page is move-protected but not edit-protected. Exclude move

		-- The page is move-protected but not edit-protected. Exclude move

		-- protection with the level "autoconfirmed", as this is equivalent to

		-- protection with the level "autoconfirmed", as this is equivalent to

		-- no move protection at all.

		-- no move protection at all.

		return require('Module:Protection banner')._main{

		return require('Module:Protection banner')._main{

			action = 'move', small = true

			action = 'move', small = true

		}

		}

	else

	else

		return nil

		return nil

	end

	end

end

end

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Start box

-- Start box

----------------------------------------------------------------------------

----------------------------------------------------------------------------

p.startBox = makeInvokeFunc('_startBox')

p.startBox = makeInvokeFunc('_startBox')

function p._startBox(args, env)

function p._startBox(args, env)

	--[[

	--[[

	-- This function generates the start box.

	-- This function generates the start box.

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

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

	-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox

	-- which generate the box HTML.

	-- which generate the box HTML.

	--]]

	--]]

	env = env or p.getEnvironment(args)

	env = env or p.getEnvironment(args)

	local links

	local links

	local content = args.content

	local content = args.content

	if not content or args[1] then

	if not content or args[1] then

		-- No need to include the links if the documentation is on the template page itself.

		-- No need to include the links if the documentation is on the template page itself.

		local linksData = p.makeStartBoxLinksData(args, env)

		local linksData = p.makeStartBoxLinksData(args, env)

		if linksData then

		if linksData then

			links = p.renderStartBoxLinks(linksData)

			links = p.renderStartBoxLinks(linksData)

		end

		end

	end

	end

	-- Generate the start box html.

	-- Generate the start box html.

	local data = p.makeStartBoxData(args, env, links)

	local data = p.makeStartBoxData(args, env, links)

	if data then

	if data then

		return p.renderStartBox(data)

		return p.renderStartBox(data)

	else

	else

		-- User specified no heading.

		-- User specified no heading.

		return nil

		return nil

	end

	end

end

end

function p.makeStartBoxLinksData(args, env)

function p.makeStartBoxLinksData(args, env)

	--[[

	--[[

	-- Does initial processing of data to make the [view] [edit] [history] [purge] links.

	-- Does initial processing of data to make the [view] [edit] [history] [purge] links.

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- 

	-- 

	-- Messages:

	-- Messages:

	-- 'view-link-display' --> 'view'

	-- 'view-link-display' --> 'view'

	-- 'edit-link-display' --> 'edit'

	-- 'edit-link-display' --> 'edit'

	-- 'history-link-display' --> 'history'

	-- 'history-link-display' --> 'history'

	-- 'purge-link-display' --> 'purge'

	-- 'purge-link-display' --> 'purge'

	-- 'module-preload' --> 'Template:Documentation/preload-module-doc'

	-- 'module-preload' --> 'Template:Documentation/preload-module-doc'

	-- 'docpage-preload' --> 'Template:Documentation/preload'

	-- 'docpage-preload' --> 'Template:Documentation/preload'

	-- 'create-link-display' --> 'create'

	-- 'create-link-display' --> 'create'

	--]]

	--]]

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	local title = env.title

	local title = env.title

	local docTitle = env.docTitle

	local docTitle = env.docTitle

	if not title or not docTitle then

	if not title or not docTitle then

		return nil

		return nil

	end

	end

	if docTitle.isRedirect then 

	if docTitle.isRedirect then 

		docTitle = docTitle.redirectTarget

		docTitle = docTitle.redirectTarget

	end

	end

	-- Create link if /doc doesn't exist.

	-- Create link if /doc doesn't exist.

	local preload = args.preload

	local preload = args.preload

	if not preload then

	if not preload then

		if subjectSpace == 828 then -- Module namespace

		if subjectSpace == 828 then -- Module namespace

			preload = message('module-preload')

			preload = message('module-preload')

		else

		else

			preload = message('docpage-preload')

			preload = message('docpage-preload')

		end

		end

	end

	end

	return {

	return {

		title = title,

		title = title,

		docTitle = docTitle,

		docTitle = docTitle,

		-- View, display, edit, and purge links if /doc exists.

		-- View, display, edit, and purge links if /doc exists.

		viewLinkDisplay = message('view-link-display'),

		viewLinkDisplay = message('view-link-display'),

		editLinkDisplay = message('edit-link-display'),

		editLinkDisplay = message('edit-link-display'),

		historyLinkDisplay = message('history-link-display'),

		historyLinkDisplay = message('history-link-display'),

		purgeLinkDisplay = message('purge-link-display'),

		purgeLinkDisplay = message('purge-link-display'),

		preload = preload,

		preload = preload,

		createLinkDisplay = message('create-link-display')

		createLinkDisplay = message('create-link-display')

	}

	}

end

end

function p.renderStartBoxLinks(data)

function p.renderStartBoxLinks(data)

	--[[

	--[[

	-- Generates the [view][edit][history][purge] or [create][purge] links from the data table.

	-- Generates the [view][edit][history][purge] or [create][purge] links from the data table.

	-- @data - a table of data generated by p.makeStartBoxLinksData

	-- @data - a table of data generated by p.makeStartBoxLinksData

	--]]

	--]]

	local docTitle = data.docTitle

	local docTitle = data.docTitle

	-- yes, we do intend to purge the template page on which the documentation appears

	-- yes, we do intend to purge the template page on which the documentation appears

	local purgeLink = makeWikilink("Special:Purge/" .. data.title.prefixedText, data.purgeLinkDisplay)

	local purgeLink = makeWikilink("Special:Purge/" .. data.title.prefixedText, data.purgeLinkDisplay)

	if docTitle.exists then

	if docTitle.exists then

		local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)

		local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)

		local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay)

		local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay)

		local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay)

		local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay)

		return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]"

		return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]"

	else

	else

		local createLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)

		local createLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)

		return  "[" .. createLink .. "] [" .. purgeLink .. "]"

		return  "[" .. createLink .. "] [" .. purgeLink .. "]"

	end

	end

	return ret

	return ret

end

end

function p.makeStartBoxData(args, env, links)

function p.makeStartBoxData(args, env, links)

	--[=[

	--[=[

	-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.

	-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

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

	-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.

	--

	--

	-- Messages:

	-- Messages:

	-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'

	-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'

	-- 'template-namespace-heading' --> 'Template documentation'

	-- 'template-namespace-heading' --> 'Template documentation'

	-- 'module-namespace-heading' --> 'Module documentation'

	-- 'module-namespace-heading' --> 'Module documentation'

	-- 'file-namespace-heading' --> 'Summary'

	-- 'file-namespace-heading' --> 'Summary'

	-- 'other-namespaces-heading' --> 'Documentation'

	-- 'other-namespaces-heading' --> 'Documentation'

	-- 'testcases-create-link-display' --> 'create'

	-- 'testcases-create-link-display' --> 'create'

	--]=]

	--]=]

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	if not subjectSpace then

	if not subjectSpace then

		-- Default to an "other namespaces" namespace, so that we get at least some output

		-- Default to an "other namespaces" namespace, so that we get at least some output

		-- if an error occurs.

		-- if an error occurs.

		subjectSpace = 2

		subjectSpace = 2

	end

	end

	local data = {}

	local data = {}

	-- Heading

	-- Heading

	local heading = args.heading -- Blank values are not removed.

	local heading = args.heading -- Blank values are not removed.

	if heading == '' then

	if heading == '' then

		-- Don't display the start box if the heading arg is defined but blank.

		-- Don't display the start box if the heading arg is defined but blank.

		return nil

		return nil

	end

	end

	if heading then

	if heading then

		data.heading = heading

		data.heading = heading

	elseif subjectSpace == 10 then -- Template namespace

	elseif subjectSpace == 10 then -- Template namespace

		data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')

		data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')

	elseif subjectSpace == 828 then -- Module namespace

	elseif subjectSpace == 828 then -- Module namespace

		data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')

		data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')

	elseif subjectSpace == 6 then -- File namespace

	elseif subjectSpace == 6 then -- File namespace

		data.heading = message('file-namespace-heading')

		data.heading = message('file-namespace-heading')

	else

	else

		data.heading = message('other-namespaces-heading')

		data.heading = message('other-namespaces-heading')

	end

	end

	-- Heading CSS

	-- Heading CSS

	local headingStyle = args['heading-style']

	local headingStyle = args['heading-style']

	if headingStyle then

	if headingStyle then

		data.headingStyleText = headingStyle

		data.headingStyleText = headingStyle

	else

	else

		-- 'documentation-heading'

		-- 'documentation-heading'

		data.headingClass = message('main-div-heading-class')

		data.headingClass = message('main-div-heading-class')

	end

	end

	-- Data for the [view][edit][history][purge] or [create] links.

	-- Data for the [view][edit][history][purge] or [create] links.

	if links then

	if links then

		-- 'mw-editsection-like plainlinks'

		-- 'mw-editsection-like plainlinks'

		data.linksClass = message('start-box-link-classes')

		data.linksClass = message('start-box-link-classes')

		data.links = links

		data.links = links

	end

	end

	return data

	return data

end

end

function p.renderStartBox(data)

function p.renderStartBox(data)

	-- Renders the start box html.

	-- Renders the start box html.

	-- @data - a table of data generated by p.makeStartBoxData.

	-- @data - a table of data generated by p.makeStartBoxData.

	local sbox = mw.html.create('div')

	local sbox = mw.html.create('div')

	sbox

	sbox

		-- 'documentation-startbox'

		-- 'documentation-startbox'

		:addClass(message('start-box-class'))

		:addClass(message('start-box-class'))

		:newline()

		:newline()

		:tag('span')

		:tag('span')

			:addClass(data.headingClass)

			:addClass(data.headingClass)

			:attr('id', 'documentation-heading')

			:attr('id', 'documentation-heading')

			:cssText(data.headingStyleText)

			:cssText(data.headingStyleText)

			:wikitext(data.heading)

			:wikitext(data.heading)

	local links = data.links

	local links = data.links

	if links then

	if links then

		sbox:tag('span')

		sbox:tag('span')

			:addClass(data.linksClass)

			:addClass(data.linksClass)

			:attr('id', data.linksId)

			:attr('id', data.linksId)

			:wikitext(links)

			:wikitext(links)

	end

	end

	return tostring(sbox)

	return tostring(sbox)

end

end

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Documentation content

-- Documentation content

----------------------------------------------------------------------------

----------------------------------------------------------------------------

p.content = makeInvokeFunc('_content')

p.content = makeInvokeFunc('_content')

function p._content(args, env)

function p._content(args, env)

	-- Displays the documentation contents

	-- Displays the documentation contents

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	env = env or p.getEnvironment(args)

	env = env or p.getEnvironment(args)

	local docTitle = env.docTitle

	local docTitle = env.docTitle

	local content = args.content

	local content = args.content

	if not content and docTitle and docTitle.exists then

	if not content and docTitle and docTitle.exists then

		content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}

		content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}

	end

	end

	-- The line breaks below are necessary so that "=== Headings ===" at the start and end

	-- The line breaks below are necessary so that "=== Headings ===" at the start and end

	-- of docs are interpreted correctly.

	-- of docs are interpreted correctly.

	return '\n' .. (content or '') .. '\n' 

	return '\n' .. (content or '') .. '\n' 

end

end

p.contentTitle = makeInvokeFunc('_contentTitle')

p.contentTitle = makeInvokeFunc('_contentTitle')

function p._contentTitle(args, env)

function p._contentTitle(args, env)

	env = env or p.getEnvironment(args)

	env = env or p.getEnvironment(args)

	local docTitle = env.docTitle

	local docTitle = env.docTitle

	if not args.content and docTitle and docTitle.exists then

	if not args.content and docTitle and docTitle.exists then

		return docTitle.prefixedText

		return docTitle.prefixedText

	else

	else

		return ''

		return ''

	end

	end

end

end

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- End box

-- End box

----------------------------------------------------------------------------

----------------------------------------------------------------------------

p.endBox = makeInvokeFunc('_endBox')

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)

function p._endBox(args, env)

	--[=[

	--[=[

	-- This function generates the end box (also known as the link box).

	-- This function generates the end box (also known as the link box).

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- 

	-- 

	--]=]

	--]=]

	-- Get environment data.

	-- Get environment data.

	env = env or p.getEnvironment(args)

	env = env or p.getEnvironment(args)

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	local docTitle = env.docTitle

	local docTitle = env.docTitle

	if not subjectSpace or not docTitle then

	if not subjectSpace or not docTitle then

		return nil

		return nil

	end

	end

	-- Check whether we should output the end box at all. Add the 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

	-- box by default if the documentation exists or if we are in the

	-- user, module or template namespaces.

	-- user, module or template namespaces.

	local linkBox = args['link box']

	local linkBox = args['link box']

	if linkBox == 'off'

	if linkBox == 'off'

		or not (

		or not (

			docTitle.exists

			docTitle.exists

			or subjectSpace == 2

			or subjectSpace == 2

			or subjectSpace == 828

			or subjectSpace == 828

			or subjectSpace == 10

			or subjectSpace == 10

		)

		)

	then

	then

		return nil

		return nil

	end

	end

	-- Assemble the link box.

	-- Assemble the link box.

	local text = ''

	local text = ''

	if linkBox then

	if linkBox then

		text = text .. linkBox

		text = text .. linkBox

	else

	else

		text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." 

		text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." 

		if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then

		if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then

			-- We are in the user, template or module namespaces.

			-- We are in the user, template or module namespaces.

			-- Add sandbox and testcases links.

			-- Add sandbox and testcases links.

			-- "Editors can experiment in this template's sandbox and testcases pages."

			-- "Editors can experiment in this template's sandbox and testcases pages."

			text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'

			text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'

			if not args.content and not args[1] then

			if not args.content and not args[1] then

				-- "Please add categories to the /doc subpage."

				-- "Please add categories to the /doc subpage."

				-- Don't show this message with inline docs or with an explicitly specified doc page,

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

				-- as then it is unclear where to add the categories.

				text = text .. (p.makeCategoriesBlurb(args, env) or '')

				text = text .. (p.makeCategoriesBlurb(args, env) or '')

			end

			end

			text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"

			text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"

		end

		end

	end

	end

	local box = mw.html.create('div')

	local box = mw.html.create('div')

	-- 'documentation-metadata'

	-- 'documentation-metadata'

	box:attr('role', 'note')

	box:attr('role', 'note')

		:addClass(message('end-box-class'))

		:addClass(message('end-box-class'))

		-- 'plainlinks'

		-- 'plainlinks'

		:addClass(message('end-box-plainlinks'))

		:addClass(message('end-box-plainlinks'))

		:wikitext(text)

		:wikitext(text)

		:done()

		:done()

	return '\n' .. tostring(box)

	return '\n' .. tostring(box)

end

end

function p.makeDocPageBlurb(args, env)

function p.makeDocPageBlurb(args, env)

	--[=[

	--[=[

	-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".

	-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- 

	-- 

	-- Messages:

	-- Messages:

	-- 'edit-link-display' --> 'edit'

	-- 'edit-link-display' --> 'edit'

	-- 'history-link-display' --> 'history'

	-- 'history-link-display' --> 'history'

	-- 'transcluded-from-blurb' --> 

	-- 'transcluded-from-blurb' --> 

	-- 'The above [[Wikipedia:Template documentation|documentation]] 

	-- 'The above [[Wikipedia:Template documentation|documentation]] 

	-- is [[Help:Transclusion|transcluded]] from $1.'

	-- is [[Help:Transclusion|transcluded]] from $1.'

	-- 'module-preload' --> 'Template:Documentation/preload-module-doc'

	-- 'module-preload' --> 'Template:Documentation/preload-module-doc'

	-- 'create-link-display' --> 'create'

	-- 'create-link-display' --> 'create'

	-- 'create-module-doc-blurb' -->

	-- 'create-module-doc-blurb' -->

	-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

	-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

	--]=]

	--]=]

	local docTitle = env.docTitle

	local docTitle = env.docTitle

	if not docTitle then

	if not docTitle then

		return nil

		return nil

	end

	end

	if docTitle.exists then

	if docTitle.exists then

		-- /doc exists; link to it.

		-- /doc exists; link to it.

		local docLink = makeWikilink(docTitle.prefixedText)

		local docLink = makeWikilink(docTitle.prefixedText)

		local editDisplay = message('edit-link-display')

		local editDisplay = message('edit-link-display')

		local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay)

		local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay)

		local historyDisplay = message('history-link-display')

		local historyDisplay = message('history-link-display')

		local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay)

		local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay)

		return message('transcluded-from-blurb', {docLink})

		return message('transcluded-from-blurb', {docLink})

			.. ' '

			.. ' '

			.. makeToolbar(editLink, historyLink)

			.. makeToolbar(editLink, historyLink)

			.. '<br />'

			.. '<br />'

	elseif env.subjectSpace == 828 then

	elseif env.subjectSpace == 828 then

		-- /doc does not exist; ask to create it.

		-- /doc does not exist; ask to create it.

		local createUrl = docTitle:canonicalUrl{action = 'edit', preload = message('module-preload')}

		local createUrl = docTitle:canonicalUrl{action = 'edit', preload = message('module-preload')}

		local createDisplay = message('create-link-display')

		local createDisplay = message('create-link-display')

		local createLink = makeUrlLink(createUrl, createDisplay)

		local createLink = makeUrlLink(createUrl, createDisplay)

		return message('create-module-doc-blurb', {createLink})

		return message('create-module-doc-blurb', {createLink})

			.. '<br />'

			.. '<br />'

	end

	end

end

end

function p.makeExperimentBlurb(args, env)

function p.makeExperimentBlurb(args, env)

	--[[

	--[[

	-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."

	-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- 

	-- 

	-- Messages:

	-- Messages:

	-- 'sandbox-link-display' --> 'sandbox'

	-- 'sandbox-link-display' --> 'sandbox'

	-- 'sandbox-edit-link-display' --> 'edit'

	-- 'sandbox-edit-link-display' --> 'edit'

	-- 'compare-link-display' --> 'diff'

	-- 'compare-link-display' --> 'diff'

	-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'

	-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'

	-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'

	-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'

	-- 'sandbox-create-link-display' --> 'create'

	-- 'sandbox-create-link-display' --> 'create'

	-- 'mirror-edit-summary' --> 'Create sandbox version of $1'

	-- 'mirror-edit-summary' --> 'Create sandbox version of $1'

	-- 'mirror-link-display' --> 'mirror'

	-- 'mirror-link-display' --> 'mirror'

	-- 'mirror-link-preload' --> 'Template:Documentation/mirror'

	-- 'mirror-link-preload' --> 'Template:Documentation/mirror'

	-- 'sandbox-link-display' --> 'sandbox'

	-- 'sandbox-link-display' --> 'sandbox'

	-- 'testcases-link-display' --> 'testcases'

	-- 'testcases-link-display' --> 'testcases'

	-- 'testcases-edit-link-display'--> 'edit'

	-- 'testcases-edit-link-display'--> 'edit'

	-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'

	-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'

	-- 'testcases-create-link-display' --> 'create'

	-- 'testcases-create-link-display' --> 'create'

	-- 'testcases-link-display' --> 'testcases'

	-- 'testcases-link-display' --> 'testcases'

	-- 'testcases-edit-link-display' --> 'edit'

	-- 'testcases-edit-link-display' --> 'edit'

	-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'

	-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'

	-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'

	-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'

	-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'

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

	-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'

	--]]

	--]]

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	local templateTitle = env.templateTitle

	local templateTitle = env.templateTitle

	local sandboxTitle = env.sandboxTitle

	local sandboxTitle = env.sandboxTitle

	local testcasesTitle = env.testcasesTitle

	local testcasesTitle = env.testcasesTitle

	local templatePage = templateTitle.prefixedText

	local templatePage = templateTitle.prefixedText

	if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then

	if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then

		return nil

		return nil

	end

	end

	-- Make links.

	-- Make links.

	local sandboxLinks, testcasesLinks

	local sandboxLinks, testcasesLinks

	if sandboxTitle.exists then

	if sandboxTitle.exists then

		local sandboxPage = sandboxTitle.prefixedText

		local sandboxPage = sandboxTitle.prefixedText

		local sandboxDisplay = message('sandbox-link-display')

		local sandboxDisplay = message('sandbox-link-display')

		local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)

		local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)

		local sandboxEditDisplay = message('sandbox-edit-link-display')

		local sandboxEditDisplay = message('sandbox-edit-link-display')

		local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, sandboxEditDisplay)

		local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, sandboxEditDisplay)

		local compareUrl = env.compareUrl

		local compareUrl = env.compareUrl

		local compareLink

		local compareLink

		if compareUrl then

		if compareUrl then

			local compareDisplay = message('compare-link-display')

			local compareDisplay = message('compare-link-display')

			compareLink = makeUrlLink(compareUrl, compareDisplay)

			compareLink = makeUrlLink(compareUrl, compareDisplay)

		end

		end

		sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)

		sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)

	else

	else

		local sandboxPreload

		local sandboxPreload

		if subjectSpace == 828 then

		if subjectSpace == 828 then

			sandboxPreload = message('module-sandbox-preload')

			sandboxPreload = message('module-sandbox-preload')

		else

		else

			sandboxPreload = message('template-sandbox-preload')

			sandboxPreload = message('template-sandbox-preload')

		end

		end

		local sandboxCreateUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = sandboxPreload}

		local sandboxCreateUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = sandboxPreload}

		local sandboxCreateDisplay = message('sandbox-create-link-display')

		local sandboxCreateDisplay = message('sandbox-create-link-display')

		local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)

		local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)

		local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})

		local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})

		local mirrorPreload = message('mirror-link-preload')

		local mirrorPreload = message('mirror-link-preload')

		local mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}

		local mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}

		if subjectSpace == 828 then

		if subjectSpace == 828 then

			mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}

			mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}

		end

		end

		local mirrorDisplay = message('mirror-link-display')

		local mirrorDisplay = message('mirror-link-display')

		local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)

		local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)

		sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)

		sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)

	end

	end

	if testcasesTitle.exists then

	if testcasesTitle.exists then

		local testcasesPage = testcasesTitle.prefixedText

		local testcasesPage = testcasesTitle.prefixedText

		local testcasesDisplay = message('testcases-link-display')

		local testcasesDisplay = message('testcases-link-display')

		local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)

		local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)

		local testcasesEditUrl = testcasesTitle:canonicalUrl{action = 'edit'}

		local testcasesEditUrl = testcasesTitle:canonicalUrl{action = 'edit'}

		local testcasesEditDisplay = message('testcases-edit-link-display')

		local testcasesEditDisplay = message('testcases-edit-link-display')

		local testcasesEditLink = makeWikilink("Special:EditPage/" .. testcasesPage, testcasesEditDisplay)

		local testcasesEditLink = makeWikilink("Special:EditPage/" .. testcasesPage, testcasesEditDisplay)

		-- for Modules, add testcases run link if exists

		-- for Modules, add testcases run link if exists

		if testcasesTitle.contentModel == "Scribunto"  and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then

		if testcasesTitle.contentModel == "Scribunto"  and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then

			local testcasesRunLinkDisplay = message('testcases-run-link-display')

			local testcasesRunLinkDisplay = message('testcases-run-link-display')

			local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)

			local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)

			testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)

			testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)

		else

		else

			testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)

			testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)

		end

		end

	else

	else

		local testcasesPreload

		local testcasesPreload

		if subjectSpace == 828 then

		if subjectSpace == 828 then

			testcasesPreload = message('module-testcases-preload')

			testcasesPreload = message('module-testcases-preload')

		else

		else

			testcasesPreload = message('template-testcases-preload')

			testcasesPreload = message('template-testcases-preload')

		end

		end

		local testcasesCreateUrl = testcasesTitle:canonicalUrl{action = 'edit', preload = testcasesPreload}

		local testcasesCreateUrl = testcasesTitle:canonicalUrl{action = 'edit', preload = testcasesPreload}

		local testcasesCreateDisplay = message('testcases-create-link-display')

		local testcasesCreateDisplay = message('testcases-create-link-display')

		local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)

		local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)

		testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)

		testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)

	end

	end

	local messageName

	local messageName

	if subjectSpace == 828 then

	if subjectSpace == 828 then

		messageName = 'experiment-blurb-module'

		messageName = 'experiment-blurb-module'

	else

	else

		messageName = 'experiment-blurb-template'

		messageName = 'experiment-blurb-template'

	end

	end

	return message(messageName, {sandboxLinks, testcasesLinks})

	return message(messageName, {sandboxLinks, testcasesLinks})

end

end

function p.makeCategoriesBlurb(args, env)

function p.makeCategoriesBlurb(args, env)

	--[[

	--[[

	-- Generates the text "Please add categories to the /doc subpage."

	-- Generates the text "Please add categories to the /doc subpage."

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- Messages:

	-- Messages:

	-- 'doc-link-display' --> '/doc'

	-- 'doc-link-display' --> '/doc'

	-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'

	-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'

	--]]

	--]]

	local docTitle = env.docTitle

	local docTitle = env.docTitle

	if not docTitle then

	if not docTitle then

		return nil

		return nil

	end

	end

	local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))

	local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))

	return message('add-categories-blurb', {docPathLink})

	return message('add-categories-blurb', {docPathLink})

end

end

function p.makeSubpagesBlurb(args, env)

function p.makeSubpagesBlurb(args, env)

	--[[

	--[[

	-- Generates the "Subpages of this template" link.

	-- Generates the "Subpages of this template" link.

	-- @args - a table of arguments passed by the user

	-- @args - a table of arguments passed by the user

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- Messages:

	-- Messages:

	-- 'template-pagetype' --> 'template'

	-- 'template-pagetype' --> 'template'

	-- 'module-pagetype' --> 'module'

	-- 'module-pagetype' --> 'module'

	-- 'default-pagetype' --> 'page'

	-- 'default-pagetype' --> 'page'

	-- 'subpages-link-display' --> 'Subpages of this $1'

	-- 'subpages-link-display' --> 'Subpages of this $1'

	--]]

	--]]

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	local templateTitle = env.templateTitle

	local templateTitle = env.templateTitle

	if not subjectSpace or not templateTitle then

	if not subjectSpace or not templateTitle then

		return nil

		return nil

	end

	end

	local pagetype

	local pagetype

	if subjectSpace == 10 then

	if subjectSpace == 10 then

		pagetype = message('template-pagetype')

		pagetype = message('template-pagetype')

	elseif subjectSpace == 828 then

	elseif subjectSpace == 828 then

		pagetype = message('module-pagetype')

		pagetype = message('module-pagetype')

	else

	else

		pagetype = message('default-pagetype')

		pagetype = message('default-pagetype')

	end

	end

	local subpagesLink = makeWikilink(

	local subpagesLink = makeWikilink(

		'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',

		'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',

		message('subpages-link-display', {pagetype})

		message('subpages-link-display', {pagetype})

	)

	)

	return message('subpages-blurb', {subpagesLink})

	return message('subpages-blurb', {subpagesLink})

end

end

----------------------------------------------------------------------------

----------------------------------------------------------------------------

-- Tracking categories

-- Tracking categories

----------------------------------------------------------------------------

----------------------------------------------------------------------------

function p.addTrackingCategories(env)

function p.addTrackingCategories(env)

	--[[

	--[[

	-- Check if {{documentation}} is transcluded on a /doc or /testcases page.

	-- Check if {{documentation}} is transcluded on a /doc or /testcases page.

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- @env - environment table containing title objects, etc., generated with p.getEnvironment

	-- Messages:

	-- Messages:

	-- 'display-strange-usage-category' --> true

	-- 'display-strange-usage-category' --> true

	-- 'doc-subpage' --> 'doc'

	-- 'doc-subpage' --> 'doc'

	-- 'testcases-subpage' --> 'testcases'

	-- 'testcases-subpage' --> 'testcases'

	-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'

	-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'

	-- 

	-- 

	-- /testcases pages in the module namespace are not categorised, as they may have

	-- /testcases pages in the module namespace are not categorised, as they may have

	-- {{documentation}} transcluded automatically.

	-- {{documentation}} transcluded automatically.

	--]]

	--]]

	local title = env.title

	local title = env.title

	local subjectSpace = env.subjectSpace

	local subjectSpace = env.subjectSpace

	if not title or not subjectSpace then

	if not title or not subjectSpace then

		return nil

		return nil

	end

	end

	local subpage = title.subpageText

	local subpage = title.subpageText

	if message('display-strange-usage-category', nil, 'boolean')

	if message('display-strange-usage-category', nil, 'boolean')

		and (

		and (

			subpage == message('doc-subpage')

			subpage == message('doc-subpage')

			or subjectSpace ~= 828 and subpage == message('testcases-subpage')

			or subjectSpace ~= 828 and subpage == message('testcases-subpage')

		)

		)

	then

	then

		return makeCategoryLink(message('strange-usage-category'))

		return makeCategoryLink(message('strange-usage-category'))

	end

	end

	return ''

	return ''

end

end

return p

return p