Catégorie | ModÚle | Formulaire |
---|---|---|
Text | Text | Text |
Author | Author | Author |
Collection | Collection | Collection |
Keywords | Keywords | Keywords |
Subpage | Subpage | Subpage |
ModĂšle | Formulaire |
---|---|
BrowseTexts | BrowseTexts |
BrowseAuthors | BrowseAuthors |
BrowseLetters | BrowseLetters |
Template:GalleryAuthorsPreviewSmall
Special pages :
Module:Documentation
Aller Ă la navigation
Aller Ă la recherche
Ce module implémente le modÚle {{Documentation}}. Voir la page du modÚle pour les instructions d'utilisation.
Fonctions exportables
documentation(frame)
â Fonction principale du module â Ă appeler avec#invoke
dans un modĂšle â renvoyant le code HTML de la documentation._documentation(args)
â Fonction subsidiaire du module â Ă appeler avecrequire()
dans un autre module â et renvoyant le code HTML de la documentation.
Autres fonctions
nomSouspage(page)
â Renvoie le nom d'une sous-page, en tenant compte des cas oĂč l'on se trouverait dĂ©jĂ dans une sous-page "/Documentation", "/Bac Ă sable" ou "/Test".existePage(page)
â Teste si une page existe.lienUrl(nomPage, titrePage, action, pagePreload)
â Retourne le lien URL wikifiĂ© de la forme [nomPage titrePage] voulu.entete(args, page, doc, existeDoc)
â Construit l'entĂȘte de la documentation contenant l'image de documentation, le titre, et les liens de crĂ©ation/modification/purge.contenu(args, titreDoc, existeDoc)
â Retourne la concatĂ©nation de la documentation en dur, sans cadre vert. C'est cette mĂ©thode qui gĂ©nĂšre la sous-page /Documentation rĂ©digĂ©e par l'utilisateur.notice(args, page, doc, existeDoc)
â Retourne la notice de la documentation situĂ© en bas de page. Elle peut-ĂȘtre modifiĂ©e par l'utilisateur grĂące au paramĂštre «|notice=
» dans un modÚle seulement si le paramÚtre «|contenu=
» est renseigné.
--Ce module implémente le modÚle {{Documentation}}.
local p = {}
local function existePage(page)
return page and page.exists
end
local function nomSouspage(page, souspage)
--On n'est pas dans une sous-page
if not page.isSubpage then
return page.subjectNsText .. ':' .. page.text .. '/' .. souspage
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 .. '/' .. souspage
else
return page.subjectNsText .. ':' .. page.text .. '/' .. souspage
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(' ')
:wikitext(args.titre or 'Documentation')
:done()
local editionLien = res:tag('span')
:addClass('mw-editsection plainlinks')
:css('vertical-align', 'middle')
if not args.contenu then
editionLien:wikitext('[')
if existeDoc then
editionLien:wikitext(lienUrl(doc, 'modifier'))
else
if page.namespace == 828 then
editionLien:wikitext(lienUrl(doc, 'créer', 'edit', 'Module'))
else
editionLien:wikitext(lienUrl(doc, 'créer', 'edit', ''))
end
end
editionLien:wikitext('] ')
end
editionLien
:wikitext('[')
:wikitext(lienUrl(page, 'purger', 'purge'))
:wikitext(']')
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*[|}]', '{{%s*[Ss]emi%-protection +longue%s*[|}]'},
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
local alreadyShown = false
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]) or (protection[3] and contenuDoc:match(protection[3])) then
alreadyShown = true
end
end
if not alreadyShown then
if message == '' then
message = nil
end
return require('Module:Protection').main({message}, protection[1], page)
end
end
end
-- pour les bacs à sable, on retire les balises de catégories
-- 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 ]*$', '')
return contenuDoc
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 contenuDoc = mw.getCurrentFrame():expandTemplate{title = doc.prefixedText}
if page.subpageText == 'Bac Ă sable' or page.subpageText == 'Test' then
contenuDoc = retireBalisesCategories(contenuDoc)
end
res:wikitext(contenuDoc)
if args['complément'] then
res :newline()
:newline()
:wikitext(args['complément'])
end
elseif page.subpageText ~= 'Bac Ă sable' and page.subpageText ~= 'Test' then
local texteBandeau = '<b>Ce %s ne possĂšde aucune 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'
)
if 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"
end
else
texteBandeau = texteBandeau:format(
'modĂšle',
lienUrl(doc, 'créer cette sous-page', 'edit', ''),
'modĂšle'
)
end
local param = {
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 documentation ')
:wikitext('de ce modĂšle est directement ')
:wikitext('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 documentation de ce ')
:wikitext(lienAide)
:wikitext(' est incluse depuis sa [[')
:wikitext(tostring(doc))
:wikitext('|sous-page de documentation]] ')
:tag('span')
:css('font-size', '89%')
:css('font-style', 'normal')
:wikitext('(')
:wikitext(lienUrl(doc, 'modifier'))
:wikitext(' | ')
: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
return res
end
function p._documentation(args)
local page = mw.title.getCurrentTitle()
local titreDoc = args[1] or nomSouspage(page, 'Documentation')
local doc = mw.title.new(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 args.module and page.subpageText ~= 'Bac Ă sable' and page.subpageText ~= 'Test' then
if page.isSubpage and page.baseText == 'Country data' then
res:wikitext("[[Catégorie:Module d'informations pays|" .. page.subpageText .. "]]")
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
val = mw.text.trim(val)
if val ~= '' then
args[cle] = val
end
end
return p._documentation(args)
end
return p