Module:Documentation - Historique des versions

Yves.bertin : 1 révision importée

2024-11-20T11:23:22Z

1 révision importée

w.fr>Escargot bleu : idem couleur de fond

2024-05-10T07:19:20Z

idem couleur de fond

Yves.bertin : 1 révision importée

2020-08-07T16:43:19Z

1 révision importée

w:fr>Epok : Correction typo.

2020-05-02T18:40:20Z

Correction typo.

Voir les modifications

Yves.bertin : 1 révision importée

2019-02-24T14:17:10Z

1 révision importée

w.fr>Od1n : F60.5 (ça faisait longtemps) espaces et lignes vides

2018-09-01T11:45:25Z

F60.5 (ça faisait longtemps) espaces et lignes vides

Nouvelle page

--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:Test Template Info-Icon.svg|50px|alt=|link=]]')
:tag('span')
:css('font-weight', 'bold')
:css('font-size', '125%')
:css('vertical-align', 'middle')
:wikitext(' ')
: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('[')

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('] [')
:wikitext(lienUrl(page, 'purger', 'purge'))
:wikitext(']')
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*[|}]', '{{%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 existeDoc then
if args.contenu then
res :wikitext(args.contenu)
:newline()
:newline()
end

local frame = mw.getCurrentFrame()
if frame.args and frame.args['contenu sous-page'] then
local contenuDoc = frame.args['contenu sous-page']
if page.subpageText == 'Bac à sable' or page.subpageText == 'Test' then
contenuDoc = retireBalisesCategories(contenuDoc)
end
res:wikitext(contenuDoc)
else
local contenuDoc = frame:expandTemplate{title = doc.prefixedText}
if page.subpageText == 'Bac à sable' or page.subpageText == 'Test' then
contenuDoc = retireBalisesCategories(contenuDoc)
end
res:wikitext(contenuDoc)
end

if args['complément'] then
res :newline()
:newline()
:wikitext(args['complément'])
end

elseif args.contenu then
res:wikitext(args.contenu)

elseif page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
local texteBandeau = 'Ce %s ne possède aucune [[Aide:Documentation de modèle|documentation]] '
..'explicative en sous-page, pas même une description succincte. '
..'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"
else
texteBandeau = texteBandeau .. '[[Catégorie:Module sans documentation]]'
end
else
texteBandeau = texteBandeau:format(
'modèle',
lienUrl(doc, 'créer cette sous-page', 'edit', ''),
'modèle'
)
texteBandeau = texteBandeau .. '[[Catégorie:Modèle sans documentation]]'
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 .. ' ')
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('. 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('. ')
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]] ')
:tag('span')
:css('font-size', '89%')
:css('font-style', 'normal')
:wikitext('(')
:wikitext(lienUrl(doc, 'modifier'))
:wikitext(' | ')
:wikitext(lienUrl(doc, 'historique', 'history'))
:wikitext('). ')
:done()
:wikitext('Veuillez placer les catégories dans la sous-page ')
:wikitext(lienUrl(doc, '/Documentation'))
:wikitext('. ')
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]] ')
: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 ')
: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]] ')
:tag('span')
:css('font-size', '89%')
:css('font-style', 'normal')
:wikitext('(')
:wikitext(lienUrl(pageTest, 'modifier'))
:wikitext(')')
else
contenuParagraphe
:wikitext('test ')
: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 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
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

← Version précédente	Version du 20 novembre 2024 à 11:23
(Aucune différence)

@@ Ligne 7 : / Ligne 7 : @@
 end
-local function nomSouspage(page, souspage)
+local function textPagebase(page)
 	--On n'est pas dans une sous-page
 	if not page.isSubpage then
-		return page.subjectNsText .. ':' .. page.text .. '/' .. souspage
+		return page.text
 	end
@@ Ligne 18 : / Ligne 18 : @@
 	or sousPage == 'Bac à sable'
 	or sousPage == 'Test' then
-		return page.subjectNsText .. ':' .. page.baseText .. '/' .. souspage
+		return page.baseText
 	else
-		return page.subjectNsText .. ':' .. page.text .. '/' .. souspage
+		return page.text
 	end
 end
@@ Ligne 47 : / Ligne 51 : @@
 	-- Titre
 	res
-		:css('margin-bottom', '1ex')
+		:css('margin-bottom', '1em')
 		:css('border-bottom', '1px solid #aaa')
 		:css('padding-bottom', '3px')
- 		:wikitext('[[Fichier:Test Template Info-Icon.svg|50px|alt=|link=]]')
+		:tag('span')
-	 	:tag('span')
+			:addClass('documentation-icone')
-	 		:css('font-weight', 'bold')
+			:css('font-weight', 'bold')
-	 		:css('font-size', '125%')
+			:css('font-size', '125%')
-	 		:css('vertical-align', 'middle')
+			:css('vertical-align', 'middle')
-	 		:wikitext('&nbsp;')
+			:wikitext('&nbsp;')
-	 		:wikitext(args.titre or 'Documentation')
+			:wikitext(args.titre or 'Documentation')
-	 		:done()
+			:done()
 	-- Liens
@@ Ligne 203 : / Ligne 207 : @@
 				['icône'] = 'OOjs_UI_icon_book-ltr.svg',
 				alt = 'MIT',
 				style = 'width:80%;',
 				texte = texteBandeau,
@@ Ligne 221 : / Ligne 226 : @@
 	return res
 end
@@ Ligne 342 : / Ligne 362 : @@
 		end
 	end
-	contenuParagraphe:wikitext('.')
+	contenuParagraphe:wikitext('.<br>')
 	return res
@@ Ligne 364 : / Ligne 407 : @@
 	--Génération de la documentation
-	local couleur = '#ecfcf4'
+	local classeNamespace = 'documentation-modele'
 	if page.namespace == 828 then
-		couleur = '#ecf0fc'
+		classeNamespace = 'documentation-module'
 	end
 	res
 		:tag('div')
 			:css('clear', 'both')
 			:css('margin', '1em 0 0 0')
 			:css('border', '1px solid #aaa')
-			:css('background', couleur)
+			:css('padding', '0.5em 1em 0.8em')
 			:node(entete(args, page, doc, existeDoc))
 			:wikitext(protection(page, doc, existeDoc, args['message protection']))

← Version précédente	Version du 7 août 2020 à 16:43
(Aucune différence)

← Version précédente	Version du 24 février 2019 à 14:17
(Aucune différence)