Voir la source de Modèle:Légende/Documentation

{{Sous-page de documentation}}
{{Modèle utilisant TemplateStyles|Légende/styles.css}}

== Utilisation ==
Ce modèle facilite l'ajout d'une légende à une carte géographique, à un schéma ou à un tableau.

{{Encart|style=important|contenu='''Attention :''' quand il ne s'agit pas d'une légende, utilisez de préférence le modèle {{m|Carré couleur}}.}} 

{{Avertissement|1='''Les différents modèles de légendes que sont {{m|Légende}}, {{m|Légende hachurée}}, {{m|Légende double}} et {{m|Ligne de légende}} doivent obligatoirement êtres ajoutés entre des modèles {{m|Légende/Début}} et {{m|Légende/Fin}}.'''}}

== Syntaxe ==
 <nowiki>{{Légende/Début}}
{{Légende|</nowiki>'''''couleur'''''|'''''légende'''''<nowiki>}}
{{Légende|</nowiki>'''''couleur'''''|'''''légende'''''|bordure='''''bordure'''''|taille police='''''taille police'''''<nowiki>}}
{{Légende|</nowiki>texte='''''texte'''''|'''''légende'''''<nowiki>}}
{{Légende/Fin}}</nowiki>

== Paramètres ==
; <code>1</code>
: Code couleur [[Feuilles de style en cascade|CSS]] envoyé à la propriété <syntaxhighlight lang="css" inline>background:</syntaxhighlight> du CSS ({{rouge|obligatoire}}).
; <code>2</code>
: Texte de la légende ({{rouge|obligatoire}}).
; <code>bordure</code> : Code envoyé à la propriété <syntaxhighlight lang="css" inline>border:</syntaxhighlight> du [[Feuilles de style en cascade|CSS]] (facultatif).
: Par défaut : <syntaxhighlight lang="css" inline>1px solid grey</syntaxhighlight>
; <code>taille police</code> : Code envoyé à la propriété <syntaxhighlight lang="css" inline>font-size:</syntaxhighlight> du [[Feuilles de style en cascade|CSS]] (facultatif).
: Par défaut : <syntaxhighlight lang="css" inline>90%</syntaxhighlight>
; <code>texte dans carré</code>
: Permet d'indiquer un texte à afficher à l'intérieur du carré de couleur (généralement de un à deux caractères, utilisé par exemple quand plusieurs éléments d'une carte portent la même couleur, et ne sont différenciés que par un chiffre ou une lettre).

=== Codes couleurs ===
{{Boîte déroulante/début|titre=Liste des codes couleurs CSS}}
{{Principales couleurs}}
{{Boîte déroulante/fin}}

== Exemples ==
{{Légende/Documentation/Exemples}}

== TemplateData ==
<templatedata>
{
	"description": "Légende avec un carré de couleur. Il faut toujours ajouter les modèles de légendes entre des modèles {{Légende/Début}} et {{Légende/Fin}}.",
	"params": {
		"1": {
			"required": true,
			"label": "Couleur",
			"description": "Code couleur CSS envoyé à la propriété « background: » du CSS pour la case colorée.",
			"type": "line",
			"example": "yellow"
		},
		"2": {
			"required": true,
			"label": "Légende",
			"type": "string",
			"description": "Texte de la légende."
		},
		"taille police": {
			"required": false,
			"label": "Taille police",
			"default": "90%",
			"type": "line",
			"description": "Code envoyé à la propriété « font-size: » du CSS.",
			"example": "100%"
		},
		"bordure": {
			"required": false,
			"label": "Bordure",
			"default": "1px solid grey",
			"description": "Code envoyé à la propriété « border: » du CSS. Mettre « none » pour désactiver la bordure.",
			"example": "2px solid black",
			"type": "line"
		},
		"texte": {
			"required": false,
			"label": "Texte",
			"type": "string/line",
			"description": "Pour une ligne de légende avec mention textuelle à la place de la couleur, texte remplace le carré coloré. "
		},
		"texte dans carré": {
			"label": "Texte dans carré",
			"description": "Texte à afficher à l'intérieur du carré de couleur.",
			"example": "A",
			"type": "line"
		}
	},
	"format": "\n{{_|_=_}}\n"
}
</templatedata>

== Voir aussi ==
* Modèles de légendes :
** {{m|Légende}} : légende simple à une seule couleur ;
** {{m|Légende hachurée}} : pour les légendes hachurées ;
** {{m|légende double}} : deux couleurs côte à côte, autre variante possible pour les légendes hachurées ;
** {{m|Ligne de légende}} : légende sous forme d'une ligne horizontale (par exemple pour des frontières ou tracés).
* Les modèles {{m|Légende/Début}} et {{m|Légende/Fin}}, entre lesquels doivent se trouver tous les modèles de légendes.
* Autres modèles :
** {{m|Carré couleur}} : pour afficher un carré coloré quand il ne s'agit pas d'une légende ;
** {{m|Liste pour légende}} : pour afficher une liste en légende sans carrés.
** {{m|Légende0}} : pour afficher une légende sur une seule ligne.
<includeonly>
[[Catégorie:Modèle géographie]]
</includeonly>