Module:Documentation: Difference between revisions
Jump to navigation
Jump to search
Enwikipedia>DannyS712 |
fix namespace |
||
Line 7: | Line 7: | ||
-- Get the config table. | -- Get the config table. | ||
local cfg = mw.loadData('Module:Documentation/config') | local cfg = mw.loadData('Module:Documentation/config') | ||
local i18n = mw.loadData('Module:Documentation/i18n') | |||
local p = {} | local p = {} | ||
Line 33: | Line 33: | ||
expectType = expectType or 'string' | expectType = expectType or 'string' | ||
if type(msg) ~= expectType then | if type(msg) ~= expectType then | ||
error(' | error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-type', cfgKey, expectType, type(msg)), 2) | ||
end | end | ||
if not valArray then | if not valArray then | ||
Line 41: | Line 41: | ||
local function getMessageVal(match) | local function getMessageVal(match) | ||
match = tonumber(match) | match = tonumber(match) | ||
return valArray[match] or error(' | return valArray[match] or error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-empty', '$' .. match, cfgKey), 4) | ||
end | end | ||
Line 109: | Line 109: | ||
return p[funcName](args) | return p[funcName](args) | ||
end | end | ||
end | |||
---------------------------------------------------------------------------- | |||
-- Load TemplateStyles | |||
---------------------------------------------------------------------------- | |||
p.main = function(frame) | |||
local parent = frame.getParent(frame) | |||
local output = p._main(parent.args) | |||
return frame:extensionTag{ name='templatestyles', args = { src= message('templatestyles-scr') } } .. frame:preprocess(output) | |||
end | end | ||
Line 114: | Line 124: | ||
-- Main function | -- Main function | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
function p._main(args) | function p._main(args) | ||
Line 135: | Line 143: | ||
:tag('div') | :tag('div') | ||
:attr('id', message('main-div-id')) | :attr('id', message('main-div-id')) | ||
:addClass(message('main-div- | :addClass(message('main-div-class')) | ||
:wikitext(p._startBox(args, env)) | :wikitext(p._startBox(args, env)) | ||
:wikitext(p._content(args, env)) | :wikitext(p._content(args, env)) | ||
:done() | :done() | ||
:wikitext(p._endBox(args, env)) | :wikitext(p._endBox(args, env)) | ||
Line 334: | Line 337: | ||
-- '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:Wikipedia:Template sandbox and test cases|template sandbox]] page' | ||
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page' | -- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Wikipedia:Template sandbox and 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' | ||
Line 355: | Line 358: | ||
-- "This is the template sandbox for [[Template:Foo]] (diff)." | -- "This is the template sandbox for [[Template:Foo]] (diff)." | ||
local text = '' | local text = '' | ||
local frame = mw.getCurrentFrame() | |||
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed. | |||
local pagetype | local pagetype | ||
if subjectSpace == 10 then | if subjectSpace == 10 then | ||
Line 365: | Line 370: | ||
local templateLink = makeWikilink(templateTitle.prefixedText) | local templateLink = makeWikilink(templateTitle.prefixedText) | ||
local compareUrl = env.compareUrl | local compareUrl = env.compareUrl | ||
if compareUrl then | if isPreviewing or not compareUrl then | ||
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink}) | |||
else | |||
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}) | ||
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 | ||
Line 391: | Line 396: | ||
text = text .. makeCategoryLink(message('sandbox-category')) | text = text .. makeCategoryLink(message('sandbox-category')) | ||
omargs.text = text | omargs.text = text | ||
omargs.class = message('sandbox-class') | |||
local ret = '<div style="clear: both;"></div>' | local ret = '<div style="clear: both;"></div>' | ||
ret = ret .. messageBox.main('ombox', omargs) | ret = ret .. messageBox.main('ombox', omargs) | ||
Line 402: | Line 408: | ||
-- 'protection-template' --> 'pp-template' | -- 'protection-template' --> 'pp-template' | ||
-- 'protection-template-args' --> {docusage = 'yes'} | -- 'protection-template-args' --> {docusage = 'yes'} | ||
local title = env.title | local title = env.title | ||
local protectionLevels | |||
local protectionTemplate = message('protection-template') | |||
local namespace = title.namespace | |||
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then | |||
-- Don't display the protection template if we are not in the template or module namespaces. | |||
return nil | |||
end | |||
protectionLevels = env.protectionLevels | protectionLevels = env.protectionLevels | ||
if not protectionLevels then | if not protectionLevels then | ||
return nil | return nil | ||
end | end | ||
local | local editLevels = protectionLevels.edit | ||
local | local moveLevels = protectionLevels.move | ||
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then | |||
-- The page is | -- The page is full-move protected, or full, template, or semi-protected. | ||
local frame = mw.getCurrentFrame() | |||
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')} | |||
else | else | ||
return nil | return nil | ||
Line 492: | Line 497: | ||
data.docTitle = docTitle | data.docTitle = docTitle | ||
-- View, display, edit, and purge links if /doc exists. | -- View, display, edit, and purge links if /doc exists. | ||
data.viewLinkDisplay = | data.viewLinkDisplay = i18n['view-link-display'] | ||
data.editLinkDisplay = | data.editLinkDisplay = i18n['edit-link-display'] | ||
data.historyLinkDisplay = | data.historyLinkDisplay = i18n['history-link-display'] | ||
data.purgeLinkDisplay = | data.purgeLinkDisplay = i18n['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 508: | Line 513: | ||
end | end | ||
data.preload = preload | data.preload = preload | ||
data.createLinkDisplay = | data.createLinkDisplay = i18n['create-link-display'] | ||
return data | return data | ||
end | end | ||
Line 553: | Line 558: | ||
-- | -- | ||
-- 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=Documentation icon]]' | ||
-- 'template-namespace-heading' --> 'Template documentation' | -- 'template-namespace-heading' --> 'Template documentation' | ||
-- 'module-namespace-heading' --> 'Module documentation' | -- 'module-namespace-heading' --> 'Module documentation' | ||
Line 579: | Line 584: | ||
data.heading = heading | data.heading = heading | ||
elseif subjectSpace == 10 then -- Template namespace | elseif subjectSpace == 10 then -- Template namespace | ||
data.heading = | data.heading = i18n['template-namespace-heading'] | ||
elseif subjectSpace == 828 then -- Module namespace | elseif subjectSpace == 828 then -- Module namespace | ||
data.heading = | data.heading = i18n['module-namespace-heading'] | ||
elseif subjectSpace == 6 then -- File namespace | elseif subjectSpace == 6 then -- File namespace | ||
data.heading = | data.heading = i18n['file-namespace-heading'] | ||
else | else | ||
data.heading = | data.heading = i18n['other-namespaces-heading'] | ||
end | end | ||
Line 615: | Line 608: | ||
local sbox = mw.html.create('div') | local sbox = mw.html.create('div') | ||
sbox | sbox | ||
: | :addClass(message('header-div-class')) | ||
local links = data.links | local links = data.links | ||
if links then | if links then | ||
sbox:tag(' | sbox | ||
:tag('div') | |||
:addClass(data.linksClass) | |||
:attr('id', data.linksId) | |||
:wikitext(links) | |||
end | end | ||
sbox | |||
:tag('div') | |||
:addClass(message('heading-div-class')) | |||
:wikitext(data.heading) | |||
return tostring(sbox) | return tostring(sbox) | ||
end | end | ||
Line 652: | Line 642: | ||
-- 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. | ||
local cbox = mw.html.create('div') | |||
cbox | |||
:addClass(message('content-div-class')) | |||
:wikitext('\n' .. (content or '') .. '\n') | |||
return tostring(cbox) | |||
end | end | ||
Line 678: | Line 672: | ||
-- @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 | ||
--]=] | --]=] | ||
Line 710: | Line 697: | ||
end | end | ||
-- Assemble the | -- Assemble the footer text field. | ||
local text = '' | local text = '' | ||
if linkBox then | if linkBox then | ||
Line 742: | Line 722: | ||
end | end | ||
end | end | ||
local ebox = mw.html.create('div') | |||
ebox | |||
:addClass(message('footer-div-class')) | |||
:wikitext(text) | |||
return tostring(ebox) | |||
end | end | ||
Line 773: | Line 756: | ||
local docLink = makeWikilink(docTitle.prefixedText) | local docLink = makeWikilink(docTitle.prefixedText) | ||
local editUrl = docTitle:fullUrl{action = 'edit'} | local editUrl = docTitle:fullUrl{action = 'edit'} | ||
local editDisplay = | local editDisplay = i18n['edit-link-display'] | ||
local editLink = makeUrlLink(editUrl, editDisplay) | local editLink = makeUrlLink(editUrl, editDisplay) | ||
local historyUrl = docTitle:fullUrl{action = 'history'} | local historyUrl = docTitle:fullUrl{action = 'history'} | ||
local historyDisplay = | local historyDisplay = i18n['history-link-display'] | ||
local historyLink = makeUrlLink(historyUrl, historyDisplay) | local historyLink = makeUrlLink(historyUrl, historyDisplay) | ||
ret = message('transcluded-from-blurb', {docLink}) | ret = message('transcluded-from-blurb', {docLink}) | ||
Line 785: | Line 768: | ||
-- /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:fullUrl{action = 'edit', preload = message('module-preload')} | ||
local createDisplay = | local createDisplay = i18n['create-link-display'] | ||
local createLink = makeUrlLink(createUrl, createDisplay) | local createLink = makeUrlLink(createUrl, createDisplay) | ||
ret = message('create-module-doc-blurb', {createLink}) | ret = message('create-module-doc-blurb', {createLink}) | ||
Line 858: | Line 841: | ||
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:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary} | ||
local mirrorDisplay = message('mirror-link-display') | local mirrorDisplay = message('mirror-link-display') | ||
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) | local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) | ||
Line 872: | Line 852: | ||
local testcasesEditDisplay = message('testcases-edit-link-display') | local testcasesEditDisplay = message('testcases-edit-link-display') | ||
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) | local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) | ||
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) | |||
else | else | ||
local testcasesPreload | local testcasesPreload |