Module:Documentation: Difference between revisions

From Mariopedia, a wiki on Mario, Yoshi, Wario, Donkey Kong, Super Smash Bros., and more!
Jump to navigationJump to search

Module:Documentation (view source)

Revision as of 15:18, July 19, 2019

1,184 bytes added ,  4 years ago
Add configurable css from config, so that it can be removed from common.css. Class maintained for compatibility on other wikis and with scripts. See Special:Permalink/906970618#Moving CSS
(Add configurable css from config, so that it can be removed from common.css. Class maintained for compatibility on other wikis and with scripts. See Special:Permalink/906970618#Moving CSS)
Line 7:
-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
 
local i18n = mw.loadData('Module:Documentation/i18n')
local p = {}
 
Line 33:
expectType = expectType or 'string'
if type(msg) ~= expectType then
error(require('Modulemessage:TNT type error in message cfg.') .format(. cfgKey .. 'I18n/Documentation', ('cfg-error-msg-type', cfgKey,.. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
Line 41:
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error(require('Modulemessage:TNT').format('I18n/Documentation', 'cfg-error-msg-empty',no value found for key '$' .. match, .. ' in message cfg.' .. cfgKey), 4)
end
 
Line 112:
 
----------------------------------------------------------------------------
-- Main function
-- Load TemplateStyles
----------------------------------------------------------------------------
 
p.main = functionmakeInvokeFunc(frame'_main')
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
 
----------------------------------------------------------------------------
-- Main function
----------------------------------------------------------------------------
 
function p._main(args)
Line 143 ⟶ 135:
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-classclasses'))
:css(message('main-div-css', nil, 'table'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
:css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
:newline()
:done()
:done()
:wikitext(p._endBox(args, env))
Line 358 ⟶ 356:
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local text = ''
local frame = mw.getCurrentFrame()
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
local pagetype
if subjectSpace == 10 then
Line 370 ⟶ 366:
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if isPreviewing or not compareUrl then
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
else
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
Line 396 ⟶ 392:
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
omargs.class = message('sandbox-class')
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
Line 408 ⟶ 403:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels, mProtectionBanner
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
if not protectionLevels then
return nil
end
local editLevelseditProt = protectionLevels.edit and protectionLevels.edit[1]
local moveLevelsmoveProt = protectionLevels.move and protectionLevels.move[1]
if editProt then
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then
-- The page is full-move protected, or full, template, or semiedit-protected.
mProtectionBanner = require('Module:Protection banner')
local frame = mw.getCurrentFrame()
returnlocal frame:expandTemplate{title = protectionTemplate, argsreason = message('protection-templatereason-args', nil, 'tableedit')}
return mProtectionBanner._main{reason, small = true}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
mProtectionBanner = require('Module:Protection banner')
return mProtectionBanner._main{action = 'move', small = true}
else
return nil
Line 497 ⟶ 493:
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = i18n[message('view-link-display'])
data.editLinkDisplay = i18n[message('edit-link-display'])
data.historyLinkDisplay = i18n[message('history-link-display'])
data.purgeLinkDisplay = i18n[message('purge-link-display'])
-- Create link if /doc doesn't exist.
local preload = args.preload
Line 513 ⟶ 509:
end
data.preload = preload
data.createLinkDisplay = i18n[message('create-link-display'])
return data
end
Line 558 ⟶ 554:
--
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
Line 584 ⟶ 580:
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = i18n[message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading'])
elseif subjectSpace == 828 then -- Module namespace
data.heading = i18n[message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading'])
elseif subjectSpace == 6 then -- File namespace
data.heading = i18n[message('file-namespace-heading'])
else
data.heading = i18n[message('other-namespaces-heading'])
end
-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
elseif subjectSpace == 10 then
-- We are in the template or template talk namespaces.
data.headingFontWeight = 'bold'
data.headingFontSize = '125%'
else
data.headingFontSize = '150%'
end
Line 608 ⟶ 616:
local sbox = mw.html.create('div')
sbox
:css('padding-bottom', '3px')
:addClass(message('header-div-class'))
:css('border-bottom', '1px solid #aaa')
:css('margin-bottom', '1ex')
:newline()
:tag('span')
:cssText(data.headingStyleText)
:css('font-weight', data.headingFontWeight)
:css('font-size', data.headingFontSize)
:wikitext(data.heading)
local links = data.links
if links then
sbox:tag('span')
:tagaddClass('div'data.linksClass)
:addClassattr('id', data.linksClasslinksId)
:wikitext(links)
:attr('id', data.linksId)
:wikitext(links)
end
sbox
:tag('div')
:addClass(message('heading-div-class'))
:wikitext(data.heading)
return tostring(sbox)
end
Line 642 ⟶ 653:
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'
local cbox = mw.html.create('div')
cbox
:addClass(message('content-div-class'))
:wikitext('\n' .. (content or '') .. '\n')
return tostring(cbox)
end
 
Line 672 ⟶ 679:
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'fmbox-id' --> 'documentation-meta-data'
-- 'fmbox-style' --> 'background-color: #ecfcf4'
-- 'fmbox-textstyle' --> 'font-style: italic'
--
-- The HTML is generated by the {{fmbox}} template, courtesy of [[Module:Message box]].
--]=]
Line 697 ⟶ 711:
end
 
-- Assemble the footerarguments textfor field{{fmbox}}.
local fmargs = {}
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
fmargs.image = 'none'
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'
 
-- Assemble the fmbox text field.
local text = ''
if linkBox then
Line 722 ⟶ 743:
end
end
fmargs.text = text
 
return messageBox.main('fmbox', fmargs)
local ebox = mw.html.create('div')
ebox
:addClass(message('footer-div-class'))
:wikitext(text)
return tostring(ebox)
end
 
Line 756 ⟶ 774:
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = i18n[message('edit-link-display'])
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = i18n[message('history-link-display'])
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
Line 768 ⟶ 786:
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = i18n[message('create-link-display'])
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
Line 841 ⟶ 859:
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
Line 852 ⟶ 873:
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
local testcasesPreload
DannyS712
0

edits

Retrieved from "https://mariopedia.org/wiki/Special:MobileDiff/14297"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu