Voir la source de Module:Navbar/Documentation

<includeonly>{{Shared Template Warning|Module:Navbar}}</includeonly>
== Utilisation ==
Ce module fournit les fonction <code>Navbar.navbar(frame)</code> et <code>Navbar._navbar(args)</code> 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 ===
* <code>[[Module:Navbar#L-158|navbar(frame)]]</code> – Même fonction que <code>[[Module:Navbar#L-92|_navbar(args)]]</code> ci-dessous, mais pour une invocation directement depuis un modèle.
* <code>[[Module:Navbar#L-92|_navbar(args)]]</code> – Prend en argument un tableau contenant les paramètres (tous facultatifs) :
** <code>style</code> : paramètre libre de style css à appliquer à la navbar. Exemple : <code>float:right; padding:5px; border:1px solid;</code> ;
** <code>fontstyle</code> : paramètre libre de style css à appliquer au texte. Exemple : <code>color: green; font-style: italic;</code> ;
** <code>fontcolor</code> : valeur du style css à appliquer au texte pour <code>color:</code> uniquement. '''Incompatible''' avec le paramètre <code>fontstyle</code>. Exemple : <code>green</code>
** <code>collapsible</code> : booléen{{efn|groupe=alpha|name=bool|Lorsque ce module est appelé depuis un modèle, un booléen est défini comme valant <syntaxhighlight lang="lua" inline>true</syntaxhighlight> lorsqu'il est non vide, et <syntaxhighlight lang="lua" inline>false</syntaxhighlight> lorsqu'il est vide. Lorsqu'il est appelé depuis un autre module, il est préférable d'utiliser les vraies valeurs booléennes <syntaxhighlight lang="lua" inline>true</syntaxhighlight> et <syntaxhighlight lang="lua" inline>false</syntaxhighlight> pour une meilleure clarté du code.}} Lorsque <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, le texte est placé sur la gauche de façon à être adapté pour une disposition sur une [[Aide:Palette de navigation|palette]].
** <code>mini</code> : booléen{{efn|groupe=alpha|name=bool}}, forcé à <syntaxhighlight lang="lua" inline>1</syntaxhighlight> lorsque <code>plain</code> vaut <syntaxhighlight lang="lua" inline>false</syntaxhighlight>. Lorsque <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, les noms sur les boutons sont remplacés par leurs initiales « v », « t », « e »{{etc.}}
** <code>plain</code> : booléen{{efn|groupe=alpha|name=bool}} pour enlever le texte qui précède les boutons.
** <code>brackets</code> : booléen{{efn|groupe=alpha|name=bool}} ajoutant des crochets <code>[ ]</code> autour des boutons lorsque <syntaxhighlight lang="lua" inline>true</syntaxhighlight>.
** <code>text</code> : texte à afficher avant les liens. Par défaut : <code>Cette boîte : </code>. N'est pas pris en compte si <code>plain</code> vaut <syntaxhighlight lang="lua" inline>true</syntaxhighlight>.
** <code>template</code> : nom du modèle sans l'espace de nom. Par défaut, le nom du modèle contenant l'appel de module.
** <code>talk</code> / <code>t</code> / <code>d</code>, <code>edit</code> / <code>e</code>, <code>hist</code> / <code>h</code>, <code>move</code> / <code>m</code>, <code>watch</code> / <code>w</code> : 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 <code>template</code> est défini.
** <code>noedit</code> : booléen{{efn|groupe=alpha|name=bool}} servant à retirer le lien pour éditer le modèle.

Retourne le wikitexte pour une navbar.

<references group="alpha"/>

=== Modules externes et autres éléments dont ce module a besoin pour fonctionner ===
* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.text.trim|mw.text.trim]]</code> – Enlève les espaces au début et à la fin d'une chaine de caractères ;
* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.getCurrentFrame|mw.getCurrentFrame]]</code> – Retourne l'[[mw:Extension:Scribunto/Lua reference manual/fr#L'objet Frame|objet frame]] courant, généralement l'objet frame du dernier appel à <code>#invoke</code> ;
** <code>[[mw:Extension:Scribunto/Lua reference manual/fr#frame:getParent|frame:getParent()]]</code> – Si le <code><nowiki>{{#invoke:}}</nowiki></code> est contenu dans un modèle, <code>frame</code> contient les arguments passés dans le <code><nowiki>{{#invoke:}}</nowiki></code> et <code>frame:getParent()</code> contient les paramètres donnés dans l'appel de modèle.
** <code>[[mw:Extension:Scribunto/Lua reference manual/fr#frame:getTitle|frame:getTitle()]]</code> – Renvoie le titre associé à l'[[mw:Extension:Scribunto/Lua reference manual/fr#L'objet_Frame|objet ''frame'']] sous forme de chaine de caractères. Pour l'objet ''frame'' créé par <code><nowiki>{{#invoke:}}</nowiki></code>, c'est le titre du module invoqué ;
** <code>[[mw:Extension:Scribunto/Lua reference manual/fr#frame:extensionTag|frame:extensionTag()]]</code> – Permet l'utilisation d'équivalents lua aux [[mw:Help:Extension:ParserFunctions/fr|fonctions d'analyse syntaxique]], appelées via le [[Aide:Mot magique|mot magique]] <code><nowiki>{{#tag:}}</nowiki></code> ;
* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.title.new|mw.title.new]]</code> – Crée un nouvel [[mw:Extension:Scribunto/Lua reference manual/fr#Objet title|objet title]] ;
** <code>title:fullUrl()</code> – Renvoie l'url associée à l'objet title encodée.
* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html.create|mw.html.create]]</code> – Crée un nouvel objet [[mw:Extension:Scribunto/Lua reference manual/fr#Bibliothèque html|mw.html]], équivalent d'un [[élément HTML]] ;
** <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:addClass()]]</code>, <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:cssText()]]</code>, <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:attr]]</code>, <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:tag()]]</code>, <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:wikitext()]]</code>, <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:done()]]</code> et <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.html:wikitext|html:node()]]</code> : méthodes de la bibliothèque mw.html.

* <code>[[Module:Arguments]]</code> – Module simplifiant l'utilisation des arguments de <code>#invoke</code> ;
* <code>[[Module:TableTools]]</code> – 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 :
<pre>
{{#invoke:Navbar|navbar|params}}
</pre>

=== Appel depuis un module ===
<syntaxhighlight lang="lua">
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
</syntaxhighlight>

=== Exemple concret ===
<pre>
{{#invoke:Navbar|navbar|template=Navbar|brackets=oui|fontstyle=color: green; font-style: italic;|m}}
</pre>
ou le code équivalent en lua
<syntaxhighlight lang="lua">
local navbar = require('Module:Navbar')

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

donnent tous les deux :

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

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.

{{Projet Scribunto}}

<includeonly>
[[Catégorie:Module appelé par un autre module]]
</includeonly>