Modèle:Sommaire/Documentation
Cette sous-page contient les instructions, 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 faut ajouter le modèle après le résumé introductif.
Sur Wikipédia, ce modèle n'est plus compatible avec le skin Vector 2022 qui est utilisé.
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.
1 Mise en page
1.1 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.
Exemple d'utilisation : pour éviter que le sommaire de cette page soit beaucoup trop long.
1.2 Alignement : paramètre align
Note : éviter de changer l'alignement par défaut (cf. débats sur Wikipédia).
Valeurs acceptées : left (flottant à gauche, valeur par défaut), right (flottant à droite) et center (centré)
Exemples :
Note : éviter de l'utiliser.
2 Données
Ce modèle permet d’insérer la table des matières avec une mise en forme paramétrable.
| Paramètre | Description | Type | Statut | |
|---|---|---|---|---|
| Niveau | niveau | Ce paramètre permet de limiter les niveaux de titres affichés dans le sommaire | Nombre | facultatif |
| Alignement | align | Permet d’afficher le sommaire à gauche (« left ») ou à droite (« right »)
| Ligne | facultatif |
| Flottant | flottant | Si ce paramètre est rempli, le texte suivant le sommaire s’affichera autour (plutôt qu’après) | Ligne | facultatif |
| Largeur | width | Largeur du sommaire (toute valeur valide en CSS, par exemple « 156px » ou « 22em » ; utilisez de préférence les « em ») | Ligne | 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 | facultatif |