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') |
|
| |
|
| -- Get the config table. | | -- Get the config table. |
Line 8: |
Line 10: |
|
| |
|
| local p = {} | | local p = {} |
| | |
| | -- Constants. |
| | local currentTitle = mw.title.getCurrentTitle() |
| | local subjectSpace = mw.site.namespaces[currentTitle.namespace].subject.id -- The number of the current subject namespace. |
|
| |
|
| -- Often-used functions. | | -- Often-used functions. |
| local ugsub = mw.ustring.gsub | | local gsub = mw.ustring.gsub |
|
| |
|
| ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
| -- Helper functions | | -- Helper functions |
| --
| |
| -- These are defined as local functions, but are made available in the p
| |
| -- table for testing purposes.
| |
| ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
|
| |
|
| local function message(cfgKey, valArray, expectType) | | local function formatMessage(cfgKey, expectType, valArray) |
| --[[ | | --[[ |
| -- Gets a message from the cfg table and formats it if appropriate. | | -- Formats a message from the cfg table. |
| -- The function raises an error if the value from the cfg table is not | | -- The function raises an error if the value from the cfg table is not of the type expectType. |
| -- of the type expectType. The default type for expectType is 'string'.
| | -- Values from valArray can be specified in the message by using $1 for [1], $2 for [2], etc. |
| -- If the table valArray is present, strings such as $1, $2 etc. in the | | -- For example, if the message cfg.fooMessage had the value 'Foo $2 bar $1.', |
| -- message are substituted with values from the table keys [1], [2] etc.
| | -- formatMessage('fooMessage', 'string', {'baz', 'qux'}) would return "Foo qux bar baz." |
| -- For example, if the message "foo-message" had the value 'Foo $2 bar $1.', | |
| -- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz." | |
| --]] | | --]] |
| local msg = cfg[cfgKey] | | local msg = cfg[cfgKey] |
| expectType = expectType or 'string' | | if expectType and type(msg) ~= expectType then |
| if type(msg) ~= expectType then
| | error('formatMessage: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2) |
| error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2) | |
| end | | end |
| if not valArray then | | if not valArray then |
Line 40: |
Line 40: |
| 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('formatMessage: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) |
| end | | end |
|
| |
|
| return ugsub(msg, '$([1-9][0-9]*)', getMessageVal) | | local ret = gsub(msg, '$([1-9][0-9]*)', getMessageVal) |
| | return ret |
| end | | end |
|
| |
| p.message = message
| |
|
| |
|
| local function makeWikilink(page, display) | | local function makeWikilink(page, display) |
Line 55: |
Line 54: |
| end | | end |
| end | | end |
|
| |
| p.makeWikilink = makeWikilink
| |
|
| |
|
| local function makeCategoryLink(cat, sort) | | local function makeCategoryLink(cat, sort) |
| local catns = mw.site.namespaces[14].name | | local catns = mw.site.namespaces[14].name |
| return makeWikilink(catns .. ':' .. cat, sort) | | return makeWikilink(catns .. '/' .. cat, sort) |
| end | | end |
|
| |
| p.makeCategoryLink = makeCategoryLink
| |
|
| |
|
| local function makeUrlLink(url, display) | | local function makeUrlLink(url, display) |
| return mw.ustring.format('[%s %s]', url, display) | | return mw.ustring.format('[%s %s]', url, display) |
| end | | end |
|
| |
| p.makeUrlLink = makeUrlLink
| |
|
| |
|
| local function makeToolbar(...) | | local function makeToolbar(...) |
Line 80: |
Line 73: |
| ret[#ret + 1] = select(i, ...) | | ret[#ret + 1] = select(i, ...) |
| end | | end |
| -- 'documentation-toolbar'
| | return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>' |
| return '<span class="' .. message('toolbar-class') .. '">(' | |
| .. table.concat(ret, ' | ') .. ')</span>'
| |
| end | | end |
|
| |
| p.makeToolbar = makeToolbar
| |
|
| |
|
| ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
Line 93: |
Line 82: |
| local function makeInvokeFunc(funcName) | | local function makeInvokeFunc(funcName) |
| return function (frame) | | return function (frame) |
| | local headingArg = formatMessage('headingArg', 'string') |
| local args = getArgs(frame, { | | local args = getArgs(frame, { |
| valueFunc = function (key, value) | | valueFunc = function (key, value) |
| if type(value) == 'string' then | | if type(value) == 'string' then |
| value = value:match('^%s*(.-)%s*$') -- Remove whitespace. | | value = value:match('^%s*(.-)%s*$') -- Remove whitespace. |
| if key == 'heading' or value ~= '' then | | if key == headingArg or value ~= '' then |
| return value | | return value |
| else | | else |
Line 112: |
Line 102: |
|
| |
|
| ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
| -- Entry points | | -- Main functions |
| ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
|
| |
| 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') |
|
| |
|
| function p._main(args) | | function p._main(args) |
| --[[
| | local root = htmlBuilder.create() |
| -- This function defines logic flow for the module.
| |
| -- @args - table of arguments passed by the user
| |
| --]]
| |
| local env = p.getEnvironment(args)
| |
| local root = mw.html.create() | |
| root | | root |
| :tag('div') | | .wikitext(p.protectionTemplate()) |
| -- 'documentation-container'
| | .wikitext(p.sandboxNotice(args)) |
| :addClass(message('container'))
| | -- This div tag is from {{documentation/start box}}, but moving it here |
| :attr('role', 'complementary') | | -- so that we don't have to worry about unclosed tags. |
| :attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)
| | .tag('div') |
| :attr('aria-label', args.heading == '' and 'Documentation' or nil) | | .attr('id', formatMessage('mainDivId', 'string')) |
| :newline() | | .addClass(formatMessage('mainDivClasses', 'string')) |
| :tag('div') | | .newline() |
| -- 'documentation'
| | .wikitext(p._startBox(args)) |
| :addClass(message('main-div-classes'))
| | .wikitext(p._content(args)) |
| :newline()
| | .tag('div') |
| :wikitext(p._startBox(args, env))
| | .css('clear', 'both') -- So right or left floating items don't stick out of the doc box. |
| :wikitext(p._content(args, env))
| | .newline() |
| :tag('div')
| | .done() |
| -- 'documentation-clear'
| | .done() |
| :addClass(message('clear'))
| | .wikitext(p._endBox(args)) |
| :done()
| | .newline() |
| :newline() | | .wikitext(p.addTrackingCategories()) |
| :done()
| | return tostring(root) |
| :wikitext(p._endBox(args, env))
| |
| :done()
| |
| :wikitext(p.addTrackingCategories(env)) | |
| -- 'Module:Documentation/styles.css'
| |
| return mw.getCurrentFrame():extensionTag ( | |
| 'templatestyles', '', {src=cfg['templatestyles']
| |
| }) .. tostring(root)
| |
| end | | end |
|
| |
|
| ----------------------------------------------------------------------------
| | function p.sandboxNotice(args) |
| -- Environment settings
| | local sandboxNoticeTemplate = formatMessage('sandboxNoticeTemplate', 'string') |
| ----------------------------------------------------------------------------
| | if not (sandboxNoticeTemplate and currentTitle.subpageText == formatMessage('sandboxSubpage', 'string')) then |
| | | return nil |
| 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
| |
| --
| |
| -- Title objects include:
| |
| -- env.title - the page we are making documentation for (usually the current title)
| |
| -- env.templateTitle - the template (or module, file, etc.)
| |
| -- env.docTitle - the /doc subpage.
| |
| -- env.sandboxTitle - the /sandbox subpage.
| |
| -- env.testcasesTitle - the /testcases subpage.
| |
| --
| |
| -- Data includes:
| |
| -- env.subjectSpace - the number of the title's subject namespace.
| |
| -- env.docSpace - the number of the namespace the title puts its documentation in.
| |
| -- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
| |
| -- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
| |
| --
| |
| -- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
| |
| -- returned will be nil.
| |
| --]]
| |
|
| |
| local env, envFuncs = {}, {}
| |
| | |
| -- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
| |
| -- returned by that function is memoized in the env table so that we don't call any of the functions
| |
| -- more than once. (Nils won't be memoized.)
| |
| setmetatable(env, { | |
| __index = function (t, key)
| |
| local envFunc = envFuncs[key]
| |
| if envFunc then
| |
| local success, val = pcall(envFunc)
| |
| if success then
| |
| env[key] = val -- Memoise the value.
| |
| return val
| |
| end
| |
| end
| |
| return nil
| |
| end
| |
| })
| |
| | |
| function envFuncs.title()
| |
| -- The title object for the current page, or a test page passed with args.page.
| |
| local title
| |
| local titleArg = args.page
| |
| if titleArg then
| |
| title = mw.title.new(titleArg)
| |
| else
| |
| title = mw.title.getCurrentTitle()
| |
| end
| |
| return title | |
| end | | end |
| | local frame = mw.getCurrentFrame() |
| | local notice = htmlBuilder.create() |
| | notice |
| | .tag('div') |
| | .css('clear', 'both') |
| | .done() |
| | .wikitext(frame:expandTemplate{title = sandboxNoticeTemplate, args = {[formatMessage('sandboxNoticeLivepageParam')] = args[formatMessage('livepageArg', 'string')]}}) |
| | return tostring(notice) |
| | end |
|
| |
|
| function envFuncs.templateTitle()
| | function p.protectionTemplate() |
| --[[
| | local protectionTemplate = formatMessage('protectionTemplate', 'string') |
| -- The template (or module, etc.) title object.
| | if not (protectionTemplate and currentTitle.namespace == 10) then |
| -- Messages:
| | -- Don't display the protection template if we are not in the template namespace. |
| -- 'sandbox-subpage' --> 'sandbox'
| | return nil |
| -- 'testcases-subpage' --> 'testcases'
| |
| --]]
| |
| local subjectSpace = env.subjectSpace
| |
| local title = env.title
| |
| local subpage = title.subpageText
| |
| if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then | |
| return mw.title.makeTitle(subjectSpace, title.baseText)
| |
| else | |
| return mw.title.makeTitle(subjectSpace, title.text)
| |
| end
| |
| end | | end |
| | | local frame = mw.getCurrentFrame() |
| function envFuncs.docTitle() | | local function getProtectionLevel(protectionType) |
| --[[ | | -- Gets the protection level for the current page. |
| -- Title object of the /doc subpage.
| | local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType) |
| -- Messages: | | if level ~= '' then |
| -- 'doc-subpage' --> 'doc'
| | return level |
| --]] | |
| local title = env.title
| |
| local docname = args[1] -- User-specified doc page.
| |
| local docpage
| |
| if docname then
| |
| docpage = docname | |
| else | | else |
| docpage = env.docpageBase .. '/' .. message('doc-subpage') | | return nil -- The parser function returns the blank string if there is no match. |
| end | | end |
| return mw.title.new(docpage)
| |
| end | | end |
| | | if getProtectionLevel('move') == 'sysop' or getProtectionLevel('edit') then |
| function envFuncs.sandboxTitle()
| | -- The page is full-move protected, or full, template, or semi-protected. |
| --[[
| | return frame:expandTemplate{title = protectionTemplate, args = formatMessage('protectionTemplateArgs', 'table')} |
| -- Title object for the /sandbox subpage.
| |
| -- Messages:
| |
| -- 'sandbox-subpage' --> 'sandbox'
| |
| --]]
| |
| return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
| |
| end
| |
|
| |
| function envFuncs.testcasesTitle()
| |
| --[[ | |
| -- Title object for the /testcases subpage.
| |
| -- Messages: | |
| -- 'testcases-subpage' --> 'testcases'
| |
| --]]
| |
| return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
| |
| end | | end |
| | return nil |
| | end |
|
| |
|
| | p.startBox = makeInvokeFunc('_startBox') |
|
| |
|
| function envFuncs.subjectSpace()
| | function p._startBox(args) |
| -- The subject namespace number.
| | -- Arg processing from {{documentation}}. |
| return mw.site.namespaces[env.title.namespace].subject.id
| | local preload = args[formatMessage('preloadArg', 'string')] -- Allow custom preloads. |
| end | | local heading = args[formatMessage('headingArg', 'string')] -- Blank values are not removed. |
| | | local headingStyle = args[formatMessage('headingStyleArg', 'string')] |
| function envFuncs.docSpace()
| | local content = args[formatMessage('contentArg', 'string')] |
| -- The documentation namespace number. For most namespaces this is the
| | local docspace = p.docspace() |
| -- same as the subject namespace. However, pages in the Article, File,
| | local docname = args[1] -- Other docname, if fed. |
| -- MediaWiki or Category namespaces must have their /doc, /sandbox and
| | local templatePage = p.templatePage() |
| -- /testcases pages in talk space.
| |
| local subjectSpace = env.subjectSpace
| |
| if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
| |
| return subjectSpace + 1
| |
| else
| |
| return subjectSpace
| |
| end
| |
| end | |
|
| |
|
| function envFuncs.docpageBase() | | -- Arg processing from {{documentation/start box2}}. |
| -- The base page of the /doc, /sandbox, and /testcases subpages.
| | local docpage |
| -- For some namespaces this is the talk page, rather than the template page. | | if docname then |
| local templateTitle = env.templateTitle | | docpage = docname |
| local docSpace = env.docSpace | | else |
| local docSpaceText = mw.site.namespaces[docSpace].name | | local namespace = docspace or currentTitle.nsText |
| -- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
| | local pagename = templatePage or currentTitle.text |
| return docSpaceText .. ':' .. templateTitle.text
| | docpage = namespace .. ':' .. pagename .. '/' .. formatMessage('docSubpage', 'string') |
| end | | end |
| | local docTitle = mw.title.new(docpage) |
| | local docExist = docTitle.exists |
| | | |
| function envFuncs.compareUrl() | | -- Output from {{documentation/start box}}. |
| -- Diff link between the sandbox and the main template using [[Special:ComparePages]].
| |
| local templateTitle = env.templateTitle
| |
| local sandboxTitle = env.sandboxTitle
| |
| if templateTitle.exists and sandboxTitle.exists then
| |
| local compareUrl = mw.uri.fullUrl(
| |
| 'Special:ComparePages',
| |
| { page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
| |
| )
| |
| return tostring(compareUrl)
| |
| else
| |
| return nil
| |
| end
| |
| end
| |
|
| |
|
| return env | | -- First, check the heading parameter. |
| end
| | if heading == '' then |
| | | -- Heading is defined but blank, so do nothing. |
| ----------------------------------------------------------------------------
| |
| -- Start box
| |
| ----------------------------------------------------------------------------
| |
| | |
| p.startBox = makeInvokeFunc('_startBox')
| |
| | |
| function p._startBox(args, env)
| |
| --[[
| |
| -- This function generates the start box.
| |
| -- @args - a table of arguments passed by the user | |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| --
| |
| -- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
| |
| -- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
| |
| -- which generate the box HTML.
| |
| --]]
| |
| env = env or p.getEnvironment(args)
| |
| local links
| |
| local content = args.content
| |
| if not content or args[1] then
| |
| -- No need to include the links if the documentation is on the template page itself. | |
| local linksData = p.makeStartBoxLinksData(args, env)
| |
| if linksData then
| |
| links = p.renderStartBoxLinks(linksData)
| |
| end
| |
| end
| |
| -- Generate the start box html.
| |
| local data = p.makeStartBoxData(args, env, links)
| |
| if data then
| |
| return p.renderStartBox(data)
| |
| else
| |
| -- User specified no heading.
| |
| return nil | | return nil |
| end | | end |
| end
| |
|
| |
|
| function p.makeStartBoxLinksData(args, env)
| | -- Build the start box div. |
| --[[ | | local sbox = htmlBuilder.create('div') |
| -- Does initial processing of data to make the [view] [edit] [history] [purge] links.
| | sbox |
| -- @args - a table of arguments passed by the user | | .css('padding-bottom', '3px') |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| | .css('border-bottom', '1px solid #aaa') |
| --
| | .css('margin-bottom', '1ex') |
| -- Messages:
| | .newline() |
| -- 'view-link-display' --> 'view'
| |
| -- 'edit-link-display' --> 'edit' | |
| -- 'history-link-display' --> 'history'
| |
| -- 'purge-link-display' --> 'purge'
| |
| -- 'module-preload' --> 'Template:Documentation/preload-module-doc'
| |
| -- 'docpage-preload' --> 'Template:Documentation/preload'
| |
| -- 'create-link-display' --> 'create'
| |
| --]]
| |
| local subjectSpace = env.subjectSpace
| |
| local title = env.title
| |
| local docTitle = env.docTitle
| |
| if not title or not docTitle then
| |
| return nil
| |
| end
| |
| if docTitle.isRedirect then
| |
| docTitle = docTitle.redirectTarget | |
| end
| |
|
| |
|
| local data = {}
| | -- Make the heading. |
| data.title = title
| | local hspan = sbox.tag('span') |
| data.docTitle = docTitle
| | if headingStyle then |
| -- View, display, edit, and purge links if /doc exists. | | hspan.cssText(headingStyle) |
| data.viewLinkDisplay = message('view-link-display') | | elseif subjectSpace == 10 then |
| data.editLinkDisplay = message('edit-link-display')
| | -- We are in the template or template talk namespaces. |
| data.historyLinkDisplay = message('history-link-display') | | hspan |
| data.purgeLinkDisplay = message('purge-link-display')
| | .css('font-weight', 'bold') |
| -- Create link if /doc doesn't exist. | | .css('fond-size', '125%') |
| local preload = args.preload
| |
| if not preload then
| |
| if subjectSpace == 828 then -- Module namespace
| |
| preload = message('module-preload')
| |
| else | |
| preload = message('docpage-preload')
| |
| end
| |
| end
| |
| data.preload = preload
| |
| data.createLinkDisplay = message('create-link-display')
| |
| return data
| |
| end
| |
| | |
| function p.renderStartBoxLinks(data)
| |
| --[[
| |
| -- Generates the [view][edit][history][purge] or [create][purge] links from the data table.
| |
| -- @data - a table of data generated by p.makeStartBoxLinksData
| |
| --]]
| |
|
| |
| local function escapeBrackets(s)
| |
| -- Escapes square brackets with HTML entities.
| |
| s = s:gsub('%[', '[') -- Replace square brackets with HTML entities.
| |
| s = s:gsub('%]', ']')
| |
| return s
| |
| end
| |
| | |
| local ret
| |
| local docTitle = data.docTitle
| |
| local title = data.title
| |
| local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
| |
| if docTitle.exists then
| |
| local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
| |
| local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
| |
| local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
| |
| ret = '[%s] [%s] [%s] [%s]'
| |
| ret = escapeBrackets(ret)
| |
| ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
| |
| else | | else |
| local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) | | hspan.css('font-size', '150%') |
| ret = '[%s] [%s]'
| |
| ret = escapeBrackets(ret)
| |
| ret = mw.ustring.format(ret, createLink, purgeLink)
| |
| end
| |
| return ret
| |
| end
| |
| | |
| function p.makeStartBoxData(args, env, links)
| |
| --[=[
| |
| -- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
| |
| -- @args - a table of arguments passed by the user
| |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| -- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
| |
| --
| |
| -- Messages:
| |
| -- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
| |
| -- 'template-namespace-heading' --> 'Template documentation'
| |
| -- 'module-namespace-heading' --> 'Module documentation'
| |
| -- 'file-namespace-heading' --> 'Summary'
| |
| -- 'other-namespaces-heading' --> 'Documentation'
| |
| -- 'testcases-create-link-display' --> 'create'
| |
| --]=]
| |
| local subjectSpace = env.subjectSpace
| |
| if not subjectSpace then
| |
| -- Default to an "other namespaces" namespace, so that we get at least some output
| |
| -- if an error occurs.
| |
| subjectSpace = 2
| |
| end
| |
| local data = {}
| |
|
| |
| -- Heading
| |
| local heading = args.heading -- Blank values are not removed.
| |
| if heading == '' then
| |
| -- Don't display the start box if the heading arg is defined but blank.
| |
| return nil
| |
| end | | end |
| if heading then | | if heading then |
| data.heading = heading | | -- "heading" has data. |
| | hspan.wikitext(heading) |
| elseif subjectSpace == 10 then -- Template namespace | | elseif subjectSpace == 10 then -- Template namespace |
| data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading') | | hspan.wikitext(formatMessage('documentationIconWikitext', 'string') .. ' ' .. formatMessage('templateNamespaceHeading', 'string')) |
| elseif subjectSpace == 828 then -- Module namespace | | elseif subjectSpace == 828 then -- Module namespace |
| data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') | | hspan.wikitext(formatMessage('documentationIconWikitext', 'string') .. ' ' .. formatMessage('moduleNamespaceHeading', 'string')) |
| elseif subjectSpace == 6 then -- File namespace | | elseif subjectSpace == 6 then -- File namespace |
| data.heading = message('file-namespace-heading') | | hspan.wikitext(formatMessage('fileNamespaceHeading', 'string')) |
| else | | else |
| data.heading = message('other-namespaces-heading') | | hspan.wikitext(formatMessage('otherNamespacesHeading', 'string')) |
| end | | end |
| | | |
| -- Heading CSS | | -- Add the [view][edit][history][purge] or [create] links. |
| local headingStyle = args['heading-style'] | | -- Check for the content parameter first, as we don't need the links if the documentation |
| if headingStyle then
| | -- content is being entered directly onto the template page. |
| data.headingStyleText = headingStyle
| | if not content then |
| else
| | local lspan = sbox.tag('span') -- lspan is short for "link span". |
| -- 'documentation-heading'
| | lspan |
| data.headingClass = message('main-div-heading-class')
| | .addClass(formatMessage('startBoxLinkclasses', 'string')) |
| | .attr('id', formatMessage('startBoxLinkId', 'string')) |
| | if docExist then |
| | local viewLink = makeWikilink(docpage, formatMessage('viewLinkDisplay', 'string')) |
| | local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, formatMessage('editLinkDisplay', 'string')) |
| | local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, formatMessage('historyLinkDisplay', 'string')) |
| | local purgeLink = makeUrlLink(currentTitle:fullUrl{action = 'purge'}, formatMessage('purgeLinkDisplay', 'string')) |
| | local text = '[%s] [%s] [%s] [%s]' |
| | text = text:gsub('%[', '[') -- Replace square brackets with HTML entities. |
| | text = text:gsub('%]', ']') |
| | lspan.wikitext(mw.ustring.format(text, viewLink, editLink, historyLink, purgeLink)) |
| | else |
| | if not preload then |
| | if subjectSpace == 6 then -- File namespace |
| | preload = formatMessage('fileDocpagePreload', 'string') |
| | else |
| | preload = formatMessage('docpagePreload', 'string') |
| | end |
| | end |
| | lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload}, formatMessage('createLinkDisplay', 'string'))) |
| | end |
| end | | end |
|
| |
| -- Data for the [view][edit][history][purge] or [create] links.
| |
| if links then
| |
| -- 'mw-editsection-like plainlinks'
| |
| data.linksClass = message('start-box-link-classes')
| |
| data.links = links
| |
| end
| |
|
| |
| return data
| |
| end
| |
|
| |
|
| function p.renderStartBox(data)
| |
| -- Renders the start box html.
| |
| -- @data - a table of data generated by p.makeStartBoxData.
| |
| local sbox = mw.html.create('div')
| |
| sbox
| |
| -- 'documentation-startbox'
| |
| :addClass(message('start-box-class'))
| |
| :newline()
| |
| :tag('span')
| |
| :addClass(data.headingClass)
| |
| :attr('id', 'documentation-heading')
| |
| :cssText(data.headingStyleText)
| |
| :wikitext(data.heading)
| |
| local links = data.links
| |
| if links then
| |
| sbox:tag('span')
| |
| :addClass(data.linksClass)
| |
| :attr('id', data.linksId)
| |
| :wikitext(links)
| |
| end
| |
| return tostring(sbox) | | return tostring(sbox) |
| end | | end |
|
| |
| ----------------------------------------------------------------------------
| |
| -- Documentation content
| |
| ----------------------------------------------------------------------------
| |
|
| |
|
| p.content = makeInvokeFunc('_content') | | p.content = makeInvokeFunc('_content') |
|
| |
|
| function p._content(args, env) | | function p._content(args) |
| -- Displays the documentation contents | | local content = args[formatMessage('contentArg', 'string')] |
| -- @args - a table of arguments passed by the user
| | if not content then |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| | local docpage = args[1] |
| env = env or p.getEnvironment(args)
| | if docpage and mw.title.new(docpage).exists then |
| local docTitle = env.docTitle | | local frame = mw.getCurrentFrame() |
| local content = args.content
| | content = frame:preprocess('{{ ' .. docpage .. ' }}') |
| if not content and docTitle and docTitle.exists then
| | else |
| content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
| | docpage = p.docspace() .. ':' .. p.templatePage() .. '/' .. formatMessage('docSubpage', 'string') |
| end
| | if mw.title.new(docpage).exists then |
| if mw.site.siteName == "Miraheze Developers Wiki" and args.noexportinstructions ~= "yes" then
| | local frame = mw.getCurrentFrame() |
| local export = mw.getCurrentFrame():expandTemplate{title="How to export"}
| | content = frame:preprocess('{{ ' .. docpage .. ' }}') |
| content = export .. "<br/>" .. (content or '')
| | end |
| | end |
| 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 |
Line 542: |
Line 288: |
| end | | end |
|
| |
|
| p.contentTitle = makeInvokeFunc('_contentTitle') | | p.endBox = makeInvokeFunc('_endBox') |
|
| |
|
| function p._contentTitle(args, env) | | function p._endBox(args) |
| env = env or p.getEnvironment(args) | | -- Argument processing in {{documentation}}. |
| local docTitle = env.docTitle | | local content = args[formatMessage('contentArg', 'string')] |
| if not args.content and docTitle and docTitle.exists then | | local linkBox = args[formatMessage('linkBoxArg', 'string')] -- So "link box=off" works. |
| return docTitle.prefixedText | | local docspace = p.docspace() |
| | local docname = args[1] -- Other docname, if fed. |
| | local templatePage = p.templatePage() |
| | |
| | -- Argument processing in {{documentation/end box2}}. |
| | local docpageRoot = (docspace or currentTitle.nsText) .. ':' .. (templatePage or currentTitle.text) |
| | local docpage |
| | if docname then |
| | docpage = docname |
| else | | else |
| return '' | | docpage = docpageRoot .. '/' .. formatMessage('docSubpage', 'string') |
| end | | end |
| end
| | local docTitle = mw.title.new(docpage) |
| | | local docExist = docTitle.exists |
| ----------------------------------------------------------------------------
| | local docnameFed = args[1] and true |
| -- End box
| | local sandbox = docpageRoot .. '/' .. formatMessage('sandboxSubpage', 'string') |
| ----------------------------------------------------------------------------
| | local testcases = docpageRoot .. '/' .. formatMessage('testcasesSubpage', 'string') |
| | templatePage = currentTitle.nsText .. ':' .. templatePage |
|
| |
|
| p.endBox = makeInvokeFunc('_endBox')
| | -- Output from {{documentation/end box}} |
| | |
| function p._endBox(args, env)
| |
| --[=[ | |
| -- This function generates the end box (also known as the link box).
| |
| -- @args - a table of arguments passed by the user
| |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| --
| |
| --]=]
| |
| | | |
| -- Get environment data. | | -- First, check whether we should output the end box at all. Add the end box by default if the documentation |
| env = env or p.getEnvironment(args)
| | -- exists or if we are in the user, module or template namespaces. |
| local subjectSpace = env.subjectSpace
| | if linkBox == formatMessage('linkBoxOff', 'string') or not (docExist or subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10) then |
| local docTitle = env.docTitle
| |
| if not subjectSpace or not docTitle then
| |
| return nil
| |
| end
| |
|
| |
| -- Check whether we should output the end box at all. Add the end
| |
| -- box by default if the documentation exists or if we are in the
| |
| -- user, module or template namespaces.
| |
| local linkBox = args['link box'] | |
| if linkBox == 'off'
| |
| or not (
| |
| docTitle.exists
| |
| or subjectSpace == 2
| |
| or subjectSpace == 828
| |
| or subjectSpace == 10
| |
| )
| |
| then
| |
| return nil | | return nil |
| end | | end |
|
| |
|
| -- Assemble the link box. | | -- Assemble the arguments for {{fmbox}}. |
| | local fmargs = {} |
| | fmargs[formatMessage('fmboxIdParam', 'string')] = formatMessage('fmboxId', 'string') -- Sets fmargs.id = 'documentation-meta-data' |
| | fmargs[formatMessage('fmboxImageParam', 'string')] = formatMessage('fmboxImageNone', 'string') -- Sets fmargs.image = 'none' |
| | fmargs[formatMessage('fmboxStyleParam', 'string')] = formatMessage('fmboxStyle', 'string') -- Sets fmargs.style = 'background-color: #ecfcf4' |
| | fmargs[formatMessage('fmboxTextstyleParam', 'string')] = formatMessage('fmboxTextstyle', 'string') -- Sets fmargs.textstyle = 'font-style: italic;' |
| | |
| | -- Assemble the fmbox text field. |
| local text = '' | | local text = '' |
| if linkBox then | | if linkBox then |
| | -- Use custom link box content if it is defined. |
| text = text .. linkBox | | text = text .. linkBox |
| else | | else |
| text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." | | if docExist then |
| if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then | | -- /doc exists; link to it. |
| -- We are in the user, template or module namespaces. | | local docLink = makeWikilink(docpage) |
| -- Add sandbox and testcases links. | | local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, formatMessage('editLinkDisplay', 'string')) |
| -- "Editors can experiment in this template's sandbox and testcases pages." | | local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, formatMessage('historyLinkDisplay', 'string')) |
| text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />' | | text = text .. formatMessage('transcludedFromBlurb', 'string', {docLink}) .. ' ' .. makeToolbar(editLink, historyLink) .. '<br />' |
| if not args.content and not args[1] then | | elseif subjectSpace == 828 then |
| -- "Please add categories to the /doc subpage." | | -- /doc does not exist; ask to create it. |
| -- Don't show this message with inline docs or with an explicitly specified doc page,
| | local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = formatMessage('modulePreload', 'string')}, formatMessage('createLinkDisplay', 'string')) |
| -- as then it is unclear where to add the categories. | | text = text .. formatMessage('createModuleDocBlurb', 'string', {createLink}) .. '<br />' |
| text = text .. (p.makeCategoriesBlurb(args, env) or '') | | end |
| | -- Add links to /sandbox and /testcases when appropriate. |
| | if subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10 then |
| | -- We are in the user, module or template namespaces. |
| | local sandboxLinks, testcasesLinks |
| | local pagePossessive = subjectSpace == 828 and formatMessage('modulePossessive', 'string') or formatMessage('templatePossessive', 'string') |
| | local sandboxTitle = mw.title.new(sandbox) |
| | if sandboxTitle.exists then |
| | local sandboxLink = makeWikilink(sandbox, formatMessage('sandboxLinkDisplay', 'string')) |
| | local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, formatMessage('sandboxEditLinkDisplay', 'string')) |
| | local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, formatMessage('compareLinkDisplay', 'string')) |
| | sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink) |
| | else |
| | local sandboxPreload = subjectSpace == 828 and formatMessage('moduleSandboxPreload', 'string') or formatMessage('templateSandboxPreload', 'string') |
| | local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, formatMessage('sandboxCreateLinkDisplay', 'string')) |
| | local mirrorSummary = formatMessage('mirrorEditSummary', 'string', {makeWikilink(templatePage)}) |
| | local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, formatMessage('mirrorLinkDisplay', 'string')) |
| | sandboxLinks = formatMessage('sandboxLinkDisplay', 'string') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink) |
| | end |
| | local testcaseTitle = mw.title.new(testcases) |
| | if testcaseTitle.exists then |
| | local testcasesLink = makeWikilink(testcases, formatMessage('testcasesLinkDisplay', 'string')) |
| | local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'}, formatMessage('testcasesEditLinkDisplay', 'string')) |
| | testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) |
| | else |
| | local testcasesPreload = subjectSpace == 828 and formatMessage('moduleTestcasesPreload', 'string') or formatMessage('templateTestcasesPreload', 'string') |
| | local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload}, formatMessage('testcasesCreateLinkDisplay', 'string')) |
| | testcasesLinks = formatMessage('testcasesLinkDisplay', 'string') .. ' ' .. makeToolbar(testcasesCreateLink) |
| | end |
| | text = text .. formatMessage('experimentBlurb', 'string', {pagePossessive, sandboxLinks, testcasesLinks}) .. '<br />' |
| | -- Show the categories text, but not if "content" fed or "docname fed" since then it is unclear where to add the categories. |
| | if not content and not docnameFed then |
| | local docPathLink = makeWikilink(docpage, formatMessage('docLinkDisplay', 'string')) |
| | text = text .. formatMessage('addCategoriesBlurb', 'string', {docPathLink}) |
| | end |
| | -- Show the "subpages" link. |
| | if subjectSpace ~= 6 then -- Don't show the link in file space. |
| | local pagetype |
| | if subjectSpace == 10 then |
| | pagetype = formatMessage('templatePagetype', 'string') |
| | elseif subjectSpace == 828 then |
| | pagetype = formatMessage('modulePagetype', 'string') |
| | else |
| | pagetype = formatMessage('defaultPagetype', 'string') |
| | end |
| | text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', formatMessage('subpagesLinkDisplay', 'string', {pagetype})) |
| | end |
| | -- Show the "print" link if it exists. |
| | local printPage = templatePage .. '/' .. formatMessage('printSubpage', 'string') |
| | local printTitle = mw.title.new(printPage) |
| | if printTitle.exists then |
| | local printLink = makeWikilink(printPage, formatMessage('printLinkDisplay', 'string')) |
| | text = text .. '<br />' .. formatMessage('printBlurb', 'string', {printLink}) |
| | .. (formatMessage('displayPrintCategory', 'boolean') and makeCategoryLink(formatMessage('printCategory', 'string')) or '') |
| end | | end |
| text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
| |
| end | | end |
| end | | end |
| | | fmargs.text = text |
| 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 '\n' .. tostring(box) | | -- Return the fmbox output. |
| | return messageBox.main('fmbox', fmargs) |
| end | | end |
|
| |
|
| function p.makeDocPageBlurb(args, env) | | function p.addTrackingCategories() |
| --[=[ | | -- Check if {{documentation}} is transcluded on a /doc or /testcases page. |
| -- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
| | local ret = '' |
| -- @args - a table of arguments passed by the user
| | local subpage = currentTitle.subpageText |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| | if formatMessage('displayStrangeUsageCategory', 'boolean') and (subpage == formatMessage('docSubpage', 'string') or subpage == formatMessage('testcasesSubpage', 'string')) then |
| --
| | local sort = (currentTitle.namespace == 0 and formatMessage('strangeUsageCategoryMainspaceSort', 'string') or '') .. currentTitle.prefixedText -- Sort on namespace. |
| -- Messages:
| | ret = ret .. makeCategoryLink(formatMessage('strangeUsageCategory', 'string'), sort) |
| -- 'edit-link-display' --> 'edit'
| |
| -- 'history-link-display' --> 'history'
| |
| -- 'transcluded-from-blurb' -->
| |
| -- 'The above [[Wikipedia:Template documentation|documentation]]
| |
| -- is [[Help: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 [[Wikipedia:Lua|Scribunto module]].'
| |
| --]=] | |
| local docTitle = env.docTitle | |
| if not docTitle then
| |
| return nil
| |
| end
| |
| local ret
| |
| if docTitle.exists then | |
| -- /doc exists; link to it.
| |
| local docLink = makeWikilink(docTitle.prefixedText)
| |
| local editUrl = docTitle:fullUrl{action = 'edit'}
| |
| local editDisplay = message('edit-link-display')
| |
| local editLink = makeUrlLink(editUrl, editDisplay)
| |
| local historyUrl = docTitle:fullUrl{action = 'history'}
| |
| local historyDisplay = message('history-link-display')
| |
| local historyLink = makeUrlLink(historyUrl, historyDisplay) | |
| ret = message('transcluded-from-blurb', {docLink})
| |
| .. ' '
| |
| .. makeToolbar(editLink, historyLink)
| |
| .. '<br />'
| |
| elseif env.subjectSpace == 828 then
| |
| -- /doc does not exist; ask to create it.
| |
| local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')} | |
| local createDisplay = message('create-link-display')
| |
| local createLink = makeUrlLink(createUrl, createDisplay)
| |
| ret = message('create-module-doc-blurb', {createLink})
| |
| .. '<br />'
| |
| end | | end |
| return ret | | return ret |
| end | | end |
|
| |
|
| function p.makeExperimentBlurb(args, env) | | function p.docspace() |
| --[[ | | -- Determines the namespace of the documentation. |
| -- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
| | if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then |
| -- @args - a table of arguments passed by the user
| | -- Pages in the Article, File, MediaWiki or Category namespaces must have their |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| | -- /doc, /sandbox and /testcases pages in talk space. |
| -- | | return mw.site.namespaces[subjectSpace].talk.name |
| -- Messages:
| |
| -- 'sandbox-link-display' --> 'sandbox'
| |
| -- 'sandbox-edit-link-display' --> 'edit'
| |
| -- 'compare-link-display' --> 'diff'
| |
| -- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
| |
| -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
| |
| -- 'sandbox-create-link-display' --> 'create'
| |
| -- 'mirror-edit-summary' --> 'Create sandbox version of $1'
| |
| -- 'mirror-link-display' --> 'mirror'
| |
| -- 'mirror-link-preload' --> 'Template:Documentation/mirror'
| |
| -- 'sandbox-link-display' --> 'sandbox'
| |
| -- 'testcases-link-display' --> 'testcases'
| |
| -- 'testcases-edit-link-display'--> 'edit'
| |
| -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
| |
| -- 'testcases-create-link-display' --> 'create'
| |
| -- 'testcases-link-display' --> 'testcases'
| |
| -- 'testcases-edit-link-display' --> 'edit'
| |
| -- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
| |
| -- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
| |
| -- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
| |
| -- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
| |
| --]]
| |
| local subjectSpace = env.subjectSpace
| |
| local templateTitle = env.templateTitle
| |
| local sandboxTitle = env.sandboxTitle
| |
| local testcasesTitle = env.testcasesTitle
| |
| local templatePage = templateTitle.prefixedText
| |
| if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
| |
| return nil | |
| end
| |
| -- Make links.
| |
| local sandboxLinks, testcasesLinks
| |
| if sandboxTitle.exists then
| |
| local sandboxPage = sandboxTitle.prefixedText
| |
| local sandboxDisplay = message('sandbox-link-display') | |
| local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
| |
| local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
| |
| local sandboxEditDisplay = message('sandbox-edit-link-display')
| |
| local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
| |
| local compareUrl = env.compareUrl
| |
| local compareLink | |
| if compareUrl then
| |
| local compareDisplay = message('compare-link-display')
| |
| compareLink = makeUrlLink(compareUrl, compareDisplay)
| |
| end
| |
| sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
| |
| else | | else |
| local sandboxPreload | | return currentTitle.subjectNsText |
| if subjectSpace == 828 then
| |
| sandboxPreload = message('module-sandbox-preload')
| |
| else
| |
| sandboxPreload = message('template-sandbox-preload')
| |
| end
| |
| local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
| |
| local sandboxCreateDisplay = message('sandbox-create-link-display')
| |
| local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
| |
| local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
| |
| local mirrorPreload = message('mirror-link-preload')
| |
| local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
| |
| if subjectSpace == 828 then
| |
| mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
| |
| end
| |
| local mirrorDisplay = message('mirror-link-display')
| |
| local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
| |
| sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
| |
| end
| |
| if testcasesTitle.exists then
| |
| local testcasesPage = testcasesTitle.prefixedText
| |
| local testcasesDisplay = message('testcases-link-display')
| |
| local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
| |
| local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
| |
| local testcasesEditDisplay = message('testcases-edit-link-display')
| |
| local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
| |
| -- for Modules, add testcases run link if exists
| |
| if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
| |
| local testcasesRunLinkDisplay = message('testcases-run-link-display')
| |
| local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
| |
| testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
| |
| else
| |
| testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
| |
| end
| |
| else
| |
| local testcasesPreload
| |
| if subjectSpace == 828 then
| |
| testcasesPreload = message('module-testcases-preload')
| |
| else
| |
| testcasesPreload = message('template-testcases-preload')
| |
| end
| |
| local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
| |
| local testcasesCreateDisplay = message('testcases-create-link-display')
| |
| local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
| |
| testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
| |
| end
| |
| local messageName
| |
| if subjectSpace == 828 then
| |
| messageName = 'experiment-blurb-module'
| |
| else
| |
| messageName = 'experiment-blurb-template'
| |
| end
| |
| return message(messageName, {sandboxLinks, testcasesLinks})
| |
| end
| |
| | |
| function p.makeCategoriesBlurb(args, env)
| |
| --[[
| |
| -- Generates the text "Please add categories to the /doc subpage."
| |
| -- @args - a table of arguments passed by the user
| |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| -- Messages:
| |
| -- 'doc-link-display' --> '/doc'
| |
| -- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
| |
| --]]
| |
| local docTitle = env.docTitle
| |
| if not docTitle then
| |
| return nil
| |
| end | | end |
| local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
| |
| return message('add-categories-blurb', {docPathLink})
| |
| end | | end |
|
| |
|
| function p.makeSubpagesBlurb(args, env) | | function p.templatePage() |
| --[[ | | -- Determines the template page. No namespace or interwiki prefixes are included. |
| -- Generates the "Subpages of this template" link.
| | local subpage = currentTitle.subpageText |
| -- @args - a table of arguments passed by the user
| | if subpage == formatMessage('sandboxSubpage', 'string') or subpage == formatMessage('testcasesSubpage', 'string') then |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| | return currentTitle.baseText |
|
| |
| -- Messages:
| |
| -- 'template-pagetype' --> 'template'
| |
| -- 'module-pagetype' --> 'module'
| |
| -- 'default-pagetype' --> 'page'
| |
| -- 'subpages-link-display' --> 'Subpages of this $1'
| |
| --]]
| |
| local subjectSpace = env.subjectSpace
| |
| local templateTitle = env.templateTitle | |
| if not subjectSpace or not templateTitle then | |
| return nil
| |
| end
| |
| local pagetype
| |
| if subjectSpace == 10 then
| |
| pagetype = message('template-pagetype')
| |
| elseif subjectSpace == 828 then
| |
| pagetype = message('module-pagetype')
| |
| else | | else |
| pagetype = message('default-pagetype') | | return currentTitle.text |
| end | | end |
| local subpagesLink = makeWikilink(
| |
| 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
| |
| message('subpages-link-display', {pagetype})
| |
| )
| |
| return message('subpages-blurb', {subpagesLink})
| |
| end
| |
|
| |
| ----------------------------------------------------------------------------
| |
| -- Tracking categories
| |
| ----------------------------------------------------------------------------
| |
|
| |
| function p.addTrackingCategories(env)
| |
| --[[
| |
| -- Check if {{documentation}} is transcluded on a /doc or /testcases page.
| |
| -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
|
| |
| -- Messages:
| |
| -- 'display-strange-usage-category' --> true
| |
| -- 'doc-subpage' --> 'doc'
| |
| -- 'testcases-subpage' --> 'testcases'
| |
| -- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
| |
| --
| |
| -- /testcases pages in the module namespace are not categorised, as they may have
| |
| -- {{documentation}} transcluded automatically.
| |
| --]]
| |
| local title = env.title
| |
| local subjectSpace = env.subjectSpace
| |
| if not title or not subjectSpace then
| |
| return nil
| |
| end
| |
| local subpage = title.subpageText
| |
| local ret = ''
| |
| if message('display-strange-usage-category', nil, 'boolean')
| |
| and (
| |
| subpage == message('doc-subpage')
| |
| or subjectSpace ~= 828 and subpage == message('testcases-subpage')
| |
| )
| |
| then
| |
| ret = ret .. makeCategoryLink(message('strange-usage-category'))
| |
| end
| |
| return ret
| |
| end | | end |
|
| |
|
| return p | | return p |