| 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') |
| − |
| |
| − | -- Get the config table.
| |
| − | local cfg = mw.loadData('Module:Documentation/config')
| |
| | | | |
| | local p = {} | | local p = {} |
| | | | |
| − | -- Often-used functions. | + | -- Constants. |
| − | local ugsub = mw.ustring.gsub | + | local currentTitle = mw.title.getCurrentTitle() |
| | + | local subjectSpace = mw.site.namespaces[currentTitle.namespace].subject.id |
| | | | |
| | ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
| | -- 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)
| |
| − | --[[
| |
| − | -- Gets a message from the cfg table and formats it if appropriate.
| |
| − | -- The function raises an error if the value from the cfg table is not
| |
| − | -- of the type expectType. The default type for expectType is 'string'.
| |
| − | -- If the table valArray is present, strings such as $1, $2 etc. in the
| |
| − | -- message are substituted with values from the table keys [1], [2] etc.
| |
| − | -- 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]
| |
| − | expectType = expectType or 'string'
| |
| − | if type(msg) ~= expectType then
| |
| − | error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
| |
| − | end
| |
| − | if not valArray then
| |
| − | return msg
| |
| − | end
| |
| − |
| |
| − | local function getMessageVal(match)
| |
| − | match = tonumber(match)
| |
| − | return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
| |
| − | end
| |
| − |
| |
| − | local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
| |
| − | return ret
| |
| − | end
| |
| − |
| |
| − | p.message = message
| |
| | | | |
| | local function makeWikilink(page, display) | | local function makeWikilink(page, display) |
| Line 57: |
Line 23: |
| | end | | end |
| | end | | end |
| − |
| |
| − | p.makeWikilink = makeWikilink
| |
| − |
| |
| − | local function makeCategoryLink(cat, sort)
| |
| − | local catns = mw.site.namespaces[14].name
| |
| − | return makeWikilink(catns .. ':' .. cat, sort)
| |
| − | 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 84: |
Line 39: |
| | return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>' | | return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>' |
| | end | | end |
| − |
| |
| − | p.makeToolbar = makeToolbar
| |
| | | | |
| | ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
| Line 112: |
Line 65: |
| | | | |
| | ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
| − | -- Main function | + | -- Main functions |
| | ---------------------------------------------------------------------------- | | ---------------------------------------------------------------------------- |
| | | | |
| Line 118: |
Line 71: |
| | | | |
| | 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
| |
| − | --
| |
| − | -- Messages:
| |
| − | -- 'main-div-id' --> 'template-documentation'
| |
| − | -- 'main-div-classes' --> 'template-documentation iezoomfix'
| |
| − | --]]
| |
| − | local env = p.getEnvironment(args)
| |
| − | local root = mw.html.create() | |
| | root | | root |
| − | :wikitext(p.protectionTemplate(env)) | + | .wikitext(p.protectionTemplate()) |
| − | :wikitext(p.sandboxNotice(args, env)) | + | .wikitext(p.sandboxNotice(args)) |
| | -- 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') | + | .tag('div') |
| − | :attr('id', message('main-div-id')) | + | .attr('id', 'template-documentation') |
| − | :addClass(message('main-div-classes')) | + | .addClass('template-documentation iezoomfix') |
| − | :newline() | + | .wikitext(p._startBox(args)) |
| − | :wikitext(p._startBox(args, env))
| + | .wikitext(p._content(args)) |
| − | :wikitext(p._content(args, env)) | + | .tag('div') |
| − | :tag('div') | + | .css('clear', 'both') -- So right or left floating items don't stick out of the doc box. |
| − | :css('clear', 'both') -- So right or left floating items don't stick out of the doc box. | + | .done() |
| − | :newline() | + | .done() |
| − | :done()
| + | .wikitext(p._endBox(args)) |
| − | :done() | + | .wikitext(p.addTrackingCategories()) |
| − | :wikitext(p._endBox(args, env)) | |
| − | :wikitext(p.addTrackingCategories(env)) | |
| | return tostring(root) | | return tostring(root) |
| | end | | end |
| | | | |
| − | ----------------------------------------------------------------------------
| + | function p.sandboxNotice(args) |
| − | -- Environment settings
| + | if currentTitle.subpageText == 'sandbox' then |
| − | ----------------------------------------------------------------------------
| + | local frame = mw.getCurrentFrame() |
| | + | local root = htmlBuilder.create() |
| | + | root |
| | + | .tag('div') |
| | + | .css('clear', 'both') |
| | + | .done() |
| | + | .wikitext(frame:expandTemplate{title = 'template sandbox notice', args = {args.livepage}}) |
| | + | return tostring(root) |
| | + | else |
| | + | return nil |
| | + | end |
| | + | end |
| | | | |
| − | function p.getEnvironment(args) | + | function p.protectionTemplate() |
| − | --[[ | + | if currentTitle.namespace == 10 then -- We are in the template namespace. |
| − | -- Returns a table with information about the environment, including title objects and other namespace- or
| + | local frame = mw.getCurrentFrame() |
| − | -- 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.
| |
| − | -- env.printTitle - the print version of the template, located at the /Print subpage.
| |
| − | --
| |
| − | -- Data includes:
| |
| − | -- env.protectionLevels - the protection levels table of the title object.
| |
| − | -- 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
| + | local function getProtectionLevel(protectionType) |
| − | -- returned by that function is memoized in the env table so that we don't call any of the functions
| + | -- Gets the protection level for the current page. |
| − | -- more than once. (Nils won't be memoized.)
| + | local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType) |
| − | setmetatable(env, {
| + | if level ~= '' then |
| − | __index = function (t, key)
| + | return level |
| − | local envFunc = envFuncs[key] | + | else |
| − | if envFunc then
| + | return nil -- The parser function returns the blank string if there is no match. |
| − | local success, val = pcall(envFunc) | |
| − | if success then | |
| − | env[key] = val -- Memoise the value.
| |
| − | return val
| |
| − | end
| |
| | 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
| |
| − |
| |
| − | function envFuncs.templateTitle()
| |
| − | --[[
| |
| − | -- The template (or module, etc.) title object.
| |
| − | -- Messages:
| |
| − | -- 'sandbox-subpage' --> 'sandbox'
| |
| − | -- '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
| |
| − |
| |
| − | function envFuncs.docTitle()
| |
| − | --[[
| |
| − | -- Title object of the /doc subpage.
| |
| − | -- Messages:
| |
| − | -- 'doc-subpage' --> 'doc'
| |
| − | --]]
| |
| − | local title = env.title
| |
| − | local docname = args[1] -- User-specified doc page.
| |
| − | local docpage
| |
| − | if docname then
| |
| − | docpage = docname
| |
| − | else
| |
| − | docpage = env.docpageBase .. '/' .. message('doc-subpage')
| |
| − | end
| |
| − | return mw.title.new(docpage)
| |
| − | end
| |
| − |
| |
| − | function envFuncs.sandboxTitle()
| |
| − | --[[
| |
| − | -- 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
| |
| − |
| |
| − | function envFuncs.printTitle()
| |
| − | --[[
| |
| − | -- Title object for the /Print subpage.
| |
| − | -- Messages:
| |
| − | -- 'print-subpage' --> 'Print'
| |
| − | --]]
| |
| − | return env.templateTitle:subPageTitle(message('print-subpage'))
| |
| − | end
| |
| − |
| |
| − | function envFuncs.protectionLevels()
| |
| − | -- The protection levels table of the title object.
| |
| − | return env.title.protectionLevels
| |
| − | end
| |
| − |
| |
| − | function envFuncs.subjectSpace()
| |
| − | -- The subject namespace number.
| |
| − | return mw.site.namespaces[env.title.namespace].subject.id
| |
| − | end
| |
| − |
| |
| − | function envFuncs.docSpace()
| |
| − | -- The documentation namespace number. For most namespaces this is the 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
| |
| − | return subjectSpace + 1
| |
| − | else
| |
| − | return subjectSpace
| |
| | end | | end |
| − | end
| |
| | | | |
| − | function envFuncs.docpageBase()
| + | if getProtectionLevel('move') == 'sysop' or getProtectionLevel('edit') then |
| − | -- The base page of the /doc, /sandbox, and /testcases subpages.
| + | -- The page is full-move protected, or full, template, or semi-protected. |
| − | -- For some namespaces this is the talk page, rather than the template page.
| + | return frame:expandTemplate{title = 'pp-template', args = {docusage = 'yes'}} |
| − | local templateTitle = env.templateTitle
| |
| − | local docSpace = env.docSpace
| |
| − | local docSpaceText = mw.site.namespaces[docSpace].name
| |
| − | -- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
| |
| − | return docSpaceText .. ':' .. templateTitle.text
| |
| − | end
| |
| − |
| |
| − | function envFuncs.compareUrl()
| |
| − | -- 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 |
| − | end
| |
| − |
| |
| − | return env
| |
| − | end
| |
| − |
| |
| − | ----------------------------------------------------------------------------
| |
| − | -- Auxiliary templates
| |
| − | ----------------------------------------------------------------------------
| |
| − |
| |
| − | function p.sandboxNotice(args, env)
| |
| − | --[=[
| |
| − | -- Generates a sandbox notice for display above sandbox pages.
| |
| − | -- @args - a table of arguments passed by the user
| |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| − | --
| |
| − | -- Messages:
| |
| − | -- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
| |
| − | -- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
| |
| − | -- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
| |
| − | -- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
| |
| − | -- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
| |
| − | -- 'sandbox-notice-pagetype-other' --> 'sandbox page'
| |
| − | -- 'sandbox-notice-compare-link-display' --> 'diff'
| |
| − | -- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
| |
| − | -- 'sandbox-notice-testcases-link-display' --> 'test cases'
| |
| − | -- 'sandbox-category' --> 'Template sandboxes'
| |
| − | --]=]
| |
| − | local title = env.title
| |
| − | local sandboxTitle = env.sandboxTitle
| |
| − | 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 |
| − | -- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
| + | return nil |
| − | local omargs = {}
| |
| − | omargs.image = message('sandbox-notice-image')
| |
| − | -- Get the text. We start with the opening blurb, which is something like
| |
| − | -- "This is the template sandbox for [[Template:Foo]] (diff)."
| |
| − | local text = ''
| |
| − | local pagetype
| |
| − | if subjectSpace == 10 then
| |
| − | pagetype = message('sandbox-notice-pagetype-template')
| |
| − | elseif subjectSpace == 828 then
| |
| − | pagetype = message('sandbox-notice-pagetype-module')
| |
| − | else
| |
| − | pagetype = message('sandbox-notice-pagetype-other')
| |
| − | end
| |
| − | local templateLink = makeWikilink(templateTitle.prefixedText)
| |
| − | local compareUrl = env.compareUrl
| |
| − | if compareUrl then
| |
| − | local compareDisplay = message('sandbox-notice-compare-link-display')
| |
| − | local compareLink = makeUrlLink(compareUrl, compareDisplay)
| |
| − | text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
| |
| − | else
| |
| − | text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
| |
| − | end
| |
| − | -- Get the test cases page blurb if the page exists. This is something like
| |
| − | -- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
| |
| − | local testcasesTitle = env.testcasesTitle
| |
| − | if testcasesTitle and testcasesTitle.exists then
| |
| − | if testcasesTitle.namespace == mw.site.namespaces.Module.id then
| |
| − | local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
| |
| − | local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
| |
| − | local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
| |
| − | local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
| |
| − | text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
| |
| − | else
| |
| − | local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
| |
| − | local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
| |
| − | text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
| |
| − | end
| |
| − | end
| |
| − | -- Add the sandbox to the sandbox category.
| |
| − | text = text .. makeCategoryLink(message('sandbox-category'))
| |
| − | omargs.text = text
| |
| − | local ret = '<div style="clear: both;"></div>'
| |
| − | ret = ret .. messageBox.main('ombox', omargs)
| |
| − | return ret | |
| | end | | end |
| − |
| |
| − | function p.protectionTemplate(env)
| |
| − | -- Generates the padlock icon in the top right.
| |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| − | -- Messages:
| |
| − | -- '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
| |
| − | end
| |
| − | local editProt = protectionLevels.edit and protectionLevels.edit[1]
| |
| − | local moveProt = protectionLevels.move and protectionLevels.move[1]
| |
| − | if editProt then
| |
| − | -- The page is edit-protected.
| |
| − | mProtectionBanner = require('Module:Protection banner')
| |
| − | 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 = require('Module:Protection banner')
| |
| − | return mProtectionBanner._main{action = 'move', small = true}
| |
| − | else
| |
| − | return nil
| |
| − | end
| |
| − | end
| |
| − |
| |
| − | ----------------------------------------------------------------------------
| |
| − | -- Start box
| |
| − | ----------------------------------------------------------------------------
| |
| | | | |
| | p.startBox = makeInvokeFunc('_startBox') | | p.startBox = makeInvokeFunc('_startBox') |
| | | | |
| − | function p._startBox(args, env) | + | function p._startBox(args) |
| − | --[[ | + | -- Arg processing from {{documentation}}. |
| − | -- This function generates the start box.
| + | local preload = args.preload -- Allow custom preloads. |
| − | -- @args - a table of arguments passed by the user | + | local heading = args.heading -- Blank values are not removed. |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| + | local headingStyle = args['heading-style'] |
| − | --
| |
| − | -- 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 | | local content = args.content |
| − | if not content then | + | local docspace = p.docspace() |
| − | -- No need to include the links if the documentation is on the template page itself.
| + | local docname = args[1] -- Other docname, if fed. |
| − | local linksData = p.makeStartBoxLinksData(args, env)
| + | local templatePage = p.templatePage() |
| − | if linksData then
| + | |
| − | links = p.renderStartBoxLinks(linksData)
| + | -- Arg processing from {{documentation/start box2}}. |
| − | end
| + | local docpage |
| − | end
| + | if docname then |
| − | -- Generate the start box html. | + | docpage = docname |
| − | local data = p.makeStartBoxData(args, env, links) | |
| − | if data then | |
| − | return p.renderStartBox(data) | |
| | else | | else |
| − | -- User specified no heading. | + | local namespace = docspace or currentTitle.nsText |
| − | return nil | + | local pagename = templatePage or currentTitle.text |
| | + | docpage = namespace .. ':' .. pagename .. '/doc' |
| | end | | end |
| − | end
| + | local docTitle = mw.title.new(docpage) |
| | + | local docExist = docTitle.exists |
| | + | |
| | + | -- Output from {{documentation/start box}}. |
| | | | |
| − | function p.makeStartBoxLinksData(args, env)
| + | -- First, check the heading parameter. |
| − | --[[ | + | if heading == '' then |
| − | -- Does initial processing of data to make the [view] [edit] [history] [purge] links.
| + | -- Heading is defined but blank, so do nothing. |
| − | -- @args - a table of arguments passed by the user | |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| − | --
| |
| − | -- Messages:
| |
| − | -- 'view-link-display' --> 'view'
| |
| − | -- 'edit-link-display' --> 'edit'
| |
| − | -- 'history-link-display' --> 'history'
| |
| − | -- 'purge-link-display' --> 'purge'
| |
| − | -- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
| |
| − | -- '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 | | return nil |
| | end | | end |
| | | | |
| − | local data = {}
| + | -- Build the start box div. |
| − | data.title = title
| + | local sbox = htmlBuilder.create('div') |
| − | data.docTitle = docTitle
| + | sbox |
| − | -- View, display, edit, and purge links if /doc exists. | + | .css('padding-bottom', '3px') |
| − | data.viewLinkDisplay = message('view-link-display') | + | .css('border-bottom', '1px solid #aaa') |
| − | data.editLinkDisplay = message('edit-link-display') | + | .css('margin-bottom', '1ex') |
| − | data.historyLinkDisplay = message('history-link-display')
| |
| − | data.purgeLinkDisplay = message('purge-link-display')
| |
| − | -- Create link if /doc doesn't exist.
| |
| − | local preload = args.preload
| |
| − | if not preload then
| |
| − | if subjectSpace == 6 then -- File namespace
| |
| − | preload = message('file-docpage-preload')
| |
| − | elseif 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)
| + | -- Make the heading. |
| − | --[[
| + | local hspan = sbox.tag('span') |
| − | -- Generates the [view][edit][history][purge] or [create] links from the data table. | + | if headingStyle then |
| − | -- @data - a table of data generated by p.makeStartBoxLinksData
| + | hspan.cssText(headingStyle) |
| − | --]]
| + | elseif subjectSpace == 10 then |
| − |
| + | -- We are in the template or template talk namespaces. |
| − | local function escapeBrackets(s) | + | hspan |
| − | -- Escapes square brackets with HTML entities.
| + | .css('font-weight', 'bold') |
| − | s = s:gsub('%[', '[') -- Replace square brackets with HTML entities.
| + | .css('fond-size', '125%') |
| − | s = s:gsub('%]', ']') | |
| − | return s
| |
| − | end | |
| − | | |
| − | local ret
| |
| − | local docTitle = data.docTitle
| |
| − | local title = data.title
| |
| − | 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)
| |
| − | local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
| |
| − | 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]'
| |
| − | ret = escapeBrackets(ret)
| |
| − | ret = mw.ustring.format(ret, createLink)
| |
| − | 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'
| |
| − | -- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
| |
| − | -- 'start-box-link-id' --> 'doc_editlinks'
| |
| − | -- '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('[[File:Template-info.png|50px|link=|alt=Documentation icon]] Template documentation') |
| | elseif subjectSpace == 828 then -- Module namespace | | elseif subjectSpace == 828 then -- Module namespace |
| − | data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') | + | hspan.wikitext('[[File:Template-info.png|50px|link=|alt=Documentation icon]] Module documentation') |
| | elseif subjectSpace == 6 then -- File namespace | | elseif subjectSpace == 6 then -- File namespace |
| − | data.heading = message('file-namespace-heading') | + | hspan.wikitext('Summary') |
| | else | | else |
| − | data.heading = message('other-namespaces-heading') | + | hspan.wikitext('Documentation') |
| | 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 |
| − | elseif subjectSpace == 10 then
| + | local lspan = sbox.tag('span') -- lspan is short for "link span". |
| − | -- We are in the template or template talk namespaces.
| + | lspan |
| − | data.headingFontWeight = 'bold'
| + | .addClass('mw-editsection plainlinks') |
| − | data.headingFontSize = '125%' | + | .attr('id', 'doc_editlinks') |
| − | else
| + | if docExist then |
| − | data.headingFontSize = '150%'
| + | local viewLink = makeWikilink(docpage, 'view') |
| | + | local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, 'edit') |
| | + | local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, 'history') |
| | + | local purgeLink = makeUrlLink(docTitle:fullUrl{action = 'purge'}, 'purge') |
| | + | 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 = 'Template:Documentation/preload-filespace' |
| | + | else |
| | + | preload = 'Template:Documentation/preload' |
| | + | end |
| | + | end |
| | + | lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload}, 'create')) |
| | + | end |
| | end | | end |
| − |
| |
| − | -- Data for the [view][edit][history][purge] or [create] links.
| |
| − | if links then
| |
| − | data.linksClass = message('start-box-linkclasses')
| |
| − | data.linksId = message('start-box-link-id')
| |
| − | 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
| |
| − | :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
| |
| − | 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
| |
| − | -- @args - a table of arguments passed by the user
| |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| − | env = env or p.getEnvironment(args)
| |
| − | local docTitle = env.docTitle
| |
| | local content = args.content | | local content = args.content |
| − | if not content and docTitle and docTitle.exists then | + | if not content then |
| − | content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText} | + | local docpage = args[1] |
| | + | if docpage and mw.title.new(docpage).exists then |
| | + | local frame = mw.getCurrentFrame() |
| | + | content = frame:preprocess('{{ ' .. docpage .. ' }}') |
| | + | else |
| | + | docpage = p.docspace() .. ':' .. p.templatePage() .. '/doc' |
| | + | if mw.title.new(docpage).exists then |
| | + | local frame = mw.getCurrentFrame() |
| | + | content = frame:preprocess('{{ ' .. docpage .. ' }}') |
| | + | 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 652: |
Line 246: |
| | end | | end |
| | | | |
| − | p.contentTitle = makeInvokeFunc('_contentTitle') | + | p.endBox = makeInvokeFunc('_endBox') |
| | + | |
| | + | function p._endBox(args) |
| | + | -- Argument processing in {{documentation}}. |
| | + | local preload = args.preload -- Allow custom preloads. |
| | + | local content = args.content |
| | + | local linkBox = args['link box'] -- So "link box=off" works. |
| | + | local docspace = p.docspace() |
| | + | local docname = args[1] -- Other docname, if fed. |
| | + | local templatePage = p.templatePage() |
| | | | |
| − | function p._contentTitle(args, env)
| + | -- Argument processing in {{documentation/end box2}}. |
| − | env = env or p.getEnvironment(args) | + | local docpageRoot = (docspace or currentTitle.nsText) .. ':' .. (templatePage or currentTitle.text) |
| − | local docTitle = env.docTitle | + | local docpage |
| − | if not args.content and docTitle and docTitle.exists then | + | if docname then |
| − | return docTitle.prefixedText | + | docpage = docname |
| | else | | else |
| − | return '' | + | docpage = docpageRoot .. '/doc' |
| | end | | end |
| − | end
| + | local docTitle = mw.title.new(docpage) |
| − | | + | local docExist = docTitle.exists |
| − | ----------------------------------------------------------------------------
| + | local docnameFed = args[1] and true |
| − | -- End box
| + | local sandbox = docpageRoot .. '/sandbox' |
| − | ----------------------------------------------------------------------------
| + | local testcases = docpageRoot .. '/testcases' |
| − | | + | templatePage = currentTitle.nsText .. ':' .. templatePage |
| − | p.endBox = makeInvokeFunc('_endBox')
| |
| | | | |
| − | function p._endBox(args, env)
| + | -- Output from {{documentation/end box}} |
| − | --[=[ | |
| − | -- 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
| |
| − | --
| |
| − | -- 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]].
| |
| − | --]=]
| |
| | | | |
| − | -- 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 == 'off' 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 |
| Line 709: |
Line 282: |
| | -- Assemble the arguments for {{fmbox}}. | | -- Assemble the arguments for {{fmbox}}. |
| | local fmargs = {} | | local fmargs = {} |
| − | fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data' | + | fmargs.id = 'documentation-meta-data' |
| | fmargs.image = 'none' | | fmargs.image = 'none' |
| − | fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4' | + | fmargs.style = 'background-color: #ecfcf4' |
| − | fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;' | + | fmargs.textstyle = 'font-style: italic;' |
| | | | |
| | -- Assemble the fmbox text field. | | -- 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'}, 'edit') |
| − | -- "Editors can experiment in this template's sandbox and testcases pages." | + | local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, 'history') |
| − | text = text .. (p.makeExperimentBlurb(args, env) or '')
| + | text = text .. 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from ' |
| − | text = text .. '<br />' | + | .. 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 = 'Template:Documentation/preload-module-doc'}, 'create') |
| − | -- as then it is unclear where to add the categories. | + | text = text .. 'You might want to ' .. createLink .. ' a documentation page for this [[Wikipedia:Lua|Scribunto module]].<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 pagePossessive = subjectSpace == 828 and "module's" or "template's" |
| | + | text = text .. 'Editors can experiment in this ' .. pagePossessive .. ' ' |
| | + | local sandboxTitle = mw.title.new(sandbox) |
| | + | if sandboxTitle.exists then |
| | + | local sandboxLink = makeWikilink(sandbox, 'sandbox') |
| | + | local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, 'edit') |
| | + | local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, 'diff') |
| | + | text = text .. sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink) |
| | + | else |
| | + | local sandboxPreload = 'Template:Documentation/preload-' .. (subjectSpace == 828 and 'module-' or '') .. 'sandbox' |
| | + | local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, 'create') |
| | + | local mirrorSummary = 'Create sandbox version of ' .. makeWikilink(templatePage) |
| | + | local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, 'mirror') |
| | + | text = text .. 'sandbox ' .. makeToolbar(sandboxCreateLink, mirrorLink) |
| | + | end |
| | + | text = text .. ' and ' |
| | + | local testcaseTitle = mw.title.new(testcases) |
| | + | if testcaseTitle.exists then |
| | + | local testcasesLink = makeWikilink(testcases, 'testcases') |
| | + | local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'}, 'edit') |
| | + | text = text .. testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) |
| | + | else |
| | + | local testcasesPreload = 'Template:Documentation/preload-' .. (subjectSpace == 828 and 'module-' or '') .. 'testcases' |
| | + | local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload}, 'create') |
| | + | text = text .. 'testcases ' .. makeToolbar(testcasesCreateLink) |
| | + | end |
| | + | text = text .. ' pages. <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 |
| | + | text = text .. 'Please add categories to the ' .. makeWikilink(docpage, '/doc') .. ' subpage.' |
| | end | | end |
| − | text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" | + | -- Show the "subpages" link. |
| − | local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. | + | if subjectSpace ~= 6 then -- Don't show the link in file space. |
| − | if printBlurb then | + | local pagetype |
| − | text = text .. '<br />' .. printBlurb | + | if subjectSpace == 10 then |
| | + | pagetype = 'template' |
| | + | elseif subjectSpace == 828 then |
| | + | pagetype = 'module' |
| | + | else |
| | + | pagetype = 'page' |
| | + | end |
| | + | text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', 'Subpages of this ' .. pagetype) |
| | + | end |
| | + | -- Show the "print" link if it exists. |
| | + | local printPage = templatePage .. '/Print' |
| | + | local printTitle = mw.title.new(printPage) |
| | + | if printTitle.exists then |
| | + | text = text .. '<br />A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at ' |
| | + | .. makeWikilink(printPage, '/Print') .. '. If you make a change to this template, please update the print version as well.' |
| | + | .. '[[Category:Templates with print versions]]' |
| | end | | end |
| | end | | end |
| Line 741: |
Line 363: |
| | fmargs.text = text | | fmargs.text = text |
| | | | |
| | + | -- Return the fmbox output. |
| | return messageBox.main('fmbox', fmargs) | | 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 subpage == 'doc' or subpage == 'testcases' then |
| − | --
| + | local sort = (currentTitle.namespace == 0 and 'Main:' or '') .. currentTitle.prefixedText -- Sort on namespace. |
| − | -- Messages:
| + | ret = ret .. makeWikilink('Category:Wikipedia pages with strange ((documentation)) usage', sort) |
| − | -- 'edit-link-display' --> 'edit'
| |
| − | -- 'history-link-display' --> 'history'
| |
| − | -- 'transcluded-from-blurb' -->
| |
| − | -- 'The above [[Wikipedia:Template documentation|documentation]]
| |
| − | -- is [[Wikipedia: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 subjectSpace == 828 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 | | end |
| − | return message(messageName, {sandboxLinks, testcasesLinks})
| |
| | end | | end |
| | | | |
| − | function p.makeCategoriesBlurb(args, env) | + | function p.templatePage() |
| − | --[[ | + | -- Determines the template page. No namespace or interwiki prefixes are included. |
| − | -- Generates the text "Please add categories to the /doc subpage."
| + | local subpage = currentTitle.subpageText |
| − | -- @args - a table of arguments passed by the user
| + | if subpage == 'sandbox' or subpage == 'testcases' then |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| + | return currentTitle.baseText |
| − | -- 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
| |
| − | local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
| |
| − | return message('add-categories-blurb', {docPathLink})
| |
| − | end
| |
| − | | |
| − | function p.makeSubpagesBlurb(args, env)
| |
| − | --[[
| |
| − | -- Generates the "Subpages of this template" link.
| |
| − | -- @args - a table of arguments passed by the user
| |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| − |
| |
| − | -- 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
| |
| − | local subpagesLink = makeWikilink(
| |
| − | 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
| |
| − | message('subpages-link-display', {pagetype})
| |
| − | )
| |
| − | return message('subpages-blurb', {subpagesLink})
| |
| − | end
| |
| − | | |
| − | function p.makePrintBlurb(args, env)
| |
| − | --[=[
| |
| − | -- Generates the blurb displayed when there is a print version of the template available.
| |
| − | -- @args - a table of arguments passed by the user
| |
| − | -- @env - environment table containing title objects, etc., generated with p.getEnvironment
| |
| − | --
| |
| − | -- Messages:
| |
| − | -- 'print-link-display' --> '/Print'
| |
| − | -- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'
| |
| − | -- .. ' of this template exists at $1.'
| |
| − | -- .. ' If you make a change to this template, please update the print version as well.'
| |
| − | -- 'display-print-category' --> true
| |
| − | -- 'print-category' --> 'Templates with print versions'
| |
| − | --]=]
| |
| − | local printTitle = env.printTitle
| |
| − | if not printTitle then
| |
| − | return nil
| |
| − | end
| |
| − | local ret
| |
| − | if printTitle.exists then
| |
| − | local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))
| |
| − | ret = message('print-blurb', {printLink})
| |
| − | local displayPrintCategory = message('display-print-category', nil, 'boolean')
| |
| − | if displayPrintCategory then
| |
| − | ret = ret .. makeCategoryLink(message('print-category'))
| |
| − | end
| |
| − | end
| |
| − | return ret
| |
| − | 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 | | end |
| − | return ret
| |
| | end | | end |
| | | | |
| | return p | | return p |
