Ouvrir le menu principal
WikiField

Modifications

Module:Documentation

29 590 octets ajoutés, 28 février 2019 à 23:26
Wikitext pages in module namespace are a thing now
-- This module implements {{documentation}}.
 
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')
 
-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
 
local p = {}
local defaultDocPage = 'doc'
-- Often-used functions.local getType ugsub = mw.ustring.gsub ------------------------------------------------------------------------------ Helper functions---- These are defined as local functions, but are made available in the p-- table for testing purposes.---------------------------------------------------------------------------- local functionmessage( namespacecfgKey, page valArray, expectType) local pageType = 'template'--[[ -- Gets a message from the cfg table and formats it if appropriate. -- The function raises an error if namespace == the value from the cfg table is not -- of the type expectType. The default type for expectType is 'Modulestring' then. pageType = 'module' -- If the table valArray is present, strings such as $1, $2 etc. in the elseif namespace == 'Widget' then-- message are substituted with values from the table keys [1], [2] etc. pageType = -- For example, if the message "foo-message" had the value 'widgetFoo $2 bar $1.', elseif page.fullText:gsub-- message( '/foo-message' .. defaultDocPage .. , {'$baz', 'qux' }):find( would return "Foo qux bar baz." --]] local msg = cfg[cfgKey] expectType = expectType or '%.css$string' if type(msg) ~= expectType then pageType = error('stylesheetmessage: type error in message cfg.' elseif page.fullText:gsub. cfgKey .. ' ( '/' .. defaultDocPage expectType .. '$'expected, got '' .. type(msg):find( '%.js$. ' ) then pageType = 'script' elseif namespace == 'MediaWiki' then pageType = 'message', 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 retend p.message = message local function makeWikilink(page, display) if display then return mw.ustring.format('[[%s|%s]]', page, display) else return mw.ustring.format('[[%s]]', page) endend 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) return mw.ustring.format('[%s %s]', url, display)end p.makeUrlLink = makeUrlLink local function makeToolbar(...) local ret = {} local lim = select('#', ...) if lim < 1 then return nil end for i = 1, lim do ret[#ret + 1] = select(i, ...) end return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'end  p.makeToolbar = makeToolbar ------------------------------------------------------------------------------ Argument processing---------------------------------------------------------------------------- local function makeInvokeFunc(funcName) return function (frame) local args = getArgs(frame, { valueFunc = function (key, value) if type(value) == 'string' then value = value:match('^%s*(.-)%s*$') -- Remove whitespace. if key == 'heading' or value ~= '' then return value else return nil end else return value end end }) return p[funcName](args) endend ------------------------------------------------------------------------------ Main function---------------------------------------------------------------------------- p.main = makeInvokeFunc('_main') function p._main(args) --[[ -- 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 :wikitext(p.protectionTemplate(env)) :wikitext(p.sandboxNotice(args, env)) -- This div tag is from {{documentation/start box}}, but moving it here -- so that we don't have to worry about unclosed tags. :tag('div') :attr('id', message('main-div-id')) :addClass(message('main-div-classes')) :newline() :wikitext(p._startBox(args, env)) :wikitext(p._content(args, env)) :tag('div') :css('clear', 'both') -- So right or left floating items don't stick out of the doc box. :newline() :done() :done() :wikitext(p._endBox(args, env)) :wikitext(p.addTrackingCategories(env)) return pageTypetostring(root)
end
-- Creating a documentation page or transclution through {{subst:doc}}---------------------------------------------------------------------------- Environment settings---------------------------------------------------------------------------- function p.creategetEnvironment( f args) local --[[ -- Returns a table with information about the environment, including title objects and other namespace- or -- path-related data. -- @args = require- table of arguments passed by the user -- -- Title objects include: -- env.title - the page we are making documentation for ( 'Module:ProcessArgs' usually the current title) -- env.normtemplateTitle - the template (or module, file, etc.) local page = mw-- env.docTitle - the /doc subpage. -- env.titlesandboxTitle - the /sandbox subpage.getCurrentTitle() local docPage = args-- env.page or pagetestcasesTitle - the /testcases subpage.nsText -- 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 pageof the /doc, /sandbox and /testcases pages, with namespace.baseText -- 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. defaultDocPage --]]
local outenv, envFuncs = {}, {}  if not args-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table.content and tostring( page ) == docPage thenThe value -- returned by that function is memoized in the env table so that we don't call any of the functions out = f:preprocess -- more than once. ( Nils won'{{subst:Template:Documentation/preload}}' t be memoized.) elsesetmetatable(env, { local templateArgs __index = {} for _function (t, key in ipairs{ 'type', 'page', 'content' } do) local val envFunc = argsenvFuncs[key] if envFunc then local success, val then= pcall(envFunc) if success then env[key ] == 'content' then val = '\n' .-- Memoise the value. return val .. '\n' end table.insert( templateArgs, key .. '=' .. 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
 
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  out = '{{documentation|' .. table function envFuncs.concatdocTitle( templateArgs, '|' ) --[[ -- Title object of the /doc subpage.. '}}' out = out-- Messages:gsub( -- '|}}doc-subpage', --> '}}doc' ) --]] local title = env.title if not local docname = args[1] -- User-specified doc page.content local docpage if docname then out docpage = out docname else docpage = env.docpageBase .. '\n<!-- Put categories/interwiki on the documentation page -' .. message('doc->subpage')
end
return mw.title.new(docpage)
end
if not mwfunction envFuncs.isSubstingsandboxTitle() then out = f--[[ -- Title object for the /sandbox subpage. -- Messages:preprocess -- 'sandbox-subpage' --> 'sandbox' --]] return mw.title.new(env.docpageBase .. '/' .. message( out 'sandbox-subpage')) end function envFuncs.testcasesTitle() --[[ if not args-- Title object for the /testcases subpage.nocat then out = out -- Messages: -- 'testcases-subpage' --> 'testcases' --]] return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage')) end function envFuncs.printTitle() --[[Category -- Title object for the /Print subpage. -- Messages:Pages with templates requiring substitution -- '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
 
function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
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 outtostring(compareUrl) else return nil end end   return envend  ------------------------------------------------------------------------------ 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 -- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text". 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.contentModel == "Scribunto" 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 retend 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 endend ------------------------------------------------------------------------------ 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 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 end
end
function p.makeStartBoxLinksData(args, env) --[[ -- Does initial processing of data to make the [view] [edit] [history] [purge] links. -- Header on @args - a table of arguments passed by the documentation pageuserfunction -- @env - environment table containing title objects, etc., generated with p.docPage( f )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' local args = require( -- 'docpage-preload' --> 'ModuleTemplate:ProcessArgsDocumentation/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.merge( true )redirectTarget end  local badDoc data = {} data.title = argstitle data.baddocdocTitle = docTitle -- View, display, edit, and purge links if f:callParserFunction/doc exists. data.viewLinkDisplay = message( '#dplvarview-link-display', ) data.editLinkDisplay = message('$doc noheaderedit-link-display' ) data.historyLinkDisplay =message('history-link-display') data.purgeLinkDisplay = message('1purge-link-display' ) -- Create link if /doc doesn't exist. local preload = args.preload if not preload then if badDoc subjectSpace == 6 then-- File namespace f:callParserFunctionpreload = message( '#dplvar:setfile-docpage-preload', ) elseif subjectSpace == 828 then -- Module namespace preload = message('$doc badmodule-preload', ) else preload = message('1docpage-preload' )
end
return
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] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]
local page function escapeBrackets(s) -- Escapes square brackets with HTML entities. s = mws:gsub('%[', '&#91;') -- Replace square brackets with HTML entities. s = s:gsub('%]', '&#93;') return s end  local ret local docTitle = data.docTitle local title= data.getCurrentTitletitle 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 namespace purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) ret = '[%s] [%s] [%s] [%s]' ret = escapeBrackets(ret) ret = pagemw.ustring.nsTextformat(ret, viewLink, editLink, historyLink, purgeLink) else local pageType createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) ret = '[%s]' ret = escapeBrackets(ret) ret = mw.ustring.lowerformat(ret, createLink) end return retend 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.type or getTypegetEnvironment -- @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, page 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 if heading then data.heading = heading elseif subjectSpace == 10 then -- Template namespace data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading') elseif subjectSpace == 828 then -- Module namespace data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') elseif subjectSpace == 6 then -- File namespace data.heading = message('file-namespace-heading') else data.heading = message('other-namespaces-heading') end
-- Heading CSS local body headingStyle = mw.html.create( 'div' ):addClass( args['documentationheading-headerstyle' )] bodyif headingStyle then :css{ ['margin-bottom'] = '0data.8em', padding headingStyleText = '0.8em 1em 0.7em',headingStyle ['background-color'] elseif subjectSpace = '#' .. ( badDoc and 'F9F2EA' or 'EAF4F9' ), border = '1px solid #AAA'10 then }-- We are in the template or template talk namespaces. :tag( 'div' ) :css( 'float', 'right' ) :wikitext( '[[', page:fullUrl( 'actiondata.headingFontWeight =purge' ), bold' purge]]' ) :done() :wikitext( 'This is the documentation page, it ', pageType data.headingFontSize == 'module' and 'will125%' or 'should', ' be transcluded into the main ', pageType, ' page. ', 'See [[Template:Documentation]] for more information' ) if badDoc thenelse body:wikitext( "<br>'''This ", pageType, "'s documentation needs improving or additional informationdata.headingFontSize = '150%''" )
end
-- Data for the [view][edit][history][purge] or [create] links. if not ( argslinks then data.nocat or namespace =linksClass = message('Userstart-box-linkclasses' ) then body:wikitextdata.linksId = message( '[[Category:Documentation pages]]start-box-link-id' ) data.links = links
end
return bodydata
end
-- Wrapper around the documentation on the main pagefunction p.pagerenderStartBox( f data) -- mwRenders the start box html. -- @data - a table of data generated by p.textmakeStartBoxData.trim uses local sbox = mw.ustringhtml.gsubcreate('div') sbox :css('padding-bottom', which silently fails on large strings'3px') local function trim :css( s 'border-bottom', '1px solid #aaa') return string.gsub:css( s'margin-bottom', '^[\t\r\n\f ]*1ex') :newline() :tag('span') :cssText(data.headingStyleText) :css('font-weight', data.headingFontWeight)[\t\r\n\f ]*$ :css('font-size', data.headingFontSize) :wikitext(data.heading) local links = data.links if links then sbox:tag('span') :addClass(data.linksClass) :attr('%1id' , data.linksId) :wikitext(links)
end
local args return tostring(sbox)end ------------------------------------------------------------------------------ Documentation content---------------------------------------------------------------------------- p.content = requiremakeInvokeFunc( 'Module:ProcessArgs_content' ) function p.merge_content( true args, env) local page -- 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 = mw.titleenv or p.getCurrentTitlegetEnvironment(args) local namespace docTitle = pageenv.nsTextdocTitle local docText content = trim( args.content if not content and docTitle and docTitle.exists then content = args._content or '' mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText} end if docText -- The line breaks below are necessary so that "=== Headings === " at the start and end -- of docs are interpreted correctly. return '\n' then docText .. (content or '') .. '\n' end p.contentTitle = nil endmakeInvokeFunc('_contentTitle')  function p._contentTitle(args, env) local docPageenv = env or p.getEnvironment(args) local noDocdocTitle = env.docTitle if docText not args.content and docTitle and docTitle.exists then docPage = pagereturn docTitle.prefixedText
else
docPage = mw.title.new( args.page or namespace .. return ':' .. page.text .. '/' .. defaultDocPage ) noDoc = args.nodoc or not docPage.exists
end
local badDoc end ------------------------------------------------------------------------------ End box---------------------------------------------------------------------------- p.endBox = makeInvokeFunc('_endBox') function p._endBox(args.baddoc, env) local pageType --[= mw[ -- This function generates the end box (also known as the link box).ustring -- @args - a table of arguments passed by the user -- @env - environment table containing title objects, etc.lower( args, generated with p.type or getType( namespacegetEnvironment -- -- Messages: -- 'fmbox-id' --> 'documentation-meta-data' -- 'fmbox-style' --> 'background-color: #ecfcf4' -- 'fmbox-textstyle' --> 'font-style: italic' -- -- The HTML is generated by the {{fmbox}} template, page ) )courtesy of [[Module:Message box]]. --]=]
if not docText and not noDoc then-- Get environment data. f:callParserFunction env = env or p.getEnvironment( '#dplvar:set', '$doc noheader', '1' args) docText local subjectSpace = trim( f:expandTemplate{ title env.subjectSpace local docTitle = ':' env.. docPage.fullText } )docTitle if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' not subjectSpace or not docTitle then badDoc = 1 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 end  -- Assemble the arguments for {{fmbox}}. local fmargs = {} fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data' fmargs.image = 'none' fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4' fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'  -- Assemble the fmbox text field. local text = '' if docText linkBox then text =text .. linkBox else text = text .. (p.makeDocPageBlurb(args, env) or '' ) -- "This documentation is transcluded from [[Foo]]." if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then docText -- We are in the user, template or module namespaces. -- Add sandbox and testcases links. -- "Editors can experiment in this template's sandbox and testcases pages." text = niltext .. (p.makeExperimentBlurb(args, env) or '') noDoc text = text .. '<br />' if not args.content and not args[1] then -- "Please add categories to the /doc subpage." -- Don't show this message with inline docs or with an explicitly specified doc page, -- as then it is unclear where to add the categories. text = text .. (p.makeCategoriesBlurb(args, env) or '') end text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. if printBlurb then text = text .. '<br />' .. printBlurb end
end
end
fmargs.text = text  return messageBox.main('fmbox', fmargs)end function p.makeDocPageBlurb(args, env) --[=[ -- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)". -- @args - a table of arguments passed by the user -- @env - environment table containing title objects, etc., generated with p.getEnvironment -- -- Messages: -- '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 docText docTitle.exists then docText -- /doc exists; link to it. local docLink = makeWikilink(docTitle.prefixedText) local editUrl = docTitle:fullUrl{action = 'edit'\n} 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}) .. docText ' ' .. 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}) .. '\n<br />'
end
return retend function p.makeExperimentBlurb(args, env) --[[ -- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." -- @args - a table of arguments passed by the user -- @env - environment table containing title objects, etc., generated with p.getEnvironment -- -- 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' local action = -- 'sandbox-create-link-display' --> 'create' -- 'mirror-edit-summary' --> 'Create sandbox version of $1' -- 'mirror-link-display' --> 'mirror' local -- 'mirror-link-preload = '--> 'Template:Documentation/mirror' local colour = -- 'sandbox-link-display' --> 'EAF4F9sandbox' local message-- 'testcases-link-display' --> 'testcases' local category-- 'testcases-edit-link-display'--> 'edit' if noDoc then-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' action = -- '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' colour = -- 'experiment-blurb-module' --> 'Editors can experiment in this module'F9EAEAs $1 and $2 pages.' message = " -- 'experiment-blurb-template'--> 'Editors can experiment in this template'This " s $1 and $2 pages.' --]] local subjectSpace = env.subjectSpace local templateTitle = env.templateTitle local sandboxTitle = env.sandboxTitle local testcasesTitle = env. pageType testcasesTitle local templatePage = templateTitle.prefixedText if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then return nil end -- Make links. " has no documentation 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 "If you know how to use this " local compareDisplay = message('compare-link-display') compareLink = makeUrlLink(compareUrl, compareDisplay) end sandboxLinks = sandboxLink .. pageType ' ' .. "makeToolbar(sandboxEditLink, compareLink) else local sandboxPreload if subjectSpace == 828 then sandboxPreload = message('module-sandbox-preload') else sandboxPreload = message('template-sandbox-preload') end local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', please preload = sandboxPreload} local sandboxCreateDisplay = message('sandbox-create it.-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 not ( argssubjectSpace == 828 then mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.nocat or namespace prefixedText, summary =mirrorSummary} end local mirrorDisplay = message('Usermirror-link-display' ) then category local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) sandboxLinks = pageType message('sandbox-link-display') .. 's with no documentation'.. makeToolbar(sandboxCreateLink, mirrorLink) end if not mwtestcasesTitle.titleexists then local testcasesPage = testcasesTitle.newprefixedText local testcasesDisplay = message( 'Categorytestcases-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. category )talkPageTitle and testcasesTitle.talkPageTitle.exists then category local testcasesRunLinkDisplay = message('testcases-run-link-display') local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) testcasesLinks = testcasesLink .. 'Pages with no documentation'.. makeToolbar(testcasesEditLink, testcasesRunLink) else endtestcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
elseif badDoc thenelse colour = 'F9F2EA' message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n"local testcasesPreload if not ( args.nocat or namespace subjectSpace == 'User' ) 828 then category testcasesPreload = pageType .. message('s with bad documentationmodule-testcases-preload') else if not mw.title.newtestcasesPreload = message( 'Category:template-testcases-preload' .. category ).exists then category = 'Pages with bad documentation' end
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
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
local links = {-- Messages: -- '[template-pagetype' .. docPage:fullUrl( --> 'action=edittemplate' .. preload ) .. -- ' module-pagetype' .. action .. --> ']module', -- '[default-pagetype' .. docPage:fullUrl( --> 'action=historypage' ) .. -- ' history]subpages-link-display', --> '[Subpages of this $1' --]] local subjectSpace = env.subjectSpace local templateTitle = env. page:fullUrltemplateTitle if not subjectSpace or not templateTitle then return nil end local pagetype if subjectSpace == 10 then pagetype = message( 'action=purgetemplate-pagetype' ) .. ' purge]' } if not noDoc and page ~elseif subjectSpace == docPage 828 then table.insertpagetype = message( links, 1, '[[module-pagetype' .. docPage.fullText .. ) else pagetype = message('|view]]default-pagetype' )
end
links local subpagesLink = mw.html.createmakeWikilink( 'span' ) 'Special:css( PrefixIndex/'float', 'right' ) :wikitext( mw.text.nowiki( templateTitle.prefixedText .. '[/' ), table.concat message( links, ' | subpages-link-display' ), mw.text.nowiki( ']' ) {pagetype}) ) local body = mw.html.createreturn message( 'divsubpages-blurb' , {subpagesLink}):addClass( 'documentation' ) body:css{ ['background-color'] = '#' .. colour,end border = '1px solid #AAA', padding = '0function p.8em 1em 0.7em'makePrintBlurb(args,env) --['margin-top'] = '1em', clear = 'both'[ }-- Generates the blurb displayed when there is a print version of the template available. -- @args - a table of arguments passed by the user local header = mw-- @env - environment table containing title objects, etc.html, generated with p.create( 'div' )getEnvironment -- -- Messages:css{ margin = -- 'print-0.8em link-1em 0.8emdisplay', padding = --> '0.8em 1em 0.7em/Print', [ -- 'backgroundprint-colorblurb'] = --> 'A [[Help:Books/for experts#EAF4F9Improving the book layout|print version]]', ['border --bottom .. '] = 'inheritof this template exists at $1.' } -- header :node( links ) :tag( .. 'spanIf you make a change to this template, please update the print version as well.' ) :css{ [ -- 'fontdisplay-weightprint-category'] = 'bold',--> true [ -- 'fontprint-sizecategory'] = --> '130%Templates with print versions', ['margin --right'] = '1em', ['line-height'] = '1' } :wikitext( 'Documentation' ) local codePages printTitle = { module = true, stylesheet = true, script = true, }env.printTitle if not noDoc and codePages[pageType] printTitle then header :tag( 'span' ) :css( 'white-space', 'nowrap' ) :wikitext( '[[#the-code|Jump to code ↴]]' )return nil
end
local ret bodyif printTitle.exists then :nodelocal printLink = makeWikilink( header ):doneprintTitle.prefixedText, message('print-link-display') :wikitext( message ) :wikitext( docText ) if not noDoc and page ~ret = docPage then body :tagmessage( 'divprint-blurb' , {printLink}) :css{ margin local displayPrintCategory = message('0.7em display-1em print-0.7emcategory', [nil, 'background-colorboolean'] = '#EAF4F9',) ['border-top'] = 'inherit', if displayPrintCategory then padding ret = '0ret .8em 1em 0.7em', clear = 'both' } :nodemakeCategoryLink( links ) :wikitextmessage( 'The above documentation is transcluded from [[', docPage.fullText, ']].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
if -- Messages: -- 'display-strange-usage-category then' --> true -- 'doc-subpage' --> 'doc' -- 'testcases-subpage' --> 'testcases' body:wikitext( f:expandTemplate{ title = -- 'Translation strange-usage-category'--> 'Wikipedia pages with strange ((documentation)) usage' -- -- /testcases pages in the module namespace are not categorised, args = as they may have -- {{ category, project = '0' 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 anchor ret = '' if not noDoc message('display-strange-usage-category', nil, 'boolean') and pageType ~( subpage == message('templatedoc-subpage' ) or subjectSpace ~= 828 and pageType ~subpage == message('messagetestcases-subpage' ) ) then anchor ret = mwret .html.createmakeCategoryLink( 'div' ):attrmessage( 'id', 'thestrange-usage-codecategory' ))
end
return tostring( body ) .. tostring( anchor )ret
end
return p
Utilisateur anonyme
Récupérée de « https://www.wikifield.fr/wiki/Spécial:MobileDiff/110 »