Module:Documentation module

Documentation[voir] [modifier] [historique] [purger]

Utilisation

Fonctions exportables :

doc(frame) – génère un entête de documentation s'adaptant au contexte :
- depuis un module qui ne possède pas de sous-page de documentation : génère un message explicatif ainsi qu'un lien pour la création
- depuis un module qui possède une sous-page de documentation : génère un message explicatif ainsi que les liens vers la documentation
- depuis une sous-page de documentation d'un module : génère un message explicatif ainsi que les liens vers le module

Modules externes et autres éléments dont ce module a besoin pour fonctionner :

mw.title

Projet Scribunto

La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.

-- module contenant les fonctions permettant de gérer la documentation des modules

local p = {}


-- génère un affichage proche de {{m|Documentation modèle vue directement}}
function p.doc_vue_directement(frame)
    -- on regarde si on est la sous-page de documentation d'un module
    local titre = mw.title.getCurrentTitle()
    local res = ""
    
    -- ns=828 + sous-page=doc
    local mdl = false
    if (titre.nsText == "Module" and titre.subpageText == "doc") then
        mdl = true
    end
    
    -- table
    res = res .. '<table class="messagebox"><tr width="60"><td>[[Fichier:File:Edit-copy green.svg|centre|40px]]</td>'
    res = res .. "<td>'''Ceci est la page de [[Aide:Comment documenter un modèle ?|documentation]] du module "
    res = res .. "[[Module:" .. titre.baseText .. "|" .. titre.baseText .. "]]'''<br />"
    res = res .. '<span style="font-size:88%; line-height:1.2em">'
    res = res .. "Cette [[Wikipédia:Sous-page|sous-page]] contient les instructions, les [[Wikipédia:Conventions sur les catégories|catégories]]"
    res = res .. "et les [[Aide:Lien interlangue|liens interlangues]] de son modèle d’origine et elle n’est pas destinée à être visualisée directement.</span>"
    res = res .. "</td></tr></table>[[Catégorie:Documentation d'un module|" .. titre.baseTexte .. "]]"
        
    return res
end



return p