Modèle:Sommaire/Documentation

Ceci est la page de documentation de Modèle:Sommaire [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.

Ce modèle permet d'insérer la table des matières avec une mise en forme paramétrable.

Il n'est techniquement possible d'insérer qu'un seul sommaire sur une page de Wikipédia. L'ajout de ce modèle désactivera automatiquement l'affichage du sommaire placé par défaut par MediaWiki. Si ce modèle {{Sommaire}} est appelé plusieurs fois sur une page, seul le premier appel sera affiché correctement.

Note :

Ce modèle « catégorise » la page qui l’emploie dans Catégorie:Page utilisant un sommaire limité.

Mise en page

Limitation de niveau : paramètre niveau

Lorsque le sommaire est trop long, ce paramètre permet de masquer les niveaux de titres en-dessous du 2 ou 3. Il est déconseillé de le restreindre au premier niveau de titre, car le résultat est peu utile pour le lecteur (sommaire qui ne reflète pas la richesse du contenu).

En matière d'accessibilité, ce paramètre niveau permet d'éviter de faire des semblants de titres – non accessibles – avec du gras (« '''''' » ou « ; »). Ce paramètre niveau permet de continuer à utiliser la syntaxe habituelle « == Mon titre == », ce qui est accessible.

{{Sommaire|niveau=2}}

• voir le rendu

Exemple d'utilisation : pour forcer l'affichage du sommaire en plus de {{Sommaire alphabétique}}, mais sans afficher les sections de niveau correspondant à l'alphabet. Sans limitation : Modèle:Permalien, avec limitation : Modèle:Permalien.

Alignement : paramètre align

Note : ces paramètres permettent de mettre en forme le sommaire d'une manière qui ne fait pas consensus au sein de la communauté (voir les quelques tentatives de prises de décision à ce sujet, et les suppressions des modèles précédemment utilisés à cet effet, dont Discussion modèle:Sommaire à gauche/Suppression). Son usage est donc déconseillé dans les articles.

Valeurs acceptées : left (flottant à gauche, valeur par défaut), right (flottant à droite) et center (centré)

Alignement à gauche (par défaut)

{{Sommaire|align=left}}

• voir le rendu

Alignement à droite

{{Sommaire|align=right}}

• voir le rendu

Texte tout autour du menu : paramètre flottant

Note : ces paramètres permettent de mettre en forme le sommaire d'une manière qui ne fait pas consensus au sein de la communauté (voir les quelques tentatives de prises de décision à ce sujet). Son usage est donc déconseillé dans les articles.

{{Sommaire|align=right|flottant=1}}

• voir le rendu

Données

Ce modèle permet d’insérer la table des matières avec une mise en forme paramétrable.

Paramètres du modèle[Modifier les données du modèle]

Paramètre		Description	Type	État
Niveau	niveau	Ce paramètre permet de limiter les niveaux de titres affichés dans le sommaire	Nombre	facultatif
Alignement	align	Permet d’affiche le sommaire à gauche (« left ») ou à droite (« right ») Par défaut left	Ligne de texte	facultatif
Flottant	flottant	Si ce paramètre est rempli, le texte suivant le sommaire s’affichera autour (plutôt qu’après)	Ligne de texte	facultatif
Largeur	width	Largeur du sommaire (toute valeur valide en CSS, par exemple « 156px » ou « 22em » ; utilisez de préférence les « em »)	Ligne de texte	facultatif
Non catégorisé	nocat	Si ce paramètre est rempli, la page n’est pas catégorisée dans « Catégorie:Page utilisant un sommaire limité » ; ce paramètre ne devrait pas être utilisé dans les articles	Ligne de texte	facultatif

Voir aussi

• Modèle:Sommaire à droite
• Modèle:Sommaire alphabétique