Module:Documentation : Différence entre versions

De Lagny-sur-Marne Wiki
Aller à : navigation, rechercher
m (retouche modif précédente)
 
(57 révisions intermédiaires par 10 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
−
--Ce module implemente le modèle {{Documentation}}.
+
--Ce module implémente le modèle {{Documentation}}.
  
 
local p = {}
 
local p = {}
  
−
function p.corps(frame)
+
local function existePage(page)
−
    local args = frame:getParent().args
+
return page and page.exists
−
    local corps = {}
+
end
 +
 
 +
local function nomDocumentation(page)
 +
--On n'est pas dans une sous-page
 +
if not page.isSubpage then
 +
return page.subjectNsText .. ':' .. page.text .. '/Documentation'
 +
end
 +
 +
--On est dans une sous-page
 +
local sousPage = page.subpageText
 +
if sousPage == 'Documentation'
 +
or sousPage == 'Bac à sable'
 +
or sousPage == 'Test' then
 +
return page.subjectNsText .. ':' .. page.baseText .. '/Documentation'
 +
else
 +
return page.subjectNsText .. ':' .. page.text .. '/Documentation'
 +
end
 +
end
 +
 
 +
local function lienUrl(nomPage, titrePage, action, pagePreload)
 +
local argument = {['action'] = action or 'edit'}
 +
 +
if pagePreload then
 +
argument['preload'] = 'Modèle:Documentation/Preload' .. pagePreload
 +
end
 +
 
 +
return mw.ustring.format('[%s %s]', nomPage:fullUrl(argument), titrePage)
 +
end
 +
 
 +
local function entete(args, page, doc, existeDoc)
 +
local res = mw.html.create('div')
  
−
    --Bandeau pour les sous-pages /Bac à sable
+
res
−
    if mw.title.getCurrentTitle().subpageText == 'Bac à sable' then
+
:css('margin-bottom', '1ex')
−
        table.insert(corps, '<div style="clear:both />')
+
:css('border-bottom', '1px solid #aaa')
−
        table.insert(corps, frame:preprocess('{{Sous-page de bac à sable}}'))
+
:css('padding-bottom', '3px')
−
    end
+
:wikitext('[[Fichier:Template-info.png|50px|alt=|link=]]')
 +
:tag('span')
 +
:css('font-weight', 'bold')
 +
:css('font-size', '125%')
 +
:css('vertical-align', 'middle')
 +
:wikitext('&nbsp;')
 +
:wikitext(args.titre or 'Documentation')
 +
:done()
  
−
    --Génération de la documentation
+
if not args.contenu then
−
    table.insert(corps, frame:preprocess(p.entete(frame, args)))
+
local editionLien = res:tag('span')
−
    table.insert(corps, p.contenu(frame, args))
+
:addClass('mw-editsection plainlinks')
−
    table.insert(corps, frame:preprocess(p.notice(frame, args)))
+
:css('vertical-align', 'middle')
 +
:wikitext('&#91;')
  
−
    --Code HTML brut
+
if existeDoc then
−
    if args.raw then
+
editionLien:wikitext(lienUrl(doc, 'modifier'))
−
        return frame:preprocess('<nowiki>' .. table.concat(corps) .. '</nowiki>')
+
else
−
    end
+
if args.module then
 +
editionLien:wikitext(lienUrl(doc, 'créer', 'edit', 'Module'))
 +
else
 +
editionLien:wikitext(lienUrl(doc, 'créer', 'edit', ''))
 +
end
 +
end
  
−
    return table.concat(corps)
+
editionLien
 +
:wikitext('&#93;&#32;&#91;')
 +
:wikitext(lienUrl(page, 'purger', 'purge'))
 +
:wikitext('&#93;')
 +
end
  
 +
return res
 
end
 
end
  
−
function p.ifexist(page)
+
local function protection(page, doc, existeDoc, message)
−
    if not page then return false end
+
-- Insertion automatique du modèle de protection.
−
    if mw.title.new(page).exists then return true end
+
local niveauProtection = page.protectionLevels.edit
−
    return false
 
−
end
 
  
−
function p.docname(frame)
+
if niveauProtection and niveauProtection[1] then
−
    local page = mw.title.getCurrentTitle()
+
local tableProtection = {
 +
autoconfirmed = {'semiProtection', '{{%s*[Ss]emi%-protection%s*l?o?n?g?u?e?[|}]'},
 +
editextendedsemiprotected = {'semiProtectionEtendue', '{{%s*[Ss]emi%-protection étendue%s*[|}]'},
 +
sysop = {'protection', '{{%s*[Pp]rotection%s*[|}]'},
 +
}
 +
local protection = tableProtection[niveauProtection[1]]
 +
if existeDoc then
 +
-- Vérification qu'il n'y a pas déjà un modèle de
 +
-- protection dans la documentation du modèle.
 +
local contenuDoc = doc:getContent()
 +
if contenuDoc:match(protection[2]) then
 +
protection = false
 +
end
 +
end
  
−
    if not page.isSubpage then
+
if protection then
−
        --On n'est pas dans une sous-page
+
if message == '' then
−
        return page.subjectNsText .. ":" .. page.text .. "/Documentation"
+
message = nil
−
    else
+
end
−
        --On est dans une sous-page
+
return require('Module:Protection').main({message}, protection[1], page)
−
        if page.subpageText == 'Documentation'
+
end
−
        or page.subpageText == 'Bac à sable'
+
end
−
        or page.subpageText == 'Test' then
 
−
            return page.subjectNsText .. ":" .. page.baseText .. "/Documentation"
 
−
        else
 
−
            return page.subjectNsText .. ":" .. page.text .. "/Documentation"
 
−
        end
 
−
    end
 
 
end
 
end
  
−
function p.entete(frame, args)
+
local function contenu(args, doc, existeDoc)
−
    local entete = {'<div style="clear:both; margin:1em 0 0 0; border:1px solid #aaa; background:'}
+
local page = mw.title.getCurrentTitle()
 +
local res = mw.html.create():newline()
  
−
    if not args.couleur then
+
if args.contenu then
−
        table.insert(entete, '#ecfcf4')
+
res:wikitext(args.contenu)
−
    else
+
elseif existeDoc then
−
        table.insert(entete, args.couleur)
+
local frame = mw.getCurrentFrame()
−
    end
+
if frame.args and frame.args['contenu sous-page'] then
 +
res:wikitext(frame.args['contenu sous-page'])
 +
else
 +
res:wikitext(frame:expandTemplate{title = doc.prefixedText})
 +
end
 +
elseif page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
 +
local texteBandeau = '<b>Ce %s ne possède aucune [[Aide:Documentation de modèle|documentation]] '
 +
..'explicative en sous-page</b>, pas même une description succincte.<br> '
 +
..'Vous pouvez %s afin de documenter ce %s adéquatement.'
 +
if args.module then
 +
texteBandeau = texteBandeau:format(
 +
'module',
 +
lienUrl(doc, 'créer cette sous-page', 'edit', 'Module'),
 +
'module'
 +
)
 +
else
 +
texteBandeau = texteBandeau:format(
 +
'modèle',
 +
lienUrl(doc, 'créer cette sous-page', 'edit', ''),
 +
'modèle'
 +
)
 +
end
 +
if page.namespace == 10 then
 +
texteBandeau = texteBandeau .. '[[Catégorie:Modèle sans documentation]]'
 +
elseif page.namespace == 828 then
 +
if page.baseText == 'Carte/données' or page.baseText == 'Country data' or page.text:sub(1, 12) == 'Utilisateur:' then
 +
-- pas de catégorisation pour : modèles de données, pseudo-namespace "Module:Utilisateur:Toto/Nom du module"
 +
else
 +
texteBandeau = texteBandeau .. '[[Catégorie:Module sans documentation]]'
 +
end
 +
end
 +
local param = {
 +
['icône'] = 'Book-cover-A-Z.svg',
 +
alt = 'domaine public',
 +
style = 'width:80%;',
 +
texte = texteBandeau,
 +
}
 +
res:wikitext(require('Module:Bandeau')._bandeau(param))
 +
end
  
−
    table.insert(entete, '; padding:1em 1em 0.8em;">')
+
res
−
    table.insert(entete, '<div style="margin-bottom:1ex; border-bottom:1px solid #aaa; padding-bottom:3px;">')
+
:newline()
−
    table.insert(entete, '[[Fichier:Template-info.png|50px|alt=Documentation du modèle|link=]]')
+
:tag('div')
−
    table.insert(entete, '<span style="font-weight:bold; font-size:125%">&nbsp;')
+
:css('clear', 'both')
−
 
+
−
    if args.titre then
+
return res
−
        table.insert(entete, args.titre)
+
end
−
    else
 
−
        table.insert(entete, 'Documentation')
 
−
    end
 
−
    table.insert(entete, '</span>')
 
  
−
    if not args.contenu then
+
local function notice(args, page, doc, existeDoc)
−
        table.insert(entete, '<span id="doc_editlinks" class="mw-editsection plainlinks">&#91;[')
+
local res = mw.html.create('div')
−
        table.insert(entete, '{{fullurl:')
+
:css('border-top', '1px solid #aaa')
 +
:css('margin', '1.5em 0 0')
  
−
        if args[1] then
+
local contenuParagraphe = res
−
            if p.ifexist(args[1]) then
+
:tag('p')
−
                table.insert(entete, args[1])
+
:addClass('plainlinks')
−
                table.insert(entete, '|action=edit modifier}}]&#93;&#32;&#91;{{Purger le cache|purger}}')
+
:css('margin-bottom', '0')
−
            else
+
:css('padding-left', '1em')
−
                table.insert(entete, args[1])
+
:css('font-style', 'italic')
−
                table.insert(entete, '|action=edit&preload=Modèle:Documentation/Preload créer}}]')
 
−
            end
 
−
        else
 
−
            if p.ifexist(p.docname(frame)) then
 
−
                table.insert(entete, p.docname(frame))
 
−
                table.insert(entete, '|action=edit modifier}}]&#93;&#32;&#91;{{Purger le cache|purger}}')
 
−
            else
 
−
                table.insert(entete, p.docname(frame))
 
−
                table.insert(entete, '|action=edit&preload=Modèle:Documentation/Preload créer}}]')
 
−
            end
 
−
        end
 
−
        table.insert(entete, '&#93;</span>')
 
−
    end
 
  
−
    table.insert(entete, '</div>')
+
if args.contenu then
−
    return table.concat(entete)
+
if args.notice then
−
end
+
contenuParagraphe:wikitext(args.notice .. '<br />')
 +
else
 +
contenuParagraphe
 +
:wikitext('La [[Aide:Documentation de modèle|documentation]] ')
 +
:wikitext('de ce [[Aide:Modèle|modèle]] est directement ')
 +
:wikitext('[[Aide:Inclusion|incluse]] dans le corps de ce dernier. ')
 +
:wikitext(lienUrl(page, 'Cliquez ici pour purger le cache', 'purge'))
 +
:wikitext('.<br /> 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', ''))
 +
:wikitext('.<br /> ')
 +
end
 +
else
 +
if existeDoc then
 +
local lienAide = '[[Aide:Modèle|modèle]]'
 +
if args.module then
 +
lienAide = '[[Aide:Module|module]]'
 +
end
 +
contenuParagraphe
 +
:wikitext('La [[Aide:Documentation de modèle|documentation]] de ce ')
 +
:wikitext(lienAide)
 +
:wikitext(' est [[Aide:Inclusion|incluse]] depuis sa [[')
 +
:wikitext(tostring(doc))
 +
:wikitext('|sous-page de documentation]]&nbsp;')
 +
:tag('span')
 +
:css('font-size', '89%')
 +
:css('font-style', 'normal')
 +
:wikitext('(')
 +
:wikitext(lienUrl(doc, 'modifier'))
 +
:wikitext('&nbsp;|&nbsp;')
 +
:wikitext(lienUrl(doc, 'historique', 'history'))
 +
:wikitext(').<br /> ')
 +
:done()
 +
:wikitext('Veuillez placer les catégories dans la sous-page ')
 +
:wikitext(lienUrl(doc, '/Documentation'))
 +
:wikitext('.<br /> ')
 +
end
 +
end
 +
 +
contenuParagraphe:wikitext('Les éditeurs peuvent travailler dans le ')
 +
 +
local titrePageBacasable = nomDocumentation(page):gsub('/Documentation', '/Bac à sable')
 +
local pageBacasable = mw.title.new(titrePageBacasable)
  
−
function p.contenu(frame, args)
+
if existePage(pageBacasable) then
−
    local contenu = {}
+
contenuParagraphe
−
    if args.contenu then
+
:wikitext('[[' .. titrePageBacasable .. '|bac à sable]]&nbsp;')
−
        table.insert(contenu, '\n')
+
:tag('span')
−
        table.insert(contenu, args.contenu)
+
:css('font-size', '89%')
−
    else
+
:css('font-style', 'normal')
−
        table.insert(contenu, frame:preprocess('<nowiki />\n'))
+
:wikitext('(')
−
        --Évite toute récursion
+
:wikitext(lienUrl(pageBacasable, 'modifier'))
−
        if args[1]
+
:wikitext(')')
−
        and frame:preprocess('{{FULLPAGENAMEE}}') ~= frame:preprocess('{{FULLPAGENAMEE:' .. args[1] .. '}}')
+
else
−
        and p.ifexist(args[1]) then
+
local preLoad = '2'
−
            table.insert(contenu, frame:preprocess('{{' .. args[1] .. '}}'))
+
if args.module then
−
        elseif frame:preprocess('{{FULLPAGENAMEE}}') ~= frame:preprocess('{{FULLPAGENAMEE:' .. p.docname(frame) .. '}}')
+
preLoad = nil
−
        and p.ifexist(p.docname(frame)) then
+
end
−
            table.insert(contenu, frame:preprocess('{{' .. p.docname(frame) .. '}}'))
+
contenuParagraphe
−
        end
+
:wikitext('bac à sable&nbsp;')
−
    end
+
:tag('span')
 +
:css('font-size', '89%')
 +
:css('font-style', 'normal')
 +
:wikitext('(')
 +
:wikitext(lienUrl(pageBacasable, 'créer', 'edit', preLoad))
 +
:wikitext(')')
 +
end
 +
 +
if not args.module then
 +
contenuParagraphe:wikitext(' et la page de ')
  
−
    table.insert(contenu, frame:preprocess('\n<nowiki /><div style="clear:both" />\n'))
+
local titrePageTest = nomDocumentation(page):gsub('/Documentation', '/Test')
 +
local pageTest = mw.title.new(titrePageTest)
 +
 +
if existePage(pageTest) then
 +
contenuParagraphe
 +
:wikitext('[[' .. titrePageTest .. '|test]]&nbsp;')
 +
:tag('span')
 +
:css('font-size', '89%')
 +
:css('font-style', 'normal')
 +
:wikitext('(')
 +
:wikitext(lienUrl(pageTest, 'modifier'))
 +
:wikitext(')')
 +
else
 +
contenuParagraphe
 +
:wikitext('test&nbsp;')
 +
:tag('span')
 +
:css('font-size', '89%')
 +
:css('font-style', 'normal')
 +
:wikitext('(')
 +
:wikitext(lienUrl(pageTest, 'créer', 'edit', '3'))
 +
:wikitext(')')
 +
end
 +
end
 +
contenuParagraphe:wikitext('.')
  
−
    return table.concat(contenu)
+
return res
 
end
 
end
  
−
function p.notice(frame, args)
+
function p._documentation(args)
−
    local notice = {}
+
local page = mw.title.getCurrentTitle()
 +
local titreDoc = nomDocumentation(page)
 +
local doc = mw.title.new(args[1] or titreDoc)
 +
local existeDoc = existePage(doc)
 +
local res = mw.html.create()
 +
 +
--Bandeau pour les sous-pages /Bac à sable
 +
if page.subpageText == 'Bac à sable' then
 +
res
 +
:tag('div')
 +
:css('clear', 'both')
 +
:done()
 +
:wikitext(mw.getCurrentFrame():expandTemplate{title = 'Sous-page de bac à sable'})
 +
end
  
−
    if args.contenu then
+
--Génération de la documentation
−
        table.insert(notice, '<div class="plainlinks" style="border-top:1px solid #aaa; margin: 1em 0 0;">')
+
res
−
        table.insert(notice, '<p style="margin-bottom:0; padding-left:1em; font-style:italic;">\n')
+
:tag('div')
 +
:css('clear', 'both')
 +
:css('margin', '1em 0 0 0')
 +
:css('border', '1px solid #aaa')
 +
:css('background', args.couleur or '#ecfcf4')
 +
:css('padding', '1em 1em 0.8em')
 +
:node(entete(args, page, doc, existeDoc))
 +
:wikitext(protection(page, doc, existeDoc, args['message protection']))
 +
:node(contenu(args, doc, existeDoc))
 +
:node(notice(args, page, doc, existeDoc))
  
−
        if args.notice then
+
--Catégorisation des modules, en rangeant à part les modules de données
−
            table.insert(notice, args.notice)
+
if page.namespace == 828 and page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
−
        else
+
if page.isSubpage and page.baseText == 'Carte/données' then
−
            table.insert(notice, 'La [[Aide:Comment documenter un modèle ?|documentation]] de ce [[Aide:Modèle|modèle]] ')
+
res:wikitext("[[Catégorie:Module de paramétrage de carte]]")
−
            table.insert(notice, 'est directement [[Aide:Inclusion|incluse]] dans le corps de ce dernier.<br />')
+
elseif page.isSubpage and page.baseText == 'Country data' then
−
            table.insert(notice, 'Si cette page est protégée, veuillez transférer le contenu de la documentation vers sa ')
+
res:wikitext("[[Catégorie:Module d'informations pays]]")
−
            table.insert(notice, '[{{fullurl:' .. p.docname(frame))
+
else
−
            table.insert(notice, '|action=edit&preload=Modèle:Documentation/Preload sous-page dédiée}}].')
+
res:wikitext("[[Catégorie:Module en langage Lua]]")
−
        end
+
end
−
    else
+
end
−
        if args[1] and p.ifexist(args[1]) or p.ifexist(p.docname(frame)) then
 
−
            table.insert(notice, '<div class="plainlinks" style="border-top:1px solid #aaa; margin: 1em 0 0;">')
 
−
            table.insert(notice, '<p style="margin-bottom:0; padding-left:1em; font-style:italic;">')
 
−
            table.insert(notice, 'La [[Aide:Comment documenter un modèle ?|documentation]] de ce ')
 
−
            table.insert(notice, '[[Aide:Modèle|modèle]] est [[Aide:Inclusion|incluse]] depuis sa ')
 
  
−
            if args[1] then
+
return tostring(res)
−
                table.insert(notice, '[[' .. args[1] .. '|sous-page de documentation]]')
+
end
−
            else
 
−
                table.insert(notice, '[[' .. p.docname(frame) .. '|sous-page de documentation]]')
 
−
            end
 
  
−
            table.insert(notice, '&nbsp;<span style="font-size:89%; font-style:normal;">(')
+
function p.documentation(frame)
−
            table.insert(notice, '[{{fullurl:')
+
local args = {}
 +
local argsParent = frame:getParent().args
  
−
            if args[1] then
+
--Paramètres vides interprétés par Lua
−
                table.insert(notice, args[1] .. '|action=edit}} modifier]')
+
for cle, val in pairs(argsParent) do
−
                table.insert(notice, '&nbsp;|&nbsp;[{{fullurl:')
+
if val ~= '' then
−
                table.insert(notice, args[1] .. '|action=history}} historique]')
+
args[cle] = mw.text.trim(val)
−
            else
+
end
−
                table.insert(notice, p.docname(frame) .. '|action=edit}} modifier]')
+
end
−
                table.insert(notice, '&nbsp;|&nbsp;[{{fullurl:')
 
−
                table.insert(notice, p.docname(frame) .. '|action=history}} historique]')
 
−
            end
 
−
            table.insert(notice, ')</span>.<br />')
 
−
        else
 
−
            table.insert(notice, '<div class="plainlinks">')
 
−
            table.insert(notice, '<p style="margin-bottom:0; padding-left:1em; font-style:italic;">')
 
−
        end
 
−
        table.insert(notice, 'Les éditeurs peuvent travailler dans le ')
 
  
−
        if args[1] and p.ifexist(frame:preprocess('{{#rel2abs:' .. args[1] .. '/../Bac à sable}}'))
+
return p._documentation(args)
−
        or p.ifexist(frame:preprocess('{{#rel2abs:' .. p.docname(frame) .. '/../Bac à sable}}')) then
+
end
−
            table.insert(notice, '[[{{#rel2abs:')
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '/../Bac à sable}}|bac à sable]]')
 
−
            table.insert(notice, '&nbsp;<span style="font-size:89%; font-style:normal;">(')
 
−
            table.insert(notice, '[{{fullurl:{{#rel2abs:')
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '/../Bac à sable}}|action=edit}} modifier])</span>')
 
−
        else
 
−
            table.insert(notice, 'bac à sable&nbsp;<span style="font-size:89%; font-style:normal;">(')
 
−
            table.insert(notice, '[{{fullurl:{{#rel2abs:')
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '/../Bac à sable}}|action=edit&preload=Modèle:Documentation/Preload2}} créer]')
 
−
            table.insert(notice, ')</span>')
 
−
        end
 
−
        table.insert(notice, ' et la page de ')
 
−
 
 
−
        if args[1] and p.ifexist(frame:preprocess('{{#rel2abs:' .. args[1] .. '/../Test}}'))
 
−
        or p.ifexist(frame:preprocess('{{#rel2abs:' .. p.docname(frame) .. '/../Test}}')) then
 
−
            table.insert(notice, '[[{{#rel2abs:')
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '/../Test}}|test]]')
 
−
            table.insert(notice, '&nbsp;<span style="font-size:89%; font-style:normal;">(')
 
−
            table.insert(notice, '[{{fullurl:{{#rel2abs:')
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '/../Test}}|action=edit}} modifier])</span>')
 
−
        else
 
−
            table.insert(notice, 'test&nbsp;<span style="font-size:89%; font-style:normal;">(')
 
−
            table.insert(notice, '[{{fullurl:{{#rel2abs:')
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '/../Test}}|action=edit&preload=Modèle:Documentation/Preload3}} créer]')
 
−
            table.insert(notice, ')</span>')
 
−
        end
 
−
        table.insert(notice, '.<br />Veuillez placer les catégories dans la sous-page ')
 
−
        table.insert(notice, '<span class="plainlinks">[')
 
−
        table.insert(notice, '{{fullurl:')
 
−
        if args[1] and p.ifexist(args[1]) or p.ifexist(p.docname(frame)) then
 
−
            if args[1] then
 
−
                table.insert(notice, args[1])
 
−
            else
 
−
                table.insert(notice, p.docname(frame))
 
−
            end
 
−
            table.insert(notice, '|action=edit')
 
  
−
        else
+
function p.nomDocumentation(frame)
−
            if args[1] then
+
if frame.args[1] and mw.text.trim(frame.args[1]) ~= '' then
−
                table.insert(notice, args[1])
+
return frame.args[1]
−
            else
+
else
−
                table.insert(notice, p.docname(frame))
+
local titreDoc = nomDocumentation(mw.title.getCurrentTitle())
−
            end
+
if mw.title.new(titreDoc).exists then
−
            table.insert(notice, '|action=edit&preload=Modèle:Documentation/Preload')
+
return titreDoc
−
        end
+
end  
−
        table.insert(notice, ' /Documentation}}].')
+
end
−
    end
 
−
    table.insert(notice, '</p></div></div>')
 
−
    return table.concat(notice)
 
 
end
 
end
  
 
return p
 
return p

Version actuelle datée du 15 mai 2017 à 08:40

La documentation pour ce module peut être créée à Module:Documentation/doc 

--Ce module implémente le modèle {{Documentation}}.

local p = {}

local function existePage(page)
	return page and page.exists
end

local function nomDocumentation(page)
	--On n'est pas dans une sous-page
	if not page.isSubpage then
		return page.subjectNsText .. ':' .. page.text .. '/Documentation'
	end
 
	--On est dans une sous-page
	local sousPage = page.subpageText
	if sousPage == 'Documentation'
	or sousPage == 'Bac à sable'
	or sousPage == 'Test' then
		return page.subjectNsText .. ':' .. page.baseText .. '/Documentation'
	else
		return page.subjectNsText .. ':' .. page.text .. '/Documentation'
	end
end

local function lienUrl(nomPage, titrePage, action, pagePreload)
	local argument = {['action'] = action or 'edit'}
 
	if pagePreload then
		argument['preload'] = 'Modèle:Documentation/Preload' .. pagePreload
	end

	return mw.ustring.format('[%s %s]', nomPage:fullUrl(argument), titrePage)
end

local function entete(args, page, doc, existeDoc)
	local res = mw.html.create('div')

	res
		:css('margin-bottom', '1ex')
		:css('border-bottom', '1px solid #aaa')
		:css('padding-bottom', '3px')
 		:wikitext('[[Fichier:Template-info.png|50px|alt=|link=]]')
	 	:tag('span')
	 		:css('font-weight', 'bold')
	 		:css('font-size', '125%')
	 		:css('vertical-align', 'middle')
	 		:wikitext('&nbsp;')
	 		:wikitext(args.titre or 'Documentation')
	 		:done()

	if not args.contenu then
		local editionLien = res:tag('span')
			:addClass('mw-editsection plainlinks')
			:css('vertical-align', 'middle')
			:wikitext('&#91;')

		if existeDoc then
			editionLien:wikitext(lienUrl(doc, 'modifier'))
		else
			if args.module then
				editionLien:wikitext(lienUrl(doc, 'créer', 'edit', 'Module'))
			else
				editionLien:wikitext(lienUrl(doc, 'créer', 'edit', ''))
			end
		end

		editionLien
			:wikitext('&#93;&#32;&#91;')
			:wikitext(lienUrl(page, 'purger', 'purge'))
			:wikitext('&#93;')
	end

	return res
end

local function protection(page, doc, existeDoc, message)
	-- Insertion automatique du modèle de protection.
	local niveauProtection = page.protectionLevels.edit

	if niveauProtection and niveauProtection[1] then
		local tableProtection = {
			autoconfirmed = {'semiProtection', '{{%s*[Ss]emi%-protection%s*l?o?n?g?u?e?[|}]'},
			editextendedsemiprotected = {'semiProtectionEtendue', '{{%s*[Ss]emi%-protection étendue%s*[|}]'},
			sysop = {'protection', '{{%s*[Pp]rotection%s*[|}]'},
		}
		local protection = tableProtection[niveauProtection[1]]
		if existeDoc then
			-- Vérification qu'il n'y a pas déjà un modèle de
			-- protection dans la documentation du modèle.
			local contenuDoc = doc:getContent()
			if contenuDoc:match(protection[2]) then
				protection = false
			end
		end

		if protection then
			if message == '' then
				message = nil
			end
			return require('Module:Protection').main({message}, protection[1], page)
		end
	end
end

local function contenu(args, doc, existeDoc)
	local page = mw.title.getCurrentTitle()
	local res = mw.html.create():newline()

	if args.contenu then
		res:wikitext(args.contenu)
	elseif existeDoc then
		local frame = mw.getCurrentFrame()
		if frame.args and frame.args['contenu sous-page'] then
			res:wikitext(frame.args['contenu sous-page'])
		else
			res:wikitext(frame:expandTemplate{title = doc.prefixedText})
		end
	elseif page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
		local texteBandeau = '<b>Ce %s ne possède aucune [[Aide:Documentation de modèle|documentation]] '
			..'explicative en sous-page</b>, pas même une description succincte.<br> '
			..'Vous pouvez %s afin de documenter ce %s adéquatement.'
		if args.module then
			texteBandeau = texteBandeau:format(
				'module',
				lienUrl(doc, 'créer cette sous-page', 'edit', 'Module'),
				'module'
			)
		else
			texteBandeau = texteBandeau:format(
				'modèle',
				lienUrl(doc, 'créer cette sous-page', 'edit', ''),
				'modèle'
			)
		end
		if page.namespace == 10 then
			texteBandeau = texteBandeau .. '[[Catégorie:Modèle sans documentation]]'
		elseif page.namespace == 828 then
			if page.baseText == 'Carte/données' or page.baseText == 'Country data' or page.text:sub(1, 12) == 'Utilisateur:' then
				-- pas de catégorisation pour : modèles de données, pseudo-namespace "Module:Utilisateur:Toto/Nom du module"
			else
				texteBandeau = texteBandeau .. '[[Catégorie:Module sans documentation]]'
			end
		end
		local param = {
			['icône'] = 'Book-cover-A-Z.svg',
			alt = 'domaine public',
			style = 'width:80%;',
			texte = texteBandeau,
		}
		res:wikitext(require('Module:Bandeau')._bandeau(param))
	end

	res
		:newline()
		:tag('div')
			:css('clear', 'both')
 
	return res
end

local function notice(args, page, doc, existeDoc)
	local res = mw.html.create('div')
		:css('border-top', '1px solid #aaa')
		:css('margin', '1.5em 0 0')

	local contenuParagraphe = res
		:tag('p')
			:addClass('plainlinks')
			:css('margin-bottom', '0')
			:css('padding-left', '1em')
			:css('font-style', 'italic')

	if args.contenu then
		if args.notice then
			contenuParagraphe:wikitext(args.notice .. '<br />')
		else
			contenuParagraphe
				:wikitext('La [[Aide:Documentation de modèle|documentation]] ')
				:wikitext('de ce [[Aide:Modèle|modèle]] est directement ')
				:wikitext('[[Aide:Inclusion|incluse]] dans le corps de ce dernier. ')
				:wikitext(lienUrl(page, 'Cliquez ici pour purger le cache', 'purge'))
				:wikitext('.<br /> 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', ''))
				:wikitext('.<br /> ')
		end
	else
		if existeDoc then
			local lienAide = '[[Aide:Modèle|modèle]]'
			if args.module then
				lienAide = '[[Aide:Module|module]]'
			end
			contenuParagraphe
				:wikitext('La [[Aide:Documentation de modèle|documentation]] de ce ')
				:wikitext(lienAide)
				:wikitext(' est [[Aide:Inclusion|incluse]] depuis sa [[')
				:wikitext(tostring(doc))
				:wikitext('|sous-page de documentation]]&nbsp;')
				:tag('span')
					:css('font-size', '89%')
					:css('font-style', 'normal')
					:wikitext('(')
					:wikitext(lienUrl(doc, 'modifier'))
					:wikitext('&nbsp;|&nbsp;')
					:wikitext(lienUrl(doc, 'historique', 'history'))
					:wikitext(').<br /> ')
					:done()
				:wikitext('Veuillez placer les catégories dans la sous-page ')
				:wikitext(lienUrl(doc, '/Documentation'))
				:wikitext('.<br /> ')
		end
	end
	
	contenuParagraphe:wikitext('Les éditeurs peuvent travailler dans le ')
	
	local titrePageBacasable = nomDocumentation(page):gsub('/Documentation', '/Bac à sable')
	local pageBacasable = mw.title.new(titrePageBacasable)

	if existePage(pageBacasable) then
		contenuParagraphe
			:wikitext('[[' .. titrePageBacasable .. '|bac à sable]]&nbsp;')
			:tag('span')
				:css('font-size', '89%')
				:css('font-style', 'normal')
				:wikitext('(')
				:wikitext(lienUrl(pageBacasable, 'modifier'))
				:wikitext(')')
	else
		local preLoad = '2'
		if args.module then
			preLoad = nil
		end
		contenuParagraphe
			:wikitext('bac à sable&nbsp;')
			:tag('span')
				:css('font-size', '89%')
				:css('font-style', 'normal')
				:wikitext('(')
				:wikitext(lienUrl(pageBacasable, 'créer', 'edit', preLoad))
				:wikitext(')')
	end
	
	if not args.module then
		contenuParagraphe:wikitext(' et la page de ')

		local titrePageTest = nomDocumentation(page):gsub('/Documentation', '/Test')
		local pageTest = mw.title.new(titrePageTest)
 
		if existePage(pageTest) then
			contenuParagraphe
				:wikitext('[[' .. titrePageTest .. '|test]]&nbsp;')
				:tag('span')
					:css('font-size', '89%')
					:css('font-style', 'normal')
					:wikitext('(')
					:wikitext(lienUrl(pageTest, 'modifier'))
					:wikitext(')')
		else
			contenuParagraphe
				:wikitext('test&nbsp;')
				:tag('span')
					:css('font-size', '89%')
					:css('font-style', 'normal')
					:wikitext('(')
					:wikitext(lienUrl(pageTest, 'créer', 'edit', '3'))
					:wikitext(')')
		end
	end
	contenuParagraphe:wikitext('.')

	return res
end

function p._documentation(args)
	local page = mw.title.getCurrentTitle()
	local titreDoc = nomDocumentation(page)
	local doc = mw.title.new(args[1] or titreDoc)
	local existeDoc = existePage(doc)
	local res = mw.html.create()
	
	--Bandeau pour les sous-pages /Bac à sable
	if page.subpageText == 'Bac à sable' then
		res
			:tag('div')
				:css('clear', 'both')
				:done()
			:wikitext(mw.getCurrentFrame():expandTemplate{title = 'Sous-page de bac à sable'})
	end

	--Génération de la documentation
	res
		:tag('div')
			:css('clear', 'both')
			:css('margin', '1em 0 0 0')
			:css('border', '1px solid #aaa')
			:css('background', args.couleur or '#ecfcf4')
			:css('padding', '1em 1em 0.8em')
			:node(entete(args, page, doc, existeDoc))
			:wikitext(protection(page, doc, existeDoc, args['message protection']))
			:node(contenu(args, doc, existeDoc))
			:node(notice(args, page, doc, existeDoc))

	--Catégorisation des modules, en rangeant à part les modules de données
	if page.namespace == 828 and page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
		if page.isSubpage and page.baseText == 'Carte/données' then
			res:wikitext("[[Catégorie:Module de paramétrage de carte]]")
		elseif page.isSubpage and page.baseText == 'Country data' then
			res:wikitext("[[Catégorie:Module d'informations pays]]")
		else
			res:wikitext("[[Catégorie:Module en langage Lua]]")
		end
	end

	return tostring(res)
end

function p.documentation(frame)
	local args = {}
	local argsParent = frame:getParent().args

	--Paramètres vides interprétés par Lua
	for cle, val in pairs(argsParent) do
		if val ~= '' then
			args[cle] = mw.text.trim(val)
		end
	end

	return p._documentation(args)
end

function p.nomDocumentation(frame)
	if frame.args[1] and mw.text.trim(frame.args[1]) ~= '' then
		return frame.args[1]
	else
		local titreDoc = nomDocumentation(mw.title.getCurrentTitle())
		if mw.title.new(titreDoc).exists then
			return titreDoc
		end 
	end
end

return p
Récupérée de « https://lagny-sur-marne.wiki/index.php?title=Module:Documentation&oldid=19307 »