Modèle:Contenu de sommaire/Documentation

Ceci est la sous-page de documentation du modèle {{Contenu de sommaire}} ; elle est insérée sur la page de celui-ci à l’aide du modèle {{Documentation}}. C’est également sur cette page que vous placerez les liens interwiki et les catégories du modèle.

Utilisation

Ce modèle permet de créer un sommaire pour un livre. Vous pouvez le placer dans la sous-page Sommaire (par exemple : Livre de ceci cela/Sommaire), et ainsi l’afficher automatiquement grâce au modèle {{Sommaire}}. Il peut fonctionner en mode simple ou complexe.

Ce modèle est aussi disponible en tant que {{Chapitres}}.

Mode simple

{{Contenu de sommaire | style = {{{style|autre}}} | Chapitre 1 | Chapitre 2 | ... }}

Vous ajoutez autant de chapitres que nécessaire. Le titre du chapitre ne doit pas comporter de fioritures car il est utilisé comme lien (mise en italique, modèle, ...).

Mode complexe

{{Contenu de sommaire | complexe = 1 | style = {{{style|autre}}}
  | ext/Chapitre 2/params | ext/Chapitre 2/params | ... }}

La syntaxe du mode complexe est identique au mode simple, sauf qu’on utilise le paramètre complexe (n’importe quelle valeur convient, tant qu’il n’est pas vide) et que les entrées de chapitres sont sous une forme spéciale :

• le nom de l’extension
• ensuite le titre du chapitre (comme le mode simple)
• enfin la liste des paramètres de l’extension séparés par des barres obliques (slash, « / »)

Attention: chaque élément est séparé des autres par une barre oblique et non par une barre verticale.

Voyez la page de l’extension pour en savoir plus sur les paramètres.

Notez que vous pouvez aussi utiliser des entrées de chapitre simples lorsqu’aucune extension n’est nécessaire pour cette entrée

Paramètres supplémentaires

Ces paramètres peuvent être utilisés aussi bien avec le mode simple que le mode complexe.

style

Devrait toujours être {{{style|autre}}} pour pouvoir définir le style à partir du modèle {{Sommaire}} ; autre (peut être vide) permet de décider quel style utiliser lorsqu’il n’est pas défini par {{Sommaire}} (mettez celui le plus employé).
Si le style n’est pas donné lors de l’appel à {{Contenu de sommaire}}, le style par défaut sera utilisé : c’est normalement une redirection vers un autre style.
Note: le style personnalisé permet d’utiliser un style propre au livre.

titre

Certains styles permettent de définir le titre du sommaire ; vous pouvez utiliser {{BASEPAGENAME}} comme valeur pour avoir le titre du livre.

image

Certains styles permettent d’afficher une image (écrivez le nom du fichier sans le préfixe).

option1, option2, option3, option4

Certains styles acceptent des options ; voyez la page du style pour en savoir plus.

base

Pour indiquer l’emplacement du livre (n’est utile que si le livre n’est pas à la racine ; voir aussi {{Multi-sommaire}}).

Limites

• Le nombre de chapitres est actuellement limité à 100 (mais ça peut être augmenté).
• le nombre de paramètres des extensions (mode complexe) est limité à 23, et la taille totale de l’entrée complexe, barres obliques comprises, est limitée à 255 caractères (car utilisation de la fonction #titleparts).

Exemples

{{Contenu de sommaire|style={{{style|}}}
 |Les carrés rouges|Les ronds bleus|Les triangles verts}}
  

{{Chapitres|style={{{style|}}}
 |Les carrés rouges|Les ronds bleus|Les triangles verts}}

{{Contenu de sommaire
 | style = {{{style|large}}}
 | Les carrés rouges
 | Les ronds bleus
 | Les triangles verts
}}

{{Contenu de sommaire|
 complexe=1|style={{{style|large}}}|
 avancement/Les carrés rouges/5 |
 avancement/Les ronds bleus/33 |
 avancement/Les triangles verts/100
}}

{{Contenu de sommaire
 | complexe=oui | style={{{style|bas}}}
 | option1=numéros seuls
 | titre={{{BASEPAGENAME}}} | image = Wikibooks-logo-fr.png |
 | Pommes
 | super extension/Poires/x/y/z
 | Ananas
 | autre extension / Pêches / 5326
 | extension sans paramètre/Abricots
}}

Voir aussi

• le modèle {{Sommaire}} qui permet d’inclure automatiquement le sommaire créé
• la liste des styles disponibles
• la liste des extensions disponibles