Editing Documentation
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 3: | Line 3: | ||
-- Get required modules. | -- Get required modules. | ||
local getArgs = require('Module:Arguments').getArgs | local getArgs = require('Module:Arguments').getArgs | ||
| + | local htmlBuilder = require('Module:HtmlBuilder') | ||
local messageBox = require('Module:Message box') | local messageBox = require('Module:Message box') | ||
| Line 127: | Line 128: | ||
--]] | --]] | ||
local env = p.getEnvironment(args) | local env = p.getEnvironment(args) | ||
| − | local root = | + | local root = htmlBuilder.create() |
root | root | ||
| − | + | .wikitext(p.protectionTemplate(env)) | |
| − | + | .wikitext(p.sandboxNotice(args, env)) | |
-- This div tag is from {{documentation/start box}}, but moving it here | -- This div tag is from {{documentation/start box}}, but moving it here | ||
-- so that we don't have to worry about unclosed tags. | -- so that we don't have to worry about unclosed tags. | ||
| − | + | .tag('div') | |
| − | + | .attr('id', message('main-div-id')) | |
| − | + | .addClass(message('main-div-classes')) | |
| − | + | .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)) | |
| − | + | .newline() | |
| + | .wikitext(p.addTrackingCategories(env)) | ||
return tostring(root) | return tostring(root) | ||
end | end | ||
| Line 331: | Line 333: | ||
-- | -- | ||
-- Messages: | -- Messages: | ||
| − | -- 'sandbox-notice-image' --> '[[Image:Sandbox. | + | -- 'sandbox-notice-image' --> '[[Image:Sandbox.png|50px|alt=|link=]]' |
-- '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).' | ||
| Line 355: | Line 357: | ||
-- "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 369: | ||
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 376: | Line 380: | ||
local testcasesTitle = env.testcasesTitle | local testcasesTitle = env.testcasesTitle | ||
if testcasesTitle and testcasesTitle.exists then | if testcasesTitle and testcasesTitle.exists then | ||
| − | if testcasesTitle.namespace == mw.site.namespaces.Module | + | if testcasesTitle.namespace == mw.site.namespaces.Module then |
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') | local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') | ||
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display') | local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display') | ||
| Line 402: | Line 406: | ||
-- '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 550: | Line 553: | ||
-- | -- | ||
-- Messages: | -- Messages: | ||
| − | -- 'documentation-icon-wikitext' --> '[[File: | + | -- 'documentation-icon-wikitext' --> '[[File:Template-info.png|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 610: | Line 613: | ||
-- Renders the start box html. | -- Renders the start box html. | ||
-- @data - a table of data generated by p.makeStartBoxData. | -- @data - a table of data generated by p.makeStartBoxData. | ||
| − | local sbox = | + | local sbox = htmlBuilder.create('div') |
sbox | sbox | ||
| − | + | .css('padding-bottom', '3px') | |
| − | + | .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 | local links = data.links | ||
if links then | if links then | ||
| − | sbox | + | sbox.tag('span') |
| − | + | .addClass(data.linksClass) | |
| − | + | .attr('id', data.linksId) | |
| − | + | .wikitext(links) | |
end | end | ||
return tostring(sbox) | return tostring(sbox) | ||
| Line 645: | Line 648: | ||
local content = args.content | local content = args.content | ||
if not content and docTitle and docTitle.exists then | if not content and docTitle and docTitle.exists then | ||
| − | + | local frame = mw.getCurrentFrame() | |
| + | content = frame:expandTemplate{title = docTitle.prefixedText} | ||
end | end | ||
-- 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. | ||
return '\n' .. (content or '') .. '\n' | return '\n' .. (content or '') .. '\n' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
end | end | ||
| Line 724: | Line 716: | ||
-- Add sandbox and testcases links. | -- Add sandbox and testcases links. | ||
-- "Editors can experiment in this template's sandbox and testcases pages." | -- "Editors can experiment in this template's sandbox and testcases pages." | ||
| − | text = text .. | + | text = text .. p.makeExperimentBlurb(args, env) |
text = text .. '<br />' | text = text .. '<br />' | ||
if not args.content and not args[1] then | if not args.content and not args[1] then | ||
| Line 805: | Line 797: | ||
-- 'mirror-edit-summary' --> 'Create sandbox version of $1' | -- 'mirror-edit-summary' --> 'Create sandbox version of $1' | ||
-- 'mirror-link-display' --> 'mirror' | -- 'mirror-link-display' --> 'mirror' | ||
| − | |||
-- 'sandbox-link-display' --> 'sandbox' | -- 'sandbox-link-display' --> 'sandbox' | ||
-- 'testcases-link-display' --> 'testcases' | -- 'testcases-link-display' --> 'testcases' | ||
-- 'testcases-edit-link-display'--> 'edit' | -- 'testcases-edit-link-display'--> 'edit' | ||
| + | -- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases' | ||
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' | -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' | ||
-- 'testcases-create-link-display' --> 'create' | -- 'testcases-create-link-display' --> 'create' | ||
| Line 853: | Line 845: | ||
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) | local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) | ||
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) | local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) | ||
| − | local | + | local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, 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 869: | Line 857: | ||
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 | ||