7,612
edits
Changes
Jump to navigation
Jump to search
m
p.main = makeInvokeFunc('_main')
:tag('div')
:css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
:newline()
:done()
local protectionLevels, mProtectionBanner
if local protectionLevels local protectionTemplate = message('protection-template') local namespace = title.namespace ~ if not (protectionTemplate and (namespace == 10 and title.or namespace ~== 828 )) then
return local cbox = mw.html.create('div') cbox :addClass(message('content-div-class')) :wikitext('\n' .. (content or '') .. '\n' ) return tostring(cbox)
--
-- 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]].
fmargs.text = text
return messageBoxlocal ebox = mw.html.maincreate('fmboxdiv', fmargs) ebox :addClass(message('footer-div-class')) :wikitext(text) return tostring(ebox)
Module:Documentation (view source)
Revision as of 16:54, 16 September 2020
, 16:54, 16 September 20201 revision imported
-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
local i18n = mw.loadData('Module:Documentation/i18n')
local p = {}
expectType = expectType or 'string'
if type(msg) ~= expectType then
error(require('messageModule: type error in message cfg.TNT' ).. cfgKey .. ' format(' .. expectType .. I18n/Documentation' expected, got ' .. cfg-error-msg-type', cfgKey, expectType, type(msg) .. ')', 2)
end
if not valArray then
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error(require('messageModule: no value found for key $TNT' ).. match .. format('I18n/Documentation', ' in message cfg.-error-msg-empty', '$' .. match, cfgKey), 4)
end
return p[funcName](args)
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
-- Main function
----------------------------------------------------------------------------
function p._main(args)
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-classesclass')) :newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:done()
:wikitext(p._endBox(args, env))
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[w:Wikipedia:Template test cases|template sandbox]] page' -- 'sandbox-notice-pagetype-module' --> '[[w:Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.namespace contentModel == mw.site.namespaces.Module.id "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
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)
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local title = env.title
-- Don't display the protection template if we are not in the template or module namespaces.
return nil
return nil
end
local editProt editLevels = protectionLevels.edit and protectionLevels.edit[1] local moveProt moveLevels = protectionLevels.move if moveLevels and moveLevels[1] == 'sysop' or editLevels and protectionLevels.moveeditLevels[1] if editProt then -- The page is editfull-move protected, or full, template, or semi-protected. mProtectionBanner local frame = requiremw.getCurrentFrame('Module:Protection banner') local reason return frame:expandTemplate{title = protectionTemplate, args = message('protection-reasontemplate-editargs') 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"nil, as this is equivalent to -- no move protection at all. mProtectionBanner = require('Module:Protection bannertable') return mProtectionBanner._main{action = 'move', small = true}
else
return nil
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = message(i18n['view-link-display')] data.editLinkDisplay = message(i18n['edit-link-display')] data.historyLinkDisplay = message(i18n['history-link-display')] data.purgeLinkDisplay = message(i18n['purge-link-display')]
-- Create link if /doc doesn't exist.
local preload = args.preload
end
data.preload = preload
data.createLinkDisplay = message(i18n['create-link-display')]
return data
end
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message(i18n['template-namespace-heading')]
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message(i18n['module-namespace-heading')]
elseif subjectSpace == 6 then -- File namespace
data.heading = message(i18n['file-namespace-heading')]
else
data.heading = message(i18n['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
local sbox = mw.html.create('div')
sbox
:cssaddClass('padding-bottom', '3px') :cssmessage('borderheader-bottom', '1px solid #aaa') :css('margindiv-bottom', '1exclass') :newline() :tag('spandiv') :cssTextaddClass(data.headingStyleText) :cssmessage('fontheading-weightdiv-class', data.headingFontWeight) :css('font-size', data.headingFontSize)
:wikitext(data.heading)
local links = data.links
if links then
sbox :tag('spandiv') :addClass(data.linksClass) :attr('id', data.linksId) :wikitext(links)
end
return tostring(sbox)
local content = args.content
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
end
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--]=]
end
-- Assemble the arguments for {{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 footer text field.
local text = ''
if linkBox then
end
end
end
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[w:Wikipedia:Template documentation|documentation]] -- is [[w:Wikipedia:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[w:Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle or args.content then
return nil
end
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message(i18n['edit-link-display')]
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message(i18n['history-link-display')]
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message(i18n['create-link-display')]
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
