Module:Documentation: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
Nordenpunto (talk | contribs) m (1 revision imported) |
(Undo imported revision 59148 by user wikipedia>Mat.duf) Tag: Undo |
||
Line 1: | Line 1: | ||
-- |
-- This module implements {{documentation}}. |
||
-- Get required modules. |
|||
local getArgs = require('Module:Arguments').getArgs |
|||
-- Get the config table. |
|||
local cfg = mw.loadData('Module:Documentation/config') |
|||
local p = {} |
local p = {} |
||
-- Often-used functions. |
|||
local function existePage(page) |
|||
local ugsub = mw.ustring.gsub |
|||
return page and page.exists |
|||
end |
|||
---------------------------------------------------------------------------- |
|||
local function textPagebase(page) |
|||
-- Helper functions |
|||
--On n'est pas dans une sous-page |
|||
-- |
|||
if not page.isSubpage then |
|||
-- These are defined as local functions, but are made available in the p |
|||
return page.text |
|||
-- 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 |
end |
||
local function getMessageVal(match) |
|||
--On est dans une sous-page |
|||
match = tonumber(match) |
|||
local sousPage = page.subpageText |
|||
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) |
|||
if sousPage == 'Documentation' |
|||
end |
|||
or sousPage == 'Bac à sable' |
|||
or sousPage == 'Test' then |
|||
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal) |
|||
return page.baseText |
|||
end |
|||
p.message = message |
|||
local function makeWikilink(page, display) |
|||
if display then |
|||
return mw.ustring.format('[[%s|%s]]', page, display) |
|||
else |
else |
||
return |
return mw.ustring.format('[[%s]]', page) |
||
end |
end |
||
end |
end |
||
p.makeWikilink = makeWikilink |
|||
local function nomSouspage(page, souspage) |
|||
return page.subjectNsText .. ':' .. textPagebase(page) .. '/' .. souspage |
|||
local function makeCategoryLink(cat, sort) |
|||
local catns = mw.site.namespaces[14].name |
|||
return makeWikilink(catns .. ':' .. cat, sort) |
|||
end |
end |
||
p.makeCategoryLink = makeCategoryLink |
|||
local function lienUrl(nomPage, texteLien, action, pagePreload) |
|||
local arguments = {} |
|||
local function makeUrlLink(url, display) |
|||
if action then |
|||
return mw.ustring.format('[%s %s]', url, display) |
|||
arguments['action'] = action |
|||
end |
|||
p.makeUrlLink = makeUrlLink |
|||
local function makeToolbar(...) |
|||
local ret = {} |
|||
local lim = select('#', ...) |
|||
if lim < 1 then |
|||
return nil |
|||
end |
end |
||
for i = 1, lim do |
|||
ret[#ret + 1] = select(i, ...) |
|||
end |
|||
-- 'documentation-toolbar' |
|||
return '<span class="' .. message('toolbar-class') .. '">(' |
|||
.. table.concat(ret, ' | ') .. ')</span>' |
|||
end |
|||
p.makeToolbar = makeToolbar |
|||
if pagePreload then |
|||
arguments['preload'] = 'Modèle:Documentation/' .. pagePreload |
|||
---------------------------------------------------------------------------- |
|||
-- 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) |
|||
end |
end |
||
end |
|||
---------------------------------------------------------------------------- |
|||
-- Entry points |
|||
---------------------------------------------------------------------------- |
|||
function p.nonexistent(frame) |
|||
if arguments['action'] or arguments['preload'] then |
|||
if mw.title.getCurrentTitle().subpageText == 'testcases' then |
|||
return mw.ustring.format('[%s %s]', nomPage:fullUrl(arguments), texteLien) |
|||
return frame:expandTemplate{title = 'module test cases notice'} |
|||
else |
else |
||
return p.main(frame) |
|||
return mw.ustring.format('[[%s|%s]]', nomPage.fullText, texteLien) |
|||
end |
end |
||
end |
end |
||
p.main = makeInvokeFunc('_main') |
|||
local function entete(args, page, doc, existeDoc) |
|||
local res = mw.html.create('div') |
|||
function p._main(args) |
|||
-- Titre |
|||
--[[ |
|||
res |
|||
-- This function defines logic flow for the module. |
|||
:css('margin-bottom', '1ex') |
|||
-- @args - table of arguments passed by the user |
|||
:css('border-bottom', '1px solid #aaa') |
|||
--]] |
|||
:css('padding-bottom', '3px') |
|||
local env = p.getEnvironment(args) |
|||
:wikitext('[[Fichier:Test Template Info-Icon.svg|50px|alt=|link=]]') |
|||
local root = mw.html.create() |
|||
:tag('span') |
|||
root |
|||
:css('font-weight', 'bold') |
|||
:wikitext(p._getModuleWikitext(args, env)) |
|||
:css('font-size', '125%') |
|||
:wikitext(p.protectionTemplate(env)) |
|||
:css('vertical-align', 'middle') |
|||
:wikitext(p.sandboxNotice(args, env)) |
|||
:tag('div') |
|||
:wikitext(args.titre or 'Documentation') |
|||
-- 'documentation-container' |
|||
:done() |
|||
:addClass(message('container')) |
|||
:attr('role', 'complementary') |
|||
:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil) |
|||
:attr('aria-label', args.heading == '' and 'Documentation' or nil) |
|||
:newline() |
|||
:tag('div') |
|||
-- 'documentation' |
|||
:addClass(message('main-div-classes')) |
|||
:newline() |
|||
:wikitext(p._startBox(args, env)) |
|||
:wikitext(p._content(args, env)) |
|||
:tag('div') |
|||
-- 'documentation-clear' |
|||
:addClass(message('clear')) |
|||
:done() |
|||
:newline() |
|||
:done() |
|||
:wikitext(p._endBox(args, env)) |
|||
:done() |
|||
:wikitext(p.addTrackingCategories(env)) |
|||
-- 'Module:Documentation/styles.css' |
|||
return mw.getCurrentFrame():extensionTag ( |
|||
'templatestyles', '', {src=cfg['templatestyles'] |
|||
}) .. tostring(root) |
|||
end |
|||
---------------------------------------------------------------------------- |
|||
-- Liens |
|||
-- Environment settings |
|||
local editionLien = res:tag('span') |
|||
---------------------------------------------------------------------------- |
|||
:addClass('mw-editsection-like plainlinks') |
|||
:css('vertical-align', 'middle') |
|||
function p.getEnvironment(args) |
|||
if args['aucun contenu additionnel'] == nil then |
|||
--[[ |
|||
if not args.contenu then |
|||
-- Returns a table with information about the environment, including title |
|||
if existeDoc then |
|||
-- objects and other namespace- or path-related data. |
|||
editionLien |
|||
-- @args - table of arguments passed by the user |
|||
:wikitext('[') |
|||
-- |
|||
:wikitext(lienUrl(doc, 'voir')) |
|||
-- Title objects include: |
|||
:wikitext('] ') |
|||
-- env.title - the page we are making documentation for (usually the current title) |
|||
-- env.templateTitle - the template (or module, file, etc.) |
|||
-- env.docTitle - the /doc subpage. |
|||
-- env.sandboxTitle - the /sandbox subpage. |
|||
-- env.testcasesTitle - the /testcases subpage. |
|||
-- |
|||
-- Data includes: |
|||
-- env.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 |
|||
:wikitext('[') |
|||
-- returned by that function is memoized in the env table so that we don't call any of the functions |
|||
:wikitext(lienUrl(doc, 'modifier', 'edit')) |
|||
-- more than once. (Nils won't be memoized.) |
|||
:wikitext('] ') |
|||
setmetatable(env, { |
|||
__index = function (t, key) |
|||
:wikitext('[') |
|||
local envFunc = envFuncs[key] |
|||
:wikitext(lienUrl(doc, 'historique', 'history')) |
|||
if envFunc then |
|||
:wikitext('] ') |
|||
local success, val = pcall(envFunc) |
|||
else |
|||
if success then |
|||
local pagePreload = 'Preload' |
|||
env[key] = val -- Memoise the value. |
|||
if page.namespace == 828 then |
|||
return val |
|||
pagePreload = 'PreloadModule' |
|||
end |
end |
||
editionLien |
|||
:wikitext('[') |
|||
:wikitext(lienUrl(doc, 'créer', 'edit', pagePreload)) |
|||
:wikitext('] ') |
|||
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 |
end |
||
return title |
|||
end |
end |
||
function envFuncs.templateTitle() |
|||
editionLien |
|||
--[[ |
|||
:wikitext('[') |
|||
-- The template (or module, etc.) title object. |
|||
:wikitext(lienUrl(page, 'purger', 'purge')) |
|||
-- Messages: |
|||
:wikitext(']') |
|||
-- '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() |
|||
return res |
|||
--[[ |
|||
end |
|||
-- 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.protectionLevels() |
|||
local function protection(page, doc, existeDoc, message) |
|||
-- The protection levels table of the title object. |
|||
-- Insertion automatique du modèle de protection. |
|||
return env.title.protectionLevels |
|||
end |
|||
function envFuncs.subjectSpace() |
|||
if niveauProtection and niveauProtection[1] then |
|||
-- The subject namespace number. |
|||
local tableProtection = { |
|||
return mw.site.namespaces[env.title.namespace].subject.id |
|||
autoconfirmed = {'semiProtection', '{{%s*[Ss]emi%-protection%s*[|}]', '{{%s*[Ss]emi%-protection +longue%s*[|}]'}, |
|||
end |
|||
editextendedsemiprotected = {'semiProtectionEtendue', '{{%s*[Ss]emi%-protection +étendue%s*[|}]'}, |
|||
sysop = {'protection', '{{%s*[Pp]rotection%s*[|}]'}, |
|||
} |
|||
local protection = tableProtection[niveauProtection[1]] |
|||
if not protection then |
|||
return '' |
|||
end |
|||
function envFuncs.docSpace() |
|||
local alreadyShown = false |
|||
-- The documentation namespace number. For most namespaces this is the |
|||
if existeDoc then |
|||
-- same as the subject namespace. However, pages in the Article, File, |
|||
-- Vérification qu'il n'y a pas déjà un modèle de |
|||
-- MediaWiki or Category namespaces must have their /doc, /sandbox and |
|||
-- protection dans la documentation du modèle. |
|||
-- /testcases pages in talk space. |
|||
local contenuDoc = doc:getContent() |
|||
local subjectSpace = env.subjectSpace |
|||
if contenuDoc:match(protection[2]) or (protection[3] and contenuDoc:match(protection[3])) then |
|||
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then |
|||
alreadyShown = true |
|||
return subjectSpace + 1 |
|||
end |
|||
else |
|||
return subjectSpace |
|||
end |
end |
||
end |
|||
function envFuncs.docpageBase() |
|||
if not alreadyShown then |
|||
-- The base page of the /doc, /sandbox, and /testcases subpages. |
|||
if message == '' then |
|||
-- For some namespaces this is the talk page, rather than the template page. |
|||
message = nil |
|||
local templateTitle = env.templateTitle |
|||
end |
|||
local docSpace = env.docSpace |
|||
return require('Module:Protection').main({message}, protection[1], page) |
|||
local docSpaceText = mw.site.namespaces[docSpace].name |
|||
end |
|||
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon. |
|||
return docSpaceText .. ':' .. templateTitle.text |
|||
end |
end |
||
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 |
|||
return env |
|||
-- pour les bacs à sable, on retire les balises de catégories |
|||
end |
|||
-- habituellement situées en "includeonly" à la fin de la documentation |
|||
local function retireBalisesCategories(contenuDoc) |
|||
local count |
|||
repeat |
|||
contenuDoc, count = mw.ustring.gsub(contenuDoc, '%[%[Catégorie:[^%]]+%]%][\t\r\n\f ]*$', '') |
|||
until count == 0 |
|||
---------------------------------------------------------------------------- |
|||
contenuDoc, count = mw.ustring.gsub(contenuDoc, '[\t\r\n\f ]*$', '') |
|||
-- Auxiliary templates |
|||
---------------------------------------------------------------------------- |
|||
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext') |
|||
return contenuDoc |
|||
function p._getModuleWikitext(args, env) |
|||
local currentTitle = mw.title.getCurrentTitle() |
|||
if currentTitle.contentModel ~= 'Scribunto' then return end |
|||
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care |
|||
local moduleWikitext = package.loaded["Module:Module wikitext"] |
|||
if moduleWikitext then |
|||
return moduleWikitext.main() |
|||
end |
|||
end |
end |
||
function p.sandboxNotice(args, env) |
|||
--[=[ |
|||
local page = mw.title.getCurrentTitle() |
|||
-- Generates a sandbox notice for display above sandbox pages. |
|||
local res = mw.html.create():newline() |
|||
-- @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. |
|||
omargs.text = text .. makeCategoryLink(message('sandbox-category')) |
|||
-- 'documentation-clear' |
|||
-- Contenu auto haut |
|||
return '<div class="' .. message('clear') .. '"></div>' |
|||
if args['contenu auto haut'] then |
|||
.. require('Module:Message box').main('ombox', omargs) |
|||
res:wikitext(args['contenu auto haut']) |
|||
end |
|||
:newline() |
|||
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 = env.protectionLevels |
|||
if not protectionLevels then |
|||
return nil |
|||
end |
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. |
|||
return require('Module:Protection banner')._main{ |
|||
message('protection-reason-edit'), 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. |
|||
return require('Module:Protection banner')._main{ |
|||
action = 'move', small = true |
|||
} |
|||
else |
|||
return nil |
|||
end |
|||
end |
|||
---------------------------------------------------------------------------- |
|||
-- Contenu ou sous-page de doc |
|||
-- Start box |
|||
if args['aucun contenu additionnel'] == nil then |
|||
---------------------------------------------------------------------------- |
|||
if args.contenu then |
|||
res:newline() |
|||
:wikitext(args.contenu) |
|||
:newline() |
|||
p.startBox = makeInvokeFunc('_startBox') |
|||
elseif existeDoc then |
|||
local contenuDoc = mw.getCurrentFrame():expandTemplate{title = doc.prefixedText} |
|||
if page.subpageText == 'Bac à sable' or page.subpageText == 'Test' then |
|||
contenuDoc = retireBalisesCategories(contenuDoc) |
|||
end |
|||
res:newline() |
|||
:wikitext(contenuDoc) |
|||
:newline() |
|||
function p._startBox(args, env) |
|||
elseif page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' and args['contenu facultatif'] == nil then |
|||
--[[ |
|||
local texteBandeau = '<b>Ce %s ne possède aucune [[Aide:Documentation de modèle|documentation]] ' |
|||
-- This function generates the start box. |
|||
..'explicative en sous-page</b>, pas même une description succincte.<br> ' |
|||
-- @args - a table of arguments passed by the user |
|||
..'Vous pouvez %s afin de documenter ce %s adéquatement.' |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
if page.namespace == 828 then -- Module |
|||
-- |
|||
texteBandeau = texteBandeau:format( |
|||
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make |
|||
'module', |
|||
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox |
|||
lienUrl(doc, 'créer cette sous-page', 'edit', 'PreloadModule'), |
|||
-- which generate the box HTML. |
|||
'module' |
|||
--]] |
|||
) |
|||
env = env or p.getEnvironment(args) |
|||
else -- Modèle |
|||
local links |
|||
texteBandeau = texteBandeau:format( |
|||
local content = args.content |
|||
'modèle', |
|||
if not content or args[1] then |
|||
lienUrl(doc, 'créer cette sous-page', 'edit', 'Preload'), |
|||
-- No need to include the links if the documentation is on the template page itself. |
|||
'modèle' |
|||
local linksData = p.makeStartBoxLinksData(args, env) |
|||
) |
|||
if linksData then |
|||
end |
|||
links = p.renderStartBoxLinks(linksData) |
|||
if page.namespace == 10 then -- Modèle |
|||
texteBandeau = texteBandeau .. '[[Catégorie:Modèle sans documentation]]' |
|||
elseif page.namespace == 828 then -- Module |
|||
if page.text:sub(1, 12) == 'Utilisateur:' then |
|||
-- Pas de catégorisation pour le pseudo-namespace "Module:Utilisateur:Toto/Nom du module" |
|||
elseif existeDoc == false then |
|||
texteBandeau = texteBandeau .. '[[Catégorie:Module sans documentation]]' |
|||
end |
|||
end |
|||
local param = { |
|||
['icône'] = 'OOjs_UI_icon_book-ltr.svg', |
|||
alt = 'MIT', |
|||
style = 'width:80%;', |
|||
texte = texteBandeau, |
|||
} |
|||
res:wikitext(require('Module:Bandeau')._bandeau(param)) |
|||
end |
end |
||
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) |
|||
-- Contenu auto bas |
|||
--[[ |
|||
if args['contenu auto bas'] then |
|||
-- Does initial processing of data to make the [view] [edit] [history] [purge] links. |
|||
res:newline() |
|||
-- @args - a table of arguments passed by the user |
|||
:wikitext(args['contenu auto bas']) |
|||
-- @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' |
|||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' |
|||
-- 'docpage-preload' --> 'Template:Documentation/preload' |
|||
-- 'create-link-display' --> 'create' |
|||
--]] |
|||
local subjectSpace = env.subjectSpace |
|||
local title = env.title |
|||
local docTitle = env.docTitle |
|||
if not title or not docTitle then |
|||
return nil |
|||
end |
|||
if docTitle.isRedirect then |
|||
docTitle = docTitle.redirectTarget |
|||
end |
end |
||
local data = {} |
|||
res |
|||
data.title = title |
|||
:tag('div') |
|||
data.docTitle = docTitle |
|||
:css('clear', 'both') |
|||
-- View, display, edit, and purge links if /doc exists. |
|||
data.viewLinkDisplay = message('view-link-display') |
|||
return res |
|||
data.editLinkDisplay = message('edit-link-display') |
|||
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 == 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 |
end |
||
function p.renderStartBoxLinks(data) |
|||
local function lienWstat(nomPage, texteLien) |
|||
--[[ |
|||
local nomPageEncoded = mw.text.encode(nomPage) |
|||
-- Generates the [view][edit][history][purge] or [create][purge] links from the data table. |
|||
local nomPageNoSpaces = mw.ustring.gsub(nomPageEncoded, ' ', '_') |
|||
-- @data - a table of data generated by p.makeStartBoxLinksData |
|||
local url = 'https://wstat.fr/template/info/' .. nomPageNoSpaces |
|||
--]] |
|||
return mw.ustring.format('[%s %s]', url, texteLien) |
|||
local function escapeBrackets(s) |
|||
-- Escapes square brackets with HTML entities. |
|||
s = s:gsub('%[', '[') -- Replace square brackets with HTML entities. |
|||
s = s:gsub('%]', ']') |
|||
return s |
|||
end |
|||
local ret |
|||
local docTitle = data.docTitle |
|||
local title = data.title |
|||
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) |
|||
if docTitle.exists then |
|||
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) |
|||
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay) |
|||
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay) |
|||
ret = '[%s] [%s] [%s] [%s]' |
|||
ret = escapeBrackets(ret) |
|||
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink) |
|||
else |
|||
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) |
|||
ret = '[%s] [%s]' |
|||
ret = escapeBrackets(ret) |
|||
ret = mw.ustring.format(ret, createLink, purgeLink) |
|||
end |
|||
return ret |
|||
end |
end |
||
function p.makeStartBoxData(args, env, links) |
|||
--[=[ |
|||
local res = mw.html.create('div') |
|||
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox. |
|||
:css('border-top', '1px solid #aaa') |
|||
-- @args - a table of arguments passed by the user |
|||
:css('margin', '1.5em 0 0') |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error. |
|||
-- |
|||
-- Messages: |
|||
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' |
|||
-- 'template-namespace-heading' --> 'Template documentation' |
|||
-- 'module-namespace-heading' --> 'Module documentation' |
|||
-- 'file-namespace-heading' --> 'Summary' |
|||
-- 'other-namespaces-heading' --> 'Documentation' |
|||
-- 'testcases-create-link-display' --> 'create' |
|||
--]=] |
|||
local subjectSpace = env.subjectSpace |
|||
if not subjectSpace then |
|||
-- Default to an "other namespaces" namespace, so that we get at least some output |
|||
-- if an error occurs. |
|||
subjectSpace = 2 |
|||
end |
|||
local data = {} |
|||
-- Heading |
|||
local contenuWstat = res |
|||
local heading = args.heading -- Blank values are not removed. |
|||
:tag('p') |
|||
if heading == '' then |
|||
:css('margin-bottom', '0') |
|||
-- Don't display the start box if the heading arg is defined but blank. |
|||
:css('padding-left', '1em') |
|||
return nil |
|||
end |
|||
local nomWstat = textPagebase(page) |
|||
if heading then |
|||
local texteWstat = "statistiques d'utilisation" |
|||
data.heading = heading |
|||
elseif subjectSpace == 10 then -- Template namespace |
|||
if page.namespace == 828 then |
|||
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading') |
|||
nomWstat = 'Module:' .. nomWstat |
|||
elseif subjectSpace == 828 then -- Module namespace |
|||
texteWstat = texteWstat .. ' du module' |
|||
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') |
|||
elseif subjectSpace == 6 then -- File namespace |
|||
data.heading = message('file-namespace-heading') |
|||
else |
else |
||
data.heading = message('other-namespaces-heading') |
|||
texteWstat = texteWstat .. ' du modèle' |
|||
end |
end |
||
-- Heading CSS |
|||
contenuWstat:wikitext('Voir les ') |
|||
local headingStyle = args['heading-style'] |
|||
:wikitext(lienWstat(nomWstat, texteWstat)) |
|||
if headingStyle then |
|||
:wikitext(" sur l'outil [[Aide:Wstat|wstat]].") |
|||
data.headingStyleText = headingStyle |
|||
local contenuParagraphe = res |
|||
:tag('p') |
|||
:addClass('plainlinks') |
|||
:css('margin-bottom', '0') |
|||
:css('padding-left', '1em') |
|||
:css('font-style', 'italic') |
|||
-- Phrase "la documentation est générée par ..." |
|||
if args['nom modèle'] then |
|||
local lienAide = '[[Aide:Modèle|modèle]]' |
|||
if page.namespace == 828 then |
|||
lienAide = '[[Aide:Module|module]]' |
|||
end |
|||
contenuParagraphe |
|||
:wikitext('La [[Aide:Documentation de modèle|documentation]] de ce ') |
|||
:wikitext(lienAide) |
|||
:wikitext(' est générée par le modèle ') |
|||
:wikitext(mw.getCurrentFrame():expandTemplate{title = 'm', args = {args['nom modèle']} }) |
|||
:wikitext('.<br>') |
|||
else |
else |
||
-- 'documentation-heading' |
|||
contenuParagraphe |
|||
data.headingClass = message('main-div-heading-class') |
|||
end |
|||
-- Data for the [view][edit][history][purge] or [create] links. |
|||
if links then |
|||
-- 'mw-editsection-like plainlinks' |
|||
data.linksClass = message('start-box-link-classes') |
|||
data.links = links |
|||
end |
|||
return data |
|||
end |
|||
function p.renderStartBox(data) |
|||
-- Renders the start box html. |
|||
-- @data - a table of data generated by p.makeStartBoxData. |
|||
local sbox = mw.html.create('div') |
|||
sbox |
|||
-- 'documentation-startbox' |
|||
:addClass(message('start-box-class')) |
|||
:newline() |
|||
:tag('span') |
:tag('span') |
||
:addClass( |
:addClass(data.headingClass) |
||
:attr('id', 'documentation-heading') |
|||
:wikitext('Erreur : le paramètre <code>nom modèle</code> n\'est pas renseigné.<br>') |
|||
:cssText(data.headingStyleText) |
|||
:wikitext(data.heading) |
|||
local links = data.links |
|||
if links then |
|||
sbox:tag('span') |
|||
:addClass(data.linksClass) |
|||
:attr('id', data.linksId) |
|||
:wikitext(links) |
|||
end |
end |
||
return tostring(sbox) |
|||
end |
|||
---------------------------------------------------------------------------- |
|||
-- Phrase indiquant la provenance du contenu (dans le corps ou en sous-page) |
|||
-- Documentation content |
|||
if args['aucun contenu additionnel'] == nil then |
|||
---------------------------------------------------------------------------- |
|||
if args.contenu then |
|||
contenuParagraphe |
|||
:wikitext('Elle est directement [[Aide:Inclusion|incluse]] dans l\'appel de ce dernier. ') |
|||
:wikitext('Si cette page est protégée, veuillez ') |
|||
:wikitext('transférer le contenu de la documentation vers sa ') |
|||
:wikitext(lienUrl(doc, 'sous-page dédiée', 'edit', 'Preload')) |
|||
:wikitext('.<br>') |
|||
elseif existeDoc then |
|||
contenuParagraphe |
|||
:wikitext('Elle est [[Aide:Inclusion|incluse]] depuis ') |
|||
p.content = makeInvokeFunc('_content') |
|||
if args['page doc'] then |
|||
contenuParagraphe |
|||
:wikitext('la page [[') |
|||
:wikitext(tostring(doc)) |
|||
:wikitext(']]. ') |
|||
else |
|||
contenuParagraphe |
|||
:wikitext('sa [[') |
|||
:wikitext(tostring(doc)) |
|||
:wikitext('|sous-page de documentation]]. ') |
|||
end |
|||
function p._content(args, env) |
|||
contenuParagraphe |
|||
-- Displays the documentation contents |
|||
:wikitext('Veuillez placer les catégories sur cette page-là.<br>') |
|||
-- @args - a table of arguments passed by the user |
|||
end |
|||
-- @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 |
|||
if not content and docTitle and docTitle.exists then |
|||
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText} |
|||
end |
end |
||
-- The line breaks below are necessary so that "=== Headings ===" at the start and end |
|||
-- of docs are interpreted correctly. |
|||
return '\n' .. (content or '') .. '\n' |
|||
end |
|||
p.contentTitle = makeInvokeFunc('_contentTitle') |
|||
-- Phrase indiquant les liens vers le bac à sable et la page de test |
|||
contenuParagraphe |
|||
:wikitext('Les éditeurs peuvent travailler dans le ') |
|||
local titrePageBacasable = nomSouspage(page, 'Bac à sable') |
|||
local pageBacasable = mw.title.new(titrePageBacasable) |
|||
function p._contentTitle(args, env) |
|||
if existePage(pageBacasable) then |
|||
env = env or p.getEnvironment(args) |
|||
contenuParagraphe |
|||
local docTitle = env.docTitle |
|||
:wikitext('[[' .. titrePageBacasable .. '|bac à sable]] ') |
|||
if not args.content and docTitle and docTitle.exists then |
|||
:tag('span') |
|||
return docTitle.prefixedText |
|||
:css('font-size', '89%') |
|||
:css('font-style', 'normal') |
|||
:wikitext('(') |
|||
:wikitext(lienUrl(pageBacasable, 'modifier', 'edit')) |
|||
:wikitext(')') |
|||
else |
else |
||
return '' |
|||
local pagePreload = 'Preload2' |
|||
if page.namespace == 828 then |
|||
pagePreload = nil |
|||
end |
|||
contenuParagraphe |
|||
:wikitext('bac à sable ') |
|||
:tag('span') |
|||
:css('font-size', '89%') |
|||
:css('font-style', 'normal') |
|||
:wikitext('(') |
|||
:wikitext(lienUrl(pageBacasable, 'créer', 'edit', pagePreload)) |
|||
:wikitext(')') |
|||
end |
end |
||
end |
|||
---------------------------------------------------------------------------- |
|||
if page.namespace ~= 828 then |
|||
-- End box |
|||
contenuParagraphe:wikitext(' et la page de ') |
|||
---------------------------------------------------------------------------- |
|||
p.endBox = makeInvokeFunc('_endBox') |
|||
local titrePageTest = nomSouspage(page, 'Test') |
|||
local pageTest = mw.title.new(titrePageTest) |
|||
function p._endBox(args, env) |
|||
if existePage(pageTest) then |
|||
--[=[ |
|||
contenuParagraphe |
|||
-- This function generates the end box (also known as the link box). |
|||
:wikitext('[[' .. titrePageTest .. '|test]] ') |
|||
-- @args - a table of arguments passed by the user |
|||
:tag('span') |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
:css('font-size', '89%') |
|||
-- |
|||
:css('font-style', 'normal') |
|||
--]=] |
|||
:wikitext('(') |
|||
:wikitext(lienUrl(pageTest, 'modifier', 'edit')) |
|||
-- Get environment data. |
|||
:wikitext(')') |
|||
env = env or p.getEnvironment(args) |
|||
else |
|||
local subjectSpace = env.subjectSpace |
|||
contenuParagraphe |
|||
local docTitle = env.docTitle |
|||
:wikitext('test ') |
|||
if not subjectSpace or not docTitle then |
|||
:tag('span') |
|||
return nil |
|||
:css('font-size', '89%') |
|||
end |
|||
:css('font-style', 'normal') |
|||
:wikitext('(') |
|||
-- Check whether we should output the end box at all. Add the end |
|||
:wikitext(lienUrl(pageTest, 'créer', 'edit', 'Preload3')) |
|||
-- box by default if the documentation exists or if we are in the |
|||
:wikitext(')') |
|||
-- 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 link box. |
|||
local text = '' |
|||
if 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 |
|||
-- 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 = text .. (p.makeExperimentBlurb(args, env) or '') .. '<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" |
|||
end |
end |
||
end |
end |
||
contenuParagraphe:wikitext('.') |
|||
local box = mw.html.create('div') |
|||
-- 'documentation-metadata' |
|||
box:attr('role', 'note') |
|||
:addClass(message('end-box-class')) |
|||
-- 'plainlinks' |
|||
:addClass(message('end-box-plainlinks')) |
|||
:wikitext(text) |
|||
:done() |
|||
return |
return '\n' .. tostring(box) |
||
end |
end |
||
function p. |
function p.makeDocPageBlurb(args, env) |
||
--[=[ |
|||
local page = mw.title.getCurrentTitle() |
|||
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)". |
|||
local titrePageDoc = args['page doc'] or nomSouspage(page, 'Documentation') |
|||
-- @args - a table of arguments passed by the user |
|||
local doc = mw.title.new(titrePageDoc) |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
local existeDoc = existePage(doc) |
|||
-- |
|||
local res = mw.html.create() |
|||
-- Messages: |
|||
-- 'edit-link-display' --> 'edit' |
|||
--Bandeau pour les sous-pages /Bac à sable |
|||
-- 'history-link-display' --> 'history' |
|||
if page.subpageText == 'Bac à sable' then |
|||
-- 'transcluded-from-blurb' --> |
|||
res |
|||
-- 'The above [[Wikipedia:Template documentation|documentation]] |
|||
:tag('div') |
|||
-- is [[Help:Transclusion|transcluded]] from $1.' |
|||
:css('clear', 'both') |
|||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' |
|||
:done() |
|||
-- 'create-link-display' --> 'create' |
|||
:wikitext(mw.getCurrentFrame():expandTemplate{title = 'Sous-page de bac à sable'}) |
|||
-- '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 |
end |
||
local ret |
|||
if docTitle.exists then |
|||
--Génération de la documentation |
|||
-- /doc exists; link to it. |
|||
local couleur = '#ecfcf4' |
|||
local docLink = makeWikilink(docTitle.prefixedText) |
|||
if page.namespace == 828 then |
|||
local editUrl = docTitle:fullUrl{action = 'edit'} |
|||
couleur = '#ecf0fc' |
|||
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 |
|||
end |
|||
function p.makeExperimentBlurb(args, env) |
|||
res |
|||
--[[ |
|||
:tag('div') |
|||
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." |
|||
:addClass('documentation') |
|||
-- @args - a table of arguments passed by the user |
|||
:css('clear', 'both') |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
:css('margin', '1em 0 0 0') |
|||
-- |
|||
:css('border', '1px solid #aaa') |
|||
-- Messages: |
|||
:css('background', couleur) |
|||
-- 'sandbox-link-display' --> 'sandbox' |
|||
:css('padding', '1em 1em 0.8em') |
|||
-- 'sandbox-edit-link-display' --> 'edit' |
|||
:node(entete(args, page, doc, existeDoc)) |
|||
-- 'compare-link-display' --> 'diff' |
|||
:wikitext(protection(page, doc, existeDoc, args['message protection'])) |
|||
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox' |
|||
:node(contenu(args, doc, existeDoc)) |
|||
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' |
|||
:node(notice(args, page, doc, existeDoc)) |
|||
-- 'sandbox-create-link-display' --> 'create' |
|||
-- 'mirror-edit-summary' --> 'Create sandbox version of $1' |
|||
-- Catégorisation par défaut pour les modules sans documentation |
|||
-- 'mirror-link-display' --> 'mirror' |
|||
if page.namespace == 828 and page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then |
|||
-- 'mirror-link-preload' --> 'Template:Documentation/mirror' |
|||
if existeDoc == false then |
|||
-- 'sandbox-link-display' --> 'sandbox' |
|||
res:wikitext("[[Catégorie:Module en langage Lua]]") |
|||
-- '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 |
end |
||
sandboxLinks = sandboxLink .. ' ' .. 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', 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 |
end |
||
if testcasesTitle.exists then |
|||
local testcasesPage = testcasesTitle.prefixedText |
|||
local testcasesDisplay = message('testcases-link-display') |
|||
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay) |
|||
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'} |
|||
local testcasesEditDisplay = message('testcases-edit-link-display') |
|||
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) |
|||
-- for Modules, add testcases run link if exists |
|||
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then |
|||
local testcasesRunLinkDisplay = message('testcases-run-link-display') |
|||
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) |
|||
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink) |
|||
else |
|||
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) |
|||
end |
|||
else |
|||
local testcasesPreload |
|||
if subjectSpace == 828 then |
|||
testcasesPreload = message('module-testcases-preload') |
|||
else |
|||
testcasesPreload = message('template-testcases-preload') |
|||
end |
|||
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload} |
|||
local testcasesCreateDisplay = message('testcases-create-link-display') |
|||
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay) |
|||
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink) |
|||
end |
|||
local messageName |
|||
if subjectSpace == 828 then |
|||
messageName = 'experiment-blurb-module' |
|||
else |
|||
messageName = 'experiment-blurb-template' |
|||
end |
|||
return message(messageName, {sandboxLinks, testcasesLinks}) |
|||
end |
|||
function p.makeCategoriesBlurb(args, env) |
|||
return tostring(res) |
|||
--[[ |
|||
-- 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 |
end |
||
function p. |
function p.makeSubpagesBlurb(args, env) |
||
--[[ |
|||
local args = {} |
|||
-- Generates the "Subpages of this template" link. |
|||
local argsParent = frame:getParent().args |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
--Paramètres vides interprétés par Lua |
|||
for cle, val in pairs(argsParent) do |
|||
-- Messages: |
|||
val = mw.text.trim(val) |
|||
-- 'template-pagetype' --> 'template' |
|||
if val ~= '' then |
|||
-- 'module-pagetype' --> 'module' |
|||
args[cle] = val |
|||
-- 'default-pagetype' --> 'page' |
|||
end |
|||
-- '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 |
end |
||
local pagetype |
|||
if subjectSpace == 10 then |
|||
pagetype = message('template-pagetype') |
|||
elseif subjectSpace == 828 then |
|||
pagetype = message('module-pagetype') |
|||
else |
|||
pagetype = message('default-pagetype') |
|||
end |
|||
local subpagesLink = makeWikilink( |
|||
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', |
|||
message('subpages-link-display', {pagetype}) |
|||
) |
|||
return message('subpages-blurb', {subpagesLink}) |
|||
end |
|||
---------------------------------------------------------------------------- |
|||
return p._documentation(args) |
|||
-- Tracking categories |
|||
---------------------------------------------------------------------------- |
|||
function p.addTrackingCategories(env) |
|||
--[[ |
|||
-- Check if {{documentation}} is transcluded on a /doc or /testcases page. |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- Messages: |
|||
-- 'display-strange-usage-category' --> true |
|||
-- 'doc-subpage' --> 'doc' |
|||
-- 'testcases-subpage' --> 'testcases' |
|||
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage' |
|||
-- |
|||
-- /testcases pages in the module namespace are not categorised, as they may have |
|||
-- {{documentation}} transcluded automatically. |
|||
--]] |
|||
local title = env.title |
|||
local subjectSpace = env.subjectSpace |
|||
if not title or not subjectSpace then |
|||
return nil |
|||
end |
|||
local subpage = title.subpageText |
|||
local ret = '' |
|||
if message('display-strange-usage-category', nil, 'boolean') |
|||
and ( |
|||
subpage == message('doc-subpage') |
|||
or subjectSpace ~= 828 and subpage == message('testcases-subpage') |
|||
) |
|||
then |
|||
ret = ret .. makeCategoryLink(message('strange-usage-category')) |
|||
end |
|||
return ret |
|||
end |
end |
||