Open main menu

Changes

Module:Documentation

930 bytes removed, 21:44, 21 November 2020
link
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')
-- Get the config table.
end
local ret = return ugsub(msg, '$([1-9][0-9]*)', getMessageVal) return ret
end
ret[#ret + 1] = select(i, ...)
end
-- 'documentation-toolbar' return '<small stylespan class="font' .. message('toolbar-style: normal;class') .. '">(' .. table.concat(ret, ' &#124; ') .. ')</smallspan>'
end
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
local env = p.getEnvironment(args)
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:attr(-- 'id', message('maindocumentation-div-idcontainer')) :addClass(message('main-div-classescontainer'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
-- 'documentation' :cssaddClass(message('clearmain-div-classes')) :newline() :wikitext(p._startBox(args, env)) :wikitext(p._content(args, env)) :tag('bothdiv') -- So right or left floating items don't stick out of the doc box.documentation-clear' :addClass(message('clear')) :done()
:newline()
:done()
:wikitext(p._endBox(args, env))
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
-- 'Module:Documentation/styles.css' return mw.getCurrentFrame():extensionTag ( 'templatestyles', '', {src=cfg['templatestyles'] }) .. tostring(root)
end
function p.getEnvironment(args)
--[[
-- Returns a table with information about the environment, including title -- objects and other namespace- or -- path-related data.
-- @args - table of arguments passed by the user
--
function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the same as the -- same as the subject namespace. However, pages in the Article, File, MediaWiki or Category -- MediaWiki or Category namespaces must have their /doc, /sandbox and -- /testcases pages in talk space.
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
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
end
-- Add the sandbox to the sandbox category.
omargs.text = text .. makeCategoryLink(message('sandbox-category'))  omargs.text = text-- 'documentation-clear' local ret = return '<div styleclass="' .. message('clear: both;') .. '"></div>' ret = ret .. messageBoxrequire('Module:Message box').main('ombox', omargs) return ret
end
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels, mProtectionBanner local title = env.title protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
if editProt then
-- The page is edit-protected.
mProtectionBanner = return require('Module:Protection banner')._main{ local reason = message('protection-reason-edit') 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 = return require('Module:Protection banner') return mProtectionBanner._main{ action = 'move', small = true }
else
return nil
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
--]=]
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
-- 'documentation-heading' data.headingFontSize headingClass = message('150%main-div-heading-class')
end
-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message(-- 'startmw-boxeditsection-linkclasseslike plainlinks') data.linksId linksClass = message('start-box-link-idclasses')
data.links = links
end
local sbox = mw.html.create('div')
sbox
:css(-- 'paddingdocumentation-bottom', '3pxstartbox') :cssaddClass(message('borderstart-bottom', '1px solid #aaabox-class') :css('margin-bottom', '1ex')
:newline()
:tag('span')
:addClass(data.headingClass)
:cssText(data.headingStyleText)
:css('font-weight', data.headingFontWeight)
:css('font-size', data.headingFontSize)
:wikitext(data.heading)
local links = data.links
-- @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]].
--]=]
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 text fieldlink box.
local text = ''
if linkBox then
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '') text = text .. '<br />'
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
end
end
fmargs local box = mw.html.create('div') -- 'documentation-metadata' box:addClass(message('end-box-class')) -- 'plainlinks' :addClass(message('end-box-plainlinks')) :wikitext(text = text) :done()
return messageBox'\n' .main. tostring('fmbox', fmargsbox)
end
-- 'transcluded-from-blurb' -->
-- 'The above [[Wikipedia:Template documentation|documentation]]
-- is [[WikipediaHelp:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
Anonymous user