کاربر ناشناس
پودمان:Documentation: تفاوت میان نسخهها
جز
role=note for end box
(اگر چیزی ترکید، کاربر هنوز را بیابید.) |
جز (role=note for end box) |
||
خط ۱: | خط ۱: | ||
-- This module implements {{documentation}}. | -- This module implements {{documentation}}. | ||
-- Get required modules. | -- Get required modules. | ||
local getArgs = require('Module:Arguments').getArgs | local getArgs = require('Module:Arguments').getArgs | ||
-- Get the config table. | -- Get the config table. | ||
خط ۳۴: | خط ۳۲: | ||
expectType = expectType or 'string' | expectType = expectType or 'string' | ||
if type(msg) ~= expectType then | if type(msg) ~= expectType then | ||
error(' | error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2) | ||
end | end | ||
if not valArray then | if not valArray then | ||
خط ۴۲: | خط ۴۰: | ||
local function getMessageVal(match) | local function getMessageVal(match) | ||
match = tonumber(match) | match = tonumber(match) | ||
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) | |||
return valArray[match] or error(' | |||
end | end | ||
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal) | |||
end | end | ||
خط ۸۴: | خط ۸۰: | ||
ret[#ret + 1] = select(i, ...) | ret[#ret + 1] = select(i, ...) | ||
end | end | ||
return '< | -- 'documentation-toolbar' | ||
return '<span class="' .. message('toolbar-class') .. '">(' | |||
.. table.concat(ret, ' | ') .. ')</span>' | |||
end | end | ||
خط ۱۱۴: | خط ۱۱۲: | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- | -- Entry points | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
function p.nonexistent(frame) | |||
if mw.title.getCurrentTitle().subpageText == 'testcases' then | |||
return frame:expandTemplate{title = 'module test cases notice'} | |||
else | |||
return p.main(frame) | |||
end | |||
end | |||
p.main = makeInvokeFunc('_main') | p.main = makeInvokeFunc('_main') | ||
خط ۱۲۳: | خط ۱۲۹: | ||
-- This function defines logic flow for the module. | -- This function defines logic flow for the module. | ||
-- @args - table of arguments passed by the user | -- @args - table of arguments passed by the user | ||
--]] | --]] | ||
local env = p.getEnvironment(args) | local env = p.getEnvironment(args) | ||
خط ۱۳۴: | خط ۱۳۶: | ||
:wikitext(p.protectionTemplate(env)) | :wikitext(p.protectionTemplate(env)) | ||
:wikitext(p.sandboxNotice(args, env)) | :wikitext(p.sandboxNotice(args, env)) | ||
:tag('div') | :tag('div') | ||
-- 'documentation-container' | |||
:addClass(message(' | :addClass(message('container')) | ||
:newline() | :newline() | ||
:tag('div') | :tag('div') | ||
: | -- 'documentation' | ||
:addClass(message('main-div-classes')) | |||
:newline() | |||
:wikitext(p._startBox(args, env)) | |||
:wikitext(p._content(args, env)) | |||
:tag('div') | |||
-- 'documentation-clear' | |||
:addClass(message('clear')) | |||
:done() | |||
:newline() | :newline() | ||
:done() | :done() | ||
:wikitext(p._endBox(args, env)) | |||
:done() | :done() | ||
:wikitext(p.addTrackingCategories(env)) | :wikitext(p.addTrackingCategories(env)) | ||
return tostring(root) | -- 'Module:Documentation/styles.css' | ||
return mw.getCurrentFrame():extensionTag ( | |||
'templatestyles', '', {src=cfg['templatestyles'] | |||
}) .. tostring(root) | |||
end | end | ||
خط ۱۵۸: | خط ۱۶۷: | ||
function p.getEnvironment(args) | function p.getEnvironment(args) | ||
--[[ | --[[ | ||
-- Returns a table with information about the environment, including title objects and other namespace- or | -- 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 | -- @args - table of arguments passed by the user | ||
-- | -- | ||
خط ۲۸۴: | خط ۲۹۳: | ||
function envFuncs.docSpace() | function envFuncs.docSpace() | ||
-- The documentation namespace number. For most namespaces this is | -- The documentation namespace number. For most namespaces this is the | ||
-- subject namespace. However, pages in the Article, File, | -- same as the subject namespace. However, pages in the Article, File, | ||
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space. | -- MediaWiki or Category namespaces must have their /doc, /sandbox and | ||
-- /testcases pages in talk space. | |||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then | if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then | ||
خط ۳۱۱: | خط ۳۲۱: | ||
if templateTitle.exists and sandboxTitle.exists then | if templateTitle.exists and sandboxTitle.exists then | ||
local compareUrl = mw.uri.fullUrl( | local compareUrl = mw.uri.fullUrl( | ||
' | 'Special:ComparePages', | ||
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | { page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | ||
) | ) | ||
return tostring(compareUrl) | return tostring(compareUrl) | ||
خط ۳۲۶: | خط ۳۳۶: | ||
-- Auxiliary templates | -- Auxiliary templates | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext') | p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext') | ||
خط ۳۶۰: | خط ۳۷۱: | ||
local templateTitle = env.templateTitle | local templateTitle = env.templateTitle | ||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then | if not (subjectSpace and title and sandboxTitle and templateTitle | ||
and mw.title.equals(title, sandboxTitle)) then | |||
return nil | return nil | ||
end | end | ||
خط ۳۹۰: | خط ۴۰۲: | ||
local testcasesTitle = env.testcasesTitle | local testcasesTitle = env.testcasesTitle | ||
if testcasesTitle and testcasesTitle.exists then | if testcasesTitle and testcasesTitle.exists then | ||
if testcasesTitle. | if testcasesTitle.contentModel == "Scribunto" 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') | ||
خط ۴۰۳: | خط ۴۱۵: | ||
end | end | ||
-- Add the sandbox to the sandbox category. | -- Add the sandbox to the sandbox category. | ||
text = text .. makeCategoryLink(message('sandbox-category')) | omargs.text = text .. makeCategoryLink(message('sandbox-category')) | ||
-- 'documentation-clear' | |||
return '<div class="' .. message('clear') .. '"></div>' | |||
.. require('Module:Message box').main('ombox', omargs) | |||
end | end | ||
خط ۴۱۶: | خط ۴۲۸: | ||
-- 'protection-template' --> 'pp-template' | -- 'protection-template' --> 'pp-template' | ||
-- 'protection-template-args' --> {docusage = 'yes'} | -- 'protection-template-args' --> {docusage = 'yes'} | ||
local | local protectionLevels = env.protectionLevels | ||
if not protectionLevels then | if not protectionLevels then | ||
return nil | return nil | ||
خط ۴۲۶: | خط ۴۳۶: | ||
if editProt then | if editProt then | ||
-- The page is edit-protected. | -- The page is edit-protected. | ||
return require('Module:Protection banner')._main{ | |||
message('protection-reason-edit'), small = true | |||
} | |||
elseif moveProt and moveProt ~= 'autoconfirmed' then | elseif moveProt and moveProt ~= 'autoconfirmed' then | ||
-- The page is move-protected but not edit-protected. Exclude move | -- The page is move-protected but not edit-protected. Exclude move | ||
-- protection with the level "autoconfirmed", as this is equivalent to | -- protection with the level "autoconfirmed", as this is equivalent to | ||
-- no move protection at all. | -- no move protection at all. | ||
return require('Module:Protection banner')._main{ | |||
action = 'move', small = true | |||
} | |||
else | else | ||
return nil | return nil | ||
خط ۴۵۹: | خط ۴۷۰: | ||
local links | local links | ||
local content = args.content | local content = args.content | ||
if not content then | if not content or args[1] then | ||
-- No need to include the links if the documentation is on the template page itself. | -- No need to include the links if the documentation is on the template page itself. | ||
local linksData = p.makeStartBoxLinksData(args, env) | local linksData = p.makeStartBoxLinksData(args, env) | ||
خط ۴۹۷: | خط ۵۰۸: | ||
if not title or not docTitle then | if not title or not docTitle then | ||
return nil | return nil | ||
end | |||
if docTitle.isRedirect then | |||
docTitle = docTitle.redirectTarget | |||
end | end | ||
خط ۵۶۹: | خط ۵۸۳: | ||
-- 'file-namespace-heading' --> 'Summary' | -- 'file-namespace-heading' --> 'Summary' | ||
-- 'other-namespaces-heading' --> 'Documentation' | -- 'other-namespaces-heading' --> 'Documentation' | ||
-- 'testcases-create-link-display' --> 'create' | -- 'testcases-create-link-display' --> 'create' | ||
--]=] | --]=] | ||
خط ۶۰۳: | خط ۶۱۵: | ||
if headingStyle then | if headingStyle then | ||
data.headingStyleText = headingStyle | data.headingStyleText = headingStyle | ||
else | else | ||
data. | -- 'documentation-heading' | ||
data.headingClass = message('main-div-heading-class') | |||
end | end | ||
-- Data for the [view][edit][history][purge] or [create] links. | -- Data for the [view][edit][history][purge] or [create] links. | ||
if links then | if links then | ||
-- 'mw-editsection-like plainlinks' | |||
data. | data.linksClass = message('start-box-link-classes') | ||
data.links = links | data.links = links | ||
end | end | ||
خط ۶۲۶: | خط ۶۳۵: | ||
local sbox = mw.html.create('div') | local sbox = mw.html.create('div') | ||
sbox | sbox | ||
-- 'documentation-startbox' | |||
: | :addClass(message('start-box-class')) | ||
:newline() | :newline() | ||
:tag('span') | :tag('span') | ||
:addClass(data.headingClass) | |||
:cssText(data.headingStyleText) | :cssText(data.headingStyleText) | ||
:wikitext(data.heading) | :wikitext(data.heading) | ||
local links = data.links | local links = data.links | ||
خط ۶۹۰: | خط ۶۹۷: | ||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | -- @env - environment table containing title objects, etc., generated with p.getEnvironment | ||
-- | -- | ||
--]=] | --]=] | ||
خط ۷۲۱: | خط ۷۲۲: | ||
end | end | ||
-- Assemble the | -- Assemble the link box. | ||
local text = '' | local text = '' | ||
if linkBox then | if linkBox then | ||
خط ۷۳۸: | خط ۷۳۲: | ||
-- 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 .. (p.makeExperimentBlurb(args, env) or '') | text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />' | ||
if not args.content and not args[1] then | if not args.content and not args[1] then | ||
-- "Please add categories to the /doc subpage." | -- "Please add categories to the /doc subpage." | ||
خط ۷۵۳: | خط ۷۴۶: | ||
end | end | ||
end | end | ||
local box = mw.html.create('div') | |||
-- 'documentation-metadata' | |||
box:attr('role', 'note') | |||
:addClass(message('end-box-class')) | |||
-- 'plainlinks' | |||
:addClass(message('end-box-plainlinks')) | |||
:wikitext(text) | |||
:done() | |||
return | return '\n' .. tostring(box) | ||
end | end | ||
خط ۷۶۹: | خط ۷۷۰: | ||
-- 'transcluded-from-blurb' --> | -- 'transcluded-from-blurb' --> | ||
-- 'The above [[Wikipedia:Template documentation|documentation]] | -- 'The above [[Wikipedia:Template documentation|documentation]] | ||
-- is [[ | -- is [[Help:Transclusion|transcluded]] from $1.' | ||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' | -- 'module-preload' --> 'Template:Documentation/preload-module-doc' | ||
-- 'create-link-display' --> 'create' | -- 'create-link-display' --> 'create' | ||
خط ۸۸۴: | خط ۸۸۵: | ||
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) | local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) | ||
-- for Modules, add testcases run link if exists | -- for Modules, add testcases run link if exists | ||
if | if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then | ||
local testcasesRunLinkDisplay = message('testcases-run-link-display') | local testcasesRunLinkDisplay = message('testcases-run-link-display') | ||
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) | local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) | ||
خط ۹۵۵: | خط ۹۵۶: | ||
end | end | ||
local subpagesLink = makeWikilink( | local subpagesLink = makeWikilink( | ||
' | 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', | ||
message('subpages-link-display', {pagetype}) | message('subpages-link-display', {pagetype}) | ||
) | ) |