« Modèle:Palette/Documentation » : différence entre les versions

Contenu supprimé Contenu ajouté
FDo64 (discussion | contributions)
Nouvelle page : == Utilisation == Fonctions exportables : * <code>listePalette(frame)</code> – implémente {{m|Palette}}. Modules externes et autres éléments dont ce module a besoin pour fo...
Ligne 1 :
{{Sous-page de documentation}}<includeonly>{{Protection|nombre=140000}}</includeonly>
 
== Utilisation ==
Fonctions exportables :
Ce modèle sert à rassembler en un seul bloc les palettes de navigation utilisant {{m|Méta palette de navigation}}.
* <code>listePalette(frame)</code> – implémente {{m|Palette}}.
 
Modules externes et autres éléments dont ce module a besoin pour fonctionner : aucun
== Syntaxe ==
<code><nowiki>{{Palette|</nowiki>''A''<nowiki>|</nowiki>''B''<nowiki>|...}}</nowiki></code>, où <nowiki>{{Palette A}}</nowiki>, <nowiki>{{Palette B}}</nowiki>{{etc.}}, sont les noms des modèles de palette, construits à l’aide de {{m|Méta palette de navigation}} et {{m|Méta palette de navigation sous-groupe}}.
 
Des paramètres ''nocat'''X''''' {{incise|où '''X''' désigne le rang de la palette}} pour supprimer les catégorisations automatiques existent si les palettes originales prennent en compte un paramètre ''nocat''.
 
=== Cas particulier des palettes avec paramètres ===
L'utilisation du modèle Palette est autorisée pour les palettes avec paramètres. Il y a cependant une contrainte lorsque plusieurs palettes avec paramètres veulent être regroupées, et deux solutions sont possibles en cas de nom de paramètre identiques :
 
==== numérotation des paramètres ====
Exemple :
<pre>{{Palette
|A|titre 1=A
|B|titre 2=B
|...
}}</pre>
(ici les palettes A et B on toutes deux un paramètre nommé ''titre'').
 
==== passage du modèle complet ====
Exemple :
<pre>{{Palette
|{{Palette A|titre=A}}
|{{Palette B|titre=B}}
|...
}}</pre>
 
=== Boîte déroulante ===
Il est possible d'encapsuler la totalité des palettes dans une boîte déroulante. Pour cela il existe trois paramètres :
* <code>titre boîte déroulante</code> : titre affiché de la boîte.
* <code>couleurFondT</code> (facultatif) : couleur de fond du titre, exemples : black, #C080FF, …
* <code>couleurTexteT</code> (facultatif) : couleur du texte de titre.
 
== Titre du modèle ==
 
Pour utiliser ce modèle, le titre doit commencer par <code>Palette</code> puis le mot suivant doit commencer par une capitale.
 
Par exemple, le code <code><nowiki>{{Palette|Empereurs romains}}</nowiki></code> se réfère à la palette avec le titre [[Modèle:Palette Empereurs romains]]. Néanmoins, cette palette est aussi utilisable sans le <code>|</code>, ce qui donne <code><nowiki>{{Palette Empereurs romains}}</nowiki></code> (voir article [[Auguste]]).
 
Le titre doit être reporté au niveau du paramètre <code>modèle</code>. Par exemple, pour cette palette [[Modèle:Palette Empereurs romains]], le paramètre <code>modèle</code> correspond à son titre "Palette Empereurs romains" :
{{Méta palette de navigation
| modèle = Palette Empereurs romains
| titre = <nowiki>[[Liste des empereurs romains]]</nowiki>
 
== Templatedata ==
<templatedata>
{
"description": "Ce modèle sert à regrouper des palettes de navigation",
"params": {
"1": {
"label": "Palette 1",
"description": "Nom de la première palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": true
},
"2": {
"label": "Palette 2",
"description": "Nom de la deuxième palette, sans le préfixe « Modèle:Palette »",
"type": "string"
},
"3": {
"label": "Palette 3",
"description": "Nom de la troisième palette, sans le préfixe « Modèle:Palette »",
"type": "string"
},
"4": {
"label": "Palette 4",
"description": "Nom de la quatrième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"5": {
"label": "Palette 5",
"description": "Nom de la cinquième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"6": {
"label": "Palette 6",
"description": "Nom de la sixième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"7": {
"label": "Palette 7",
"description": "Nom de la septième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"8": {
"label": "Palette 8",
"description": "Nom de la huitième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"9": {
"label": "Palette 9",
"description": "Nom de la neuvième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"10": {
"label": "Palette 10",
"description": "Nom de la dixième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"11": {
"label": "Palette 11",
"description": "Nom de la onzième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"12": {
"label": "Palette 12",
"description": "Nom de la douzième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"13": {
"label": "Palette 13",
"description": "Nom de la treizième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"14": {
"label": "Palette 14",
"description": "Nom de la quatorzième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"15": {
"label": "Palette 15",
"description": "Nom de la quinzième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"16": {
"label": "Palette 16",
"description": "Nom de la seizième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"17": {
"label": "Palette 17",
"description": "Nom de la dix-septième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"18": {
"label": "Palette 18",
"description": "Nom de la dix-huitième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"19": {
"label": "Palette 19",
"description": "Nom de la dix-neuvième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
},
"20": {
"label": "Palette 20",
"description": "Nom de la vingtième palette, sans le préfixe « Modèle:Palette »",
"type": "string",
"required": false
}
 
}
}
</templatedata>
 
== Exemples ==
Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.
=== Exemple simple ===
{{m|Palette|Exemple 1|Exemple 2|Exemple 3}} donne…<includeonly>
{{Palette|Exemple 1|Exemple 2|Exemple 3}}</includeonly>
 
=== Exemple avec ''nocat'' ===
{{m|Palette|Lettre A|3=nocat1=oui}} donne…
<includeonly>{{Palette|Lettre A|nocat1=oui}}</includeonly>
 
== Cas particuliers ==
Les palettes contenant des paramètres, ainsi que les palettes verticales, doivent contenir un paramétrage spécifique pour être reconnues et correctement affichées par ce modèle.
 
=== Palettes horizontales ===
==== Code pour une palette horizontale avec paramètres utilisant le modèle {{m|Méta palette de navigation}} ====
<pre>{{Méta palette de navigation
| paramètre = oui<!-- Obligatoire, utile au modèle Palette. Ne pas supprimer -->
| parent = {{{parent|}}}<!-- Obligatoire, utile au modèle Palette. Ne pas supprimer -->
...</pre>
 
==== Code pour une palette horizontale avec paramètres utilisant un autre modèle ====
<pre>{{#ifeq:{{{parent|}}}|bandeau|palette avec paramètres
|
...
}}<!-- Fin test nécessaire au modèle Palette --></pre>
 
=== Palettes verticales ===
Les palettes verticales ne devraient pas être appelées à partir du modèle Palette puisqu'il n'y a aucune utilité de les assembler en un seul bloc. Néanmoins, dans l'éventualité ou un bot ou une personne mal informée appliquerait ce modèle, ce cas est prévu afin de ne pas générer d'erreurs sur les pages.
 
Voir aussi : [[:Catégorie:Palette verticale]].
 
==== Code pour une palette verticale sans paramètres utilisant le modèle {{m|Méta infobox navigation}} ====
<pre>{{Méta infobox navigation
| parent = {{{parent|}}}<!-- Obligatoire, utile au modèle Palette. Ne pas supprimer -->
...</pre>
 
==== Code pour une palette verticale sans paramètres utilisant le modèle {{m|Méta palette de navigation}} ====
<pre><!--
Début test nécessaire au modèle Palette
-->{{#ifeq:{{{parent|}}}|bandeau|palette verticale}}<!--
Fin test nécessaire au modèle Palette
-->{{Méta palette de navigation
...
}}<!-- Fin test nécessaire au modèle Palette --></pre>
 
==== Code pour une palette verticale avec paramètres utilisant le modèle {{m|Méta infobox navigation}} ====
<pre>{{#ifeq:{{{parent|}}}|bandeau|palette verticale avec paramètres
|{{Méta infobox navigation
...
}}<!-- Fin test nécessaire au modèle Palette --></pre>
 
== Maintenance ==
Voir les catégories d'erreur suivantes :
* [[:Catégorie:Modèle Palette - Palette inconnue]]
* [[:Catégorie:Modèle Palette - Page contenant trop de palettes]]
 
== Voir aussi ==
* [[:Catégorie:Méta palette de navigation]]
* {{m|Méta palette de navigation}}
* [[Modèle:Palette (espace modèle)]] à utiliser dans l'espace modèle uniquement pour éviter le message « Modèle en boucle détecté : Modèle:Palette ».
 
{{Modèle utilisant les modules Lua|Module:Palette}}
{{Projet|Palette}}
<includeonly>
{{Projet Scribunto}}
{{DEFAULTSORT:Palette}}
[[Catégorie:Méta palette de navigation|*]]
[[Catégorie:Exclure lors de l'impression]]
</includeonly>
<noinclude>
[[Catégorie:Documentation de module]]
</noinclude>