Module:Documentation: Difference between revisions
Content deleted Content added
Johnrdorazio (talk | contribs) m 1 revision imported |
link |
||
Line 3:
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')▼
-- Get the config table.
Line 44 ⟶ 43:
end
end
Line 82 ⟶ 80:
ret[#ret + 1] = select(i, ...)
end
return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>'▼
return '<span class="' .. message('toolbar-class') .. '">('
end
Line 129:
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--]]
local env = p.getEnvironment(args)
Line 140 ⟶ 136:
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:tag('div')
-- 'documentation-container'
:attr('id', message('main-div-id'))▼
:addClass(message('
:newline()
:wikitext(p._startBox(args, env))▼
:wikitext(p._content(args, env))▼
:tag('div')
-- 'documentation'
:newline()
▲ :wikitext(p._startBox(args, env))
▲ :wikitext(p._content(args, env))
:tag('div')
-- '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 tostring(root)▼
return mw.getCurrentFrame():extensionTag (
'templatestyles', '', {src=cfg['templatestyles']
end
Line 164 ⟶ 167:
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
--
Line 290 ⟶ 293:
function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is
-- same as the subject namespace. However, pages in the Article, File,
-- 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
Line 318 ⟶ 322:
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
Line 367 ⟶ 371:
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
Line 410 ⟶ 415:
end
-- Add the sandbox to the sandbox category.
omargs.text = text .. makeCategoryLink(message('sandbox-category'))
-- 'documentation-clear'
end
Line 423 ⟶ 428:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels
if not protectionLevels then
return nil
Line 433 ⟶ 436:
if editProt then
-- The page is edit-protected.
}
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.
}
else
return nil
Line 579 ⟶ 583:
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'▼
-- 'testcases-create-link-display' --> 'create'
--]=]
Line 613 ⟶ 615:
if headingStyle then
data.headingStyleText = headingStyle
else
-- 'documentation-heading'
end
-- Data for the [view][edit][history][purge] or [create] links.
if links then
▲ data.linksClass = message('start-box-linkclasses')
data.
data.links = links
end
Line 636 ⟶ 635:
local sbox = mw.html.create('div')
sbox
-- 'documentation-startbox'
:addClass(message('start-box-class'))
:newline()
:tag('span')
:addClass(data.headingClass)
:cssText(data.headingStyleText)
:wikitext(data.heading)
local links = data.links
Line 700 ⟶ 697:
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
▲ -- 'fmbox-id' --> 'documentation-meta-data'
--]=]
Line 731 ⟶ 722:
end
-- Assemble the
local text = ''
if linkBox then
Line 748 ⟶ 732:
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
Line 763 ⟶ 746:
end
end
local box = mw.html.create('div')
-- 'documentation-metadata'
box:addClass(message('end-box-class'))
-- 'plainlinks'
:addClass(message('end-box-plainlinks'))
:wikitext(text)
:done()
return
end
Line 779 ⟶ 769:
-- 'transcluded-from-blurb' -->
-- 'The above [[Wikipedia:Template documentation|documentation]]
-- is [[
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
|