|
|
| Ligne 1 : |
Ligne 1 : |
| {{Sous-page de documentation}} | | {| style="border: 0px" |
| | | |- |
| Ce modèle permet d'insérer la [[Sommaire|table des matières]] avec une mise en forme paramétrable.
| | | __TOC__ |
| | | |} |
| 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 {{m|Sommaire}} est appelé plusieurs fois sur une page, seul le premier appel sera affiché correctement.
| |
| | |
| == Mise en page == | |
| === Limitation de niveau : paramètre <code>niveau</code> ===
| |
| 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 (« <nowiki>''''''</nowiki> » ou « <nowiki>;</nowiki> »). Ce paramètre niveau permet de continuer à utiliser la syntaxe habituelle « <nowiki>== Mon titre ==</nowiki> », ce qui est accessible.
| |
| | |
| : <pre><nowiki>{{Sommaire|niveau=2}}</nowiki></pre>
| |
| :*[[Modèle:Sommaire/Documentation/Exemple5|voir le rendu]]
| |
| | |
| === Alignement : paramètre <code>align</code> ===
| |
| 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 : <code>left</code> (flottant à gauche, valeur par défaut), <code>right</code> (flottant à droite) et <code>center</code> (centré)
| |
| | |
| ;Alignement à gauche (par défaut)
| |
| : <pre><nowiki>{{Sommaire|align=left}}</nowiki></pre>
| |
| :*[[Modèle:Sommaire/Documentation/Exemple1|voir le rendu]]
| |
| | |
| ;Alignement à droite
| |
| : <pre><nowiki>{{Sommaire|align=right}}</nowiki></pre>
| |
| :*[[Modèle:Sommaire/Documentation/Exemple2|voir le rendu]]
| |
| | |
| === Texte tout autour du menu : paramètre <code>flottant</code> ===
| |
| 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.
| |
| | |
| : <pre><nowiki>{{Sommaire|align=right|flottant=1}}</nowiki></pre>
| |
| :*[[Modèle:Sommaire/Documentation/Exemple4|voir le rendu]]
| |
| | |
| == Données ==
| |
| <templatedata>
| |
| {
| |
| "description": "Ce modèle permet d’insérer la table des matières avec une mise en forme paramétrable",
| |
| "params": {
| |
| "niveau": {
| |
| "required": false,
| |
| "label": "Niveau",
| |
| "type": "number",
| |
| "description": "Ce paramètre permet de limiter les niveaux de titres affichés dans le sommaire"
| |
| },
| |
| "align": {
| |
| "required": false,
| |
| "label": "Alignement",
| |
| "type": "string/line",
| |
| "default": "left",
| |
| "description": "Permet d’affiche le sommaire à gauche (« left ») ou à droite (« right »)"
| |
| },
| |
| "flottant": {
| |
| "required": false,
| |
| "label": "Flottant",
| |
| "type": "string/line",
| |
| "description": "Si ce paramètre est rempli, le texte suivant le sommaire s’affichera autour (plutôt qu’après)"
| |
| },
| |
| "width": {
| |
| "required": false,
| |
| "label": "Largeur",
| |
| "type": "string/line",
| |
| "description": "Largeur du sommaire (toute valeur valide en CSS, par exemple « 156px » ou « 22em » ; utilisez de préférence les « em »)"
| |
| },
| |
| "nocat": {
| |
| "required": false,
| |
| "label": "Non catégorisé",
| |
| "type": "string/line",
| |
| "description": "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"
| |
| }
| |
| }
| |
| }
| |
| </templatedata>
| |
| | |
| == Voir aussi ==
| |
| * [[Modèle:Sommaire à droite]]
| |
| * [[Modèle:Sommaire alphabétique]]
| |
| | |
| {{catégorise|Page utilisant un sommaire limité}}
| |
| | |
| [[Catégorie:Modèle de sommaire]]
| |
| | |
| <includeonly>
| |
| [[en:Template:TOClimit]]
| |
| </includeonly>
| |
