Anonymous user
Module:Documentation: Difference between revisions
remove unneeded return variables (if this breaks anything feel free to revert without discussing with me first)
m (Pppery moved page Module:Documentation/2 to Module:Documentation without leaving a redirect) |
wp>DannyS712 (remove unneeded return variables (if this breaks anything feel free to revert without discussing with me first)) |
||
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 | return format('[[%s|%s]]', page, display) | ||
else | else | ||
return | return format('[[%s]]', page) | ||
end | end | ||
end | end | ||
Line 66: | Line 67: | ||
local function makeUrlLink(url, display) | local function makeUrlLink(url, display) | ||
return | return format('[%s %s]', url, display) | ||
end | end | ||
Line 81: | Line 82: | ||
end | end | ||
-- 'documentation-toolbar' | -- 'documentation-toolbar' | ||
return '<span class="' | return format( | ||
'<span class="%s">(%s)</span>', | |||
message('toolbar-class'), | |||
table.concat(ret, ' | ') | |||
) | |||
end | end | ||
Line 133: | Line 137: | ||
local root = mw.html.create() | local root = mw.html.create() | ||
root | root | ||
:wikitext(p._getModuleWikitext(args, env)) | |||
:wikitext(p.protectionTemplate(env)) | |||
:wikitext(p.sandboxNotice(args, env)) | |||
:tag('div') | :tag('div') | ||
-- 'documentation-container' | -- 'documentation-container' | ||
Line 179: | Line 186: | ||
-- | -- | ||
-- Data includes: | -- Data includes: | ||
-- 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. | ||
Line 271: | Line 279: | ||
end | end | ||
function envFuncs.protectionLevels() | |||
-- The protection levels table of the title object. | |||
return env.title.protectionLevels | |||
end | |||
function envFuncs.subjectSpace() | function envFuncs.subjectSpace() | ||
Line 305: | Line 317: | ||
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. | local compareUrl = mw.uri.canonicalUrl( | ||
'Special:ComparePages', | 'Special:ComparePages', | ||
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | { page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | ||
Line 317: | Line 329: | ||
return env | return env | ||
end | end | ||
---------------------------------------------------------------------------- | |||
-- Auxiliary templates | |||
---------------------------------------------------------------------------- | |||
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext') | |||
function p._getModuleWikitext(args, env) | |||
local currentTitle = mw.title.getCurrentTitle() | |||
if currentTitle.contentModel ~= 'Scribunto' then return end | |||
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care | |||
local moduleWikitext = package.loaded["Module:Module wikitext"] | |||
if moduleWikitext then | |||
return moduleWikitext.main() | |||
end | |||
end | |||
function p.sandboxNotice(args, env) | |||
--[=[ | |||
-- Generates a sandbox notice for display above sandbox pages. | |||
-- @args - a table of arguments passed by the user | |||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | |||
-- | |||
-- Messages: | |||
-- 'sandbox-notice-image' --> '[[File:Sandbox.svg|50px|alt=|link=]]' | |||
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.' | |||
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).' | |||
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page' | |||
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page' | |||
-- 'sandbox-notice-pagetype-other' --> 'sandbox page' | |||
-- 'sandbox-notice-compare-link-display' --> 'diff' | |||
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' | |||
-- 'sandbox-notice-testcases-link-display' --> 'test cases' | |||
-- 'sandbox-category' --> 'Template sandboxes' | |||
-- 'module-sandbox-category' --> 'Module sandboxes' | |||
-- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace' | |||
--]=] | |||
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, sandboxCat | |||
if subjectSpace == 10 then | |||
pagetype = message('sandbox-notice-pagetype-template') | |||
sandboxCat = message('sandbox-category') | |||
elseif subjectSpace == 828 then | |||
pagetype = message('sandbox-notice-pagetype-module') | |||
sandboxCat = message('module-sandbox-category') | |||
else | |||
pagetype = message('sandbox-notice-pagetype-other') | |||
sandboxCat = message('other-sandbox-category') | |||
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. | |||
omargs.text = text .. makeCategoryLink(sandboxCat) | |||
-- 'documentation-clear' | |||
return '<div class="' .. message('clear') .. '"></div>' | |||
.. require('Module:Message box').main('ombox', omargs) | |||
end | |||
function p.protectionTemplate(env) | |||
-- Generates the padlock icon in the top right. | |||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | |||
-- Messages: | |||
-- 'protection-template' --> 'pp-template' | |||
-- 'protection-template-args' --> {docusage = 'yes'} | |||
local 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. | |||
return require('Module:Protection banner')._main{ | |||
message('protection-reason-edit'), 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. | |||
return require('Module:Protection banner')._main{ | |||
action = 'move', small = true | |||
} | |||
else | |||
return nil | |||
end | |||
end | |||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
Line 379: | Line 515: | ||
end | end | ||
-- Create link if /doc doesn't exist. | -- Create link if /doc doesn't exist. | ||
local preload = args.preload | local preload = args.preload | ||
Line 396: | Line 524: | ||
end | end | ||
end | end | ||
return { | |||
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 406: | Line 543: | ||
-- @data - a table of data generated by p.makeStartBoxLinksData | -- @data - a table of data generated by p.makeStartBoxLinksData | ||
--]] | --]] | ||
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) | |||
if docTitle.exists then | if docTitle.exists then | ||
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) | local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) | ||
local editLink = | local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay) | ||
local historyLink = | local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay) | ||
return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]" | |||
else | else | ||
local createLink = makeUrlLink(docTitle: | local createLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) | ||
return "[" .. createLink .. "] [" .. purgeLink .. "]" | |||
end | end | ||
return ret | return ret | ||
Line 641: | Line 766: | ||
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 = | local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay) | ||
local historyDisplay = message('history-link-display') | local historyDisplay = message('history-link-display') | ||
local historyLink = | local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay) | ||
return message('transcluded-from-blurb', {docLink}) | |||
.. ' ' | .. ' ' | ||
.. makeToolbar(editLink, historyLink) | .. makeToolbar(editLink, historyLink) | ||
Line 657: | Line 779: | ||
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: | 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}) | |||
.. '<br />' | .. '<br />' | ||
end | end | ||
end | end | ||
Line 708: | Line 829: | ||
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 = | local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, sandboxEditDisplay) | ||
local compareUrl = env.compareUrl | local compareUrl = env.compareUrl | ||
local compareLink | local compareLink | ||
Line 725: | Line 845: | ||
sandboxPreload = message('template-sandbox-preload') | sandboxPreload = message('template-sandbox-preload') | ||
end | end | ||
local sandboxCreateUrl = sandboxTitle: | 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: | local mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary} | ||
if subjectSpace == 828 then | if subjectSpace == 828 then | ||
mirrorUrl = sandboxTitle: | 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 742: | Line 862: | ||
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: | local testcasesEditUrl = testcasesTitle:canonicalUrl{action = 'edit'} | ||
local testcasesEditDisplay = message('testcases-edit-link-display') | local testcasesEditDisplay = message('testcases-edit-link-display') | ||
local testcasesEditLink = | 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 | ||
Line 760: | Line 880: | ||
testcasesPreload = message('template-testcases-preload') | testcasesPreload = message('template-testcases-preload') | ||
end | end | ||
local testcasesCreateUrl = testcasesTitle: | 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) | ||
Line 847: | Line 967: | ||
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 ( | ||
Line 854: | Line 973: | ||
) | ) | ||
then | then | ||
return makeCategoryLink(message('strange-usage-category')) | |||
end | end | ||
return | return '' | ||
end | end | ||
return p | return p |