Module:Documentation - Revision history

imported>Paine Ellsworth: per edit request on talk page - make the doc environment behave correctly, giving the actual template name on the doc page rather than the name of the "doc" subpage

2025-03-12T03:38:41Z

per edit request on talk page - make the doc environment behave correctly, giving the actual template name on the doc page rather than the name of the "doc" subpage

← Older revision		Revision as of 03:38, 12 March 2025
Line 237:		Line 237:
	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') or (subpage == message('doc-subpage') and mw.title.getCurrentTitle().namespace == env.docSpace) then
	return mw.title.makeTitle(subjectSpace, title.baseText)		return mw.title.makeTitle(subjectSpace, title.baseText)
	else		else

Sushoff: Created page with "-- This module implements {{documentation}}. -- Get required modules. local getArgs = require('Module:Arguments').getArgs -- Get the config table. local cfg = mw.loadData('Module:Documentation/config') local p = {} -- Often-used functions. local ugsub = mw.ustring.gsub local format = mw.ustring.format ---------------------------------------------------------------------------- -- Helper functions -- -- These are defined as local functions, but are made available in..."

2025-02-01T12:44:13Z

Created page with "-- This module implements {{documentation}}. -- Get required modules. local getArgs = require('Module:Arguments').getArgs -- Get the config table. local cfg = mw.loadData('Module:Documentation/config') local p = {} -- Often-used functions. local ugsub = mw.ustring.gsub local format = mw.ustring.format ---------------------------------------------------------------------------- -- Helper functions -- -- These are defined as local functions, but are made available in..."

← Older revision	Revision as of 12:44, 1 February 2025
(No difference)

imported>WOSlinker: add EXPECTUNUSEDTEMPLATE to sandboxNotice

2024-09-03T07:30:09Z

add __EXPECTUNUSEDTEMPLATE__ to sandboxNotice

← Older revision		Revision as of 07:30, 3 September 2024
Line 379:		Line 379:
	-- 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 = '__EXPECTUNUSEDTEMPLATE__'
	local pagetype, sandboxCat		local pagetype, sandboxCat
	if subjectSpace == 10 then		if subjectSpace == 10 then

imported>DannyS712: remove unneeded return variables (if this breaks anything feel free to revert without discussing with me first)

2024-01-07T08:09:04Z

remove unneeded return variables (if this breaks anything feel free to revert without discussing with me first)

← Older revision		Revision as of 08:09, 7 January 2024
Line 766:		Line 766:
	return nil		return nil
	end		end
	~~local ret~~
	if docTitle.exists then		if docTitle.exists then
	-- /doc exists; link to it.		-- /doc exists; link to it.
Line 774:		Line 773:
	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)
	~~ret =~~ message('transcluded-from-blurb', {docLink})		return message('transcluded-from-blurb', {docLink})
	.. ' '		.. ' '
	.. makeToolbar(editLink, historyLink)		.. makeToolbar(editLink, historyLink)
Line 783:		Line 782:
	local createDisplay = message('create-link-display')		local createDisplay = message('create-link-display')
	local createLink = makeUrlLink(createUrl, createDisplay)		local createLink = makeUrlLink(createUrl, createDisplay)
	~~ret =~~ message('create-module-doc-blurb', {createLink})		return message('create-module-doc-blurb', {createLink})
	.. '<br />'		.. '<br />'
	end		end
	~~return ret~~
	end		end

Line 969:		Line 967:
	end		end
	local subpage = title.subpageText		local subpage = title.subpageText
	~~local ret = ''~~
	if message('display-strange-usage-category', nil, 'boolean')		if message('display-strange-usage-category', nil, 'boolean')
	and (		and (
Line 976:		Line 973:
	)		)
	then		then
	~~ret = ret ..~~ makeCategoryLink(message('strange-usage-category'))		return makeCategoryLink(message('strange-usage-category'))
	end		end
	return ~~ret~~		return ''
	end		end

	return p		return p

imported>Pppery: Split Category:Template sandboxes per CfD

2023-10-28T01:26:52Z

Split Category:Template sandboxes per CfD

← Older revision		Revision as of 01:26, 28 October 2023
Line 363:		Line 363:
	-- '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'
			-- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace'
	--]=]		--]=]
	local title = env.title		local title = env.title
Line 378:		Line 380:
	-- "This is the template sandbox for [[Template:Foo]] (diff)."		-- "This is the template sandbox for [[Template:Foo]] (diff)."
	local text = ''		local text = ''
	local pagetype		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')
	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')
	else		else
	pagetype = message('sandbox-notice-pagetype-other')		pagetype = message('sandbox-notice-pagetype-other')
			sandboxCat = message('other-sandbox-category')
	end		end
	local templateLink = makeWikilink(templateTitle.prefixedText)		local templateLink = makeWikilink(templateTitle.prefixedText)
Line 411:		Line 416:
	end		end
	end		end

	-- Add the sandbox to the sandbox category.		-- Add the sandbox to the sandbox category.
	omargs.text = text .. makeCategoryLink(~~message('sandbox-category')~~)		omargs.text = text .. makeCategoryLink(sandboxCat)

	-- 'documentation-clear'		-- 'documentation-clear'

imported>Izno: add a comment to make it obvious

2023-07-31T17:22:10Z

add a comment to make it obvious

← Older revision		Revision as of 17:22, 31 July 2023
Line 538:		Line 538:
	--]]		--]]
	local docTitle = data.docTitle		local docTitle = data.docTitle
			-- 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)

imported>Izno: some cleaning, restore purge

2023-07-31T17:21:00Z

some cleaning, restore purge

← Older revision		Revision as of 17:21, 31 July 2023
Line 11:		Line 11:
	-- Often-used functions.		-- Often-used functions.
	local ugsub = mw.ustring.gsub		local ugsub = mw.ustring.gsub
			local format = mw.ustring.format

	----------------------------------------------------------------------------		----------------------------------------------------------------------------
Line 50:		Line 51:
	local function makeWikilink(page, display)		local function makeWikilink(page, display)
	if display then		if display then
	return ~~mw.ustring.~~format('[[%s\|%s]]', page, display)		return format('[[%s\|%s]]', page, display)
	else		else
	return ~~mw.ustring.~~format('[[%s]]', page)		return format('[[%s]]', page)
	end		end
	end		end
Line 66:		Line 67:

	local function makeUrlLink(url, display)		local function makeUrlLink(url, display)
	return ~~mw.ustring.~~format('[%s %s]', url, display)		return format('[%s %s]', url, display)
	end		end

Line 81:		Line 82:
	end		end
	-- 'documentation-toolbar'		-- 'documentation-toolbar'
	return '<span class="' .. message('toolbar-class') ~~.. '">('~~		return format(
	.. table.concat(ret, ' \| ') ~~.. '~~)~~</span>'~~		'<span class="%s">(%s)</span>',
			message('toolbar-class'),
			table.concat(ret, ' \| ')
			)
	end		end

Line 505:		Line 509:
	end		end

	~~local data = {}~~
	~~data.title = title~~
	~~data.docTitle = docTitle~~
	~~-- View, display, edit, and purge links if /doc exists.~~
	~~data.viewLinkDisplay = message('view-link-display')~~
	~~data.editLinkDisplay = message('edit-link-display')~~
	~~data.historyLinkDisplay = message('history-link-display')~~
	~~data.purgeLinkDisplay = message('purge-link-display')~~
	-- Create link if /doc doesn't exist.		-- Create link if /doc doesn't exist.
	local preload = args.preload		local preload = args.preload
Line 522:		Line 518:
	end		end
	end		end
	~~data~~.preload = preload
	~~data.~~createLinkDisplay = message('create-link-display')		return {
	~~return data~~		title = title,
			docTitle = docTitle,
			-- View, display, edit, and purge links if /doc exists.
			viewLinkDisplay = message('view-link-display'),
			editLinkDisplay = message('edit-link-display'),
			historyLinkDisplay = message('history-link-display'),
			purgeLinkDisplay = message('purge-link-display'),
			preload = preload,
			createLinkDisplay = message('create-link-display')
			}
	end		end

Line 532:		Line 537:
	-- @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
	local purgeLink = makeWikilink("Special:Purge/" .. ~~docTitle~~.prefixedText, data.purgeLinkDisplay)		local purgeLink = makeWikilink("Special:Purge/" .. data.title.prefixedText, data.purgeLinkDisplay)

	if docTitle.exists then		if docTitle.exists then

imported>Izno: switch these to canonicalurl

2023-07-26T03:12:57Z

switch these to canonicalurl

imported>Izno: per tper

2023-06-17T01:23:52Z

per tper

← Older revision		Revision as of 01:23, 17 June 2023
Line 532:		Line 532:
	-- @data - a table of data generated by p.makeStartBoxLinksData		-- @data - a table of data generated by p.makeStartBoxLinksData
	--]]		--]]

	~~local function escapeBrackets(s)~~
	~~-- Escapes square brackets with HTML entities.~~
	~~s = s:gsub('%[', '[') -- Replace square brackets with HTML entities.~~
	~~s = s:gsub('%]', ']')~~
	~~return s~~
	~~end~~

	~~local ret~~
	local docTitle = data.docTitle		local docTitle = data.docTitle
	~~local title = data.title~~		local purgeLink = makeWikilink("Special:Purge/" .. docTitle.prefixedText, data.purgeLinkDisplay)
	local purgeLink = ~~makeUrlLink~~(~~title~~:~~fullUrl{action = 'purge'}~~, 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 = ~~makeUrlLink~~(docTitle~~:fullUrl{action = 'edit'}~~, data.editLinkDisplay)		local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay)
	local historyLink = ~~makeUrlLink~~(docTitle~~:fullUrl{action = 'history'}~~, data.historyLinkDisplay)		local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay)
	~~ret = '[%s] [%s] [%s] [%s]'~~		return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]"
	~~ret = escapeBrackets(ret)~~
	~~ret = mw~~.~~ustring~~.~~format(ret,~~ viewLink, editLink, historyLink, purgeLink)
	else		else
	local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)		local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
	~~ret = '[%s] [%s]'~~		return "[" .. createLink .. "] [" .. purgeLink .. "]"
	~~ret = escapeBrackets(ret)~~
	~~ret = mw~~.~~ustring~~.~~format(ret,~~ createLink, purgeLink)
	end		end
	return ret		return ret
Line 771:		Line 759:
	-- /doc exists; link to it.		-- /doc exists; link to it.
	local docLink = makeWikilink(docTitle.prefixedText)		local docLink = makeWikilink(docTitle.prefixedText)
	~~local editUrl = docTitle:fullUrl{action = 'edit'}~~
	local editDisplay = message('edit-link-display')		local editDisplay = message('edit-link-display')
	local editLink = ~~makeUrlLink~~(~~editUrl~~, editDisplay)		local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay)
	~~local historyUrl = docTitle:fullUrl{action = 'history'}~~
	local historyDisplay = message('history-link-display')		local historyDisplay = message('history-link-display')
	local historyLink = ~~makeUrlLink~~(~~historyUrl~~, historyDisplay)		local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay)
	ret = message('transcluded-from-blurb', {docLink})		ret = message('transcluded-from-blurb', {docLink})
	.. ' '		.. ' '
Line 834:		Line 820:
	local sandboxDisplay = message('sandbox-link-display')		local sandboxDisplay = message('sandbox-link-display')
	local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)		local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
	~~local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}~~
	local sandboxEditDisplay = message('sandbox-edit-link-display')		local sandboxEditDisplay = message('sandbox-edit-link-display')
	local sandboxEditLink = ~~makeUrlLink~~(~~sandboxEditUrl~~, sandboxEditDisplay)		local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, sandboxEditDisplay)
	local compareUrl = env.compareUrl		local compareUrl = env.compareUrl
	local compareLink		local compareLink
Line 870:		Line 855:
	local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}		local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
	local testcasesEditDisplay = message('testcases-edit-link-display')		local testcasesEditDisplay = message('testcases-edit-link-display')
	local testcasesEditLink = ~~makeUrlLink~~(~~testcasesEditUrl~~, 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

imported>Andrybak: update code comment according to Special:Diff/989669779

2022-09-29T01:57:36Z

update code comment according to Special:Diff/989669779

← Older revision		Revision as of 01:57, 29 September 2022
Line 349:		Line 349:
	--		--
	-- Messages:		-- Messages:
	-- 'sandbox-notice-image' --> '[[~~Image~~: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).'

← Older revision		Revision as of 03:12, 26 July 2023
Line 313:		Line 313:
	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.~~fullUrl~~(		local compareUrl = mw.uri.canonicalUrl(
	'Special:ComparePages',		'Special:ComparePages',
	{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}		{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
Line 542:		Line 542:
	return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]"		return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]"
	else		else
	local createLink = makeUrlLink(docTitle:~~fullUrl~~{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
Line 769:		Line 769:
	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:~~fullUrl~~{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)
Line 836:		Line 836:
	sandboxPreload = message('template-sandbox-preload')		sandboxPreload = message('template-sandbox-preload')
	end		end
	local sandboxCreateUrl = sandboxTitle:~~fullUrl~~{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:~~fullUrl~~{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:~~fullUrl~~{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')
Line 853:		Line 853:
	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:~~fullUrl~~{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)
Line 871:		Line 871:
	testcasesPreload = message('template-testcases-preload')		testcasesPreload = message('template-testcases-preload')
	end		end
	local testcasesCreateUrl = testcasesTitle:~~fullUrl~~{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)