Module:Documentation
Révision datée du 9 août 2018 à 08:33 par mcfr>JSBM
[purger]
Ceci est la page de documentation, elle va être incluse dans le page principale du module. Voir Modèle:Documentation pour plus d'informationsThis module implements {{Documentation}}
.
Dependencies
ko:모듈:Documentation
pl:Moduł:Dokumentacja
ru:Модуль:Документация
zh:模块:Documentation
local p = {} local defaultDocPage = 'doc' local getType = function( namespace, page ) local pageType = 'modèle' if namespace == 'Module' then pageType = 'module' elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then pageType = 'stylesheet' elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.js$' ) then pageType = 'script' elseif namespace == 'MediaWiki' then pageType = 'message' end return pageType end -- Creating a documentation page or transclution through {{subst:doc}} function p.create( f ) local args = require( 'Module:ProcessArgs' ).norm() local page = mw.title.getCurrentTitle() local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage local out if not args.content and tostring( page ) == docPage then out = f:preprocess( '{{subst:Modèle:Documentation/preload}}' ) else local templateArgs = {} for _, key in ipairs{ 'type', 'page', 'content' } do local val = args[key] if val then if key == 'content' then val = '\n' .. val .. '\n' end table.insert( templateArgs, key .. '=' .. val ) end end out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}' out = out:gsub( '|}}', '}}' ) if not args.content then out = out .. '\n<!-- Put categories/interwiki on the documentation page -->' end end if not mw.isSubsting() then out = f:preprocess( out ) if not args.nocat then out = out .. '[[Catégorie:Pages with templates requiring substitution]]' end end return out end -- Header on the documentation page function p.docPage( f ) local args = require( 'Module:ProcessArgs' ).merge( true ) local badDoc = args.baddoc if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then if badDoc then f:callParserFunction( '#dplvar:set', '$doc bad', '1' ) end return end local page = mw.title.getCurrentTitle() local namespace = page.nsText local pageType = mw.ustring.lower( args.type or getType( namespace, page ) ) local body = mw.html.create( 'div' ):addClass( 'documentation-header' ) body :css{ ['margin-bottom'] = '0.8em', padding = '0.8em 1em 0.7em', ['background-color'] = '#' .. ( badDoc and 'F9F2EA' or 'EAF4F9' ), border = '1px solid #AAA' } :tag( 'div' ) :css( 'float', 'right' ) :wikitext( '[[', page:fullUrl( 'action=purge' ), ' purger]]' ) :done() :wikitext( 'Ceci est la page de documentation, elle ', pageType == 'module' and 'va' or 'devrait', ' être incluse dans le page principale du ', pageType, '. ', 'Voir [[Modèle:Documentation]] pour plus d\'informations' ) if badDoc then body:wikitext( "<br>'''La documentation de ce ", pageType, " a besoin d'être améliorée.'''" ) end if not ( args.nocat or namespace == 'Utilisateur' ) then body:wikitext( '[[Catégorie:Pages de documentation]]' ) end return body end -- Wrapper around the documentation on the main page function p.page( f ) -- mw.text.trim uses mw.ustring.gsub, which silently fails on large strings local function trim( s ) return string.gsub( s, '^[\t\r\n\f ]*(.-)[\t\r\n\f ]*$', '%1' ) end local args = require( 'Module:ProcessArgs' ).merge( true ) local page = mw.title.getCurrentTitle() local namespace = page.nsText local docText = trim( args.content or '' ) if docText == '' then docText = nil end local docPage local noDoc if docText then docPage = page else docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/' .. defaultDocPage ) noDoc = args.nodoc or not docPage.exists end local badDoc = args.baddoc local pageType = mw.ustring.lower( args.type or getType( namespace, page ) ) if not docText and not noDoc then f:callParserFunction( '#dplvar:set', '$doc noheader', '1' ) docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } ) if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then badDoc = 1 end if docText == '' then docText = nil noDoc = 1 end end if docText then docText = '\n' .. docText .. '\n' end local action = 'modifier' local preload = '' local colour = 'EAF4F9' local message local category if noDoc then action = 'créer' preload = '&preload=Modèle:Documentation/preload' colour = 'F9EAEA' message = "'''Ce " .. pageType .. " n'a pas de documentation. " .. "Si vous savez comment l'utiliser, merci de la créer.'''" if not ( args.nocat or namespace == 'Utilisateur' ) then category = pageType .. ' sans documentation' if not mw.title.new( 'Catégorie:' .. category ).exists then category = 'Pages sans documentation' end end elseif badDoc then colour = 'F9F2EA' message = "'''La documentation de ce " .. pageType .. " a besoin d'être améliorée.'''\n" if not ( args.nocat or namespace == 'Utilisateur' ) then category = pageType .. 's avec une mauvaise documentation' if not mw.title.new( 'Catégorie:' .. category ).exists then category = 'Pages avec une mauvaise documentation' end end end local links = { '[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']', '[' .. docPage:fullUrl( 'action=history' ) .. ' historique]', '[' .. page:fullUrl( 'action=purge' ) .. ' purger]' } if not noDoc and page ~= docPage then table.insert( links, 1, '[[' .. docPage.fullText .. '|voir]]' ) end links = mw.html.create( 'span' ) :css( 'float', 'right' ) :wikitext( mw.text.nowiki( '[' ), table.concat( links, ' | ' ), mw.text.nowiki( ']' ) ) local body = mw.html.create( 'div' ):addClass( 'documentation' ) body:css{ ['background-color'] = '#' .. colour, border = '1px solid #AAA', padding = '0.8em 1em 0.7em', ['margin-top'] = '1em', clear = 'both' } local header = mw.html.create( 'div' ) :css{ margin = '-0.8em -1em 0.8em', padding = '0.8em 1em 0.7em', ['background-color'] = '#EAF4F9', ['border-bottom'] = 'inherit' } header :node( links ) :tag( 'span' ) :css{ ['font-weight'] = 'bold', ['font-size'] = '130%', ['margin-right'] = '1em', ['line-height'] = '1' } :wikitext( 'Documentation' ) if not noDoc and pageType ~= 'modèle' and pageType ~= 'message' then header :tag( 'span' ) :css( 'white-space', 'nowrap' ) :wikitext( '[[#the-code|Aller au code ↴]]' ) end body :node( header ):done() :wikitext( message ) :wikitext( docText ) if not noDoc and page ~= docPage then body :tag( 'div' ) :css{ margin = '0.7em -1em -0.7em', ['background-color'] = '#EAF4F9', ['border-top'] = 'inherit', padding = '0.8em 1em 0.7em', clear = 'both' } :node( links ) :wikitext( 'La documentation ci-dessus est insérée depuis [[', docPage.fullText, ']].' ) end local anchor = '' if not noDoc and pageType ~= 'modèle' and pageType ~= 'message' then anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' ) end local cat = "" if category then cat = '[[Catégorie:' .. category .. ']]' end return tostring( body ) .. tostring( anchor ) .. cat end return p