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. Le module ayant été copié tel quel, les boutons générés sont restés sous leurs noms anglais (« view », « talk », « edit », etc.) Sur Wikipédia en français, ce module n'est pas utilisé par Modèle:Tnavbar qui est 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(frame) – Même fonction que _navbar(args) ci-dessous, mais pour une invocation directement depuis un modèle.
• _navbar(args) – Prend en argument un tableau contenant les paramètres (tous facultatifs) :
  • style : paramètre libre de style css à appliquer à la navbar. Exemple : float:right; padding:5px; border:1px solid; ;
  • fontstyle : paramètre libre de style css à appliquer au texte. Exemple : color: green; font-style: italic; ;
  • fontcolor : valeur du style css à appliquer au texte pour color: uniquement. Incompatible avec le paramètre fontstyle. Exemple : green
  • collapsible : booléen Lorsque true, le texte est placé sur la gauche de façon à être adapté pour une disposition sur une palette.
  • mini : booléen, forcé à 1 lorsque plain vaut false. Lorsque true, les noms sur les boutons sont remplacés par leurs initiales « v », « t », « e », etc.
  • plain : booléen pour enlever le texte qui précède les boutons.
  • brackets : booléen ajoutant des crochets [ ] autour des boutons lorsque true.
  • text : texte à afficher avant les liens. Par défaut : Cette boîte : . N'est pas pris en compte si plain vaut true.
  • template : nom du modèle sans l'espace de nom. Par défaut, le nom du modèle contenant l'appel de module.
  • talk / t / d, edit / e, hist / h, move / m, watch / w : arguments associés à des paramètres numériques quelconques (1, 2, 3, etc.) Lorsque présents, activent les boutons associés. (« view » est toujours activé, « talk » et « edit » sont activés par défaut sauf quand le paramètre template est défini.
  • noedit : booléen servant à retirer le lien pour éditer le modèle.

Retourne le wikitexte pour une navbar.

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

Exemples

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

Exemple concret

{{#invoke:Navbar|navbar|template=Navbar|brackets=oui|fontstyle=color: green; font-style: italic;|m}}

ou le code équivalent en lua

local navbar = require('Module:Navbar')

navbar._navbar({template="Navbar", brackets=true, fontstyle="color: green; font-style: italic;", m})

donnent tous les deux :

Comme vous pouvez le constater, le module n'est pas entièrement fonctionnel en l'état car certaines classes css utilisées par la version anglaise ne sont pas présentes sur Wikipédia en français.