Module:Dièse couleur web/Documentation

La documentation pour ce module peut être créée à Module:Dièse couleur web/Documentation/doc

Erreur de script : Erreur Lua à la ligne 1 : unexpected symbol near '=='.

== Utilisation ==
Ce module Lua est utilisé par le modèle {{m|Dièse couleur web}}. Il fournit une fonction permettant d'ajouter un éventuel # à un code hexadécimal pour en faire un code hexadécimal de couleur.

=== Fonctions exportables ===
* <code>main( frame )</code> – Prend en argument un frame de la forme { couleur, couleur_défaut }. Retourne couleur si couleur est non vide et #couleur si couleur est un code hexadécimal ; si couleur est vide, retourne la même chose pour couleur_défaut.
* <code>couleur( value, echappe )</code> – <code>value</code> est un code hexadécimal ou un nom de couleur, <code>echappe</code> est un booléen valant <syntaxhighlight lang="lua" inline>false</syntaxhighlight> par défaut. Retourne value si value est non vide et #value si value est un code hexadécimal. Si echappe vaut true, le # est échappé.

=== 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.

=== Modèles appelant directement ce module ===
* [[Modèle:Dièse couleur web]] (utilise <code>main</code>)

=== Modules lua utilisant ce module ===
* [[Module:Infobox/Titre]] (utilise <code>couleur</code>)

== Exemples ==
=== Appel depuis un modèle ===
Dans [[Modèle:Dièse couleur web]], ce module est appelé par le code :
<pre>{{#invoke:Dièse couleur web|main|1={{{1}}}|2={{{2|}}}}}</pre>

=== Appel depuis un module ===
Dans [[Module:Infobox/Titre]], ce module est appelé par le code :
<syntaxhighlight lang="lua">
local couleur = require( 'Module:Dièse couleur web' ).couleur

return 'background-color:' .. couleur( background ) .. ';'
		.. 'color:' .. couleur( color ) .. ';'
</syntaxhighlight>

{{Projet|Scribunto}}<includeonly>
[[Catégorie:Module appelé directement par un modèle]]
[[Catégorie:Module appelé par un autre module]]
</includeonly>