« Module:Documentation » : différence entre les versions

    De WikiPasokh
    m (update code comment according to Special:Diff/989669779)
     
    m (1 version importée)
    (2 versions intermédiaires par 2 utilisateurs non affichées)
    Ligne 1 : Ligne 1 :
    -- This module implements {{documentation}}.
    -- Ce module implémente le modèle {{Méta documentation de modèle}}.
     
    -- 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
    end
    if not valArray then
    return msg
    end
    local function getMessageVal(match)
    match = tonumber(match)
    return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
    end
    return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
    end
    p.message = message


    local function makeWikilink(page, display)
    --On est dans une sous-page
    if display then
    local sousPage = page.subpageText
    return mw.ustring.format('[[%s|%s]]', page, display)
    if sousPage == 'Documentation'
    or sousPage == 'Bac à sable'
    or sousPage == 'Test' then
    return page.baseText
    else
    else
    return mw.ustring.format('[[%s]]', page)
    return page.text
    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, ' &#124; ') .. ')</span>'
    end
    p.makeToolbar = makeToolbar
    ----------------------------------------------------------------------------
    -- Argument processing
    ----------------------------------------------------------------------------


    local function makeInvokeFunc(funcName)
    if pagePreload then
    return function (frame)
    arguments['preload'] = 'Modèle:Documentation/' .. pagePreload
    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


    ----------------------------------------------------------------------------
    if arguments['action'] or arguments['preload'] then
    -- Entry points
    return mw.ustring.format('[%s %s]', nomPage:fullUrl(arguments), texteLien)
    ----------------------------------------------------------------------------
     
    function p.nonexistent(frame)
    if mw.title.getCurrentTitle().subpageText == 'testcases' then
    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', '1em')
    -- @args - table of arguments passed by the user
    :css('border-bottom', '1px solid #aaa')
    --]]
    :css('padding-bottom', '3px')
    local env = p.getEnvironment(args)
    :tag('span')
    local root = mw.html.create()
    :addClass('documentation-icone')
    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))
    :wikitext('&nbsp;')
    :tag('div')
    :wikitext(args.titre or 'Documentation')
    -- 'documentation-container'
    :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()
    :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')
     
    if args['aucun contenu additionnel'] == nil then
    if not args.contenu then
    if existeDoc then
    editionLien
    :wikitext('&#91;')
    :wikitext(lienUrl(doc, 'voir'))
    :wikitext('&#93; ')


    function p.getEnvironment(args)
    :wikitext('&#91;')
    --[[
    :wikitext(lienUrl(doc, 'modifier', 'edit'))
    -- Returns a table with information about the environment, including title
    :wikitext('&#93; ')
    -- objects and other namespace- or path-related data.
    -- @args - table of arguments passed by the user
    --
    -- Title objects include:
    -- 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('&#91;')
    -- returned by that function is memoized in the env table so that we don't call any of the functions
    :wikitext(lienUrl(doc, 'historique', 'history'))
    -- more than once. (Nils won't be memoized.)
    :wikitext('&#93; ')
    setmetatable(env, {
    else
    __index = function (t, key)
    local pagePreload = 'Preload'
    local envFunc = envFuncs[key]
    if page.namespace == 828 then
    if envFunc then
    pagePreload = 'PreloadModule'
    local success, val = pcall(envFunc)
    if success then
    env[key] = val -- Memoise the value.
    return val
    end
    end
    editionLien
    :wikitext('&#91;')
    :wikitext(lienUrl(doc, 'créer', 'edit', pagePreload))
    :wikitext('&#93; ')
    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('&#91;')
    -- The template (or module, etc.) title object.
    :wikitext(lienUrl(page, 'purger', 'purge'))
    -- Messages:
    :wikitext('&#93;')
    -- '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
    local niveauProtection = page.protectionLevels.edit
    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
    end


    ----------------------------------------------------------------------------
    -- pour les bacs à sable, on retire les balises de catégories
    -- Auxiliary templates
    -- 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


    p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')
    contenuDoc, count = mw.ustring.gsub(contenuDoc, '[\t\r\n\f ]*$', '')


    function p._getModuleWikitext(args, env)
    return contenuDoc
    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 function contenu(args, doc, existeDoc)
    --[=[
    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' --> '[[File: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'
    return '<div class="' .. message('clear') .. '"></div>'
    .. require('Module:Message box').main('ombox', omargs)
    end


    function p.protectionTemplate(env)
    -- Contenu auto haut
    -- Generates the padlock icon in the top right.
    if args['contenu auto haut'] then
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    res:wikitext(args['contenu auto haut'])
    -- Messages:
      :newline()
    -- 'protection-template' --> 'pp-template'
    -- 'protection-template-args' --> {docusage = 'yes'}
    local protectionLevels = env.protectionLevels
    if not protectionLevels then
    return nil
    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
    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',
    class = 'plainlinks',
    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')
    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


    function p.renderStartBoxLinks(data)
    return res
    --[[
    -- Generates the [view][edit][history][purge] or [create][purge] links from the data table.
    -- @data - a table of data generated by p.makeStartBoxLinksData
    --]]
    local function escapeBrackets(s)
    -- Escapes square brackets with HTML entities.
    s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
    s = s:gsub('%]', '&#93;')
    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 function lienWstat(nomPage, texteLien)
    --[=[
    local nomPageEncoded = mw.text.encode(nomPage)
    -- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
    local nomPageNoSpaces = mw.ustring.gsub(nomPageEncoded, ' ', '_')
    -- @args - a table of arguments passed by the user
    local url = 'https://wstat.fr/template/info/' .. nomPageNoSpaces
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    return mw.ustring.format('[%s %s]', url, texteLien)
    -- @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 heading = args.heading -- Blank values are not removed.
    if heading == '' then
    -- Don't display the start box if the heading arg is defined but blank.
    return nil
    end
    if heading then
    data.heading = heading
    elseif subjectSpace == 10 then -- Template namespace
    data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
    elseif subjectSpace == 828 then -- Module namespace
    data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
    elseif subjectSpace == 6 then -- File namespace
    data.heading = message('file-namespace-heading')
    else
    data.heading = message('other-namespaces-heading')
    end
    -- Heading CSS
    local headingStyle = args['heading-style']
    if headingStyle then
    data.headingStyleText = headingStyle
    else
    -- 'documentation-heading'
    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
    end


    function p.renderStartBox(data)
    local function lienRechercheModule(nomModule, texteLien)
    -- Renders the start box html.
    local nomModuleEncoded = mw.text.encode(nomModule)
    -- @data - a table of data generated by p.makeStartBoxData.
    local nomModuleNoSpaces = mw.ustring.gsub(nomModuleEncoded, ' ', '+')
    local sbox = mw.html.create('div')
    local quote = mw.text.encode('"')
    sbox
    local url = 'https://fr.wikipedia.org/w/index.php?title=Spécial:Recherche&ns828=1&search=insource:' .. quote .. nomModuleNoSpaces .. quote
    -- 'documentation-startbox'
    return mw.ustring.format('[%s %s]', url, texteLien)
    :addClass(message('start-box-class'))
    :newline()
    :tag('span')
    :addClass(data.headingClass)
    :attr('id', 'documentation-heading')
    :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
    return tostring(sbox)
    end
    end


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


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


    function p._content(args, env)
    -- Phrase "la documentation est générée par ..."
    -- Displays the documentation contents
    if args['nom modèle'] then
    -- @args - a table of arguments passed by the user
    local lienAide = '[[Aide:Modèle|modèle]]'
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    if page.namespace == 828 then
    env = env or p.getEnvironment(args)
    lienAide = '[[Aide:Module|module]]'
    local docTitle = env.docTitle
    end
    local content = args.content
    if not content and docTitle and docTitle.exists then
    content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
    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')


    function p._contentTitle(args, env)
    contenuParagraphe
    env = env or p.getEnvironment(args)
    :wikitext('La [[Aide:Documentation de modèle|documentation]] de ce ')
    local docTitle = env.docTitle
    :wikitext(lienAide)
    if not args.content and docTitle and docTitle.exists then
    :wikitext(' est générée par le modèle ')
    return docTitle.prefixedText
    :wikitext(mw.getCurrentFrame():expandTemplate{title = 'm', args = {args['nom modèle']} })
    :wikitext('.<br>')
    else
    else
    return ''
    contenuParagraphe
    :tag('span')
    :addClass('error')
    :wikitext('Erreur : le paramètre <code>nom modèle</code> n\'est pas renseigné.<br>')
    end
    end
    end


    ----------------------------------------------------------------------------
    -- Phrase indiquant la provenance du contenu (dans le corps ou en sous-page)
    -- End box
    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.endBox = makeInvokeFunc('_endBox')
    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._endBox(args, env)
    contenuParagraphe
    --[=[
    :wikitext('Veuillez placer les catégories sur cette page-là.<br>')
    -- This function generates the end box (also known as the link box).
    end
    -- @args - a table of arguments passed by the user
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    --
    --]=]
    -- Get environment data.
    env = env or p.getEnvironment(args)
    local subjectSpace = env.subjectSpace
    local docTitle = env.docTitle
    if not subjectSpace or not docTitle then
    return nil
    end
    -- Check whether we should output the end box at all. Add the end
    -- box by default if the documentation exists or if we are in the
    -- 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
    end


    -- Assemble the link box.
    -- Phrase indiquant les liens vers le bac à sable et la page de test
    local text = ''
    contenuParagraphe
    if linkBox then
    :wikitext('Les éditeurs peuvent travailler dans le ')
    text = text .. linkBox
     
    local titrePageBacasable = nomSouspage(page, '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', 'edit'))
    :wikitext(')')
    else
    else
    text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
    local pagePreload = 'Preload2'
    if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
    if page.namespace == 828 then
    -- We are in the user, template or module namespaces.
    pagePreload = nil
    -- 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
    contenuParagraphe
    :wikitext('bac à sable&nbsp;')
    :tag('span')
    :css('font-size', '89%')
    :css('font-style', 'normal')
    :wikitext('(')
    :wikitext(lienUrl(pageBacasable, 'créer', 'edit', pagePreload))
    :wikitext(')')
    end
    end
    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 '\n' .. tostring(box)
    if page.namespace ~= 828 then
    end
    contenuParagraphe:wikitext(' et la page de ')


    function p.makeDocPageBlurb(args, env)
    local titrePageTest = nomSouspage(page, 'Test')
    --[=[
    local pageTest = mw.title.new(titrePageTest)
    -- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
    -- @args - a table of arguments passed by the user
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    --
    -- Messages:
    -- 'edit-link-display' --> 'edit'
    -- 'history-link-display' --> 'history'
    -- 'transcluded-from-blurb' -->
    -- 'The above [[Wikipedia:Template documentation|documentation]]
    -- is [[Help:Transclusion|transcluded]] from $1.'
    -- 'module-preload' --> 'Template:Documentation/preload-module-doc'
    -- 'create-link-display' --> 'create'
    -- '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
    local ret
    if docTitle.exists then
    -- /doc exists; link to it.
    local docLink = makeWikilink(docTitle.prefixedText)
    local editUrl = docTitle:fullUrl{action = 'edit'}
    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
    return ret
    end


    function p.makeExperimentBlurb(args, env)
    if existePage(pageTest) then
    --[[
    contenuParagraphe
    -- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
    :wikitext('[[' .. titrePageTest .. '|test]]&nbsp;')
    -- @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')
    -- Messages:
    :wikitext('(')
    -- 'sandbox-link-display' --> 'sandbox'
    :wikitext(lienUrl(pageTest, 'modifier', 'edit'))
    -- 'sandbox-edit-link-display' --> 'edit'
    :wikitext(')')
    -- 'compare-link-display' --> 'diff'
    -- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
    -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
    -- 'sandbox-create-link-display' --> 'create'
    -- 'mirror-edit-summary' --> 'Create sandbox version of $1'
    -- 'mirror-link-display' --> 'mirror'
    -- 'mirror-link-preload' --> 'Template:Documentation/mirror'
    -- 'sandbox-link-display' --> 'sandbox'
    -- '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
    sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
    else
    local sandboxPreload
    if subjectSpace == 828 then
    sandboxPreload = message('module-sandbox-preload')
    else
    else
    sandboxPreload = message('template-sandbox-preload')
    contenuParagraphe
    end
    :wikitext('test&nbsp;')
    local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
    :tag('span')
    local sandboxCreateDisplay = message('sandbox-create-link-display')
    :css('font-size', '89%')
    local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
    :css('font-style', 'normal')
    local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
    :wikitext('(')
    local mirrorPreload = message('mirror-link-preload')
    :wikitext(lienUrl(pageTest, 'créer', 'edit', 'Preload3'))
    local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
    :wikitext(')')
    if subjectSpace == 828 then
    mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
    end
    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
    contenuParagraphe:wikitext('.<br>')
    local testcasesPage = testcasesTitle.prefixedText
     
    local testcasesDisplay = message('testcases-link-display')
    -- Phrase indiquant les liens vers les statistiques
    local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
    local nomStat, texteWstat
    local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
    if page.namespace == 828 then
    local testcasesEditDisplay = message('testcases-edit-link-display')
    nomStat = 'Module:' .. textPagebase(page)
    local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
    texteWstat = "statistiques d'appel depuis le wikicode"
    -- 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
    else
    local testcasesPreload
    nomStat = textPagebase(page)
    if subjectSpace == 828 then
    texteWstat = "statistiques d'utilisation du modèle"
    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
    end
    local messageName
     
    if subjectSpace == 828 then
    contenuParagraphe
    messageName = 'experiment-blurb-module'
    :wikitext('Voir les ')
    else
    :wikitext(lienWstat(nomStat, texteWstat))
    messageName = 'experiment-blurb-template'
    :wikitext(" sur l'outil [[Aide:Wstat|wstat]]")
     
    if page.namespace == 828 then --pour les modules, recherche de "Module:..." dans l'espace de noms Module:
    contenuParagraphe
    :wikitext(' et les ')
    :wikitext(lienRechercheModule(nomStat, "appels depuis d'autres modules"))
    end
    end
    return message(messageName, {sandboxLinks, testcasesLinks})
     
    contenuParagraphe:wikitext(".")
     
    return res
    end
    end


    function p.makeCategoriesBlurb(args, env)
    function p._documentation(args)
    --[[
    local page = mw.title.getCurrentTitle()
    -- Generates the text "Please add categories to the /doc subpage."
    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)
    -- Messages:
    local res = mw.html.create()
    -- 'doc-link-display' --> '/doc'
     
    -- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
    --Bandeau pour les sous-pages /Bac à sable
    --]]
    if page.subpageText == 'Bac à sable' then
    local docTitle = env.docTitle
    res
    if not docTitle then
    :tag('div')
    return nil
    :css('clear', 'both')
    :done()
    :wikitext(mw.getCurrentFrame():expandTemplate{title = 'Sous-page de bac à sable'})
    end
    end
    local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
    return message('add-categories-blurb', {docPathLink})
    end


    function p.makeSubpagesBlurb(args, env)
    --Génération de la documentation
    --[[
    local classeNamespace = 'documentation-modele'
    -- Generates the "Subpages of this template" link.
    if page.namespace == 828 then
    -- @args - a table of arguments passed by the user
    classeNamespace = 'documentation-module'
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    -- Messages:
    -- 'template-pagetype' --> 'template'
    -- 'module-pagetype' --> 'module'
    -- 'default-pagetype' --> 'page'
    -- '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
    res
    pagetype = message('template-pagetype')
    :tag('div')
    elseif subjectSpace == 828 then
    :addClass('documentation')
    pagetype = message('module-pagetype')
    :addClass(classeNamespace)
    else
    :css('clear', 'both')
    pagetype = message('default-pagetype')
    :css('margin', '1em 0 0 0')
    :css('border', '1px solid #aaa')
    :css('padding', '0.5em 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 par défaut pour les modules sans documentation
    if page.namespace == 828 and page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
    if existeDoc == false then
    res:wikitext("[[Catégorie:Module en langage Lua]]")
    end
    end
    end
    local subpagesLink = makeWikilink(
     
    'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
    return tostring(res)
    message('subpages-link-display', {pagetype})
    )
    return message('subpages-blurb', {subpagesLink})
    end
    end


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


    function p.addTrackingCategories(env)
    --Paramètres vides interprétés par Lua
    --[[
    for cle, val in pairs(argsParent) do
    -- Check if {{documentation}} is transcluded on a /doc or /testcases page.
    val = mw.text.trim(val)
    -- @env - environment table containing title objects, etc., generated with p.getEnvironment
    if val ~= '' then
    args[cle] = val
    -- Messages:
    end
    -- '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
    end
    local subpage = title.subpageText
     
    local ret = ''
    return p._documentation(args)
    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


    return p
    return p

    Version du 1 juin 2024 à 11:44

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

    -- Ce module implémente le modèle {{Méta documentation de modèle}}.

local p = {}

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

local function textPagebase(page)
	--On n'est pas dans une sous-page
	if not page.isSubpage then
		return page.text
	end

	--On est dans une sous-page
	local sousPage = page.subpageText
	if sousPage == 'Documentation'
	or sousPage == 'Bac à sable'
	or sousPage == 'Test' then
		return page.baseText
	else
		return page.text
	end
end

local function nomSouspage(page, souspage)
	return page.subjectNsText .. ':' .. textPagebase(page) .. '/' .. souspage
end

local function lienUrl(nomPage, texteLien, action, pagePreload)
	local arguments = {}

	if action then
		arguments['action'] = action
	end

	if pagePreload then
		arguments['preload'] = 'Modèle:Documentation/' .. pagePreload
	end

	if arguments['action'] or arguments['preload'] then
		return mw.ustring.format('[%s %s]', nomPage:fullUrl(arguments), texteLien)
	else
		return mw.ustring.format('[[%s|%s]]', nomPage.fullText, texteLien)
	end
end

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

	-- Titre
	res
		:css('margin-bottom', '1em')
		:css('border-bottom', '1px solid #aaa')
		:css('padding-bottom', '3px')
		:tag('span')
			:addClass('documentation-icone')
			:css('font-weight', 'bold')
			:css('font-size', '125%')
			:css('vertical-align', 'middle')
			:wikitext('&nbsp;')
			:wikitext(args.titre or 'Documentation')
			:done()

	-- Liens
	local editionLien = res:tag('span')
		:addClass('mw-editsection-like plainlinks')
		:css('vertical-align', 'middle')

	if args['aucun contenu additionnel'] == nil then
		if not args.contenu then
			if existeDoc then
				editionLien
					:wikitext('&#91;')
					:wikitext(lienUrl(doc, 'voir'))
					:wikitext('&#93; ')

					:wikitext('&#91;')
					:wikitext(lienUrl(doc, 'modifier', 'edit'))
					:wikitext('&#93; ')

					:wikitext('&#91;')
					:wikitext(lienUrl(doc, 'historique', 'history'))
					:wikitext('&#93; ')
			else
				local pagePreload = 'Preload'
				if page.namespace == 828 then
					pagePreload = 'PreloadModule'
				end

				editionLien
					:wikitext('&#91;')
					:wikitext(lienUrl(doc, 'créer', 'edit', pagePreload))
					:wikitext('&#93; ')
			end
		end
	end

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

	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()

	-- Contenu auto haut
	if args['contenu auto haut'] then
		res:wikitext(args['contenu auto haut'])
		   :newline()
	end

	-- Contenu ou sous-page de doc
	if args['aucun contenu additionnel'] == nil then
		if args.contenu then
			res:newline()
			   :wikitext(args.contenu)
			   :newline()

		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()

		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]] '
				..'explicative en sous-page</b>, pas même une description succincte.<br> '
				..'Vous pouvez %s afin de documenter ce %s adéquatement.'
			if page.namespace == 828 then -- Module
				texteBandeau = texteBandeau:format(
					'module',
					lienUrl(doc, 'créer cette sous-page', 'edit', 'PreloadModule'),
					'module'
				)
			else -- Modèle
				texteBandeau = texteBandeau:format(
					'modèle',
					lienUrl(doc, 'créer cette sous-page', 'edit', 'Preload'),
					'modèle'
				)
			end
			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',
				class = 'plainlinks',
				style = 'width:80%;',
				texte = texteBandeau,
			}
			res:wikitext(require('Module:Bandeau')._bandeau(param))
		end
	end

	-- Contenu auto bas
	if args['contenu auto bas'] then
		res:newline()
		   :wikitext(args['contenu auto bas'])
	end

	res
		:tag('div')
			:css('clear', 'both')

	return res
end

local function lienWstat(nomPage, texteLien)
	local nomPageEncoded = mw.text.encode(nomPage)
	local nomPageNoSpaces = mw.ustring.gsub(nomPageEncoded, ' ', '_')
	local url = 'https://wstat.fr/template/info/' .. nomPageNoSpaces
	return mw.ustring.format('[%s %s]', url, texteLien)
end

local function lienRechercheModule(nomModule, texteLien)
	local nomModuleEncoded = mw.text.encode(nomModule)
	local nomModuleNoSpaces = mw.ustring.gsub(nomModuleEncoded, ' ', '+')
	local quote = mw.text.encode('"')
	local url = 'https://fr.wikipedia.org/w/index.php?title=Spécial:Recherche&ns828=1&search=insource:' .. quote .. nomModuleNoSpaces .. quote
	return mw.ustring.format('[%s %s]', url, texteLien)
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')

	-- 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
		contenuParagraphe
		:tag('span')
			:addClass('error')
			:wikitext('Erreur : le paramètre <code>nom modèle</code> n\'est pas renseigné.<br>')
	end

	-- Phrase indiquant la provenance du contenu (dans le corps ou en sous-page)
	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 ')

			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

			contenuParagraphe
				:wikitext('Veuillez placer les catégories sur cette page-là.<br>')
		end
	end

	-- 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)

	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', 'edit'))
				:wikitext(')')
	else
		local pagePreload = 'Preload2'
		if page.namespace == 828 then
			pagePreload = nil
		end
		contenuParagraphe
			:wikitext('bac à sable&nbsp;')
			:tag('span')
				:css('font-size', '89%')
				:css('font-style', 'normal')
				:wikitext('(')
				:wikitext(lienUrl(pageBacasable, 'créer', 'edit', pagePreload))
				:wikitext(')')
	end

	if page.namespace ~= 828 then
		contenuParagraphe:wikitext(' et la page de ')

		local titrePageTest = nomSouspage(page, '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', 'edit'))
					:wikitext(')')
		else
			contenuParagraphe
				:wikitext('test&nbsp;')
				:tag('span')
					:css('font-size', '89%')
					:css('font-style', 'normal')
					:wikitext('(')
					:wikitext(lienUrl(pageTest, 'créer', 'edit', 'Preload3'))
					:wikitext(')')
		end
	end
	contenuParagraphe:wikitext('.<br>')

	-- Phrase indiquant les liens vers les statistiques
	local nomStat, texteWstat
	if page.namespace == 828 then
		nomStat = 'Module:' .. textPagebase(page)
		texteWstat = "statistiques d'appel depuis le wikicode"
	else
		nomStat = textPagebase(page)
		texteWstat = "statistiques d'utilisation du modèle"
	end

	contenuParagraphe
		:wikitext('Voir les ')
		:wikitext(lienWstat(nomStat, texteWstat))
		:wikitext(" sur l'outil [[Aide:Wstat|wstat]]")

	if page.namespace == 828 then --pour les modules, recherche de "Module:..." dans l'espace de noms Module:
		contenuParagraphe
			:wikitext(' et les ')
			:wikitext(lienRechercheModule(nomStat, "appels depuis d'autres modules"))
	end

	contenuParagraphe:wikitext(".")

	return res
end

function p._documentation(args)
	local page = mw.title.getCurrentTitle()
	local titrePageDoc = args['page doc'] or nomSouspage(page, 'Documentation')
	local doc = mw.title.new(titrePageDoc)
	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
	local classeNamespace = 'documentation-modele'
	if page.namespace == 828 then
		classeNamespace = 'documentation-module'
	end

	res
		:tag('div')
			:addClass('documentation')
			:addClass(classeNamespace)
			:css('clear', 'both')
			:css('margin', '1em 0 0 0')
			:css('border', '1px solid #aaa')
			:css('padding', '0.5em 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 par défaut pour les modules sans documentation
	if page.namespace == 828 and page.subpageText ~= 'Bac à sable' and page.subpageText ~= 'Test' then
		if existeDoc == false then
			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
    Récupérée de « https://fr.wikipasokh.com/index.php?title=Module:Documentation&oldid=1048 »