Module:Navbar/Documentation

Utilisation

Ce module fournit les fonction Navbar.navbar(frame) et Navbar._navbar(args) servant à la création, respectivement depuis un modèle et un module, de trois liens internes « voir », « discussion » et « éditer », pour permettre par exemple de mettre un lien direct dans un article vers la modification d'un modèle et ne pas avoir besoin de chercher le nom de ce modèle dans le wikicode.

Le module Navbar est initialement utilisé pour l'implémentation de en:Template:Navbar sur la wikipédia en anglais. Sur wikipédia en français, ce module n'est pas utilisé par Modèle:Tnavbar, codé entièrement en wikicode. La seule utilisation significative actuelle est dans Module:Medical cases chart, pour la génération de graphiques liés à la pandémie de Covid-19.

Pour son implémentation, ce modèle utilise la feuille de styles Module:Navbar/styles.css, ainsi que la sous-page contenant les paramètres : Module:Navbar/configuration.

Fonctions exportables

• _navbar(args) – Prend en argument un tableau contenant les paramètres (tous facultatifs) fontstyle, fontcolor, collapsible, mini et plain. Retourne le wikitexte pour une navbar.

• navbar(frame) – Même fonction, mais pour une invocation directement depuis un modèle.

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

• mw.text.trim – Enlève les espaces au début et à la fin d'une chaine de caractères ;
• mw.getCurrentFrame – Retourne l'objet frame courant, généralement l'objet frame du dernier appel à #invoke ;
  • frame:getParent() – Si le {{#invoke:}} est contenu dans un modèle, frame contient les arguments passés dans le {{#invoke:}} et frame:getParent() contient les paramètres donnés dans l'appel de modèle.
  • frame:getTitle() – Renvoie le titre associé à l'objet frame sous forme de chaine de caractères. Pour l'objet frame créé par {{#invoke:}}, c'est le titre du module invoqué ;
  • frame:extensionTag() – Permet l'utilisation d'équivalents lua aux fonctions d'analyse syntaxique, appelées via le mot magique {{#tag:}} ;
• mw.title.new – Crée un nouvel objet title ;
  • title:fullUrl() – Renvoie l'url associée à l'objet title encodée.
• mw.html.create – Crée un nouvel objet mw.html, équivalent d'un élément HTML ;
  • html:addClass(), html:cssText(), html:attr, html:tag(), html:wikitext(), html:done() et html:node() : méthodes de la bibliothèque mw.html.

• Module:Arguments – Module simplifiant l'utilisation des arguments de #invoke ;
• Module:TableTools – Module fournissant diverses fonctions de manipulation des tables lua ;

• Module en sous-page : Module:Navbar/configuration

• Feuille de style css : Module:Navbar/styles.css

Exemple

Appel depuis un modèle

Ce module peut être appelé depuis un modèle de la manière suivante :

{{#invoke:Navbar|navbar|params}}

Appel depuis un module

local Navbar = require('Module:Navbar')

local p={}

function p.main(param1, param2, args)
    local wikitexte = ''
    -- code pour la génération d'un modèle visuel en wikitexte
    return wikitexte .. Navbar._navbar(args)
end

return p