Utilisateur:François Melchior/Modèle:Contenu de sommaire/Documentation

Ceci est la sous-page de documentation du modèle {{François Melchior/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}}.

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

Syntaxe

{{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 (pas de mise en italique, de tags html, ...).

Le titre du chapitre peut être suivi des champs suivants :

l’état d’avancement du chapitre (nombre entre 0 et 100),
une image illustrant le chapitre ;

ces informations pourront être utilisés par le style (dépend du style).

{{Contenu de sommaire | style = {{{style|autre}}}
  | Chapitre 1 | avancement 1 | [[Image:une_image]]
  | Chapitre 2 | avancement 2 | [[Image:autre_image]] | ... }}

Note: si le titre d’un chapitre est composé seulement d’un nombre et que le chapitre précédent n’a pas de champ avancement associé, vous devrez doubler la barre verticale pour marquer la séparation (voir les exemples ci-dessous).

Niveaux et titres

Il est possible de faire des sous-chapitres en faisant précéder le nom du chapitre par autant de signes plus (+) que de niveaux souhaités; par contre on ne pourra descendre que d’un niveau à la fois.

Il est également possible d’ajouter un titre à la place d’un chapitre en le faisant précéder d’un point d’exclamation (!).

Paramètres

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}} (vous pouvez mettre par exemple celui qui est le plus employé). Attention: vous devez ici utiliser le préfixe sommaire ou navigation.
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 sommaire personnalisé permet d’utiliser un style propre au livre.

à plat: Indique que le livre possède une structure à un seul niveau (pas de sous-sous-pages). Les valeurs reconnues pour ce paramètre sont : oui, true, 1, non, false et 0.

liens automatiques: Permet de gérer l’ajout automatique des liens Glossaire, Auteurs, Bibliographie, Index et Licence : par défaut, ils seront affichés si les pages correspondantes existent ; si le paramètre a la valeur oui, true ou 1, ils seront affichés même si les pages corresondantes n’existent pas ; avec une valeur non, false ou 0, ces liens ne seront jamais affichés.

option ... option ...: style, ...: Certains styles acceptent des options ; voyez la page du style pour en savoir plus. La seconde version permet de n’appliquer l’option qu’à certains styles.

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|sommaire large}}}
 | Les carrés rouges
 | Les ronds bleus
 | Les triangles verts
}}

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

{{Contenu de sommaire
 | style={{{style|sommaire bas}}}
 | option numéros seuls = 1
 | option titre = ~ | option image = Wikibooks-logo-fr.png |
 | Pommes
 | Poires | [[Image:Wikibooks-logo-fr.png]]
 | Ananas
 || 133
 | Pêches
}}

Voir aussi

le modèle {{Sommaire}} qui permet d’inclure automatiquement le sommaire créé ;
le modèle {{Navigation}} qui utilise également le sommaire créé ;
la liste des styles disponibles.